Class: LegendTool

• [new LegendTool(options)](/solutions/geotoolkit/GeoToolkit_JS/apis/classes/geotoolkit.widgets-1.tools-2.legendtool.legendtool.md#new legendtool(options))

• new LegendTool(options)

CompositeTool.constructor

▸ add(tool): LegendTool

Add tool to the container.

LegendTool

CompositeTool.add

▸ addListener(eventName, listener): LegendTool

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)

LegendTool

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

CompositeTool.captureMouseUp

▸ dispatchEvent(eventName, eventArgs): boolean

Dispatch event through the handlers.

boolean

CompositeTool.dispatchEvent

▸ dispose(): void

Dispose tool.

void

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

CompositeTool.fireEvent

▸ getClassName(): string

string

CompositeTool.getClassName

▸ Protected getEventRadius(eventArgs): number

Returns device radius for the provided event

number

CompositeTool.getEventRadius

▸ getManipulatorLayer(): CompositeNode<Node&gt;

return manipulator layer

CompositeNode<Node&gt;

layer

CompositeTool.getManipulatorLayer

▸ getMouseRadius(): number

Returns current device radius for mouse events

number

CompositeTool.getMouseRadius

▸ getName(): string

return tool name if any

string

name of the tool

CompositeTool.getName

▸ getNode(): CompositeNode<Node&gt;

Returns node associated with manipulator.

CompositeNode<Node&gt;

CompositeTool.getNode

▸ getOptions(): Options

Get LegendTool options

Options

LegendTool options

▸ getParentTool(): AbstractCompositeTool

Gets parent tool

AbstractCompositeTool

parent tool

CompositeTool.getParentTool

▸ getProperties(context?): OptionsOut

Returns all the properties pertaining to this object

OptionsOut

An object containing the properties

CompositeTool.getProperties

▸ getProperty(name): any

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

any

CompositeTool.getProperty

▸ getPropertyKeys(): string[]

Returns known properties keys

string[]

CompositeTool.getPropertyKeys

▸ getRoot(): AbstractCompositeTool

Gets root tool

AbstractCompositeTool

parent tool

CompositeTool.getRoot

▸ getToolByName(name): AbstractTool

Returns the tool matching the given name. This function also accepts tool 'path' instead of absolute name. For example: getToolByName("compositeTool.panningTools.trackPanning.TrackPanning") Would return the same tool as getToolByName("TrackPanning") As long as there is only one tool named "TrackPanning" in this composite

See listToolsNames()

AbstractTool

CompositeTool.getToolByName

▸ getToolByType(type): AbstractTool

Returns the tool matching the given type.

AbstractTool

CompositeTool.getToolByType

▸ getToolIndex(tool): number

Return index of specified tool.

number

index of tool

CompositeTool.getToolIndex

▸ getTouchRadius(): number

Returns current device radius for touch events

number

CompositeTool.getTouchRadius

▸ hasEventListener(type, callback?): boolean

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

boolean

CompositeTool.hasEventListener

▸ insert(index, tool): LegendTool

Insert tool at specified index.

LegendTool

CompositeTool.insert

▸ isActive(): boolean

return active state

boolean

CompositeTool.isActive

▸ isDisposed(): boolean

Returns whether this object has been disposed

boolean

CompositeTool.isDisposed

▸ Protected isDoubleClick(point, eventArgs?): boolean

returns true if double clicked

boolean

CompositeTool.isDoubleClick

▸ isEnabled(): boolean

returns enable state

boolean

state

CompositeTool.isEnabled

▸ isSilent(): boolean

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

boolean

CompositeTool.isSilent

▸ isTouchEvent(eventArgs): boolean

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

boolean

CompositeTool.isTouchEvent

▸ listToolsNames(): string[]

List all the tools contained in this composite. Prepend their compositetool parent using a '.'

string[]

CompositeTool.listToolsNames

▸ notify<E&gt;(type, source, args?): LegendTool

Notify listeners

LegendTool

this

CompositeTool.notify

▸ off<E&gt;(type?, callback?): LegendTool

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.

LegendTool

this

CompositeTool.off

▸ on<E&gt;(type, callback): LegendTool

Attach listener on event that will be called whenever the specified event is delivered to the target <p> If the callback function is already in the list of event listeners for this target, the function is not added a second time. </p> <p> 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. </p> TypeScript hint: in case of creating derived tool with own events, EventMap should be extended and .on() and .notify() methods redeclared, see sample.

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

LegendTool

CompositeTool.on

▸ Protected onActiveStateChanged(): void

Fires

Events.onStateChanged

void

CompositeTool.onActiveStateChanged

▸ Protected onEnabledStateChanged(): void

Fires

Events.onEnabledStateChanged

void

CompositeTool.onEnabledStateChanged

▸ pageToCanvas(eventArgs, externalPlot?): Object

return position relative to the canvas

Object

CompositeTool.pageToCanvas

▸ pointToModel(model, eventArgs): Point

converts device coordinates to inner coordinates of node

Point

CompositeTool.pointToModel

▸ remove(tool): LegendTool

Remove tool from container.

LegendTool

CompositeTool.remove

▸ removeListener(eventName, listener?): LegendTool

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

Deprecated

since 4.0 use .off() instead.

LegendTool

CompositeTool.removeListener

▸ resetAnnotationSize(): LegendTool

Reset annotation size to original

LegendTool

this

▸ setActive(active): LegendTool

set active state

Fires

Events.onStateChanged

LegendTool

CompositeTool.setActive

▸ setEnabled(enabled): LegendTool

set enable state

Fires

Events.onEnabledStateChanged

Fires

Events.onStateChanged

LegendTool

this

CompositeTool.setEnabled

▸ setMouseRadius(radius): LegendTool

Sets device radius for mouse events

LegendTool

this

CompositeTool.setMouseRadius

▸ setName(name): LegendTool

set tool name

LegendTool

CompositeTool.setName

▸ setNode(node): LegendTool

Sets node associated with manipulator

LegendTool

this

CompositeTool.setNode

▸ setOptions(options): LegendTool

Set LegendTool options

LegendTool

this

▸ setProperties(properties?, context?): LegendTool

Sets all the properties pertaining to this object

LegendTool

this

CompositeTool.setProperties

▸ setProperty(name, value): LegendTool

Sets dynamic property by name

LegendTool

this

CompositeTool.setProperty

▸ setSilent(bool): LegendTool

Set silent mode

LegendTool

this

CompositeTool.setSilent

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

Sets slot enabled

LegendTool

CompositeTool.setSlotEnabled

▸ setSlots(slots?, merge?): LegendTool

Sets new slots.

Example

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

LegendTool

this

CompositeTool.setSlots

▸ setTouchRadius(radius): LegendTool

Sets device radius for touch events

LegendTool

this

CompositeTool.setTouchRadius

▸ Protected start(eventArgs?): LegendTool

start

LegendTool

CompositeTool.start

▸ Protected stop(): LegendTool

stop

LegendTool

CompositeTool.stop

▸ toggle(): LegendTool

switch enable state to opposite state

LegendTool

CompositeTool.toggle

▸ updateHandles(): LegendTool

Update adapter handles

LegendTool

this

▸ Static canvasToClient(plotPoint, plot): Point

Convert plot coordinates to global coordinates

Point

CompositeTool.canvasToClient

▸ Static clientToCanvas(nativeEvent, plot): Point

Convert global coordinates to plot coordinates

Point

CompositeTool.clientToCanvas

▸ Static getClassName(): string

string

CompositeTool.getClassName

▸ Static getExclusiveTool(plot): AbstractTool

return exclusive tool associated with plot

AbstractTool

tool

CompositeTool.getExclusiveTool

▸ Static getNativeEventName(eventName): string[]

Returns native event name

string[]

CompositeTool.getNativeEventName

▸ Static isTouchEvent(eventArgs): eventArgs is TouchEvent

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

eventArgs is TouchEvent

CompositeTool.isTouchEvent

▸ Static lock(plot, tool): void

Set exclusive tool for plot

void

CompositeTool.lock

▸ Static setDefaultMouseRadius(radius): void

Sets default device radius for mouse events

void

CompositeTool.setDefaultMouseRadius

▸ Static setDefaultTouchRadius(radius): void

Sets default device radius for touch events

void

CompositeTool.setDefaultTouchRadius

▸ Static unlock(value): void

Remove exclusive tool from plot

void

CompositeTool.unlock