ImgFrame_GetGeometry¶

Return the geometry of an image frame.

ImgFrame_GetGeometry(imgDocRef{; frameIdx}) ➔ geometry

imgDocRef	Text	The image document reference.
frameIdx	Longint	The index of the image frame.
geometry	Object

Return an object describing the geometric characteristics of an image frame.

Parameter imgDocRef is the image document reference. This method works with both raster images and PDF documents.

Parameter frameIdx is the index of the image frame. Passing 0 or omitting this parameter is the same as passing 1.

The geometry of the image frame is returned as an object in geometry. The contents of the geometry object depend on the kind of the image document, described in the following tables.

Raster Frame Geometry¶
Property name	Type	Description
`PixelSize`	`SizeObj`	The pixel size of the raw raster data.
`DPISize`	`SizeObj`	The DPI size of the raw raster data.
`PointSize`	`SizeObj`	The point size of the raw raster data. Calculated from `PixelSize` and `DPISize`.
`Orientation`	`Longint`	The orientation of the raster frame.

PDF Page Geometry¶
Property name	Type	Description
`PointSize`	`SizeObj`	The size of the PDF page.
`Rotation`	`Longint`	The rotation of the PDF page.

Note

This utility method is a wrapper for the ImgFrame_GetGeometry_JSN plug-in method. There is little reason to call this method directly as there are specialized methods for accessing the geometric characteristics of image frames, with the added benefit of presenting those in the frame’s oriented coordinate space by default: ImgFrame_GetPointSize, RasterFrame_GetPixelSize, RasterFrame_GetDPISize, RasterFrame_GetOrientation.