Interface WmsSourceOptions

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

Hierarchy (view full)

Properties

colorSpace? containsFn? extent? flipY? format? imageFormat is8bit? layer noDataValue? params? projection requestPriority? synchronous? url

Properties

OptionalcolorSpace

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.

OptionalcontainsFn

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.

Optionalextent

extent?: Extent

The optional extent of the source. If not provided, it will be computed from the source.

OptionalflipY

flipY?: boolean

Should images be flipped vertically during composition ?

Optionalformat

format?: ImageFormat

The optional image decoder.

imageFormat

imageFormat: string

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

Optionalis8bit

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

layer: string | string[]

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

OptionalnoDataValue

noDataValue?: number

The optional no-data value.

Optionalparams

params?: Record<string, unknown>

Additional params to pass to the WMS service.

projection

projection: string

The projection of the layer.

OptionalrequestPriority

requestPriority?: RequestPriority

The relative priority of HTTP requests emitted by this source.

Default Value

'auto'

Optionalsynchronous

synchronous?: boolean

Is this source able to generate images synchronously ?

url

url: string

The URL to the WMS service.

Settings

Member Visibility

On This Page

Properties