4D Doc Center : SVG_Define

Home

4D v14

SVG_Define_symbol


SVG_Define_symbol ( parentSVGObject ; id {; x {; y {; width {; height {; mode}}}}} ) -> Function result

Parameter	Type	Description
parentSVGObject	SVG_Ref	Reference of parent element
id	String	Name of symbol
x	Longint	X position of viewbox
y	Longint	Y position of viewbox
width	Longint	Width of viewbox
height	Longint	Height of viewbox
mode	String	Adjustment to viewbox
Function result	SVG_Ref	Reference of symbol

Description

The SVG_Define_symbol command creates a symbol in the SVG container designated by parentSVGObject and returns its reference. If parentSVGObject is not an SVG document, an error is generated.

A symbol object is used to specify graphic objects that may be instantiated using the SVG_Use command.

The id parameter specifies the name of the symbol.

The optional x, y, width and height parameters specify the viewbox rectangle ('viewBox' attribute).

The optional mode parameter can be used to indicate if the graphic must be fitted, and how so, to the size of the viewbox. For more information about this point, please refer to the description of the SVG_New command.

Example

Refer to the description of the SVG_Use command.