Skip To Content ArcGIS for Developers Sign In Dashboard

Symbol QML Type

Base type for symbols used to display a graphic or a feature. More...

Import Statement: import Esri.ArcGISRuntime 100.9
Since: Esri.ArcGISRuntime 100.0


Inherited By:

CompositeSymbol, DistanceCompositeSceneSymbol, FillSymbol, LineSymbol, MarkerSceneSymbol, MarkerSymbol, and MultilayerSymbol




Detailed Description

Note: You cannot declare or create a component of this type in QML code.

Symbols describe how graphics and features look on the map. Different symbols are used with different geometry types. Marker symbols are used for point and multipoint geometries, fill symbols are used for polygon geometries, and line symbols are used for polyline geometries.

See also JsonSerializable.

Property Documentation

json : jsobject

JSON that can be used to instantiate the type instance.

Sizes of symbols in JSON are represented in points (not pixels). Symbol layers in a multilayer symbol are in reverse order of how they appear in the JSON representation.

Note: For Symbols of type MarkerSymbol, an angle set from JSON will be inverted (e.g. an angle of 20 will become -20).

swatchImage : url

Returns the image URL to the symbol's swatch image (read-only).

Accessing this property will force the swatch image to be created.

swatchOptions : SwatchOptions

Returns the configuration options for the swatch image (read-only).

If these options are a changed a new swatchImage will be generated.

symbolType : Enums.SymbolType

Returns the symbol type (read-only).

See also Enums.SymbolType.

unknownJson : jsobject

Returns the unknown JSON from the source JSON.

See also JsonSerializable.

unsupportedJson : jsobject

Returns the unsupported data from the source JSON.

See also JsonSerializable.

Signal Documentation


Emitted when the swatchImage property changes.

Note: The corresponding handler is onSwatchImageChanged.

Method Documentation

void createSwatch()

Creates a swatch image using the provided swatchOptions.

This method initiates a request to create a swatch image from this symbol. Once completed, the swatchImage property is updated with a URL pointing to a path handled by the image provider. The swatchImageChanged signal is emitted whenever the swatchImage changes.

If no swatchOptions have been provided then the defaults are used.

See also SwatchOptions.

bool equals(symbol)

Returns whether this instance and the other symbol are equal.

Feedback on this topic?