Class: Rectangle

• new Rectangle(options)

• new Rectangle(options?)

AbstractCombinedEditor<RectangleShape>.constructor

▸ addListener(eventName, listener): Rectangle

add event listener. The listener receives the message when the system event happens.

Deprecated

since 4.0 use .on() instead. Note that 3 args callback should be used in subscription via .on(): (eventType, source, args)

Rectangle

AbstractCombinedEditor.addListener

▸ apply(command): Rectangle

Applies command to the current node

Rectangle

this

AbstractCombinedEditor.apply

▸ Protected canInsert(eventArgs): boolean

Determines if the editor can insert a new node at the point

boolean

AbstractCombinedEditor.canInsert

▸ canRedo(): boolean

Checks if there is command in history to redo

boolean

AbstractCombinedEditor.canRedo

▸ canUndo(): boolean

Checks if there is command in history to undo

boolean

AbstractCombinedEditor.canUndo

▸ captureMouseUp(): void

listen to window mouse events in order to catch a mouse up action outside of the tool container DOM element. useful for example when you pan and release click outside of DOM element.

void

AbstractCombinedEditor.captureMouseUp

▸ changeNodeOrder(order, anchor?): Rectangle

changes the z-order of the nodes being rendered.

Rectangle

this

AbstractCombinedEditor.changeNodeOrder

▸ Protected createGhost(): Node

Creates a clone of the current node

Node

AbstractCombinedEditor.createGhost

▸ deleteNode(trash?, shape?): Rectangle

Delete node or array of nodes to specified trash container

Rectangle

this

AbstractCombinedEditor.deleteNode

▸ dispose(): void

Dispose tool.

void

AbstractCombinedEditor.dispose

▸ Protected end(eventArgs?): void

Ends current node creation, fires the corresponding event and clones new empty node for the new creation

void

AbstractCombinedEditor.end

▸ fireEvent(eventName, eventArgs?): void

This method is Protected. Fire an Event.

Deprecated

since 4.0 use .notify() instead. Note that 3 args callback should be used in subscription via .on()

void

AbstractCombinedEditor.fireEvent

▸ flipNodeOrientation(flipX, flipY): Rectangle

Flip node vertically and/or horizontally

Rectangle

this

AbstractCombinedEditor.flipNodeOrientation

▸ getActiveNode(): Node

Returns the ghost if ghost mode is enabled and initialized and the original node otherwise

Node

AbstractCombinedEditor.getActiveNode

▸ Protected getActivePlot(): Plot

Gets an active plot

Plot

AbstractCombinedEditor.getActivePlot

▸ getAspectRatio(): number

number

AbstractCombinedEditor.getAspectRatio

▸ Protected getBboxHandle(eventArgs?): EditHandleId

Returns current bounding box handle if no arguments provided, or bounding box element index that is currently under mouse event, null if nothing is

EditHandleId

AbstractCombinedEditor.getBboxHandle

▸ getBounds(): Rect

Returns bounds for the bounding box elements

Rect

AbstractCombinedEditor.getBounds

▸ getClassName(): string

string

AbstractCombinedEditor.getClassName

▸ Protected getDataLayer(): Node

Gets the edited nodes' parent layer

Node

AbstractCombinedEditor.getDataLayer

▸ getDeviceTransform(): Transformation

Returns current node-to-device transformation

Transformation

AbstractCombinedEditor.getDeviceTransform

▸ getEditMode(): EditMode

Returns current edit mode

EditMode

AbstractCombinedEditor.getEditMode

▸ Protected getEventRadius(eventArgs): number

Returns device radius for the provided event

number

AbstractCombinedEditor.getEventRadius

▸ Protected getGhost(): Node

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

Node

AbstractCombinedEditor.getGhost

▸ getHandlesGroup(): Group<Node>

Returns handles group

Group<Node>

AbstractCombinedEditor.getHandlesGroup

▸ getHistory(): History

Returns current history

History

AbstractCombinedEditor.getHistory

▸ Protected getLocalTransform(): Transformation

Returns current node local transformation

Transformation

AbstractCombinedEditor.getLocalTransform

▸ getManipulatorLayer(): CompositeNode<Node>

return manipulator layer

CompositeNode<Node>

layer

AbstractCombinedEditor.getManipulatorLayer

▸ getMouseRadius(): number

Returns current device radius for mouse events

number

AbstractCombinedEditor.getMouseRadius

▸ getName(): string

return tool name if any

string

name of the tool

AbstractCombinedEditor.getName

▸ getNode(): Rectangle

Returns current node

Rectangle

AbstractCombinedEditor.getNode

▸ getParentTool(): AbstractCompositeTool

Gets parent tool

AbstractCompositeTool

parent tool

AbstractCombinedEditor.getParentTool

▸ getProperties(): OptionsOut

Returns properties

OptionsOut

editor properties

AbstractCombinedEditor.getProperties

▸ getProperty(name): any

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

any

AbstractCombinedEditor.getProperty

▸ getPropertyKeys(): string[]

Returns known properties keys

string[]

AbstractCombinedEditor.getPropertyKeys

▸ getRoot(): AbstractCompositeTool

Gets root tool

AbstractCompositeTool

parent tool

AbstractCombinedEditor.getRoot

▸ getTouchRadius(): number

Returns current device radius for touch events

number

AbstractCombinedEditor.getTouchRadius

▸ Protected getVisible(): boolean

Gets the edited node visibility state

boolean

AbstractCombinedEditor.getVisible

▸ hasEventListener(type, callback?): boolean

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

boolean

AbstractCombinedEditor.hasEventListener

▸ Protected initialize(options): void

void

AbstractCombinedEditor.initialize

▸ isActive(): boolean

return active state

boolean

AbstractCombinedEditor.isActive

▸ isDisposed(): boolean

Returns whether this object has been disposed

boolean

AbstractCombinedEditor.isDisposed

▸ Protected isDoubleClick(point, eventArgs?): boolean

returns true if double clicked

boolean

AbstractCombinedEditor.isDoubleClick

▸ isEnabled(): boolean

returns enable state

boolean

state

AbstractCombinedEditor.isEnabled

▸ isSilent(): boolean

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

boolean

AbstractCombinedEditor.isSilent

▸ isStarted(): boolean

Tests if editing was started (editor is active and at least one command was applied)

boolean

AbstractCombinedEditor.isStarted

▸ Protected isSupported(options): boolean

Checks if editor supports the options provided

boolean

AbstractCombinedEditor.isSupported

▸ isTouchEvent(eventArgs): boolean

return true if the event is a touch event and false otherwise.

boolean

AbstractCombinedEditor.isTouchEvent

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

Notify listeners

Rectangle

this

AbstractCombinedEditor.notify

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

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.

Rectangle

this

AbstractCombinedEditor.off

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

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.

Example

// Using in derived tool
import type {EventMap as EventMapBase} from '@int/geotoolkit/controls/tools/AbstractTool';
export type EventMap = EventMapBase & {
[MyToolEvents.onValueChanged]: MyToolEventArgs
}
export enum MyToolEvents {
onValueChanged = 'onValueChanged'
}
export class MyTool extends AbstractTool {
public declare on: <E extends keyof EventMap>(type: E, callback: (eventType: E, sender: this, args: EventMap[E]) => void) => this;
protected declare notify: <E extends keyof EventMap>(type: E, source: AbstractTool, args?: EventMap[E]) => this;
public declare off: <E extends keyof EventMap>(type: E, callback?: (eventType: E, sender: this, args: EventMap[E]) => void) => this;
// ...
}

Rectangle

AbstractCombinedEditor.on

▸ Protected onActiveStateChanged(): void

Fires

Events.onStateChanged

void

AbstractCombinedEditor.onActiveStateChanged

▸ Protected onBeforeCommandApplied(command): void

Fires the EditEvents.BeforeCommandApplied event

void

AbstractCombinedEditor.onBeforeCommandApplied

▸ Protected onCommandApplied(command): void

Fires the EditEvents.CommandApplied and the command.getEventName() events

void

AbstractCombinedEditor.onCommandApplied

▸ Protected onCommandApplying(command): void

Fires the EditEvents.CommandApplying event

void

AbstractCombinedEditor.onCommandApplying

▸ Protected onCommandRedo(command): void

Fires the EditEvents.Redo event

void

AbstractCombinedEditor.onCommandRedo

▸ Protected onCommandUndo(command): void

Fires the EditEvents.Undo event

void

AbstractCombinedEditor.onCommandUndo

▸ Protected onDoubleClick(eventArgs): void

Handles mouse double click event

void

AbstractCombinedEditor.onDoubleClick

▸ Protected onEnabledStateChanged(): void

Fires

Events.onEnabledStateChanged

void

AbstractCombinedEditor.onEnabledStateChanged

▸ Protected onKeyDown(eventArgs): void

Handles key down event

void

AbstractCombinedEditor.onKeyDown

▸ Protected onKeyUp(eventArgs): void

Handles key up event

void

AbstractCombinedEditor.onKeyUp

▸ Protected onLeave(eventArgs): void

Handles mouse leave event

void

AbstractCombinedEditor.onLeave

▸ Protected onMouseDown(eventArgs): void

Handles mouse down event

void

AbstractCombinedEditor.onMouseDown

▸ Protected onMouseMove(eventArgs): void

Handles mouse move event

void

AbstractCombinedEditor.onMouseMove

▸ Protected onMouseUp(eventArgs): void

Handles mouse up event

void

AbstractCombinedEditor.onMouseUp

▸ Protected onNodeCreated(node, eventArgs?): void

Fires the EditEvents.End event

void

AbstractCombinedEditor.onNodeCreated

▸ pageToCanvas(eventArgs, externalPlot?): Object

return position relative to the canvas

Object

AbstractCombinedEditor.pageToCanvas

▸ pointToModel(model, eventArgs): Point

converts device coordinates to inner coordinates of node

Point

AbstractCombinedEditor.pointToModel

▸ Protected push(command): Rectangle

Pushes command to the history after applying it and firing the corresponding event

Rectangle

this

AbstractCombinedEditor.push

▸ redo(): Rectangle

Reapplies last canceled command in history (if possible)

Rectangle

this

AbstractCombinedEditor.redo

▸ removeListener(eventName, listener?): Rectangle

remove event listener. The listener reveives the message when the system event happens.

Deprecated

since 4.0 use .off() instead.

Rectangle

AbstractCombinedEditor.removeListener

▸ Protected resetNode(unlink?): Rectangle

Resets current node to the initial state before all the changes were made

Rectangle

this

AbstractCombinedEditor.resetNode

▸ Protected resetNodeToGhost(): Rectangle

Resets the current node to its ghost state

Rectangle

AbstractCombinedEditor.resetNodeToGhost

▸ Protected rotateNode(node, angle, hint?): boolean

boolean

AbstractCombinedEditor.rotateNode

▸ setActive(active): Rectangle

set active state

Fires

Events.onStateChanged

Rectangle

AbstractCombinedEditor.setActive

▸ setEditMode(mode): Rectangle

Sets edit mode to determine operations that can be applied to the current node. Use bitwise operations for the full customization.

Rectangle

this

AbstractCombinedEditor.setEditMode

▸ setEnabled(enabled): Rectangle

set enable state

Fires

Events.onEnabledStateChanged

Fires

Events.onStateChanged

Rectangle

this

AbstractCombinedEditor.setEnabled

▸ setMouseRadius(radius): Rectangle

Sets device radius for mouse events

Rectangle

this

AbstractCombinedEditor.setMouseRadius

▸ setName(name): Rectangle

set tool name

Rectangle

AbstractCombinedEditor.setName

▸ Protected setNode(node): Rectangle

Sets node to edit

Rectangle

this

AbstractCombinedEditor.setNode

▸ Protected setNodeBounds(node, p1, p2, hint?): boolean

boolean

AbstractCombinedEditor.setNodeBounds

▸ setProperties(properties?): Rectangle

Sets properties to the editing elements

Rectangle

this

AbstractCombinedEditor.setProperties

▸ setProperty(name, value): Rectangle

Sets dynamic property by name

Rectangle

this

AbstractCombinedEditor.setProperty

▸ setSilent(bool): Rectangle

Set silent mode

Rectangle

this

AbstractCombinedEditor.setSilent

▸ setSlotEnabled(eventName, value, target?): Rectangle

Sets slot enabled

Rectangle

AbstractCombinedEditor.setSlotEnabled

▸ setSlots(slots?, merge?): Rectangle

Sets new slots.

Example

const slots = {
'pointerdown': (event: EventArgs) => {
// event is an instance of @int/geotoolkit/controls/tools/EventArgs
...
}
};
tool.setSlots(slots);

Rectangle

this

AbstractCombinedEditor.setSlots

▸ setTouchRadius(radius): Rectangle

Sets device radius for touch events

Rectangle

this

AbstractCombinedEditor.setTouchRadius

▸ Protected start(eventArgs?): Rectangle

start

Rectangle

AbstractCombinedEditor.start

▸ Protected stop(): Rectangle

stop

Rectangle

AbstractCombinedEditor.stop

▸ Protected swapActiveHandles(handleId, vertical): EditHandleId

Swaps active handles vertically/horizontally

EditHandleId

swapped handle id

AbstractCombinedEditor.swapActiveHandles

▸ toggle(): Rectangle

switch enable state to opposite state

Rectangle

AbstractCombinedEditor.toggle

▸ Protected transformNode(node, tr, hint?): boolean

boolean

AbstractCombinedEditor.transformNode

▸ Protected translateNode(node, x, y, hint?): boolean

boolean

AbstractCombinedEditor.translateNode

▸ undo(): Rectangle

Cancels last command in history (if possible)

Rectangle

this

AbstractCombinedEditor.undo

▸ update(): Rectangle

Forces editing shapes and handles to be updated

Rectangle

this

AbstractCombinedEditor.update

▸ Protected updateBrowserCursor(eventArgs, cursor?): void

void

AbstractCombinedEditor.updateBrowserCursor

▸ updateHandles(): Rectangle

Forces editing handles to be updated

Rectangle

this

AbstractCombinedEditor.updateHandles

▸ Protected updateNodePosition(): void

Updates active node's position if scene transformation was changed but pointer position wasn't

void

AbstractCombinedEditor.updateNodePosition

▸ Static canvasToClient(plotPoint, plot): Point

Convert plot coordinates to global coordinates

Point

AbstractCombinedEditor.canvasToClient

▸ Static clientToCanvas(nativeEvent, plot): Point

Convert global coordinates to plot coordinates

Point

AbstractCombinedEditor.clientToCanvas

▸ Static getClassName(): string

string

AbstractCombinedEditor.getClassName

▸ Static getExclusiveTool(plot): AbstractTool

return exclusive tool associated with plot

AbstractTool

tool

AbstractCombinedEditor.getExclusiveTool

▸ Static getNativeEventName(eventName): string[]

Returns native event name

string[]

AbstractCombinedEditor.getNativeEventName

▸ Static isTouchEvent(eventArgs): eventArgs is TouchEvent

return true if the event is a touch event and false otherwise.

eventArgs is TouchEvent

AbstractCombinedEditor.isTouchEvent

▸ Static lock(plot, tool): void

Set exclusive tool for plot

void

AbstractCombinedEditor.lock

▸ Static setDefaultMouseRadius(radius): void

Sets default device radius for mouse events

void

AbstractCombinedEditor.setDefaultMouseRadius

▸ Static setDefaultTouchRadius(radius): void

Sets default device radius for touch events

void

AbstractCombinedEditor.setDefaultTouchRadius

▸ Static unlock(value): void

Remove exclusive tool from plot

void

AbstractCombinedEditor.unlock