Skip To Content ArcGIS for Developers Sign In Dashboard

MultilayerSymbol Class


Base type for multi-layer symbols. More...

Header: #include <MultilayerSymbol>
Since: Esri::ArcGISRuntime 100.2
Inherits: Symbol
Inherited By:

Esri::ArcGISRuntime::MultilayerPointSymbol, Esri::ArcGISRuntime::MultilayerPolygonSymbol, and Esri::ArcGISRuntime::MultilayerPolylineSymbol

Public Functions

QColor color() const
void setColor(const QColor &color)
SymbolLayerListModel *symbolLayers() const

Additional Inherited Members

Detailed Description

Base type for multi-layer symbols.

Multi-layer symbols define how a symbol can be composed of multiple layers of different symbol types. The resulting symbol will be rendered with the type of geometry type and actual symbol type.

Note: Symbol layers in a multilayer symbol are in reverse order of how they appear in the JSON representation.

// in this multilayer symbol pseudocode json, the 'symbolLayers' ordered list of symbol
// layers contains a solid stroke symbol layer followed by a solid fill symbol layer.
{ "symbolLayers": [{"type": "CIMSolidStroke", "color": "black"},{"type": "CIMSolidFill", "color": "red"}],"type": "CIMPointSymbol" }

// this is the solid fill symbol layer, the reverse order from the json representation
auto* symbolLayerIndexZero = multilayerSymbol->symboLayers()->at(0); // red fill in the image below

// this is the solid stroke symbol layer, the reverse order from the json representation
auto* symbolLayerIndexOne = multilayerSymbol->symboLayers()->at(1); // black outline in the image below

"MultilayerPoint symbol"

Multilayer symbol consisting of two layers.

Member Function Documentation



QColor MultilayerSymbol::color() const

Returns the color of the multi-layer symbol.

The default color is transparent black, RGBA(0, 0, 0, 0)

See also setColor().

void MultilayerSymbol::setColor(const QColor &color)

Sets the color of the multi-layer symbol to color.

See also color().

SymbolLayerListModel *MultilayerSymbol::symbolLayers() const

Get the list of symbol layers of the multilayer symbol as a list model.

This function was introduced in Esri::ArcGISRuntime 100.5.

Feedback on this topic?