BasemapStylesServiceInfo Class

  • BasemapStylesServiceInfo
  • class Esri::ArcGISRuntime::BasemapStylesServiceInfo

    Represents the service metadata for the Basemap Styles Service. More...

    Header: #include <BasemapStylesServiceInfo.h>
    Since: Esri::ArcGISRuntime 200.5
    Inherits: Esri::ArcGISRuntime::Object

    Public Functions

    virtual ~BasemapStylesServiceInfo() override
    QList<Esri::ArcGISRuntime::BasemapStyleInfo *> stylesInfo() const
    QUrl url() const
    QString version() const

    Detailed Description

    The BasemapStylesServiceInfo can be obtained from a loaded BasemapStylesService. The service info provides information for browsing the contents of the service.

    Relevant samples:

    • Create dynamic basemap gallery: Implement a basemap gallery that automatically retrieves the latest customization options from the basemap styles service.

    See also BasemapStylesService.

    Member Function Documentation

    [override virtual] BasemapStylesServiceInfo::~BasemapStylesServiceInfo()

    Destructor.

    QList<Esri::ArcGISRuntime::BasemapStyleInfo *> BasemapStylesServiceInfo::stylesInfo() const

    Returns a list of BasemapStyleInfo objects.

    Each BasemapStyleInfo object contains information about a style in the Basemap Style Service, including:

    • Name of style.
    • URL to access the thumbnail for a style.
    • Customizations options available for a style (e.g. label languages).

    The information in each BasemapStyleInfo object is retrieved from the service each time the BasemapStylesService is loaded, allowing any new customization options added to the Basemap Styles Service to be automatically integrated into an application.

    The ability to access the latest customization options available in the Basemap Styles Service allows applications to be created that dynamically update to include the latest features. For example, if the language of labels on a basemap is a customization option available in an applications preferences, specifying the available languages using the results of a query to the Basemap Styles Service ensures an application user has access to all of the available languages. If the service adds a new language, the list of languages in the preferences will automatically be updated.

    QUrl BasemapStylesServiceInfo::url() const

    Returns the URL for the Basemap Styles Service.

    QString BasemapStylesServiceInfo::version() const

    Returns the service's version.

    Your browser is no longer supported. Please upgrade your browser for the best experience. See our browser deprecation post for more details.