Class: Layer<T>

• new Layer&lt;T&amp;gt;(options)

• new Layer<T>(options?)

Creates layer

CompositeNode&lt;T&amp;gt;.constructor

▸ addChild(node): Layer<T>

Add a child node

Layer<T>

this

CompositeNode.addChild

▸ addCssClass(cssclass): Layer<T>

Adds new css class to node

Layer<T>

this

CompositeNode.addCssClass

▸ addInvalidateHandler(handler): Layer<T>

Add invalidate handler

Deprecated

since 4.0, use Node.on instead

Layer<T>

this

CompositeNode.addInvalidateHandler

▸ adjustPosition(area?, vAlign?, hAlign?): Layer<T>

Adjust position of node to specified area

Layer<T>

this

CompositeNode.adjustPosition

▸ Protected applyOpacity(context): Layer<T>

This method is called to apply opacity if it is specified on the rendering context. The default implementation sets global alpha on the rendering context

Layer<T>

this

CompositeNode.applyOpacity

▸ Protected applyResponsiveStyle(): void

Apply a responsive style rules it is exists

void

CompositeNode.applyResponsiveStyle

▸ changeChildOrder(node, order, anchor?): Layer<T>

changes the z-order of the nodes being rendered.

Layer<T>

this

CompositeNode.changeChildOrder

▸ checkCollision(context): boolean

Check culling Returns true if object is inside of renderable area

boolean

true if node is collided

CompositeNode.checkCollision

▸ clearChildren(disposeChildren?): Layer<T>

Remove all child nodes from this composite group

Layer<T>

this

CompositeNode.clearChildren

▸ clone(): Layer<Node>

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

Layer<Node>

clone

CompositeNode.clone

▸ connectStyle(style, type, callback): Layer<T>

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

Layer<T>

this

CompositeNode.connectStyle

▸ Protected copyConstructor(src, deepCopy?): Layer<T>

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

Layer<T>

this

CompositeNode.copyConstructor

▸ disconnectStyle(style, type, callback): Layer<T>

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

Layer<T>

this

CompositeNode.disconnectStyle

▸ dispose(): void

Dispose node. Clear all listeners and disconnect style to avoid memory leaks

void

CompositeNode.dispose

▸ enableClipping(doClip): Layer<T>

Enables or disables clipping of this node. If enabled, shapes will not be rendered outside of its bounds.

Layer<T>

this

CompositeNode.enableClipping

▸ enableEventPropagation(enable): Layer<T>

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

Layer<T>

this

CompositeNode.enableEventPropagation

▸ enumerateNodes(callback, target?): void

Executes a provided function once for each child node

void

CompositeNode.enumerateNodes

▸ execute(delegate): Layer<T>

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

Layer<T>

The result if any or this

CompositeNode.execute

▸ execute<T>(delegate): T

T

CompositeNode.execute

▸ Protected filter(context): boolean

Filter node

boolean

flag filter flag ("true" to render node; "false" otherwise)

CompositeNode.filter

▸ getAnimationStyle(): AnimationStyle

Return animation style

AnimationStyle

animationStyle current animation style

CompositeNode.getAnimationStyle

▸ getAutoModelLimitsStrategy(): ModelLimitsStrategy

Get a strategy for calculating model limits

ModelLimitsStrategy

strategy If it is null, the limits of the parent model are used.

▸ getBounds(): Rect

Returns parent bounds

Rect

bounds

CompositeNode.getBounds

▸ getChild(i): T

Return node by index

T

CompositeNode.getChild

▸ getChildren<S>(predicate, modify?): Iterator<S>

Return iterator by child nodes

Iterator<S>

CompositeNode.getChildren

▸ getChildren(filter?, modify?): Iterator<T>

Returns an iterator for child nodes. The iterator does not support adding or deleting items from children by default. If it is necessary to modify a collection of children, pass true as the last parameter.

Example

// Gets a writable iterator
const it = node.getChildren(null, true);

Iterator<T>

An iterator for child nodes.

CompositeNode.getChildren

▸ getChildrenCount(): number

Return number of child nodes

number

CompositeNode.getChildrenCount

▸ getClassName(): string

string

CompositeNode.getClassName

▸ getClipStyle(): ClipStyle

Gets the current clipping style

ClipStyle

clipping style

CompositeNode.getClipStyle

▸ getContentsArea(transformation?): Rect

Return area of content. By default it is equal to bounds.

Rect

CompositeNode.getContentsArea

▸ getContentsTransform(): Transformation

Transformation of inner contents to content area

Transformation

CompositeNode.getContentsTransform

▸ getCss(): CssStyle

Return CSS style

CssStyle

CompositeNode.getCss

▸ getCssClass(): string

Returns css class name to be used to apply CSS style

string

the css class name

CompositeNode.getCssClass

▸ getCssClasses(): string[]

Gets list of css class names which applied to this node

string[]

CompositeNode.getCssClasses

▸ getCssTransform(): string

Returns CSS transformation

string

CompositeNode.getCssTransform

▸ getDeviceLimits(): Rect

Return device limits

Rect

CompositeNode.getDeviceLimits

▸ getId(): string | number

Returns the associated identifier of the node

string | number

The node's id

CompositeNode.getId

▸ getInfiniteMode(): boolean

Return infinity mode flag

boolean

flag

CompositeNode.getInfiniteMode

▸ Protected getInvalidateMethod(): AttributeCallback<EventDispatcher>

Gets invalidate method

AttributeCallback<EventDispatcher>

method to invalidate this object

CompositeNode.getInvalidateMethod

▸ getIsInfinite(): boolean

Returns infinite flag, flag that indicates infinite limits of the layer

boolean

▸ getLocalTransform(): Transformation

Retrieves the transformation of bounds to parent

Transformation

transform the local transform.

CompositeNode.getLocalTransform

▸ getMarginsStyle(): SpaceStyle<string | number>

Return margins style

SpaceStyle<string | number>

CompositeNode.getMarginsStyle

▸ getModelLimits(): Rect

Returns parent model limits

Rect

CompositeNode.getModelLimits

▸ getName(): string

Returns the node name

string

The node name

CompositeNode.getName

▸ getOpacity(): number

Returns current node opacity

number

opacity

CompositeNode.getOpacity

▸ getOpacityBlendMode(): BlendMode

Returns current node opacity

BlendMode

opacity blend mode

CompositeNode.getOpacityBlendMode

▸ getParent(): Node

Return parent node

Node

parent node

CompositeNode.getParent

▸ getProperties(context?): OptionsOut<T>

Gets all the properties pertaining to this object

OptionsOut<T>

properties object

CompositeNode.getProperties

▸ getProperty(name): any

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

any

CompositeNode.getProperty

▸ getPropertyKeys(): string[]

Returns known properties keys

string[]

CompositeNode.getPropertyKeys

▸ getRenderingFilter(): IFilter

Return filter to be used for rendering and picking

IFilter

current filter

CompositeNode.getRenderingFilter

▸ getResponsiveStyle(): ResponsiveStyle

Return responsive style

ResponsiveStyle

CompositeNode.getResponsiveStyle

▸ getRoot(): Node

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

Node

the root node

CompositeNode.getRoot

▸ getScaleScrollStrategy(): Delegate

Gets scale scroll strategy

Delegate

scale scroll strategy

CompositeNode.getScaleScrollStrategy

▸ getSceneTransform(): Transformation

Returns transformation from node to root scene

Transformation

a transformation from node to root scene

CompositeNode.getSceneTransform

▸ getTag(): any

Returns the object associated with the node by user.

any

The node's user-object

CompositeNode.getTag

▸ getVisible(): boolean

Return visibility of the node

boolean

true if node is visible

CompositeNode.getVisible

▸ getVisibleDeviceLimits(ignoreModelLimits?): Rect

Return visible device limits

Rect

CompositeNode.getVisibleDeviceLimits

▸ getVisibleModelLimits(ignoreModelLimits?): Rect

Return visible model limits

Rect

CompositeNode.getVisibleModelLimits

▸ getWorldTransform(): Transformation

Retrieves the local transformation of the node which represents multiplication of parent to bounds and contents transformations.

Transformation

CompositeNode.getWorldTransform

▸ getZIndex(): number

Returns node z-index (null if not set)

number

CompositeNode.getZIndex

▸ hasCssClass(cssClass): boolean

Check if node has specified css class

boolean

CompositeNode.hasCssClass

▸ hasEventListener(type, callback?): boolean

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

boolean

CompositeNode.hasEventListener

▸ indexOfChild(node): number

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

number

CompositeNode.indexOfChild

▸ insertChild(index, node): Layer<T>

Insert child node at specified index

Layer<T>

this

CompositeNode.insertChild

▸ invalidate(bounds?, force?): Layer<T>

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

Layer<T>

this

CompositeNode.invalidate

▸ invalidateParent(bounds?, force?): Layer<T>

Invalidate parent and notify all listeners.

Layer<T>

this

CompositeNode.invalidateParent

▸ isClippingEnabled(): boolean

Returns if clipping is enabled or not for this node.

boolean

CompositeNode.isClippingEnabled

▸ isDisposed(): boolean

Returns whether this object has been disposed

boolean

CompositeNode.isDisposed

▸ isEventPropagationEnabled(): boolean

Return true if event propagation is enabled from child to parent

boolean

CompositeNode.isEventPropagationEnabled

▸ isHorizontalFlip(): boolean

Return true if the representation is flipped horizontally

boolean

CompositeNode.isHorizontalFlip

▸ isNotificationEnabled(): boolean

return state of notification

boolean

current notification state

CompositeNode.isNotificationEnabled

▸ isSelectable(): boolean

Returns true if node can be picked/selected.

boolean

The selectable flag

CompositeNode.isSelectable

▸ isSilent(): boolean

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

boolean

CompositeNode.isSilent

▸ isVerticalFlip(): boolean

Return true if the representation is flipped vertically

boolean

CompositeNode.isVerticalFlip

▸ moveTo(area, vAlign?, hAlign?): Layer<T>

MoveTo position of node to specified area

Layer<T>

this

CompositeNode.moveTo

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

Notify listeners of the Node

Layer<T>

this

CompositeNode.notify

▸ Protected notifyRoot(event, source, args?): Node

Notify an even to root node

Node

this

CompositeNode.notifyRoot

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

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.

Layer<T>

this

CompositeNode.off

▸ on<E>(type, callback): Layer<T>

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.

Layer<T>

this

CompositeNode.on

▸ Protected onChildAdded(child): void

This method is called it child or children are added

void

CompositeNode.onChildAdded

▸ Protected onChildRemoved(child): void

This method is called it child or children are removed

void

CompositeNode.onChildRemoved

▸ Protected onParentChanged(node): Layer<T>

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

Layer<T>

this

CompositeNode.onParentChanged

▸ Protected onVisibilityChanged(): void

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

void

CompositeNode.onVisibilityChanged

▸ Protected postRendering(context, callback?): void

To be called after rendering, used for PDF output

void

CompositeNode.postRendering

▸ Protected preRendering(context, callback?): void

Occurs before child rendering

void

CompositeNode.preRendering

▸ registerAnimationStyle(root): void

Register animation style.

void

CompositeNode.registerAnimationStyle

▸ removeChild(node, disposeChildren?): Layer<T>

Remove child node

Layer<T>

this

CompositeNode.removeChild

▸ removeCssClass(cssclass): Layer<T>

Removes css class from node

Layer<T>

this

CompositeNode.removeCssClass

▸ removeInvalidateHandler(handler): Layer<T>

Remove invalidate handler

Deprecated

since 4.0, use Node.off instead

Layer<T>

this

CompositeNode.removeInvalidateHandler

▸ render(context): void

Render composite node and children

void

CompositeNode.render

▸ renderAsync(context, callback): void

Render node in asynchronous mode

void

CompositeNode.renderAsync

▸ Protected renderChildren(context): void

Render children

void

CompositeNode.renderChildren

▸ Protected renderChildrenAsync(context, callback): void

Render children async

void

CompositeNode.renderChildrenAsync

▸ Protected renderContent(context): void

render to specified context. This method calls preRendering, renderChildren, postRendering

void

CompositeNode.renderContent

▸ Protected renderContentAsync(context, callback): void

Render children in asynchronous mode

void

CompositeNode.renderContentAsync

▸ rotate(theta, x, y): Layer<T>

Rotate bounds around a given coordinate

Layer<T>

this

CompositeNode.rotate

▸ scale(xx, yy): Layer<T>

Scale node

Layer<T>

this

CompositeNode.scale

▸ setAnimationStyle(animationStyle): Layer<T>

Sets animation style

Layer<T>

CompositeNode.setAnimationStyle

▸ setAutoModelLimitsStrategy(strategy): Layer<T>

Set a strategy for calculating model limits. If it is null, the limits of the parent model are used.

Layer<T>

this

▸ setChild(index, node): Layer<T>

Replace child node by index

Layer<T>

this

CompositeNode.setChild

▸ setClipStyle(style): Layer<T>

Sets a new clipping style

Layer<T>

this

CompositeNode.setClipStyle

▸ setCss(style, merge?): Layer<T>

Sets CSS style. This style will be applied for all inserted elements

Layer<T>

this

CompositeNode.setCss

▸ setCssClass(name): Layer<T>

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

Layer<T>

this

CompositeNode.setCssClass

▸ setCssTransform(transform): Layer<T>

Set CSS transformation

Layer<T>

this

CompositeNode.setCssTransform

▸ setId(id): Layer<T>

Allows the user to associate any identifier

Layer<T>

this

CompositeNode.setId

▸ setInfiniteMode(infinityMode): Layer<T>

Set infinity mode flag to draw composite without collision check

Layer<T>

this

CompositeNode.setInfiniteMode

▸ setIsInfinite(infinite): Layer<T>

Set infinite flag, this flag indicates that the layer has infinite limits

Layer<T>

this

▸ setLocalTransform(localTransform, force?): Layer<T>

Sets local transformation to be used to transform from local to parent coordinate

Layer<T>

this

CompositeNode.setLocalTransform

▸ setMarginsStyle(margins, merge?): Layer<T>

Sets margins style

Layer<T>

this

CompositeNode.setMarginsStyle

▸ setName(name): Layer<T>

Sets name of the node

Layer<T>

this

CompositeNode.setName

▸ setNotification(notify, force?): Layer<T>

set notification state

Layer<T>

this

CompositeNode.setNotification

▸ setOpacity(opacity, blendMode?): Layer<T>

Sets node opacity

Layer<T>

this

CompositeNode.setOpacity

▸ setProperties(properties?): Layer<T>

Sets all the properties pertaining to this object

Layer<T>

this

CompositeNode.setProperties

▸ setProperty(name, value): Layer<T>

Sets dynamic property by name

Layer<T>

this

CompositeNode.setProperty

▸ setRenderingFilter(filter): Layer<T>

Sets filter to be applied before rendering and picking

Layer<T>

this

CompositeNode.setRenderingFilter

▸ setResponsiveStyle(style): Layer<T>

Sets responsive style.

Layer<T>

this

CompositeNode.setResponsiveStyle

▸ setScaleScrollStrategy(strategy?): Layer<T>

Sets scale scroll strategy

Layer<T>

this

CompositeNode.setScaleScrollStrategy

▸ setSelectable(selectable): Layer<T>

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

Layer<T>

this

CompositeNode.setSelectable

▸ setSilent(bool): Layer<T>

Set silent mode

Layer<T>

this

CompositeNode.setSilent

▸ setTag(tag): Layer<T>

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

Layer<T>

this

CompositeNode.setTag

▸ setVisible(value): Layer<T>

Sets visibility of the node. Send event Events.VisibilityChanged

Layer<T>

this

CompositeNode.setVisible

▸ setVisibleModelLimits(visibleModelBounds, deviceBounds?): Layer<T>

Set visible model limits

Layer<T>

this

CompositeNode.setVisibleModelLimits

▸ setZIndex(value): Layer<T>

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

Layer<T>

this

CompositeNode.setZIndex

▸ shear(shx, shy): Layer<T>

Shear this node's bounds

Layer<T>

this

CompositeNode.shear

▸ toString(): string

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

string

A string representation

CompositeNode.toString

▸ translate(tx, ty): Layer<T>

Translate bounds