download the extension package.
5 Save the extension package in a directory on your machine. 6 In Fireworks, choose Commands > Manage Extensions to start the Extension Manager (or,
you can start Extension Manager, located in the Macromedia program group, independently from Fireworks). 7 In the Extension Manager, choose File > Install Extension, and choose the extension package you just saved. The Extension Manager automatically installs the extension into Fireworks. You cannot begin using some extensions until you restart Fireworks. If you are running Fireworks when you install the extension, you might be prompted to quit and restart the application. To view basic information on the extension after its installation, go to the Extension Manager (Commands > Manage Extensions) in Fireworks.
Whats new in Extending Fireworks MX 2004
Fireworks MX 2004 includes the following new features and interfaces that you can use to develop extensions for the product:
Cross-product JavaScript communication
Cross-product JavaScript communication allows any application to control Fireworks by sending JavaScript instructions directly to Fireworks encoded in XML through a local socket. Through this connection, Fireworks can do anything that is supported in the Fireworks API. Event handling for SWF panels Third-party command panels developed in Flash for Fireworks (SWF command panels) can listen and respond to events that happen inside Fireworks MX 2004. So, if you develop a SWF command panel that creates a specific object for the user (such a spiral pattern), you can also leverage the new Fireworks event handling so the user can inspect the object and adjust the object properties. Auto Shapes Along with the new Auto Shapes implementation, the Fireworks M X 2004 API lets you define an Auto Shape entirely in JavaScript. (For information about working with Auto Shapes in Fireworks, see Using Fireworks Help.)
Chapter 1: Extending Fireworks Overview
Conventions used in this guide
The following typographical conventions are used in this guide:
Code font indicates code fragments and API literals, including class names, method names, function names, type names, scripts, SQL statements, and HTML and XML tag and attribute names. Italic code font indicates replaceable items in code. The continuation symbol () indicates that a long line of code has been broken across two or more lines to fit on the page. When copying the lines of code, eliminate the continuation symbol and type the code as one line. Curly braces ({ }) around a function argument indicate that the argument is optional.

gridSize.x is the horizontal grid size; gridSize.y is the vertical grid size.

frames

array Boolean

gammaPreview

gradients

gridColor

gridOrigin

gridSize

point object integer

guides

Guides object (see Guides object on page 53). Total height of the document, in pixels. To find the bottom edge of the document, use document.

top + document.height.

height

isDirty

Boolean Boolean Boolean
Set to true if the document was modified since the last ti me it was saved. Set to true if the document is currently in paint-mode editing, false otherwise. Set to true if the document is a Symbol or Button document, false if it is an ordinary document. You might see this when looking through the list of open documents and one is a symbol-editing window. Set to true if the document is open in Fireworks; false otherwise. (Occasionally the JavaScript object that is associated with a document lingers after the document closes; this property lets you check for that eventuality.)

isPaintMode

isSymbolDocument

isValid

Boolean

lastExportDirectory

Notes The path to the last directory to which the file was exported, which is expressed as file:// URL, or null if the file was never exported. For instance, if the document was last exported to "file:///files/current/ logo.gif", it returns "file:///files/ current". The name that was used the last time the file was exported, or null if the file was never exported. For instance, if the document was last exported to "file:///files/current/ logo.gif", it returns "logo.gif". An array of Layer objects in the document (see Layer object on page 54). Coordinate of the left edge of the document, in pixels. To find the right edge of the document, use document.left +

document.width.

lastExportFile

layers

array integer

mapType

Acceptable values are "client", "server", and "both". Corresponds to the image-map type selected in File > HTML Properties > ImageMap. A color string that corresponds to the matte color specified in the Optimize panel (see Color string data type on page 11). This string is used by the useMatteColor property. Number of frames after the current frame to show through onion skinning. Corresponds to the onion-skin controls in the left edge of the Frames panel. A value of 0 indicates no onion skinning; a very large value (such as 99,999) indicates onion skinning of all frames after the current frame. Similar to the onionSkinAfter property, but refers to the number of frames to show through onion skinning before the current frame. List of internal pattern names. PathAttrs object (see PathAttrs object on page 54). This object specifies default attributes that will be applied to all newly created objects. A structure that can be used to store various chunks of text in a well-known format. For more information, see The pngText object on page 16.

activeViewScale

Data type float string string
Notes The scaling (zoom value) of the active view. 1.0=100% of the normal view. The path to the Batch Code directory, which is expressed as file://URL. The path to the directory that contains the Fireworks application, which is expressed as file://URL. The path to the Export Settings directory, which is expressed as file://URL. In Fireworks, this folder is stored on a peruser basis on multiuser systems. Even on single-user systems, this folder is not inside the Fireworks installation directory. The path to the URL Libraries directory, which is expressed as file://URL. In Fireworks, this folder is stored on a peruser basis on multiuser systems. Even on single-user systems, this folder is not inside the Fireworks installation directory. The path to the directory that contains the Fireworks help file, which is expressed as file://URL. The path to the HTML Code directory, which is expressed as file://URL. The path to the Commands directory, which is expressed as file://URL. The path to the JSExtensions directory, which is expressed as file://URL.
In the format: "MKBY" In the format: "TEXT"

appBatchCodeDir

appDir

appExportSettingsDir

appFavoritesDir

appHelpDir

appHtmlCodeDir
string string string string string

appJsCommandsDir

appJsExtensionsDir
appMacCreator appMacJsfFileType

appName

Notes The name of the application ("Fireworks MX 2004"). This attribute is part of the common API, so it also appears as app.appName (as implemented in Macromedia Dreamweaver). The path to the Patterns directory, which is expressed as file://URL. The path to the Preferences directory, which is expressed as a file://URL. The path to the Presets directory, which is expressed as file://URL. In Fireworks, this folder is stored on a peruser basis on multiuser systems. Even on single-user systems, this folder is not inside the Fireworks installation directory. The path to the Settings directory, which is expressed as file://URL. The path to the applications Auto Shapes directory, which is expressed as file://URL. The path to the applications Auto Shape Tools directory, which is expressed as file:// URL. The path to the Styles directory, which is expressed as file://URL. In Fireworks, this folder is stored on a peruser basis on multiuser systems. Even on single-user systems, this folder is not inside the Fireworks installation directory. The path to the SWF Commands directory, which is expressed as a file://URL. The path to the Libraries directory, which is expressed as file://URL. The path to the Textures directory, which is expressed as file://URL. The path to the Xtras directory, which is expressed as file://URL. The string that currently appears in the Batch Progress dialog box. Set this property to change the string being displayed. Use with progressCountCurrent and progressCountTotal.

sliceAutoNaming1: sliceAutoNaming2: sliceAutoNaming3: sliceAutoNaming4: sliceAutoNaming5: sliceAutoNaming6: "doc.name" "underscore" "slice" "numeric01" "none" "none"
sliceFrameNaming1 and sliceFrameNaming2
Notes Used to generate a name by concatenating two strings; the resulting string is concatenated to the name specified by sliceAutoNaming. If you need fewer than two strings, fill in the remaining string with "none". Acceptable values are: "none" generates nothing. "frameNumber" generates frame number preceded by f, for example, f2. "number" generates frame number, for example, 2. "state" generates frame state, for example, "over", "down", or "overdown". "abbreviation" generates abbreviated state, for example, "o", "d", or "od". "underscore" the underscore character (_) "period" the period character (.) "space" the space character ( ) "hyphen" the hyphen character (-) If set to true, use slice objects for slicing (and sliceAlongGuides should be set to false). HTML style to be used during export. Acceptable values are "Dreamweaver", "Generic", "FrontPage", "GoLive", or a usercreated HTML style.

sliceUsingUrls

templateName
Fill object The following table lists the properties of the Fill object, along with their data types and, where appropriate, acceptable values and notes.
Data type string array string integer object string object
Notes Specifies where this fill appears in the Fill panel. Array of two color strings (see Color string data type on page 11). Acceptable values are "hard" and "antialiased". 0 to 1000, which represents the feathering value in pixels (0 means no feathering). Gradient object (see Gradient object on page 53). The name that appears in the Fill panel. Pattern object (see Pattern object on page 55).

ditherColors

edgeType

feather

gradient

name pattern

Notes Acceptable values are "solid", "linear", "radial", "conical", "satin", "pinch", "folds", "elliptical", "rectangular", "bars", "ripple", "waves", "pattern", and "web dither". Acceptable values are "blend" and "blend opaque". 0 to 100 If set to true (and shape is set to "web dither"), then the second color in the ditherColors array is ignored and transparent is used instead.

hGuides

array Boolean array

vGuides

Layer object The following table lists the properties of the Layer object, along with their data types and, where appropriate, acceptable values and notes. Read-only properties are marked with a bullet ().

disclosure

Notes If set to true, the Layers list displays all the objects in the layer. If set to false, only the name of the layer appears. An array of FrameNLayerIntersection objects (see FrameNLayerIntersection object on page 52). Acceptable values are "normal" and "web". Might be null (removes any existing name). Acceptable values are "shared" and "not shared".

layerType name sharing

PathAttrs object The following table lists the properties of the PathAttrs object, along with their data types and, where appropriate, acceptable values and notes.

Data type object string

Notes Brush object (see Brush object on page 26). A color string that specifies the color that is used for rendering the Brush object, if any (see Color string data type on page 11). Acceptable values are "inside", "center", and "outside". Texture object (see Texture object on page 44). Fill object (see Fill object on page 51). A color string that specifies the color that is used for rendering the Fill object, if any (see Color string data type on page 11). The three fillHandle properties are used by Gradient and Pattern fills to set the angle and size of the gradient/pattern.

brushColor

brushPlacement
string object object string

brushTexture

fill fillColor
fillHandle1 fillHandle2 fillHandle3 fillOnTop
point point point Boolean
If set to true, the fill is drawn on top of the brush; if set to false (the default), the fill is drawn beneath the brush. Texture object (see Texture object on page 44).

fillTexture

Pattern object The following table lists the property of the Pattern object, along with its data type and notes.
Notes The name that appears in the Fill panel.
RectanglePrimitive object The following table lists the properties and methods of the RectanglePrimitive object, along with their data types and, where appropriate, acceptable values and notes.

roundness

Notes A floating-point value between 0 and 1 that specifies the roundness to use for the corners (0 is no roundness, 1 is 100% roundness). A rectangle that specifies the original sides of the primitive (see Rectangle data type on page 11). Because rectangle primitives remember transformations, the user might see something different from the original sides. A matrix that indicates all the transformations that were applied to the primitive (see Matrix data type on page 11). A PathAttrs object that indicates the path attributes of the primitive (see PathAttrs object on page 54).

originalSides

transform

matrix

RegisterMoveParms object The following table lists the properties of the RegisterMoveParms object, along with their data types and, where appropriate, acceptable values and notes.

constrainAngles

Notes Determines whether dragging the control point constrains the angles to the minAngle and maxAngle values. Pass in the key that you want to use to constrain the rotation. A value of "none" means that rotation will not be constrained. A value of "shiftKey" means that when the user holds downs the Shift key while dragging the mouse, rotation will be constrained. The value can be one of the following: "none", "shiftKey", "ctrlCmdKey", "altOptKey". Note: these points are set with minAngle and maxAngle. The value to constrain the x coordinate. Note: the method constrainXKey must be used in conjunction with this method. Pass in the key that you want to use to constrain the x-coordinate value. A value of "none" means that x will not be constrained. A value of "shiftKey" means that when the user holds downs the shift key while dragging the mouse, x will be constrained. The value can be one of the following: "none", "shiftKey", "ctrlCmdKey", "altOptKey". The value to constrain the y coordinate. Note: the method constrainYKey must be used in conjunction with this method. Pass in the key that you want to use to constrain the y-coordinate value. A value of "none" means that y will not be constrained. A value of "shiftKey" means that when the user holds downs the Shift key while dragging the mouse, the value of y will be constrained. The value can be one of the following: "none", "shiftKey", "ctrlCmdKey", "altOptKey".

constrainRotateKey

constrainX

constrainXKey

constrainY

constrainYKey

Creating event handlers To create an event handler, implement a function with the corresponding event name. Currently, Fireworks supports the following events for Flash panels:
Event onFwStartMovie onFwStopMovie onFwUnitsChange onFwPICollapseOrExpand onFwDocumentNameChange onFwCurrentFrameChange onFwCurrentLayerChange onFwHistoryChange onFwApplicationDeactivate onFwApplicationActivate onFwSymbolLibraryChange onFwURLListChange onFwFavoritesChange onFwPreferencesChange onFwDocumentSizeChange onFwActiveViewChange onFwPixelSelectionChange onFwActiveSelectionChange onFwActiveDocumentChange onFwActiveToolParamsChange onFwActiveToolChange onFwZoomChange onFwObjectSettingChange Description Sent to the SWF file right after Fireworks has started (or restarted) the SWF file. Sent to the SWF file right before Fireworks stops the file (and possibly unloads it). Sent when the user changes the type of units (inches, pixels, centimeters) in the Info panel. Sent when the user switches the PI between two rows high and four rows high. Sent when the name of the current document changes (for example, when the user performs a save). Sent when the user selects a different frame. Sent when the user selects a different layer. Sent when the user creates an non-scriptable history step. Sent when the Fireworks application loses focus. Sent when the Fireworks application gains focus. Sent when the symbol library changes in some way. Sent when a new URL is added to the document. Sent when the favorite urls list is modified. Sent when the preferences are changed. Sent when the document is resized. Sent when the active view changes. This happens when the user changes focus in 2- or 4-Up view. Sent when the pixel selection changes. Sent when the selection changes in a document. Sent when the user creates a new document, closes a document, opens a document, or switches between open documents. Sent when the user changes the tool stroke or fill attributes. Sent when the user changes tools. Sent when the zoom setting for the current document changes. Sent when a stroke or fill setting is changed for the selected object.
Note: The event handler must be implemented in the global namespace. Any events that are in the SWF file but aren't global, or are only read after Fireworks checks for events, will not work correctly.
Example function onFwDocumentNameChange() { // your code goes here } Example _global.onFwDocumentNameChange = function () { // your code goes here }

are "left", "right", "top", "bottom", "center vertical",
Aligns the selection. dom.appendPointToHotspot()
Usage dom.appendPointToHotspot(pt, tolerance) Arguments pt
A point that specifies the x,y coordinates of the point to be added (see Point data type on page 11).
A floating-point value > = 0 that specifies the tolerance between the new point and the starting point of the polyline path. If the new point is within tolerance of the starting point, the polyline path is closed.

tolerance Returns

Appends a point to the selected unclosed polygon Hotspot. If an unclosed polygon Hotspot is not selected, a new polygon Hotspot is created with the single point that passed in.

dom.appendPointToPath()

Usage dom.appendPointtoPath(ontourIndex, ptToInsertBefore, controlPointFirst, mainPoint, controlPointLast) Arguments contourIndex An zero-based index value that specifies the contour to which the Bzier point is appended. For paths with multiple contours, the contours are in an arbitrary order. ptToInsertBefore A zero-based index value that specifies where on the path the new point should be placed. The new point is appended in front of the point that this integer represents. To add a point to the beginning of the path, pass 0; to add a point to the end of the path, pass a large number. controlPointFirst, mainPoint, and controlPointLast
Points that specify the x,y coordinates of the preceding control point, the main point, and the following control point of the new point (see Point data type on page 11).
Appends a Bzier point to the selected path.
See also dom.insertPointInPath()

dom.appendPointToSlice()

Usage dom.appendPointToSlice(pt, tolerance) Arguments pt
Appends a point to the selected unclosed polygon slice. If an unclosed polygon slice is not selected, then a new polygon slice is created with the single point that passed in. dom.applyCharacterMarkup()
Fireworks 3, enhanced in 4.
Usage dom.applyCharacterMarkup(tag) Arguments tag Acceptable values for tag are "b", "i", and "u", for bold, italic, and underline: "fwplain", which was added in Fireworks 4, for text with no character markup. Returns

Pastes the Clipboard contents into the document as an element mask. Only one element can be selected when calling this function. If more than one element (or none) is selected when this function is called, Fireworks throws an exception. An exception is also thrown if there is nothing on the Clipboard. dom.clipPasteAttributes()
Usage dom.clipPasteAttributes() Arguments
Pastes the attributes from the Clipboard onto the selection.
The following command applies the attributes that were copied to the Clipboard onto the selected items.
fw.getDocumentDOM().clipPasteAttributes();
dom.clipPasteFromChannelToChannel()
Usage dom.clipPasteFromChannelToChannel(fromChannel, toChannel) Arguments fromChannel If the current selection is not a single bitmap, a new opaque bitmap is created and the fromChannel is pasted in to all three color channels of the new bitmap, resulting in a
grayscale image. This first argument is ignored if the current selection is not a single bitmap.

toChannel Returns

If the currently selected element is a bitmap, the toChannel argument is used to specify where to paste the color data.
Pastes the specified color channel on the Clipboard into each of the RGB channels of a new image or into the specified channel of the selected image, if any.
The following command copies the red data from the Clipboard into the red channel:
fw.getDocumentDOM().clipPasteFromChannelToChannel("red", "red");
The following command copies the green data from the clipboard into the alpha channel:
fw.getDocumentDOM().clipPasteFromChannelToChannel("green", "alpha");

dom.clipPasteInside()

Fireworks 3, deprecated in 4 in favor of dom.clipPasteAsMask() (see dom.clipPasteAsMask() on page 128).
Usage dom.clipPasteInside({whatIfResolutionDifferent}) Arguments whatIfResolutionDifferent An optional string that specifies how resampling should be done if the resolution of the Clipboard contents doesnt match the resolution of the document. Acceptable values for whatIfResolutionDifferent are "resample", "do not resample", and "ask user" (displays a dialog box to let the user decide). If whatIfResolutionDifferent is omitted or null, "ask user" is assumed. Returns
Pastes the Clipboard contents into the selection, and makes the selected element into the element mask for the pasted element(s). If the selected element already has a mask, this function groups the pasted elements with the selected element and applies the existing element mask to the group.
The following command pastes the Clipboard contents inside the selected items. If the resolution of the Clipboard doesnt match the resolution of the document, Fireworks resamples the Clipboard contents to match the document.

Specifies copying instead of moving the selection.
doSubSel If doSubSel is set to true, the function moves only the subselected parts of a path. If the argument is set to false, the function moves the whole object. Returns
Moves or copies the selection to the specified location.
The following command copies only the selected parts of a path to the specified coordinates:
fw.getDocumentDOM().moveSelectionTo({x:163, y:0}, true, true);
dom.moveSelectionToFrame()
Usage dom.moveSelectionToFrame(frameIndex, bMakeCopy) Arguments frameIndex bMakeCopy Returns
An integer value that specifies the frame to which the selection is moved or copied, starting with 0 (although, to specify the current frame, pass 1 here). If bMakeCopy is true, the selection is copied instead of moved.
Moves or copies the selection to the specified frame.
dom.moveSelectionToLayer()
Usage dom.moveSelectionToLayer(layerIndex, bMakeCopy, {whatIfMultipleSelected}, {elementIndex}) Arguments layerIndex An integer value that specifies the layer to which the selection should be moved or copied, starting with 0 (although, to specify the current layer, pass 1 here). bMakeCopy
If bMakeCopy is true, the selection is copied instead of moved.
whatIfMultipleSelected An optional string that is used only if the destination is a web layer and bMakeCopy is true. It specifies how to create Hotspots if multiple items are selected. Acceptable values for whatIfMultipleSelected are "single" (creates a single Hotspot that has the same bounding rectangle as the selection), "multiple" (creates one Hotspot for each item), and "ask user" (displays a dialog box to let the user decide). If whatIfMultipleSelected is omitted or null, "ask user" is assumed.
A zero-based index, added in Fireworks 4, that specifies the element before which the moved or copied selection should be inserted. If elementIndex is omitted, the selection is placed at the top of the layer (before any other elements). Otherwise, it is an index within the existing elements in the layer, where 0 is the topmost, and (n-1) is the last element (for a layer with n elements). The maximum value is the number of elements previously in the layer meaning that the elements are moved to the bottom of the specified layer.

See also dom.selectSimilarFromPoint()
dom.selectSimilarFromPoint()
Usage dom.selectSimilarFromPoint(where, tolerance, edgemode, featherAmt, combinemode)
Arguments where A point that specifies the x,y coordinates of the pixel whose color is used to calculate the new mask (see Point data type on page 11). tolerance An integer between 0 and 255, inclusive, that specifies the tolerance for selecting pixels. edgemode
Acceptable values are "hard edge", "antialias", and "feather". specifies the number of pixels to feather. This value is ignored if
Behavior is almost identical to dom.selectSimilar(), except that the new mask is calculated from the color at the specified location in the image, rather than from the average color in the selection.
See also dom.selectSimilar()

dom.sendEmail()

Usage dom.sendEmail(fileAttachment) Arguments fileAttachment
A string, which is expressed as file://URL, denoting the location of a file to

send by e-mail.

Creates a new e-mail with the specified file as an attachment.
The following example opens a new e-mail in the default e-mail program and attaches the file foo.png to the message:
fw.getDocumentDOM().sendEmail("file:///Users/andy/Documents/foo.png");
dom.setAllLayersDisclosure()
Usage dom.setAllLayersDisclosure(bDisclosed) Arguments bDisclosed If bDisclosed is true, all the false, only layer names appear on the list. Returns
elements on all layers appear in the Layers list. If
Specifies whether all the elements in all layers appear in the Layers list.
See also dom.setLayerDisclosure()
dom.setAnimInstanceLoopCount()
Fireworks 3, deprecated in 4 in favor of dom.setAnimInstanceNumFrames().
Usage dom.setAnimInstanceLoopCount(loopCount) Arguments loopCount Returns
An integer that corresponds to the loop count value that appears in the Objects panel when a multiframe image instance is selected.
Sets the loop count of the selected instances of multiframe image symbols. dom.setAnimInstanceNumFrames()
Usage dom.setAnimInstanceNumFrames(numFrames) Arguments numFrames
An integer that specifies the number of frames through which the symbol animates.
Sets the number of frames to animate the currently selected animation element.
See also dom.convertToAnimSymbol()
dom.setAnimInstanceOffsetDist()
Usage dom.setAnimInstanceOffsetDist(offsetDistPt) Arguments offsetDistPt A point that specifies the distance the animation moves in pixels. For example, passing ({x:100, y:25}) animates the symbol to the right by 100 pixels and down by 25 pixels. Returns

A string that specifies the new name of the gradient.
Renames a gradient. dom.setGridOrigin()
Usage dom.setGridOrigin(gridOrigin) Arguments gridOrigin Returns
A point that specifies the x,y coordinates of the documents grid origin (see Point data type on page 11).
Sets the grid origin for the document. dom.setGridSize()
Usage dom.setGridSize(gridSize)
Arguments gridSize Returns
A point that specifies the x,y coordinates that are used for the documents grid size (see Point data type on page 11).
Sets the grid size for the document. dom.setGridColor()
Usage dom.setGridColor(gridColor) Arguments gridColor Returns
Sets the color used to display the grid. dom.setGroupType()
Usage dom.setGroupType({type}) Arguments type An optional string that specifies how to group the items. Acceptable values are "normal", "mask to image", and "mask to path". If the argument is omitted, "normal" is assumed. ("mask to image" and "mask to path" are deprecated in Fireworks 4.) Returns
Changes the group type of the currently selected groups.

dom.setGuideColor()

Usage dom.setGuideColor(guideColor) Arguments guideColor Returns
Sets the color that is used to display normal (nonslice) guides. To set the color of slice guides, use
dom.setSliceGuideColor(). See also dom.setSliceGuideColor()

dom.setHotspotAltTag()

Usage dom.setHotspotAltTag(whatToSet, altTagString) Arguments whatToSet
Acceptable values are "hotspots", "slices", and "hotspots and slices". A string that specifies the text to be used for the alt tag.

altTagString Returns

Sets the alt tag text to the specified value for the Hotspots and slices in the selection.
The following command sets the text attributes of the alt tag of the selected slices to "This is my alt tag".
fw.getDocumentDOM().setHotspotAltTag("slices","This is my alt tag");

dom.setHotspotColor()

Usage dom.setHotSpotColor(whatToSet, color) Arguments whatToSet color Returns
Acceptable values are "hotspots", "slices", and "hotspots and slices".
Sets the color to the specified value for the Hotspots and slices in the selection.
The following command sets the color of the selected Hotspots to red.
fw.getDocumentDOM().setHotspotColor("hotspots", "#ff0000");
dom.setHotspotRectangle()
Usage dom.setHotspotRectangle(boundingRectangle, bMakeCopy) Arguments boundingRectangle A rectangle that specifies the size of the new Hotspot or slice (see Rectangle data type on page 11). bMakeCopy
A Boolean value; if it is true, the selection is copied and resized instead of moved

A floating-point number that describes how much to scale the text characters horizontally. A value of 1.0 is normal. Values greater than 1.0 make the characters wider, and values less than 1.0 make the characters narrower.
Sets the horizontal scaling of text. For vertical text mode, this function stretches or compresses the height of the characters. dom.setTextLeading()
Usage dom.setTextLeading(leadingValue, leadingMode) Arguments leadingValue A floating-point number that determines the spacing between two lines of text. The meaning of leadingValue depends on leadingMode. leadingMode leadingValue leadingValue Returns
Acceptable values are "exact" or "percentage". If set to "exact", is the number of pixels between two lines of text. If set to "percentage", is a percentage of the default leading; 1.0 is the default leading, 0.5 is half the default leading, and 2.0 is double the default leading.
Sets the leading between lines of text. For vertical text mode, the leading is the space between two adjacent columns of text.

dom.setTextOnPathMode()

Usage dom.setTextOnPathMode(mode) Arguments mode Acceptable values "skew horizontal". Returns
are "rotate", "vertical", "skew vertical", and
Determines how the selected text-on-a-path items are displayed. dom.setTextOnPathOffset()
Usage dom.setTextOnPathOffset(offset) Arguments offset Returns
A floating-point value that specifies the offset distance, in pixels.
Sets the offset value between the items in the selected text-on-a-path. dom.setTextOrientation()
Usage dom.setTextOrientation(orientation) Arguments orientation Acceptable values are "horizontal left to right", "vertical right to left", "horizontal right to left", and "vertical left to right".
Sets the horizontal/vertical text orientation of the selected text items. dom.setTextParaIndent()
Usage dom.setTextParaIndent(paraIndent) Arguments paraIndent Returns
The number of pixels by which to indent the first line of a paragraph.
Sets the paragraph indention of text, in pixels. dom.setTextParaSpacingAfter()
Usage dom.setTextParaSpacingAfter(paraSpaceAfter) Arguments paraSpaceAfter
The number of pixels to place after a paragraph before starting the

next paragraph.

Sets the after-paragraph spacing for text; that is, the number of pixels to move down before starting the next paragraph. For vertical text mode, this function defines the vertical distance between paragraphs.
dom.setTextParaSpacingBefore()
Usage dom.setTextParaSpacingBefore(paraSpaceBefore) Arguments paraSpaceBefore Returns
The number of pixels to move down before starting a new paragraph.
Sets the before-paragraph spacing for text; that is, the number of pixels to move down from the previous paragraph before starting the new paragraph. For vertical text mode, this function defines the vertical distance between paragraphs. If you apply dom.setTextParaSpacingAfter() in one paragraph, and dom.setTextParaSpacingBefore() in the second paragraph, the space between the two paragraphs would be the sum of both spacing arguments. dom.setTextRuns()