# symbol

The symbol element is used to define graphical template objects which can be instantiated by a use element.

The use of symbol elements for graphics that are used multiple times in the same document adds structure and semantics. Documents that are rich in structure may be rendered graphically, as speech, or as Braille, and thus promote accessibility.

Note: A symbol element itself is not meant to be rendered. Only instances of a symbol element (i.e., a reference to a symbol by a use element) are rendered. That means that some browsers could refuse to directly display a symbol element even if the CSS display property tells otherwise.

Usually, this element is create with:

const symbol = parentElement.add('symbol')

It's possible create as a disconnected element with gySVG('symbol') and attach it to the SVG document with .attachTo().

More info: mdn (opens new window) | w3c (opens new window)

# .height()

symbol.height( _ )

Set this attribute determines the height of the symbol.

  • argument: {} _

  • returns: {gySVGObject} The original object

const height = element.height();

Get the height current value.

  • returns: {}

# .preserveAspectRatio()

element.preserveAspectRatio( align )

Set the preserveAspectRatio attribute. It indicates how an element with a viewBox providing a given aspect ratio must fit into a viewport with a different aspect ratio.

  • argument: {string} align Must be 'none' | 'xMinYMin' | 'xMidYMin' | 'xMaxYMin' | 'xMinYMid' | 'xMidYMid' (the default) | 'xMaxYMid' | 'xMinYMax' | 'xMidYMax' | 'xMaxYMax' and can be complemented with 'meet' (the default) | 'slice'

  • returns: {gySVGObject} The original object

const align = element.preserveAspectRatio();

Get the preserveAspectRatio current value.

  • returns: {string} Current align configuration

# .refX()

symbol.refX( _ )

Set this attribute determines the x coordinate of the reference point of the symbol.

  • argument: {} _

  • returns: {gySVGObject} The original object

const refX = element.refX();

Get the refX current value.

  • returns: {}

# .refY()

symbol.refY( _ )

Set this attribute determines the y coordinate of the reference point of the symbol.

  • argument: {} _

  • returns: {gySVGObject} The original object

const refY = element.refY();

Get the refY current value.

  • returns: {}

# .viewBox()

element.viewBox( minX, minY, width, height )

Set the viewBox attribute. It defines the position and dimension, in user space, of an SVG viewport. With four values specify a rectangle in user space which is mapped to the bounds of the viewport established for the SVG element.

  • argument: {number} minX x-axis min value

  • argument: {number} minY y-axis min value

  • argument: {number} width width value

  • argument: {number} height height value

  • returns: {gySVGObject} The original object

element.viewBox( viewBoxArray )

Set the viewBox attribute with an array with four values.

  • argument: {Array} viewBoxArray Array with four numeric values

  • returns: {gySVGObject} The original object

element.viewBox( viewBoxString )

Set the viewBox attribute with a string.

  • argument: {string} viewBoxString Four numeric values separated by coma or space

  • returns: {gySVGObject} The original object

const viewBox = element.viewBox();

Get the viewBox current value.

  • returns: {string} four values separate by coma

# .width()

symbol.width( _ )

Set this attribute determines the width of the symbol.

  • argument: {} _

  • returns: {gySVGObject} The original object

const width = element.width();

Get the width current value.

  • returns: {}

# .x()

symbol.x( _ )

Set this attribute determines the x coordinate of the symbol.

  • argument: {} _

  • returns: {gySVGObject} The original object

const x = element.x();

Get the x current value.

  • returns: {}

# .y()

symbol.y( _ )

Set this attribute determines the y coordinate of the symbol.

  • argument: {} _

  • returns: {gySVGObject} The original object

const y = element.y();

Get the y current value.