MarkerSymbolLayer

A base class for marker symbol layers, representing a symbol layer used to display a marker. MarkerSymbolLayer draws a shape or picture at a specific location relative to point geometry. A marker symbol layer is most often used in point symbols, but they can also be included in polyline and polygon symbols to draw a symbol at locations along lines and outlines, or within areas (the center of a polygon, for example).

The following types of marker symbol layers are supported:

This symbol layer controls many common operations vital for working with markers.

Anchors, angles, offsets, and size properties are controlled on MarkerSymbolLayer.

The MarkerSymbolLayer has methods affecting both 2D and 3D markers. Some properties apply only to 3D markers, such as angleX, or offsetZ. These properties have no effect on markers in 2D. Properties on 2D markers, such as offsetX, affect the marker's position in screen space, not world space. This means that the x-axis for a 2D marker runs from negative-x on the West edge of the screen to positive-x on the East edge of the screen. Negative-y to positive-y runs from the South edge of the screen to the North edge of the screen.

Properties that apply only to 3D markers affect the marker's position in world space, rather than screen space. This means that the x, y, and z-axes to which the class methods are the axes of the world, with the following layout: from negative to positive, the x-axis spans from world West to world East, the y-axis from world South to world North, and the z-axis from directly into the surface to the sky.

While a simple text symbol (TextSymbol) can be used to display a character as a marker, proper display is dependent on the referenced font being available on the machine or device running the app. If the exact font is not found, which is likely to occur on many mobile devices, a fallback mechanism is used to find the best available font to use. A character marker symbol authored from ArcGIS Pro, however, is represented by a vector marker symbol. This symbol stores the geometry that represents the character, is not dependent on the font to render the shape of the marker, and displays as expected on all devices.

Since

200.1.0

Inheritors

Properties

Link copied to clipboard

The anchor object of a marker symbol layer. The SymbolAnchor determines how the MarkerSymbolLayer is anchored. SymbolAnchor specifies the marker's anchor point and anchor placement mode. The default symbol anchor is at XYZ(0, 0, 0) and uses 'relative' mode. See the SymbolAnchor documentation for a detailed description of the object.

Link copied to clipboard

The marker symbol layer's heading: the angle of rotation about the anchor point. The input value can be any real number. The default value is 0. This property affects markers in both maps and scenes. Positive angles rotate the marker counterclockwise.

Link copied to clipboard

The marker symbol layer's x-offset. The input value can be any real number. The default value is 0. This property affects markers in both Maps and Scenes. The x-offset is a delta applied to the marker in the direction corresponding to the given value. For example, a positive x-offset moves the marker in the positive-x direction.

Link copied to clipboard

The marker symbol layer's y-offset. The input value can be any real number. The default value is 0. This property affects markers in both Maps and Scenes. The y-offset is a delta applied to the marker in the direction corresponding to the given value. For example, a positive y-offset moves the marker in the positive-y direction.

Link copied to clipboard

The size of marker symbol layer. The input value can be any positive number. The default value is 13.333 DIPs (10 points). A larger size means a larger marker.

Inherited properties

Link copied to clipboard

The symbol layer color locked property. The color-locked status of the symbol layer. If color_locked is true, the color of that layer will not change.

Link copied to clipboard

The symbol layer enabled property. The enable status of the symbol layer. Layer will be rendered only if it is enabled.

Functions

Link copied to clipboard
open override fun clone(): MarkerSymbolLayer

Clones the MarkerSymbolLayer.