Creates a WMS image model.
the options for the WMSImageModel.
An event indicating that this Controller is invalidated. Invalidated means that data has changed and the visualization needs to be refreshed. This event fires when #invalidate is called.
The background color the WMS server must use when generating the WMS image. Note that this option is only considered by the server when the WMSImageModel.transparent property is false. The backgroundColor is a string that must be formatted as "0xRRGGBB", where RGB values are represented as hexadecimal values. If you try to assign a string that does not adhere to this format an exception will be thrown.
The background color the WMS server must use when generating the WMS image. Note that this option is only considered by the server when the WMSImageModel.transparent property is false. The backgroundColor is a string that must be formatted as "0xRRGGBB", where RGB values are represented as hexadecimal values. If you try to assign a string that does not adhere to this format an exception will be thrown.
Indicates whether or not credentials should be included with HTTP requests.
See GoogleImageModel.credentials for more information.
The default value is false.
Indicates whether or not credentials should be included with HTTP requests.
See GoogleImageModel.credentials for more information.
The default value is false.
Dimension parameters to send along with WMS GetMap and GetFeatureInfo 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
WMS 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 WMSImageModel to request temperature data on the 1st of july 2016, at ground level.
wmsImageModel.dimensions = {
TIME: "2016-07-01T12:00:00.000Z",
ELEVATION: 0
};
Dimension parameters to send along with WMS GetMap and GetFeatureInfo 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
WMS 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 WMSImageModel to request temperature data on the 1st of july 2016, at ground level.
wmsImageModel.dimensions = {
TIME: "2016-07-01T12:00:00.000Z",
ELEVATION: 0
};Root URI of the getMap request interface.
Root URI of the getMap request interface.
The WMS layers, specified as an array of strings. Each string is a layer name identifier.
These layers are not the same as a Layer. They are the layers exposed by the WMS server and which are listed in the capabilities document of the WMS server.
This layers array must be considered as an immutable property. This means that to add or to remove layers, you will need to reassign this property again. Directly removing elements from the array, or directly adding elements to the array, without resetting the property will have no effect.
The order of the layers in the array corresponds to the rendering order of the layers by the WMS server.
Assigning to this property will automatically trigger a refresh of the visualization on the map.
The WMS layers, specified as an array of strings. Each string is a layer name identifier.
These layers are not the same as a Layer. They are the layers exposed by the WMS server and which are listed in the capabilities document of the WMS server.
This layers array must be considered as an immutable property. This means that to add or to remove layers, you will need to reassign this property again. Directly removing elements from the array, or directly adding elements to the array, without resetting the property will have no effect.
The order of the layers in the array corresponds to the rendering order of the layers by the WMS server.
Assigning to this property will automatically trigger a refresh of the visualization on the map.
The WMS layers that will be queried. These are the layers that will be used in the GetFeatureInfo
requests performed by the WMSImageLayer.getFeatureInfo method.
The query layers are specified as an array of strings. Each string is a layer name identifier.
This queryLayers array must be considered as an immutable property. This means that to add or to remove layers, you will need to reassign this property again. Directly removing elements from the array, or directly adding elements to the array, without resetting the property will have no effect.
Assigning to this property will automatically trigger a refresh of the visualization on the map.
The WMS layers that will be queried. These are the layers that will be used in the GetFeatureInfo
requests performed by the WMSImageLayer.getFeatureInfo method.
The query layers are specified as an array of strings. Each string is a layer name identifier.
This queryLayers array must be considered as an immutable property. This means that to add or to remove layers, you will need to reassign this property again. Directly removing elements from the array, or directly adding elements to the array, without resetting the property will have no effect.
Assigning to this property will automatically trigger a refresh of the visualization on the map.
Reports whether this model supports GetFeatureInfo requests. This is only true if the queryLayers property is filled in.
Headers to send with every HTTP request.
See GoogleImageModel.requestHeaders for more information.
The default value is null.
Headers to send with every HTTP request.
See GoogleImageModel.requestHeaders for more information.
The default value is null.
Custom request parameters to send along with WMS 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 WMS 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. Assigning to this property will automatically trigger a refresh of the
visualization on the map.
Custom request parameters to send along with WMS 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 WMS 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. Assigning to this property will automatically trigger a refresh of the
visualization on the map.
A url to a Styled Layer Descriptor that must be passed when making a request. This corresponds to the SLD request parameter in the GetMap request. If you assign to this value, the value of the sldBody property, if any, will be reset to null.
Assigning to this property will automatically trigger a refresh of the visualization on the map.
A url to a Styled Layer Descriptor that must be passed when making a request. This corresponds to the SLD request parameter in the GetMap request. If you assign to this value, the value of the sldBody property, if any, will be reset to null.
Assigning to this property will automatically trigger a refresh of the visualization on the map.
the Styled Layer Descriptor to pass when making a request. This corresponds to the SLD_BODY
request parameter in the GetMap request. The SLD must not be URL encoded.
If you assign to this value, the value of the sldBody property, if any, will be reset to null.
Assigning to this property will automatically trigger a refresh of the visualization on the map.
the Styled Layer Descriptor to pass when making a request. This corresponds to the SLD_BODY
request parameter in the GetMap request. The SLD must not be URL encoded.
If you assign to this value, the value of the sldBody property, if any, will be reset to null.
Assigning to this property will automatically trigger a refresh of the visualization on the map.
The named styles to apply on the server when making a request. The style names in the array apply to the
respective layers. Specifying a style name for a layer is
optional; if you do not wish to specify a style name for a particular layer, you can omit the entry for that
layer or pass an empty string in the styles array. The STYLES request parameter is
mandatory in a WMS request, but can be empty in case no styles are defined.
Assigning to this property will automatically trigger a refresh of the visualization on the map.
The named styles to apply on the server when making a request. The style names in the array apply to the
respective layers. Specifying a style name for a layer is
optional; if you do not wish to specify a style name for a particular layer, you can omit the entry for that
layer or pass an empty string in the styles array. The STYLES request parameter is
mandatory in a WMS request, but can be empty in case no styles are defined.
Assigning to this property will automatically trigger a refresh of the visualization on the map.
Indicates whether the ImageModel will request transparent tiles from the server or not
Indicates whether the ImageModel will request transparent tiles from the server or not
Signals that the underlying data for the tiled images has changed. If this model is added to a map using a RasterImageLayer, calling this method will thus trigger a refresh of the visualization.
Creates a WMS image model for the given layers and options. This is the recommended method to create a model based on information provided by WMSCapabilities.
The capabilities of the WMS server.
An array of object literals that defines the desired WMS layers and (optionally) their layer styles.
Each object literal has a mandatory layer property and an optional style property,
both of type String.
the options for the WMS model
a WMSImageModel for the given parameters.
Creates a WMS image model for the given layers and options. This is the recommended method to create a model based on a given WMS server URL and layer name(s).
The URL of the WMS server.
An array of object literals that defines the desired WMS layers and (optionally) their layer styles.
Each object literal has a mandatory layer property and an optional style property,
both of type String.
the options for the WMS model
a promise for a WMSImageModel for the given parameters.
The promise is rejected if the model creation fails.
A
RasterImageModelthat can access an OGC WMS Server. Use this model instead of the WMSTileSetModel if you want to visualize WMS images at an arbitrary scale and with arbitrary extents. For example, if the WMS images contain text, the text may appear smaller on the map than intended when using aWMSTileSetModel. You can avoid this by using thisWMSImageModelinstead.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
WMSImageModelto retrieve WMS image data for a given service url and layer name:WMSImageModel.createFromURL("http://sampleservices.luciad.com/wms", [{layer: "rivers"}]) .then(function(model) { //Create a layer for the WMS model const layer = new RasterImageLayer(model); //Add the layer to the map map.layerTree.addChild(layer); });If you want to access the WMS server's capabilities and explore the service metadata and available data sets, you first have to create a WMSCapabilities instance. This instance can also be to create a
WMSImageModelafterwards:const capabilitiesPromise = WMSCapabilities.fromURL("http://sampleservices.luciad.com/wms"); capabilitiesPromise.then(function(capabilities) { //Create a model using the capabilities const model = WMSImageModel.createFromCapabilities(capabilities, [{layer: "rivers"}]); //Create a layer for the WMS model const layer = new RasterImageLayer(model); //Add the layer to the map map.layerTree.addChild(layer); });Limitations
The limitations for single-image rasters also apply to this model, cf. RasterImageModel and RasterImageLayer. Most notably, WebGLMap does not support single-image raster models and layers.
Supported versions
LuciadRIA supports consuming WMS services that support version 1.1.1 and 1.3.0 of the OGC WMS specification.
2015.0