The following members of class SymbolStyle are deprecated. They are provided to keep old source code working. We strongly advise against using them in new code.
Public Functions
(since Esri | Symbol |
(deprecated) Esri | default |
(deprecated) Esri | fetch |
(deprecated) Esri | search |
Signals
(deprecated) void | default |
(deprecated) void | fetch |
(deprecated) void | search |
Member Function Documentation
[since Esri::ArcGISRuntime 100.13, deprecated] SymbolStyle::SymbolStyle (Esri::ArcGISRuntime::PortalItem *portalItem , Esri::ArcGISRuntime::Credential *credential, QObject *parent = nullptr)
This function is deprecated. We strongly advise against using it in new code.
Creates a new symbol style object from a portal item. The portal item must contain a style.
- portalItem - A PortalItem that contains a web style.
- credential - The credential used to access the remote resource.
- parent - The optional parent QObject.
If you have the item id of a style file, you can search the portal to find the item using its item id. Use this constructor if you have a reference to a portal item.
This function was introduced in Esri::ArcGISRuntime 100.13.
[override virtual, since Esri::ArcGISRuntime 100.13, deprecated] Esri::ArcGISRuntime::Credential *SymbolStyle::credential() const
This function is deprecated. We strongly advise against using it in new code.
Reimplements: RemoteResource::credential() const.
Returns the security credentials to access the remote resource.
Only applicable if the resource is secured.
This function was introduced in Esri::ArcGISRuntime 100.13.
[deprecated] Esri::ArcGISRuntime::TaskWatcher SymbolStyle::defaultSearchParameters ()
This function is deprecated. We strongly advise against using it in new code.
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 defaultSearchParametersCompleted signal emits once complete, giving access to pre-populated SymbolStyleSearchParameters.
[signal, deprecated] void SymbolStyle::defaultSearchParametersCompleted (const QUuid &taskId , const Esri::ArcGISRuntime::SymbolStyleSearchParameters &searchParameters )
This function is deprecated. We strongly advise against using it in new code.
Signal emitted when the defaultSearchParameters asynchronous task has completed.
- taskId - The task ID of the asynchronous task.
- searchParameters - The SymbolStyleSearchParameters.
See also SymbolStyleSearchParameters.
[deprecated] Esri::ArcGISRuntime::TaskWatcher SymbolStyle::fetchSymbol (const QStringList &keys)
This function is deprecated. We strongly advise against using it in new code.
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 fetchSymbolCompleted 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 fetchSymbolCompleted.
[signal, deprecated] void SymbolStyle::fetchSymbolCompleted (const QUuid &taskId , Esri::ArcGISRuntime::Symbol *symbol)
This function is deprecated. We strongly advise against using it in new code.
Signal emitted when the fetchSymbol asynchronous task has completed.
- taskId - The task ID of the asynchronous task.
- symbol - The Symbol requested.
The returned Symbol object has the SymbolStyle as its parent.
See also Returned QObjects Parenting and SymbolStyleSearchParameters.
[override virtual, since Esri::ArcGISRuntime 100.13, deprecated] Esri::ArcGISRuntime::RequestConfiguration SymbolStyle::requestConfiguration () const
This function is deprecated. We strongly advise against using it in new code.
Reimplements: RemoteResource::requestConfiguration() const.
Returns the RequestConfiguration used to customize the request to this RemoteResource.
This function was introduced in Esri::ArcGISRuntime 100.13.
See also setRequestConfiguration().
[deprecated] Esri::ArcGISRuntime::TaskWatcher SymbolStyle::searchSymbols (const Esri::ArcGISRuntime::SymbolStyleSearchParameters &searchParameters )
This function is deprecated. We strongly advise against using it in new code.
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 searchSymbolsCompleted signal emits once complete, giving access to a SymbolStyleSearchResultListModel.
Note: To get all available style symbol search results, pass in a default constructed SymbolStyleSearchParameters.
[signal, deprecated] void SymbolStyle::searchSymbolsCompleted (const QUuid &taskId , Esri::ArcGISRuntime::SymbolStyleSearchResultListModel *searchResults )
This function is deprecated. We strongly advise against using it in new code.
Signal emitted when the searchSymbols asynchronous task has completed.
- taskId - The task ID of the asynchronous task.
- searchResults - The SymbolStyleSearchResultListModel.
The returned SymbolStyleSearchResultListModel object has the SymbolStyle as its parent.
See also Returned QObjects Parenting.
[override virtual, since Esri::ArcGISRuntime 100.13, deprecated] void SymbolStyle::setRequestConfiguration (const Esri::ArcGISRuntime::RequestConfiguration &requestConfiguration )
This function is deprecated. We strongly advise against using it in new code.
Reimplements: RemoteResource::setRequestConfiguration(const Esri::ArcGISRuntime::RequestConfiguration &requestConfiguration).
Sets the RequestConfiguration, which is used to customize the request to this RemoteResource, to requestConfiguration.
This function was introduced in Esri::ArcGISRuntime 100.13.
See also requestConfiguration().