API / geotoolkit / widgets / tools / LegendToolEventArgs / LegendToolEventArgs
tools.LegendToolEventArgs.LegendToolEventArgs
ProxyEventArgs
↳
LegendToolEventArgs
Constructors
- [new LegendToolEventArgs(eventArgs, fromAnnotation, toAnnotation)](/solutions/geotoolkit/GeoToolkit_JS/apis/classes/geotoolkit.widgets-1.tools-2.legendtooleventargs.legendtooleventargs.md#new legendtooleventargs(eventargs, fromannotation, toannotation))
Methods
Constructors
• new LegendToolEventArgs(eventArgs, fromAnnotation?, toAnnotation?)
| Name | Type | Description |
|---|---|---|
eventArgs | EventArgs | contains info about the event |
Optional fromAnnotation | AnnotationLocation | move from Annotation |
Optional toAnnotation | AnnotationLocation | move to Annotation |
ProxyEventArgs.constructor
Methods
▸ getCSSPoint(): Point
Returns point in css coordinates
▸ getEventName(): string
Returns event name
string
▸ getEventTarget(): EventTarget | Node
Returns native event target
EventTarget | Node
▸ getFromAnnotation(): AnnotationLocation
Get annotation location from
annotation location from
▸ getNativeEventArgs(): Event
Returns original event args
Event
ProxyEventArgs.getNativeEventArgs
▸ getNode(): Node
Returns node on the plot
▸ getPlot(): Plot
Returns plot
plot
▸ getPlotPoint(): Point
Returns point in plot coordinate
▸ getToAnnotation(): AnnotationLocation
Get annotation location to
annotation location to
▸ inPlot(): boolean
Returns whether event position is inside of plot
boolean
▸ isCanceled(): boolean
Returns whether event has been cancelled
boolean
▸ isPreventDefault(): boolean
Returns whether event has been prevented default
boolean
ProxyEventArgs.isPreventDefault
▸ preventDefault(): LegendToolEventArgs
Prevents default
this
▸ setEventTarget(target): LegendToolEventArgs
Set event target
| Name | Type | Description |
|---|---|---|
target | EventTarget | Node | event target |
▸ stopPropagation(preventDefault?, stopPropagation?): LegendToolEventArgs
Cancels event processing
| Name | Type | Description |
|---|---|---|
Optional preventDefault | boolean | prevent default system events |
Optional stopPropagation | boolean | stop propagation to next listener |
this