version 11.3
SVG_Define_filter (parentRef; id{; frameX; frameY{; frameWidth; frameHeight{; frameUnit{; filterUnit}}}}) SVG_Ref
| Parameter | Type | Description | |
| parentSVGObject | SVG_Ref | Reference of parent element | |
| id | String | Name of symbol | |
| frameX | Number | Coordinate on X axis | |
| frameY | Number | Coordinate on Y axis | |
| frameWidth | Number | Width of target rectangle | |
| frameHeight | Number | Height of target rectangle | |
| frameUnit | String | Coordinate system of frame | |
| filterUnit | String | Filter system of values | |
| Function result | SVG_Ref | Reference of filter |
Description
The SVG_Define_filter command sets a new filter in the SVG container designated by parentSVGObject and returns its reference. If parentSVGObject is not an SVG document, an error is generated.
A filter is a succession of graphic operations that will be applied to the target element. The filter element is never rendered directly; it will be applied to an object using the SVG_SET_FILTER command.
The id parameter specifies the name of the marker. The name will be used to associate a filter with an object. If an element with the same name exists, it will be replaced.
The optional frameX, frameY, frameWidth and frameHeight parameters set a rectangular region in the document to which this filter will be applied.
The optional frameUnit parameter sets the coordinate system for the 4 previous parameters. Expected values: "userSpaceOnUse" or "objectBoundingBox" (default value).
The optional filterUnit parameter sets the coordinate system for the lenths and the filter definition properties. Expected values: "userSpaceOnUse" (default value) or "objectBoundingBox".
See Also
SVG_Filter_Blend, SVG_Filter_Blur, SVG_Filter_Offset, SVG_SET_FILTER.