SymbolStyle QML Type

Determines if this SymbolStyle instance should attempt to automatically load after it has instantiated.

By default this property is true which means a SymbolStyle will attempt to load if it has at least a specificationType. It may be useful to declare this property as false in the case you would like to delay the loading of the SymbolStyle to be controlled manually at a later time.

This property cannot be set after the SymbolStyle has instantiated.

The security credential used to access the remote resource.

This is only applicable if the service is secured.

The result from the asynchronous defaultSearchParametersStatus method.

Obtain this result once the defaultSearchParametersStatusChanged emits, and the defaultSearchParametersStatus is completed.

Returns the status of the asynchronous defaultSearchParameters task (read-only).

See also Enums.TaskStatus.

The result from the asynchronous fetchSymbol method(s).

Obtain this result once the fetchSymbolStatusChanged emits, and the fetchSymbolStatus is completed.

Returns the status of the asynchronous fetchSymbol task (read-only).

See also Enums.TaskStatus.

Returns the load error (read-only).

Note: load errors are also reported on the error property and emit the errorChanged signal.

See also Loadable.

Returns the load status code of this Loadable object (read-only).

See also Enums.LoadStatus and Loadable.

The portal that hosts the web style identified with styleName.

This will be null if the style was identified with a PortalItem, a URL, or a local .stylx file on disk. If null is passed for portal parameter, ArcGIS online is used as the default portal. An overview of Esri web styles and symbols currently in production is available for 3D and for 2d.

This property was introduced in Esri.ArcGISRuntime 100.10.

The portal item representing the web style.

The PortalItem will be set when SymbolStyle is created using createSymbolStyleFromUrl(url).

This property was introduced in Esri.ArcGISRuntime 100.10.

The configuration parameters used for network requests sent by this object.

This property was introduced in Esri.ArcGISRuntime 100.13.

The results from the asynchronous searchSymbols method.

Obtain this result once the searchSymbolsStatusChanged emits, and the searchSymbolsStatus is completed.

Returns the status of the asynchronous searchSymbols task (read-only).

See also Enums.TaskStatus.

The path to the ArcGIS Runtime-enabled style (*.stylx) file.

This property must be set in order to construct a SymbolStyle.

You cannot change the styleLocation on the SymbolStyle after the instance is already loaded.

The name of the web style.

The registered Esri symbol style name. The styleName cannot be a custom web style name. This will be empty if the style was identified with a URL, a PortalItem, or a local .stylx file on disk.

This property was introduced in Esri.ArcGISRuntime 100.10.

Returns the type of Symbol Style for this object (read-only).

See also Enums.SymbolStyleType.

The URL of the web style. This will be empty if the style was identified with a PortalItem, a style name, or a local .stylx file on disk.

This property was introduced in Esri.ArcGISRuntime 100.10.

Emitted when the autoLoad property changes.

Note: The corresponding handler is onAutoLoadChanged.

Emitted when the credential property changes.

Note: The corresponding handler is onCredentialChanged.

This signal was introduced in Esri.ArcGISRuntime 100.13.

Emitted when the defaultSearchParametersStatus property changes.

Note: The corresponding handler is onDefaultSearchParametersStatusChanged.

Emitted when the fetchSymbolStatus property changes.

Note: The corresponding handler is onFetchSymbolStatusChanged.

Emitted when the loadError property changes.

Note: load errors are also reported on the error property and emit the errorChanged signal.

Note: The corresponding handler is onLoadErrorChanged.

See also Loadable and Object.

Emitted when the loadStatus property changes.

Note: The corresponding handler is onLoadStatusChanged.

See also Loadable.

Emitted when the portal property changes.

Note: The corresponding handler is onPortalChanged.

This signal was introduced in Esri.ArcGISRuntime 100.10.

Emitted when the portalItem property changes.

Note: The corresponding handler is onPortalItemChanged.

This signal was introduced in Esri.ArcGISRuntime 100.10.

Emitted when the requestConfiguration property changes.

Note: The corresponding handler is onRequestConfigurationChanged.

This signal was introduced in Esri.ArcGISRuntime 100.13.

Emitted when the searchSymbolsStatus property changes.

Note: The corresponding handler is onSearchSymbolsStatusChanged.

Emitted when the styleLocation property changes.

Note: The corresponding handler is onStyleLocationChanged.

Emitted when the styleName property changes.

Note: The corresponding handler is onStyleNameChanged.

This signal was introduced in Esri.ArcGISRuntime 100.10.

Emitted when the url property changes.

Note: The corresponding handler is onUrlChanged.

This signal was introduced in Esri.ArcGISRuntime 100.10.

See also Loadable.

Cancel the task with the ID taskId.

Returns false if the task cannot be canceled or there is no task with the specified id taskId.

See also Cancelable.

Creates a new symbol style object using web style item Url.

• webStyleUrl

This method can only be accessed via the Factory object.

Factory.SymbolStyle.createSymbolStyleFromUrl(...)

A symbol style using style item's URL. For example, https://www.arcgis.com/home/item.html?id=bf27400d167d4c2e8e12c8a46f87afe4 is the URL of the "Basic Shapes" style on ArcGIS Online.".

This method was introduced in Esri.ArcGISRuntime 100.10.

Retrieves all of the valid SymbolStyleSearchParameters for the SymbolStyle.

This asynchronous task retrieves all the valid input search parameters in the style file. This means you get all of the possible input values for categories, keys, names, symbolClasses, and tags. This is an expensive task that should be used sparingly. The defaultSearchParametersStatusChanged signal emits once complete, with the defaultSearchParametersStatus being completed, giving access to pre-populated SymbolStyleSearchParameters.

Gets a Symbol, as defined by the input keys.

This function is useful for obtaining a single, multi-layer symbol from the supplied keys. This is commonly used to create symbols and graphics on-the-fly. A common workflow for this would be to first call searchSymbols, which searches for symbols in the style file. This returns a list model of SymbolStyleSearchResults, all of which contain a key. Create a string list of all the keys you want in your resulting symbol, and call fetchSymbol with this string list. This will return a new symbol from all of the individual symbol keys provided.

The fetchSymbolStatusChanged signal emits once complete, giving access to the resulting symbol.

If the SymbolStyle is not loaded then starting this task will start the load cycle.

Note: The order of the keys in the string list determines how the output symbol will look. The first key in the string list will be at the bottom of the output symbol.

See also Loadable.

See also Loadable.

Searches for symbols using searchParameters.

This asynchronous task searches for symbols in a style file. The input searchParameters define what is searched for. For example, you could search for all symbols that have the tag "airspace" or "forestry". You can also set the match to be strict or not, which will determine if the search uses "=" or "LIKE" for each parameter. The searchSymbolsStatusChanged signal emits once complete, with the searchSymbolsStatus being completed, giving access to a SymbolStyleSearchResultListModel.

Note: To get all available style symbol search results, pass in a default constructed SymbolStyleSearchParameters.