# marker

The marker element defines the graphic that is to be used for drawing arrowheads or polymarkers on a given path, line, polyline or polygon element.

Markers are attached to shapes using the marker-start, marker-mid, and marker-end properties.

Usually, this element is create with:

const marker = parentElement.add('marker')

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

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

# .markerHeight()

marker.markerHeight( _ )

Set this attribute defines the height of the marker viewport.

  • argument: {} _

  • returns: {gySVGObject} The original object

const markerHeight = element.markerHeight();

Get the markerHeight current value.

  • returns: {}

# .markerUnits()

marker.markerUnits( _ )

Set this attribute defines the coordinate system for the attributes markerWidth, markerHeight and the contents of the marker.

  • argument: {} _

  • returns: {gySVGObject} The original object

const markerUnits = element.markerUnits();

Get the markerUnits current value.

  • returns: {}

# .markerWidth()

marker.markerWidth( _ )

Set this attribute defines the width of the marker viewport.

  • argument: {} _

  • returns: {gySVGObject} The original object

const markerWidth = element.markerWidth();

Get the markerWidth current value.

  • returns: {}

# .orient()

marker.orient( _ )

Set this attribute defines the orientation of the marker relative to the shape it is attached to.

  • argument: {} _

  • returns: {gySVGObject} The original object

const orient = element.orient();

Get the orient 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()

marker.refX( _ )

Set this attribute defines the x coordinate for the reference point of the marker.

  • argument: {} _

  • returns: {gySVGObject} The original object

const refX = element.refX();

Get the refX current value.

  • returns: {}

# .refY()

marker.refY( _ )

Set this attribute defines the y coordinate for the reference point of the marker.

  • 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.