Show / Hide Table of Contents

Method GetSymbolAsync

GetSymbolAsync(IEnumerable<String>)

Asynchronously returns a symbol based on the provided list of keys.

Declaration
public Task<Symbol> GetSymbolAsync(IEnumerable<string> keys)
Parameters
Type Name Description
System.Collections.Generic.IEnumerable<System.String> keys

System.Collections.Generic.IEnumerable<T> of System.String type value. It is the list of keys required to obtain a symbol from the style.

Returns
Type Description
System.Threading.Tasks.Task<Symbol>

The task object representing the asynchronous getSymbol as operation. The value of the task result is a Symbol object.

Remarks

This function is useful for obtaining a single multilayer symbol from supplied keys. This is commonly used to create symbols and graphics on-the-fly. For example, assume XYZ style has a symbol with key "abc" which is the central symbol and another symbol with key "pqr", which could be the modifier/echelon placed at some offset from central geometry. So if you provide these two keys as attributes then symbol style will find and assemble a symbol accordingly. Once you have that symbol, you can apply it to a Graphic or Renderer, obtain its swatch image, or serialize to JSON. If the Symbol style is not loaded then starting this task will start the load cycle.

Applies to

Platforms and versions
TargetVersions
.NET Standard 2.0100.3 - 200.7
.NET100.13 - 200.7
.NET Windows100.13 - 200.7
.NET Android200.2 - 200.7
.NET iOS200.0 - 200.7
.NET Framework100.0 - 200.7
Xamarin.Android100.0 - 100.14
Xamarin.iOS100.0 - 100.15
UWP100.0 - 200.7
In This Article
Back to top Copyright © 2022 Esri.