Adds an event listener.
ComboBox | GraphicLine | ListBox | Oval | PlaceGun | Polygon | Rectangle | SignatureField | Snippet | SplineItem | State | TextBox | XMLElement
EPS
10 preference objects
AnimationSetting | ClippingPathSettings | ContentTransparencySetting | FillTransparencySetting | LinkedPageItemOption | Preference | StrokeTransparencySetting | TextWrapPreference | TimingSetting | TransparencySetting
Properties
| Name | Type | Access | Description |
|---|---|---|---|
| Flip | read/write | Indicates whether the EPS has been flipped independently of its parent object and, if yes, the direction in which the EPS was flipped. | |
| Number | read/write | The horizontal scale of the EPS relative to its containing object. | |
| Number | read/write | The rotation angle of the EPS relative to its containing object. (Range: -360 to 360) | |
| Number | read/write | The skewing angle of the EPS relative to its containing object. (Range: -360 to 360) | |
| Number | read/write | The vertical scale of the EPS relative to its containing object. | |
| Number[] | readonly | The native resolution of a placed graphic. | |
| Article[] | readonly | The list of all articles this page item is part of | |
| Graphic[] | readonly | Lists all graphics contained by the EPS. | |
| PageItem[] | readonly | Lists all page items contained by the EPS. | |
| Boolean | read/write | If true, the master page item can be overridden. | |
| AnimationSetting | readonly | The page item animation settings. | |
| ObjectStyle | read/write | The object style applied to the EPS. | |
| ArrowHeadAlignmentEnum | read/write | The arrowhead alignment applied to the EPS. | |
| XMLItem | readonly | The XML element associated with the EPS. | |
| CornerOptions | read/write | The shape to apply to the bottom left corner of rectangular shapes. | |
| Number | String unit | read/write | The radius in measurement units of the corner effect applied to the bottom left corner of rectangular shapes | |
| CornerOptions | read/write | The shape to apply to the bottom right corner of rectangular shapes. | |
| Number | String unit | read/write | The radius in measurement units of the corner effect applied to the bottom right corner of rectangular shapes | |
| ClippingPathSettings | readonly | Clipping path settings. | |
| PlacedVectorProfilePolicy | read/write | The color profile policy for CMYK content in a placed vector. | |
| ContentTransparencySetting | readonly | Transparency settings for the content of the EPS. | |
| Number[] | readonly | The resolution of a graphic after it has been resized. | |
| EndCap | read/write | The end shape of an open path. | |
| EndJoin | read/write | The corner join applied to the EPS. | |
| EventListeners |
readonly | A collection of event listeners. | |
| Events |
readonly | A collection of events. | |
| Swatch | String | read/write | The swatch (color, gradient, tint, or mixed ink) applied to the fill of the EPS. . Can also accept: String. | |
| Number 0–100 | read/write | The percent of tint to use in the EPS's fill color. (To specify a tint percent, use a number in the range of 0 to 100; to use the inherited or overridden value, use -1.) | |
| FillTransparencySetting | readonly | Transparency settings for the fill applied to the EPS. | |
| Flip | read/write | The direction in which to flip the printed image. | |
| Swatch | read/write | The swatch (color, gradient, tint, or mixed ink) applied to the gap of a dashed, dotted, or striped stroke. For information, see stroke type. | |
| Number 0–100 | read/write | The tint as a percentage of the gap color. (To specify a tint percent, use a number in the range of 0 to 100; to use the inherited or overridden value, use -1.) | |
| Number[] | String[] unit | read/write | 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. | |
| Number | read/write | The angle of a linear gradient applied to the fill of the EPS. (Range: -180 to 180) | |
| Number | String unit | read/write | The length (for a linear gradient) or radius (for a radial gradient) applied to the fill of the EPS. | |
| Number[] | String[] unit | read/write | The starting point (in page coordinates) of a gradient applied to the fill of the EPS, in the format [x, y]. | |
| Number | read/write | The angle of a linear gradient applied to the stroke of the EPS. (Range: -180 to 180) | |
| Number | String unit | read/write | The length (for a linear gradient) or radius (for a radial gradient) applied to the stroke of the EPS. | |
| Number[] | String[] unit | read/write | The starting point (in page coordinates) of a gradient applied to the stroke of the EPS, in the format [x, y]. | |
| Graphics |
readonly | A collection of imported graphics in any graphic file format (vector, metafile, or bitmap). | |
| PlacedVectorProfilePolicy | read/write | The color profile policy for grayscale content in a placed vector. | |
| DimensionsConstraints[] | read/write | The left margin, width, and right margin constraints this item is subject to when using the object-based layout rule. | |
| Number | read/write | The horizontal scaling applied to the EPS. | |
| Number | readonly | The unique ID of the EPS. | |
| String | readonly | The type of the image. | |
| Number | readonly | The index of the EPS within its containing object. | |
| Boolean | readonly | Returns true if the object specifier resolves to valid objects. | |
| Layer | read/write | The layer that the EPS is on. | |
| Link | readonly | The source file of the link. | |
| String | read/write | A property that can be set to any string. | |
| Number 1–1000 | read/write | The scaling applied to the arrowhead at the start of the path. (Range: 1 to 1000) | |
| ArrowHead | read/write | The arrowhead applied to the start of the path. | |
| LinkedPageItemOption | readonly | Linked Page Item options | |
| Boolean | read/write | If true, the EPS is locked. | |
| Number = 4 1–500 | read/write | The limit of the ratio of stroke width to miter length before a miter (pointed) join becomes a bevel (squared-off) join. | |
| String | read/write | The name of the EPS. | |
| Boolean | read/write | If true, the EPS does not print. | |
| Boolean | read/write | If true, the EPS's fill color overprints any underlying objects. If false, the fill color knocks out the underlying colors. | |
| Boolean | read/write | If true, the gap color overprints any underlying colors. If false, the gap color knocks out the underlying colors. | |
| Boolean | read/write | If true, the EPS's stroke color overprints any underlying objects. If false, the stroke color knocks out the underlying colors. | |
| Boolean | 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. | |
| Graphic | Guide | Movie | PageItem | Sound | readonly | An object that originated on a master page and has been overridden. Can return: PageItem, Guide, Graphic, Movie or Sound. | |
| PageItems |
readonly | The page items collection, which can be used to process all page items in a container (such as a document, page, or group), regardless of type. | |
| ComboBox | GraphicLine | ListBox | Oval | PlaceGun | Polygon | Rectangle | SignatureField | SplineItem | TextBox | XMLElement | Snippet | State | readonly | The parent of the EPS (a Snippet, XMLElement, PlaceGun, TextBox, SignatureField, ComboBox, ListBox, SplineItem, Polygon, GraphicLine, Rectangle, Oval or State). | |
| Page | readonly | The page on which this page item appears. | |
| Preferences |
readonly | A collection of preferences objects. | |
| Object | read/write | A property that allows setting of several properties at the same time. | |
| PlacedVectorProfilePolicy | read/write | The color profile policy for RGB content in a placed vector. | |
| Number 1–1000 | read/write | The scaling applied to the arrowhead at the end of the path. (Range: 1 to 1000) | |
| ArrowHead | read/write | The arrowhead applied to the end of the path. | |
| Number | read/write | The rotatation angle of the EPS. (Range: -360 to 360) | |
| Number | read/write | The skewing angle applied to the EPS. (Range: -360 to 360) | |
| String | readonly | The color space. | |
| StrokeAlignment | read/write | The stroke alignment applied to the EPS. | |
| Swatch | String | read/write | The swatch (color, gradient, tint, or mixed ink) applied to the stroke of the EPS. Can also accept: String. | |
| StrokeCornerAdjustment | read/write | The corner adjustment applied to the EPS. | |
| Number[] | String[] unit | read/write | The dash and gap measurements that define the pattern of a custom dashed line. Define up to six values (in points) in the format [dash1, gap1, dash2, gap2, dash3, gap3]. | |
| Number 0–100 | read/write | The percent of tint to use in object's stroke color. (To specify a tint percent, use a number in the range of 0 to 100; to use the inherited or overridden value, use -1.) | |
| StrokeTransparencySetting | readonly | Transparency settings for the stroke. | |
| StrokeStyle | String | read/write | The name of the stroke style to apply. Can also accept: String. | |
| Number | String unit | read/write | The weight (in points) to apply to the EPS's stroke. | |
| SVGs |
readonly | A collection of SVG files. | |
| TextWrapPreference | readonly | The text wrap preference properties that define the default formatting for wrapping text around objects. | |
| TimingSetting | readonly | The object timing settings. | |
| CornerOptions | read/write | The shape to be applied to the top left corner of rectangular shapes and all corners of non-rectangular shapes.Note: corner option differs from end join in which you can set a radius for a corner option, whereas the rounded or beveled effect of an end join depends on the stroke weight. | |
| Number | String unit | read/write | The radius in measurement units of the corner effect applied to the top left corner of rectangular shapes and all corners of non-rectangular shapes | |
| CornerOptions | read/write | The shape to apply to the top right corner of rectangular shapes | |
| Number | String unit | read/write | The radius in measurement units of the corner effect applied to the top right corner of rectangular shapes | |
| TransparencySetting | readonly | Transparency settings. | |
| DimensionsConstraints[] | read/write | The top margin, height, and bottom margin constraints this item is subject to when using the object-based layout rule. | |
| Number | read/write | The vertical scaling applied to the EPS. | |
| Boolean | read/write | If true, the EPS is visible. | |
| Number[] | String[] unit | read/write | 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. |
Events
| Name | Description |
|---|---|
| Dispatched after a EPS is placed. This event bubbles. This event is not cancelable. | |
| Dispatched before a EPS is placed. This event bubbles. This event is cancelable. |
Methods
Applies the specified object style.
Tag the object or the parent story using default tags defined in XML preference.
Finds objects that match the find what value and replace the objects with the change to value.
Clear overrides for object style
Clears transformations from the EPS. Transformations include rotation, scaling, flipping, fitting, and shearing.
Duplicate an object and place it into the target page item.
Converts the EPS to a different shape.
Create Email QR Code on the page item or document
Create Hyperlink QR Code on the page item or document
Create Plain Text QR Code on the page item
Create Text Msg QR Code on the page item or document
Create Business Card QR Code on the page item or load on document's placegun
Detaches an overridden master page item from the master page.
Duplicates the EPS at the specified location or offset.
Exports the object(s) to a file.
Exports the EPS for the web.
Gets the label value associated with the specified key.
Finds objects that match the find what value.
Applies the specified fit option to content in a frame.
Flips the EPS.
Resolves the object specifier, creating an array of object references.
Sets the label to the value associated with the specified key.
Associates the page item with the specified XML element while preserving existing content.
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.
Overrides a master page item and places the item on the document page as a new object.
Places a file
Places XML content into the specified object. Note: Replaces any existing content.
Apply an item's scaling to its content if possible.
Move the bounding box of the page item
Deletes the EPS.
Removes the event listener.
Removes the override from a previously overridden master page item.
Resize the page item.
Get the coordinates of the given location in the specified coordinate system.
Stores the object in the specified library.
Generates a string which, if executed, will return the EPS.
Retrieves the object specifier.
Transform the page item.
Get the transformation values of the page item.
Object of 16
Properties elsewhere that hold a EPS.
Parameter of 3
Method parameters that accept a EPS.
Return 13
Methods that return a EPS.