Wmts
A layer that can visualize data from a WMTS service by using pre-generated tiles. Web Map Tile Service (WMTS) is an Open Geospatial Consortium (OGC) standard for delivering geographic data via raster tiles. A WMTS layer uses pre-generated tiles to create a map instead of dynamically generating map images.The service may be hosted in ArcGIS Online, in ArcGIS Enterprise, or in a third party Server. This API supports WMTS 1.0.0.
Functional characteristics
The maps provided by a WMTS service use predefined symbology defined by the server. As a result, it is not possible to apply custom renderers or to visualize feature selection.
A WMTS service can contain multiple layers in a hierarchy. A WMTS layer can be constructed directly with a URL to a service and the uniquely identifying name of the desired layer. Alternatively, a WMTS service can be used to programmatically explore the available layers and allow the user to choose layers at run time.
When creating a WmtsLayer, some WMTS services require that you provide a direct URI to the getCapabilities resource by appending either /1.0.0/WMTSCapabilities.xml or ?service=wmts&request=getCapabilities&version=1.0.0 to the root WMTS URI.
Performance characteristics
WMTS layer consumes raster tiles that were previously rendered and cached by a server. WMTS requires fewer server resources than WMS because the images are rendered and cached ahead of time. WMTS layer requires a connection to the service at all times.
Since
200.1.0
See also
Constructors
Creates a WMTS layer from the specified URL, layer Id, tile matrix set Id and preferred image format.
Creates a WMTS layer object from a WMTS layer info.
Properties
The dictionary of custom parameters to be sent with WMTS requests issued by this layer. These parameters are appended to GetMap and GetFeatureInfo requests. If a parameter with the same name is defined in WmtsService.customParameters, then layer-specific values take precedence over service-wide values.
The id of the WMTS layer. WmtsLayer.layerId cannot be changed on loaded layers, or on layers created from a WmtsLayerInfo.
The WMTS Layer information.
The preferred image format used for tiles of this WMTS layer. If an image format is not specified when creating this layer, then the value is TileImageFormat.Unknown until the layer is loaded.
The WMTS tile matrix set for this WMTS layer. If tile matrix set is not specified when creating this layer, or is specified only by name, then the value is null until layer is loaded.
The tile matrix set identifier for this WMTS layer. This value cannot be changed on loaded layers, or on layers created from a WmtsLayerInfo.
The URL of the WMTS service. This value cannot be changed on loaded layers, or on layers created from a WmtsLayerInfo.
Inherited properties
The attribution string for the image tiled layer.
The brightness of the layer.
A flag indicating whether the layer content's visibility can be changed. A flag indicating whether the layer content visibility can be changed. Will return false if an error occurs.
The description for the layer.
The full extent of this layer, which is the extent where all layer data is contained. You can use this to zoom to all of the data contained in this layer. For feature layers, the extent is retrieved from its FeatureTable.extent.
The unique identifying string for the layer, as specified in a map or scene. The id is used by other parts of this API to refer to a specific Layer, such as in a set of FeatureFenceParameters or a FacilityLayerDefinition. If not supplied, all layers will be assigned a unique id when created.
True if the layer supports identify, false otherwise. The value of this property may not be correct until the layer is in a fully loaded state.
The load status.
The maximum scale for the layer. The maximum scale at which this layer is visible. If the map or scene is zoomed in beyond this scale, the layer will not be visible. A value of 0 means there is no maximum scale threshold and the layer will be visible at the smallest scale available for the map or scene. If the value is nil, there is no maximum scale. All of the connected map and scene views will be updated.
The minimum scale for the layer. The minimum scale at which this layer is visible. If the map or scene is zoomed out beyond this scale, the layer will not be visible. A value of 0 means there is no minimum scale threshold and the layer will be visible at the largest scale available for the map or scene. If the value is nil, there is no minimum scale. All of the connected map and scene views will be updated.
Controls how a tile request that returns 'NoData' is resampled. Zooming in can result in tile requests with no tiles at the requested level of detail. In this case, there are options that control what to display where the tile should be including:
A flag indicating whether the layer content participates in the legend. A flag indicating whether the layer content is shown in the legend.
The spatial reference of the layer.
The sub layer contents of a layer content.
Callback invoked when the visibility of the layer changes.
Inherited functions
Cancels loading metadata for the Loadable object.
Fetches the list of legend info.
Returns the layer content's effective visibility at the specified scale. Returns the effective layer content visibility. This effective visibility takes care of the effective visibility of the parents at the specified scale. Will return false if an error occurs.