ArcGIS Runtime SDK for iOS: AGSMarkerSymbolLayer Class Reference
ArcGIS Runtime SDK for iOS  100.12
AGSMarkerSymbolLayer Class Reference

Description

A base class for marker symbol layers.

A base class for marker symbol layers representing a symbol layer used to display a marker.

An AGSMarkerSymbolLayer object 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).

ArcGIS Runtime includes the following types of marker symbol layers:

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

This class and its subclasses have properties that may affect 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 (AGSTextSymbol) 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
100.5
Inheritance diagram for AGSMarkerSymbolLayer:
AGSSymbolLayer AGSObject AGSPictureMarkerSymbolLayer AGSVectorMarkerSymbolLayer

Instance Methods

(BOOL) - isEqualToSymbolLayer:
 

Properties

AGSSymbolAnchor anchor
 
BOOL colorLocked
 
BOOL enabled
 
double heading
 
CGFloat offsetX
 
CGFloat offsetY
 
CGFloat size
 
AGSSymbolLayerType type
 

Method Documentation

◆ isEqualToSymbolLayer:

- (BOOL) isEqualToSymbolLayer: (AGSSymbolLayer *)  other

Compares whether two symbol layers are equal.

Parameters
otherThe other symbol layer to compare this symbol layer to.
Returns
YES if the symbol layers are equal, NO if not.
Since
100.5

Property Documentation

◆ anchor

- (AGSSymbolAnchor) anchor
readwritenonatomicassign

The anchor of a marker symbol layer. It determines how marker symbols are anchored and specifies the marker's anchor point and anchor placement mode. The default symbol anchor is at XY(0, 0) and uses AGSSymbolAnchorPlacementModeRelative placement.

Since
100.5

◆ colorLocked

- (BOOL) colorLocked
readwritenonatomicassigninherited

Indicates whether or not the symbol layer is color locked. If YES, the layer's color will not change.

Since
100.5

◆ enabled

- (BOOL) enabled
readwritenonatomicassigninherited

Indicates whether or not the symbol layer is enabled. Layer will be rendered only when enabled.

Since
100.5

◆ heading

- (double) heading
readwritenonatomicassign

The angle of rotation about the anchor point, in degrees. It may be any real number. Defaults to 0. This property affects markers in both maps and scenes. Positive angles rotate the marker counterclockwise.

Angle for an AGSMarkerSymbolLayer object is measured in degrees counterclockwise from from 0 to 360. Marker symbol layers can have a separate heading value defined (which is also 0 by default). Setting a heading for a marker symbol layer does not affect the angle of the point symbol. When an angle value is set for the point symbol, however, that value is applied cumulatively to all the marker symbol layers it contains. The heading for individual symbol layers must be re-fetched in order to see the updated value. In 2D, the rotation applies around the anchor point of the 2D marker. For 3D markers, the rotation applies around the z-axis.

Since
100.5

◆ offsetX

- (CGFloat) offsetX
readwritenonatomicassign

The marker symbol layer's x-offset. It may be any real number. Defaults to 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.

Since
100.5

◆ offsetY

- (CGFloat) offsetY
readwritenonatomicassign

The marker symbol layer's y-offset. It may be any real number. Defaults to 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.

Since
100.5

◆ size

- (CGFloat) size
readwritenonatomicassign

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

Since
100.5

◆ type

- (AGSSymbolLayerType) type
readnonatomicassigninherited

The type of the symbol layer. AGSSymbolLayerTypeUnknown is returned when an error occurs

Since
100.5