Class: WMS

• new WMS(options)

• new WMS(options?)

Creates WMS layer

Image.constructor

▸ addCssClass(cssclass): WMS

Adds new css class to node

WMS

this

Image.addCssClass

▸ addInvalidateHandler(handler): WMS

Add invalidate handler

Deprecated

since 4.0, use Node.on instead

WMS

this

Image.addInvalidateHandler

▸ Protected calculateDefaultModelLimits(data?): Rect

Returns default model limits (based on the map coordinate system)

Rect

Image.calculateDefaultModelLimits

▸ checkCollision(context): boolean

Check if this node is within the area being rendered by the context

boolean

true if object is inside of renderable area

Image.checkCollision

▸ clearCache(): WMS

Clear cache

WMS

this

Image.clearCache

▸ clone(): Node

All subclasses should override copyConstructor or provide custom implementation for this method

Node

clone

Image.clone

▸ connectStyle(style, type, callback): WMS

Connects style.

This convenience method subscribes a listener to given style for the specified type.
And automatically un-subscribes listener if node is disposed to prevent memory leaks

WMS

this

Image.connectStyle

▸ Protected copyConstructor(src, deepCopy?): WMS

Copy constructor function.
Function used as part of the cloning mechanism.
Implementations should copy the given instance state to this instance.

WMS

this

Image.copyConstructor

▸ disconnectStyle(style, type, callback): WMS

Disconnect style
This convenience method un-subscribes a listener to given style for the specified type.

WMS

this

Image.disconnectStyle

▸ dispose(): void

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

void

Image.dispose

▸ enableEventPropagation(enable): WMS

Enable event propagation from the node hierarchy from bottom to top

This option is similar to DOM Event bubbling, which allows to get any event from child node. By default it is disabled for better performance.

Example

import {Group} from '@int/geotoolkit/scene/Group';
import {Events as SceneEvents} from '@int/geotoolkit/scene/Node';
const parentGroup = new Group()
.setName('ParentGroup')
.enableEventPropagation(true);
const childGroup = new Group()
.setName('ChildGroup');

parentGroup.addChild(childGroup);
parentGroup.on(SceneEvents.Invalidate, (eventName, sender, args) => {
// Got notifications from all children of parent group
});
childGroup.invalidate();

WMS

this

Image.enableEventPropagation

▸ execute(delegate): WMS

Executes delegate and return the result. It allows us to keep all initialization calls in one place,
and we do not need to scroll up or down in IDE to find how and where it was initialized.

Example

// All setters (.setName() for example) returns reference to the this.
// In order to modify inner object like LineStyle or Pattern, to get this object (property) we should call getter to get object reference.
// Then modify it as shown below in Option 1 or you can use execute methods shown in Option 2.
import {Group} from '@int/geotoolkit/scene/Group';
import {Rect} from '@int/geotoolkit/util/Rect';
// Option 1
const group = new Group()
.setName('MyGroup')
.setBounds(new Rect(0, 0, 42, 16))
.enableClipping(true)
.setTag({'type': 'sometype'});

group.getLineStyle().setPattern('pattern');
return group;

// Options 2 ( using execute method )
return group
.execute(function () {
this.getLineStyle()
.setPattern("pattern");
});

WMS

The result if any or this

Image.execute

▸ execute<T>(delegate): T

T

Image.execute

▸ getCache(): Cache

Return cache strategy to be used to cache children nodes

Cache

cache cache strategy

Image.getCache

▸ getClassName(): string

string

Image.getClassName

▸ getCoordinateSystem(): AbstractSystem

Return coordinate system for this layer

AbstractSystem

Image.getCoordinateSystem

▸ getCssClass(): string

Returns css class name to be used to apply CSS style

string

the css class name

Image.getCssClass

▸ getCssClasses(): string[]

Gets list of css class names which applied to this node

string[]

Image.getCssClasses

▸ getDataSource(): AbstractSource

Returns current data source

AbstractSource

source

Image.getDataSource

▸ getDefaultModelLimits(): Rect

Gets calculated model limits

Rect

limits calculated model limits

Image.getDefaultModelLimits

▸ getId(): string | number

Returns the associated identifier of the node

string | number

The node's id

Image.getId

▸ getImageFormat(): Image

Returns the image format used by the layer

Image

format image format that is used

▸ getLayerAlpha(): number

Return a the alpha of the layer between 0.0 (fully transparent) and 1.0 (fully opaque). The default value is 1.0.

number

alpha alpha

Image.getLayerAlpha

▸ getLayers(): LayerServerData[]

Gets the JSON data of the available layers for the server

LayerServerData[]

Image.getLayers

▸ getMapCoordinateSystem(): AbstractSystem

Return a map coordinate system

AbstractSystem

Image.getMapCoordinateSystem

▸ getModelLimits(): Rect

Gets user defined model limits if set; calculated model limits otherwise

Rect

limits user defined or calculated model limits

Image.getModelLimits

▸ getName(): string

Returns the node name

string

The node name

Image.getName

▸ getOptions(): Options

Gets options

Options

options options

Image.getOptions

▸ getParent(): Node

Return parent node

Node

parent node

Image.getParent

▸ getProperties(): OptionsOut

Gets all the properties pertaining to this object

OptionsOut

object containing the properties

Image.getProperties

▸ getProperty(name): any

Gets dynamic property by name. These properties can be used as a property bags

any

Image.getProperty

▸ getPropertyKeys(): string[]

Returns known properties keys

string[]

Image.getPropertyKeys

▸ getRoot(): Node

Returns root node.
If node doesn't have parent then it returns itself.

Node

the root node

Image.getRoot

▸ getSceneTransform(): Transformation

Returns transformation from node to root scene

Transformation

a transformation from node to root scene

Image.getSceneTransform

▸ getServerURL(): string | string[]

Gets the server url from the layer source

string | string[]

Image.getServerURL

▸ getTag(): any

Returns the object associated with the node by user.

any

The node's user-object

Image.getTag

▸ getTooltipFormatter(): Formatter

Returns the format function to use for the tooltip info (null if tooltips are not visible)

Formatter

Image.getTooltipFormatter

▸ getTransparent(): boolean

Returns the transparency of the layer

boolean

bool true if layer is transparent

▸ getVersion(): string

Returns WMS version currently used

string

▸ getVisible(): boolean

Return visibility of the node

boolean

true if node is visible

Image.getVisible

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

Returns the server layer names that are requested.

(string | number)[]

layers

Image.getVisibleLayers

▸ getVisibleModelLimits(ignoreModelLimits?): Rect

Return visible model limits

Rect

Image.getVisibleModelLimits

▸ getWorldTransform(): Transformation

getWorldTransform retrieves the local transformation of the inner node coordinates to parent coordinates.

Transformation

the world transform.

Image.getWorldTransform

▸ getZIndex(): number

Returns node z-index (null if not set)

number

Image.getZIndex

▸ hasCssClass(cssClass): boolean

Check if node has specified css class

boolean

Image.hasCssClass

▸ 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

Image.hideLayers

▸ hitTest(pt, radius?): AbstractFeature[]

Performs selection of the data with its device coordinates. Returns null, if no data available but will be loaded asynchronously later (fires Events.InfoUpdated).

AbstractFeature[]

data data selected

Image.hitTest

▸ invalidate(bounds?, force?): WMS

Invalidate layer

WMS

this

Image.invalidate

▸ Protected invalidateParent(bounds?, force?): WMS

Invalidate parent and notify all listeners. NOTE: Don't keep arguments of the event, because instance can be changed

Fires

Events.Invalidate

WMS

this

Image.invalidateParent

▸ isDisposed(): boolean

Returns whether this object has been disposed

boolean

Image.isDisposed

▸ isEventPropagationEnabled(): boolean

Return true if event propagation is enabled from child to parent

boolean

Image.isEventPropagationEnabled

▸ isLoading(): boolean

Checks if layer data is still loading and not ready

boolean

Image.isLoading

▸ isNotificationEnabled(): boolean

return state of notification

boolean

current notification state

Image.isNotificationEnabled

▸ isSelectable(): boolean

Returns true if node can be picked/selected.

boolean

The selectable flag

Image.isSelectable

▸ isSilent(): boolean

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

boolean

Image.isSilent

▸ load(): Promise<WMS>

Returns promise that is resolved when all layer data is loaded and ready to be rendered

Promise<WMS>

Image.load

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

Notify listeners of the Node

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 onParentChanged(node): WMS

This method is called when parent changes. Do not call it directly.

WMS

this

Image.onParentChanged

▸ Protected onVisibilityChanged(): void

This method is called if visibility is changed. Send event Events.VisibilityChanged

void

Image.onVisibilityChanged

▸ removeCssClass(cssclass): WMS

Removes css class from node

WMS

this

Image.removeCssClass

▸ removeInvalidateHandler(handler): WMS

Remove invalidate handler

Deprecated

since 4.0, use Node.off instead

WMS

this

Image.removeInvalidateHandler

▸ render(context): void

Renders node

void

Image.render

▸ renderAsync(context, callback): void

Render node in asynchronous mode. Default implementation creates call method "render" inside

void

Image.renderAsync

▸ renderContent(context): void

Renders layer content

void

Image.renderContent

▸ renderContentAsync(context, callback): void

Renders async layer content

void

Image.renderContentAsync

▸ setCache(cache): WMS

Sets cache to be used to cache

WMS

this

Image.setCache

▸ setCssClass(name): WMS

Sets css class name of the node to be used to apply CSS style

WMS

this

Image.setCssClass

▸ setId(id): WMS

Allows the user to associate any identifier

WMS

this

Image.setId

▸ setImageFormat(format): WMS

Sets the image format to use by the layer

WMS

this

▸ setLayerAlpha(alpha): WMS

Set the alpha of the layer

WMS

this

Image.setLayerAlpha

▸ setMapCoordinateSystem(system?): WMS

Sets a map coordinate system

WMS

Image.setMapCoordinateSystem

▸ setModelLimits(limits): WMS

Sets model limits

WMS

this

Image.setModelLimits

▸ setName(name): WMS

Sets name of the node

WMS

this

Image.setName

▸ setNotification(notify, force?): WMS

set notification state

WMS

this

Image.setNotification

▸ setOptions(options?): WMS

Sets options (default options listed are for construction time only)

WMS

Image.setOptions

▸ setProperties(properties?): WMS

Sets all the properties pertaining to this object

WMS

this

Image.setProperties

▸ setProperty(name, value): WMS

Sets dynamic property by name

WMS

this

Image.setProperty

▸ setSelectable(selectable): WMS

Allows to select node. If node is not selectable then child node is not selectable.

WMS

this

Image.setSelectable

▸ setServerURL(url): WMS

Sets the url to the layer source

WMS

Image.setServerURL

▸ setSilent(bool): WMS

Set silent mode

WMS

this

Image.setSilent

▸ setTag(tag): WMS

Allows the user to associate any arbitrary object with the node.

WMS

this

Image.setTag

▸ setTransparent(bool): WMS

Sets the transparency of the layer

WMS

this

▸ setVersion(version): WMS

Sets WMS version to use

WMS

this

▸ setVisible(value): WMS

Sets visibility of the node. Send event Events.VisibilityChanged

WMS

this

Image.setVisible

▸ setZIndex(value): WMS

Sets z-index for node (set null for default)

WMS

this

Image.setZIndex

▸ showLayers(id): WMS

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

WMS

Image.showLayers

▸ toString(): string

Returns a string representation of this object (generally the classname)

string

A string representation

Image.toString

▸ transformFromMap(point, dst?, clamp?): Point

Transform a point from map coordinate system to layer coordinate system

Point

Image.transformFromMap

▸ transformPoint(point, from, to, dst?, clamp?): Point

Transform point

Point

Image.transformPoint

▸ transformToMap(point, dst?, clamp?): Point

Transform a point from layer coordinate system to map coordinate system

Point

Image.transformToMap

▸ updateSceneTransformation(): WMS

Update scene transformation

WMS

this

Image.updateSceneTransformation

▸ updateState(regions?, changes?): WMS

Update state. These methods reset node state and update state for children. this method is useful to refresh a scene graph

WMS

this

Image.updateState

▸ Protected updateTimeStamp(): WMS

Update time stamp to indicate that Node or Children has been changed.

WMS

this

Image.updateTimeStamp

▸ Static enableSceneGraphNotification(enabled): void

Enable / disable all notifications

void

Image.enableSceneGraphNotification

▸ Static findParent<T>(node, classType, filter?): InstanceType<T>

Find root of the node with specified type

InstanceType<T>

Image.findParent

▸ Static findParent(node, classType, filter?): Node

Find root of the node with specified type

Node

Image.findParent

▸ Static getClassName(): string

string

Image.getClassName

▸ Static isSceneGraphNotificationEnabled(): boolean

Return status of the global notification for all nodes.

boolean

Image.isSceneGraphNotificationEnabled