Class: Handle

• new Handle(params?)

Anchored handle

AnchoredHandle.constructor

• new Handle(x, y, size?)

Anchored handle

AnchoredHandle.constructor

▸ addCssClass(cssclass): Handle

Adds new css class to node

Handle

this

AnchoredHandle.addCssClass

▸ addInvalidateHandler(handler): Handle

Add invalidate handler

Deprecated

since 4.0, use Node.on instead

Handle

this

AnchoredHandle.addInvalidateHandler

▸ Protected applyOpacity(context): Handle

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

Handle

this

AnchoredHandle.applyOpacity

▸ Protected applyResponsiveStyle(): void

Apply a responsive style rules it is exists

void

AnchoredHandle.applyResponsiveStyle

▸ 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

AnchoredHandle.checkCollision

▸ clone(): Node

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

Node

clone

AnchoredHandle.clone

▸ connectStyle(style, type, callback): Handle

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

Handle

this

AnchoredHandle.connectStyle

▸ copyConstructor(src): Handle

Used for cloning

Handle

AnchoredHandle.copyConstructor

▸ createGhost(): GhostBearingHandle

Creates a copy of this handle, sets ghost styles, registers it as a ghosts and returns the ghost

GhostBearingHandle

AnchoredHandle.createGhost

▸ disconnectStyle(style, type, callback): Handle

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

Handle

this

AnchoredHandle.disconnectStyle

▸ dispose(): void

Disposes this handle, Clear all listeners and remove the ghost

void

AnchoredHandle.dispose

▸ enableEventPropagation(enable): Handle

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

Handle

this

AnchoredHandle.enableEventPropagation

▸ execute(delegate): Handle

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

Handle

The result if any or this

AnchoredHandle.execute

▸ execute<T>(delegate): T

T

AnchoredHandle.execute

▸ Protected filter(context): boolean

Filter node

boolean

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

AnchoredHandle.filter

▸ getActiveFillStyle(): FillStyle

Return fill style for active state

FillStyle

fillStyle current fill style

AnchoredHandle.getActiveFillStyle

▸ getActiveLineStyle(): LineStyle

Return line style for inactive state

LineStyle

gets current active line style

AnchoredHandle.getActiveLineStyle

▸ getAdapter(): ShapeAdapter<Node>

Returns current adapter of the real handle if this is a ghost, otherwise returns the adapter to this handle

ShapeAdapter<Node>

AnchoredHandle.getAdapter

▸ getAnchor(): Point

Returns the position of the handle

Point

AnchoredHandle.getAnchor

▸ getAnimationStyle(): AnimationStyle

Return animation style

AnimationStyle

animationStyle current animation style

AnchoredHandle.getAnimationStyle

▸ getClassName(): string

string

AnchoredHandle.getClassName

▸ getClipStyle(): ClipStyle

Gets the current clipping style

ClipStyle

clipping style

AnchoredHandle.getClipStyle

▸ getCss(): CssStyle

Return CSS style

CssStyle

AnchoredHandle.getCss

▸ getCssClass(): string

Returns css class name to be used to apply CSS style

string

the css class name

AnchoredHandle.getCssClass

▸ getCssClasses(): string[]

Gets list of css class names which applied to this node

string[]

AnchoredHandle.getCssClasses

▸ getCssTransform(): string

Returns CSS transformation

string

AnchoredHandle.getCssTransform

▸ getFillStyle(): FillStyle

Return fill style

FillStyle

fillStyle current fill style

AnchoredHandle.getFillStyle

▸ getGhost(): GhostBearingHandle

Returns the ghost registered with this handle. If ghost does not exist, returns null

GhostBearingHandle

AnchoredHandle.getGhost

▸ getGhostFillStyle(): FillStyle

Return fill style for ghost mode state

FillStyle

fillStyle current ghost fill style

AnchoredHandle.getGhostFillStyle

▸ getGhostLineStyle(): LineStyle

Return line style for ghost mode stat

LineStyle

gets current ghost line style

AnchoredHandle.getGhostLineStyle

▸ getHandleSize(): Dimension

Return handle size as a two-dimensional unit

Dimension

AnchoredHandle.getHandleSize

▸ getId(): string | number

Returns the associated identifier of the node

string | number

The node's id

AnchoredHandle.getId

▸ getInactiveFillStyle(): FillStyle

Return fill style for inactive state

FillStyle

fillStyle current fill style

AnchoredHandle.getInactiveFillStyle

▸ getInactiveLineStyle(): LineStyle

Return fill style for inactive state

LineStyle

gets current inactive line style

AnchoredHandle.getInactiveLineStyle

▸ Protected getInvalidateMethod(): AttributeCallback<EventDispatcher>

Gets invalidate method

AttributeCallback<EventDispatcher>

method to invalidate this object

AnchoredHandle.getInvalidateMethod

▸ getLineStyle(): LineStyle

Return line style

LineStyle

lineStyle current line style

AnchoredHandle.getLineStyle

▸ getLocalTransform(): Transformation

Retrieves the transformation of bounds to parent

Transformation

transform the local transform.

AnchoredHandle.getLocalTransform

▸ getMarginsStyle(): SpaceStyle<string | number>

Return margins style

SpaceStyle<string | number>

AnchoredHandle.getMarginsStyle

▸ getName(): string

Returns the node name

string

The node name

AnchoredHandle.getName

▸ getOpacity(): number

Returns current node opacity

number

opacity

AnchoredHandle.getOpacity

▸ getOpacityBlendMode(): BlendMode

Returns current node opacity

BlendMode

opacity blend mode

AnchoredHandle.getOpacityBlendMode

▸ getOperationInfo(): any

Returns a json with information required to operate this handle. The information may be different for every adapter and defined by adapter itself

any

The Operation Info

AnchoredHandle.getOperationInfo

▸ getParent(): Node

Return parent node

Node

parent node

AnchoredHandle.getParent

▸ getParentHandle(): GhostBearingHandle

Gets the handle to which this ghost is associated

GhostBearingHandle

AnchoredHandle.getParentHandle

▸ getProperties(): OptionsOut

Gets properties pertaining to this handle

OptionsOut

properties

AnchoredHandle.getProperties

▸ getProperty(name): any

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

any

AnchoredHandle.getProperty

▸ getPropertyKeys(): string[]

Returns known properties keys

string[]

AnchoredHandle.getPropertyKeys

▸ getRenderingFilter(): IFilter

Return filter to be used for rendering and picking

IFilter

current filter

AnchoredHandle.getRenderingFilter

▸ getResponsiveStyle(): ResponsiveStyle

Return responsive style

ResponsiveStyle

AnchoredHandle.getResponsiveStyle

▸ getRoot(): Node

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

Node

the root node

AnchoredHandle.getRoot

▸ getScaleScrollStrategy(): Delegate

Gets scale scroll strategy

Delegate

scale scroll strategy

AnchoredHandle.getScaleScrollStrategy

▸ getSceneTransform(): Transformation

Returns transformation from node to root scene

Transformation

a transformation from node to root scene

AnchoredHandle.getSceneTransform

▸ getTag(): any

Returns the object associated with the node by user.

any

The node's user-object

AnchoredHandle.getTag

▸ getVisible(): boolean

Return visibility of the node

boolean

true if node is visible

AnchoredHandle.getVisible

▸ getWorldTransform(): Transformation

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

Transformation

transform the world transform.

AnchoredHandle.getWorldTransform

▸ getZIndex(): number

Returns node z-index (null if not set)

number

AnchoredHandle.getZIndex

▸ hasCssClass(cssClass): boolean

Check if node has specified css class

boolean

AnchoredHandle.hasCssClass

▸ hasEventListener(type, callback?): boolean

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

boolean

AnchoredHandle.hasEventListener

▸ hasGhost(): boolean

Returns true if a ghost has been initialized for this handle

boolean

AnchoredHandle.hasGhost

▸ invalidate(bounds?, force?): Handle

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

Handle

this

AnchoredHandle.invalidate

▸ invalidateParent(bounds?, force?): Handle

Invalidate bounds

Handle

this

AnchoredHandle.invalidateParent

▸ isActive(): boolean

Returns active state of this handle. Active state defines which style will be used when rendering the handle.

boolean

active Active state flag

AnchoredHandle.isActive

▸ isDisposed(): boolean

Returns whether this object has been disposed

boolean

AnchoredHandle.isDisposed

▸ isEventPropagationEnabled(): boolean

Return true if event propagation is enabled from child to parent

boolean

AnchoredHandle.isEventPropagationEnabled

▸ isGhost(): boolean

Returns true if this handle is a ghost

boolean

AnchoredHandle.isGhost

▸ isNotificationEnabled(): boolean

return state of notification

boolean

current notification state

AnchoredHandle.isNotificationEnabled

▸ isSelectable(): boolean

Returns true if node can be picked/selected.

boolean

The selectable flag

AnchoredHandle.isSelectable

▸ isSilent(): boolean

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

boolean

AnchoredHandle.isSilent

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

Notify listeners of the Node

Handle

this

AnchoredHandle.notify

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

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.

Handle

this

AnchoredHandle.off

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

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.

Handle

this

AnchoredHandle.on

▸ Protected onParentChanged(node): Handle

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

Handle

this

AnchoredHandle.onParentChanged

▸ Protected onVisibilityChanged(): void

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

void

AnchoredHandle.onVisibilityChanged

▸ Protected postRendering(context): void

To be called after rendering. Call this method if you override method render

void

AnchoredHandle.postRendering

▸ Protected preRendering(context): void

Occurs before rendering this method sets clipping by default. Call this method if you override method render

void

AnchoredHandle.preRendering

▸ registerAnimationStyle(root): void

Register animation style.

void

AnchoredHandle.registerAnimationStyle

▸ removeCssClass(cssclass): Handle

Removes css class from node

Handle

this

AnchoredHandle.removeCssClass

▸ removeGhost(): Handle

If a ghost exists, this method disposes the ghost

Handle

AnchoredHandle.removeGhost

▸ removeInvalidateHandler(handler): Handle

Remove invalidate handler

Deprecated

since 4.0, use Node.off instead

Handle

this

AnchoredHandle.removeInvalidateHandler

▸ render(context): void

Renders node

void

AnchoredHandle.render

▸ renderAsync(context, callback): void

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

void

AnchoredHandle.renderAsync

▸ resetGhost(): Handle

Resets ghost anchors and transformation to match the real handle

Handle

this

AnchoredHandle.resetGhost

▸ rotate(theta, x, y): Handle

Rotate bounds around a given coordinate

Handle

this

AnchoredHandle.rotate

▸ scale(xx, yy): Handle

Scale node

Handle

this

AnchoredHandle.scale

▸ setActive(active): Handle

Sets active state of this handle. Active state defines which style will be used when rendering the handle.

Handle

AnchoredHandle.setActive

▸ setActiveFillStyle(fillStyle, merge?): Handle

Sets fill style for active state

Handle

this

AnchoredHandle.setActiveFillStyle

▸ setActiveLineStyle(lineStyle, merge?): Handle

Sets line style for active state

Handle

this

AnchoredHandle.setActiveLineStyle

▸ setAdapter(adapter?): Handle

Sets current adapter of the real handle if this is a ghost, otherwise sets the adapter to this handle

Handle

this

AnchoredHandle.setAdapter

▸ setAnchor(anchor): Handle

Sets the point defining the anchor of this handle (coordinates of the symbol)

Handle

AnchoredHandle.setAnchor

▸ setAnimationStyle(animationStyle): Handle

Sets animation style

Handle

AnchoredHandle.setAnimationStyle

▸ setClipStyle(style): Handle

Sets a new clipping style

Handle

this

AnchoredHandle.setClipStyle

▸ setCss(style, merge?): Handle

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

Handle

this

AnchoredHandle.setCss

▸ setCssClass(name): Handle

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

Handle

this

AnchoredHandle.setCssClass

▸ setCssTransform(transform): Handle

Set CSS transformation

Handle

this

AnchoredHandle.setCssTransform

▸ setFillStyle(fillStyle, merge?): Handle

Sets fill style

Handle

this

AnchoredHandle.setFillStyle

▸ setGhostFillStyle(fillStyle, merge?): Handle

Sets fill style for ghost mode state

Handle

this

AnchoredHandle.setGhostFillStyle

▸ setGhostLineStyle(lineStyle, merge?): Handle

Set line style for ghost mode state

Handle

this

AnchoredHandle.setGhostLineStyle

▸ Protected setGhostMode(ghost): Handle

Sets a flag to this handle which specifies if it is currently a ghost, used internally

Handle

AnchoredHandle.setGhostMode

▸ setHandleSize(size): Handle

Sets the size of the handle. Size is defined in two dimensions and is rendered with respect to the anchor of this handle

Handle

AnchoredHandle.setHandleSize

▸ setId(id): Handle

Allows the user to associate any identifier

Handle

this

AnchoredHandle.setId

▸ setInactiveFillStyle(fillStyle, merge?): Handle

Sets fill style for inactive state

Handle

this

AnchoredHandle.setInactiveFillStyle

▸ setInactiveLineStyle(lineStyle, merge?): Handle

Sets line style for inactive state

Handle

this

AnchoredHandle.setInactiveLineStyle

▸ setLineStyle(lineStyle, merge?): Handle

Sets line style

Handle

this

AnchoredHandle.setLineStyle

▸ setLocalTransform(localTransform, force?): Handle

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

Handle

this

AnchoredHandle.setLocalTransform

▸ setMarginsStyle(margins, merge?): Handle

Sets margins style

Handle

this

AnchoredHandle.setMarginsStyle

▸ setName(name): Handle

Sets name of the node

Handle

this

AnchoredHandle.setName

▸ setNotification(notify, force?): Handle

set notification state

Handle

this

AnchoredHandle.setNotification

▸ setOpacity(opacity, blendMode?): Handle

Sets node opacity

Handle

this

AnchoredHandle.setOpacity

▸ setOperationInfo(operationInfo): Handle

Sets a json with information required to operate this handle. The information may be different for every adapter and defined by adapter itself

Handle

AnchoredHandle.setOperationInfo

▸ Protected setParentHandle(parent): Handle

Sets the handle to which this ghost is associated, used internally

Handle

AnchoredHandle.setParentHandle

▸ setProperties(props?): Handle

Gets properties pertaining to this handle

Handle

AnchoredHandle.setProperties

▸ setProperty(name, value): Handle

Sets dynamic property by name

Handle

this

AnchoredHandle.setProperty

▸ setRenderingFilter(filter): Handle

Sets filter to be applied before rendering and picking

Handle

this

AnchoredHandle.setRenderingFilter

▸ setResponsiveStyle(style): Handle

Sets responsive style.

Handle

this

AnchoredHandle.setResponsiveStyle

▸ setScaleScrollStrategy(strategy?): Handle

Sets scale scroll strategy

Handle

this

AnchoredHandle.setScaleScrollStrategy

▸ setSelectable(selectable): Handle

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

Handle

this

AnchoredHandle.setSelectable

▸ setSilent(bool): Handle

Set silent mode

Handle

this

AnchoredHandle.setSilent

▸ setTag(tag): Handle

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

Handle

this

AnchoredHandle.setTag

▸ setVisible(visible): Handle

Sets visibility of the handle and its ghost

Handle

AnchoredHandle.setVisible

▸ setZIndex(value): Handle

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

Handle

this

AnchoredHandle.setZIndex

▸ shear(shx, shy): Handle

Shear this node's bounds

Handle

this

AnchoredHandle.shear

▸ toString(): string

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

string

A string representation

AnchoredHandle.toString

▸ translate(tx, ty): Handle

Translate bounds

Handle

this

AnchoredHandle.translate

▸ unregisterAnimationStyle(root): void

Unregister animation style.

void

AnchoredHandle.unregisterAnimationStyle

▸ updateSceneTransformation(): Handle

Update scene transformation

Handle

this

AnchoredHandle.updateSceneTransformation

▸ updateState(regions?, changes?): Handle

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

Handle

this

AnchoredHandle.updateState

▸ Protected updateTimeStamp(): Handle

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

Handle

this

AnchoredHandle.updateTimeStamp

▸ Static enableSceneGraphNotification(enabled): void

Enable / disable all notifications

void

AnchoredHandle.enableSceneGraphNotification

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

Find root of the node with specified type