Class: AbstractHandle

• new AbstractHandle(options)

• Protected new AbstractHandle(options?)

Shape.constructor

▸ addCssClass(cssclass): AbstractHandle

Adds new css class to node

AbstractHandle

this

Shape.addCssClass

▸ addInvalidateHandler(handler): AbstractHandle

Add invalidate handler

Deprecated

since 4.0, use Node.on instead

AbstractHandle

this

Shape.addInvalidateHandler

▸ Protected applyOpacity(context): AbstractHandle

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

AbstractHandle

this

Shape.applyOpacity

▸ Protected applyResponsiveStyle(): void

Apply a responsive style rules it is exists

void

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

Shape.checkCollision

▸ clone(): Node

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

Node

clone

Shape.clone

▸ connectStyle(style, type, callback): AbstractHandle

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

AbstractHandle

this

Shape.connectStyle

▸ copyConstructor(src): AbstractHandle

Used for cloning

AbstractHandle

Shape.copyConstructor

▸ disconnectStyle(style, type, callback): AbstractHandle

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

AbstractHandle

this

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

Shape.dispose

▸ enableEventPropagation(enable): AbstractHandle

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

AbstractHandle

this

Shape.enableEventPropagation

▸ execute(delegate): AbstractHandle

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

AbstractHandle

The result if any or this

Shape.execute

▸ execute<T>(delegate): T

T

Shape.execute

▸ Protected filter(context): boolean

Filter node

boolean

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

Shape.filter

▸ getActiveFillStyle(): FillStyle

Return fill style for active state

FillStyle

fillStyle current fill style

▸ getActiveLineStyle(): LineStyle

Return line style for inactive state

LineStyle

gets current active line style

▸ getAdapter(): ShapeAdapter<Node>

Returns the adapter which owns this handle.

ShapeAdapter<Node>

The owner adapter

▸ getAnimationStyle(): AnimationStyle

Return animation style

AnimationStyle

animationStyle current animation style

Shape.getAnimationStyle

▸ getClassName(): string

string

Shape.getClassName

▸ getClipStyle(): ClipStyle

Gets the current clipping style

ClipStyle

clipping style

Shape.getClipStyle

▸ getCss(): CssStyle

Return CSS style

CssStyle

Shape.getCss

▸ getCssClass(): string

Returns css class name to be used to apply CSS style

string

the css class name

Shape.getCssClass

▸ getCssClasses(): string[]

Gets list of css class names which applied to this node

string[]

Shape.getCssClasses

▸ getCssTransform(): string

Returns CSS transformation

string

Shape.getCssTransform

▸ getFillStyle(): FillStyle

Return fill style

FillStyle

fillStyle current fill style

Shape.getFillStyle

▸ getId(): string | number

Returns the associated identifier of the node

string | number

The node's id

Shape.getId

▸ getInactiveFillStyle(): FillStyle

Return fill style for inactive state

FillStyle

fillStyle current fill style

▸ getInactiveLineStyle(): LineStyle

Return fill style for inactive state

LineStyle

gets current inactive line style

▸ Protected getInvalidateMethod(): AttributeCallback<EventDispatcher>

Gets invalidate method

AttributeCallback<EventDispatcher>

method to invalidate this object

Shape.getInvalidateMethod

▸ getLineStyle(): LineStyle

Return line style

LineStyle

lineStyle current line style

Shape.getLineStyle

▸ getLocalTransform(): Transformation

Retrieves the transformation of bounds to parent

Transformation

transform the local transform.

Shape.getLocalTransform

▸ getMarginsStyle(): SpaceStyle<string | number>

Return margins style

SpaceStyle<string | number>

Shape.getMarginsStyle

▸ getName(): string

Returns the node name

string

The node name

Shape.getName

▸ getOpacity(): number

Returns current node opacity

number

opacity

Shape.getOpacity

▸ getOpacityBlendMode(): BlendMode

Returns current node opacity

BlendMode

opacity blend mode

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

▸ getParent(): Node

Return parent node

Node

parent node

Shape.getParent

▸ getProperties(): OptionsOut

Gets properties pertaining to this handle

OptionsOut

Shape.getProperties

▸ getProperty(name): any

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

any

Shape.getProperty

▸ getPropertyKeys(): string[]

Returns known properties keys

string[]

Shape.getPropertyKeys

▸ getRenderingFilter(): IFilter

Return filter to be used for rendering and picking

IFilter

current filter

Shape.getRenderingFilter

▸ getResponsiveStyle(): ResponsiveStyle

Return responsive style

ResponsiveStyle

Shape.getResponsiveStyle

▸ getRoot(): Node

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

Node

the root node

Shape.getRoot

▸ getScaleScrollStrategy(): Delegate

Gets scale scroll strategy

Delegate

scale scroll strategy

Shape.getScaleScrollStrategy

▸ getSceneTransform(): Transformation

Returns transformation from node to root scene

Transformation

a transformation from node to root scene

Shape.getSceneTransform

▸ getTag(): any

Returns the object associated with the node by user.

any

The node's user-object

Shape.getTag

▸ getVisible(): boolean

Return visibility of the node

boolean

true if node is visible

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

Shape.getWorldTransform

▸ getZIndex(): number

Returns node z-index (null if not set)

number

Shape.getZIndex

▸ hasCssClass(cssClass): boolean

Check if node has specified css class

boolean

Shape.hasCssClass

▸ hasEventListener(type, callback?): boolean

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

boolean

Shape.hasEventListener

▸ invalidate(bounds?, force?): AbstractHandle

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

AbstractHandle

this

Shape.invalidate

▸ invalidateParent(bounds?, force?): AbstractHandle

Invalidate bounds

AbstractHandle

this

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

▸ isDisposed(): boolean

Returns whether this object has been disposed

boolean

Shape.isDisposed

▸ isEventPropagationEnabled(): boolean

Return true if event propagation is enabled from child to parent

boolean

Shape.isEventPropagationEnabled

▸ isNotificationEnabled(): boolean

return state of notification

boolean

current notification state

Shape.isNotificationEnabled

▸ isSelectable(): boolean

Returns true if node can be picked/selected.

boolean

The selectable flag

Shape.isSelectable

▸ isSilent(): boolean

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

boolean

Shape.isSilent

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

Notify listeners of the Node

AbstractHandle

this

Shape.notify

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

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.

AbstractHandle

this

Shape.off

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

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.

AbstractHandle

this

Shape.on

▸ Protected onParentChanged(node): AbstractHandle

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

AbstractHandle

this

Shape.onParentChanged

▸ Protected onVisibilityChanged(): void

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

void

Shape.onVisibilityChanged

▸ Protected postRendering(context): void

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

void

Shape.postRendering

▸ Protected preRendering(context): void

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

void

Shape.preRendering

▸ registerAnimationStyle(root): void

Register animation style.

void

Shape.registerAnimationStyle

▸ removeCssClass(cssclass): AbstractHandle

Removes css class from node

AbstractHandle

this

Shape.removeCssClass

▸ removeInvalidateHandler(handler): AbstractHandle

Remove invalidate handler

Deprecated

since 4.0, use Node.off instead

AbstractHandle

this

Shape.removeInvalidateHandler

▸ Abstract render(context): void

Renders node

void

Shape.render

▸ renderAsync(context, callback): void

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

void

Shape.renderAsync

▸ rotate(theta, x, y): AbstractHandle

Rotate bounds around a given coordinate

AbstractHandle

this

Shape.rotate

▸ scale(xx, yy): AbstractHandle

Scale node

AbstractHandle

this

Shape.scale

▸ setActive(active): AbstractHandle

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

AbstractHandle

▸ setActiveFillStyle(fillStyle, merge?): AbstractHandle

Sets fill style for active state

AbstractHandle

this

▸ setActiveLineStyle(lineStyle, merge?): AbstractHandle

Sets line style for active state

AbstractHandle

this

▸ setAdapter(adapter): AbstractHandle

Sets the adapter which owns this handle.

AbstractHandle

▸ setAnimationStyle(animationStyle): AbstractHandle

Sets animation style

AbstractHandle

Shape.setAnimationStyle

▸ setClipStyle(style): AbstractHandle

Sets a new clipping style

AbstractHandle

this

Shape.setClipStyle

▸ setCss(style, merge?): AbstractHandle

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

AbstractHandle

this

Shape.setCss

▸ setCssClass(name): AbstractHandle

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

AbstractHandle

this

Shape.setCssClass

▸ setCssTransform(transform): AbstractHandle

Set CSS transformation

AbstractHandle

this

Shape.setCssTransform

▸ setFillStyle(fillStyle, merge?): AbstractHandle

Sets fill style

AbstractHandle

this

Shape.setFillStyle

▸ setId(id): AbstractHandle

Allows the user to associate any identifier

AbstractHandle

this

Shape.setId

▸ setInactiveFillStyle(fillStyle, merge?): AbstractHandle

Sets fill style for inactive state

AbstractHandle

this

▸ setInactiveLineStyle(lineStyle, merge?): AbstractHandle

Sets line style for inactive state

AbstractHandle

this

▸ setLineStyle(lineStyle, merge?): AbstractHandle

Sets line style

AbstractHandle

this

Shape.setLineStyle

▸ setLocalTransform(localTransform, force?): AbstractHandle

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

AbstractHandle

this

Shape.setLocalTransform

▸ setMarginsStyle(margins, merge?): AbstractHandle

Sets margins style

AbstractHandle

this

Shape.setMarginsStyle

▸ setName(name): AbstractHandle

Sets name of the node

AbstractHandle

this

Shape.setName

▸ setNotification(notify, force?): AbstractHandle

set notification state

AbstractHandle

this

Shape.setNotification

▸ setOpacity(opacity, blendMode?): AbstractHandle

Sets node opacity

AbstractHandle

this

Shape.setOpacity

▸ setOperationInfo(operationInfo): AbstractHandle

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

AbstractHandle

▸ setProperties(props?): AbstractHandle

Sets properties pertaining to this object

AbstractHandle

this

Shape.setProperties

▸ setProperty(name, value): AbstractHandle

Sets dynamic property by name

AbstractHandle

this

Shape.setProperty

▸ setRenderingFilter(filter): AbstractHandle

Sets filter to be applied before rendering and picking

AbstractHandle

this

Shape.setRenderingFilter

▸ setResponsiveStyle(style): AbstractHandle

Sets responsive style.

AbstractHandle

this

Shape.setResponsiveStyle

▸ setScaleScrollStrategy(strategy?): AbstractHandle

Sets scale scroll strategy

AbstractHandle

this

Shape.setScaleScrollStrategy

▸ setSelectable(selectable): AbstractHandle

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

AbstractHandle

this

Shape.setSelectable

▸ setSilent(bool): AbstractHandle

Set silent mode

AbstractHandle

this

Shape.setSilent

▸ setTag(tag): AbstractHandle

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

AbstractHandle

this

Shape.setTag

▸ setVisible(value): AbstractHandle

Sets visibility of the node. Send event Events.VisibilityChanged

AbstractHandle

this

Shape.setVisible

▸ setZIndex(value): AbstractHandle

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

AbstractHandle

this

Shape.setZIndex

▸ shear(shx, shy): AbstractHandle

Shear this node's bounds

AbstractHandle

this

Shape.shear

▸ toString(): string

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

string

A string representation

Shape.toString

▸ translate(tx, ty): AbstractHandle

Translate bounds

AbstractHandle

this

Shape.translate

▸ unregisterAnimationStyle(root): void

Unregister animation style.

void

Shape.unregisterAnimationStyle

▸ updateSceneTransformation(): AbstractHandle

Update scene transformation

AbstractHandle

this

Shape.updateSceneTransformation

▸ updateState(regions?, changes?): AbstractHandle

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

AbstractHandle

this

Shape.updateState

▸ Protected updateTimeStamp(): AbstractHandle

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

AbstractHandle

this

Shape.updateTimeStamp

▸ Static enableSceneGraphNotification(enabled): void

Enable / disable all notifications

void

Shape.enableSceneGraphNotification

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

Find root of the node with specified type

InstanceType<T>

Shape.findParent

▸ Static findParent(node, classType, filter?): Node

Find root of the node with specified type

Node

Shape.findParent

▸ Static getClassName(): string

string

Shape.getClassName

▸ Static intersectsBounds(bounds, localTransformation, parentInvalidArea, expand?): boolean

Check collision of the shape bounds with parent invalid area

boolean

true if bounds intersect the invalid area

Shape.intersectsBounds

▸ Static isSceneGraphNotificationEnabled(): boolean

Return status of the global notification for all nodes.

boolean

Shape.isSceneGraphNotificationEnabled