Class: Arrow

• new Arrow(from?, to?, visible?, symbolStart?, symbolEnd?, linestyle?)

Line.constructor

• new Arrow(options?)

Line.constructor

▸ addCssClass(cssclass): Arrow

Adds new css class to node

Arrow

this

Line.addCssClass

▸ addInvalidateHandler(handler): Arrow

Add invalidate handler

Deprecated

since 4.0, use Node.on instead

Arrow

this

Line.addInvalidateHandler

▸ Protected applyOpacity(context): Arrow

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

Arrow

this

Line.applyOpacity

▸ Protected applyResponsiveStyle(): void

Apply a responsive style rules it is exists

void

Line.applyResponsiveStyle

▸ checkCollision(context): boolean

Check collision

boolean

true if object is inside of rendering area

Line.checkCollision

▸ clone(): Line

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

Line

clone

Line.clone

▸ connectStyle(style, type, callback): Arrow

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

Arrow

this

Line.connectStyle

▸ Protected copyConstructor(src): Arrow

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

Arrow

this

Line.copyConstructor

▸ disconnectStyle(style, type, callback): Arrow

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

Arrow

this

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

Line.dispose

▸ enableEventPropagation(enable): Arrow

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

Arrow

this

Line.enableEventPropagation

▸ execute(delegate): Arrow

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

Arrow

The result if any or this

Line.execute

▸ execute<T>(delegate): T

T

Line.execute

▸ Protected filter(context): boolean

Filter node

boolean

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

Line.filter

▸ getAnimationStyle(): AnimationStyle

Return animation style

AnimationStyle

animationStyle current animation style

Line.getAnimationStyle

▸ getBounds(): Rect

Return bounding box of this line.

Rect

bounds.

Line.getBounds

▸ getClassName(): string

string

Line.getClassName

▸ getClipStyle(): ClipStyle

Gets the current clipping style

ClipStyle

clipping style

Line.getClipStyle

▸ getCss(): CssStyle

Return CSS style

CssStyle

Line.getCss

▸ getCssClass(): string

Returns css class name to be used to apply CSS style

string

the css class name

Line.getCssClass

▸ getCssClasses(): string[]

Gets list of css class names which applied to this node

string[]

Line.getCssClasses

▸ getCssTransform(): string

Returns CSS transformation

string

Line.getCssTransform

▸ getFillStyle(): FillStyle

Return fill style

FillStyle

fillStyle current fill style

Line.getFillStyle

▸ getFrom(): Point

returns from point

Point

Line.getFrom

▸ getHeads(): Heads

Returns arrow heads

Heads

heads the type of ends that this arrow had

▸ getId(): string | number

Returns the associated identifier of the node

string | number

The node's id

Line.getId

▸ Protected getInvalidateMethod(): AttributeCallback<EventDispatcher>

Gets invalidate method

AttributeCallback<EventDispatcher>

method to invalidate this object

Line.getInvalidateMethod

▸ getLineDecoration(): ILineDecoration

Return Line Decoration Style

ILineDecoration

Line.getLineDecoration

▸ getLineStyle(): LineStyle

Return line style

LineStyle

lineStyle current line style

Line.getLineStyle

▸ getLocalTransform(): Transformation

Retrieves the transformation of bounds to parent

Transformation

transform the local transform.

Line.getLocalTransform

▸ getMarginsStyle(): SpaceStyle<string | number>

Return margins style

SpaceStyle<string | number>

Line.getMarginsStyle

▸ getName(): string

Returns the node name

string

The node name

Line.getName

▸ getOpacity(): number

Returns current node opacity

number

opacity

Line.getOpacity

▸ getOpacityBlendMode(): BlendMode

Returns current node opacity

BlendMode

opacity blend mode

Line.getOpacityBlendMode

▸ getParent(): Node

Return parent node

Node

parent node

Line.getParent

▸ getProperties(): OptionsOut

Gets all the properties pertaining to this object

OptionsOut

properties

Line.getProperties

▸ getProperty(name): any

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

any

Line.getProperty

▸ getPropertyKeys(): string[]

Returns known properties keys

string[]

Line.getPropertyKeys

▸ getRenderingFilter(): IFilter

Return filter to be used for rendering and picking

IFilter

current filter

Line.getRenderingFilter

▸ getResponsiveStyle(): ResponsiveStyle

Return responsive style

ResponsiveStyle

Line.getResponsiveStyle

▸ getRoot(): Node

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

Node

the root node

Line.getRoot

▸ getScaleScrollStrategy(): Delegate

Gets scale scroll strategy

Delegate

scale scroll strategy

Line.getScaleScrollStrategy

▸ getSceneTransform(): Transformation

Returns transformation from node to root scene

Transformation

a transformation from node to root scene

Line.getSceneTransform

▸ getSymbolEnd(): SymbolShape

Returns arrow end symbol

SymbolShape

symbol

▸ getSymbolStart(): SymbolShape

Returns arrow start symbol

SymbolShape

symbol

▸ getTag(): any

Returns the object associated with the node by user.

any

The node's user-object

Line.getTag

▸ getTo(): Point

returns to point

Point

Line.getTo

▸ getVisible(): boolean

Return visibility of the node

boolean

true if node is visible

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

Line.getWorldTransform

▸ getZIndex(): number

Returns node z-index (null if not set)

number

Line.getZIndex

▸ hasCssClass(cssClass): boolean

Check if node has specified css class

boolean

Line.hasCssClass

▸ hasEventListener(type, callback?): boolean

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

boolean

Line.hasEventListener

▸ invalidate(bounds?, force?): Arrow

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

Arrow

this

Line.invalidate

▸ invalidateParent(bounds?, force?): Arrow

Invalidate bounds

Arrow

this

Line.invalidateParent

▸ isDisposed(): boolean

Returns whether this object has been disposed

boolean

Line.isDisposed

▸ isEventPropagationEnabled(): boolean

Return true if event propagation is enabled from child to parent

boolean

Line.isEventPropagationEnabled

▸ isNotificationEnabled(): boolean

return state of notification

boolean

current notification state

Line.isNotificationEnabled

▸ isSelectable(): boolean

Returns true if node can be picked/selected.

boolean

The selectable flag

Line.isSelectable

▸ isSilent(): boolean

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

boolean

Line.isSilent

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

Notify listeners of the Node

Arrow

this

Line.notify

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

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.

Arrow

this

Line.off

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

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.

Arrow

this

Line.on

▸ Protected onParentChanged(node): Arrow

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

Arrow

this

Line.onParentChanged

▸ Protected onVisibilityChanged(): void

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

void

Line.onVisibilityChanged

▸ Protected postRendering(context): void

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

void

Line.postRendering

▸ Protected preRendering(context): void

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

void

Line.preRendering

▸ registerAnimationStyle(root): void

Register animation style.

void

Line.registerAnimationStyle

▸ removeCssClass(cssclass): Arrow

Removes css class from node

Arrow

this

Line.removeCssClass

▸ removeInvalidateHandler(handler): Arrow

Remove invalidate handler

Deprecated

since 4.0, use Node.off instead

Arrow

this

Line.removeInvalidateHandler

▸ render(context): void

Renders node

void

Line.render

▸ renderAsync(context, callback): void

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

void

Line.renderAsync

▸ rotate(theta, x, y): Arrow

Rotate bounds around a given coordinate

Arrow

this

Line.rotate

▸ scale(xx, yy): Arrow

Scale node

Arrow

this

Line.scale

▸ setAnimationStyle(animationStyle): Arrow

Sets animation style

Arrow

Line.setAnimationStyle

▸ setClipStyle(style): Arrow

Sets a new clipping style

Arrow

this

Line.setClipStyle

▸ setCss(style, merge?): Arrow

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

Arrow

this

Line.setCss

▸ setCssClass(name): Arrow

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

Arrow

this

Line.setCssClass

▸ setCssTransform(transform): Arrow

Set CSS transformation

Arrow

this

Line.setCssTransform

▸ setFillStyle(fillStyle, merge?): Arrow

Sets fill style

Arrow

this

Line.setFillStyle

▸ setHeads(heads): Arrow

Set heads

Arrow

this

▸ setId(id): Arrow

Allows the user to associate any identifier

Arrow

this

Line.setId

▸ setLine(line): Arrow

Set line positions

Arrow

this

Line.setLine

▸ setLineDecoration(lineDecoration): Arrow

Specify Line Decoration style

Arrow

this

Line.setLineDecoration

▸ setLineStyle(lineStyle, merge?): Arrow

Sets line style

Arrow

this

Line.setLineStyle

▸ setLocalTransform(localTransform, force?): Arrow

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

Arrow

this

Line.setLocalTransform

▸ setMarginsStyle(margins, merge?): Arrow

Sets margins style

Arrow

this

Line.setMarginsStyle

▸ setName(name): Arrow

Sets name of the node

Arrow

this

Line.setName

▸ setNotification(notify, force?): Arrow

set notification state

Arrow

this

Line.setNotification

▸ setOpacity(opacity, blendMode?): Arrow

Sets node opacity

Arrow

this

Line.setOpacity

▸ setProperties(properties?): Arrow

Sets all the properties pertaining to this object

Arrow

Line.setProperties

▸ setProperty(name, value): Arrow

Sets dynamic property by name

Arrow

this

Line.setProperty

▸ setRenderingFilter(filter): Arrow

Sets filter to be applied before rendering and picking

Arrow

this

Line.setRenderingFilter

▸ setResponsiveStyle(style): Arrow

Sets responsive style.

Arrow

this

Line.setResponsiveStyle

▸ setScaleScrollStrategy(strategy?): Arrow

Sets scale scroll strategy

Arrow

this

Line.setScaleScrollStrategy

▸ setSelectable(selectable): Arrow

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

Arrow

this

Line.setSelectable

▸ setSilent(bool): Arrow

Set silent mode

Arrow

this

Line.setSilent

▸ setSymbol(symbol): Arrow

Sets the symbol to be drawn at both ends of the arrow

Arrow

this

▸ setSymbolEnd(symbol): Arrow

Sets the symbol to be drawn at the end of the arrow

Arrow

this

▸ setSymbolStart(symbol): Arrow

Sets the symbol to be drawn at the start of the arrow

Arrow

this

▸ setTag(tag): Arrow

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

Arrow

this

Line.setTag

▸ setVisible(value): Arrow

Sets visibility of the node. Send event Events.VisibilityChanged

Arrow

this

Line.setVisible

▸ setZIndex(value): Arrow

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

Arrow

this

Line.setZIndex

▸ shear(shx, shy): Arrow

Shear this node's bounds

Arrow

this

Line.shear

▸ toString(): string

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

string

A string representation

Line.toString

▸ translate(tx, ty): Arrow

Translate bounds

Arrow

this

Line.translate

▸ unregisterAnimationStyle(root): void

Unregister animation style.

void

Line.unregisterAnimationStyle

▸ updateBounds(): Arrow

Update bounds

Arrow

this

Line.updateBounds

▸ updateSceneTransformation(): Arrow

Update scene transformation

Arrow

this

Line.updateSceneTransformation

▸ updateState(regions?, changes?): Arrow

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

Arrow

this

Line.updateState

▸ Protected updateTimeStamp(): Arrow

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

Arrow

this

Line.updateTimeStamp

▸ Static enableSceneGraphNotification(enabled): void

Enable / disable all notifications

void

Line.enableSceneGraphNotification

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

Find root of the node with specified type

InstanceType<T>

Line.findParent

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

Find root of the node with specified type

Node

Line.findParent

▸ Static getClassName(): string

string

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

Line.intersectsBounds

▸ Static isSceneGraphNotificationEnabled(): boolean

Return status of the global notification for all nodes.

boolean

Line.isSceneGraphNotificationEnabled