DictionarySymbolStyle class final

A dictionary symbol style object containing symbol primitives and rules for generating symbols from attribute values.

A DictionarySymbolStyle is created either from a style file on disk (an SQLite database with a .stylx extension, created with ArcGIS Pro) or from a dictionary style file hosted on ArcGIS Online or an ArcGIS Enterprise portal (also referred to as a dictionary web style)

A DictionarySymbolStyle must contain a set of symbol primitives and a rule engine that parses input fields. The DictionarySymbolStyle assembles new symbols based on the input attribute values. DictionarySymbolStyle is often used to render symbols from a military specification (such as Mil2525D or App6B) but can also be used with a custom style. When working with dictionary symbol styles, it's important to avoid using certain reserved strings as field names. Note that dictionary symbol styles reserve certain field names for their internal implementation. Specifically, the field name gt is reserved and geoelements rendered with a dictionary symbol style should not contain an attribute with name gt. Additionally, do not use countrylabel as a primitive name as it is reserved to manage a unique symbol/text scenario in military dictionaries.

A DictionarySymbolStyle is used in conjunction with a DictionaryRenderer to symbolize geoelements in a FeatureLayer or GraphicsOverlay.

Esri builds and maintains some dictionary web styles according to the US and NATO military symbol specifications. These desktop and web styles are hosted online and are publicly available. Refer to the ArcGIS Online Dictionary Symbology Styles group for the latest versions of the styles available.

Inheritance

Constructors

DictionarySymbolStyle.withFileUri(Uri styleFileUri)
Creates a new dictionary symbol style object from the style file at the provided location.
factory
DictionarySymbolStyle.withPortalItem(PortalItem portalItem)
Creates a new dictionary symbol style object from a portal item. The portal item must contain a dictionary style.
factory
DictionarySymbolStyle.withUri(Uri webStyleUri)
Creates a new dictionary symbol style object using web style item Url.
factory

Properties

configurations → List<DictionarySymbolStyleConfiguration>
The collection of configuration settings for the custom dictionary style.
no setter
dictionaryName → String
The name of the custom Arcade-based dictionary style. For older version style files, this is an empty string.
no setter
fileUri → Uri
The location of the .stylx file on disk. This will be empty if the style was hosted on a portal (also referred to as a web style).
no setterinherited
hashCode → int
The hash code for this object.
no setterinherited
loadError → ArcGISException?
The load error.
no setterinherited
loadStatus → LoadStatus
The load status.
no setterinherited
onLoadStatusChanged → Stream<LoadStatus>
A stream that reports changes to the LoadStatus.
no setterinherited
portal → Portal?
The portal that hosts the web style identified with SymbolStyle.styleName. This will be null if the style was identified with a PortalItem or Uri or a local .stylx file on disk.
no setterinherited
portalItem → PortalItem?
The portal item representing the web style.
no setterinherited
runtimeType → Type
A representation of the runtime type of the object.
no setterinherited
styleName → String
The name of the web style. This will be empty if the style was identified with a URL or a PortalItem or a local .stylx file on disk.
no setterinherited
symbologyFieldNames → List<String>
The string list of attributes used to construct a symbol from the DictionarySymbolStyle.
no setter
textFieldNames → List<String>
The string list of attributes used to obtain text values for display with a symbol from a DictionarySymbolStyle.
no setter
uiSchemaJson → String
The JSON schema used to drive a user interface for browsing and constructing symbols from a dictionary style.
no setter
uri → Uri?
The URL of the web style. This will be empty if the style was identified with a PortalItem or style name or a local .stylx file on disk.
no setterinherited

Methods

cancelLoad() → void
Cancels loading metadata for the object.
inherited
getDefaultSearchParameters() → Future<SymbolStyleSearchParameters>
Returns a Symbol Style Search Parameters object providing all available search parameters from the database.
inherited
getSymbol(List<String> keys) → Future<ArcGISSymbol>
Asynchronously returns a symbol based on the provided list of keys.
inherited
getSymbolWithAttributes(Map<CaseInsensitiveString, dynamic> attributes) → Future<ArcGISSymbol>
Asynchronously returns a symbol based on the provided attributes.
load() → Future<void>
Loads the metadata for the object asynchronously.
inherited
noSuchMethod(Invocation invocation) → dynamic
Invoked when a nonexistent method or property is accessed.
inherited
retryLoad() → Future<void>
Loads or retries loading metadata for the object asynchronously.
inherited
searchSymbols(SymbolStyleSearchParameters searchParameters) → Future<List<SymbolStyleSearchResult>>
Returns a collection of Symbol Style Search Result object.
inherited
toString() → String
A string representation of this object.
inherited

Operators

operator ==(Object other) → bool
The equality operator.
inherited