Adobe 65011817 Extended User Guide - Page 257

ExportFrameInfo object, ExportOptions object

Page 257 highlights

Last updated 12/8/2009 EXTENDING FIREWORKS 253 Objects within Fireworks documents Property mode owner showAttrs Data type string object Boolean Notes Acceptable values are "mask to image" and "mask to path". The element (image, path, text, and so on) that owns the mask. If set to true, and mode is "mask to path", the mask element's fill and stroke (if any) are drawn. If set to false, the mask element's fill and stroke are ignored. ExportFrameInfo object The following table lists the properties of the ExportFrameInfo object, along with their data type and, where appropriate, acceptable values and notes. Property delayTime frameHidden frameName gifDisposalMethod Data type integer Boolean string string Notes For GIF animations, the delay time between frames, in 1/100ths of a second. For example, if you set delayTime to 200, two seconds elapse before the next frame in the animation appears. Default value is 7. If set to false (the default), the frame is exported. If set to true, the frame is hidden and not exported. The name of the frame displayed in the Frames panel. Default is null. GIF89a frame disposal method. See the GIF89a specification for details. Acceptable values are "unspecified" (the default), "none", "background", and "previous". 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

  • 1
  • 2
  • 3
  • 4
  • 5
  • 6
  • 7
  • 8
  • 9
  • 10
  • 11
  • 12
  • 13
  • 14
  • 15
  • 16
  • 17
  • 18
  • 19
  • 20
  • 21
  • 22
  • 23
  • 24
  • 25
  • 26
  • 27
  • 28
  • 29
  • 30
  • 31
  • 32
  • 33
  • 34
  • 35
  • 36
  • 37
  • 38
  • 39
  • 40
  • 41
  • 42
  • 43
  • 44
  • 45
  • 46
  • 47
  • 48
  • 49
  • 50
  • 51
  • 52
  • 53
  • 54
  • 55
  • 56
  • 57
  • 58
  • 59
  • 60
  • 61
  • 62
  • 63
  • 64
  • 65
  • 66
  • 67
  • 68
  • 69
  • 70
  • 71
  • 72
  • 73
  • 74
  • 75
  • 76
  • 77
  • 78
  • 79
  • 80
  • 81
  • 82
  • 83
  • 84
  • 85
  • 86
  • 87
  • 88
  • 89
  • 90
  • 91
  • 92
  • 93
  • 94
  • 95
  • 96
  • 97
  • 98
  • 99
  • 100
  • 101
  • 102
  • 103
  • 104
  • 105
  • 106
  • 107
  • 108
  • 109
  • 110
  • 111
  • 112
  • 113
  • 114
  • 115
  • 116
  • 117
  • 118
  • 119
  • 120
  • 121
  • 122
  • 123
  • 124
  • 125
  • 126
  • 127
  • 128
  • 129
  • 130
  • 131
  • 132
  • 133
  • 134
  • 135
  • 136
  • 137
  • 138
  • 139
  • 140
  • 141
  • 142
  • 143
  • 144
  • 145
  • 146
  • 147
  • 148
  • 149
  • 150
  • 151
  • 152
  • 153
  • 154
  • 155
  • 156
  • 157
  • 158
  • 159
  • 160
  • 161
  • 162
  • 163
  • 164
  • 165
  • 166
  • 167
  • 168
  • 169
  • 170
  • 171
  • 172
  • 173
  • 174
  • 175
  • 176
  • 177
  • 178
  • 179
  • 180
  • 181
  • 182
  • 183
  • 184
  • 185
  • 186
  • 187
  • 188
  • 189
  • 190
  • 191
  • 192
  • 193
  • 194
  • 195
  • 196
  • 197
  • 198
  • 199
  • 200
  • 201
  • 202
  • 203
  • 204
  • 205
  • 206
  • 207
  • 208
  • 209
  • 210
  • 211
  • 212
  • 213
  • 214
  • 215
  • 216
  • 217
  • 218
  • 219
  • 220
  • 221
  • 222
  • 223
  • 224
  • 225
  • 226
  • 227
  • 228
  • 229
  • 230
  • 231
  • 232
  • 233
  • 234
  • 235
  • 236
  • 237
  • 238
  • 239
  • 240
  • 241
  • 242
  • 243
  • 244
  • 245
  • 246
  • 247
  • 248
  • 249
  • 250
  • 251
  • 252
  • 253
  • 254
  • 255
  • 256
  • 257
  • 258
  • 259
  • 260
  • 261
  • 262
  • 263
  • 264
  • 265
  • 266
  • 267
  • 268
  • 269
  • 270
  • 271
  • 272
  • 273
  • 274
  • 275
  • 276
  • 277
  • 278
  • 279
  • 280
  • 281
  • 282
  • 283
  • 284
  • 285
  • 286
  • 287
  • 288
  • 289
  • 290
  • 291
  • 292
  • 293
  • 294
  • 295
  • 296
  • 297
  • 298
  • 299
  • 300
  • 301
  • 302
  • 303
  • 304
  • 305
  • 306
  • 307
  • 308
  • 309
  • 310
  • 311
  • 312
  • 313
  • 314
  • 315
  • 316
  • 317
  • 318
  • 319
  • 320
  • 321
  • 322
  • 323
  • 324
  • 325
  • 326
  • 327
  • 328
  • 329
  • 330
  • 331
  • 332
  • 333
  • 334
  • 335
  • 336

253
EXTENDING FIREWORKS
Objects within Fireworks documents
Las
t
up
d
a
ted
12/8/2009
ExportFrameInfo object
The following table lists the properties of the ExportFrameInfo object, along with their data type and, where
appropriate, acceptable values and notes.
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
mode
string
Acceptable values are
"mask to image"
and
"mask to
path"
.
owner
object
The element (image, path, text, and so on) that owns the mask.
showAttrs
Boolean
If set to
true
, and
mode
is
"mask to path"
, the mask
element’s fill and stroke (if any) are drawn. If set to
false
, the
mask element’s fill and stroke are ignored.
Property
Data type
Notes
delayTime
integer
For GIF animations, the delay time between frames, in 1/100ths
of a second. For example, if you set
delayTime
to
200
, two
seconds elapse before the next frame in the animation
appears. Default value is
7
.
frameHidden
Boolean
If set to
false
(the default), the frame is exported. If set to
true
, the frame is hidden and not exported.
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