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.

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`.
`colorMode`	string	Acceptable values are `"indexed"` (the default)`, "24 bit"`, and `"32 bit"`.
`crop`	Boolean	The default value is `false.`
`cropBottom`	integer	The default value is `0`.
`cropLeft`	integer	The default value is `0`.
`cropRight`	integer	The default value is `0`.
`cropTop`	integer	The default value is `0`.
`ditherMode`	string	Acceptable values are `"none"` (the default), `"diffusion"`, and `"2 by 2".`
`ditherPercent`	integer	0 to 100; default value is `100`.
`exportFormat`	string	Acceptable values are `"GIF"`, `"JPEG"`, `"PNG"`, `"custom"`, and `"GIF animation"`. There is no default; this value must be specified.
`frameInfo`	array	Array of ExportFrameInfo objects (for more information, see ExportFrameInfo object); can be `null` (the default).
`interlacedGIF`	Boolean	The default value is `false.`
`jpegQuality`	integer	1 to 100; the default value is `80`.
`jpegSmoothness`	integer	0 to 8; the default value is `0`.
`jpegSubsampling`	integer	0 to 4; the default value is `1`.
`localAdaptive`	Boolean	The default value is `true.`
`lossyGifAmount`	integer	0 to 100; the default value is `0`.
`macFileCreator`	string	The default value is `""` (an empty string).
`macFileType`	string	The default value is `""`(an empty string).
`name`	string	The default value is `""` (an empty string).
`numCustomEntries`	integer	0 to 256; default value is `0`.
`numEntriesRequested`	integer	0 to 256; default value is `128`.
`numGridEntries`	integer	0 to 256; default value is `6`.
`optimized`	Boolean	Default value is `true.`
`paletteEntries`	array	Array of color strings (for more information, see Color string data type); default value is `null.`
`paletteInfo`	array	Array of ExportPaletteInfo objects, or `null` if all entries in the array are default values (for more information, see ExportPaletteInfo object); default value is `null.`
`paletteMode`	string	Acceptable values are `"adaptive"` (the default), `"custom"`, `"grid"`, `"monochrome"`, `"Macintosh"`, `"Windows"`, `"exact"`, and `"Web 216".`
`paletteTransparencyType`	string	Acceptable values are `"none"` (the default), `"index"`, `"index alpha"`, and `"rgba".`
`percentScale`	integer	1 to 100,000; default value is `100`.
`progressiveJPEG`	Boolean	The default value is `false.`
`savedAnimationRepeat`	integer	The default value is `0`.
`sorting`	string	Acceptable values are `"none"` (the default), `"luminance"`, and `"popularity".`
`transparencyIndex`	integer	-1 to 255; pass `-1` to use the background color's index; default value is `-1`.
`useScale`	Boolean	The default value is `true.`
`webSnapAdaptive`	Boolean	The default value is `true.`
`webSnapTolerance`	integer	The default value is `14`.
`xSize`	integer	-100,000 to 100,000; default value is `0`. For details on using `xSize` and `ySize`, see ExportOptions object.
`ySize`	integer	-100,000 to 100,000; default value is `0`. For details on using `xSize` and `ySize`, see ExportOptions object.

Send me an e-mail when comments are added to this page | Comment Report

Current page: http://livedocs.adobe.com/fireworks/8/fwextending/fw_02_43.htm