Skip To Content ArcGIS for Developers Sign In Dashboard

SymbolLayer Class

class Esri::ArcGISRuntime::SymbolLayer

Symbol layers are used to build Multilayer symbols. More...

Header: #include <SymbolLayer>
Since: Esri::ArcGISRuntime 100.5
Inherits: Esri::ArcGISRuntime::Object
Inherited By:

Esri::ArcGISRuntime::FillSymbolLayer, Esri::ArcGISRuntime::MarkerSymbolLayer, and Esri::ArcGISRuntime::StrokeSymbolLayer

This class was introduced in Esri::ArcGISRuntime 100.5.

Public Functions

virtual ~SymbolLayer() override
bool isColorLocked() const
bool isEnabled() const
void setColorLocked(bool colorLocked)
void setEnabled(bool enabled)
Esri::ArcGISRuntime::SymbolLayerType symbolLayerType() const
bool operator==(Esri::ArcGISRuntime::SymbolLayer *other) const

Detailed Description

The available symbol layer types correspond to the primitive geometry they are designed to render: marker layers for point, stroke layers for line, and fill layers for area. Layer types, however, are not applied exclusively to the corresponding geoelement geometry type. A marker symbol layer, for example, could be applied to a polyline feature to render its vertices. Each layer type has a unique set of properties to control its display.

A symbol can contain one or several symbol layers of the same or different type. A symbol used to render polygons, for example, might contain a fill symbol layer to render the polygon interior, a stroke symbol layer for rendering the polygon outline, and a marker symbol layer to render polygon vertices. A symbol to render a polyline might contain several stroke layers of varying widths. If a symbol contains a layer that cannot render the type of geometry to which it is applied, that symbol layer is ignored when rendering.

Member Function Documentation

[override virtual] SymbolLayer::~SymbolLayer()


bool SymbolLayer::isColorLocked() const

Returns if the symbol layer is color locked.

Any symbol layer that is color locked will not change color when the symbol color is changed. However, changing the color of the symbol layer directly would change the color of the symbol layer irrespective of the property value.

bool SymbolLayer::isEnabled() const

Returns if the symbol layer is enabled.

A symbol layer will only be rendered if it is enabled.

void SymbolLayer::setColorLocked(bool colorLocked)

Sets the color locked status to colorLocked

See also isColorLocked().

void SymbolLayer::setEnabled(bool enabled)

Sets the enabled status to enabled.

See also isEnabled().

Esri::ArcGISRuntime::SymbolLayerType SymbolLayer::symbolLayerType() const

Returns the symbol layer type.

bool SymbolLayer::operator==(Esri::ArcGISRuntime::SymbolLayer *other) const

Equivalency operator.

Returns whether this object and other are equal.

Feedback on this topic?