AGSStrokeSymbolLayer Class Reference

Description

A base class for stroke symbol layers.

A base class representing a symbol layer that, when applied to a polyline geometry, draws a stroke along that geometry. It also controls drawing the outline of a polygon geometry.

Stroke symbol layer controls many common operations vital for working with strokes including cap style and line style 3D. These properties provide the ability to pick between various options for rendering strokes. Line style 3D applies only in 3D, but cap style and width have effects in both 2D and 3D.

Note

Applied to a polyline geometry, the stroke symbol layer will draw a segment of stroke adhering to the selected visual properties for each line segment. Similarly, as the outline of a polygon geometry, the stroke symbol layer draws a stroke segment for each line segment of the polygon outline.

Since

100.5

Inheritance diagram for AGSStrokeSymbolLayer:

Instance Methods
(BOOL)	- isEqualToSymbolLayer:

Properties
AGSStrokeSymbolLayerCapStyle	capStyle
BOOL	colorLocked
BOOL	enabled
AGSStrokeSymbolLayerLineStyle3D	lineStyle3D
AGSSymbolLayerType	type
CGFloat	width

Method Documentation

isEqualToSymbolLayer:

- (BOOL) isEqualToSymbolLayer:

(AGSSymbolLayer *)

other

Compares whether two symbol layers are equal.

Parameters

other

The 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

capStyle

- (AGSStrokeSymbolLayerCapStyle) capStyle

readwritenonatomicassign

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

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

lineStyle3D

- (AGSStrokeSymbolLayerLineStyle3D) lineStyle3D

readwritenonatomicassign

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

readwritenonatomicassign

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