Class: CrossHair

• new CrossHair(layer?, name?)

Creates CrossHair

AbstractTool.constructor

• new CrossHair(options?)

Creates CrossHair

AbstractTool.constructor

▸ addListener(eventName, listener): CrossHair

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)

CrossHair

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

▸ 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

▸ getFillStyle(): FillStyle

Return fill style

FillStyle

▸ getHorizontalLineStyle(): LineStyle

return horizontal line style

LineStyle

▸ getLabelSettings(orientation): LabelSettingsOut

Gets settings for one label

LabelSettingsOut

JSON to configure label

▸ getLineStyle(): LineStyle

Return line style

LineStyle

▸ 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

▸ getOutLineStyle(): LineStyle

Return outline style

LineStyle

▸ getParentTool(): AbstractCompositeTool

Gets parent tool

AbstractCompositeTool

parent tool

AbstractTool.getParentTool

▸ getPosition(): Point

The current cross hair position

Point

▸ 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

▸ getRadius(): number

Returns radius of the cursor center target

number

▸ getRoot(): AbstractCompositeTool

Gets root tool

AbstractCompositeTool

parent tool

AbstractTool.getRoot

▸ getSymbol(): SymbolShape

Return cross-hair symbol

SymbolShape

▸ getTarget(): Node

Returns current target

Node

target

▸ getTouchRadius(): number

Returns current device radius for touch events

number

AbstractTool.getTouchRadius

▸ getVerticalLineStyle(): LineStyle

return vertical line style

LineStyle

▸ 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

▸ isVisible(): boolean

return visible state

boolean

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

Notify listeners

CrossHair

this

AbstractTool.notify

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

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.

CrossHair

this

AbstractTool.off

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

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

CrossHair

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?): CrossHair

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

Deprecated

since 4.0 use .off() instead.

CrossHair

AbstractTool.removeListener

▸ setActive(active): CrossHair

set active state

Fires

Events.onStateChanged

CrossHair

AbstractTool.setActive

▸ setEnabled(enabled): CrossHair

set enable state

Fires

Events.onEnabledStateChanged

Fires

Events.onStateChanged

CrossHair

this

AbstractTool.setEnabled

▸ setFillStyle(fillStyle, merge?): CrossHair

Sets fill style, used if radius is not null

CrossHair

this

▸ setHorizontalLineStyle(lineStyle, merge?): CrossHair

Sets vertical line style

CrossHair

this

▸ setLabelSettings(orientation, settings?): CrossHair

Set Settings for one label

CrossHair

this

▸ setLabelsTextConverter(position, textConverter): CrossHair

sets LabelsTextConverter

CrossHair

this

▸ setLineStyle(lineStyle, merge?): CrossHair

Sets line style

CrossHair

this

▸ setMouseRadius(radius): CrossHair

Sets device radius for mouse events

CrossHair

this

AbstractTool.setMouseRadius

▸ setName(name): CrossHair

set tool name

CrossHair

AbstractTool.setName

▸ setOutLineStyle(lineStyle, merge?): CrossHair

Sets line style

CrossHair

this

▸ setPosition(position, silent?, eventArgs?): CrossHair

Sets the current position in model coordinates of the manipulator layer

CrossHair

this

▸ setProperties(properties?): CrossHair

Sets all the properties pertaining to this object

CrossHair

this

AbstractTool.setProperties

▸ setProperty(name, value): CrossHair

Sets dynamic property by name

CrossHair

this

AbstractTool.setProperty

▸ setRadius(radius): CrossHair

set radius of the cursor center target

CrossHair

▸ setSelectTargetCallback(callback): CrossHair

Sets callback for selecting target Node from scene

CrossHair

this

▸ setSilent(bool): CrossHair

Set silent mode

CrossHair

this

AbstractTool.setSilent

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

Sets slot enabled

CrossHair

AbstractTool.setSlotEnabled

▸ setSlots(slots?, merge?): CrossHair

Sets new slots.

Example

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

CrossHair

this

AbstractTool.setSlots

▸ setSymbol(symbol): CrossHair

set cross-hair symbol

CrossHair

this

▸ setTextStyle(textStyle, merge?): CrossHair

Sets the text style of labels

CrossHair

this

▸ setTouchRadius(radius): CrossHair

Sets device radius for touch events

CrossHair

this

AbstractTool.setTouchRadius

▸ setVerticalLineStyle(lineStyle, merge?): CrossHair

Sets vertical line style

CrossHair

this

▸ setVisible(visible): CrossHair

Sets visible

CrossHair

this

▸ Protected start(eventArgs?): CrossHair

start

CrossHair

AbstractTool.start

▸ Protected stop(): CrossHair

stop

CrossHair

AbstractTool.stop

▸ toggle(): CrossHair

switch enable state to opposite state

CrossHair

AbstractTool.toggle

▸ updateCursorPosition(silent?): CrossHair

Update position of cursor for the last mouse position. This code can be used if content is scrolled to display the position of the cursor in the last mouse position

CrossHair

this

▸ 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