Last updated

API / geotoolkit / widgets / tools / FloatingAnnotationTool / FloatingToolEventArgs

Class: FloatingToolEventArgs

tools.FloatingAnnotationTool.FloatingToolEventArgs

Define FloatingToolEventArgs

Hierarchy

Table of contents

Constructors
Methods

Contents

Constructors

new FloatingToolEventArgs(eventArgs, fromAnnotation, toAnnotation, item)

new FloatingToolEventArgs(eventArgs, fromAnnotation?, toAnnotation?, item?)

Creates

Parameters

Name Type Description
eventArgsEventArgscontains info about the event
Optional fromAnnotationAnnotationLocationmove from Annotation
Optional toAnnotationAnnotationLocationmove to Annotation
Optional itemFloatingAnnotation

Overrides

ProxyEventArgs.constructor

Methods

getCSSPoint

getCSSPoint(): Point

Returns point in css coordinates

Returns

Point

Inherited from

ProxyEventArgs.getCSSPoint


getEventName

getEventName(): string

Returns event name

Returns

string

Inherited from

ProxyEventArgs.getEventName


getEventTarget

getEventTarget(): EventTarget | Node

Returns native event target

Returns

EventTarget | Node

Inherited from

ProxyEventArgs.getEventTarget


getFromAnnotation

getFromAnnotation(): AnnotationLocation

Get annotation location from

Returns

AnnotationLocation

annotation location from


getNativeEventArgs

getNativeEventArgs(): Event

Returns original event args

Returns

Event

Inherited from

ProxyEventArgs.getNativeEventArgs


getNode

getNode(): Node

Returns node on the plot

Returns

Node

Inherited from

ProxyEventArgs.getNode


getPlot

getPlot(): Plot

Returns plot

Returns

Plot

plot

Inherited from

ProxyEventArgs.getPlot


getPlotPoint

getPlotPoint(): Point

Returns point in plot coordinate

Returns

Point

Inherited from

ProxyEventArgs.getPlotPoint


getSelectedItem

getSelectedItem(): FloatingAnnotation

Return selected item to move or resize

Returns

FloatingAnnotation

item


getToAnnotation

getToAnnotation(): AnnotationLocation

Get annotation location to

Returns

AnnotationLocation

annotation location to


inPlot

inPlot(): boolean

Returns whether event position is inside of plot

Returns

boolean

Inherited from

ProxyEventArgs.inPlot


isCanceled

isCanceled(): boolean

Returns whether event has been cancelled

Returns

boolean

Inherited from

ProxyEventArgs.isCanceled


isPreventDefault

isPreventDefault(): boolean

Returns whether event has been prevented default

Returns

boolean

Inherited from

ProxyEventArgs.isPreventDefault


preventDefault

preventDefault(): FloatingToolEventArgs

Prevents default

Returns

FloatingToolEventArgs

this

Inherited from

ProxyEventArgs.preventDefault


setEventTarget

setEventTarget(target): FloatingToolEventArgs

Set event target

Parameters

Name Type Description
targetEventTarget | Nodeevent target

Returns

FloatingToolEventArgs

Inherited from

ProxyEventArgs.setEventTarget


stopPropagation

stopPropagation(preventDefault?, stopPropagation?): FloatingToolEventArgs

Cancels event processing

Parameters

Name Type Description
Optional preventDefaultbooleanprevent default system events
Optional stopPropagationbooleanstop propagation to next listener

Returns

FloatingToolEventArgs

this

Inherited from

ProxyEventArgs.stopPropagation