Adobe InDesign CS (3.0) Object Model JS: Image

InDesign CS

Class

Image

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

QuickLinks

exportFile, extractLabel, insertLabel, markup, move, place, placeXML, remove, resize, rotate, shear, store, unlink

Hierarchy

Button | GraphicLine | Group | Movie | Oval | PageItem | Polygon | Rectangle | Sound | State | XMLElement
Graphic
Image
ClippingPathSettings | ImageIOPreference | TextWrapPreference

Properties

PropertyTypeAccessDescription
absoluteHorizontalScalenumber r/wThe horizontal scale of the Image relative to its containing object.
absoluteRotationAnglenumber r/wThe rotation angle of the Image relative to its containing object. (Range: -360 to 360)
absoluteShearAnglenumber r/wThe skewing angle of the Image relative to its containing object. (Range: -360 to 360)
absoluteVerticalScalenumber r/wThe vertical scale of the Image relative to its containing object.
actualPpi Array of number readonlyThe native resolution of a placed graphic.
associatedXMLElementXMLElement readonlyReturns the associated XML element
blendModeBlendMode:
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/wThe blend mode used to combine the background with the color of the Image.
clippingPathClippingPathSettings readonlyClipping path settings.
effectivePpi Array of number readonlyThe resolution of a graphic after it has been resized.
featherCornerTypeFeatherCornerType:
FeatherCornerType.SHARP
FeatherCornerType.ROUNDED
FeatherCornerType.DIFFUSION
r/wThe type of feathering.
featherModeFeatherMode:
FeatherMode.NONE
FeatherMode.STANDARD
r/wThe feather-enabling mode.
featherWidthnumber r/wThe width of the feathering
fillColorString
Swatch
r/wThe swatch (color, gradient, tint, or mixed ink) applied to the fill of the Image. . Can also accept: String.
fillTintnumber r/wThe 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/wThe 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.
horizontalScalenumber r/wThe horizontal scaling applied to the text as a percentage of its current size. (Range: 1 to 1000)
idnumber readonlyThe unique ID of the Image.
imageIOPreferencesImageIOPreference readonlyThe image I/O preference properties that define preferences for importing images.
imageRenderingIntentRenderingIntent:
RenderingIntent.USE_COLOR_SETTINGS
RenderingIntent.PERCEPTUAL
RenderingIntent.SATURATION
RenderingIntent.RELATIVE_COLORIMETRIC
RenderingIntent.ABSOLUTE_COLORIMETRIC
r/wThe rendering intent override applied to the image.
imageTypeNamestring readonlyThe type of the image.
indexnumber readonlyThe index of the Image within its containing object.
isolateBlendingbool r/wIf true, the Image blends in isolation.
itemLinkLink readonlyThe source file of the link.
knockoutGroupbool r/wIf true, the Image is a knockout group.
labelstring r/wA property that can be set to any string.
localDisplaySettingDisplaySettingOptions:
DisplaySettingOptions.HIGH_QUALITY
DisplaySettingOptions.TYPICAL
DisplaySettingOptions.OPTIMIZED
DisplaySettingOptions.DEFAULT_VALUE
r/wDisplay performance options for the Image.
nonprintingbool r/wIf true, the Image does not print.
opacitynumber r/wThe opacity of the object
overprintFillbool r/wIf true, the Image's fill color overprints any underlying objects. If false, the fill color knocks out the underlying colors.
parentButton
GraphicLine
Group
Movie
Oval
PageItem
Polygon
Rectangle
Sound
State
XMLElement
readonlyThe parent of the Image (a XMLElement, Sound, Movie, PageItem, Oval, Rectangle, Polygon, GraphicLine, State, Group or Button).
profileProfile
String
r/wThe color profile. Can return: Profile enumerator or String.
profileList Array of string readonlyA list of valid RGB profiles.
propertiesObject r/wA property that allows setting of several properties at the same time.
rotationAnglenumber r/wThe rotatation angle of the Image. (Range: -360 to 360)
shadowBlendModeBlendMode:
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/wThe blend mode to use for drawing the shadow.
shadowBlurRadiusnumber r/wThe radius of the shadow blur.
shadowColorSwatch r/wThe swatch (color or mixed ink) applied to the shadow.
shadowModeShadowMode:
ShadowMode.NONE
ShadowMode.DROP
r/wThe shadow mode.
shadowOpacitynumber r/wThe opacity of the shadow
shadowXOffsetnumber r/wThe horizontal offset of the shadow.
shadowYOffsetnumber r/wThe vertical offset of the shadow.
shearAnglenumber r/wThe skewing angle applied to the Image. (Range: -360 to 360)
spacestring readonlyThe color space.
textWrapPreferencesTextWrapPreference readonlyThe text wrap preference properties that define the default formatting for wrapping text around objects.
verticalScalenumber r/wThe 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/wThe 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 exportFile (format: any, to: File[, showingOptions: bool=false][, using: PDFExportPreset])
Exports the object(s) to a file.

ParameterTypeDescription
formatExportFormat
String
The export format. Can accept: ExportFormat enumerator or String.
toFileThe path of the export file.
showingOptionsboolIf true, prompts the user to select export options. (Optional) (default: false)
usingPDFExportPresetThe export style to use. (Optional)

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

ParameterTypeDescription
keystringThe key.

void insertLabel (key: string, value: string)
Sets the label to the value associated with the specified key.

ParameterTypeDescription
keystringThe key.
valuestringThe value.

void markup (using: XMLElement)
Associates the page item with the specified XML element while preserving existing content.

ParameterTypeDescription
usingXMLElementThe XML element.

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.

ParameterTypeDescription
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.

ParameterTypeDescription
fileNameFileThe 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)
showingOptionsboolWhether to display the import options dialog (Optional) (default: false)
autoflowingboolWhether to autoflow placed text (Optional) (default: false)
retainingFormattingboolWhether to keep formatting of placed text files (Optional) (default: true)
convertingQuotesboolWhether to convert to typographer's quotes (Optional) (default: true)
withPropertiesObjectInitial 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.

ParameterTypeDescription
usingXMLElementThe XML element whose content you want to place.

void remove ()
Deletes the Image.

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.

ParameterTypeDescription
horizontalScalenumberThe percentage of horizontal scale (Optional)
verticalScalenumberThe percentage of vertical scale (Optional)
aroundAnchorPoint
Array of 2 Units
The point to scale around. Can accept: Array of 2 Units or AnchorPoint enumerator. (Optional)
consideringCurrentScaleboolIf 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)
transformingContentboolIf true then both the object and items within it are scaled (Optional) (default: true)
consideringParentsScaleboolIf 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

ParameterTypeDescription
bynumberAngle by which to rotate the page item
aroundAnchorPoint
Array of 2 Units
The point to rotate around. Can accept: Array of 2 Units or AnchorPoint enumerator. (Optional)
consideringCurrentRotationboolIf 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)
transformingContentboolIf true then both the object and items within it are rotated (Optional) (default: true)
consideringParentsRotationboolIf 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

ParameterTypeDescription
bynumberAngle by which to shear the object
aroundAnchorPoint
Array of 2 Units
The point to shear around. Can accept: Array of 2 Units or AnchorPoint enumerator. (Optional)
consideringCurrentShearboolIf 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)
transformingContentboolIf true then both the object and items within it are sheared (Optional) (default: true)
consideringParentsShearboolIf 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

ParameterTypeDescription
usingLibraryThe library in which to store

void unlink (from: UnlinkFrom)
Detaches an overridden master page item from the page or from the master

ParameterTypeDescription
fromUnlinkFrom:
UnlinkFrom.PAGE
UnlinkFrom.MASTER_SPREAD
What to unlink from

Element of

ImageIOPreference.parent

Jongware, 27-Jun-2010 v3.0.3dContents :: Index