LuciadRIA (2026.1.01)
    Preparing search index...

    Interface WMSImageModelCreateOptions

    Interface to provide HTTP request options.

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

    Hierarchy (View Summary)

    Properties

    backgroundColor? bounds? credentials? dimensions? getFeatureInfoPostRoot? getFeatureInfoRoot? getMapPostRoot? getMapRoot? imageFormat? infoFormat? maxRequestURLSize? reference? requestHeaders? requestParameters? sld? sldBody? swapAxes? transparent?
    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.

    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.
    credentials?: boolean | RequestCredentials

    Determines whether the browser sends credentials with the request

    Can be either a boolean or a RequestCredentials value:

    • true: maps to "include" - credentials are included in both same-origin and cross-origin requests
    • false: maps to "same-origin" - credentials are only included in same-origin requests
    • "include": credentials are included in both same-origin and cross-origin requests
    • "same-origin": credentials are only included in same-origin requests
    • "omit": credentials are never included in requests

    Defaults to "same-origin" behavior when undefined.

    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.

    getFeatureInfoPostRoot?: string

    Root URI for HTTP POST GetFeatureInfo requests. When the generated GET URL would exceed maxRequestURLSize, this URI is used instead to send GetFeatureInfo requests using HTTP POST. Use this option to override the POST GetFeatureInfo URI that was returned by the WMS server in the capabilities. If neither the capabilities nor this option provide a POST URI, POST is never used for GetFeatureInfo.

    2026.1

    getFeatureInfoRoot?: string

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

    2024.0

    getMapPostRoot?: string

    Root URI for HTTP POST GetMap requests. When the generated GET URL would exceed maxRequestURLSize, this URI is used to send GetMap requests using HTTP POST. Use this option to override the POST GetMap URI that was returned by the WMS server in the capabilities. If neither the capabilities nor this option provide a POST URI, POST is never used for GetMap.

    2026.1

    getMapRoot?: string

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

    2021.0.04

    imageFormat?: string

    The image format of the images to retrieve.

    "image/png" if not defined.
    infoFormat?: string

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

    maxRequestURLSize?: number

    Maximum URL length (in characters) for GET requests. When a generated request URL exceeds this threshold and a POST root is configured, the request is sent as HTTP POST instead. Request parameters will be encoded as application/x-www-form-urlencoded in the request body. When undefined (the default), POST is never used.

    2026.1

    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.

    requestHeaders?: HttpRequestHeaders | null

    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.

    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.

    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.

    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.

    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.

    transparent?: boolean

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

    Settings
    Member Visibility

    On This Page
    Properties