EPS

A placed EPS file.

Properties

Property Type Access Description
absoluteFlip Flip
:
NONE
HORIZONTAL
VERTICAL
HORIZONTAL_AND_VERTICAL
BOTH
r/w Indicates whether the EPS has been flipped independently of its parent object and, if yes, the direction in which the EPS was flipped.
absoluteHorizontalScale number r/w The horizontal scale of the EPS relative to its containing object.
absoluteRotationAngle number r/w The rotation angle of the EPS relative to its containing object. (Range: -360 to 360)
absoluteShearAngle number r/w The skewing angle of the EPS relative to its containing object. (Range: -360 to 360)
absoluteVerticalScale number r/w The vertical scale of the EPS relative to its containing object.
actualPpi Array of number readonly The native resolution of a placed graphic.
allowOverrides bool r/w If true, the master page EPS allows overrides.
appliedObjectStyle ObjectStyle r/w The object style applied to the EPS.
associatedXMLElement XMLItem readonly The XML element associated with the EPS.
clippingPath ClippingPathSettings readonly Clipping path settings.
cmykVectorPolicy PlacedVectorProfilePolicy
:
IGNORE_ALL
IGNORE_OUTPUT_INTENT
HONOR_ALL_PROFILES
r/w The color profile policy for CMYK content in a placed vector.
contentTransparencySettings ContentTransparencySetting readonly Transparency settings for the content of the EPS.
effectivePpi Array of number readonly The resolution of a graphic after it has been resized.
fillTransparencySettings FillTransparencySetting readonly Transparency settings for the fill applied to the EPS.
flip Flip
:
NONE
HORIZONTAL
VERTICAL
HORIZONTAL_AND_VERTICAL
BOTH
r/w The direction in which to flip the printed image.
geometricBounds Array of number r/w The bounds of the EPS 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.
grayVectorPolicy PlacedVectorProfilePolicy
:
IGNORE_ALL
IGNORE_OUTPUT_INTENT
HONOR_ALL_PROFILES
r/w The color profile policy for grayscale content in a placed vector.
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 EPS.
imageTypeName string readonly The type of the image.
index number readonly The index of the EPS 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
:
HIGH_QUALITY
TYPICAL
OPTIMIZED
DEFAULT_VALUE
r/w Display performance options for the EPS.
nonprinting bool r/w If true, the EPS does not print.
overridden bool readonly If true, the object originated on a master spread and was overridden. If false, the object either originated on a master spread and was not overridden, or the object did not originate on a master page.
overriddenMasterPageItem any readonly An object that originated on a master page and has been overridden. Can return: PageItem, Guide, Graphic, Movie or Sound.
parent any readonly The parent of the EPS (a XMLElement, 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.
rgbVectorPolicy PlacedVectorProfilePolicy
:
IGNORE_ALL
IGNORE_OUTPUT_INTENT
HONOR_ALL_PROFILES
r/w The color profile policy for RGB content in a placed vector.
rotationAngle number r/w The rotatation angle of the EPS. (Range: -360 to 360)
shearAngle number r/w The skewing angle applied to the EPS. (Range: -360 to 360)
space string readonly The color space.
strokeTransparencySettings StrokeTransparencySetting readonly Transparency settings for the stroke.
textWrapPreferences TextWrapPreference readonly The text wrap preference properties that define the default formatting for wrapping text around objects.
transparencySettings TransparencySetting readonly Transparency settings.
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 number r/w The bounds of the EPS 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

void applyObjectStyle (using:
ObjectStyle[, clearingOverrides:
bool=true ][, clearingOverridesThroughRootObjectStyle:
bool=false ])
Applies the specified object style.

Parameter Type Description
using ObjectStyle The object style to apply.
clearingOverrides bool If true, clears the EPS’s existing attributes before applying the style. (Optional) (default: true )
clearingOverridesThroughRootObjectStyle bool If true, clears attributes and formatting applied to the EPS that are not defined in the object style. (Optional) (default: false )

void autoTag ()
Tag the object or the parent story using default tags defined in XML preference.

Array of PageItemchangeObject ([reverseOrder:
bool])
Finds objects that match the find what value and replace the objects with the change to value.

Parameter Type Description
reverseOrder bool If true, returns the results in reverse order. (Optional)

void clearObjectStyleOverrides ()
Clear overrides for object style

void detach ()
Detaches an overridden master page item from the master page.

PageItemduplicate ([to:
any][, by:
Array of number])
Duplicates the EPS at the specified location or offset

Parameter Type Description
to Array of 2 Units
Spread
Page
Layer
The location of the new EPS, specified in coordinates in the format [x, y]. Can accept: Array of 2 Units, Spread, Page or Layer. (Optional)
by Array of number Amount by which to offset the new EPS from the original EPS’s position. (Optional)

void exportFile (format:
any, to:
File[, showingOptions:
bool=false ][, using:
PDFExportPreset][, versionComments:
string][, forceSave:
bool=false ])
Exports the EPS to file.

Parameter Type Description
format ExportFormat
String
The export format, specified as an enumeration value or as an extension that appears in the Save as type or Format menu in the Export dialog. Can accept: ExportFormat enumerator or String.
to File The path to the export file.
showingOptions bool If true, displays the export options dialog. (Optional) (default: false )
using PDFExportPreset The export style. (Optional)
versionComments string The comment for this version. (Optional)
forceSave bool If true, forcibly saves a version. (Optional) (default: false )

Array of string exportForWeb (to:
File)
Exports the EPS for the web.

Parameter Type Description
to File The full path name of the exported file.

string extractLabel (key:
string)
Gets the label value associated with the specified key.

Parameter Type Description
key string The key.

Array of PageItemfindObject ([reverseOrder:
bool])
Finds objects that match the find what value.

Parameter Type Description
reverseOrder bool If true, returns the results in reverse order. (Optional)

void fit (given:
FitOptions)
Applies the specified fit option to content in a frame.

Parameter Type Description
given FitOptions
:
CONTENT_TO_FRAME
CENTER_CONTENT
PROPORTIONALLY
FRAME_TO_CONTENT
FILL_PROPORTIONALLY
The fit option to use.

void flipItem (given:
Flip[, around:
any])
Flips the EPS.

Parameter Type Description
given Flip
:
NONE
HORIZONTAL
VERTICAL
HORIZONTAL_AND_VERTICAL
BOTH
The axis around which to flip the EPS.
around Array of 2 Units
AnchorPoint
The point around which to flip the EPS. Can accept: Array of 2 Units or AnchorPoint enumerator. (Optional)

Array of EPSgetElements ()
Resolves the object specifier, creating an array of object references.

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 markup (using:
XMLElement)
Associates the page item with the specified XML element while preserving existing content.

Parameter Type Description
using XMLElement The XML element.

void move ([to:
any][, by:
Array of number])
Moves the EPS to a new location. Note: Either the ‘to’ or ‘by’ parameter is required; if both parameters are defined, only the to value is used.

Parameter Type Description
to Array of 2 Units
Spread
Page
Layer
The new location of the EPS,in the format (x, y). Can accept: Array of 2 Units, Spread, Page or Layer. (Optional)
by Array of number The amount (in measurement units) to move the EPS relative to its current position, in the format (x, y). (Optional)

any override (destinationPage:
Page)
Overrides a master page item and places the item on the document page as a new object.

Parameter Type Description
destinationPage Page The document page that contains the master page item to override.

Array of any place (fileName:
File[, showingOptions:
bool=false ][, withProperties:
Object])
Places the file.

Parameter Type Description
fileName File The file to place
showingOptions bool Whether to display the import options dialog (Optional) (default: false )
withProperties Object Initial values for properties of the new EPS (Optional)

void placeXML (using:
XMLElement)
Places XML content into the specified object. Note: Replaces any existing content.

Parameter Type Description
using XMLElement The XML element whose content you want to place.

void redefineScaling ([to:
Array of number])
Move an item’s scaling to its content if possible

Parameter Type Description
to Array of number The scale factors to be left on the item. The default is {1.0, 1.0}. (Optional)

void remove ()
Deletes the EPS.

void removeOverride ()
Removes the override from a previously overridden master page item.

any resolve (location:
any, in:
CoordinateSpaces[, consideringRulerUnits:
bool=false ])
Get the coordinates of the given location in the specified coordinate system

Parameter Type Description
location Array of 2 Reals
AnchorPoint
Array of Arrays of 2 Reals
CoordinateSpaces
AnchorPoint
BoundingBoxLimits
The location requested. Can accept: Array of 2 Reals, AnchorPoint enumerator or Array of Arrays of 2 Reals, CoordinateSpaces enumerators, AnchorPoint enumerators, BoundingBoxLimits enumerators or Long Integers.
in CoordinateSpaces
:
PASTEBOARD_COORDINATES
PARENT_COORDINATES
INNER_COORDINATES
The coordinate space to use
consideringRulerUnits bool If true then a ruler location is interpreted using ruler units rather than points. The default value is false. This parameter has no effect unless the reference point is specified relative to a page. (Optional) (default: false )

Assetstore (using:
Library[, withProperties:
Object])
Stores the EPS(s) in the specified library.

Parameter Type Description
using Library The library in which to store the EPS(s).
withProperties Object Initial values for properties of the new EPS (Optional)

string toSource ()
Generates a string which, if executed, will return the EPS.

string toSpecifier ()
Retrieves the object specifier.

void transform (in:
CoordinateSpaces, from:
any, withMatrix:
any[, replacingCurrent:
any][, consideringRulerUnits:
bool=false ])
Transform the page item

Parameter Type Description
in CoordinateSpaces
:
PASTEBOARD_COORDINATES
PARENT_COORDINATES
INNER_COORDINATES
The coordinate space to use
from Array of 2 Reals
AnchorPoint
Array of Arrays of 2 Reals
CoordinateSpaces
AnchorPoint
BoundingBoxLimits
The temporary origin during the transformation. Can accept: Array of 2 Reals, AnchorPoint enumerator or Array of Arrays of 2 Reals, CoordinateSpaces enumerators, AnchorPoint enumerators, BoundingBoxLimits enumerators or Long Integers.
withMatrix Array of 6 Reals
TransformationMatrix
Transform matrix. Can accept: Array of 6 Reals or TransformationMatrix.
replacingCurrent MatrixContent
Array of MatrixContent
Long Integer
Transform components to consider; providing this optional parameter causes the target’s existing transform components to be replaced with new values. Without this parameter, the given matrix is concatenated onto the target’s existing transform combining the effect of the two. Can accept: MatrixContent enumerator, Array of MatrixContent enumerators or Long Integer. (Optional)
consideringRulerUnits bool If true then a ruler based origin is interpreted using ruler units rather than points. The default value is false. This parameter has no effect unless the reference point is specified relative to a page. (Optional) (default: false )

Array of string transformAgain ()
Transforms the EPS using the last transformation performed on any object. Transformations include moving, rotating, shearing, scaling, and flipping.

Array of string transformAgainIndividually ()
Transforms the EPS using the last transformation performed on any EPS. Transformations include moving, rotating, shearing, scaling, and flipping.

Array of string transformSequenceAgain ()
Transforms the EPS using the last sequence of transform operations performed on any single object or performed at the same time on any group of objects. Transformations include moving, rotating, shearing, scaling, and flipping.

Array of string transformSequenceAgainIndividually ()
Transforms the EPS using the last sequence of transformations performed on any single object or performed at the same time on any group of objects. Transformations include moving, rotating, shearing, scaling, and flipping.

Array of TransformationMatrixtransformValuesOf (in:
CoordinateSpaces)
Get the transformation values of the page item

Parameter Type Description
in CoordinateSpaces
:
PASTEBOARD_COORDINATES
PARENT_COORDINATES
INNER_COORDINATES
The coordinate space to use

Used in:

EPSs.previousItem (

obj:
EPS )

EPSs.nextItem (

obj:
EPS )

Returned by:

Array of EPS EPS .getElements (

)

EPS EPSs.anyItem (

)

Array of EPS EPSs.everyItem (

)

EPS EPSs.firstItem (

)

EPS EPSs.item (
index:
any
)

EPS EPSs.itemByID (
id:
number
)

EPS EPSs.itemByName (
name:
string
)

Array of EPS EPSs.itemByRange (
from:
any, to:
any
)

EPS EPSs.lastItem (

)

EPS EPSs.middleItem (

)

EPS EPSs.nextItem (
obj:
EPS
)

EPS EPSs.previousItem (
obj:
EPS
)

Leave a Comment

Previous post:

Next post: