Class: WMSTile

• new WMSTile(options)

• new WMSTile(options?)

Tile.constructor

▸ addCssClass(cssclass): WMSTile

Adds new css class to node

WMSTile

this

Tile.addCssClass

▸ addInvalidateHandler(handler): WMSTile

Add invalidate handler

Deprecated

since 4.0, use Node.on instead

WMSTile

this

Tile.addInvalidateHandler

▸ Protected calculateDefaultModelLimits(data?): Rect

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

Rect

Tile.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

Tile.checkCollision

▸ clearCache(): WMSTile

Clear cache

WMSTile

this

Tile.clearCache

▸ clone(): Node

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

Node

clone

Tile.clone

▸ connectStyle(style, type, callback): WMSTile

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

WMSTile

this

Tile.connectStyle

▸ Protected copyConstructor(src, deepCopy?): WMSTile

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

WMSTile

this

Tile.copyConstructor

▸ disconnectStyle(style, type, callback): WMSTile

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

WMSTile

this

Tile.disconnectStyle

▸ dispose(): void

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

void

Tile.dispose

▸ enableEventPropagation(enable): WMSTile

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();

WMSTile

this

Tile.enableEventPropagation

▸ execute(delegate): WMSTile

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");
});

WMSTile

The result if any or this

Tile.execute

▸ execute<T>(delegate): T

T

Tile.execute

▸ getCache(): Cache

Return cache strategy to be used to cache children nodes

Cache

cache cache strategy

Tile.getCache

▸ getClassName(): string

string

Tile.getClassName

▸ getCoordinateSystem(): AbstractSystem

Return coordinate system for this layer

AbstractSystem

Tile.getCoordinateSystem

▸ getCssClass(): string

Returns css class name to be used to apply CSS style

string

the css class name

Tile.getCssClass

▸ getCssClasses(): string[]

Gets list of css class names which applied to this node

string[]

Tile.getCssClasses

▸ getDataSource(): AbstractSource

Returns current data source

AbstractSource

source

Tile.getDataSource

▸ getDefaultModelLimits(): Rect

Gets calculated model limits

Rect

limits calculated model limits

Tile.getDefaultModelLimits

▸ getId(): string | number

Returns the associated identifier of the node

string | number

The node's id

Tile.getId

▸ getImageFormat(): string

Returns the image format used by the layer

string

format image format that is used

▸ getImageFormatter(): FormatterCallback

Gets the current formatter function if the function format is used

FormatterCallback

Tile.getImageFormatter

▸ 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

Tile.getLayerAlpha

▸ getLayers(): LayerServerData[]

Gets the JSON data of the available layers for the server

LayerServerData[]

▸ getMapCoordinateSystem(): AbstractSystem

Return a map coordinate system

AbstractSystem

Tile.getMapCoordinateSystem

▸ getMaxLod(): number

Gets the maximum Lod for the server

number

Tile.getMaxLod

▸ getMinLod(): number

Gets the minimum Lod for the server

number

Tile.getMinLod

▸ getModelLimits(): Rect

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

Rect

limits user defined or calculated model limits

Tile.getModelLimits

▸ getName(): string

Returns the node name

string

The node name

Tile.getName

▸ getOptions(): Options

Gets options

Options

options options

Tile.getOptions

▸ getParent(): Node

Return parent node

Node

parent node

Tile.getParent

▸ getProperties(): OptionsOut

Gets all the properties pertaining to this object

OptionsOut

object containing the properties

Tile.getProperties

▸ getProperty(name): any

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

any

Tile.getProperty

▸ getPropertyKeys(): string[]

Returns known properties keys

string[]

Tile.getPropertyKeys

▸ getRoot(): Node

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

Node

the root node

Tile.getRoot

▸ getSceneTransform(): Transformation

Returns transformation from node to root scene

Transformation

a transformation from node to root scene

Tile.getSceneTransform

▸ getServerURL(): string | string[]

Gets the server url from the layer source

string | string[]

Tile.getServerURL

▸ getTag(): any

Returns the object associated with the node by user.

any

The node's user-object

Tile.getTag

▸ getTileResolution(): Dimension

Returns current tile resolution (in px)

Dimension

Tile.getTileResolution

▸ getTooltipFormatter(): Formatter

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

Formatter

Tile.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

Tile.getVisible

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

Returns the server layer names that are requested.

(string | number)[]

layers

▸ getVisibleModelLimits(ignoreModelLimits?): Rect

Return visible model limits

Rect

Tile.getVisibleModelLimits

▸ getWorldTransform(): Transformation

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

Transformation

the world transform.

Tile.getWorldTransform

▸ getZIndex(): number

Returns node z-index (null if not set)

number

Tile.getZIndex

▸ getZoomLevel(): number

Gets map zoom level

number

Tile.getZoomLevel

▸ hasCssClass(cssClass): boolean

Check if node has specified css class

boolean

Tile.hasCssClass

▸ hasEventListener(type, callback?): boolean

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

boolean

Tile.hasEventListener

▸ hideLayers(id?): WMSTile

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

WMSTile

this

▸ hitTest(pt, radius?): (AbstractNode | 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).

(AbstractNode | AbstractFeature)[]

data data selected

Tile.hitTest

▸ invalidate(bounds?, force?): WMSTile

Invalidate layer

WMSTile

this

Tile.invalidate

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

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

Fires

Events.Invalidate

WMSTile

this

Tile.invalidateParent

▸ isDisposed(): boolean

Returns whether this object has been disposed

boolean

Tile.isDisposed

▸ isEventPropagationEnabled(): boolean

Return true if event propagation is enabled from child to parent

boolean

Tile.isEventPropagationEnabled

▸ isLoading(): boolean

Checks if layer data is still loading and not ready

boolean

Tile.isLoading

▸ isNotificationEnabled(): boolean

return state of notification

boolean

current notification state

Tile.isNotificationEnabled

▸ isSelectable(): boolean

Returns true if node can be picked/selected.

boolean

The selectable flag

Tile.isSelectable

▸ isSilent(): boolean

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

boolean

Tile.isSilent

▸ load(): Promise<WMSTile>

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

Promise<WMSTile>

Tile.load

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

Notify listeners of the Node

WMSTile

this

Tile.notify

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

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.

WMSTile

this

Tile.off

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

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.

WMSTile

this

Tile.on

▸ Protected onParentChanged(node): WMSTile

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

WMSTile

this

Tile.onParentChanged

▸ Protected onVisibilityChanged(): void

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

void

Tile.onVisibilityChanged

▸ removeCssClass(cssclass): WMSTile

Removes css class from node

WMSTile

this

Tile.removeCssClass

▸ removeInvalidateHandler(handler): WMSTile

Remove invalidate handler

Deprecated

since 4.0, use Node.off instead

WMSTile

this

Tile.removeInvalidateHandler

▸ render(context): void

Renders node

void

Tile.render

▸ renderAsync(context, callback): void

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

void

Tile.renderAsync

▸ renderContent(context): void

Renders layer content

void

Tile.renderContent

▸ renderContentAsync(context, callback): void

Renders async layer content

void

Tile.renderContentAsync

▸ setCache(cache): WMSTile

Sets cache to be used to cache

WMSTile

this

Tile.setCache

▸ setCssClass(name): WMSTile

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

WMSTile

this

Tile.setCssClass

▸ setId(id): WMSTile

Allows the user to associate any identifier

WMSTile

this

Tile.setId

▸ setImageFormat(format): WMSTile

Sets the image format to use by the layer

WMSTile

this

▸ setImageFormatter(formatter): WMSTile

Sets image format for the server This converts the z, x, y image indexes into a path that is added to the server param to locate the requested tile.

WMSTile

this

Tile.setImageFormatter

▸ setLayerAlpha(alpha): WMSTile

Set the alpha of the layer

WMSTile

this

Tile.setLayerAlpha

▸ setLods(min, max): WMSTile

Sets the min/max numbers of details for the server

WMSTile

this

Tile.setLods

▸ setMapCoordinateSystem(system?): WMSTile

Sets a map coordinate system

WMSTile

Tile.setMapCoordinateSystem

▸ setModelLimits(limits): WMSTile

Sets model limits

WMSTile

this

Tile.setModelLimits

▸ setName(name): WMSTile

Sets name of the node

WMSTile

this

Tile.setName

▸ setNotification(notify, force?): WMSTile

set notification state

WMSTile

this

Tile.setNotification

▸ setOptions(options?): WMSTile

Sets options

WMSTile

this

Tile.setOptions

▸ setProperties(properties?): WMSTile

Sets all the properties pertaining to this object

WMSTile

this

Tile.setProperties

▸ setProperty(name, value): WMSTile

Sets dynamic property by name

WMSTile

this

Tile.setProperty

▸ setSelectable(selectable): WMSTile

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

WMSTile

this

Tile.setSelectable

▸ setServerURL(url): WMSTile

Sets the url to the layer source

WMSTile

Tile.setServerURL

▸ setSilent(bool): WMSTile

Set silent mode

WMSTile

this

Tile.setSilent

▸ setTag(tag): WMSTile

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

WMSTile

this

Tile.setTag

▸ setTileResolution(width, height): WMSTile

Sets the resolution of the tiles from the server

WMSTile

this

Tile.setTileResolution

▸ setTransparent(transparent): WMSTile

Sets the transparency of the layer

WMSTile

this

▸ setVersion(version): WMSTile

Sets WMS version to use

WMSTile

this

▸ setVisible(value): WMSTile

Sets visibility of the node. Send event Events.VisibilityChanged

WMSTile

this

Tile.setVisible

▸ setZIndex(value): WMSTile

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

WMSTile

this

Tile.setZIndex

▸ showLayers(id): WMSTile

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

WMSTile

this

▸ toString(): string

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

string

A string representation

Tile.toString

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

Transform a point from map coordinate system to layer coordinate system

Point

Tile.transformFromMap

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

Transform point

Point

Tile.transformPoint

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

Transform a point from layer coordinate system to map coordinate system

Point

Tile.transformToMap

▸ updateSceneTransformation(): WMSTile

Update scene transformation

WMSTile

this

Tile.updateSceneTransformation

▸ updateState(regions?, changes?): WMSTile

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

WMSTile

this

Tile.updateState

▸ Protected updateTimeStamp(): WMSTile

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

WMSTile

this

Tile.updateTimeStamp

▸ Static enableSceneGraphNotification(enabled): void

Enable / disable all notifications

void

Tile.enableSceneGraphNotification

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

Find root of the node with specified type

InstanceType<T>

Tile.findParent

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

Find root of the node with specified type

Node

Tile.findParent

▸ Static getClassName(): string

string

Tile.getClassName

▸ Static isSceneGraphNotificationEnabled(): boolean

Return status of the global notification for all nodes.

boolean

Tile.isSceneGraphNotificationEnabled