Adobe InDesign CS2 (4.0) Object Model JS: Image

InDesign CS2

previous page next page

Class

Image

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

QuickLinks

applyObjectStyle, detach, duplicate, exportFile, extractLabel, fit, flipItem, getElements, insertLabel, markup, move, override, place, placeXML, remove, removeOverride, resize, rotate, shear, store, toSource, toSpecifier, transformAgain, transformAgainIndividually, transformSequenceAgain, transformSequenceAgainIndividually

Hierarchy

Graphic

Image

ClippingPathSettings | GraphicLayerOption | ImageIOPreference | TextWrapPreference

Properties

Property	Type	Access	Description
absoluteHorizontalScale	number	r/w	The horizontal scale of the Image relative to its containing object.
absoluteRotationAngle	number	r/w	The rotation angle of the Image relative to its containing object. (Range: -360 to 360)
absoluteShearAngle	number	r/w	The skewing angle of the Image relative to its containing object. (Range: -360 to 360)
absoluteVerticalScale	number	r/w	The vertical scale of the Image relative to its containing object.
actualPpi	Array of number	readonly	The native resolution of a placed graphic.
appliedObjectStyle	ObjectStyle	r/w	The object style applied to the Image.
associatedXMLElement	XMLItem	readonly	The XML element associated with the Image.
blendMode	BlendMode: BlendMode.NORMAL BlendMode.MULTIPLY BlendMode.SCREEN BlendMode.OVERLAY BlendMode.SOFT_LIGHT BlendMode.HARD_LIGHT BlendMode.COLOR_DODGE BlendMode.COLOR_BURN BlendMode.DARKEN BlendMode.LIGHTEN BlendMode.DIFFERENCE BlendMode.EXCLUSION BlendMode.HUE BlendMode.SATURATION BlendMode.COLOR BlendMode.LUMINOSITY	r/w	The blend mode used to combine the background with the color of the Image.
clippingPath	ClippingPathSettings	readonly	Clipping path settings.
effectivePpi	Array of number	readonly	The resolution of a graphic after it has been resized.
featherCornerType	FeatherCornerType: FeatherCornerType.SHARP FeatherCornerType.ROUNDED FeatherCornerType.DIFFUSION	r/w	The type of feathering.
featherMode	FeatherMode: FeatherMode.NONE FeatherMode.STANDARD	r/w	The feather-enabling mode.
featherNoise	number (range: 0 - 100)	r/w	The amount (as a percentage) of noise to apply to the feather. (Range: 0 to 100)
featherWidth	Measurement Unit (Number or String) (range: 0 - 1000)	r/w	The width of the feathering.
fillColor	String Swatch	r/w	The swatch (color, gradient, tint, or mixed ink) applied to the fill of the Image. . Can also accept: String.
fillTint	number	r/w	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.)
geometricBounds	Array of Measurement Unit (Number or String)	r/w	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.
graphicLayerOptions	GraphicLayerOption	readonly	Graphic layer option settings.
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 Image.
imageIOPreferences	ImageIOPreference	readonly	The image I/O preference properties that define preferences for importing images.
imageRenderingIntent	RenderingIntent: RenderingIntent.USE_COLOR_SETTINGS RenderingIntent.PERCEPTUAL RenderingIntent.SATURATION RenderingIntent.RELATIVE_COLORIMETRIC RenderingIntent.ABSOLUTE_COLORIMETRIC	r/w	The rendering intent override applied to the image.
imageTypeName	string	readonly	The type of the image.
index	number	readonly	The index of the Image within its containing object.
isolateBlending	bool	r/w	If true, the Image blends in isolation.
itemLink	Link	readonly	The source file of the link.
knockoutGroup	bool	r/w	If true, the Image is a knockout group.
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 Image.
nonprinting	bool	r/w	If true, the Image does not print.
opacity	number (range: 0 - 100)	r/w	The opacity of the Image. (Range: 0 to 100)
overprintFill	bool	r/w	If true, the Image's fill color overprints any underlying objects. If false, the fill 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	Button GraphicLine Group Movie Oval PageItem Polygon Rectangle Sound State XMLElement	readonly	The parent of the Image (a XMLElement, Sound, Movie, PageItem, Oval, Rectangle, Polygon, GraphicLine, State, Group or Button).
profile	Profile String	r/w	The color profile. Can return: Profile enumerator or String.
profileList	Array of string	readonly	A list of valid RGB profiles.
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 Image. (Range: -360 to 360)
shadowBlendMode	BlendMode: BlendMode.NORMAL BlendMode.MULTIPLY BlendMode.SCREEN BlendMode.OVERLAY BlendMode.SOFT_LIGHT BlendMode.HARD_LIGHT BlendMode.COLOR_DODGE BlendMode.COLOR_BURN BlendMode.DARKEN BlendMode.LIGHTEN BlendMode.DIFFERENCE BlendMode.EXCLUSION BlendMode.HUE BlendMode.SATURATION BlendMode.COLOR BlendMode.LUMINOSITY	r/w	The blend mode to use for drawing the shadow.
shadowBlurRadius	Measurement Unit (Number or String) (range: 0 - 144)	r/w	The radius of the shadow blur.
shadowColor	Swatch	r/w	The swatch (color or mixed ink) applied to the shadow.
shadowMode	ShadowMode: ShadowMode.NONE ShadowMode.DROP	r/w	The shadow mode.
shadowNoise	number (range: 0 - 100)	r/w	The amount (as a percentage) of noise to apply to the shadow. (Range: 0 to 100)
shadowOpacity	number (range: 0 - 100)	r/w	The opacity of the shadow. (Range: 0 to 100)
shadowSpread	number (range: 0 - 100)	r/w	The amount (as a percentage) of the blur radius to use as the shadow footprint. (Range: 0 to 100) For information, see shadow blur radius.
shadowXOffset	Measurement Unit (Number or String) (range: -1000 - 1000)	r/w	The horizontal offset of the shadow.
shadowYOffset	Measurement Unit (Number or String) (range: -1000 - 1000)	r/w	The vertical offset of the shadow.
shearAngle	number	r/w	The skewing angle applied to the Image. (Range: -360 to 360)
space	string	readonly	The color space.
textWrapPreferences	TextWrapPreference	readonly	The text wrap preference properties that define the default formatting for wrapping text around objects.
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 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.

Methods

Instances

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 Image's existing attributes before applying the style. (Optional) (default: true)
clearingOverridesThroughRootObjectStyle	bool	If true, clears attributes and formatting applied to the Image that are not defined in the object style. (Optional) (default: false)

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

PageItem duplicate ([by: Array of Measurement Unit (Number or String)])
Duplicates the Image.

Parameter	Type	Description
by	Array of Measurement Unit (Number or String)	The amount (in points) to offset the new Image, in the format [x, y]. (Optional)

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 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.FRAME_TO_CONTENT FitOptions.FILL_PROPORTIONALLY	The fit option to use.

void flipItem (given: FlipItemOptions[, around: any][, transformingContent: bool=true])
Flip item about given axis

Parameter	Type	Description
given	FlipItemOptions: FlipItemOptions.HORIZONTAL FlipItemOptions.VERTICAL FlipItemOptions.BOTH	flip item options
around	AnchorPoint Array of 2 Units	The point to flip around. Can accept: Array of 2 Units or AnchorPoint enumerator. (Optional)
transformingContent	bool	If true then both the object and items within it are flipped (Optional) (default: true)

Array of Object 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.

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 Measurement Unit (Number or String)][, transformingContent: bool=true])
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)
transformingContent	bool	If true then both the object and items within it are moved (Optional) (default: true)

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.

any place (fileName: File[, showingOptions: bool=false][, withProperties: Object])
Place a 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 remove ()
Deletes the Image.

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

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][, shearAxisAngle: number=0][, 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)
shearAxisAngle	number	The amount that the shear axis is rotated. If 0 degree then shear at its horizontal axis. If 90 degrees then shear at the vertical axis. (Optional) (default: 0)
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)

Asset store (using: Library)
Store a page item in a library

Parameter	Type	Description
using	Library	The library in which to store

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

string toSpecifier ()
Retrieves the object specifier.

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

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

Array of string transformSequenceAgain ()
Transforms the Image 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 Image 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.