User Guide

220 Chapter 5: Fireworks JavaScript API
dom.setPixelMask()
Availability
Fireworks 3, deprecated in 4 in favor of dom.setSelectionMask().
Usage
dom.setPixelMask(mask, howToCombineMasks)
Arguments
mask
A mask variable that specifies the mask to be applied (see “Mask data type” on page 11). If
mask is null, any existing pixel-selection mask is removed.
howToCombineMasks If there was previously a mask and the new mask is also not null, then
howToCombineMasks specifies how the two masks should be combined. Acceptable values for
howToCombineMasks are "replace", "add", "subtract", and "intersect".
Returns
Nothing.
Description
If Fireworks is in bitmap mode, this function sets the pixel-selection mask of the current image to
the specified mask.
See Also
dom.setSelectionMask()
dom.setOnionSkinning()
Availability
Fireworks 3.
Usage
dom.setOnionSkinning(before, after)
Arguments
before
and after Integers that specify the number of frames to display before and after the
current one. To disable onion skinning, pass
0 for both arguments. To enable onion skinning for
all frames, pass 0 for before and a large number (for example, 99,999) for after.
Returns
Nothing.
Description
Sets the onion-skinning options for the document.
Example
The following command turns on onion skinning two frames before the selected frame and zero
frames after it.
fw.getDocumentDOM().setOnionSkinning(2, 0);