Adobe InCopy CS5 (7.0) Object Model JS: Image

InCopy CS5

previous page next page

Class

Image

An imported bitmap image in any bitmap file format (including TIFF, JPEG, or GIF). Base Class: Graphic

QuickLinks

addEventListener, autoTag, changeObject, clearTransformations, convertShape, exportForWeb, extractLabel, findObject, fit, getElements, insertLabel, place, placeXML, redefineScaling, reframe, removeEventListener, resize, resolve, toSource, toSpecifier, transform, transformValuesOf

Hierarchy

Graphic

Image

Properties

Property	Type	Access	Description
absoluteFlip	Flip: Flip.NONE Flip.HORIZONTAL Flip.VERTICAL Flip.HORIZONTAL_AND_VERTICAL Flip.BOTH	r/w	Indicates whether the Image has been flipped independently of its parent object and, if yes, the direction in which the Image was flipped.
absoluteHorizontalScale	number	readonly	The horizontal scale of the Image relative to its containing object.
absoluteRotationAngle	number	readonly	The rotation angle of the Image relative to its containing object. (Range: -360 to 360)
absoluteShearAngle	number	readonly	The skewing angle of the Image relative to its containing object. (Range: -360 to 360)
absoluteVerticalScale	number	readonly	The vertical scale of the Image relative to its containing object.
allGraphics	Array of Graphic	readonly	Lists all graphics contained by the Image.
allPageItems	Array of PageItem	readonly	Lists all page items contained by the Image.
allowOverrides	bool	r/w	If true, the master page item can be overridden.
associatedXMLElement	XMLItem	readonly	The XML element associated with the Image.
bottomLeftCornerOption	CornerOptions: CornerOptions.NONE CornerOptions.ROUNDED_CORNER CornerOptions.INVERSE_ROUNDED_CORNER CornerOptions.INSET_CORNER CornerOptions.BEVEL_CORNER CornerOptions.FANCY_CORNER	readonly	The shape to apply to the bottom left corner of rectangular shapes.
bottomLeftCornerRadius	Measurement Unit (Number or String)	readonly	The radius in measurement units of the corner effect applied to the bottom left corner of rectangular shapes
bottomRightCornerOption	CornerOptions: CornerOptions.NONE CornerOptions.ROUNDED_CORNER CornerOptions.INVERSE_ROUNDED_CORNER CornerOptions.INSET_CORNER CornerOptions.BEVEL_CORNER CornerOptions.FANCY_CORNER	readonly	The shape to apply to the bottom right corner of rectangular shapes.
bottomRightCornerRadius	Measurement Unit (Number or String)	readonly	The radius in measurement units of the corner effect applied to the bottom right corner of rectangular shapes
clippingPath	ClippingPathSettings	readonly	Clipping path settings.
endCap	EndCap: EndCap.BUTT_END_CAP EndCap.ROUND_END_CAP EndCap.PROJECTING_END_CAP	readonly	The end shape of an open path.
endJoin	EndJoin: EndJoin.MITER_END_JOIN EndJoin.ROUND_END_JOIN EndJoin.BEVEL_END_JOIN	readonly	The corner join applied to the Image.
eventListeners	EventListeners	readonly	A collection of event listeners.
events	Events	readonly	A collection of events.
fillColor	String Swatch	readonly	The swatch (color, gradient, tint, or mixed ink) applied to the fill of the Image. . Can also accept: String.
fillTint	number	readonly	The percent of tint to use in the Image'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.)
flip	Flip: Flip.NONE Flip.HORIZONTAL Flip.VERTICAL Flip.HORIZONTAL_AND_VERTICAL Flip.BOTH	r/w	The direction in which to flip the printed image.
gapColor	Swatch	readonly	The swatch (color, gradient, tint, or mixed ink) applied to the gap of a dashed, dotted, or striped stroke. For information, see stroke type.
gapTint	number	readonly	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.)
geometricBounds	Array of Measurement Unit (Number or String)	readonly	The bounds of the Image 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.
gradientFillAngle	number	readonly	The angle of a linear gradient applied to the fill of the Image. (Range: -180 to 180)
gradientFillLength	Measurement Unit (Number or String)	readonly	The length (for a linear gradient) or radius (for a radial gradient) applied to the fill of the Image.
gradientFillStart	Array of Measurement Unit (Number or String)	readonly	The starting point (in page coordinates) of a gradient applied to the fill of the Image, in the format [x, y].
gradientStrokeAngle	number	readonly	The angle of a linear gradient applied to the stroke of the Image. (Range: -180 to 180)
gradientStrokeLength	Measurement Unit (Number or String)	readonly	The length (for a linear gradient) or radius (for a radial gradient) applied to the stroke of the Image.
gradientStrokeStart	Array of Measurement Unit (Number or String)	readonly	The starting point (in page coordinates) of a gradient applied to the stroke of the Image, in the format [x, y].
graphicLayerOptions	GraphicLayerOption	readonly	Graphic layer option settings.
horizontalScale	number	readonly	The horizontal scaling applied to the Image.
id	number	readonly	The unique ID of the Image.
imageIOPreferences	ImageIOPreference	readonly	The image I/O preference properties that define preferences for importing images.
index	number	readonly	The index of the Image within its containing object.
isValid	bool	readonly	Returns true if the object specifier resolves to valid objects.
itemLayer	Layer	readonly	The layer that the Image is on.
itemLink	Link	readonly	The source file of the link.
label	string	r/w	A property that can be set to any string.
leftLineEnd	ArrowHead: ArrowHead.NONE ArrowHead.SIMPLE_ARROW_HEAD ArrowHead.SIMPLE_WIDE_ARROW_HEAD ArrowHead.TRIANGLE_ARROW_HEAD ArrowHead.TRIANGLE_WIDE_ARROW_HEAD ArrowHead.BARBED_ARROW_HEAD ArrowHead.CURVED_ARROW_HEAD ArrowHead.CIRCLE_ARROW_HEAD ArrowHead.CIRCLE_SOLID_ARROW_HEAD ArrowHead.SQUARE_ARROW_HEAD ArrowHead.SQUARE_SOLID_ARROW_HEAD ArrowHead.BAR_ARROW_HEAD	readonly	The arrowhead applied to the start of the path.
localDisplaySetting	DisplaySettingOptions: DisplaySettingOptions.HIGH_QUALITY DisplaySettingOptions.TYPICAL DisplaySettingOptions.OPTIMIZED DisplaySettingOptions.DEFAULT_VALUE	readonly	Display performance options for the Image.
locked	bool	readonly	If true, the Image is locked.
miterLimit	number (range: 1 - 500)	readonly	The limit of the ratio of stroke width to miter length before a miter (pointed) join becomes a bevel (squared-off) join. (default: 4)
name	string	r/w	The name of the Image.
nonprinting	bool	readonly	If true, the Image does not print.
overprintFill	bool	readonly	If true, the Image's fill color overprints any underlying objects. If false, the fill color knocks out the underlying colors.
overprintGap	bool	readonly	If true, the gap color overprints any underlying colors. If false, the gap color knocks out the underlying colors.
overprintStroke	bool	readonly	If true, the Image's stroke color overprints any underlying objects. If false, the stroke color knocks out the underlying colors.
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	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.
parent	GraphicLine Movie Oval PlaceGun Polygon Rectangle Sound SplineItem State XMLElement	readonly	The parent of the Image (a XMLElement, Sound, PlaceGun, Movie, SplineItem, Polygon, GraphicLine, Rectangle, Oval or State).
parentPage	Page	readonly	The page on which this page item appears.
preferences	Preferences	readonly	A collection of preferences objects.
properties	Object	r/w	A property that allows setting of several properties at the same time.
rightLineEnd	ArrowHead: ArrowHead.NONE ArrowHead.SIMPLE_ARROW_HEAD ArrowHead.SIMPLE_WIDE_ARROW_HEAD ArrowHead.TRIANGLE_ARROW_HEAD ArrowHead.TRIANGLE_WIDE_ARROW_HEAD ArrowHead.BARBED_ARROW_HEAD ArrowHead.CURVED_ARROW_HEAD ArrowHead.CIRCLE_ARROW_HEAD ArrowHead.CIRCLE_SOLID_ARROW_HEAD ArrowHead.SQUARE_ARROW_HEAD ArrowHead.SQUARE_SOLID_ARROW_HEAD ArrowHead.BAR_ARROW_HEAD	readonly	The arrowhead applied to the end of the path.
rotationAngle	number	readonly	The rotatation angle of the Image. (Range: -360 to 360)
shearAngle	number	readonly	The skewing angle applied to the Image. (Range: -360 to 360)
strokeAlignment	StrokeAlignment: StrokeAlignment.CENTER_ALIGNMENT StrokeAlignment.INSIDE_ALIGNMENT StrokeAlignment.OUTSIDE_ALIGNMENT	readonly	The stroke alignment applied to the Image.
strokeColor	String Swatch	readonly	The swatch (color, gradient, tint, or mixed ink) applied to the stroke of the Image. Can also accept: String.
strokeCornerAdjustment	StrokeCornerAdjustment: StrokeCornerAdjustment.NONE StrokeCornerAdjustment.DASHES StrokeCornerAdjustment.GAPS StrokeCornerAdjustment.DASHES_AND_GAPS	readonly	The corner adjustment applied to the Image.
strokeDashAndGap	Array of Measurement Unit (Number or String)	readonly	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].
strokeTint	number	readonly	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.)
strokeType	String StrokeStyle	readonly	The name of the stroke style to apply. Can also accept: String.
strokeWeight	Measurement Unit (Number or String)	readonly	The weight (in points) to apply to the Image's stroke.
textWrapPreferences	TextWrapPreference	readonly	The text wrap preference properties that define the default formatting for wrapping text around objects.
topLeftCornerOption	CornerOptions: CornerOptions.NONE CornerOptions.ROUNDED_CORNER CornerOptions.INVERSE_ROUNDED_CORNER CornerOptions.INSET_CORNER CornerOptions.BEVEL_CORNER CornerOptions.FANCY_CORNER	readonly	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.
topLeftCornerRadius	Measurement Unit (Number or String)	readonly	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
topRightCornerOption	CornerOptions: CornerOptions.NONE CornerOptions.ROUNDED_CORNER CornerOptions.INVERSE_ROUNDED_CORNER CornerOptions.INSET_CORNER CornerOptions.BEVEL_CORNER CornerOptions.FANCY_CORNER	readonly	The shape to apply to the top right corner of rectangular shapes
topRightCornerRadius	Measurement Unit (Number or String)	readonly	The radius in measurement units of the corner effect applied to the top right corner of rectangular shapes
verticalScale	number	readonly	The vertical scaling applied to the Image.
visible	bool	r/w	If true, the Image is visible.
visibleBounds	Array of Measurement Unit (Number or String)	readonly	The bounds of the Image 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.

Class

Property	Type	Access	Description
AFTER_PLACE	string	readonly	Dispatched after a Image is placed. This event bubbles. This event is not cancelable. (default: afterPlace)
BEFORE_PLACE	string	readonly	Dispatched before a Image is placed. This event bubbles. This event is cancelable. (default: beforePlace)

Methods

Instances

EventListener addEventListener (eventType: string, handler: varies[, captures: bool=false])
Adds an event listener.

Parameter	Type	Description
eventType	string	The event type.
handler	File JavaScript Function	The event handler. Can accept: File or JavaScript Function.
captures	bool	This parameter is obsolete. (Optional) (default: false)

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

Array of PageItem changeObject ([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 clearTransformations ()
Clears transformations from the Image. Transformations include rotation, scaling, flipping, fitting, and shearing.

void convertShape (given: ConvertShapeOptions[, numberOfSides: number][, insetPercentage: number][, cornerRadius: Measurement Unit (Number or String)])
Converts the Image to a different shape.

Parameter	Type	Description
given	ConvertShapeOptions: ConvertShapeOptions.CONVERT_TO_RECTANGLE ConvertShapeOptions.CONVERT_TO_ROUNDED_RECTANGLE ConvertShapeOptions.CONVERT_TO_BEVELED_RECTANGLE ConvertShapeOptions.CONVERT_TO_INVERSE_ROUNDED_RECTANGLE ConvertShapeOptions.CONVERT_TO_OVAL ConvertShapeOptions.CONVERT_TO_TRIANGLE ConvertShapeOptions.CONVERT_TO_POLYGON ConvertShapeOptions.CONVERT_TO_LINE ConvertShapeOptions.CONVERT_TO_STRAIGHT_LINE ConvertShapeOptions.CONVERT_TO_OPEN_PATH ConvertShapeOptions.CONVERT_TO_CLOSED_PATH	The Image's new shape.
numberOfSides	number (range: 3 - 100)	The number of sides for the resulting polygon. (Range: 3 to 100) (Optional)
insetPercentage	number (range: 0 - 100)	The star inset percentage for the resulting polygon. (Range: 0.0 to 100.0) (Optional)
cornerRadius	Measurement Unit (Number or String) (range: 0 - 800)	The corner radius of the resulting rectangle. (Optional)

Array of string exportForWeb (to: File)
Exports the Image 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 PageItem findObject ([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: FitOptions.CONTENT_TO_FRAME FitOptions.CENTER_CONTENT FitOptions.PROPORTIONALLY FitOptions.FILL_PROPORTIONALLY FitOptions.APPLY_FRAME_FITTING_OPTIONS	The fit option to use.

Array of Image getElements ()
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.

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 placed object(s) (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])
Apply 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 reframe (in: varies, opposingCorners: Array of varies)
Move the bounding box of the page item

Parameter	Type	Description
in	boundsKind:BoundingBoxLimits CoordinateSpaces Ordered array containing coordinateSpace:CoordinateSpaces	The bounding box to resize. Can accept: CoordinateSpaces enumerator or Ordered array containing coordinateSpace:CoordinateSpaces enumerator, boundsKind:BoundingBoxLimits enumerator.
opposingCorners	Array of any	Opposing corners of new bounding box in the given coordinate space

bool removeEventListener (eventType: string, handler: varies[, captures: bool=false])
Removes the event listener.

Parameter	Type	Description
eventType	string	The registered event type.
handler	File JavaScript Function	The registered event handler. Can accept: File or JavaScript Function.
captures	bool	This parameter is obsolete. (Optional) (default: false)

void resize (in: varies, from: varies, by: ResizeMethods, values: Array of varies[, resizeIndividually: bool=true][, consideringRulerUnits: bool=false])
Resize the page item.

Parameter	Type	Description
in	BoundingBoxLimits boundsKind:BoundingBoxLimits CoordinateSpaces Ordered array containing coordinateSpace:CoordinateSpaces	The bounding box to resize. Can accept: CoordinateSpaces enumerator, BoundingBoxLimits enumerator or Ordered array containing coordinateSpace:CoordinateSpaces enumerator, boundsKind:BoundingBoxLimits enumerator.
from	AnchorPoint AnchorPoint Array of 2 Reals Array of Arrays of 2 Reals BoundingBoxLimits CoordinateSpaces Long Integers	The transform origin. Legal specifications: relative to bounding box: anchor \| {anchor \| {x,y}, bounds kind [, coordinate space]}; relative to coordinate space: {x,y} \| {{x,y}[, coordinate space]}; relative to layout window ruler: {{x,y}, page index \| bounds kind}. Can accept: Array of 2 Reals, AnchorPoint enumerator or Array of Arrays of 2 Reals, CoordinateSpaces enumerators, AnchorPoint enumerators, BoundingBoxLimits enumerators or Long Integers.
by	ResizeMethods: ResizeMethods.ADDING_CURRENT_DIMENSIONS_TO ResizeMethods.MULTIPLYING_CURRENT_DIMENSIONS_BY ResizeMethods.REPLACING_CURRENT_DIMENSIONS_WITH	How the current dimensions are affected by the given values
values	Array of : Array of Reals CoordinateSpaces ResizeConstraints	The width and height values. Legal dimensions specifications: {x, y [, coordinate space]}, {x, resize constraint [, coordinate space]}, or {resize constraint, y [, coordinate space]}; where x and y are real numbers and coordinate space is used to determine _only_ the unit of length for x and y; coordinate space is ignored for the 'current dimensions times' resize method). Can accept: Array of Reals, ResizeConstraints enumerators or CoordinateSpaces enumerators.
resizeIndividually	bool	If false and multiple page items are targeted, the new dimensions are attained only by moving the individual items rather than resizing them. (Optional) (default: true)
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)

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

Parameter	Type	Description
location	AnchorPoint AnchorPoint Array of 2 Reals Array of Arrays of 2 Reals BoundingBoxLimits CoordinateSpaces Long Integers	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: CoordinateSpaces.PASTEBOARD_COORDINATES CoordinateSpaces.PARENT_COORDINATES CoordinateSpaces.INNER_COORDINATES CoordinateSpaces.SPREAD_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)

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

string toSpecifier ()
Retrieves the object specifier.

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

Parameter	Type	Description
in	CoordinateSpaces: CoordinateSpaces.PASTEBOARD_COORDINATES CoordinateSpaces.PARENT_COORDINATES CoordinateSpaces.INNER_COORDINATES CoordinateSpaces.SPREAD_COORDINATES	The coordinate space to use
from	AnchorPoint AnchorPoint Array of 2 Reals Array of Arrays of 2 Reals BoundingBoxLimits CoordinateSpaces Long Integers	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	Array of MatrixContent Long Integer MatrixContent	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 TransformationMatrix transformValuesOf (in: CoordinateSpaces)
Get the transformation values of the page item.

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