Class: HorizonPicker

• new HorizonPicker(widget, options)

• new HorizonPicker(widget, options?)

AbstractTool.constructor

▸ addListener(eventName, listener): HorizonPicker

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)

HorizonPicker

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

AbstractTool.captureMouseUp

▸ clear(): void

Clear horizon picker trajectories

void

▸ dispose(): void

Dispose tool.

void

AbstractTool.dispose

▸ 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

AbstractTool.fireEvent

▸ getClassName(): string

string

AbstractTool.getClassName

▸ Protected getEventRadius(eventArgs): number

Returns device radius for the provided event

number

AbstractTool.getEventRadius

▸ getHighlightedHorizonLineStyle(): LineStyle

Return horizon line style

LineStyle

lineStyle current line style

▸ getHorizonLineStyle(): LineStyle

Return horizon line style

LineStyle

lineStyle current line style

▸ getManipulatorLayer(): CompositeNode<Node>

return manipulator layer

CompositeNode<Node>

layer

AbstractTool.getManipulatorLayer

▸ getMouseRadius(): number

Returns current device radius for mouse events

number

AbstractTool.getMouseRadius

▸ getName(): string

return tool name if any

string

name of the tool

AbstractTool.getName

▸ getParentTool(): AbstractCompositeTool

Gets parent tool

AbstractCompositeTool

parent tool

AbstractTool.getParentTool

▸ getProperties(context?): OptionsOut

Gets all the properties pertaining to this object

OptionsOut

properties object

AbstractTool.getProperties

▸ getProperty(name): any

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

any

AbstractTool.getProperty

▸ getPropertyKeys(): string[]

Returns known properties keys

string[]

AbstractTool.getPropertyKeys

▸ getRoot(): AbstractCompositeTool

Gets root tool

AbstractCompositeTool

parent tool

AbstractTool.getRoot

▸ getTouchRadius(): number

Returns current device radius for touch events

number

AbstractTool.getTouchRadius

▸ getTrajectoryData(): TrajectoryData

Get trajectory data

TrajectoryData

points data

▸ getVisible(): boolean

Get horizon visible

boolean

true if visible

▸ hasEventListener(type, callback?): boolean

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

boolean

AbstractTool.hasEventListener

▸ isActive(): boolean

return active state

boolean

AbstractTool.isActive

▸ isDisposed(): boolean

Returns whether this object has been disposed

boolean

AbstractTool.isDisposed

▸ Protected isDoubleClick(point, eventArgs?): boolean

returns true if double clicked

boolean

AbstractTool.isDoubleClick

▸ isEnabled(): boolean

returns enable state

boolean

state

AbstractTool.isEnabled

▸ isSilent(): boolean

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

boolean

AbstractTool.isSilent

▸ isTouchEvent(eventArgs): boolean

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

boolean

AbstractTool.isTouchEvent

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

Notify listeners

HorizonPicker

this

AbstractTool.notify

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

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.

HorizonPicker

this

AbstractTool.off

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

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

HorizonPicker

AbstractTool.on

▸ Protected onActiveStateChanged(): void

Fires

Events.onStateChanged

void

AbstractTool.onActiveStateChanged

▸ Protected onEnabledStateChanged(): void

Fires

Events.onEnabledStateChanged

void

AbstractTool.onEnabledStateChanged

▸ pageToCanvas(eventArgs, externalPlot?): Object

return position relative to the canvas

Object

AbstractTool.pageToCanvas

▸ pointToModel(model, eventArgs): Point

converts device coordinates to inner coordinates of node

Point

AbstractTool.pointToModel

▸ removeListener(eventName, listener?): HorizonPicker

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

Deprecated

since 4.0 use .off() instead.

HorizonPicker

AbstractTool.removeListener

▸ setActive(active): HorizonPicker

set active state

Fires

Events.onStateChanged

HorizonPicker

AbstractTool.setActive

▸ setEnabled(enabled): HorizonPicker

set enable state

Fires

Events.onEnabledStateChanged

Fires

Events.onStateChanged

HorizonPicker

this

AbstractTool.setEnabled

▸ setHighlightedHorizonLineStyle(lineStyle, merge?): HorizonPicker

Sets horizon line style

HorizonPicker

this

▸ setHorizonLineStyle(lineStyle, merge?): HorizonPicker

Sets horizon line style

HorizonPicker

this

▸ setMouseRadius(radius): HorizonPicker

Sets device radius for mouse events

HorizonPicker

this

AbstractTool.setMouseRadius

▸ setName(name): HorizonPicker

set tool name

HorizonPicker

AbstractTool.setName

▸ setProperties(properties?): HorizonPicker

Sets properties

HorizonPicker

this

AbstractTool.setProperties

▸ setProperty(name, value): HorizonPicker

Sets dynamic property by name

HorizonPicker

this

AbstractTool.setProperty

▸ setSilent(bool): HorizonPicker

Set silent mode

HorizonPicker

this

AbstractTool.setSilent

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

Sets slot enabled

HorizonPicker

AbstractTool.setSlotEnabled

▸ setSlots(slots?, merge?): HorizonPicker

Sets new slots.

Example

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

HorizonPicker

this

AbstractTool.setSlots

▸ setTouchRadius(radius): HorizonPicker

Sets device radius for touch events

HorizonPicker

this

AbstractTool.setTouchRadius

▸ setTrajectoryData(data?): HorizonPicker

Sets trajectory. Can be used in any time to overwrite current trajectory

HorizonPicker

▸ setVisible(visible): HorizonPicker

Set horizon visible

HorizonPicker

this

▸ Protected start(eventArgs?): HorizonPicker

start

HorizonPicker

AbstractTool.start

▸ Protected stop(): HorizonPicker

stop

HorizonPicker

AbstractTool.stop

▸ toggle(): HorizonPicker

switch enable state to opposite state

HorizonPicker

AbstractTool.toggle

▸ Static canvasToClient(plotPoint, plot): Point

Convert plot coordinates to global coordinates

Point

AbstractTool.canvasToClient

▸ Static clientToCanvas(nativeEvent, plot): Point

Convert global coordinates to plot coordinates

Point

AbstractTool.clientToCanvas

▸ Static getClassName(): string

string

AbstractTool.getClassName

▸ Static getExclusiveTool(plot): AbstractTool

return exclusive tool associated with plot

AbstractTool

tool

AbstractTool.getExclusiveTool

▸ Static getNativeEventName(eventName): string[]

Returns native event name

string[]

AbstractTool.getNativeEventName

▸ Static isTouchEvent(eventArgs): eventArgs is TouchEvent

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

eventArgs is TouchEvent

AbstractTool.isTouchEvent

▸ Static lock(plot, tool): void

Set exclusive tool for plot

void

AbstractTool.lock

▸ Static setDefaultMouseRadius(radius): void

Sets default device radius for mouse events

void

AbstractTool.setDefaultMouseRadius

▸ Static setDefaultTouchRadius(radius): void

Sets default device radius for touch events

void

AbstractTool.setDefaultTouchRadius

▸ Static unlock(value): void

Remove exclusive tool from plot

void

AbstractTool.unlock