SVG_Define_filter

4D - Documentation   Français   English   German   4D SVG Component, Command Theme List   4D SVG Component, Index   Back   Previous   Next

version 11.3


SVG_Define_filter (parentRef; id{; frameX; frameY{; frameWidth; frameHeight{; frameUnit{; filterUnit}}}}) SVG_Ref

ParameterTypeDescription
parentSVGObjectSVG_RefReference of parent element
idStringName of symbol
frameXNumberCoordinate on X axis
frameYNumberCoordinate on Y axis
frameWidthNumberWidth of target rectangle
frameHeightNumberHeight of target rectangle
frameUnitStringCoordinate system of frame
filterUnitStringFilter system of values
Function resultSVG_RefReference 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.


4D - Documentation   Français   English   German   4D SVG Component, Command Theme List   4D SVG Component, Index   Back   Previous   Next