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 |
|---|---|---|
| IEnumerable<String> | keys | IEnumerable<T> of String type value. It is the list of keys required to obtain a symbol from the style. |
Returns
| Type | Description |
|---|---|
| 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
| Target | Versions |
|---|---|
| .NET Standard 2.0 | 100.3 - 100.14 |
| .NET 6.0 | 100.13 - 100.14 |
| .NET 6.0 Windows | 100.13 - 100.14 |
| .NET Framework | 100.0 - 100.14 |
| .NET 5 | 100.10 - 100.12 |
| .NET Core 3.1 | 100.7 - 100.12 |
| Xamarin.Android | 100.0 - 100.14 |
| Xamarin.iOS | 100.0 - 100.14 |
| UWP | 100.0 - 100.14 |