User Guide

150 Chapter 5: Fireworks JavaScript API
dom.filterSelection()
Availability
Fireworks 3.
usage
dom.filterSelection(LiveEffect)
Arguments
LiveEffect
An Effect object (see “Effect object” on page 32).
Returns
Nothing.
Description
Applies the specified pixel filter to the selection. Items that are not images are converted into
images before the filter is applied. Only external filters that are capable of also being Live Effects
can be applied using this function. To apply other types of external filters, use
dom.filterSelectionByName().Example
The following command runs the selected pixels through the hue/saturation filter and then sets
hue to 30 and saturation to 20.
fw.getDocumentDOM().filterSelection({
EffectMoaID:"{3439b08d-1922-11d3-9bde00e02910d580}",
hls_colorize:true, hue_amount:30, lightness_amount:0, saturation_amount:20
});
dom.filterSelectionByName()
Availability
Fireworks 3.
Usage
dom.filterSelectonByName(category, name)
Arguments
category
A string that specifies the category of the pixel filter to be applied. Acceptable values
depend on which filters you have installed.
name A string that specifies the name of the pixel filter to be applied. Acceptable values depend
on which filters you have installed.
Returns
Nothing.
Description
Applies the specified pixel filter to the selection as a permanent action, not as a Live Effect. (To
apply filters that can also be Live Effects, you can use
dom.filterSelection().) This function
always displays a dialog box.