ArcGIS Runtime SDK for iOS: AGSSolidStrokeSymbolLayer Class Reference
ArcGIS Runtime SDK for iOS  100.6
AGSSolidStrokeSymbolLayer Class Reference

Description

A class for stroke symbol layers with customized geometric effects. It represents a polyline geometry symbolized with a solid color. It's used in line symbols to describe the appearance of the line, or in polygon symbols as an outline. Currently it supports only dash effects.

This symbol layer, in a AGSMultilayerPolylineSymbol colors the geometry of the line with the specified solid color. It also allows setting a collection of geometric effects, which modify the stroke in various ways (see documentation for geometric effects).

It is used to represent the Web Scene specification's LineSymbol3DLayer and PathSymbol3DLayer. LineSymbol3DLayer maps to the strip 3D line style, and PathSymbol3DLayer maps to the tube 3D line style.

It provides a similar user experience to AGSSimpleLineSymbol, but since it is a symbol layer, it can also be used in a AGSMultilayerSymbol. The simple line styles of AGSSimpleLineSymbol are represented here by the AGSDashGeometricEffect, but all dash patterns are custom. A solid stroke symbol layer in a multilayer polygon symbol will act as the outline of the fill.

Since
100.5
See also
AGSGeometricEffect.h
Inheritance diagram for AGSSolidStrokeSymbolLayer:
AGSStrokeSymbolLayer AGSSymbolLayer AGSObject

Instance Methods

(instancetype) - initWithWidth:color:
 
(instancetype) - initWithWidth:color:geometricEffects:
 
(instancetype) - initWithWidth:color:geometricEffects:lineStyle3D:
 
(BOOL) - isEqualToSymbolLayer:
 

Class Methods

(instancetype) + solidStrokeSymbolLayerWithWidth:color:
 
(instancetype) + solidStrokeSymbolLayerWithWidth:color:geometricEffects:
 
(instancetype) + solidStrokeSymbolLayerWithWidth:color:geometricEffects:lineStyle3D:
 

Properties

AGSStrokeSymbolLayerCapStyle capStyle
 
AGSColor * color
 
BOOL colorLocked
 
BOOL enabled
 
NSArray< AGSGeometricEffect * > * geometricEffects
 
AGSStrokeSymbolLayerLineStyle3D lineStyle3D
 
AGSSymbolLayerType type
 
CGFloat width
 

Method Documentation

§ initWithWidth:color:()

- (instancetype) initWithWidth: (CGFloat)  width
color: (AGSColor *)  color 

Initialize a solid stroke symbol layer with the provided parameters

Parameters
widththe desired width of the layer in DIPs, except when the lineStyle3D is tube, in which case it is meters
colorthe desired color for the layer
Returns
Initialized solid stroke symbol layer
Since
100.5

§ initWithWidth:color:geometricEffects:()

- (instancetype) initWithWidth: (CGFloat)  width
color: (AGSColor *)  color
geometricEffects: (NSArray< AGSGeometricEffect * > *)  geometricEffects 

Initialize a solid stroke symbol layer with the provided parameters

Parameters
widththe desired width of the layer in DIPs, except when the lineStyle3D is tube, in which case it is meters
colorthe desired color for the layer
geometricEffectsthe effects to be applied to the layer. For example, dash patterns
Returns
Initialized solid stroke symbol layer
Since
100.5

§ initWithWidth:color:geometricEffects:lineStyle3D:()

- (instancetype) initWithWidth: (CGFloat)  width
color: (AGSColor *)  color
geometricEffects: (NSArray< AGSGeometricEffect * > *)  geometricEffects
lineStyle3D: (AGSStrokeSymbolLayerLineStyle3D lineStyle3D 

Initialize a solid stroke symbol layer with the provided parameters

Parameters
widththe desired width of the layer in DIPs, except when the lineStyle3D is tube, in which case it is meters
colorthe desired color for the layer
geometricEffectsthe effects to be applied to the layer. For example, dash patterns
thedesired 3D line style
Returns
Initialized solid stroke 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

§ solidStrokeSymbolLayerWithWidth:color:()

+ (instancetype) solidStrokeSymbolLayerWithWidth: (CGFloat)  width
color: (AGSColor *)  color 

Initialize a solid stroke symbol layer with the provided parameters

Parameters
widththe desired width of the layer in DIPs, except when the lineStyle3D is tube, in which case it is meters
colorthe desired color for the layer
Returns
Initialized solid stroke symbol layer
Since
100.5

§ solidStrokeSymbolLayerWithWidth:color:geometricEffects:()

+ (instancetype) solidStrokeSymbolLayerWithWidth: (CGFloat)  width
color: (AGSColor *)  color
geometricEffects: (NSArray< AGSGeometricEffect * > *)  geometricEffects 

Initialize a solid stroke symbol layer with the provided parameters

Parameters
widththe desired width of the layer in DIPs, except when the lineStyle3D is tube, in which case it is meters
colorthe desired color for the layer
geometricEffectsthe effects to be applied to the layer. For example, dash patterns
Returns
Initialized solid stroke symbol layer
Since
100.5

§ solidStrokeSymbolLayerWithWidth:color:geometricEffects:lineStyle3D:()

+ (instancetype) solidStrokeSymbolLayerWithWidth: (CGFloat)  width
color: (AGSColor *)  color
geometricEffects: (NSArray< AGSGeometricEffect * > *)  geometricEffects
lineStyle3D: (AGSStrokeSymbolLayerLineStyle3D lineStyle3D 

Initialize a solid stroke symbol layer with the provided parameters

Parameters
widththe desired width of the layer in DIPs, except when the lineStyle3D is tube, in which case it is meters
colorthe desired color for the layer
geometricEffectsthe effects to be applied to the layer. For example, dash patterns
thedesired 3D line style
Returns
Initialized solid stroke symbol layer
Since
100.5

Property Documentation

§ capStyle

- (AGSStrokeSymbolLayerCapStyle) capStyle
readwritenonatomicassigninherited

The cap style of the stroke symbol layer, which controls the rendering of the ends or the caps of the stroke. Defaults to round meaning the ends of the stroke are rounded off. Cap styles affect strokes in Map Views, as well as tube and strip line styles in Scene Views.

Note
In dynamic rendering mode, caps are always rendered with the butt style.
Since
100.5

§ color

- (AGSColor*) color
readwritenonatomicstrong

Color of the solid stroke symbol layer. Defaults to Black

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

§ geometricEffects

- (NSArray<AGSGeometricEffect*>*) geometricEffects
readwritenonatomiccopy

Collection of geometric effects held by a solid stroke symbol layer.

Since
100.5

§ lineStyle3D

- (AGSStrokeSymbolLayerLineStyle3D) lineStyle3D
readwritenonatomicassigninherited

The 3D line style of the stroke symbol layer, which controls the rendering of the stroke in 3D. Defaults to strip meaning the 3D stroke is flat. 3D line style has no effect on strokes in Map Views, but does affect strokes in Scene Views.

Note
The width is considered to be in DIPs for all styles except tube for which it is meters.
Only the strip 3D line style is supported in static rendering mode.
Since
100.5

§ type

- (AGSSymbolLayerType) type
readnonatomicassigninherited

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

Since
100.5

§ width

- (CGFloat) width
readwritenonatomicassigninherited

The width of a stroke symbol layer in DIPs, except when the lineStyle3D is tube, in which case it is meters. It may be any non-negative number. Defaults to 0. A larger width means a larger stroke.

Since
100.5