ArcGIS Runtime SDK for iOS: AGSVectorMarkerSymbolLayer Class Reference
ArcGIS Runtime SDK for iOS  100.11
AGSVectorMarkerSymbolLayer Class Reference

Description

A class representing a marker comprising vector graphics.

A class representing a marker comprising vector graphics. It is constructed from a collection of AGSVectorMarkerSymbolElement objects which define the building blocks of the vector marker. If it is the sole symbol layer in a AGSMultilayerPointSymbol, this symbol layer places a vector marker at the location of the point feature. This symbol layer is similar to the Web Scene specification's IconSymbol3DLayer, when the IconSymbol3DLayer references a primitive shape.

Since
100.5
Inheritance diagram for AGSVectorMarkerSymbolLayer:
AGSMarkerSymbolLayer AGSSymbolLayer AGSObject

Instance Methods

(instancetype) - initWithVectorMarkerSymbolElements:
 
(BOOL) - isEqualToSymbolLayer:
 

Class Methods

(instancetype) + vectorMarkerSymbolLayerWithVectorMarkerSymbolElements:
 

Properties

AGSSymbolAnchor anchor
 
BOOL colorLocked
 
BOOL enabled
 
double heading
 
CGFloat offsetX
 
CGFloat offsetY
 
CGFloat size
 
AGSSymbolLayerType type
 
NSArray< AGSVectorMarkerSymbolElement * > * vectorMarkerSymbolElements
 

Method Documentation

◆ initWithVectorMarkerSymbolElements:

- (instancetype) initWithVectorMarkerSymbolElements: (NSArray< AGSVectorMarkerSymbolElement * > *)  vectorMarkerSymbolElements

Initialize a vector marker symbol layer with the provided parameter

Parameters
vectorMarkerSymbolElementsCollection of vector marker symbol elements.
Returns
Initialized vector marker symbol layer
Since
100.5

◆ isEqualToSymbolLayer:

- (BOOL) isEqualToSymbolLayer: (AGSSymbolLayer *)  other

Compares whether two symbol layers are equal.

Parameters
othersymbol layer to compare this symbol layer to
Returns
YES if the symbol layers are equal
Since
100.5

◆ vectorMarkerSymbolLayerWithVectorMarkerSymbolElements:

+ (instancetype) vectorMarkerSymbolLayerWithVectorMarkerSymbolElements: (NSArray< AGSVectorMarkerSymbolElement * > *)  vectorMarkerSymbolElements

Initialize a vector marker symbol layer with the provided parameter

Parameters
vectorMarkerSymbolElementsCollection of vector marker symbol elements.
Returns
Initialized vector marker symbol layer
Since
100.5

Property Documentation

◆ anchor

- (AGSSymbolAnchor) anchor
readwritenonatomicassigninherited

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
readwritenonatomicassigninherited

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
readwritenonatomicassigninherited

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
readwritenonatomicassigninherited

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
readwritenonatomicassigninherited

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

◆ vectorMarkerSymbolElements

- (NSArray<AGSVectorMarkerSymbolElement*>*) vectorMarkerSymbolElements
readwritenonatomiccopy

Collection of vector marker symbol elements held by the vector marker symbol layer

Since
100.5