Class: Selection

• new Selection(layer?, mode?)

Creates Selection

AbstractRubberTool.constructor

• new Selection(options?)

Creates Selection

AbstractRubberTool.constructor

▸ addListener(eventName, listener): Selection

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)

Selection

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

AbstractRubberTool.captureMouseUp

▸ dispose(): void

Dispose tool.

void

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

AbstractRubberTool.fireEvent

▸ getCircularMode(): CircularMode

Gets tool's circular selection mode

CircularMode

▸ getClassName(): string

string

AbstractRubberTool.getClassName

▸ Protected getContainerModelLimits(): Rect

Return container model limits in which rubber band is drawn. By default it returns manipulator layer visible model limits

Rect

area of model limits

AbstractRubberTool.getContainerModelLimits

▸ getEndPoint(): Point

Return end point of selection

Point

▸ Protected getEventRadius(eventArgs): number

Returns device radius for the provided event

number

AbstractRubberTool.getEventRadius

▸ getFillStyle(): FillStyle

Returns fill style

FillStyle

fill style

▸ getLineStyle(): LineStyle

Returns line style

LineStyle

line style

▸ getManipulatorLayer(): CompositeNode<Node>

return manipulator layer

CompositeNode<Node>

layer

AbstractRubberTool.getManipulatorLayer

▸ getMouseButtons(): MouseButtons

Gets mouse buttons set for selection

MouseButtons

this

AbstractRubberTool.getMouseButtons

▸ getMouseRadius(): number

Returns current device radius for mouse events

number

AbstractRubberTool.getMouseRadius

▸ getName(): string

return tool name if any

string

name of the tool

AbstractRubberTool.getName

▸ getNodeFilter(): NodeFilterCallback

Returns filter handler

NodeFilterCallback

filter

▸ getParentTool(): AbstractCompositeTool

Gets parent tool

AbstractCompositeTool

parent tool

AbstractRubberTool.getParentTool

▸ getPointerMode(): PointerMode

Gets tool pointer selection mode

PointerMode

▸ getProperties(): OptionsOut

Returns properties

OptionsOut

properties

AbstractRubberTool.getProperties

▸ getProperty(name): any

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

any

AbstractRubberTool.getProperty

▸ getPropertyKeys(): string[]

Returns known properties keys

string[]

AbstractRubberTool.getPropertyKeys

▸ getRoot(): AbstractCompositeTool

Gets root tool

AbstractCompositeTool

parent tool

AbstractRubberTool.getRoot

▸ getRootNode(): Node

Return the root node to start selection. If it is not specified then root node is used

Node

root node

▸ getRubberBandMode(): RubberBandMode

Gets tool's rubberband selection mode

RubberBandMode

▸ getRubberBandRenderMode(): RubberBandRenderMode

Return the way the rectangle is displayed

RubberBandRenderMode

AbstractRubberTool.getRubberBandRenderMode

▸ getRubberBandShapeMode(): RubberBandShapeMode

Gets tool's rubberband shape

RubberBandShapeMode

▸ getSelection(): (Node | SelectedItem<any>)[]

gets the currently selected items

(Node | SelectedItem<any>)[]

▸ getSelectionMode(): SelectionMode

Returns tool selection mode

SelectionMode

▸ getStartPoint(): Point

Return start point of selection

Point

▸ getTextStyle(): TextStyle

Returns text style

TextStyle

text style

▸ getTouchRadius(): number

Returns current device radius for touch events

number

AbstractRubberTool.getTouchRadius

▸ hasEventListener(type, callback?): boolean

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

boolean

AbstractRubberTool.hasEventListener

▸ isActive(): boolean

return active state

boolean

AbstractRubberTool.isActive

▸ isAutoDisabled(): boolean

Get auto-disabled mode

boolean

does the selection automatically disable itself on selection changed

▸ isDisposed(): boolean

Returns whether this object has been disposed

boolean

AbstractRubberTool.isDisposed

▸ Protected isDoubleClick(point, eventArgs?): boolean

returns true if double clicked

boolean

AbstractRubberTool.isDoubleClick

▸ isEnabled(): boolean

returns enable state

boolean

state

AbstractRubberTool.isEnabled

▸ isSilent(): boolean

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

boolean

AbstractRubberTool.isSilent

▸ isTouchEvent(eventArgs): boolean

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

boolean

AbstractRubberTool.isTouchEvent

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

Notify listeners

Selection

this

AbstractRubberTool.notify

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

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.

Selection

this

AbstractRubberTool.off

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

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

Selection

AbstractRubberTool.on

▸ Protected onActiveStateChanged(): void

Fires

Events.onStateChanged

void

AbstractRubberTool.onActiveStateChanged

▸ Protected onDoubleClick(eventArgs): void

Double click handler Detects if double click happens on scrollbar and prevents propagation

void

▸ Protected onEnabledStateChanged(): void

Fires

Events.onEnabledStateChanged

void

AbstractRubberTool.onEnabledStateChanged

▸ Protected onMouseDown(eventArgs): void

mouse down function of selection tool

void

▸ Protected onMouseMove(eventArgs): void

mouse move function

void

▸ Protected onMouseUp(eventArgs): void

mouse up function of selection tool

void

▸ pageToCanvas(eventArgs, externalPlot?): Object

return position relative to the canvas

Object

AbstractRubberTool.pageToCanvas

▸ pointToModel(model, eventArgs): Point

converts device coordinates to inner coordinates of node

Point

AbstractRubberTool.pointToModel

▸ removeListener(eventName, listener?): Selection

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

Deprecated

since 4.0 use .off() instead.

Selection

AbstractRubberTool.removeListener

▸ setActive(active): Selection

set active state

Fires

Events.onStateChanged

Selection

AbstractRubberTool.setActive

▸ setAutoDisabled(mode): Selection

Set auto-disabled mode

Selection

this

▸ setCircularMode(mode): Selection

Sets tool's circular selection mode

Selection

this

▸ setEnabled(enabled): Selection

set enable state

Fires

Events.onEnabledStateChanged

Fires

Events.onStateChanged

Selection

this

AbstractRubberTool.setEnabled

▸ setFillStyle(fillStyle, merge?): Selection

Sets fill style

Selection

this this

▸ setLineStyle(lineStyle, merge?): Selection

Sets line style

Selection

this

▸ setMeasureCallback(measureCallback): Selection

Sets measure callback

Selection

▸ setMouseButtons(button): Selection

Sets mouse buttons for selection

Selection

this

AbstractRubberTool.setMouseButtons

▸ setMouseRadius(radius): Selection

Sets device radius for mouse events

Selection

this

AbstractRubberTool.setMouseRadius

▸ setName(name): Selection

set tool name

Selection

AbstractRubberTool.setName

▸ setNodeFilter(filter): Selection

Sets filter handler

Selection

▸ setOptions(options?): Selection

Sets selection options

Selection

this

▸ setPointerMode(mode): Selection

Sets tool pointer selection mode

Selection

this

▸ setProperties(properties): Selection

Sets all the properties pertaining to this object

Selection

this

AbstractRubberTool.setProperties

▸ setProperty(name, value): Selection

Sets dynamic property by name

Selection

this

AbstractRubberTool.setProperty

▸ setRootNode(root): Selection

Specify a root node to start selection. If it is not specified then root node is used

Selection

this

▸ setRubberBandMode(mode): Selection

Sets tool rubberband selection mode

Selection

this

▸ setRubberBandRenderMode(mode): Selection

Set the way the rectangle has to be displayed

Selection

AbstractRubberTool.setRubberBandRenderMode

▸ setRubberBandShapeMode(mode): Selection

Sets tool's rubberband shape mode

Selection

this

▸ setSelection(selection): Selection

sets the currently selected items

Selection

this

▸ setSelectionMode(mode): Selection

Sets tool selection mode

Selection

this

▸ setSelectorCallback(selectorCallback): Selection

Sets selector callback

Selection

▸ setSilent(bool): Selection

Set silent mode

Selection

this

AbstractRubberTool.setSilent

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

Sets slot enabled

Selection

AbstractRubberTool.setSlotEnabled

▸ setSlots(slots?, merge?): Selection

Sets new slots.

Example

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

Selection

this

AbstractRubberTool.setSlots

▸ setTextStyle(textStyle, merge?): Selection

Sets measurement label text style

Selection

this

▸ setTouchRadius(radius): Selection

Sets device radius for touch events

Selection

this

AbstractRubberTool.setTouchRadius

▸ Protected start(eventArgs?): Selection

start

Selection

AbstractRubberTool.start

▸ Protected stop(): Selection

stop

Selection

AbstractRubberTool.stop

▸ toggle(): Selection

switch enable state to opposite state

Selection

AbstractRubberTool.toggle

▸ Static canvasToClient(plotPoint, plot): Point

Convert plot coordinates to global coordinates

Point

AbstractRubberTool.canvasToClient

▸ Static clientToCanvas(nativeEvent, plot): Point

Convert global coordinates to plot coordinates

Point

AbstractRubberTool.clientToCanvas

▸ Static getClassName(): string

string

AbstractRubberTool.getClassName

▸ Static getExclusiveTool(plot): AbstractTool

return exclusive tool associated with plot

AbstractTool

tool

AbstractRubberTool.getExclusiveTool

▸ Static getNativeEventName(eventName): string[]

Returns native event name

string[]

AbstractRubberTool.getNativeEventName

▸ Static isTouchEvent(eventArgs): eventArgs is TouchEvent

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

eventArgs is TouchEvent

AbstractRubberTool.isTouchEvent

▸ Static lock(plot, tool): void

Set exclusive tool for plot

void

AbstractRubberTool.lock

▸ Static setDefaultMouseRadius(radius): void

Sets default device radius for mouse events

void

AbstractRubberTool.setDefaultMouseRadius

▸ Static setDefaultTouchRadius(radius): void

Sets default device radius for touch events

void

AbstractRubberTool.setDefaultTouchRadius

▸ Static unlock(value): void

Remove exclusive tool from plot

void

AbstractRubberTool.unlock