ArcGIS Runtime SDK for iOS
100.15
|
A class for stroke symbol layers with customized geometric effects.
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.
AGSGeometricEffect.h
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 |
- (instancetype) initWithWidth: | (CGFloat) | width | |
color: | (AGSColor *) | color | |
Creates a solid stroke symbol layer with the provided parameters.
width | The desired width of the layer in DIPs, except when the lineStyle3D is tube , in which case it is meters. |
color | The desired color for the layer. |
- (instancetype) initWithWidth: | (CGFloat) | width | |
color: | (AGSColor *) | color | |
geometricEffects: | (NSArray< AGSGeometricEffect * > *) | geometricEffects | |
Creates a solid stroke symbol layer with the provided parameters.
width | The desired width of the layer in DIPs, except when the lineStyle3D is tube , in which case it is meters. |
color | The desired color for the layer. |
geometricEffects | The effects to be applied to the layer. For example, dash patterns. |
- (instancetype) initWithWidth: | (CGFloat) | width | |
color: | (AGSColor *) | color | |
geometricEffects: | (NSArray< AGSGeometricEffect * > *) | geometricEffects | |
lineStyle3D: | (AGSStrokeSymbolLayerLineStyle3D) | lineStyle3D | |
Creates a solid stroke symbol layer with the provided parameters.
width | The desired width of the layer in DIPs, except when the lineStyle3D is tube , in which case it is meters. |
color | The desired color for the layer. |
geometricEffects | The effects to be applied to the layer. For example, dash patterns. |
lineStyle3D | The desired 3D line style. |
- (BOOL) isEqualToSymbolLayer: | (AGSSymbolLayer *) | other |
Compares whether two symbol layers are equal.
other | The other symbol layer to compare this symbol layer to. |
YES
if the symbol layers are equal, NO
if not. + (instancetype) solidStrokeSymbolLayerWithWidth: | (CGFloat) | width | |
color: | (AGSColor *) | color | |
Creates a solid stroke symbol layer with the provided parameters.
width | The desired width of the layer in DIPs, except when the lineStyle3D is tube , in which case it is meters. |
color | The desired color for the layer. |
+ (instancetype) solidStrokeSymbolLayerWithWidth: | (CGFloat) | width | |
color: | (AGSColor *) | color | |
geometricEffects: | (NSArray< AGSGeometricEffect * > *) | geometricEffects | |
Creates a solid stroke symbol layer with the provided parameters.
width | The desired width of the layer in DIPs, except when the lineStyle3D is tube , in which case it is meters. |
color | The desired color for the layer. |
geometricEffects | The effects to be applied to the layer. For example, dash patterns. |
+ (instancetype) solidStrokeSymbolLayerWithWidth: | (CGFloat) | width | |
color: | (AGSColor *) | color | |
geometricEffects: | (NSArray< AGSGeometricEffect * > *) | geometricEffects | |
lineStyle3D: | (AGSStrokeSymbolLayerLineStyle3D) | lineStyle3D | |
Creates a solid stroke symbol layer with the provided parameters.
width | The desired width of the layer in DIPs, except when the lineStyle3D is tube , in which case it is meters. |
color | The desired color for the layer. |
geometricEffects | The effects to be applied to the layer. For example, dash patterns. |
lineStyle3D | The desired 3D line style. |
|
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.
butt
style.
|
readwritenonatomicstrong |
The color of a solid stroke symbol layer.
The solid color of the AGSSolidStrokeSymbolLayer
. The stroke will render with the specified color.
When getting the color from a symbol, the consensus value (for all layers) is reported. If there is no consensus (one or more layers have different colors), a nil
value is reported for the color. Likewise, setting a value for color on a symbol will apply that color to all layers the symbol contains.
If you don't want changes to the symbol color to propagate to some of the symbol layers it contains, you can lock the color for those layers. If a symbol layer is color-locked, changes to the parent symbol will not affect the symbol layer. This also means that the layer will not be considered when determining a consensus color for the symbol as a whole.
|
readwritenonatomicassigninherited |
Indicates whether or not the symbol layer is color locked. If YES
, the layer's color will not change.
|
readwritenonatomicassigninherited |
Indicates whether or not the symbol layer is enabled. Layer will be rendered only when enabled.
|
readwritenonatomiccopy |
Collection of geometric effects held by a solid stroke symbol layer.
|
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.
width
is considered to be in DIPs for all styles except tube
for which it is meters. strip
3D line style is supported in static rendering mode.
|
readnonatomicassigninherited |
The type of the symbol layer. AGSSymbolLayerTypeUnknown
is returned when an error occurs
|
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.