ArcGISMapServiceInfo Class

  • ArcGISMapServiceInfo
  • class Esri::ArcGISRuntime::ArcGISMapServiceInfo

    The metadata for an ArcGIS map service. More...

    Header: #include <ArcGISMapServiceInfo.h>
    Since: Esri::ArcGISRuntime 100.0
    Inherits: Esri::ArcGISRuntime::JsonSerializable

    Public Functions

    ArcGISMapServiceInfo(const Esri::ArcGISRuntime::ArcGISMapServiceInfo &other)
    ArcGISMapServiceInfo(Esri::ArcGISRuntime::ArcGISMapServiceInfo &&other)
    virtual ~ArcGISMapServiceInfo() override
    QString attribution() const
    Esri::ArcGISRuntime::MapServiceCapabilities capabilities() const
    QString currentVersion() const
    QString description() const
    Esri::ArcGISRuntime::ServiceDocumentInfo documentInfo() const
    Esri::ArcGISRuntime::Envelope fullExtent() const
    Esri::ArcGISRuntime::Envelope initialExtent() const
    bool isEmpty() const
    bool isExportTileCacheCompactV2Allowed() const
    bool isExportTilesAllowed() const
    bool isSingleFusedMapCache() const
    bool isSupportsDynamicLayers() const
    QList<Esri::ArcGISRuntime::IdInfo> layerInfos() const
    QString mapName() const
    int maxExportTilesCount() const
    int maxImageHeight() const
    int maxImageWidth() const
    int maxRecordCount() const
    double maxScale() const
    double minScale() const
    QString serviceDescription() const
    Esri::ArcGISRuntime::ServiceType serviceSourceType() const
    Esri::ArcGISRuntime::SpatialReference spatialReference() const
    QStringList supportedImageFormatTypes() const
    QList<Esri::ArcGISRuntime::IdInfo> tableInfos() const
    Esri::ArcGISRuntime::TileInfo tileInfo() const
    QStringList tileServers() const
    Esri::ArcGISRuntime::ServiceTimeInfo timeInfo() const
    Esri::ArcGISRuntime::Unit unit() const
    QUrl url() const
    Esri::ArcGISRuntime::ArcGISMapServiceInfo &operator=(const Esri::ArcGISRuntime::ArcGISMapServiceInfo &other)
    Esri::ArcGISRuntime::ArcGISMapServiceInfo &operator=(Esri::ArcGISRuntime::ArcGISMapServiceInfo &&other)

    Reimplemented Public Functions

    virtual QString toJson() const override
    virtual QJsonObject unknownJson() const override
    virtual QJsonObject unsupportedJson() const override

    Static Public Members

    Esri::ArcGISRuntime::ArcGISMapServiceInfo fromJson(const QString &json)

    Detailed Description

    An ArcGIS map service is a data service that provides access to map images that can be rendered dynamically or pre-rendered and cached in a tile grid as static images. You can display dynamically rendered images using ArcGISMapImageLayer and pre-rendered static images using ArcGISTiledLayer.

    ArcGISMapServiceInfo provides basic information about the map, including the layers that it contains, whether or not the map is cached, its spatial reference, initial and full extents, map units, and copyright text. It also provides some metadata associated with the service, such as the service description, its author, and keywords. If the map service has a tile cache, additional information about the tiling scheme is included, such as the levels of detail, tiling scheme origin, and tile dimensions.

    You can obtain the ArcGISMapServiceInfo from a loaded ArcGISMapImageLayer, ArcGISTiledLayer, or ExportTileCacheTask.

    Member Function Documentation


    Default constructor.

    ArcGISMapServiceInfo::ArcGISMapServiceInfo(const Esri::ArcGISRuntime::ArcGISMapServiceInfo &other)

    Copy constructor from other ArcGISMapServiceInfo.

    ArcGISMapServiceInfo::ArcGISMapServiceInfo(Esri::ArcGISRuntime::ArcGISMapServiceInfo &&other)

    Move constructor from other ArcGISMapServiceInfo.

    [override virtual] ArcGISMapServiceInfo::~ArcGISMapServiceInfo()


    QString ArcGISMapServiceInfo::attribution() const

    Returns the copyright text.

    Esri::ArcGISRuntime::MapServiceCapabilities ArcGISMapServiceInfo::capabilities() const

    Returns the map service capabilities. For example, exporting map images, data and query operations.

    QString ArcGISMapServiceInfo::currentVersion() const

    Returns the current version of the ArcGIS map service.

    QString ArcGISMapServiceInfo::description() const

    Returns the description of the service.

    Esri::ArcGISRuntime::ServiceDocumentInfo ArcGISMapServiceInfo::documentInfo() const

    Returns the document information such as the title, author, and comments.

    [static] Esri::ArcGISRuntime::ArcGISMapServiceInfo ArcGISMapServiceInfo::fromJson(const QString &json)

    Convert a JSON string to an object.

    • json - The JSON string.

    Esri::ArcGISRuntime::Envelope ArcGISMapServiceInfo::fullExtent() const

    Returns the full extent of the service as an Envelope.

    Esri::ArcGISRuntime::Envelope ArcGISMapServiceInfo::initialExtent() const

    Returns the initial extent of the service as an Envelope.

    bool ArcGISMapServiceInfo::isEmpty() const

    Gets whether this ArcGISMapServiceInfo is empty.

    A default constructed ArcGISMapServiceInfo is empty.

    Returns true if empty.

    [since Esri::ArcGISRuntime 100.10] bool ArcGISMapServiceInfo::isExportTileCacheCompactV2Allowed() const

    Returns true if exporting tiles in compact version 2 format (.tpkx) is supported, false otherwise.

    The export tile cache compact version 2 (.tpkx) format now supersedes the compact (.tpk) format across ArcGIS software. For more information, see CacheStorageFormat::CompactV2.

    If this property is true, the map service supports exporting tiles as .tpkx format. If this property is false, the service does not support exporting .tpkx format, and you should check isExportTilesAllowed to confirm whether it supports exporting the earlier .tpk format. format version.

    currentVersion, 10.9 or greater, supports exporting tiles as .tpkx. Compact V2 tile caches can also be exported from export-enabled Esri image basemaps and elevation services hosted on ArcGIS Online. For more details on the specification of a .tpkx file, see

    This function was introduced in Esri::ArcGISRuntime 100.10.

    See also CacheStorageFormat.

    bool ArcGISMapServiceInfo::isExportTilesAllowed() const

    Returns true if exporting tiles in compact format (.tpk) is supported, false otherwise.

    This property indicates whether the map service supports exporting tiles as compact (.tpk) format. Exporting tiles allows you to use them as a basemap, operational layer, or elevation source, without network connectivity. See TileCache for information on creating a layer from a local tile cache.

    To export tiles, you can use either the ExportTileCacheTask or the OfflineMapTask.

    There are two formats for exporting a tile cache:

    • Compact (.tpk) is the legacy format for a tile cache. All services that support exporting tiles, support the .tpk format. See CacheStorageFormat::Compact.
    • Compact V2 (.tpkx) is the latest format used for exporting tiles. Check isExportTileCacheCompactV2Allowed to confirm whether the service supports this format.

    See also CacheStorageFormat.

    bool ArcGISMapServiceInfo::isSingleFusedMapCache() const

    Returns true if the ArcGIS map service has a single fused map cache, false otherwise.

    This is true if "Single Fused Map Cache" is set to true in the map service ArcGIS REST Services Directory.

    bool ArcGISMapServiceInfo::isSupportsDynamicLayers() const

    Returns true if the ArcGIS map service supports dynamic layers, false otherwise.

    This is true if "Supports Dynamic Layers" is set to true in the map service ArcGIS REST Services Directory.

    QList<Esri::ArcGISRuntime::IdInfo> ArcGISMapServiceInfo::layerInfos() const

    Gets information about layers in the service.

    QString ArcGISMapServiceInfo::mapName() const

    Returns the map name of the service.

    int ArcGISMapServiceInfo::maxExportTilesCount() const

    Returns the maximum number of tiles that can be exported to a tile cache or package.

    int ArcGISMapServiceInfo::maxImageHeight() const

    Returns the max image height in pixels of the service.

    int ArcGISMapServiceInfo::maxImageWidth() const

    Returns the max image width in pixels of the service.

    int ArcGISMapServiceInfo::maxRecordCount() const

    Returns the maximum number of records that can be returned at once for a query.

    double ArcGISMapServiceInfo::maxScale() const

    Returns the layers's maximum scale of the service.

    double ArcGISMapServiceInfo::minScale() const

    Returns the layers's minimum scale of the service.

    QString ArcGISMapServiceInfo::serviceDescription() const

    Returns the ArcGIS map service description.

    Esri::ArcGISRuntime::ServiceType ArcGISMapServiceInfo::serviceSourceType() const

    Returns the type of this ArcGIS service.

    Esri::ArcGISRuntime::SpatialReference ArcGISMapServiceInfo::spatialReference() const

    Returns the spatial reference of the map service.

    QStringList ArcGISMapServiceInfo::supportedImageFormatTypes() const

    Returns a list of image format types supported by this layer when generating a map image.

    QList<Esri::ArcGISRuntime::IdInfo> ArcGISMapServiceInfo::tableInfos() const

    Gets information about tables in the service.

    Esri::ArcGISRuntime::TileInfo ArcGISMapServiceInfo::tileInfo() const

    Returns the tile info from the service.

    QStringList ArcGISMapServiceInfo::tileServers() const

    Returns a list of tile server URLs that can be used to split requests for tiles.

    Esri::ArcGISRuntime::ServiceTimeInfo ArcGISMapServiceInfo::timeInfo() const

    Returns information on the support of time based queries and map requests of this map service.

    If this map service does not support time based requests, this will be empty.

    [override virtual] QString ArcGISMapServiceInfo::toJson() const

    Reimplements: JsonSerializable::toJson() const.

    Gets the JSON representation of this object.

    See also JsonSerializable.

    Esri::ArcGISRuntime::Unit ArcGISMapServiceInfo::unit() const

    Returns the linear unit of the service.

    [override virtual] QJsonObject ArcGISMapServiceInfo::unknownJson() const

    Reimplements: JsonSerializable::unknownJson() const.

    Returns the unknown data from the source JSON.

    Unknown JSON is a dictionary of values not defined in the ArcGIS specification used to create this object but found in the source JSON. If the object is written back to JSON, any unknown JSON data is not persisted. The ArcGIS specification may be for a web map, web scene, REST API, and so on.

    See also JsonSerializable.

    [override virtual] QJsonObject ArcGISMapServiceInfo::unsupportedJson() const

    Reimplements: JsonSerializable::unsupportedJson() const.

    Returns the unsupported data from the source JSON.

    Unsupported JSON is a dictionary of values defined in the ArcGIS specification used to create this object but not currently used in this API. If the object is written back to JSON, any unsupported JSON data is persisted. The ArcGIS specification may be from a web map, web scene, REST API, and so on.

    See also JsonSerializable.

    QUrl ArcGISMapServiceInfo::url() const

    Returns the URL to the map service.

    Esri::ArcGISRuntime::ArcGISMapServiceInfo &ArcGISMapServiceInfo::operator=(const Esri::ArcGISRuntime::ArcGISMapServiceInfo &other)

    Assignment operator from other ArcGISMapServiceInfo.

    Esri::ArcGISRuntime::ArcGISMapServiceInfo &ArcGISMapServiceInfo::operator=(Esri::ArcGISRuntime::ArcGISMapServiceInfo &&other)

    Move operator from other ArcGISMapServiceInfo.

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