# pattern

The pattern element defines a graphics object which can be redrawn at repeated x- and y-coordinate intervals ("tiled") to cover an area.

The pattern is referenced by the fill and/or stroke attributes on other graphics elements to fill or stroke those elements with the referenced pattern.

Usually, this element is create with:

const pattern = parentElement.add('pattern')

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

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

# .height()

pattern.height( _ )

Set this attribute determines the height of the pattern tile.

  • argument: {} _

  • returns: {gySVGObject} The original object

const height = element.height();

Get the height current value.

  • returns: {}

# .href()

pattern.href( URLPattern )

Set the href attribute. It defines a URL referencing to a template pattern that provides default values for this pattern.

  • argument: {string} URLPattern URL to a pattern

  • returns: {gySVGObject} The original object

const href = pattern.href();

Get the href current value.

  • returns: {string} Current URL to a pattern

# .patternContentUnits()

pattern.patternContentUnits( _ )

Set this attribute defines the coordinate system for the contents of the pattern.

  • argument: {} _

  • returns: {gySVGObject} The original object

const patternContentUnits = element.patternContentUnits();

Get the patternContentUnits current value.

  • returns: {}

# .patternTransform()

pattern.patternTransform( _ )

Set this attribute contains the definition of an optional additional transformation from the pattern coordinate system onto the target coordinate system.

  • argument: {} _

  • returns: {gySVGObject} The original object

const patternTransform = element.patternTransform();

Get the patternTransform current value.

  • returns: {}

# .patternUnits()

pattern.patternUnits( _ )

Set this attribute defines the coordinate system for attributes x, y, width , and height.

  • argument: {} _

  • returns: {gySVGObject} The original object

const patternUnits = element.patternUnits();

Get the patternUnits 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

# .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()

pattern.width( _ )

Set this attribute determines the width of the pattern tile.

  • argument: {} _

  • returns: {gySVGObject} The original object

const width = element.width();

Get the width current value.

  • returns: {}

# .x()

pattern.x( _ )

Set this attribute determines the x coordinate shift of the pattern tile.

  • argument: {} _

  • returns: {gySVGObject} The original object

const x = element.x();

Get the x current value.

  • returns: {}

# .y()

pattern.y( _ )

Set this attribute determines the y coordinate shift of the pattern tile.

  • argument: {} _

  • returns: {gySVGObject} The original object

const y = element.y();

Get the y current value.