AGSSolidFillSymbolLayer Class Reference

Description

A class representing a solid fill symbol layer.

An instance of AGSSolidFillSymbolLayer represents a symbol layer that is used to fill a polygon geometry with a solid color. It can have transparency applied.

If it is the only symbol layer in a AGSMultilayerPolygonSymbol, it will fill the geometry with the specified color.

It is similar to the Web Scene's FillSymbol3DLayer, and the Web Map's esriSFS.

It is like AGSSimpleFillSymbol with a solid style. Unlike AGSSimpleFillSymbol, which includes hatch fill styles, the solid fill symbol layer is used to symbolize a solid fill exclusively and therefore only exposes a color property.

Since

100.5

Inheritance diagram for AGSSolidFillSymbolLayer:

Instance Methods
(instancetype)	- initWithColor:
(BOOL)	- isEqualToSymbolLayer:

Class Methods
(instancetype)	+ solidFillSymbolLayer
(instancetype)	+ solidFillSymbolLayerWithColor:

Properties
AGSColor *	color
BOOL	colorLocked
BOOL	enabled
AGSSymbolLayerType	type

Method Documentation

initWithColor:

- (instancetype) initWithColor:

(AGSColor *)

color

Initialize a solid fill symbol layer with the provided parameter

Parameters

color

The desired color for the symbol layer.

Returns

Initialized solid fill symbol layer.

Since

100.5

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

solidFillSymbolLayer

+ (instancetype) solidFillSymbolLayer

Initialize a solid fill symbol layer

Returns

Initialized solid fill symbol layer

Since

100.5

solidFillSymbolLayerWithColor:

+ (instancetype) solidFillSymbolLayerWithColor:

(AGSColor *)

color

Initialize a solid fill symbol layer with the provided parameter

Parameters

color

The desired color for the symbol layer.

Returns

Initialized solid fill symbol layer.

Since

100.5

Property Documentation

color

- (AGSColor*) color

readwritenonatomicstrong

The color of a solid fill symbol layer.

An AGSColor representing the color used in the solid fill. If a color is not explicitly set, the default will be black, RGBA(0, 0, 0, 1).

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.

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

type

- (AGSSymbolLayerType) type

readnonatomicassigninherited

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

Since

100.5