Class: AbstractLayer

• new AbstractLayer(options)

• Protected new AbstractLayer(options?)

Creates layer

Node.constructor

▸ addCssClass(cssclass): AbstractLayer

Adds new css class to node

AbstractLayer

this

Node.addCssClass

▸ addInvalidateHandler(handler): AbstractLayer

Add invalidate handler

Deprecated

since 4.0, use Node.on instead

AbstractLayer

this

Node.addInvalidateHandler

▸ Protected calculateDefaultModelLimits(data?): Rect

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

Rect

▸ 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

Node.checkCollision

▸ clearCache(): AbstractLayer

Clear cache

AbstractLayer

this

▸ clone(): Node

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

Node

clone

Node.clone

▸ connectStyle(style, type, callback): AbstractLayer

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

AbstractLayer

this

Node.connectStyle

▸ Protected copyConstructor(src, deepCopy?): AbstractLayer

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

AbstractLayer

this

Node.copyConstructor

▸ disconnectStyle(style, type, callback): AbstractLayer

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

AbstractLayer

this

Node.disconnectStyle

▸ dispose(): void

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

void

Node.dispose

▸ enableEventPropagation(enable): AbstractLayer

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

AbstractLayer

this

Node.enableEventPropagation

▸ execute(delegate): AbstractLayer

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

AbstractLayer

The result if any or this

Node.execute

▸ execute<T>(delegate): T

T

Node.execute

▸ getCache(): Cache

Return cache strategy to be used to cache children nodes

Cache

cache cache strategy

▸ getClassName(): string

string

Node.getClassName

▸ getCoordinateSystem(): AbstractSystem

Return coordinate system for this layer

AbstractSystem

▸ getCssClass(): string

Returns css class name to be used to apply CSS style

string

the css class name

Node.getCssClass

▸ getCssClasses(): string[]

Gets list of css class names which applied to this node

string[]

Node.getCssClasses

▸ getDataSource(): AbstractSource

Returns current data source

AbstractSource

source

▸ getDefaultModelLimits(): Rect

Gets calculated model limits

Rect

limits calculated model limits

▸ getId(): string | number

Returns the associated identifier of the node

string | number

The node's id

Node.getId

▸ 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

▸ getMapCoordinateSystem(): AbstractSystem

Return a map coordinate system

AbstractSystem

▸ getModelLimits(): Rect

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

Rect

limits user defined or calculated model limits

▸ getName(): string

Returns the node name

string

The node name

Node.getName

▸ getOptions(): Options

Gets options

Options

options options

▸ getParent(): Node

Return parent node

Node

parent node

Node.getParent

▸ getProperties(): OptionsOut

Gets all the properties pertaining to this object

OptionsOut

options

Node.getProperties

▸ getProperty(name): any

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

any

Node.getProperty

▸ getPropertyKeys(): string[]

Returns known properties keys

string[]

Node.getPropertyKeys

▸ getRoot(): Node

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

Node

the root node

Node.getRoot

▸ getSceneTransform(): Transformation

Returns transformation from node to root scene

Transformation

a transformation from node to root scene

Node.getSceneTransform

▸ getServerURL(): string | string[]

Gets the server url from the layer source

string | string[]

▸ getTag(): any

Returns the object associated with the node by user.

any

The node's user-object

Node.getTag

▸ getTooltipFormatter(): Formatter

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

Formatter

▸ getVisible(): boolean

Return visibility of the node

boolean

true if node is visible

Node.getVisible

▸ getVisibleModelLimits(ignoreModelLimits?): Rect

Return visible model limits

Rect

▸ getWorldTransform(): Transformation

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

Transformation

the world transform.

Node.getWorldTransform

▸ getZIndex(): number

Returns node z-index (null if not set)

number

Node.getZIndex

▸ hasCssClass(cssClass): boolean

Check if node has specified css class

boolean

Node.hasCssClass

▸ hasEventListener(type, callback?): boolean

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

boolean

Node.hasEventListener

▸ 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

▸ invalidate(bounds?, force?): AbstractLayer

Invalidate layer

AbstractLayer

this

Node.invalidate

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

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

Fires

Events.Invalidate

AbstractLayer

this

Node.invalidateParent

▸ isDisposed(): boolean

Returns whether this object has been disposed

boolean

Node.isDisposed

▸ isEventPropagationEnabled(): boolean

Return true if event propagation is enabled from child to parent

boolean

Node.isEventPropagationEnabled

▸ isLoading(): boolean

Checks if layer data is still loading and not ready

boolean

▸ isNotificationEnabled(): boolean

return state of notification

boolean

current notification state

Node.isNotificationEnabled

▸ isSelectable(): boolean

Returns true if node can be picked/selected.

boolean

The selectable flag

Node.isSelectable

▸ isSilent(): boolean

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

boolean

Node.isSilent

▸ load(): Promise<AbstractLayer>

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

Promise<AbstractLayer>

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

Notify listeners of the Node

AbstractLayer

this

Node.notify

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

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.

AbstractLayer

this

Node.off

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

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.

AbstractLayer

this

Node.on

▸ Protected onParentChanged(node): AbstractLayer

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

AbstractLayer

this

Node.onParentChanged

▸ Protected onVisibilityChanged(): void

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

void

Node.onVisibilityChanged

▸ removeCssClass(cssclass): AbstractLayer

Removes css class from node

AbstractLayer

this

Node.removeCssClass

▸ removeInvalidateHandler(handler): AbstractLayer

Remove invalidate handler

Deprecated

since 4.0, use Node.off instead

AbstractLayer

this

Node.removeInvalidateHandler

▸ render(context): void

Renders node

void

Node.render

▸ renderAsync(context, callback): void

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

void

Node.renderAsync

▸ Abstract renderContent(context): void

Renders layer content

void

▸ renderContentAsync(context, callback): void

Renders async layer content

void

▸ setCache(cache): AbstractLayer

Sets cache to be used to cache

AbstractLayer

this

▸ setCssClass(name): AbstractLayer

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

AbstractLayer

this

Node.setCssClass

▸ setId(id): AbstractLayer

Allows the user to associate any identifier

AbstractLayer

this

Node.setId

▸ setLayerAlpha(alpha): AbstractLayer

Set the alpha of the layer

AbstractLayer

this

▸ setMapCoordinateSystem(system?): AbstractLayer

Sets a map coordinate system

AbstractLayer

▸ setModelLimits(limits): AbstractLayer

Sets model limits

AbstractLayer

this

▸ setName(name): AbstractLayer

Sets name of the node

AbstractLayer

this

Node.setName

▸ setNotification(notify, force?): AbstractLayer

set notification state

AbstractLayer

this

Node.setNotification

▸ setOptions(options?): AbstractLayer

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

AbstractLayer

▸ setProperties(properties?): AbstractLayer

Sets all the properties pertaining to this object

AbstractLayer

this

Node.setProperties

▸ setProperty(name, value): AbstractLayer

Sets dynamic property by name

AbstractLayer

this

Node.setProperty

▸ setSelectable(selectable): AbstractLayer

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

AbstractLayer

this

Node.setSelectable

▸ setServerURL(url): AbstractLayer

Sets the url to the layer source

AbstractLayer

▸ setSilent(bool): AbstractLayer

Set silent mode

AbstractLayer

this

Node.setSilent

▸ setTag(tag): AbstractLayer

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

AbstractLayer

this

Node.setTag

▸ setVisible(value): AbstractLayer

Sets visibility of the node. Send event Events.VisibilityChanged

AbstractLayer

this

Node.setVisible

▸ setZIndex(value): AbstractLayer

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

AbstractLayer

this

Node.setZIndex

▸ toString(): string

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

string

A string representation

Node.toString

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

Transform a point from map coordinate system to layer coordinate system

Point

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

Transform point

Point

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

Transform a point from layer coordinate system to map coordinate system

Point

▸ updateSceneTransformation(): AbstractLayer

Update scene transformation

AbstractLayer

this

Node.updateSceneTransformation

▸ updateState(regions?, changes?): AbstractLayer

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

AbstractLayer

this

Node.updateState

▸ Protected updateTimeStamp(): AbstractLayer

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

AbstractLayer

this

Node.updateTimeStamp

▸ Static enableSceneGraphNotification(enabled): void

Enable / disable all notifications

void

Node.enableSceneGraphNotification

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

Find root of the node with specified type

InstanceType<T>

Node.findParent

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

Find root of the node with specified type

Node

Node.findParent

▸ Static getClassName(): string

string

Node.getClassName

▸ Static isSceneGraphNotificationEnabled(): boolean

Return status of the global notification for all nodes.

boolean

Node.isSceneGraphNotificationEnabled