Class: RegularComponentNode

• new RegularComponentNode(options)

• Protected new RegularComponentNode(options?)

ReusableComponentNode.constructor

▸ addBaseLayer(baseLayer): RegularComponentNode

Add baseLayer to container

RegularComponentNode

this

ReusableComponentNode.addBaseLayer

▸ addChild(node): RegularComponentNode

Add a child node

RegularComponentNode

this

ReusableComponentNode.addChild

▸ addCssClass(cssclass): RegularComponentNode

Adds new css class to node

RegularComponentNode

this

ReusableComponentNode.addCssClass

▸ addInvalidateHandler(handler): RegularComponentNode

Add invalidate handler

Deprecated

since 4.0, use Node.on instead

RegularComponentNode

this

ReusableComponentNode.addInvalidateHandler

▸ addOverlay(overlay): RegularComponentNode

Add overlay to container

RegularComponentNode

this

ReusableComponentNode.addOverlay

▸ adjustPosition(area?, vAlign?, hAlign?): RegularComponentNode

Adjust position of node to specified area

RegularComponentNode

this

ReusableComponentNode.adjustPosition

▸ Protected applyOpacity(context): RegularComponentNode

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

RegularComponentNode

this

ReusableComponentNode.applyOpacity

▸ Protected applyResponsiveStyle(): void

Apply a responsive style rules it is exists

void

ReusableComponentNode.applyResponsiveStyle

▸ changeBaseLayerOrder(overlay, order, anchor?): RegularComponentNode

Changes the z-order of the baseLayer.

RegularComponentNode

this

ReusableComponentNode.changeBaseLayerOrder

▸ changeChildOrder(node, order, anchor?): RegularComponentNode

changes the z-order of the nodes being rendered.

RegularComponentNode

this

ReusableComponentNode.changeChildOrder

▸ changeOverlayOrder(overlay, order, anchor?): RegularComponentNode

Changes the z-order of the overlay.

RegularComponentNode

this

ReusableComponentNode.changeOverlayOrder

▸ checkCollision(context): boolean

Checks collision. Returns true if object is inside of renderable area

boolean

ReusableComponentNode.checkCollision

▸ clearBaseLayers(disposeBaseLayers?): RegularComponentNode

Remove all child baseLayers from group

RegularComponentNode

this

ReusableComponentNode.clearBaseLayers

▸ clearCache(): RegularComponentNode

Clear cache

RegularComponentNode

this

ReusableComponentNode.clearCache

▸ clearChildren(disposeChildren?): RegularComponentNode

Remove all child nodes from this composite group

RegularComponentNode

this

ReusableComponentNode.clearChildren

▸ clearOverlays(disposeOverlays?): RegularComponentNode

Remove all child overlays from group

RegularComponentNode

this

ReusableComponentNode.clearOverlays

▸ clone(): Group<Node>

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

Group<Node>

clone

ReusableComponentNode.clone

▸ connectStyle(style, type, callback): RegularComponentNode

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

RegularComponentNode

this

ReusableComponentNode.connectStyle

▸ Protected copyConstructor(src, deepCopy?): RegularComponentNode

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

RegularComponentNode

this

ReusableComponentNode.copyConstructor

▸ disconnectStyle(style, type, callback): RegularComponentNode

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

RegularComponentNode

this

ReusableComponentNode.disconnectStyle

▸ dispose(): void

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

void

ReusableComponentNode.dispose

▸ Protected drawBorder(localContext, bounds?): RegularComponentNode

Draws a rectangle at the bounding box (in parent coordinates)

RegularComponentNode

this

ReusableComponentNode.drawBorder

▸ enableClipping(doClip): RegularComponentNode

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

RegularComponentNode

this

ReusableComponentNode.enableClipping

▸ enableEventPropagation(enable): RegularComponentNode

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

RegularComponentNode

this

ReusableComponentNode.enableEventPropagation

▸ enablePickingChildren(enable): RegularComponentNode

Enables or disables picking children

RegularComponentNode

this

ReusableComponentNode.enablePickingChildren

▸ enumerateNodes(callback, target?): void

Executes a provided function once for each child node

void

ReusableComponentNode.enumerateNodes

▸ execute(delegate): RegularComponentNode

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

RegularComponentNode

The result if any or this

ReusableComponentNode.execute

▸ execute<T>(delegate): T

T

ReusableComponentNode.execute

▸ Protected filter(context): boolean

Filter node

boolean

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

ReusableComponentNode.filter

▸ getAnimationStyle(): AnimationStyle

Return animation style

AnimationStyle

animationStyle current animation style

ReusableComponentNode.getAnimationStyle

▸ getAutoModelLimitsMode(): boolean

Get Model Limits Logics to use when no Model Limits have been set set to true: will use parents width and height, starting at 0 set to false: will use parents bounds

boolean

mode

ReusableComponentNode.getAutoModelLimitsMode

▸ getAutoModelLimitsStrategy(): ModelLimitsStrategy

Get Model Limits Logics Strategy

ModelLimitsStrategy

strategy

ReusableComponentNode.getAutoModelLimitsStrategy

▸ getBaseLayer(index): Node

Return baseLayer at specified index

Node

track

ReusableComponentNode.getBaseLayer

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

Return iterator by baseLayers nodes

Iterator<Node>

ReusableComponentNode.getBaseLayers

▸ getBaseLayers(filter?, modify?): Iterator<Node>

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

Example

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

Iterator<Node>

An iterator for child overlays.

ReusableComponentNode.getBaseLayers

▸ getBaseLayersCount(): number

Returns amount of baseLayers

number

ReusableComponentNode.getBaseLayersCount

▸ getBounds(): Rect

Get the node bounds.

Rect

component node bounds

ReusableComponentNode.getBounds

▸ getCache(): Cache

Return cache strategy to be used to cache children nodes

Cache

cache

ReusableComponentNode.getCache

▸ getChild(i): Node

Return node by index

Node

ReusableComponentNode.getChild

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

Return iterator by child nodes

Iterator<S>

ReusableComponentNode.getChildren

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

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<Node>

An iterator for child nodes.

ReusableComponentNode.getChildren

▸ getChildrenCount(): number

Return number of child nodes

number

ReusableComponentNode.getChildrenCount

▸ getClassName(): string

string

ReusableComponentNode.getClassName

▸ getClipStyle(): ClipStyle

Gets the current clipping style

ClipStyle

clipping style

ReusableComponentNode.getClipStyle

▸ getContentOrientation(): Orientation

Return content orientation

Orientation

content orientation

ReusableComponentNode.getContentOrientation

▸ getContentsArea(transformation?): Rect

Return area without paddings. Model limits are mapped to content area, where children are layout.

Rect

ReusableComponentNode.getContentsArea

▸ getContentsTransform(): Transformation

getContentsTransform() retrieves the world transformation of the node.

Transformation

transformation from model coordinates to bounds of the group

ReusableComponentNode.getContentsTransform

▸ getCss(): CssStyle

Return CSS style

CssStyle

ReusableComponentNode.getCss

▸ getCssClass(): string

Returns css class name to be used to apply CSS style

string

the css class name

ReusableComponentNode.getCssClass

▸ getCssClasses(): string[]

Gets list of css class names which applied to this node

string[]

ReusableComponentNode.getCssClasses

▸ getCssTransform(): string

Returns CSS transformation

string

ReusableComponentNode.getCssTransform

▸ getData(deepCopy?): Options

Gets component data (see "setData" API for return object elements)

Options

data

ReusableComponentNode.getData

▸ getDescription(deepCopy?): Description

Gets description (Convenience method)

Description

description

ReusableComponentNode.getDescription

▸ getDesiredHeight(): string | number

Returns desired height of the group as a layoutable object This method is a helper method to get access to getLayoutStyle()

string | number

desired height ("undefined" by default)

ReusableComponentNode.getDesiredHeight

▸ getDesiredWidth(): string | number

Returns desired width of the group as a layoutable object. This method is a helper method to get access to getLayoutStyle()

string | number

desired width ("undefined" by default)

ReusableComponentNode.getDesiredWidth

▸ getDeviceLimits(): Rect

Return device limits

Rect

ReusableComponentNode.getDeviceLimits

▸ getFillStyle(): FillStyle

Return fill style

FillStyle

fillStyle current fill style

ReusableComponentNode.getFillStyle

▸ getGeometryBounds(): Rect

Gets model bounds

Rect

ReusableComponentNode.getGeometryBounds

▸ getGeometryData(deepCopy?): Entity

Gets geometric data to build the node on (Convenience method)

Entity

geometric data

ReusableComponentNode.getGeometryData

▸ getId(): string | number

Returns the associated identifier of the node

string | number

The node's id

ReusableComponentNode.getId

▸ getInfiniteMode(): boolean

Return infinity mode flag

boolean

flag

ReusableComponentNode.getInfiniteMode

▸ Protected getInvalidateMethod(): AttributeCallback<EventDispatcher>

Gets invalidate method

AttributeCallback<EventDispatcher>

method to invalidate this object

ReusableComponentNode.getInvalidateMethod

▸ getLayout(): Layout

Returns layout associated with the group

Layout

layout

ReusableComponentNode.getLayout

▸ getLayoutStyle(): LayoutStyle<string | number>

return desired layout style

LayoutStyle<string | number>

ReusableComponentNode.getLayoutStyle

▸ getLineStyle(): LineStyle

Return border style

LineStyle

ReusableComponentNode.getLineStyle

▸ getLocalTransform(): Transformation

Retrieves the transformation of bounds to parent

Transformation

transform the local transform.

ReusableComponentNode.getLocalTransform

▸ getMarginsStyle(): SpaceStyle<string | number>

Return margins style

SpaceStyle<string | number>

ReusableComponentNode.getMarginsStyle

▸ getModelLimits(): Rect

Gets model limits, the limits of this groups inside space

Rect

the current model limits

ReusableComponentNode.getModelLimits

▸ getName(): string

Returns the node name

string

The node name

ReusableComponentNode.getName

▸ getOpacity(): number

Returns current node opacity

number

opacity

ReusableComponentNode.getOpacity

▸ getOpacityBlendMode(): BlendMode

Returns current node opacity

BlendMode

opacity blend mode

ReusableComponentNode.getOpacityBlendMode

▸ getOverlay(index): Node

Return overlay at specified index

Node

track

ReusableComponentNode.getOverlay

▸ getOverlayAt(index): Node

Return overlay at specified index

Deprecated

since 4.2 use getOverlay instead

Node

track

ReusableComponentNode.getOverlayAt

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

Return iterator by overlays nodes

Iterator<Node>

ReusableComponentNode.getOverlays

▸ getOverlays(filter?, modify?): Iterator<Node>

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

Example

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

Iterator<Node>

An iterator for child overlays.

ReusableComponentNode.getOverlays

▸ getOverlaysCount(): number

Returns amount of overlays

number

ReusableComponentNode.getOverlaysCount

▸ getPaddingStyle(): SpaceStyle<string | number>

Return padding style

SpaceStyle<string | number>

padding

ReusableComponentNode.getPaddingStyle

▸ getParent(): Node

Return parent node

Node

parent node

ReusableComponentNode.getParent

▸ getPreferredSize(): Rect

Return preferred size to layout children

Rect

ReusableComponentNode.getPreferredSize

▸ getProperties(): OptionsOut

Gets all the properties pertaining to this object

OptionsOut

properties

ReusableComponentNode.getProperties

▸ getProperty(name): any

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

any

ReusableComponentNode.getProperty

▸ getPropertyKeys(): string[]

Returns known properties keys

string[]

ReusableComponentNode.getPropertyKeys

▸ getRenderingFilter(): IFilter

Return filter to be used for rendering and picking

IFilter

current filter

ReusableComponentNode.getRenderingFilter

▸ getRenderingHints(deepCopy?): RenderingHintsBase | RenderingHints

Gets rendering hints

RenderingHintsBase | RenderingHints

rendering hints

ReusableComponentNode.getRenderingHints

▸ getResponsiveStyle(): ResponsiveStyle

Return responsive style

ResponsiveStyle

ReusableComponentNode.getResponsiveStyle

▸ getRoot(): Node

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

Node

the root node

ReusableComponentNode.getRoot

▸ getScaleScrollStrategy(): Delegate

Gets scale scroll strategy

Delegate

scale scroll strategy

ReusableComponentNode.getScaleScrollStrategy

▸ getSceneTransform(): Transformation

Returns transformation from node to root scene

Transformation

a transformation from node to root scene

ReusableComponentNode.getSceneTransform

▸ getSelected(): boolean

Gets selected state

boolean

ReusableComponentNode.getSelected

▸ getStyles(): { classname: string ; fillstyle: FillStyle ; linestyle: LineStyle }[]

Gets graphical styles associated with it.

{ classname: string ; fillstyle: FillStyle ; linestyle: LineStyle }[]

ReusableComponentNode.getStyles

▸ getTag(): any

Returns the object associated with the node by user.

any

The node's user-object

ReusableComponentNode.getTag

▸ Abstract getTemplateBounds(): Rect

Gets template bounds

Rect

ReusableComponentNode.getTemplateBounds

▸ Abstract getTemplateNode(): AbstractNode

Gets template node

AbstractNode

ReusableComponentNode.getTemplateNode

▸ getVisible(): boolean

Return visibility of the node

boolean

true if node is visible

ReusableComponentNode.getVisible

▸ getVisibleDeviceLimits(ignoreModelLimits?): Rect

Return visible device limits

Rect

ReusableComponentNode.getVisibleDeviceLimits

▸ getVisibleModelLimits(ignoreModelLimits?): Rect

Return visible model limits

Rect

ReusableComponentNode.getVisibleModelLimits

▸ getWorldTransform(): Transformation

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

Transformation

ReusableComponentNode.getWorldTransform

▸ getZIndex(): number

Returns node z-index (null if not set)

number

ReusableComponentNode.getZIndex

▸ hasCssClass(cssClass): boolean

Check if node has specified css class

boolean

ReusableComponentNode.hasCssClass

▸ hasEventListener(type, callback?): boolean

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

boolean

ReusableComponentNode.hasEventListener

▸ indexOfBaseLayer(baseLayer): number

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

number

ReusableComponentNode.indexOfBaseLayer

▸ indexOfChild(node): number

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

number

ReusableComponentNode.indexOfChild

▸ indexOfOverlay(overlay): number

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

number

ReusableComponentNode.indexOfOverlay

▸ insertBaseLayer(index, baseLayer): RegularComponentNode

Insert child baseLayer at specified index

RegularComponentNode

this

ReusableComponentNode.insertBaseLayer

▸ insertChild(index, node): RegularComponentNode

Insert child node at specified index

RegularComponentNode

this

ReusableComponentNode.insertChild

▸ insertOverlay(index, overlay): RegularComponentNode

Insert child overlay at specified index

RegularComponentNode

this

ReusableComponentNode.insertOverlay

▸ invalidate(bounds?, force?): RegularComponentNode

Invalidate node

RegularComponentNode

this

ReusableComponentNode.invalidate

▸ invalidateLayout(propagate?): RegularComponentNode

Notify that layout is invalidated. Send event Events.LayoutInvalidated

RegularComponentNode

this

ReusableComponentNode.invalidateLayout

▸ invalidateParent(bounds?, force?): RegularComponentNode

Invalidate parent area

RegularComponentNode

this

ReusableComponentNode.invalidateParent

▸ isClippingEnabled(): boolean

Returns if clipping is enabled or not for this node.

boolean

ReusableComponentNode.isClippingEnabled

▸ isDisposed(): boolean

Returns whether this object has been disposed

boolean

ReusableComponentNode.isDisposed

▸ isEventPropagationEnabled(): boolean

Return true if event propagation is enabled from child to parent

boolean

ReusableComponentNode.isEventPropagationEnabled

▸ isHorizontalFlip(): boolean

Return true if the representation is flipped horizontally

boolean

flip

ReusableComponentNode.isHorizontalFlip

▸ Protected isInitialized(): boolean

Return initialization state

boolean

ReusableComponentNode.isInitialized

▸ isLayoutInvalidated(): boolean

Return true if layout is invalid

boolean

ReusableComponentNode.isLayoutInvalidated

▸ isNotificationEnabled(): boolean

return state of notification

boolean

current notification state

ReusableComponentNode.isNotificationEnabled

▸ isPickingChildrenEnabled(): boolean

Returns if picking children is enabled or not for this node.

boolean

pickingChildren

ReusableComponentNode.isPickingChildrenEnabled

▸ isResourceBased(): boolean

Gets "resource-based" indicator. Inherited class should override the method to ensure WellBoreNode invalidation on the node's resource load.

boolean

false

ReusableComponentNode.isResourceBased

▸ isSelectable(): boolean

Returns true if node can be picked/selected.

boolean

The selectable flag

ReusableComponentNode.isSelectable

▸ isSilent(): boolean

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

boolean

ReusableComponentNode.isSilent

▸ isVerticalFlip(): boolean

Return true if the representation is flipped vertically

boolean

flip

ReusableComponentNode.isVerticalFlip

▸ moveTo(area, vAlign?, hAlign?): RegularComponentNode

MoveTo position of node to specified area

RegularComponentNode

this

ReusableComponentNode.moveTo

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

Notify listeners of the Node

RegularComponentNode

this

ReusableComponentNode.notify

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

Notify an even to root node

Node

this

ReusableComponentNode.notifyRoot

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

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.