Class WmsSource

An image source that is backed by a one or more WMS layer(s). Note: this is a convenient class that simplifies the usage of UrlImageSource.

const source = new WmsSource({
     url: 'http://example.com/wms',
     projection: 'EPSG:3857',
     layer: 'myLayer',
     imageFormat: 'image/png',
});

Hierarchy (View Summary)

UrlImageSource
- WmsSource

Index

Constructors

constructor

new WmsSource(options: WmsSourceOptions): WmsSource
Creates a WmsSource from the specified parameters.
Parameters
- options: WmsSourceOptions
  The options.
Returns WmsSource
Overrides UrlImageSource.constructor
- Defined in sources/WmsSource.ts:162

Properties

`Readonly`containsFn

containsFn: CustomContainsFn | undefined

datatype

datatype: TextureDataType

Gets the datatype of images generated by this source.

`Readonly`flipY

flipY: boolean

Gets whether images generated from this source should be flipped vertically.

`Readonly`isImageSource

isImageSource: boolean = ...

`Readonly`isMemoryUsage

isMemoryUsage: true = ...

Readonly flag to indicate that his object implements MemoryUsage.

`Readonly`isUrlImageSource

isUrlImageSource: true = ...

`Readonly`isWmsSource

isWmsSource: true = ...

`Readonly`priority

priority: RequestPriority = 'auto'

`Readonly`synchronous

synchronous: boolean = false

If true, this source can immediately generate images without any delay.

`Readonly`transparent

transparent: boolean

`Readonly`type

type: string = ...

Accessors

colorSpace

get colorSpace(): ColorSpace
Gets the color space of the textures generated by this source.

Returns ColorSpace
Inherited from UrlImageSource.colorSpace
- Defined in sources/ImageSource.ts:201

Methods

adjustExtentAndPixelSize

adjustExtentAndPixelSize(
    requestExtent: Extent,
    requestWidth: number,
    requestHeight: number,
    margin?: number,
): GridExtent | null
Returns an adjusted extent, width and height so that request pixels are aligned with source pixels, and requests do not oversample the source.
Parameters
- requestExtent: Extent
  The request extent.
- requestWidth: number
  The width, in pixels, of the request extent.
- requestHeight: number
  The height, in pixels, of the request extent.
- margin: number = 0
  The margin, in pixels, around the initial extent.
Returns GridExtent | null
The adjusted parameters.
Inherited from UrlImageSource.adjustExtentAndPixelSize
- Defined in sources/ImageSource.ts:223

contains

contains(extent: Extent): boolean
Gets whether this source contains the specified extent. If a custom contains function is provided, it will be used. Otherwise, intersects is used.

This method is mainly used to discard non-relevant requests (i.e don't process regions that are not relevant to this source).
Parameters
- extent: Extent
  The extent to test.
Returns boolean
Inherited from UrlImageSource.contains
- Defined in sources/ImageSource.ts:267

dispose

dispose(): void
Disposes unmanaged resources of this source.

Returns void
Inherited from UrlImageSource.dispose
- Defined in sources/ImageSource.ts:322

getCrs

getCrs(): CoordinateSystem
Returns the CRS of this source.

Returns CoordinateSystem
The CRS.
Inherited from UrlImageSource.getCrs
- Defined in sources/UrlImageSource.ts:159

getExtent

getExtent(): Extent | null
Returns the extent of this source expressed in the CRS of the source. Might be null if the extent of the source is not known.

Returns Extent | null
The extent of the source, if any.
Inherited from UrlImageSource.getExtent
- Defined in sources/UrlImageSource.ts:163

getImages

getImages(options: GetImageOptions): ImageResponse[]
Gets the images for the specified extent and pixel size.
Parameters
- options: GetImageOptions
  The options.
Returns ImageResponse[]
An array containing the functions to generate the images asynchronously.
Inherited from UrlImageSource.getImages
- Defined in sources/UrlImageSource.ts:167

getMemoryUsage

getMemoryUsage(_context: GetMemoryUsageContext): void
Returns an approximation of the memory used by this object, in bytes.
Parameters
- _context: GetMemoryUsageContext
Returns void
Inherited from UrlImageSource.getMemoryUsage
- Defined in sources/ImageSource.ts:194

initialize

initialize(options: { targetProjection: CoordinateSystem }): Promise<void>
Initializes the source.
Parameters
- options: { targetProjection: CoordinateSystem }
  Options.
Returns Promise<void>
A promise that resolves when the source is initialized.
Inherited from UrlImageSource.initialize
- Defined in sources/UrlImageSource.ts:154

intersects

intersects(extent: Extent): boolean
Test the intersection between the specified extent and this source's extent. This method may be overriden to perform special logic.
Parameters
- extent: Extent
  The extent to test.
Returns boolean
true if the extent and this source extent intersects, false otherwise.
Inherited from UrlImageSource.intersects
- Defined in sources/ImageSource.ts:284

setTime

setTime(date?: Date): void
Sets the TIME parameter of the tile requests, and refreshes the source. If date is undefined, temporal requests are disabled.
Parameters
- Optionaldate: Date
Returns void
- Defined in sources/WmsSource.ts:175

setUrlTemplate

setUrlTemplate(template: string): void
Sets the URL template to a new value. This raises the updated event so that the layer can be repainted.
Parameters
- template: string
  The new URL template to use.
Returns void
Inherited from UrlImageSource.setUrlTemplate
- Defined in sources/UrlImageSource.ts:128

update

update(extent?: Extent): void
Raises an event to reload the source.
Parameters
- Optionalextent: Extent
Returns void
Inherited from UrlImageSource.update
- Defined in sources/ImageSource.ts:253

Class WmsSource

Hierarchy (View Summary)

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Parameters

Returns WmsSource

Properties

ReadonlycontainsFn

datatype

ReadonlyflipY

ReadonlyisImageSource

ReadonlyisMemoryUsage

ReadonlyisUrlImageSource

ReadonlyisWmsSource

Readonlypriority

Readonlysynchronous

Readonlytransparent

Readonlytype

Accessors

colorSpace

Returns ColorSpace

Methods

adjustExtentAndPixelSize

Parameters

Returns GridExtent | null

contains

Parameters

Returns boolean

dispose

Returns void

getCrs

Returns CoordinateSystem

getExtent

Returns Extent | null

getImages

Parameters

Returns ImageResponse[]

getMemoryUsage

Parameters

Returns void

initialize

Parameters

Returns Promise<void>

intersects

Parameters

Returns boolean

setTime

Parameters

Returns void

setUrlTemplate

Parameters

Returns void

update

Parameters

Returns void

Settings

On This Page

`Readonly`containsFn

`Readonly`flipY

`Readonly`isImageSource

`Readonly`isMemoryUsage

`Readonly`isUrlImageSource

`Readonly`isWmsSource

`Readonly`priority

`Readonly`synchronous

`Readonly`transparent

`Readonly`type