Class: CurveEditor

• new CurveEditor()

Creates a new instance of CurveEditor class

AbstractLogVisualEditingTool.constructor

• new CurveEditor(layer, cachedManipulatorLayer)

Creates a new instance of CurveEditor class

Deprecated

since 4.0. Use constructor with a single parameter instead

AbstractLogVisualEditingTool.constructor

• new CurveEditor(options)

Creates a new instance of CurveEditor class

AbstractLogVisualEditingTool.constructor

▸ Protected addHandle(handle): CurveEditor

Add editor handle

CurveEditor

this

AbstractLogVisualEditingTool.addHandle

▸ addListener(eventName, listener): CurveEditor

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)

CurveEditor

AbstractLogVisualEditingTool.addListener

▸ 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

AbstractLogVisualEditingTool.captureMouseUp

▸ checkHandleCollision(sample1, sample2?, activeHandle?): boolean

Checks if a sample or a value falls within the visible limits of the parent track.

boolean

True if the handle or the value falls within the visible limits of the track, false otherwise

▸ Protected createHandles(): CurveEditor

Creates the handles for every point that curve has visible on the screen if in linear interpolation mode. In step interpolation creates a line handle between each visible point

CurveEditor

▸ dispose(): void

Dispose tool.

void

AbstractLogVisualEditingTool.dispose

▸ findSampleIndex(depth, value): number

Searches the original sample index for the associated log curve

number

the original sample index if exact sample is found, otherwise returns a bitwise complement of the closest sample index

▸ 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

AbstractLogVisualEditingTool.fireEvent

▸ getActiveHandle(): GhostBearingHandle

Returns currently active handle,if exists, otherwise null

GhostBearingHandle

AbstractLogVisualEditingTool.getActiveHandle

▸ getCachedManipulatorLayer(): CompositeNode<Node>

Gets the manipulator layer with contains handles

Deprecated

since 4.0. Use AbstractLogVisualEditingTool#getManipulatorLayer instead

CompositeNode<Node>

AbstractLogVisualEditingTool.getCachedManipulatorLayer

▸ getClassName(): string

string

AbstractLogVisualEditingTool.getClassName

▸ Protected getDeviceXY(args): Point

Returns a point in model coordinates, edits one of the util points

Point

AbstractLogVisualEditingTool.getDeviceXY

▸ Protected getEventRadius(eventArgs): number

Returns device radius for the provided event

number

AbstractLogVisualEditingTool.getEventRadius

▸ Protected getHandle(index): GhostBearingHandle

GhostBearingHandle

AbstractLogVisualEditingTool.getHandle

▸ getHandleInsideTrack(): boolean

Gets the value of flag defining if the active handles can only move inside the track

boolean

▸ getHandlePainter(): Painter

Gets the shape painter with which is used to render handles. Format is the same as in SymbolShape Redraws all handles

Painter

painter

AbstractLogVisualEditingTool.getHandlePainter

▸ getHandleSize(): number

Get the size of the handles

number

AbstractLogVisualEditingTool.getHandleSize

▸ getHandleStyles(): HandleStylesOut

Returns registered styles for active, inactive, and ghost states of all handles

HandleStylesOut

object containing stylings for different types of handle states

AbstractLogVisualEditingTool.getHandleStyles

▸ Protected getHandlesCount(): number

Return number of handles

number

number of handles

AbstractLogVisualEditingTool.getHandlesCount

▸ getHandlesType(): HandlesType

Gets handles display type

HandlesType

handles display type

▸ getHideGhostOnDrop(): boolean

Gets a flag defining if the ghost should be reset after it has been dropped

boolean

AbstractLogVisualEditingTool.getHideGhostOnDrop

▸ getHideInactiveHandles(): boolean

Returns a flag which defines if inactive handles have to be hidden when dragging.

boolean

hide True when inactive handles hidden on dragging

▸ getHideSpillingHandles(): boolean

Gets the value of the flag defining if the handles which overflow the track boundaries should be hidden

boolean

▸ getManipulatorLayer(): CompositeNode<Node>

return manipulator layer

CompositeNode<Node>

layer

AbstractLogVisualEditingTool.getManipulatorLayer

▸ getMode(): Modes

Retrieves the type of editing that this adapter is doing

Modes

▸ getMouseRadius(): number

Returns current device radius for mouse events

number

AbstractLogVisualEditingTool.getMouseRadius

▸ getName(): string

return tool name if any

string

name of the tool

AbstractLogVisualEditingTool.getName

▸ getParentTool(): AbstractCompositeTool

Gets parent tool

AbstractCompositeTool

parent tool

AbstractLogVisualEditingTool.getParentTool

▸ getPosition(): Point

Returns the last registered position of the mouse in device space

Point

AbstractLogVisualEditingTool.getPosition

▸ getProperties(): OptionsOut

Returns all the properties pertaining to this object

OptionsOut

An object containing the properties

AbstractLogVisualEditingTool.getProperties

▸ getProperty(name): any

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

any

AbstractLogVisualEditingTool.getProperty

▸ getPropertyKeys(): string[]

Returns known properties keys

string[]

AbstractLogVisualEditingTool.getPropertyKeys

▸ getRoot(): AbstractCompositeTool

Gets root tool

AbstractCompositeTool

parent tool

AbstractLogVisualEditingTool.getRoot

▸ getShape(): LogCurve

Returns the shape which this tool is manipulating

LogCurve

AbstractLogVisualEditingTool.getShape

▸ getShowGhost(): boolean

Returns the flag defining if a ghost should be moved instead of the actual object

boolean

showGhost Show ghost flag

AbstractLogVisualEditingTool.getShowGhost

▸ getTouchRadius(): number

Returns current device radius for touch events

number

AbstractLogVisualEditingTool.getTouchRadius

▸ getVerticalEditAllowed(): boolean

Gets a flag defining if the data points can change their depths

boolean

True if depth change allowed

▸ hasEventListener(type, callback?): boolean

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

boolean

AbstractLogVisualEditingTool.hasEventListener

▸ hideHandles(skipActive): CurveEditor

Hides all the handles. Has an option to hide everything except the active handle

CurveEditor

▸ isActive(): boolean

return active state

boolean

AbstractLogVisualEditingTool.isActive

▸ isDisposed(): boolean

Returns whether this object has been disposed

boolean

AbstractLogVisualEditingTool.isDisposed

▸ Protected isDoubleClick(point, eventArgs?): boolean

returns true if double clicked

boolean

AbstractLogVisualEditingTool.isDoubleClick

▸ isEnabled(): boolean

returns enable state

boolean

state

AbstractLogVisualEditingTool.isEnabled

▸ isSilent(): boolean

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

boolean

AbstractLogVisualEditingTool.isSilent

▸ isTouchEvent(eventArgs): boolean

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

boolean

AbstractLogVisualEditingTool.isTouchEvent

▸ Protected makeSelection(x, y): Node[]

Makes a selection according to current position of the pointer

Node[]

AbstractLogVisualEditingTool.makeSelection

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

Notify listeners

CurveEditor

this

AbstractLogVisualEditingTool.notify

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

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.

CurveEditor

this

AbstractLogVisualEditingTool.off

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

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

CurveEditor

AbstractLogVisualEditingTool.on

▸ Protected onActiveStateChanged(): void

Fires

Events.onStateChanged

void

AbstractLogVisualEditingTool.onActiveStateChanged

▸ Protected onEnabledStateChanged(): void

Called when the tool is enabled or disabled

void

AbstractLogVisualEditingTool.onEnabledStateChanged

▸ onMouseDown(eventArgs): CurveEditor

Handles the event caused by user pressing the mouse button

CurveEditor

AbstractLogVisualEditingTool.onMouseDown

▸ onMouseMove(eventArgs): CurveEditor

Handles the event caused by user moving the mouse

CurveEditor

AbstractLogVisualEditingTool.onMouseMove

▸ onMouseUp(eventArgs): CurveEditor

Handles the event caused by user releasing the mouse button

CurveEditor

AbstractLogVisualEditingTool.onMouseUp

▸ pageToCanvas(eventArgs, externalPlot?): Object

return position relative to the canvas

Object

AbstractLogVisualEditingTool.pageToCanvas

▸ pointToModel(model, eventArgs): Point

converts device coordinates to inner coordinates of node

Point

AbstractLogVisualEditingTool.pointToModel

▸ Protected removeHandle(handle, disposeHandles?): CurveEditor

Remove handles

CurveEditor

this

AbstractLogVisualEditingTool.removeHandle

▸ removeHandles(): CurveEditor

Clears all the handles from the adapter and manipulator layer

CurveEditor

▸ removeListener(eventName, listener?): CurveEditor

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

Deprecated

since 4.0 use .off() instead.

CurveEditor

AbstractLogVisualEditingTool.removeListener

▸ setActive(active): CurveEditor

set active state

Fires

Events.onStateChanged

CurveEditor

AbstractLogVisualEditingTool.setActive

▸ setActiveHandle(handle): CurveEditor

Sets the handle currently active

CurveEditor

AbstractLogVisualEditingTool.setActiveHandle

▸ setEnabled(enabled): CurveEditor

set enable state

Fires

Events.onEnabledStateChanged

Fires

Events.onStateChanged

CurveEditor

this

AbstractLogVisualEditingTool.setEnabled

▸ setHandleInsideTrack(inside): CurveEditor

Sets a flag which defines if the active handle can only move within the track area

CurveEditor

▸ setHandlePainter(painter): CurveEditor

Sets the shape painter with which the handles will be drawn. Format is the same as in geotoolkit.scene.shapes.SymbolShape Redraws all handles

CurveEditor

AbstractLogVisualEditingTool.setHandlePainter

▸ setHandleSize(size): CurveEditor

Sets the pixel side of the handles to which a size is applicable (anchored handles)

CurveEditor

AbstractLogVisualEditingTool.setHandleSize

▸ setHandleStyles(styles): CurveEditor

Sets styles for active, inactive, and ghost states of all handles, and redraws each handle (this will lose edited handles position)

CurveEditor

AbstractLogVisualEditingTool.setHandleStyles

▸ setHandlesType(handlesType): CurveEditor

Sets handles display type

CurveEditor

this

▸ Protected setHandlesVisible(visible): CurveEditor

Iterates through handles and sets the provided visibility. If the visibility is to hide, hides the ghosts as well

CurveEditor

AbstractLogVisualEditingTool.setHandlesVisible

▸ setHideGhostOnDrop(hide): CurveEditor

Gets a flag defining if the ghost should be reset after it has been dropped

CurveEditor

AbstractLogVisualEditingTool.setHideGhostOnDrop

▸ setHideInactiveHandles(hide): CurveEditor

Sets a flag which defines if inactive handles have to be hidden when a move with an existing active handle occurs. Once you grab a handle and start dragging it around, every other handle will be hidden to aid a better view of the curve you are editing.

CurveEditor

▸ setHideSpillingHandles(hide): CurveEditor

Sets the value of the flag defining if the handles which overflow the track boundaries should be hidden

CurveEditor

▸ setMode(mode): CurveEditor

Sets what kind of edition this adapter has to do for the curve

CurveEditor

▸ setMouseRadius(radius): CurveEditor

Sets device radius for mouse events

CurveEditor

this

AbstractLogVisualEditingTool.setMouseRadius

▸ setName(name): CurveEditor

set tool name

CurveEditor

AbstractLogVisualEditingTool.setName

▸ setPosition(x, y): CurveEditor

Sets the last registered position of the mouse in device space

CurveEditor

AbstractLogVisualEditingTool.setPosition

▸ setProperties(properties?): CurveEditor

Sets all the properties pertaining to this object

CurveEditor

this

AbstractLogVisualEditingTool.setProperties

▸ setProperty(name, value): CurveEditor

Sets dynamic property by name

CurveEditor

this

AbstractLogVisualEditingTool.setProperty

▸ setShape(shape): CurveEditor

Sets the shape which this tool has to manipulate and calculate its handles from.

CurveEditor

AbstractLogVisualEditingTool.setShape

▸ setShowGhost(showGhost): CurveEditor

Sets the flag defining if a ghost should be moved instead of the actual handle

CurveEditor

AbstractLogVisualEditingTool.setShowGhost

▸ setSilent(bool): CurveEditor

Set silent mode

CurveEditor

this

AbstractLogVisualEditingTool.setSilent

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

Sets slot enabled

CurveEditor

AbstractLogVisualEditingTool.setSlotEnabled

▸ setSlots(slots?, merge?): CurveEditor

Sets new slots.

Example

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

CurveEditor

this

AbstractLogVisualEditingTool.setSlots

▸ setTouchRadius(radius): CurveEditor

Sets device radius for touch events

CurveEditor

this

AbstractLogVisualEditingTool.setTouchRadius

▸ setVerticalEditAllowed(allow): CurveEditor

Sets a flag defining if the data points can change their depths

CurveEditor

▸ showHandles(): CurveEditor

Shows all existing handles on the screen.

CurveEditor

▸ Protected start(eventArgs?): CurveEditor

start

CurveEditor

AbstractLogVisualEditingTool.start

▸ Protected stop(): CurveEditor

stop

CurveEditor

AbstractLogVisualEditingTool.stop

▸ toggle(): CurveEditor

switch enable state to opposite state

CurveEditor

AbstractLogVisualEditingTool.toggle

▸ update(): void

Updates the state of the tool, recalculated and redraws the handles and curve limits (for spilling handles)

void

AbstractLogVisualEditingTool.update

▸ Static canvasToClient(plotPoint, plot): Point

Convert plot coordinates to global coordinates

Point

AbstractLogVisualEditingTool.canvasToClient

▸ Static clientToCanvas(nativeEvent, plot): Point

Convert global coordinates to plot coordinates

Point

AbstractLogVisualEditingTool.clientToCanvas

▸ Static getClassName(): string

string

AbstractLogVisualEditingTool.getClassName

▸ Static getExclusiveTool(plot): AbstractTool

return exclusive tool associated with plot

AbstractTool

tool

AbstractLogVisualEditingTool.getExclusiveTool

▸ Static getNativeEventName(eventName): string[]

Returns native event name

string[]

AbstractLogVisualEditingTool.getNativeEventName

▸ Static isTouchEvent(eventArgs): eventArgs is TouchEvent

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

eventArgs is TouchEvent

AbstractLogVisualEditingTool.isTouchEvent

▸ Static lock(plot, tool): void

Set exclusive tool for plot

void

AbstractLogVisualEditingTool.lock

▸ Static setDefaultMouseRadius(radius): void

Sets default device radius for mouse events

void

AbstractLogVisualEditingTool.setDefaultMouseRadius

▸ Static setDefaultTouchRadius(radius): void

Sets default device radius for touch events

void

AbstractLogVisualEditingTool.setDefaultTouchRadius

▸ Static unlock(value): void

Remove exclusive tool from plot

void

AbstractLogVisualEditingTool.unlock