Class: HTMLOverlayLayer

• new HTMLOverlayLayer(options)

• new HTMLOverlayLayer(options?)

Node.constructor

▸ addCssClass(cssclass): HTMLOverlayLayer

Adds new css class to node

HTMLOverlayLayer

this

Node.addCssClass

▸ addInvalidateHandler(handler): HTMLOverlayLayer

Add invalidate handler

Deprecated

since 4.0, use Node.on instead

HTMLOverlayLayer

this

Node.addInvalidateHandler

▸ addOverlays(overlays): HTMLOverlayLayer

Add overlay(s) to HTMLOverlayLayer

HTMLOverlayLayer

this

▸ 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

▸ clone(): Node

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

Node

clone

Node.clone

▸ connectStyle(style, type, callback): HTMLOverlayLayer

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

HTMLOverlayLayer

this

Node.connectStyle

▸ Protected copyConstructor(src, deepCopy?): HTMLOverlayLayer

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

HTMLOverlayLayer

this

Node.copyConstructor

▸ disconnectStyle(style, type, callback): HTMLOverlayLayer

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

HTMLOverlayLayer

this

Node.disconnectStyle

▸ dispose(): void

Disposes this node, once disposes a node should not be used anymore.
Clear all listeners, and disconnect styles to avoid memory leaks.
Also aggressively 'cleanup' this node by setting some of its members to null.

void

Node.dispose

▸ enableEventPropagation(enable): HTMLOverlayLayer

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

HTMLOverlayLayer

this

Node.enableEventPropagation

▸ execute(delegate): HTMLOverlayLayer

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

HTMLOverlayLayer

The result if any or this

Node.execute

▸ execute<T>(delegate): T

T

Node.execute

▸ findOverlay(method): HTMLOverlay

Find a first HtmlOverlay satisfied the provided testing function

HTMLOverlay

HTMLOverlay

▸ getClassName(): string

string

Node.getClassName

▸ 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

▸ getId(): string | number

Returns the associated identifier of the node

string | number

The node's id

Node.getId

▸ getName(): string

Returns the node name

string

The node name

Node.getName

▸ getOverlay(index): HTMLOverlay

Get an HtmlOverlay by index

HTMLOverlay

HTMLOverlay

▸ getOverlaysCount(): number

Get number of overlays

number

Number of overlays

▸ getParent(): Node

Return parent node

Node

parent node

Node.getParent

▸ getProperties(context?): Options

Gets all the properties pertaining to this object

Options

An object containing the properties to set

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

▸ getTag(): any

Returns the object associated with the node by user.

any

The node's user-object

Node.getTag

▸ getVisible(): boolean

Return visibility of the node

boolean

true if node is visible

Node.getVisible

▸ 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

▸ indexOfOverlay(overlay): number

Return index of overlay (index of the specified overlay or -1 if overlay is not found)

number

index Index of overlay

▸ insertOverlays(index, overlays): HTMLOverlayLayer

Insert overlay(s) to HTMLOverlayLayer

HTMLOverlayLayer

this

▸ invalidate(bounds?, force?): HTMLOverlayLayer

Invalidate area of the shape. This method invalidates parent by default. invalidated from parent to root node.

HTMLOverlayLayer

this

Node.invalidate

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

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

Fires

Events.Invalidate

HTMLOverlayLayer

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

▸ 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

▸ notify<E>(event, source, args?): HTMLOverlayLayer

Notify listeners of the Node

HTMLOverlayLayer

this

Node.notify

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

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.

HTMLOverlayLayer

this

Node.off

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

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.

HTMLOverlayLayer

this

Node.on

▸ Protected onParentChanged(node): HTMLOverlayLayer

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

HTMLOverlayLayer

this

Node.onParentChanged

▸ Protected onVisibilityChanged(): void

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

void

Node.onVisibilityChanged

▸ removeCssClass(cssclass): HTMLOverlayLayer

Removes css class from node

HTMLOverlayLayer

this

Node.removeCssClass

▸ removeInvalidateHandler(handler): HTMLOverlayLayer

Remove invalidate handler

Deprecated

since 4.0, use Node.off instead

HTMLOverlayLayer

this

Node.removeInvalidateHandler

▸ removeOverlays(overlays?): HTMLOverlayLayer

Remove overlay(s) in HTMLOverlayLayer

HTMLOverlayLayer

this

▸ 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

▸ setCssClass(name): HTMLOverlayLayer

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

HTMLOverlayLayer

this

Node.setCssClass

▸ setId(id): HTMLOverlayLayer

Allows the user to associate any identifier

HTMLOverlayLayer

this

Node.setId

▸ setName(name): HTMLOverlayLayer

Sets name of the node

HTMLOverlayLayer

this

Node.setName

▸ setNotification(notify, force?): HTMLOverlayLayer

set notification state

HTMLOverlayLayer

this

Node.setNotification

▸ setProperties(properties?, context?): HTMLOverlayLayer

Sets all the properties pertaining to this object

HTMLOverlayLayer

this

Node.setProperties

▸ setProperty(name, value): HTMLOverlayLayer

Sets dynamic property by name

HTMLOverlayLayer

this

Node.setProperty

▸ setSelectable(selectable): HTMLOverlayLayer

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

HTMLOverlayLayer

this

Node.setSelectable

▸ setSilent(bool): HTMLOverlayLayer

Set silent mode

HTMLOverlayLayer

this

Node.setSilent

▸ setTag(tag): HTMLOverlayLayer

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

HTMLOverlayLayer

this

Node.setTag

▸ setVisible(value): HTMLOverlayLayer

Sets visibility of the node. Send event Events.VisibilityChanged

HTMLOverlayLayer

this

Node.setVisible

▸ setZIndex(value): HTMLOverlayLayer

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

HTMLOverlayLayer

this

Node.setZIndex

▸ toString(): string

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

string

A string representation

Node.toString

▸ updateSceneTransformation(): HTMLOverlayLayer

Update scene transformation

HTMLOverlayLayer

this

Node.updateSceneTransformation

▸ updateState(regions?, changes?): HTMLOverlayLayer

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

HTMLOverlayLayer

this

Node.updateState

▸ Protected updateTimeStamp(): HTMLOverlayLayer

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

HTMLOverlayLayer

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