API / geotoolkit / widgets / tools / LegendTool / LegendTool
tools.LegendTool.LegendTool
Tool to handle moving and resizing of legend around annotated widget
Example
import {LegendTool} from '@int/geotoolkit/widgets/tools/LegendTool';
const legendTool = new LegendTool({
'widget': widget,
'layer': manipulatorLayer,
'group': legendShape
});
// Insert the tool to the head of tool's collection
widget.getTool().insert(0, legendTool);↳
LegendTool
Constructors
Methods
Css Properties
| Name | Type | Description |
|---|---|---|
enabled | boolean | Enabled state |
layer | CompositeNode | Manipulator layer |
layer-clipping | boolean | Enable clipping, this does not consider the clipstyle, it is related to bounds-clipping |
layer-clipstyle | ClipStyle | Clipping style |
layer-clipstyle-evenodd | boolean | True if evenodd mode is on ('nonzero' mode otherwise) |
layer-clipstyle-geometry | GraphicsPath | Clipping geometry |
layer-clipstyle-geometry-bounds | Rect | Bounds |
layer-clipstyle-geometry-bounds-height | number | Height |
layer-clipstyle-geometry-bounds-readonly | boolean | Readonly |
layer-clipstyle-geometry-bounds-width | number | Width |
layer-clipstyle-geometry-bounds-x | number | Left |
layer-clipstyle-geometry-bounds-y | number | Top |
layer-clipstyle | GraphicsPath | Clipping style |
layer-cssclass | string | The css class name of this node |
layer-csscursor | string | CSS cursor associated with node |
layer-cssstyle | string | CSS style to be applied to inserted elements |
layer-id | string | number | Id of the node, its a unique identifier |
layer-infinity | boolean | Mode to render outside the model limits |
layer-localtransform | Transformation | Local transformation |
layer-localtransform-dx | number | X axis translation |
layer-localtransform-dy | number | Y axis translation |
layer-localtransform-xx | number | X scale |
layer-localtransform-xy | number | Xy skew |
layer-localtransform-yx | number | Yx skew |
layer-localtransform-yy | number | Y scale |
layer-margins | number | string | It has properties for specifying the margins for each side |
layer-name | string | Name of the node. It is often used for debugging purposes or to simplify queries |
layer-opacity | number | Node opacity (from 0 to 1). If it is undefined or null it inherits property from the parent. It changes globalAlpha on the rendering context |
layer-opacityblendmode | BlendMode | Node opacity mode to blend it |
layer-scalescrollstrategy | ScaleScrollStrategy | Scale scroll strategy |
layer-scalescrollstrategy-enabled | boolean | Enable flag |
layer-selectable | boolean | Selectable node, a boolean to determine if selection should consider this node |
layer-tag | any | Custom information associated with node. It is a user object which can be used by client code to store information or attach an application object to the shape |
layer-transform | string | Additional CSS transformation applied to node or 'none' |
layer-transform | Transformation | Additional CSS transformation applied to node or 'none' |
layer-visible | boolean | Visibility of the node, a boolean to determine if the node should be rendered or not |
layer-z-index | number | Define node z-index |
mouseradius | number | Device radius for mouse events |
name | string | Name of the tool used like cross-hair etc |
touchradius | number | Device radius for touch events |
Methods
▸ add(tool): LegendTool
Add tool to the container.
| Name | Type | Description |
|---|---|---|
tool | AbstractTool | AbstractTool[] | abstract tool to be added |
▸ 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)
| Name | Type | Description |
|---|---|---|
eventName | string | event name or unique event identifier |
listener | Function | the event listener |
▸ 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
▸ dispatchEvent(eventName, eventArgs): boolean
Dispatch event through the handlers.
| Name | Type | Description |
|---|---|---|
eventName | string | contains the name of the event to dispatch. |
eventArgs | EventArgs | contains info of the event. |
boolean
▸ dispose(): void
Dispose tool.
void
▸ 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()
| Name | Type | Description |
|---|---|---|
eventName | string | event name |
Optional eventArgs | any | contains info of the event |
void
▸ getClassName(): string
string
▸ Protected getEventRadius(eventArgs): number
Returns device radius for the provided event
| Name | Type | Description |
|---|---|---|
eventArgs | EventArgs | contains info of the event |
number
▸ getManipulatorLayer(): CompositeNode<Node>
return manipulator layer
layer
CompositeTool.getManipulatorLayer
▸ getMouseRadius(): number
Returns current device radius for mouse events
number
▸ getName(): string
return tool name if any
string
name of the tool
▸ getNode(): CompositeNode<Node>
Returns node associated with manipulator.
▸ getOptions(): Options
Get LegendTool options
LegendTool options
▸ getParentTool(): AbstractCompositeTool
Gets parent tool
parent tool
▸ getProperties(context?): OptionsOut
Returns all the properties pertaining to this object
| Name | Type | Description |
|---|---|---|
Optional context | ISerializationContext | serialization context |
An object containing the properties
▸ getProperty(name): any
Gets dynamic property by name. These properties can be used as a property bags
| Name | Type | Description |
|---|---|---|
name | string | property name |
any
▸ getPropertyKeys(): string[]
Returns known properties keys
string[]
▸ getRoot(): AbstractCompositeTool
Gets root tool
parent tool
▸ 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()
| Name | Type | Description |
|---|---|---|
name | string | tool name or path |
▸ getToolByType(type): AbstractTool
Returns the tool matching the given type.
| Name | Type | Description |
|---|---|---|
type | ClassType<any> | type |
▸ getToolIndex(tool): number
Return index of specified tool.
| Name | Type | Description |
|---|---|---|
tool | AbstractTool | abstract tool |
number
index of tool
▸ getTouchRadius(): number
Returns current device radius for touch events
number
▸ hasEventListener(type, callback?): boolean
Check if a list of event listeners for this type contains this listener
| Name | Type | Description |
|---|---|---|
type | string | type of event or property |
Optional callback | Function | to be called, if null, check if any callback is registered |
boolean
CompositeTool.hasEventListener
▸ insert(index, tool): LegendTool
Insert tool at specified index.
| Name | Type | Description |
|---|---|---|
index | number | index to insert the tool |
tool | AbstractTool | AbstractTool[] | abstract tool |
▸ isActive(): boolean
return active state
boolean
▸ isDisposed(): boolean
Returns whether this object has been disposed
boolean
▸ Protected isDoubleClick(point, eventArgs?): boolean
returns true if double clicked
| Name | Type | Description |
|---|---|---|
point | Point | Click point |
Optional eventArgs | EventArgs | optional event args to verify double click |
boolean
▸ isEnabled(): boolean
returns enable state
boolean
state
▸ isSilent(): boolean
Return true if the event dispatcher doesn't notify any events
boolean
▸ isTouchEvent(eventArgs): boolean
return true if the event is a touch event and false otherwise.
| Name | Type | Description |
|---|---|---|
eventArgs | Event | EventArgs | contains info of the event |
boolean
▸ listToolsNames(): string[]
List all the tools contained in this composite. Prepend their compositetool parent using a '.'
string[]
▸ notify<E>(type, source, args?): LegendTool
Notify listeners
| Name | Type |
|---|---|
E | extends string |
| Name | Type | Description |
|---|---|---|
type | E | event types |
source | LegendTool | of the event |
Optional args | EventMap[E] | arguments of the event |
this
▸ off<E>(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.
| Name | Type |
|---|---|
E | extends string |
| Name | Type | Description |
|---|---|---|
Optional type | E | type of the event |
Optional callback | (eventType: E, sender: LegendTool, args: EventMap[E]) => void | function to be called |
this
▸ on<E>(type, callback): LegendTool
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.
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;
// ...
}| Name | Type |
|---|---|
E | extends string |
| Name | Type | Description |
|---|---|---|
type | E | type of event or property |
callback | (eventType: E, sender: LegendTool, args: EventMap[E]) => void | to be called |
▸ Protected onActiveStateChanged(): void
Fires
void
CompositeTool.onActiveStateChanged
▸ Protected onEnabledStateChanged(): void
Fires
void
CompositeTool.onEnabledStateChanged
▸ pageToCanvas(eventArgs, externalPlot?): Object
return position relative to the canvas
| Name | Type | Description |
|---|---|---|
eventArgs | Event | EventArgs | parentElement the parent HTML element |
Optional externalPlot | Plot | plot |
Object
| Name | Type |
|---|---|
x | number |
y | number |
▸ pointToModel(model, eventArgs): Point
converts device coordinates to inner coordinates of node
| Name | Type | Description |
|---|---|---|
model | Node | the model |
eventArgs | Point | EventArgs | arguments of the event OR point in device (plot) coordinates. |
▸ remove(tool): LegendTool
Remove tool from container.
| Name | Type | Description |
|---|---|---|
tool | AbstractTool | AbstractTool[] | to 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.
| Name | Type | Description |
|---|---|---|
eventName | string | event name |
Optional listener | Function | Function[] | the event listener, if null, remove all listeners for the event |
▸ resetAnnotationSize(): LegendTool
Reset annotation size to original
this
▸ setActive(active): LegendTool
set active state
Fires
| Name | Type | Description |
|---|---|---|
active | boolean | set active state |
▸ setEnabled(enabled): LegendTool
set enable state
Fires
Fires
| Name | Type | Description |
|---|---|---|
enabled | boolean | sets the enabled state |
this
▸ setMouseRadius(radius): LegendTool
Sets device radius for mouse events
| Name | Type | Description |
|---|---|---|
radius | number | radius for mouse events |
this
▸ setName(name): LegendTool
set tool name
| Name | Type | Description |
|---|---|---|
name | string | the tool name |
▸ setNode(node): LegendTool
Sets node associated with manipulator
| Name | Type | Description |
|---|---|---|
node | CompositeNode<Node> | node |
this
▸ setOptions(options): LegendTool
Set LegendTool options
| Name | Type | Description |
|---|---|---|
options | Options | LegendTool options |
this
▸ setProperties(properties?, context?): LegendTool
Sets all the properties pertaining to this object
| Name | Type | Description |
|---|---|---|
Optional properties | Options | An object containing the properties to set |
Optional context | IDeserializationContext | deserialization context |
this
▸ setProperty(name, value): LegendTool
Sets dynamic property by name
| Name | Type | Description |
|---|---|---|
name | string | property name |
value | any | property value |
this
▸ setSilent(bool): LegendTool
Set silent mode
| Name | Type | Description |
|---|---|---|
bool | boolean | flag to enable silent mode |
this
▸ setSlotEnabled(eventName, value, target?): LegendTool
Sets slot enabled
| Name | Type | Description |
|---|---|---|
eventName | string | eventName |
value | boolean | value |
Optional target | EventTarget | target |
▸ 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);| Name | Type | Description |
|---|---|---|
Optional slots | Record<string, Slot | Slot[] | (eventArgs: EventArgs) => void> | type of system events |
Optional merge | boolean | set to true if you want to merge with existing slots |
this
▸ setTouchRadius(radius): LegendTool
Sets device radius for touch events
| Name | Type | Description |
|---|---|---|
radius | number | radius for touch events |
this
▸ Protected start(eventArgs?): LegendTool
start
| Name | Type | Description |
|---|---|---|
Optional eventArgs | EventArgs | event args |
▸ Protected stop(): LegendTool
stop
▸ toggle(): LegendTool
switch enable state to opposite state
▸ updateHandles(): LegendTool
Update adapter handles
this
▸ Static canvasToClient(plotPoint, plot): Point
Convert plot coordinates to global coordinates
▸ Static clientToCanvas(nativeEvent, plot): Point
Convert global coordinates to plot coordinates
| Name | Type | Description |
|---|---|---|
nativeEvent | Event | native browser event |
plot | Plot | plot with canvas |
▸ Static getClassName(): string
string
▸ Static getExclusiveTool(plot): AbstractTool
return exclusive tool associated with plot
| Name | Type | Description |
|---|---|---|
plot | Plot | plot |
tool
CompositeTool.getExclusiveTool
▸ Static getNativeEventName(eventName): string[]
Returns native event name
| Name | Type | Description |
|---|---|---|
eventName | string | W3C Pointer Events Recommendation name |
string[]
CompositeTool.getNativeEventName
▸ Static isTouchEvent(eventArgs): eventArgs is TouchEvent
return true if the event is a touch event and false otherwise.
| Name | Type | Description |
|---|---|---|
eventArgs | Event | EventArgs | contains info of the event |
eventArgs is TouchEvent
▸ Static lock(plot, tool): void
Set exclusive tool for plot
| Name | Type | Description |
|---|---|---|
plot | Plot | plot |
tool | AbstractTool | tool |
void
▸ Static setDefaultMouseRadius(radius): void
Sets default device radius for mouse events
| Name | Type | Description |
|---|---|---|
radius | number | radius for mouse events |
void
CompositeTool.setDefaultMouseRadius
▸ Static setDefaultTouchRadius(radius): void
Sets default device radius for touch events
| Name | Type | Description |
|---|---|---|
radius | number | radius for touch events |
void
CompositeTool.setDefaultTouchRadius
▸ Static unlock(value): void
Remove exclusive tool from plot
| Name | Type | Description |
|---|---|---|
value | AbstractTool | Plot | value |
void