Class DictionarySymbolStyle
A dictionary symbol style object containing symbol primitives and rules for generating symbols from attribute values.
Namespace: Esri.ArcGISRuntime.Symbology
Assembly: Esri.ArcGISRuntime.dll
Syntax
public class DictionarySymbolStyle : SymbolStyleRemarks
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 |
|---|---|
| ConfigurationProperties | Gets or sets the dictionary of configuration settings and values used by the style. These settings are specific to the rule engine used by the DictionarySymbolStyle. |
| 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. |
| SpecificationType | Gets the name of the dictionary (.stylx file), such as "mil2525d". |
| 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, Nullable<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(String, String) | Opens a DictionarySymbolStyle using the style file identified by the specification type or style location. |
| OpenAsync(Uri) | Opens a new DictionarySymbolStyle from a dictionary web style item Uri. |
Applies to
| Target | Versions |
|---|---|
| .NET Standard 2.0 | 100.3 - 100.15 |
| .NET 6.0 | 100.13 - 100.15 |
| .NET 6.0 Windows | 100.13 - 100.15 |
| .NET Framework | 100.0 - 100.15 |
| .NET 5 | 100.10 - 100.12 |
| .NET Core 3.1 | 100.7 - 100.12 |
| Xamarin.Android | 100.0 - 100.15 |
| Xamarin.iOS | 100.0 - 100.15 |
| UWP | 100.0 - 100.15 |