Information about a given BasemapStyle available from the Basemap Styles Service, including human-readable name, thumbnail url and customization options. More...
| Header: | #include <BasemapStyleInfo.h> |
| Since: | Esri::ArcGISRuntime 200.5 |
| Inherits: | Esri::ArcGISRuntime::Object |
Public Functions
| virtual | ~BasemapStyleInfo() override |
| QList<Esri::ArcGISRuntime::BasemapStyleLanguageStrategy> | languageStrategies() const |
| QList<Esri::ArcGISRuntime::BasemapStyleLanguageInfo *> | languages() const |
| Esri::ArcGISRuntime::BasemapStyle | style() const |
| QString | styleName() const |
| QUrl | thumbnailUrl() const |
| QList<Esri::ArcGISRuntime::Worldview *> | worldviews() const |
Signals
| void | thumbnailUrlChanged() |
Detailed Description
The Basemap Styles Service can be queried to access information about a given BasemapStyle. The service provides information about each style, including the human-readable name of the style, the url for the style's preview image (a.k.a thumbnail), and different customization options available with each BasemapStyle This read-only class collates the information available for each BasemapStyle into a common data structure and makes the information easily accessible to API users.
Customization options include:
- Specific languages (e.g. "Chinese (Simplified)").
- Language Strategies (e.g. "local").
If a customization is not available for a given BasemapStyle, the list for that parameter will be empty.
The BasemapStyleInfo class is intended to help a developer determine valid values for properties on the BasemapStyleParameters object, which will be dependent on the style being used. A developer could use this information to present options to an application user, for example via UI elements, or to prevent errors occurring when loading a customized basemap.
Relevant samples:
- Create dynamic basemap gallery: Implement a basemap gallery that automatically retrieves the latest customization options from the basemap styles service.
See also BasemapStylesServiceInfo.
Member Function Documentation
[override virtual] BasemapStyleInfo::~BasemapStyleInfo ()
Destructor.
QList<Esri::ArcGISRuntime::BasemapStyleLanguageStrategy > BasemapStyleInfo::languageStrategies () const
Returns a list of BasemapStyleLanguageStrategy values.
The list contains information about each BasemapStyleLanguageStrategy that can be used with this style.
If the collection is empty, the language of labels cannot be customized on this BasemapStyle.
QList<Esri::ArcGISRuntime::BasemapStyleLanguageInfo *> BasemapStyleInfo::languages() const
Returns a list of BasemapStyleLanguageInfo objects.
The list contains information about each language that can be used to customize labels on this style.
If the collection is empty, the language of labels cannot be customized on this BasemapStyle.
Esri::ArcGISRuntime::BasemapStyle BasemapStyleInfo::style() const
Returns the BasemapStyle value representing this style.
QString BasemapStyleInfo::styleName () const
Returns the human-readable name of this BasemapStyle.
QUrl BasemapStyleInfo::thumbnailUrl () const
Returns the url to the thumbnail for the style.
thumbnailUrlChanged() signal is emitted when the thumbnail image is saved to disk and the file path is set.
[signal] void BasemapStyleInfo::thumbnailUrlChanged ()
Emitted when thumbnailUrl property is changed.
QList<Esri::ArcGISRuntime::Worldview *> BasemapStyleInfo::worldviews() const
Returns a list of Worldview objects.
The list contains information about each representation of a disputed boundary that can be displayed on this style.
If the list is empty, the representation of disputed boundaries cannot be customized on this BasemapStyle.