Class: AggregationSelection

• new AggregationSelection(options)

• new AggregationSelection(options?)

Selection.constructor

▸ addListener(eventName, listener): AggregationSelection

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)

AggregationSelection

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

Selection.captureMouseUp

▸ dispose(): void

Dispose tool.

void

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

Selection.fireEvent

▸ getCircularMode(): CircularMode

Gets tool's circular selection mode

CircularMode

Selection.getCircularMode

▸ getClassName(): string

string

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

Selection.getContainerModelLimits

▸ getEndPoint(): Point

Return end point of selection

Point

Selection.getEndPoint

▸ Protected getEventRadius(eventArgs): number

Returns device radius for the provided event

number

Selection.getEventRadius

▸ getFillStyle(): FillStyle

Returns fill style

FillStyle

fill style

Selection.getFillStyle

▸ getLineStyle(): LineStyle

Returns line style

LineStyle

line style

Selection.getLineStyle

▸ getManipulatorLayer(): CompositeNode<Node>

return manipulator layer

CompositeNode<Node>

layer

Selection.getManipulatorLayer

▸ getMouseButtons(): MouseButtons

Gets mouse buttons set for selection

MouseButtons

this

Selection.getMouseButtons

▸ getMouseRadius(): number

Returns current device radius for mouse events

number

Selection.getMouseRadius

▸ getName(): string

return tool name if any

string

name of the tool

Selection.getName

▸ getNodeFilter(): NodeFilterCallback

Returns filter handler

NodeFilterCallback

filter

Selection.getNodeFilter

▸ getParentTool(): AbstractCompositeTool

Gets parent tool

AbstractCompositeTool

parent tool

Selection.getParentTool

▸ getPointerMode(): PointerMode

Gets tool pointer selection mode

PointerMode

Selection.getPointerMode

▸ getProperties(): OptionsOut

Returns properties

OptionsOut

properties

Selection.getProperties

▸ getProperty(name): any

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

any

Selection.getProperty

▸ getPropertyKeys(): string[]

Returns known properties keys

string[]

Selection.getPropertyKeys

▸ getRoot(): AbstractCompositeTool

Gets root tool

AbstractCompositeTool

parent tool

Selection.getRoot

▸ getRootNode(): Node

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

Node

root node

Selection.getRootNode

▸ getRubberBandMode(): RubberBandMode

Gets tool's rubberband selection mode

RubberBandMode

Selection.getRubberBandMode

▸ getRubberBandRenderMode(): RubberBandRenderMode

Return the way the rectangle is displayed

RubberBandRenderMode

Selection.getRubberBandRenderMode

▸ getRubberBandShapeMode(): RubberBandShapeMode

Gets tool's rubberband shape

RubberBandShapeMode

Selection.getRubberBandShapeMode

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

gets the currently selected items

(Node | SelectedItem<any>)[]

Selection.getSelection

▸ getSelectionMode(): SelectionMode

Returns tool selection mode

SelectionMode

Selection.getSelectionMode

▸ getStartPoint(): Point

Return start point of selection

Point

Selection.getStartPoint

▸ getTextStyle(): TextStyle

Returns text style

TextStyle

text style

Selection.getTextStyle

▸ getTouchRadius(): number

Returns current device radius for touch events

number

Selection.getTouchRadius

▸ hasEventListener(type, callback?): boolean

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

boolean

Selection.hasEventListener

▸ isActive(): boolean

return active state

boolean

Selection.isActive

▸ isAutoDisabled(): boolean

Get auto-disabled mode

boolean

does the selection automatically disable itself on selection changed

Selection.isAutoDisabled

▸ isDisposed(): boolean

Returns whether this object has been disposed

boolean

Selection.isDisposed

▸ Protected isDoubleClick(point, eventArgs?): boolean

returns true if double clicked

boolean

Selection.isDoubleClick

▸ isEnabled(): boolean

returns enable state

boolean

state

Selection.isEnabled

▸ isSilent(): boolean

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

boolean

Selection.isSilent

▸ isTouchEvent(eventArgs): boolean

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

boolean

Selection.isTouchEvent

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

Notify listeners

AggregationSelection

this

Selection.notify

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

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.

AggregationSelection

this

Selection.off

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

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

AggregationSelection

Selection.on

▸ Protected onActiveStateChanged(): void

Fires

Events.onStateChanged

void

Selection.onActiveStateChanged

▸ Protected onDoubleClick(eventArgs): void

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

void

Selection.onDoubleClick

▸ Protected onEnabledStateChanged(): void

Fires

Events.onEnabledStateChanged

void

Selection.onEnabledStateChanged

▸ Protected onMouseDown(eventArgs): void

mouse down function of selection tool

void

Selection.onMouseDown

▸ Protected onMouseMove(eventArgs): void

mouse move function

void

Selection.onMouseMove

▸ Protected onMouseUp(eventArgs): void

mouse up function of selection tool

void

Selection.onMouseUp

▸ pageToCanvas(eventArgs, externalPlot?): Object

return position relative to the canvas

Object

Selection.pageToCanvas

▸ pointToModel(model, eventArgs): Point

converts device coordinates to inner coordinates of node

Point

Selection.pointToModel

▸ removeListener(eventName, listener?): AggregationSelection

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

Deprecated

since 4.0 use .off() instead.

AggregationSelection

Selection.removeListener

▸ setActive(active): AggregationSelection

set active state

Fires

Events.onStateChanged

AggregationSelection

Selection.setActive

▸ setAutoDisabled(mode): AggregationSelection

Set auto-disabled mode

AggregationSelection

this

Selection.setAutoDisabled

▸ setCircularMode(mode): AggregationSelection

Sets tool's circular selection mode

AggregationSelection

this

Selection.setCircularMode

▸ setEnabled(enabled): AggregationSelection

Sets enabled

AggregationSelection

this

Selection.setEnabled

▸ setFillStyle(fillStyle, merge?): AggregationSelection

Sets fill style

AggregationSelection

this this

Selection.setFillStyle

▸ setLineStyle(lineStyle, merge?): AggregationSelection

Sets line style

AggregationSelection

this

Selection.setLineStyle

▸ setMeasureCallback(measureCallback): AggregationSelection

Sets measure callback

AggregationSelection

Selection.setMeasureCallback

▸ setMouseButtons(button): AggregationSelection

Sets mouse buttons for selection

AggregationSelection

this

Selection.setMouseButtons

▸ setMouseRadius(radius): AggregationSelection

Sets device radius for mouse events

AggregationSelection

this

Selection.setMouseRadius

▸ setName(name): AggregationSelection

set tool name

AggregationSelection

Selection.setName

▸ setNodeFilter(filter): AggregationSelection

Sets filter handler

AggregationSelection

Selection.setNodeFilter

▸ setOptions(options?): AggregationSelection

Sets selection options

AggregationSelection

this

Selection.setOptions

▸ setPointerMode(mode): AggregationSelection

Sets tool pointer selection mode

AggregationSelection

this

Selection.setPointerMode

▸ setProperties(properties): AggregationSelection

Sets all the properties pertaining to this object

AggregationSelection

this

Selection.setProperties

▸ setProperty(name, value): AggregationSelection

Sets dynamic property by name

AggregationSelection

this

Selection.setProperty

▸ setRootNode(root): AggregationSelection

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

AggregationSelection

this

Selection.setRootNode

▸ setRubberBandMode(mode): AggregationSelection

Sets tool rubberband selection mode

AggregationSelection

this

Selection.setRubberBandMode

▸ setRubberBandRenderMode(mode): AggregationSelection

Set the way the rectangle has to be displayed

AggregationSelection

Selection.setRubberBandRenderMode

▸ setRubberBandShapeMode(mode): AggregationSelection

Sets tool's rubberband shape mode

AggregationSelection

this

Selection.setRubberBandShapeMode

▸ setSelection(selection): AggregationSelection

sets the currently selected items

AggregationSelection

this

Selection.setSelection

▸ setSelectionMode(mode): AggregationSelection

Sets tool selection mode

AggregationSelection

this

Selection.setSelectionMode

▸ setSelectorCallback(selectorCallback): AggregationSelection

Sets selector callback

AggregationSelection

Selection.setSelectorCallback

▸ setSilent(bool): AggregationSelection

Set silent mode

AggregationSelection

this

Selection.setSilent

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

Sets slot enabled

AggregationSelection

Selection.setSlotEnabled

▸ setSlots(slots?, merge?): AggregationSelection

Sets new slots.

Example

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

AggregationSelection

this

Selection.setSlots

▸ setTextStyle(textStyle, merge?): AggregationSelection

Sets measurement label text style

AggregationSelection

this

Selection.setTextStyle

▸ setTouchRadius(radius): AggregationSelection

Sets device radius for touch events

AggregationSelection

this

Selection.setTouchRadius

▸ Protected start(eventArgs?): AggregationSelection

start

AggregationSelection

Selection.start

▸ Protected stop(): AggregationSelection

stop

AggregationSelection

Selection.stop

▸ toggle(): AggregationSelection

switch enable state to opposite state

AggregationSelection

Selection.toggle

▸ Static canvasToClient(plotPoint, plot): Point

Convert plot coordinates to global coordinates

Point

Selection.canvasToClient

▸ Static clientToCanvas(nativeEvent, plot): Point

Convert global coordinates to plot coordinates

Point

Selection.clientToCanvas

▸ Static getClassName(): string

string

Selection.getClassName

▸ Static getExclusiveTool(plot): AbstractTool

return exclusive tool associated with plot

AbstractTool

tool

Selection.getExclusiveTool

▸ Static getNativeEventName(eventName): string[]

Returns native event name

string[]

Selection.getNativeEventName

▸ Static isTouchEvent(eventArgs): eventArgs is TouchEvent

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

eventArgs is TouchEvent

Selection.isTouchEvent

▸ Static lock(plot, tool): void

Set exclusive tool for plot

void

Selection.lock

▸ Static setDefaultMouseRadius(radius): void

Sets default device radius for mouse events

void

Selection.setDefaultMouseRadius

▸ Static setDefaultTouchRadius(radius): void

Sets default device radius for touch events

void

Selection.setDefaultTouchRadius

▸ Static unlock(value): void

Remove exclusive tool from plot

void

Selection.unlock