API (v2.0.0) - Giro3D
    Preparing search index...

    Interface WmsSourceOptions

    Constructor options for WmsSourceOptions.

    interface WmsSourceOptions {
        colorSpace?: ColorSpace;
        containsFn?: CustomContainsFn;
        enableWorkers?: boolean;
        extent?: Extent;
        flipY?: boolean;
        format?: ImageFormat;
        httpTimeout?: number;
        imageFormat?: string;
        is8bit?: boolean;
        layer: string | string[];
        noDataValue?: number;
        params?: Record<string, unknown>;
        projection: string;
        requestPriority?: RequestPriority;
        retries?: number;
        styles?: string[];
        synchronous?: boolean;
        transparent?: boolean;
        url: string;
        version?: "1.3.0" | "1.1.1";
    }

    Hierarchy

    Index

    Properties

    colorSpace? containsFn? enableWorkers? extent? flipY? format? httpTimeout? imageFormat? is8bit? layer noDataValue? params? projection requestPriority? retries? styles? synchronous? transparent? url version?

    Properties

    colorSpace?: ColorSpace

    The custom color space of the generated textures. See https://threejs.org/docs/#manual/en/introduction/Color-management for more information. If unspecified, the source considers that 8-bit images are in the sRGB color space, otherwise NoColorSpace.

    containsFn?: CustomContainsFn

    The custom function to test if a given extent is contained in this source. Note: we assume this function accepts extents in this source's CRS.

    enableWorkers?: boolean

    Enable web workers.

    true
    extent?: Extent

    The optional extent of the source. Not required, except for some performance optimizations.

    flipY?: boolean

    Should images be flipped vertically during composition ?

    format?: ImageFormat

    The optional image decoder.

    undefined
    httpTimeout?: number

    The optional HTTP request timeout, in milliseconds.

    5000
    imageFormat?: string

    The image format (e.g image/png).

    'image/png'
    is8bit?: boolean

    The data type of images generated. For regular color images, this should be true. For images with a high dynamic range, or images that requires additional processing, this should be false.

    layer: string | string[]

    The name of the WMS layer, or layers to use.

    noDataValue?: number

    The optional no-data value.

    params?: Record<string, unknown>

    Additional params to pass to the WMS service.

    projection: string

    The projection to use in GetMap requests.

    requestPriority?: RequestPriority

    The relative priority of HTTP requests emitted by this source.

    'auto'

    retries?: number

    How many retries to execute when an HTTP request ends up in error.

    3
    styles?: string[]

    The list of WMS styles to use.

    undefined
    synchronous?: boolean

    Is this source able to generate images synchronously ?

    transparent?: boolean

    Enable transparency on requests.

    true
    url: string

    The URL to the WMS service.

    version?: "1.3.0" | "1.1.1"

    The WMS version to use.

    '1.3.0'

    Settings

    Member Visibility

    On This Page

    Properties