User Guide

46 Chapter 2: The Fireworks Object Model
ExportOptions object
Note: When this object is used to set properties, the only required property is exportFormat. If other
properties are not specified, their default values are used.
Use the following information to understand the rules for determining scaling in this object.
If
useScale is set to true (the default), percentScale is used to uniformly scale the object on
export, and
applyScale is ignored.
If
useScale is set to false and applyScale is set to false (the default), no scaling is performed
on the object when it is exported.
If
useScale is set to false and applyScale is set to true, then xSize and ySize determine
scaling as follows:
• If the value is positive, specifies the exact size for the axis.
• If the value is zero, specifies that the axis varies without limit.
• If the value is negative, specifies that the axis varies but can be no larger than "abs(value)"
If one value is positive and one is negative, the positive value is always used. This gives the
following possibilities:
• xSize < 0, ySize < 0 – use min(xSize, ySize) scaling
• xSize < 0, ySize = 0 – use xSize scaling
• xSize < 0, ySize > 0 – use ySize scaling
• xSize = 0, ySize < 0 – use ySize scaling
• xSize = 0, ySize = 0 – illegal; use scale of 1.0
• xSize = 0, ySize > 0 – use ySize scaling
• xSize > 0, ySize < 0 – use xSize scaling
• xSize > 0, ySize = 0 – use xSize scaling
• xSize > 0, ySize > 0 – do not use; instead, use useScale = true and
percentScale = 0 to 100
The following table lists the properties of the ExportOptions object, along with their data types
and, where appropriate, acceptable values and notes.
frameName
string The name of the frame displayed in the
Frames panel. Default is
null.
gifDisposalMethod
string GIF89a frame disposal method. See the
GIF89a specification for details. Acceptable
values are
"unspecified" (the default),
"none", "background", and "previous".
Property Data type Notes
animAutoCrop
Boolean The default value is true.
animAutoDifference
Boolean The default value is true.
applyScale
Boolean The default value is true.
Property Data type Notes