Class: RubberBand

• new RubberBand(layer?, mode?)

Creates RubberBand

AbstractRubberTool.constructor

• new RubberBand(options?)

Creates RubberBand

AbstractRubberTool.constructor

▸ addListener(eventName, listener): RubberBand

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)

RubberBand

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

▸ getAcceptEmptyRect(): boolean

Return empty rect flag

boolean

empty rect flag

▸ 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

▸ Protected getEventRadius(eventArgs): number

Returns device radius for the provided event

number

AbstractRubberTool.getEventRadius

▸ getFillStyle(): FillStyle

Return fill style

FillStyle

fillStyle current fill style

▸ getLineStyle(): LineStyle

Return line style

LineStyle

lineStyle current line style

▸ getManipulatorLayer(): CompositeNode<Node>

return manipulator layer

CompositeNode<Node>

layer

AbstractRubberTool.getManipulatorLayer

▸ getMinDimension(): Dimension

Get minimum selection dimension

Dimension

▸ getMinDimensionMode(): MinimumDimensionMode

Get minimum dimension mode

MinimumDimensionMode

▸ getMode(): RubberBandRenderMode

Gets rubberband rendering mode

RubberBandRenderMode

size mode

▸ 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

▸ getParentTool(): AbstractCompositeTool

Gets parent tool

AbstractCompositeTool

parent tool

AbstractRubberTool.getParentTool

▸ getProperties(context?): OptionsOut

Gets all the properties pertaining to this object

OptionsOut

properties object

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

▸ getRestrictionArea(): Rect

Get restriction area

Rect

restriction area

▸ getRoot(): AbstractCompositeTool

Gets root tool

AbstractCompositeTool

parent tool

AbstractRubberTool.getRoot

▸ getRubberBandRenderMode(): RubberBandRenderMode

Return the way the rectangle is displayed

RubberBandRenderMode

AbstractRubberTool.getRubberBandRenderMode

▸ 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 RB automatically disable itself on zoom End

▸ 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?): RubberBand

Notify listeners

RubberBand

this

AbstractRubberTool.notify

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

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.

RubberBand

this

AbstractRubberTool.off

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

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

RubberBand

AbstractRubberTool.on

▸ Protected onActiveStateChanged(): void

Fires

Events.onStateChanged

void

AbstractRubberTool.onActiveStateChanged

▸ Protected onEnabledStateChanged(): void

Fires

Events.onEnabledStateChanged

void

AbstractRubberTool.onEnabledStateChanged

▸ Protected onMouseDown(eventArgs): void

void

▸ Protected onMouseMove(eventArgs): void

void

▸ Protected onMouseUp(eventArgs): void

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

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

Deprecated

since 4.0 use .off() instead.

RubberBand

AbstractRubberTool.removeListener

▸ setAcceptEmptyRect(acceptEmptyRect): RubberBand

Set empty rect flag

RubberBand

this

▸ setActive(active): RubberBand

set active state

Fires

Events.onStateChanged

RubberBand

AbstractRubberTool.setActive

▸ setAutoDisabled(mode): RubberBand

Set auto-disabled mode

RubberBand

this

▸ setEnabled(enabled): RubberBand

set enable state

Fires

Events.onEnabledStateChanged

Fires

Events.onStateChanged

RubberBand

this

AbstractRubberTool.setEnabled

▸ setFillStyle(fillStyle, merge?): RubberBand

Sets fill style

RubberBand

this

▸ setLineStyle(lineStyle, merge?): RubberBand

Sets line style

RubberBand

this

▸ setMinDimension(minDimension, isInDevice?): RubberBand

set minimum selection dimension

RubberBand

this

▸ setMinDimensionMode(mode): RubberBand

set minimum dimension mode

Example

import {Dimension} from '@int/geotoolkit/util/Dimension';
import {MinimumDimensionMode} from '@int/geotoolkit/controls/tools/RubberBand';
...
// The rubberband tool has several configuration options for controlling the maximum amount of zoom.
// First get rubber band tool
const rubberBandTool = widget.getToolByName('rubberband');

// The setMinDimension property can be used to limit the minimum box zoom to some fixed amount.
// Optional second parameter specifies whether to use model or device coordinates;
const minVerticalUnitsZoom = 50;
const useDeviceCoordinates = false;
rubberBandTool.setMinDimension(new Dimension(0, minVerticalUnitsZoom), useDeviceCoordinates);

// The setMinDimensionMode can be used to specify how the start/end should be adjusted if the minimum zoom level limit is reached.
// The smartMode expands highlighted area around selection
rubberBandTool.setMinDimensionMode(MinimumDimensionMode.Smart);

// The hardMode expands highlighted area from the start point
rubberBandTool.setMinDimensionMode(MinimumDimensionMode.Hard);

RubberBand

this

▸ setMode(mode): RubberBand

Sets rubberband rendering mode

RubberBand

this

▸ setMouseButtons(button): RubberBand

Sets mouse buttons for selection

RubberBand

this

AbstractRubberTool.setMouseButtons

▸ setMouseRadius(radius): RubberBand

Sets device radius for mouse events

RubberBand

this

AbstractRubberTool.setMouseRadius

▸ setName(name): RubberBand

set tool name

RubberBand

AbstractRubberTool.setName

▸ setProperties(properties?): RubberBand

Sets all the properties pertaining to this object

RubberBand

this

AbstractRubberTool.setProperties

▸ setProperty(name, value): RubberBand

Sets dynamic property by name

RubberBand

this

AbstractRubberTool.setProperty

▸ setRestrictionArea(restrictionArea): RubberBand

Set restriction area

RubberBand

▸ setRubberBandRenderMode(mode): RubberBand

Set the way the rectangle has to be displayed

RubberBand

AbstractRubberTool.setRubberBandRenderMode

▸ setSettings(options?): RubberBand

Set Settings

RubberBand

this

▸ setSilent(bool): RubberBand

Set silent mode

RubberBand

this

AbstractRubberTool.setSilent

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

Sets slot enabled

RubberBand

AbstractRubberTool.setSlotEnabled

▸ setSlots(slots?, merge?): RubberBand

Sets new slots.

Example

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

RubberBand

this

AbstractRubberTool.setSlots

▸ setTarget(node): RubberBand

Sets callback for selecting target Node from scene

RubberBand

▸ setTouchRadius(radius): RubberBand

Sets device radius for touch events

RubberBand

this

AbstractRubberTool.setTouchRadius

▸ Protected start(eventArgs?): RubberBand

start

RubberBand

AbstractRubberTool.start

▸ Protected stop(): RubberBand

stop

RubberBand

AbstractRubberTool.stop

▸ toggle(): RubberBand

switch enable state to opposite state

RubberBand

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