Show / Hide Table of Contents

Class DictionarySymbolStyle

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

Inheritance
Object
SymbolStyle
DictionarySymbolStyle
SymbolStyle.OpenAsync(String)
SymbolStyle.OpenAsync(String, ArcGISPortal)
SymbolStyle.StyleLocation
SymbolStyle.StyleName
SymbolStyle.Uri
SymbolStyle.Portal
SymbolStyle.PortalItem
SymbolStyle.GetDefaultSearchParametersAsync()
SymbolStyle.SearchSymbolsAsync(SymbolStyleSearchParameters)
SymbolStyle.GetSymbolAsync(IEnumerable<String>)
Object.Equals(Object)
Object.Equals(Object, Object)
Object.GetHashCode()
Object.GetType()
Object.MemberwiseClone()
Object.ReferenceEquals(Object, Object)
Object.ToString()
Namespace: Esri.ArcGISRuntime.Symbology
Assembly: Esri.ArcGISRuntime.dll
Syntax
public class DictionarySymbolStyle : SymbolStyle
Remarks

A DictionarySymbolStyle is created with 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 MIL-STD 2525D or APP-6B) but can also be used with a custom style.

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

Properties

Name Description
Configurations

Gets the list of configuration settings for the custom dictionary style.

DictionaryName

Gets the name of the custom Arcade-based dictionary style. For older version style files, this is an empty string.

SymbologyFieldNames

Gets the string list of attributes used to construct a symbol from the dictionary style.

TextFieldNames

Gets the string list of attributes used to obtain text values for display with a symbol from a dictionary style.

Methods

Name Description
CreateFromFileAsync(String)

Creates a new a DictionarySymbolStyle from the style file at the provided location.

GetSymbolAsync(IDictionary<String, Object>)

Asynchronously returns a symbol based on the provided attributes.

OpenAsync(PortalItem)

Opens a DictionarySymbolStyle from a portal item. The portal item must be a dictionary web style.

OpenAsync(Uri)

Opens a new DictionarySymbolStyle from a dictionary web style item Uri.

Applies to

TargetVersions
.NET Standard 2.0100.3 - 200.0
.NET 6.0100.13 - 200.0
.NET 6.0 Windows100.13 - 200.0
.NET 6.0 Android200
.NET 6.0 iOS200
.NET Framework100.0 - 200.0
.NET 5100.10 - 100.12
.NET Core 3.1100.7 - 100.12
Android100.0 - 100.15
iOS100.0 - 100.15
UWP100.0 - 200.0

Relevant samples

Custom dictionary style: Use a custom dictionary style (.stylx) to symbolize features using a variety of attribute values.
In This Article
Back to top Copyright © 2022 Esri.