Class: FlowComponentNode

• new FlowComponentNode(options)

• Protected new FlowComponentNode(options?)

RegularComponentNode.constructor

▸ addBaseLayer(baseLayer): FlowComponentNode

Add baseLayer to container

FlowComponentNode

this

RegularComponentNode.addBaseLayer

▸ addChild(node): FlowComponentNode

Add a child node

FlowComponentNode

this

RegularComponentNode.addChild

▸ addCssClass(cssclass): FlowComponentNode

Adds new css class to node

FlowComponentNode

this

RegularComponentNode.addCssClass

▸ addInvalidateHandler(handler): FlowComponentNode

Add invalidate handler

Deprecated

since 4.0, use Node.on instead

FlowComponentNode

this

RegularComponentNode.addInvalidateHandler

▸ addOverlay(overlay): FlowComponentNode

Add overlay to container

FlowComponentNode

this

RegularComponentNode.addOverlay

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

Adjust position of node to specified area

FlowComponentNode

this

RegularComponentNode.adjustPosition

▸ Protected applyOpacity(context): FlowComponentNode

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

FlowComponentNode

this

RegularComponentNode.applyOpacity

▸ Protected applyResponsiveStyle(): void

Apply a responsive style rules it is exists

void

RegularComponentNode.applyResponsiveStyle

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

Changes the z-order of the baseLayer.

FlowComponentNode

this

RegularComponentNode.changeBaseLayerOrder

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

changes the z-order of the nodes being rendered.

FlowComponentNode

this

RegularComponentNode.changeChildOrder

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

Changes the z-order of the overlay.

FlowComponentNode

this

RegularComponentNode.changeOverlayOrder

▸ checkCollision(context): boolean

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

boolean

RegularComponentNode.checkCollision

▸ clearBaseLayers(disposeBaseLayers?): FlowComponentNode

Remove all child baseLayers from group

FlowComponentNode

this

RegularComponentNode.clearBaseLayers

▸ clearCache(): FlowComponentNode

Clear cache

FlowComponentNode

this

RegularComponentNode.clearCache

▸ clearChildren(disposeChildren?): FlowComponentNode

Remove all child nodes from this composite group

FlowComponentNode

this

RegularComponentNode.clearChildren

▸ clearOverlays(disposeOverlays?): FlowComponentNode

Remove all child overlays from group

FlowComponentNode

this

RegularComponentNode.clearOverlays

▸ clone(): Group<Node>

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

Group<Node>

clone

RegularComponentNode.clone

▸ connectStyle(style, type, callback): FlowComponentNode

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

FlowComponentNode

this

RegularComponentNode.connectStyle

▸ Protected copyConstructor(src, deepCopy?): FlowComponentNode

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

FlowComponentNode

this

RegularComponentNode.copyConstructor

▸ disconnectStyle(style, type, callback): FlowComponentNode

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

FlowComponentNode

this

RegularComponentNode.disconnectStyle

▸ dispose(): void

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

void

RegularComponentNode.dispose

▸ Protected drawBorder(localContext, bounds?): FlowComponentNode

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

FlowComponentNode

this

RegularComponentNode.drawBorder

▸ enableClipping(doClip): FlowComponentNode

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

FlowComponentNode

this

RegularComponentNode.enableClipping

▸ enableEventPropagation(enable): FlowComponentNode

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

FlowComponentNode

this

RegularComponentNode.enableEventPropagation

▸ enablePickingChildren(enable): FlowComponentNode

Enables or disables picking children

FlowComponentNode

this

RegularComponentNode.enablePickingChildren

▸ enumerateNodes(callback, target?): void

Executes a provided function once for each child node

void

RegularComponentNode.enumerateNodes

▸ execute(delegate): FlowComponentNode

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

FlowComponentNode

The result if any or this

RegularComponentNode.execute

▸ execute<T>(delegate): T

T

RegularComponentNode.execute

▸ Protected filter(context): boolean

Filter node

boolean

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

RegularComponentNode.filter

▸ getAnimationStyle(): AnimationStyle

Return animation style

AnimationStyle

animationStyle current animation style

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

RegularComponentNode.getAutoModelLimitsMode

▸ getAutoModelLimitsStrategy(): ModelLimitsStrategy

Get Model Limits Logics Strategy

ModelLimitsStrategy

strategy

RegularComponentNode.getAutoModelLimitsStrategy

▸ getBaseLayer(index): Node

Return baseLayer at specified index

Node

track

RegularComponentNode.getBaseLayer

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

Return iterator by baseLayers nodes

Iterator<Node>

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

RegularComponentNode.getBaseLayers

▸ getBaseLayersCount(): number

Returns amount of baseLayers

number

RegularComponentNode.getBaseLayersCount

▸ getBounds(): Rect

Get the node bounds.

Rect

component node bounds

RegularComponentNode.getBounds

▸ getCache(): Cache

Return cache strategy to be used to cache children nodes

Cache

cache

RegularComponentNode.getCache

▸ getChild(i): Node

Return node by index

Node

RegularComponentNode.getChild

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

Return iterator by child nodes

Iterator<S>

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

RegularComponentNode.getChildren

▸ getChildrenCount(): number

Return number of child nodes

number

RegularComponentNode.getChildrenCount

▸ getClassName(): string

string

RegularComponentNode.getClassName

▸ getClipStyle(): ClipStyle

Gets the current clipping style

ClipStyle

clipping style

RegularComponentNode.getClipStyle

▸ getContentOrientation(): Orientation

Return content orientation

Orientation

content orientation

RegularComponentNode.getContentOrientation

▸ getContentsArea(transformation?): Rect

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

Rect

RegularComponentNode.getContentsArea

▸ getContentsTransform(): Transformation

getContentsTransform() retrieves the world transformation of the node.

Transformation

transformation from model coordinates to bounds of the group

RegularComponentNode.getContentsTransform

▸ getCss(): CssStyle

Return CSS style

CssStyle

RegularComponentNode.getCss

▸ getCssClass(): string

Returns css class name to be used to apply CSS style

string

the css class name

RegularComponentNode.getCssClass

▸ getCssClasses(): string[]

Gets list of css class names which applied to this node

string[]

RegularComponentNode.getCssClasses

▸ getCssTransform(): string

Returns CSS transformation

string

RegularComponentNode.getCssTransform

▸ getData(deepCopy?): Options

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

Options

data

RegularComponentNode.getData

▸ getDescription(deepCopy?): Description

Gets description (Convenience method)

Description

description

RegularComponentNode.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)

RegularComponentNode.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)

RegularComponentNode.getDesiredWidth

▸ getDeviceLimits(): Rect

Return device limits

Rect

RegularComponentNode.getDeviceLimits

▸ getFillStyle(): FillStyle

Return fill style

FillStyle

fillStyle current fill style

RegularComponentNode.getFillStyle

▸ getGeometryBounds(): Rect

Gets model bounds

Rect

RegularComponentNode.getGeometryBounds

▸ getGeometryData(deepCopy?): Entity

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

Entity

geometric data

RegularComponentNode.getGeometryData

▸ getId(): string | number

Returns the associated identifier of the node

string | number

The node's id

RegularComponentNode.getId

▸ getInfiniteMode(): boolean

Return infinity mode flag

boolean

flag

RegularComponentNode.getInfiniteMode

▸ Protected getInvalidateMethod(): AttributeCallback<EventDispatcher>

Gets invalidate method

AttributeCallback<EventDispatcher>

method to invalidate this object

RegularComponentNode.getInvalidateMethod

▸ getLayout(): Layout

Returns layout associated with the group

Layout

layout

RegularComponentNode.getLayout

▸ getLayoutStyle(): LayoutStyle<string | number>

return desired layout style

LayoutStyle<string | number>

RegularComponentNode.getLayoutStyle

▸ getLineStyle(): LineStyle

Return border style

LineStyle

RegularComponentNode.getLineStyle

▸ getLocalTransform(): Transformation

Retrieves the transformation of bounds to parent

Transformation

transform the local transform.

RegularComponentNode.getLocalTransform

▸ getMarginsStyle(): SpaceStyle<string | number>

Return margins style

SpaceStyle<string | number>

RegularComponentNode.getMarginsStyle

▸ getModelLimits(): Rect

Gets model limits, the limits of this groups inside space

Rect

the current model limits

RegularComponentNode.getModelLimits

▸ getName(): string

Returns the node name

string

The node name

RegularComponentNode.getName

▸ getOpacity(): number

Returns current node opacity

number

opacity

RegularComponentNode.getOpacity

▸ getOpacityBlendMode(): BlendMode

Returns current node opacity

BlendMode

opacity blend mode

RegularComponentNode.getOpacityBlendMode

▸ getOverlay(index): Node

Return overlay at specified index

Node

track

RegularComponentNode.getOverlay

▸ getOverlayAt(index): Node

Return overlay at specified index

Deprecated

since 4.2 use getOverlay instead

Node

track

RegularComponentNode.getOverlayAt

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

Return iterator by overlays nodes

Iterator<Node>

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

RegularComponentNode.getOverlays

▸ getOverlaysCount(): number

Returns amount of overlays

number

RegularComponentNode.getOverlaysCount

▸ getPaddingStyle(): SpaceStyle<string | number>

Return padding style

SpaceStyle<string | number>

padding

RegularComponentNode.getPaddingStyle

▸ getParent(): Node

Return parent node

Node

parent node

RegularComponentNode.getParent

▸ getPreferredSize(): Rect

Return preferred size to layout children

Rect

RegularComponentNode.getPreferredSize

▸ getProperties(): OptionsOut

Gets all the properties pertaining to this object

OptionsOut

properties

RegularComponentNode.getProperties

▸ getProperty(name): any

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

any

RegularComponentNode.getProperty

▸ getPropertyKeys(): string[]

Returns known properties keys

string[]

RegularComponentNode.getPropertyKeys

▸ getRenderingFilter(): IFilter

Return filter to be used for rendering and picking

IFilter

current filter

RegularComponentNode.getRenderingFilter

▸ getRenderingHints(deepCopy?): RenderingHintsBase | RenderingHints

Gets rendering hints

RenderingHintsBase | RenderingHints

rendering hints

RegularComponentNode.getRenderingHints

▸ getResponsiveStyle(): ResponsiveStyle

Return responsive style

ResponsiveStyle

RegularComponentNode.getResponsiveStyle

▸ getRoot(): Node

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

Node

the root node

RegularComponentNode.getRoot

▸ getScaleScrollStrategy(): Delegate

Gets scale scroll strategy

Delegate

scale scroll strategy

RegularComponentNode.getScaleScrollStrategy

▸ getSceneTransform(): Transformation

Returns transformation from node to root scene

Transformation

a transformation from node to root scene

RegularComponentNode.getSceneTransform

▸ getSelected(): boolean

Gets selected state

boolean

RegularComponentNode.getSelected

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

Gets graphical styles associated with it.

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

RegularComponentNode.getStyles

▸ getTag(): any

Returns the object associated with the node by user.

any

The node's user-object

RegularComponentNode.getTag

▸ Abstract getTemplateBounds(): Rect

Gets template bounds

Rect

RegularComponentNode.getTemplateBounds

▸ Abstract getTemplateNode(): AbstractNode

Gets template node

AbstractNode

RegularComponentNode.getTemplateNode

▸ getVisible(): boolean

Return visibility of the node

boolean

true if node is visible

RegularComponentNode.getVisible

▸ getVisibleDeviceLimits(ignoreModelLimits?): Rect

Return visible device limits

Rect

RegularComponentNode.getVisibleDeviceLimits

▸ getVisibleModelLimits(ignoreModelLimits?): Rect

Return visible model limits

Rect

RegularComponentNode.getVisibleModelLimits

▸ getWorldTransform(): Transformation

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

Transformation

RegularComponentNode.getWorldTransform

▸ getZIndex(): number

Returns node z-index (null if not set)

number

RegularComponentNode.getZIndex

▸ hasCssClass(cssClass): boolean

Check if node has specified css class

boolean

RegularComponentNode.hasCssClass

▸ hasEventListener(type, callback?): boolean

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

boolean

RegularComponentNode.hasEventListener

▸ hideFlow(): void

Delete all flow children

void

▸ indexOfBaseLayer(baseLayer): number

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

number

RegularComponentNode.indexOfBaseLayer

▸ indexOfChild(node): number

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

number

RegularComponentNode.indexOfChild

▸ indexOfOverlay(overlay): number

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

number

RegularComponentNode.indexOfOverlay

▸ insertBaseLayer(index, baseLayer): FlowComponentNode

Insert child baseLayer at specified index

FlowComponentNode

this

RegularComponentNode.insertBaseLayer

▸ insertChild(index, node): FlowComponentNode

Insert child node at specified index

FlowComponentNode

this

RegularComponentNode.insertChild

▸ insertOverlay(index, overlay): FlowComponentNode

Insert child overlay at specified index

FlowComponentNode

this

RegularComponentNode.insertOverlay

▸ invalidate(bounds?, force?): FlowComponentNode

Invalidate node

FlowComponentNode

this

RegularComponentNode.invalidate

▸ invalidateLayout(propagate?): FlowComponentNode

Notify that layout is invalidated. Send event Events.LayoutInvalidated

FlowComponentNode

this

RegularComponentNode.invalidateLayout

▸ invalidateParent(bounds?, force?): FlowComponentNode

Invalidate parent area

FlowComponentNode

this

RegularComponentNode.invalidateParent

▸ isClippingEnabled(): boolean

Returns if clipping is enabled or not for this node.

boolean

RegularComponentNode.isClippingEnabled

▸ isDisposed(): boolean

Returns whether this object has been disposed

boolean

RegularComponentNode.isDisposed

▸ isEventPropagationEnabled(): boolean

Return true if event propagation is enabled from child to parent

boolean

RegularComponentNode.isEventPropagationEnabled

▸ isHorizontalFlip(): boolean

Return true if the representation is flipped horizontally

boolean

flip

RegularComponentNode.isHorizontalFlip

▸ Protected isInitialized(): boolean

Return initialization state

boolean

RegularComponentNode.isInitialized

▸ isLayoutInvalidated(): boolean

Return true if layout is invalid

boolean

RegularComponentNode.isLayoutInvalidated

▸ isNotificationEnabled(): boolean

return state of notification

boolean

current notification state

RegularComponentNode.isNotificationEnabled

▸ isPickingChildrenEnabled(): boolean

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

boolean

pickingChildren

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

RegularComponentNode.isResourceBased

▸ isSelectable(): boolean

Returns true if node can be picked/selected.

boolean

The selectable flag

RegularComponentNode.isSelectable

▸ isSilent(): boolean

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

boolean

RegularComponentNode.isSilent

▸ isVerticalFlip(): boolean

Return true if the representation is flipped vertically

boolean

flip

RegularComponentNode.isVerticalFlip

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

MoveTo position of node to specified area

FlowComponentNode

this

RegularComponentNode.moveTo

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

Notify listeners of the Node

FlowComponentNode

this

RegularComponentNode.notify

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

Notify an even to root node

Node

this

RegularComponentNode.notifyRoot

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