ArcGIS Developers

ArcGISMapServiceInfo Class

class Esri::ArcGISRuntime::ArcGISMapServiceInfo

Read-only metadata from the map service. More...

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

This class was introduced in Esri::ArcGISRuntime 100.0.

Public Functions

ArcGISMapServiceInfo(Esri::ArcGISRuntime::ArcGISMapServiceInfo &&other)
ArcGISMapServiceInfo(const Esri::ArcGISRuntime::ArcGISMapServiceInfo &other)
Esri::ArcGISRuntime::ArcGISMapServiceInfo &operator=(Esri::ArcGISRuntime::ArcGISMapServiceInfo &&other)
Esri::ArcGISRuntime::ArcGISMapServiceInfo &operator=(const 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

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

This metadata is populated once the corresponding layer is loaded.

ArcGISMapServiceInfo may also be created from JSON.

See also JsonSerializable.

Member Function Documentation

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

Move constructor from other ArcGISMapServiceInfo.

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

Copy constructor from other ArcGISMapServiceInfo.


Default constructor.

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

Move operator from other ArcGISMapServiceInfo.

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

Assignment operator from other ArcGISMapServiceInfo.

[override virtual] ArcGISMapServiceInfo::~ArcGISMapServiceInfo()


QString ArcGISMapServiceInfo::attribution() const

Returns the attribution of the service.

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

Returns the map service capabilities.

QString ArcGISMapServiceInfo::currentVersion() const

Returns the ArcGIS Server version of the service.

QString ArcGISMapServiceInfo::description() const

Returns the description of the service.

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

Returns the document info of the service.

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

Creates a new ArcGISMapServiceInfo from json.

See also JsonSerializable.

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.

bool ArcGISMapServiceInfo::isExportTileCacheCompactV2Allowed() const

Returns whether exporting tiles in compact version 2 format (.tpkx) is supported.

The export tile cache compact version 2 (.tpkx) format now supersedes the compact (.tpk) format across the ArcGIS platform. 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 and you should check isExportTilesAllowed to confirm whether it supports exporting the earlier .tpk format. format version.

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

This function was introduced in Esri::ArcGISRuntime 100.10.

bool ArcGISMapServiceInfo::isExportTilesAllowed() const

Returns whether exporting tiles in compact format (.tpk) is supported.

This property indicates whether the map service supports exporting tiles as compact (.tpk) format. Exporting tiles allows you to use them as a basemap or operational layer, 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, and is widely used across the ArcGIS platform. Check isExportTileCacheCompactV2Allowed to confirm whether the service supports this format.

See also CacheStorageFormat.

bool ArcGISMapServiceInfo::isSingleFusedMapCache() const

Returns whether the service uses pre-generated cached tiles.

bool ArcGISMapServiceInfo::isSupportsDynamicLayers() const

Returns whether the service supports dynamic layers.

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 of the service.

int ArcGISMapServiceInfo::maxImageWidth() const

Returns the max image width of the service.

int ArcGISMapServiceInfo::maxRecordCount() const

Returns the maximum number of records that can be returned from the service.

double ArcGISMapServiceInfo::maxScale() const

Returns the maximum scale of the service.

double ArcGISMapServiceInfo::minScale() const

Returns the minimum scale of the service.

QString ArcGISMapServiceInfo::serviceDescription() const

Returns the service description of the service.

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

Returns a value indicating the type of service this metadata came from.

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

Returns the spatial reference of the map service.

QStringList ArcGISMapServiceInfo::supportedImageFormatTypes() const

Returns a list of the supported image formats of the service.

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 servers from the service.

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

Returns the time info from the service.

[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.

Gets the unknown JSON of this object.

See also JsonSerializable.

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

Reimplements: JsonSerializable::unsupportedJson() const.

Gets the unsupported JSON of this object.

See also JsonSerializable.

QUrl ArcGISMapServiceInfo::url() const

Returns the URL to the map service.

Feedback on this topic?