SymbolAnchor

Implements the anchor of a symbol layer, including placement mode and x, y, z anchor values. SymbolAnchor contains the properties necessary to define the anchor for a symbol layer. These anchor properties define both the anchor values (x, y, z) and the placement mode. This object can be passed to MarkerSymbolLayer objects to control marker anchor properties.

Since

200.1.0

Constructors

Link copied to clipboard
constructor(x: Double, y: Double, placementMode: SymbolAnchorPlacementMode)

Creates a symbol anchor and sets up the properties. The function sets up the SymbolAnchor with the provided arguments.

Properties

Link copied to clipboard

The anchor placement mode of the symbol anchor object. The SymbolAnchorPlacementMode determines how Runtime interprets the SymbolAnchor anchor values. See the SymbolAnchorPlacementMode documentation for a description of the effects of each mode. The default mode is 'relative.'

Link copied to clipboard
val x: Double

The x-component of the symbol anchor object. The x-component of the SymbolAnchor can be any real number. The units of the value depend on the anchor placement mode of the SymbolAnchor. The default value is 0, regardless of placement mode. A positive x-component will adjust the anchor point of the symbol in the positive-x direction. This has the visual effect of pushing the marker in the negative-x direction, since the anchor remains on the location of the marker.

Link copied to clipboard
val y: Double

The y-component of the symbol anchor object. The y-component of the SymbolAnchor can be any real number. The units of the value depend on the anchor placement mode of the SymbolAnchor. The default value is 0, regardless of placement mode. A positive y-component will adjust the anchor point of the symbol in the positive-y direction. This has the visual effect of pushing the marker in the negative-y direction, since the anchor remains on the location of the marker.