Class: LineBox

• new LineBox(params?)

Line box

GhostBearingHandle.constructor

• new LineBox(x1?, y1?, x2?, y2?)

Line box

GhostBearingHandle.constructor

▸ addCssClass(cssclass): LineBox

Adds new css class to node

LineBox

this

GhostBearingHandle.addCssClass

▸ addInvalidateHandler(handler): LineBox

Add invalidate handler

Deprecated

since 4.0, use Node.on instead

LineBox

this

GhostBearingHandle.addInvalidateHandler

▸ Protected applyOpacity(context): LineBox

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

LineBox

this

GhostBearingHandle.applyOpacity

▸ Protected applyResponsiveStyle(): void

Apply a responsive style rules it is exists

void

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

GhostBearingHandle.checkCollision

▸ clone(): Node

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

Node

clone

GhostBearingHandle.clone

▸ connectStyle(style, type, callback): LineBox

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

LineBox

this

GhostBearingHandle.connectStyle

▸ copyConstructor(src): LineBox

Used for cloning

LineBox

GhostBearingHandle.copyConstructor

▸ createGhost(): GhostBearingHandle

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

GhostBearingHandle

GhostBearingHandle.createGhost

▸ disconnectStyle(style, type, callback): LineBox

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

LineBox

this

GhostBearingHandle.disconnectStyle

▸ dispose(): void

Disposes this handle, Clear all listeners and remove the ghost

void

GhostBearingHandle.dispose

▸ enableEventPropagation(enable): LineBox

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

LineBox

this

GhostBearingHandle.enableEventPropagation

▸ execute(delegate): LineBox

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

LineBox

The result if any or this

GhostBearingHandle.execute

▸ execute<T>(delegate): T

T

GhostBearingHandle.execute

▸ Protected filter(context): boolean

Filter node

boolean

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

GhostBearingHandle.filter

▸ getActiveFillStyle(): FillStyle

Return fill style for active state

FillStyle

fillStyle current fill style

GhostBearingHandle.getActiveFillStyle

▸ getActiveLineStyle(): LineStyle

Return line style for inactive state

LineStyle

gets current active line style

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

GhostBearingHandle.getAdapter

▸ getAnimationStyle(): AnimationStyle

Return animation style

AnimationStyle

animationStyle current animation style

GhostBearingHandle.getAnimationStyle

▸ getClassName(): string

string

GhostBearingHandle.getClassName

▸ getClipStyle(): ClipStyle

Gets the current clipping style

ClipStyle

clipping style

GhostBearingHandle.getClipStyle

▸ getCss(): CssStyle

Return CSS style

CssStyle

GhostBearingHandle.getCss

▸ getCssClass(): string

Returns css class name to be used to apply CSS style

string

the css class name

GhostBearingHandle.getCssClass

▸ getCssClasses(): string[]

Gets list of css class names which applied to this node

string[]

GhostBearingHandle.getCssClasses

▸ getCssTransform(): string

Returns CSS transformation

string

GhostBearingHandle.getCssTransform

▸ getFillStyle(): FillStyle

Return fill style

FillStyle

fillStyle current fill style

GhostBearingHandle.getFillStyle

▸ getFrom(): Point

Returns the point defining "From" coordinate of the line

Point

▸ getGhost(): GhostBearingHandle

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

GhostBearingHandle

GhostBearingHandle.getGhost

▸ getGhostFillStyle(): FillStyle

Return fill style for ghost mode state

FillStyle

fillStyle current ghost fill style

GhostBearingHandle.getGhostFillStyle

▸ getGhostLineStyle(): LineStyle

Return line style for ghost mode stat

LineStyle

gets current ghost line style

GhostBearingHandle.getGhostLineStyle

▸ getId(): string | number

Returns the associated identifier of the node

string | number

The node's id

GhostBearingHandle.getId

▸ getInactiveFillStyle(): FillStyle

Return fill style for inactive state

FillStyle

fillStyle current fill style

GhostBearingHandle.getInactiveFillStyle

▸ getInactiveLineStyle(): LineStyle

Return fill style for inactive state

LineStyle

gets current inactive line style

GhostBearingHandle.getInactiveLineStyle

▸ Protected getInvalidateMethod(): AttributeCallback<EventDispatcher>

Gets invalidate method

AttributeCallback<EventDispatcher>

method to invalidate this object

GhostBearingHandle.getInvalidateMethod

▸ getLineStyle(): LineStyle

Return line style

LineStyle

lineStyle current line style

GhostBearingHandle.getLineStyle

▸ getLocalTransform(): Transformation

Retrieves the transformation of bounds to parent

Transformation

transform the local transform.

GhostBearingHandle.getLocalTransform

▸ getMarginsStyle(): SpaceStyle<string | number>

Return margins style

SpaceStyle<string | number>

GhostBearingHandle.getMarginsStyle

▸ getName(): string

Returns the node name

string

The node name

GhostBearingHandle.getName

▸ getOpacity(): number

Returns current node opacity

number

opacity

GhostBearingHandle.getOpacity

▸ getOpacityBlendMode(): BlendMode

Returns current node opacity

BlendMode

opacity blend mode

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

GhostBearingHandle.getOperationInfo

▸ getParent(): Node

Return parent node

Node

parent node

GhostBearingHandle.getParent

▸ getParentHandle(): GhostBearingHandle

Gets the handle to which this ghost is associated

GhostBearingHandle

GhostBearingHandle.getParentHandle

▸ getProperties(): OptionsOut

Gets properties pertaining to this handle

OptionsOut

GhostBearingHandle.getProperties

▸ getProperty(name): any

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

any

GhostBearingHandle.getProperty

▸ getPropertyKeys(): string[]

Returns known properties keys

string[]

GhostBearingHandle.getPropertyKeys

▸ getRenderingFilter(): IFilter

Return filter to be used for rendering and picking

IFilter

current filter

GhostBearingHandle.getRenderingFilter

▸ getResponsiveStyle(): ResponsiveStyle

Return responsive style

ResponsiveStyle

GhostBearingHandle.getResponsiveStyle

▸ getRoot(): Node

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

Node

the root node

GhostBearingHandle.getRoot

▸ getScaleScrollStrategy(): Delegate

Gets scale scroll strategy

Delegate

scale scroll strategy

GhostBearingHandle.getScaleScrollStrategy

▸ getSceneTransform(): Transformation

Returns transformation from node to root scene

Transformation

a transformation from node to root scene

GhostBearingHandle.getSceneTransform

▸ getTag(): any

Returns the object associated with the node by user.

any

The node's user-object

GhostBearingHandle.getTag

▸ getTo(): Point

Returns the point defining "To" coordinate of the line

Point

▸ getVisible(): boolean

Return visibility of the node

boolean

true if node is visible

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

GhostBearingHandle.getWorldTransform

▸ getZIndex(): number

Returns node z-index (null if not set)

number

GhostBearingHandle.getZIndex

▸ hasCssClass(cssClass): boolean

Check if node has specified css class

boolean

GhostBearingHandle.hasCssClass

▸ hasEventListener(type, callback?): boolean

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

boolean

GhostBearingHandle.hasEventListener

▸ hasGhost(): boolean

Returns true if a ghost has been initialized for this handle

boolean

GhostBearingHandle.hasGhost

▸ invalidate(bounds?, force?): LineBox

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

LineBox

this

GhostBearingHandle.invalidate

▸ invalidateParent(bounds?, force?): LineBox

Invalidate bounds

LineBox

this

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

GhostBearingHandle.isActive

▸ isDisposed(): boolean

Returns whether this object has been disposed

boolean

GhostBearingHandle.isDisposed

▸ isEventPropagationEnabled(): boolean

Return true if event propagation is enabled from child to parent

boolean

GhostBearingHandle.isEventPropagationEnabled

▸ isGhost(): boolean

Returns true if this handle is a ghost

boolean

GhostBearingHandle.isGhost

▸ isNotificationEnabled(): boolean

return state of notification

boolean

current notification state

GhostBearingHandle.isNotificationEnabled

▸ isSelectable(): boolean

Returns true if node can be picked/selected.

boolean

The selectable flag

GhostBearingHandle.isSelectable

▸ isSilent(): boolean

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

boolean

GhostBearingHandle.isSilent

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

Notify listeners of the Node

LineBox

this

GhostBearingHandle.notify

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

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.

LineBox

this

GhostBearingHandle.off

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

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.

LineBox

this

GhostBearingHandle.on

▸ Protected onParentChanged(node): LineBox

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

LineBox

this

GhostBearingHandle.onParentChanged

▸ Protected onVisibilityChanged(): void

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

void

GhostBearingHandle.onVisibilityChanged

▸ Protected postRendering(context): void

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

void

GhostBearingHandle.postRendering

▸ Protected preRendering(context): void

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

void

GhostBearingHandle.preRendering

▸ registerAnimationStyle(root): void

Register animation style.

void

GhostBearingHandle.registerAnimationStyle

▸ removeCssClass(cssclass): LineBox

Removes css class from node

LineBox

this

GhostBearingHandle.removeCssClass

▸ removeGhost(): LineBox

If a ghost exists, this method disposes the ghost

LineBox

GhostBearingHandle.removeGhost

▸ removeInvalidateHandler(handler): LineBox

Remove invalidate handler

Deprecated

since 4.0, use Node.off instead

LineBox

this

GhostBearingHandle.removeInvalidateHandler

▸ render(context): void

Renders node

void

GhostBearingHandle.render

▸ renderAsync(context, callback): void

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

void

GhostBearingHandle.renderAsync

▸ resetGhost(): LineBox

Resets ghost anchors and transformation to match the real handle

LineBox

this

GhostBearingHandle.resetGhost

▸ rotate(theta, x, y): LineBox

Rotate bounds around a given coordinate

LineBox

this

GhostBearingHandle.rotate

▸ scale(xx, yy): LineBox

Scale node

LineBox

this

GhostBearingHandle.scale

▸ setActive(active): LineBox

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

LineBox

GhostBearingHandle.setActive

▸ setActiveFillStyle(fillStyle, merge?): LineBox

Sets fill style for active state

LineBox

this

GhostBearingHandle.setActiveFillStyle

▸ setActiveLineStyle(lineStyle, merge?): LineBox

Sets line style for active state

LineBox

this

GhostBearingHandle.setActiveLineStyle

▸ setAdapter(adapter?): LineBox

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

LineBox

this

GhostBearingHandle.setAdapter

▸ setAnchor(anchor): LineBox

Changes the line to match its center point with the provided point. Length remains the same

LineBox

this

▸ setAnimationStyle(animationStyle): LineBox

Sets animation style

LineBox

GhostBearingHandle.setAnimationStyle

▸ setClipStyle(style): LineBox

Sets a new clipping style

LineBox

this

GhostBearingHandle.setClipStyle

▸ setCss(style, merge?): LineBox

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

LineBox

this

GhostBearingHandle.setCss

▸ setCssClass(name): LineBox

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

LineBox

this

GhostBearingHandle.setCssClass

▸ setCssTransform(transform): LineBox

Set CSS transformation

LineBox

this

GhostBearingHandle.setCssTransform

▸ setFillStyle(fillStyle, merge?): LineBox

Sets fill style

LineBox

this

GhostBearingHandle.setFillStyle

▸ setGhostFillStyle(fillStyle, merge?): LineBox

Sets fill style for ghost mode state

LineBox

this

GhostBearingHandle.setGhostFillStyle

▸ setGhostLineStyle(lineStyle, merge?): LineBox

Set line style for ghost mode state

LineBox

this

GhostBearingHandle.setGhostLineStyle

▸ Protected setGhostMode(ghost): LineBox

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

LineBox

GhostBearingHandle.setGhostMode

▸ setId(id): LineBox

Allows the user to associate any identifier

LineBox

this

GhostBearingHandle.setId

▸ setInactiveFillStyle(fillStyle, merge?): LineBox

Sets fill style for inactive state

LineBox

this

GhostBearingHandle.setInactiveFillStyle

▸ setInactiveLineStyle(lineStyle, merge?): LineBox

Sets line style for inactive state

LineBox

this

GhostBearingHandle.setInactiveLineStyle

▸ setLine(point1, point2?): LineBox

Sets two points defining the line, or one of the edges

LineBox

this

▸ setLineStyle(lineStyle, merge?): LineBox

Sets line style

LineBox

this

GhostBearingHandle.setLineStyle

▸ setLocalTransform(localTransform, force?): LineBox

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

LineBox

this

GhostBearingHandle.setLocalTransform

▸ setMarginsStyle(margins, merge?): LineBox

Sets margins style

LineBox

this

GhostBearingHandle.setMarginsStyle

▸ setName(name): LineBox

Sets name of the node

LineBox

this

GhostBearingHandle.setName

▸ setNotification(notify, force?): LineBox

set notification state

LineBox

this

GhostBearingHandle.setNotification

▸ setOpacity(opacity, blendMode?): LineBox

Sets node opacity

LineBox

this

GhostBearingHandle.setOpacity

▸ setOperationInfo(operationInfo): LineBox

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

LineBox

GhostBearingHandle.setOperationInfo

▸ Protected setParentHandle(parent): LineBox

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

LineBox

GhostBearingHandle.setParentHandle

▸ setProperties(props?): LineBox

Sets properties pertaining to this object

LineBox

this

GhostBearingHandle.setProperties

▸ setProperty(name, value): LineBox

Sets dynamic property by name

LineBox

this

GhostBearingHandle.setProperty

▸ setRenderingFilter(filter): LineBox

Sets filter to be applied before rendering and picking

LineBox

this

GhostBearingHandle.setRenderingFilter

▸ setResponsiveStyle(style): LineBox

Sets responsive style.

LineBox

this

GhostBearingHandle.setResponsiveStyle

▸ setScaleScrollStrategy(strategy?): LineBox

Sets scale scroll strategy

LineBox

this

GhostBearingHandle.setScaleScrollStrategy

▸ setSelectable(selectable): LineBox

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

LineBox

this

GhostBearingHandle.setSelectable

▸ setSilent(bool): LineBox

Set silent mode

LineBox

this

GhostBearingHandle.setSilent

▸ setTag(tag): LineBox

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

LineBox

this

GhostBearingHandle.setTag

▸ setVisible(visible): LineBox

Sets visibility of the handle and its ghost

LineBox

GhostBearingHandle.setVisible

▸ setZIndex(value): LineBox

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

LineBox

this

GhostBearingHandle.setZIndex

▸ shear(shx, shy): LineBox

Shear this node's bounds

LineBox

this

GhostBearingHandle.shear

▸ toString(): string

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

string

A string representation

GhostBearingHandle.toString

▸ translate(tx, ty): LineBox

Translate bounds

LineBox

this

GhostBearingHandle.translate

▸ unregisterAnimationStyle(root): void

Unregister animation style.

void

GhostBearingHandle.unregisterAnimationStyle

▸ updateSceneTransformation(): LineBox

Update scene transformation

LineBox

this

GhostBearingHandle.updateSceneTransformation

▸ updateState(regions?, changes?): LineBox

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

LineBox

this

GhostBearingHandle.updateState

▸ Protected updateTimeStamp(): LineBox

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

LineBox

this

GhostBearingHandle.updateTimeStamp

▸ Static enableSceneGraphNotification(enabled): void

Enable / disable all notifications

void

GhostBearingHandle.enableSceneGraphNotification

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

Find root of the node with specified type

InstanceType<T>

GhostBearingHandle.findParent

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

Find root of the node with specified type