Graphic
An imported graphic in any graphic file format (including vector, metafile, and bitmap formats).
QuickLinks
Hierarchy
Properties
| Property | Type | Access | Description |
|---|---|---|---|
| absoluteHorizontalScale | number | r/w | The horizontal scale of the Graphic relative to its containing object. |
| absoluteRotationAngle | number | r/w | The rotation angle of the Graphic relative to its containing object. (Range: -360 to 360) |
| absoluteShearAngle | number | r/w | The skewing angle of the Graphic relative to its containing object. (Range: -360 to 360) |
| absoluteVerticalScale | number | r/w | The vertical scale of the Graphic relative to its containing object. |
| geometricBounds | Array of Measurement Unit (Number or String) | r/w | The bounds of the Graphic excluding the stroke width, in the format [y1, x1, y2, x2], which give the coordinates of the top-left and bottom-right corners of the bounding box. |
| horizontalScale | number | r/w | The horizontal scaling applied to the text as a percentage of its current size. (Range: 1 to 1000) |
| id | number | readonly | The unique ID of the Graphic. |
| imageTypeName | string | readonly | The type of the image. |
| index | number | readonly | The index of the Graphic within its containing object. |
| itemLink | Link | readonly | The source file of the link. |
| label | string | r/w | A property that can be set to any string. |
| localDisplaySetting | DisplaySettingOptions: DisplaySettingOptions.HIGH_QUALITY DisplaySettingOptions.TYPICAL DisplaySettingOptions.OPTIMIZED DisplaySettingOptions.DEFAULT_VALUE |
r/w | Display performance options for the Graphic. |
| parent | Button GraphicLine Group Oval PageItem Polygon Rectangle State |
readonly | The parent of the Graphic (a PageItem, Oval, Rectangle, Polygon, GraphicLine, State, Group or Button). |
| properties | Object | r/w | A property that allows setting of several properties at the same time. |
| rotationAngle | number | r/w | The rotatation angle of the Graphic. (Range: -360 to 360) |
| shearAngle | number | r/w | The skewing angle applied to the Graphic. (Range: -360 to 360) |
| verticalScale | number | r/w | The vertical scaling applied to the text as a percentage of its current size. (Range: 1 to 1000) |
| visibleBounds | Array of Measurement Unit (Number or String) | r/w | The bounds of the Graphic including the stroke width, in the format [y1, x1, y2, x2], which give the coordinates of the top-left and bottom-right corners of the bounding box. |
Methods
Instances
void exportFile (format:
any, to:
File[, showingOptions:
bool=false][, using:
PDFExportPreset])
Exports the object(s) to a file.
| Parameter | Type | Description |
|---|---|---|
| format | ExportFormat String | The export format. Can accept: ExportFormat enumerator or String. |
| to | File | The path of the export file. |
| showingOptions | bool | If true, prompts the user to select export options. (Optional) (default: false) |
| using | PDFExportPreset | The export style to use. (Optional) |
string extractLabel (key:
string)
Gets the label value associated with the specified key.
| Parameter | Type | Description |
|---|---|---|
| key | string | The key. |
void insertLabel (key:
string, value:
string)
Sets the label to the value associated with the specified key.
| Parameter | Type | Description |
|---|---|---|
| key | string | The key. |
| value | string | The value. |
void move ([to:
any][, by:
Array
of Measurement Unit (Number or String)])
Move Page Item to a new location. One of the To or By parameters is required.
| Parameter | Type | Description |
|---|---|---|
| to |
Array
of 2 Units Layer Page Spread | The new location of the object. Can accept: Array of 2 Units, Spread, Page or Layer. (Optional) |
| by | Array of Measurement Unit (Number or String) | Amount by which to move the object relative to its current position (Optional) |
any place (fileName:
File[, placePoint:
Array
of Measurement Unit (Number or String)][, destinationLayer:
any][, showingOptions:
bool=false][, autoflowing:
bool=false][, retainingFormatting:
bool=true][, convertingQuotes:
bool=true][, withProperties:
Object])
Places a file in the document.
| Parameter | Type | Description |
|---|---|---|
| fileName | File | The file to place. |
| placePoint | Array of Measurement Unit (Number or String) | The point where to place the object (only applicable if you are telling a page or spread to place) (Optional) |
| destinationLayer |
Array
of Layers Layer | The layer(s) to place the file on (only valid if you are telling a page or spread to place). Can accept: Layer or Array of Layers. (Optional) |
| showingOptions | bool | Whether to display the import options dialog (Optional) (default: false) |
| autoflowing | bool | Whether to autoflow placed text (Optional) (default: false) |
| retainingFormatting | bool | Whether to keep formatting of placed text files (Optional) (default: true) |
| convertingQuotes | bool | Whether to convert to typographer's quotes (Optional) (default: true) |
| withProperties | Object | Initial values for properties of the placed object(s) (Optional) |
void remove ()
Deletes the Graphic.
void resize ([horizontalScale:
number][, verticalScale:
number][, around:
any][, consideringCurrentScale:
bool=false][, transformingContent:
bool=true][, consideringParentsScale:
bool=false])
Resize the page item. You must specify either horizontal scale or vertical scale or both.
| Parameter | Type | Description |
|---|---|---|
| horizontalScale | number | The percentage of horizontal scale (Optional) |
| verticalScale | number | The percentage of vertical scale (Optional) |
| around | AnchorPoint Array of 2 Units | The point to scale around. Can accept: Array of 2 Units or AnchorPoint enumerator. (Optional) |
| consideringCurrentScale | bool | If true then the object's current scale and new scale will be combined. If false then the new value is absolute. The default value is false. (Optional) (default: false) |
| transformingContent | bool | If true then both the object and items within it are scaled (Optional) (default: true) |
| consideringParentsScale | bool | If true then the object is scaled relative to its parent page item. If false it is scaled relative to the spread. (Optional) (default: false) |
void rotate (by:
number[, around:
any][, consideringCurrentRotation:
bool=false][, transformingContent:
bool=true][, consideringParentsRotation:
bool=false])
Rotate the page item
| Parameter | Type | Description |
|---|---|---|
| by | number | Angle by which to rotate the page item |
| around | AnchorPoint Array of 2 Units | The point to rotate around. Can accept: Array of 2 Units or AnchorPoint enumerator. (Optional) |
| consideringCurrentRotation | bool | If true then the object's current rotation and new rotation will be combined. If false then the new value is absolute. The default value is false. (Optional) (default: false) |
| transformingContent | bool | If true then both the object and items within it are rotated (Optional) (default: true) |
| consideringParentsRotation | bool | If true then the object is rotated relative to its parent page item. If false it is rotated relative to the spread. Cannot rotate with considering current rotation and considering parents rotation both set at the same time. (Optional) (default: false) |
void shear (by:
number[, around:
any][, consideringCurrentShear:
bool=false][, transformingContent:
bool=true][, consideringParentsShear:
bool=false])
Shear the page item
| Parameter | Type | Description |
|---|---|---|
| by | number | Angle by which to shear the object |
| around | AnchorPoint Array of 2 Units | The point to shear around. Can accept: Array of 2 Units or AnchorPoint enumerator. (Optional) |
| consideringCurrentShear | bool | If true then the object's current shear and new shear will be combined. If false then the new value is absolute. The default value is false. (Optional) (default: false) |
| transformingContent | bool | If true then both the object and items within it are sheared (Optional) (default: true) |
| consideringParentsShear | bool | If true then the object is sheared relative to its parent page item. If false it is sheared relative to the spread. Cannot shear with considering current shear and considering parents shear both set at the same time. (Optional) (default: false) |
void unlink (from:
UnlinkFrom)
Detaches an overridden master page item from the page or from the master
| Parameter | Type | Description |
|---|---|---|
| from | UnlinkFrom: UnlinkFrom.PAGE UnlinkFrom.MASTER_SPREAD | What to unlink from |
Element of
Button.allGraphics
Cell.allGraphics
Character.allGraphics
Document.allGraphics
FormField.allGraphics
GraphicLine.allGraphics
Group.allGraphics
InsertionPoint.allGraphics
Layer.allGraphics
Line.allGraphics
Link.parent
MasterSpread.allGraphics
Oval.allGraphics
Page.allGraphics
PageItem.allGraphics
Paragraph.allGraphics
Polygon.allGraphics
Rectangle.allGraphics
Spread.allGraphics
Story.allGraphics
Table.allGraphics
Text.allGraphics
TextColumn.allGraphics
TextFrame.allGraphics
TextStyleRange.allGraphics
Word.allGraphics
| Jongware, 27-Jun-2010 v3.0.3d | Contents :: Index |