Amazonka.Textract.Types.Point

Documentation

data Point

The X and Y coordinates of a point on a document page. The X and Y values that are returned are ratios of the overall document page size. For example, if the input document is 700 x 200 and the operation returns X=0.5 and Y=0.25, then the point is at the (350,50) pixel coordinate on the document page.

An array of Point objects, Polygon, is returned by DetectDocumentText. Polygon represents a fine-grained polygon around detected text. For more information, see Geometry in the Amazon Textract Developer Guide.

See: newPoint smart constructor.

Constructors

Point'

Fields

• x :: Maybe Double

  The value of the X coordinate for a point on a Polygon.

• y :: Maybe Double

  The value of the Y coordinate for a point on a Polygon.

Instances

FromJSON Point

Defined in Amazonka.Textract.Types.Point

Methods

parseJSON :: Value -> Parser Point

parseJSONList :: Value -> Parser [Point]

Generic Point

Defined in Amazonka.Textract.Types.Point

Associated Types

type Rep Point :: Type -> Type

Methods

from :: Point -> Rep Point x

to :: Rep Point x -> Point

Read Point

Defined in Amazonka.Textract.Types.Point

Methods

readsPrec :: Int -> ReadS Point

readList :: ReadS [Point]

readPrec :: ReadPrec Point

readListPrec :: ReadPrec [Point]

Show Point

Defined in Amazonka.Textract.Types.Point

Methods

showsPrec :: Int -> Point -> ShowS

show :: Point -> String

showList :: [Point] -> ShowS

NFData Point

Defined in Amazonka.Textract.Types.Point

Methods

rnf :: Point -> ()

Eq Point

Defined in Amazonka.Textract.Types.Point

Methods

(==) :: Point -> Point -> Bool

(/=) :: Point -> Point -> Bool

Hashable Point

Defined in Amazonka.Textract.Types.Point

Methods

hashWithSalt :: Int -> Point -> Int

hash :: Point -> Int

type Rep Point

Defined in Amazonka.Textract.Types.Point

type Rep Point = D1 ('MetaData "Point" "Amazonka.Textract.Types.Point" "amazonka-textract-2.0-6i5mJlqzS4xCepXxXFK6UK" 'False) (C1 ('MetaCons "Point'" 'PrefixI 'True) (S1 ('MetaSel ('Just "x") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Double)) :*: S1 ('MetaSel ('Just "y") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Double))))

newPoint :: Point

Create a value of Point with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:x:Point', point_x - The value of the X coordinate for a point on a Polygon.

$sel:y:Point', point_y - The value of the Y coordinate for a point on a Polygon.

point_x :: Lens' Point (Maybe Double)

The value of the X coordinate for a point on a Polygon.

point_y :: Lens' Point (Maybe Double)

The value of the Y coordinate for a point on a Polygon.