Class: Measure

• [new Measure(options)](/solutions/geotoolkit/GeoToolkit_JS/apis/classes/geotoolkit.map.tools-1.measure.measure.md#new measure(options))

• new Measure(options?)

Measure

▸ addListener(eventName, listener): Measure

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)

Measure

Measure.addListener

▸ canRedo(): boolean

Checks if there is command in history to redo

boolean

Measure.canRedo

▸ canUndo(): boolean

Checks if there is command in history to undo

boolean

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

Measure.captureMouseUp

▸ clear(): Measure

Clears scene from all the painting elements

Measure

this

Measure.clear

▸ Protected createEditor(options): AbstractEditorBase<Node | Node[]&gt;

Returns editor to edit node with provided options

Throws

if supported editor was not found and default editor was not set

AbstractEditorBase<Node | Node[]&gt;

Measure.createEditor

▸ dispose(): void

Dispose tool.

void

Measure.dispose

▸ editNode(node): Measure

Starts editing the node provided

Measure

this

Measure.editNode

▸ execute(command): Measure

Applies the specified command to the associated node and appends it to history

Measure

Measure.execute

▸ 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

Measure.fireEvent

▸ getActiveShape(): Node

Returns currently edited shape. Relevant for EditMode.Ghost mode.

Node

Measure.getActiveShape

▸ getArea(): number

Returns measured area value

number

Measure.getArea

▸ getClassName(): string

string

Measure.getClassName

▸ getDistances(): number[]

Returns distances that were measured

number[]

Measure.getDistances

▸ getEditMode(): EditMode

Returns tool current edit mode

EditMode

Measure.getEditMode

▸ getEditor(): AbstractEditorBase<Node | Node[]&gt;

Returns current editor tool (if exists)

AbstractEditorBase<Node | Node[]&gt;

Measure.getEditor

▸ Protected getEventRadius(eventArgs): number

Returns device radius for the provided event

number

Measure.getEventRadius

▸ getHistory(): History

Returns current history

History

Measure.getHistory

▸ getLabels(): Node | Node[]

Returns label(s) that display distances or area

Node | Node[]

label(s)

Measure.getLabels

▸ getManipulatorLayer(): CompositeNode<Node&gt;

return manipulator layer

CompositeNode<Node&gt;

layer

Measure.getManipulatorLayer

▸ getMeasureMode(): MeasureMode

Returns current measure mode

MeasureMode

mode

Measure.getMeasureMode

▸ getMode(): PaintMode

Returns current painting mode

PaintMode

Measure.getMode

▸ getMouseRadius(): number

Returns current device radius for mouse events

number

Measure.getMouseRadius

▸ getName(): string

return tool name if any

string

name of the tool

Measure.getName

▸ getParentTool(): AbstractCompositeTool

Gets parent tool

AbstractCompositeTool

parent tool

Measure.getParentTool

▸ getPathMode(): MeasurePathMode

Returns current mode for paths

MeasurePathMode

▸ getProperties(): OptionsOut

Returns all properties

OptionsOut

tool options

Measure.getProperties

▸ getProperty(name): any

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

any

Measure.getProperty

▸ getPropertyKeys(): string[]

Returns known properties keys

string[]

Measure.getPropertyKeys

▸ Protected getRegistry(): Registry

Registry

Measure.getRegistry

▸ getRoot(): AbstractCompositeTool

Gets root tool

AbstractCompositeTool

parent tool

Measure.getRoot

▸ getSegmentLabels(): Node[]

Returns segment label(s) that display individual segment distances

Node[]

segment label(s)

Measure.getSegmentLabels

▸ getShape(): Node

Returns the origin of currently edited shape (if exists, null otherwise).

Node

Measure.getShape

▸ getTouchRadius(): number

Returns current device radius for touch events

number

Measure.getTouchRadius

▸ getUnit(): AbstractUnit

Returns current measuring unit

AbstractUnit

▸ hasEventListener(type, callback?): boolean

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

boolean

Measure.hasEventListener

▸ isActive(): boolean

return active state

boolean

Measure.isActive

▸ isDisposed(): boolean

Returns whether this object has been disposed

boolean

Measure.isDisposed

▸ Protected isDoubleClick(point, eventArgs?): boolean

returns true if double clicked

boolean

Measure.isDoubleClick

▸ isEnabled(): boolean

returns enable state

boolean

state

Measure.isEnabled

▸ isSilent(): boolean

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

boolean

Measure.isSilent

▸ isTouchEvent(eventArgs): boolean

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

boolean

Measure.isTouchEvent

▸ notify<E&gt;(type, source, args?): Measure

Notify listeners

Measure

this

Measure.notify

▸ off<E&gt;(type?, callback?): Measure

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.

Measure

this

Measure.off

▸ on<E&gt;(type, callback): Measure

Attach listener on event that will be called whenever the specified event is delivered to the target <p> If the callback function is already in the list of event listeners for this target, the function is not added a second time. </p> <p> 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. </p> TypeScript hint: in case of creating derived tool with own events, EventMap should be extended and .on() and .notify() methods redeclared, see sample.

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;
// ...
}

Measure

Measure.on

▸ Protected onActiveStateChanged(): void

Fires

Events.onStateChanged

void

Measure.onActiveStateChanged

▸ Protected onBeforeCommandApplying(eventName, history, command): void

Fires the EditEvents.BeforeCommandApplied event

void

Measure.onBeforeCommandApplying

▸ Protected onCommandApplied(eventName, history, command): void

Fires the EditEvents.CommandApplied event and the event according to the command event name

void

Measure.onCommandApplied

▸ Protected onCommandApplying(eventName, history, command): void

Fires the EditEvents.CommandApplying event

void

Measure.onCommandApplying

▸ Protected onCommandRedo(eventName, history, command): void

Fires the EditEvents.Redo event

void

Measure.onCommandRedo

▸ Protected onCommandUndo(eventName, history, command): void

Fires the EditEvents.Undo event

void

Measure.onCommandUndo

▸ Protected onEnabledStateChanged(): void

Fires

Events.onEnabledStateChanged

void

Measure.onEnabledStateChanged

▸ Protected onKeyDown(eventArgs): void

Handles key down event

void

Measure.onKeyDown

▸ Protected onKeyUp(eventArgs): void

Handles key up event

void

Measure.onKeyUp

▸ Protected onMouseDown(eventArgs): void

void

Measure.onMouseDown

▸ Protected onMouseMove(eventArgs): void

void

Measure.onMouseMove

▸ Protected onMouseUp(eventArgs): void

void

Measure.onMouseUp

▸ Protected onNodeCreated(editor, eventArgs): void

Node created handler

void

Measure.onNodeCreated

▸ pageToCanvas(eventArgs, externalPlot?): Object

return position relative to the canvas

Object

Measure.pageToCanvas

▸ pointToModel(model, eventArgs): Point

converts device coordinates to inner coordinates of node

Point

Measure.pointToModel

▸ redo(): Measure

Reapplies last canceled command in history (if possible)

Measure

Measure.redo

▸ removeListener(eventName, listener?): Measure

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

Deprecated

since 4.0 use .off() instead.

Measure

Measure.removeListener

▸ setActive(active): Measure

set active state

Fires

Events.onStateChanged

Measure

Measure.setActive

▸ setEditMode(mode): Measure

Sets tool edit mode (for nodes with node manipulators)

Measure

this

Measure.setEditMode

▸ Protected setEditor(editor): Measure

For internal use

Measure

this

Measure.setEditor

▸ setEnabled(enabled): Measure

set enable state

Fires

Events.onEnabledStateChanged

Fires

Events.onStateChanged

Measure

this

Measure.setEnabled

▸ setMeasureMode(mode): Measure

Sets measure mode (for what is measured)

Measure

this

Measure.setMeasureMode

▸ setMode(mode): Measure

Sets painting mode

Measure

Measure.setMode

▸ setMouseRadius(radius): Measure

Sets device radius for mouse events

Measure

this

Measure.setMouseRadius

▸ setName(name): Measure

set tool name

Measure

Measure.setName

▸ setPathMode(mode): Measure

Sets displaying paths mode

Measure

this

▸ setProperties(props?): Measure

Sets paint tool properties (mode, styles, etc.)

Measure

this

Measure.setProperties

▸ setProperty(name, value): Measure

Sets dynamic property by name

Measure

this

Measure.setProperty

▸ setSilent(bool): Measure

Set silent mode

Measure

this

Measure.setSilent

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

Sets slot enabled

Measure

Measure.setSlotEnabled

▸ setSlots(slots?, merge?): Measure

Sets new slots.

Example

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

Measure

this

Measure.setSlots

▸ setTouchRadius(radius): Measure

Sets device radius for touch events

Measure

this

Measure.setTouchRadius

▸ setUnit(unit): Measure

Sets measuring units

Measure

this

▸ Protected start(eventArgs?): Measure

start

Measure

Measure.start

▸ Protected stop(): Measure

stop

Measure

Measure.stop

▸ toggle(): Measure

switch enable state to opposite state

Measure

Measure.toggle

▸ undo(): Measure

Cancels last command in history (if possible)

Measure

Measure.undo

▸ update(): Measure

Forces editing shapes and handles to be updated

Measure

this

Measure.update

▸ updateHandles(): Measure

Forces editing handles to be synchronized with shape

Measure

this

Measure.updateHandles

▸ Static canvasToClient(plotPoint, plot): Point

Convert plot coordinates to global coordinates

Point

Measure.canvasToClient

▸ Static clientToCanvas(nativeEvent, plot): Point

Convert global coordinates to plot coordinates

Point

Measure.clientToCanvas

▸ Static getClassName(): string

string

Measure.getClassName

▸ Static getExclusiveTool(plot): AbstractTool

return exclusive tool associated with plot

AbstractTool

tool

Measure.getExclusiveTool

▸ Static getNativeEventName(eventName): string[]

Returns native event name

string[]

Measure.getNativeEventName

▸ Static isTouchEvent(eventArgs): eventArgs is TouchEvent

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

eventArgs is TouchEvent

Measure.isTouchEvent

▸ Static lock(plot, tool): void

Set exclusive tool for plot

void

Measure.lock

▸ Static setDefaultMouseRadius(radius): void

Sets default device radius for mouse events

void

Measure.setDefaultMouseRadius

▸ Static setDefaultTouchRadius(radius): void

Sets default device radius for touch events

void

Measure.setDefaultTouchRadius

▸ Static unlock(value): void

Remove exclusive tool from plot

void

Measure.unlock