Creates a WMTS TileSet Model.
the options for the WMTS model
An event indicating that this RasterTileSetModel is invalidated. Invalidated means that the underlying data for the tiled images has changed This event fires when invalidate is called.
The base URL configures the location of the tile server. Please refer to getTileURL for details on how the base URL is used to obtain tiles.
The base URL configures the location of the tile server. Please refer to getTileURL for details on how the base URL is used to obtain tiles.
Indicates whether or not credentials should be included with HTTP requests.
Set this to true if the server requires credentials, like HTTP basic authentication headers or cookies.
You should disable credentials if the server is configured to allow cross-origin requests from all domains (Acces-Control-Allow-Origin=*).
If the server allows CORS requests from all domains, the browser will block all requests where credentials=true.
Once set, all subsequent HTTP requests will use the newly set value.
The default value is false.
Indicates whether or not credentials should be included with HTTP requests.
Set this to true if the server requires credentials, like HTTP basic authentication headers or cookies.
You should disable credentials if the server is configured to allow cross-origin requests from all domains (Acces-Control-Allow-Origin=*).
If the server allows CORS requests from all domains, the browser will block all requests where credentials=true.
Once set, all subsequent HTTP requests will use the newly set value.
The default value is false.
Returns the data type of this RasterTileSetModel.
Dimension parameters to send along with WMTS GetTile request.
Typical dimensions are TIME and ELEVATION.
The object literal can contain simple key/value pairs. Dimension names will be prefixed with "DIM_" in the
WMTS requests, if this is not already the case. The dimension names TIME and ELEVATION
will never be prefixed. Accepted values are strings, numbers, booleans.
A ProgrammingError will be thrown if values of another type are used.
Values must not be URL encoded. Assigning other values than object literals to dimensions will
throw a ProgrammingError.
Assigning to this property will automatically trigger a refresh of the visualization on the map.
The example below configures a WMTSTileSetModel to request temperature data on the 1st of july 2016, at ground level.
wmtsTileSetModel.dimensions = {
TIME: "2016-07-01T12:00:00.000Z",
ELEVATION: 0
};
Dimension parameters to send along with WMTS GetTile request.
Typical dimensions are TIME and ELEVATION.
The object literal can contain simple key/value pairs. Dimension names will be prefixed with "DIM_" in the
WMTS requests, if this is not already the case. The dimension names TIME and ELEVATION
will never be prefixed. Accepted values are strings, numbers, booleans.
A ProgrammingError will be thrown if values of another type are used.
Values must not be URL encoded. Assigning other values than object literals to dimensions will
throw a ProgrammingError.
Assigning to this property will automatically trigger a refresh of the visualization on the map.
The example below configures a WMTSTileSetModel to request temperature data on the 1st of july 2016, at ground level.
wmtsTileSetModel.dimensions = {
TIME: "2016-07-01T12:00:00.000Z",
ELEVATION: 0
};The number of available detail levels. Level 0 is the coarsest level.
Headers to send with every HTTP request.
An object literal that represents the headers to send with every HTTP request. The property names represent HTTP header names, the property values represent the HTTP header values. This property can be set dynamically (post-construction). Once set, all subsequent HTTP requests will use the newly set headers.
Note that when custom headers are being sent to a server on another domain, the server will have to properly
respond to pre-flight CORS requests (a HTTP OPTION request sent by the browser before doing the actual request).
The server has to indicate that the header can be used in the actual request, by including it in
the pre-flight's Access-Control-Allow-Headers response header.
The default value is null.
Headers to send with every HTTP request.
An object literal that represents the headers to send with every HTTP request. The property names represent HTTP header names, the property values represent the HTTP header values. This property can be set dynamically (post-construction). Once set, all subsequent HTTP requests will use the newly set headers.
Note that when custom headers are being sent to a server on another domain, the server will have to properly
respond to pre-flight CORS requests (a HTTP OPTION request sent by the browser before doing the actual request).
The server has to indicate that the header can be used in the actual request, by including it in
the pre-flight's Access-Control-Allow-Headers response header.
The default value is null.
Custom request parameters to send along with WMTS GetMap and GetFeatureInfo request.
The object literal can contain simple key/value pairs. If you try to configure request parameters that
are part of the WMTS standard, a ProgrammingError will be thrown. For
example, adding a "layers" request parameter is not allowed. Accepted values are strings, numbers and booleans.
A ProgrammingError will be thrown if values of another type are used.
Values must not be URL encoded.
Assignments of other values than object literals to requestParameters will throw an Error. Clearing
the parameters can be done by assigning null or an empty object literal to
requestParameters. In order to trigger a refresh of the
visualization on the map, can call invalidate.
Custom request parameters to send along with WMTS GetMap and GetFeatureInfo request.
The object literal can contain simple key/value pairs. If you try to configure request parameters that
are part of the WMTS standard, a ProgrammingError will be thrown. For
example, adding a "layers" request parameter is not allowed. Accepted values are strings, numbers and booleans.
A ProgrammingError will be thrown if values of another type are used.
Values must not be URL encoded.
Assignments of other values than object literals to requestParameters will throw an Error. Clearing
the parameters can be done by assigning null or an empty object literal to
requestParameters. In order to trigger a refresh of the
visualization on the map, can call invalidate.
Returns the sampling mode of this RasterTileSetModel.
getTileURL will replace the {s} pattern in baseURL with
values from subdomains. This will cause tile requests to be spread across different
subdomains. Browsers limit the amount of connections to a single domain. Using
subdomains avoids hitting this limit.
The subdomains array cannot be empty if the model's baseURL contains the {s}
subdomain hook.
getTileURL will replace the {s} pattern in baseURL with
values from subdomains. This will cause tile requests to be spread across different
subdomains. Browsers limit the amount of connections to a single domain. Using
subdomains avoids hitting this limit.
The subdomains array cannot be empty if the model's baseURL contains the {s}
subdomain hook.
Returns the pixel density of the raster data at the specified detail level. The pixel density is the number of raster elements per spatial unit , i.e. (tile pixel width) / (tile spatial width) and (tile pixel height) / (tile spatial height area), where the tile spatial dimensions are in the tilesets reference.
the requested detail level
the pixel density of the raster data at the specified detail level.
It returns null if the level does not exist.
Returns the bounds of a given tile in the tile set. The bounds are calculated based on the model bounds and the model's tileset structure.
The tile coordinate for which you want to calculate the bounds
The bounds of the requested tile coordinate in the model's reference.
Returns the number of columns in the tile grid at the given level. Each level should have twice the number of columns of the previous one.
the level to be queried
the number of tile columns on the specified level
Loads a tile from the tileset. The default implementation of this method calls the getImage method.
The following code snippet illustrates how this method can be overridden.
model.getTileData = function(tile, onSuccess, onError) {
fetch(url).then(function(response) {
response.arrayBuffer().then(function(arrayBuffer) {
onSuccess(tile, {
data: arrayBuffer,
mimeType: "image/jpeg"
});
})
});the coordinate of the tile
the callback function that should be invoked when the tile was successfully loaded The function will receive two arguments, the tile coordinate that was passed to this function and a TileData object.
the callback function that should be invoked when the tile could not be loaded The function will receive two arguments, the tile coordinate that was passed to this function and an optional Error object.
an AbortSignal that signals when a tile request is cancelled.
Returns the height, in pixels, of the tiles at the specified detail level. All tiles are assumed to have the same resolution.
the requested detail level
the height of the tiles at the specified detail level
Returns the number of rows in the tile grid at the given level. Each level should have twice the number of rows of the previous one.
the level to be queried
the number of tile rows on the specified level
Returns the URL for a specific tile.
the base URL that was passed to the constructor.
the coordinate of the tile
the resolved URL for the specified tile or null if the requested tile does not exist.
Returns the width, in pixels, of the tiles at the specified detail level. All tiles are assumed to have the same resolution.
the requested detail level
the width of the tiles at the specified detail level
Signals that the underlying data for the tiled images has changed. If this model is added to a map using a RasterTileSetLayer, calling this method will thus trigger a refresh of the visualization.
Creates a tileset model for the given layers and options. This is the recommended method to create a model based on information provided by WMTSCapabilities.
WMTS capabilities
An object literal that defines the desired WMTS layer and optionally a style.
The literal has a mandatory layer and an optional style property,
both of type String.
The options for the WMTS model
a WMTSTileSetModel for the given parameters.
Creates a tileset model for the given layers and options. This is the recommended method to create a model based on a given WMTS server URL and layer names.
The URL of the WMTS server.
An object literal that defines the desired WMTS layer and (optionally) a style.
The literal has a mandatory layer and an optional style property,
both of type String.
The options for the WMTS model
a WMTSTileSetModel for the given parameters.
The promise is rejected if the model creation fails.
A tileset model that can access an OGC WMTS server.
Typically, you don't need to call the constructor yourself. Instead, use the factory methods createFromURL or createFromCapabilities to create an instance of this model. The following example demonstrates how to set up a
WMTSTileSetModelto retrieve WMTS tiles for a given service URL and layer name:WMTSTileSetModel.createFromURL("http://sampleservices.luciad.com/wmts", {layer: "92c09725-a9c5-46fb-bffd-d9e23b4abbf2"}) .then(function(model) { //Create a layer for the WMTS model const layer = new RasterTileSetLayer(model); //Add the layer to the map map.layerTree.addChild(layer); });If you want to access the WMTS server capabilities and explore the service metadata and available data sets, you must create a WMTSCapabilities instance first. You can also use this instance to create a
WMTSTileSetModelafterwards:const capabilitiesPromise = WMTSCapabilities.fromURL("http://sampleservices.luciad.com/wmts"); capabilitiesPromise.then(function(capabilities) { //Create a model using the capabilities const model = WMTSTileSetModel.createFromCapabilities(capabilities, {layer: "92c09725-a9c5-46fb-bffd-d9e23b4abbf2"}); //Create a layer for the WMTS model const layer = new RasterTileSetLayer(model); //Add the layer to the map map.layerTree.addChild(layer); });Supported versions
Currently only WMTS services that support version 1.0 of the OGC WMTS specification are supported. Also, only KVP GetTile request encodings are currently supported. SOAP or RESTful WMTS GetTile request encodings are not supported.