Interface WMSImageModelCreateOptions

Interface to provide HTTP request options.

interface WMSImageModelCreateOptions {
    backgroundColor?: string;
    bounds?: Bounds;
    credentials?: boolean;
    dimensions?: object;
    getFeatureInfoRoot?: string;
    getMapRoot?: string;
    imageFormat?: string;
    infoFormat?: string;
    reference?: CoordinateReference;
    requestHeaders?: null | HttpRequestHeaders;
    requestParameters?: HttpRequestParameters;
    sld?: string;
    sldBody?: string;
    swapAxes?: string[];
    transparent?: boolean;
}

Hierarchy (view full)

Properties

backgroundColor? bounds? credentials? dimensions? getFeatureInfoRoot? getMapRoot? imageFormat? infoFormat? reference? requestHeaders? requestParameters? sld? sldBody? swapAxes? transparent?

Properties

Optional backgroundColor

backgroundColor?: string

A string that represents the required background color when images are requested from the server (only applicable when transparent is false). The color format is "0xRRGGBB", where RGB values are represented as hexadecimal numbers. If a string is passed that does not adhere to this format an exception will be thrown.

Optional bounds

bounds?: Bounds

The extent of the WMS model. This parameter has two purposes:

1) the bounds defines the extent for which there is data available on the WMS server. For example, if there is only data available for an area covering the northern hemisphere, when panning around the southern hemisphere, LuciadRIA will not make requests to the server to retrieve image data. If you to not know the WMS extent, you should specify the reference instead.
2) the reference of this bounds is the reference which will be used to request images from the server. By convention, this model's reference is equal to the reference of this bounds parameter. It is also important to ensure that the reference of this bounds is supported by the WMS server. If you specify bounds you must not specify reference.

Optional credentials

credentials?: boolean

Whether credentials should be included with every HTTP request.

Optional dimensions

dimensions?: object

Dimension parameters to send along with WMS GetMap and GetFeatureInfo requests. Typical dimensions are TIME and ELEVATION. The object literal can contain simple key/value pairs. Accepted values are strings, numbers, booleans. Values must not be URL encoded.

Optional getFeatureInfoRoot

getFeatureInfoRoot?: string

Root URI of the getFeatureInfo request interface. Use this option to override the GetFeatureInfo URI that was returned in the capabilities object.

Since

2024.0

Optional getMapRoot

getMapRoot?: string

Root URI of the getMap request interface. Use this option to override the GetMap URI that was returned in the capabilities object.

Since

2021.0.04

Optional imageFormat

imageFormat?: string

The image format of the images to retrieve.

Default

"image/png" if not defined.

Optional infoFormat

infoFormat?: string

The default MIME-type for GetFeatureInfo requests. This can be overridden in the params of getFeatureInfoUrl. "application/json" is used as default.

Optional reference

reference?: CoordinateReference

The spatial reference in which this model is defined. You must only specify this parameter if you do not know the extent of the WMS coverage; in that case the world bounds will be assumed. If you specify bounds, you can omit this parameter.

Optional requestHeaders

requestHeaders?: null | HttpRequestHeaders

An object literal that represents headers (as a key-value map) to send with each HTTP request. If set (and not empty), an XHR with the specified headers will be performed instead of creating an Image.

Optional requestParameters

requestParameters?: HttpRequestParameters

Custom request parameters to send along with WMS GetMap and GetFeatureInfo request. The object literal can contain simple key/value pairs (strings, numbers, booleans). Values must not be URL encoded.

Optional sld

sld?: string

A URL to a Styled Layer Descriptor (SLD) that must be used to make a request. This parameter conflicts with sldBody, only one of these two parameters can be used at construction time.

Optional sldBody

sldBody?: string

A Styled Layer Descriptor (SLD) XML Document that must be used to make a request. The value must not be URL-encoded. This parameter conflicts with the sld parameter, only one of these two parameters can be used at construction time.

Optional swapAxes

swapAxes?: string[]

Indicates whether this model should swap the axis ordering of coordinates for the specified reference identifier(s) in WMS requests. If undefined, the axis ordering dictated by the model reference is respected. For each specified reference, the order will be reversed. This is for example needed to get an EPSG:4326 BBOX value that is encoded in longitude-latitude order instead of latitude-longitude.

Optional transparent

transparent?: boolean

Indicate if the images should be generated as transparent images or not

Settings

Member Visibility

Theme

On This Page

backgroundColorboundscredentialsdimensionsgetFeatureInfoRootgetMapRootimageFormatinfoFormatreferencerequestHeadersrequestParameterssldsldBodyswapAxestransparent