MarkerSymbolLayer class final
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:
- VectorMarkerSymbolLayer - Vector geometry defines the shape and appearance of the marker
- PictureMarkerSymbolLayer - Uses an image file (specified using a URI or image data) to define the marker
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.
- Inheritance
-
- Object
- SymbolLayer
- MarkerSymbolLayer
- Implementers
Properties
- anchor ↔ SymbolAnchor
-
The anchor object of a marker symbol layer.
getter/setter pair
- colorLocked ↔ bool
-
The symbol layer color locked property.
getter/setter pairinherited
- enabled ↔ bool
-
The symbol layer enabled property.
getter/setter pairinherited
- hashCode → int
-
The hash code for this object.
no setterinherited
- heading ↔ double
-
The marker symbol layer's heading: the angle of rotation about the anchor
point.
getter/setter pair
- offsetX ↔ double
-
The marker symbol layer's x-offset.
getter/setter pair
- offsetY ↔ double
-
The marker symbol layer's y-offset.
getter/setter pair
- runtimeType → Type
-
A representation of the runtime type of the object.
no setterinherited
- size ↔ double
-
The size of marker symbol layer.
getter/setter pair
Methods
-
clone(
) → SymbolLayer -
Clones the SymbolLayer.
inherited
-
noSuchMethod(
Invocation invocation) → dynamic -
Invoked when a nonexistent method or property is accessed.
inherited
-
toString(
) → String -
A string representation of this object.
inherited
Operators
-
operator ==(
Object other) → bool -
The equality operator.
inherited