Class: WMS

• new WMS(options)

• new WMS(options?)

Creates WMS source

Image.constructor

▸ abortGeometryQueries(): WMS

Aborts all the geometry data queried

WMS

this

▸ clear(): WMS

Notifies source to remove all data added.

WMS

this

Image.clear

▸ dispose(): void

Disposes this source, once disposed it should not be used anymore.

void

Image.dispose

▸ getClassName(): string

string

Image.getClassName

▸ getCopyright(): string

Returns copyright information.

string

Image.getCopyright

▸ Protected getDataLoader(): AbstractLoader

Returns server data loader (if exists)

AbstractLoader

Image.getDataLoader

▸ getFeatureInfo(geometry, layer): AbstractFeature[]

Queries data by the geometry provided.

AbstractFeature[]

▸ getImageFormat(): Image

Returns the image format currently used

Image

▸ getInflateRatio(): number

Returns current inflate ratio

number

Image.getInflateRatio

▸ getInitialCoordinateSystem(): AbstractSystem

Gets current data initial coordinate system.

AbstractSystem

Image.getInitialCoordinateSystem

▸ getLayers(): LayerServerData[]

Returns layers JSON data loaded from the server Should be used asynchronically after loadServerData() method is called

LayerServerData[]

Image.getLayers

▸ getMapCoordinateSystem(): AbstractSystem

Gets current map coordinate system.

AbstractSystem

Image.getMapCoordinateSystem

▸ getModelLimits(): Rect

Returns the current data model limits (presumably loaded from the server if it's settled)

Rect

Image.getModelLimits

▸ getProperties(): OptionsOut

Returns properties

OptionsOut

properties

Image.getProperties

▸ getServerData(): JSONObject | XMLDocument

Returns server data loaded from the server Should be used asynchronically after loadServerData() method is called

JSONObject | XMLDocument

Image.getServerData

▸ getServerURL(): string | string[]

Gets the server url that is currently used for requests

string | string[]

server url

Image.getServerURL

▸ getSourceTimeout(): number

Returns timeout

number

Image.getSourceTimeout

▸ getTransformerFromMap(): Transformer

Gets transformer to transform data from map coordinate system

Transformer

Image.getTransformerFromMap

▸ getTransformerToMap(): Transformer

Gets transformer to transform data to map coordinate system

Transformer

Image.getTransformerToMap

▸ getTransparent(): boolean

Returns the image current transparency

boolean

▸ getVersion(): string

Returns WMS version currently used

string

▸ getVisibleLayers(): (string | number)[]

Returns the server layer ids that are requested.

(string | number)[]

layers

Image.getVisibleLayers

▸ hasEventListener(type, callback?): boolean

Check if a list of event listeners for this type contains this listener

boolean

Image.hasEventListener

▸ hideLayers(id?): WMS

Adds the passed in ID's to the list of layers to hide

WMS

this

Image.hideLayers

▸ Protected initLoader(loader?): WMS

Initializes the loader provided

WMS

this

Image.initLoader

▸ isDataLoaded(): boolean

Returns true if server data is already loaded (or no loader provided)

boolean

Image.isDataLoaded

▸ isDataReady(): boolean

Checks if source (current visible) data is loaded and ready to be rendered

boolean

Image.isDataReady

▸ isDisposed(): boolean

Returns whether this object has been disposed

boolean

Image.isDisposed

▸ isLoading(): boolean

Checks if some of the requests haven't been finished yet. Returns true if some data is loading, false otherwise.

boolean

Image.isLoading

▸ isSilent(): boolean

Return true if the event dispatcher doesn't notify any events

boolean

Image.isSilent

▸ loadServerData(): Promise<WMS>

Returns promise that is loaded when server settings are ready to process

Promise<WMS>

Image.loadServerData

▸ loadSourceData(): Promise<AbstractSource>

Returns promise that is resolving when data are ready to process

Promise<AbstractSource>

Image.loadSourceData

▸ notify<E>(type, source, args?): WMS

Notify listeners

WMS

this

Image.notify

▸ off<E>(type?, callback?): WMS

Detach listener on event. Calling .off() with no arguments removes all attached listeners. Calling .off(type) with no callback removes all attached listeners for specific type.

WMS

this

Image.off

▸ on<E>(type, callback): WMS

Attach listener on event that will be called whenever the specified event is delivered to the target

If the callback function is already in the list of event listeners for this target, the function is not added a second time.

If a particular anonymous function is in the list of event listeners registered for a certain target, and then later in the code, an identical anonymous function is given in an "on" call, the second function will also be added to the list of event listeners for that target.

WMS

this

Image.on

▸ Protected resetLastQueryParams(): WMS

Resets saved last queried limits and layer

WMS

this

Image.resetLastQueryParams

▸ Protected setDataReady(isReady, err?): WMS

Sets source (current visible) data ready/not ready, changes the corresponding promise

WMS

this

Image.setDataReady

▸ setImageFormat(format): WMS

Sets the image format to be used

WMS

this

▸ setInflateRatio(ratio): WMS

Sets image inflate ratio to use

WMS

this

Image.setInflateRatio

▸ setInitialCoordinateSystem(system): WMS

Sets the data initial coordinate system.

WMS

this

Image.setInitialCoordinateSystem

▸ setMapCoordinateSystem(system): WMS

Sets map coordinate system.

WMS

this

Image.setMapCoordinateSystem

▸ setProperties(properties?): WMS

Sets properties

WMS

this

Image.setProperties

▸ setQueryParameter(param, value?): WMS

Sets custom query parameter to add to the data requests

WMS

this

Image.setQueryParameter

▸ setServerURL(url): WMS

Sets the server url to use for requesting

WMS

this

Image.setServerURL

▸ setSilent(bool): WMS

Set silent mode

WMS

this

Image.setSilent

▸ setSourceTimeout(timeout): WMS

Sets timeout

WMS

this

Image.setSourceTimeout

▸ setTooltipLayers(layers): WMS

Sets layers to show as the tooltip info (in .getFeatureInfo method)

WMS

this

▸ setTransparent(transparent): WMS

Sets the image transparency

WMS

this

▸ setVersion(version): WMS

Sets WMS version to use

WMS

this

▸ showLayers(layers): WMS

Sets the server layer name(s) to be shown on the layer

WMS

this

Image.showLayers

▸ update(): WMS

Aborts all the sent requests, resends the last one

WMS

this

Image.update

▸ Static getClassName(): string

string

Image.getClassName