Last updated

API / geotoolkit / controls / tools / DOMEventArgs / DOMEventArgs

Class: DOMEventArgs

tools.DOMEventArgs.DOMEventArgs

DOMSupport event arguments

Hierarchy

Table of contents

Constructors
Methods

Contents

Constructors

new DOMEventArgs(selection, point, eventArgs, isClick)

new DOMEventArgs(selection, point, eventArgs?, isClick?)

Parameters

Name Type Description
selection(Node | SelectedItem<any>)[]array of selected nodes
pointPointmouse position in device coordinates
Optional eventArgsEventArgscontains info about the event
Optional isClickbooleantrue if event happened in the same element point

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


getMouseButton

getMouseButton(): MouseButton

Return mouse button

Returns

MouseButton


getMousePosition

getMousePosition(): Point

Return mouse position in device coordinates

Returns

Point


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


getSelection

getSelection(): (Node | SelectedItem<any>)[]

Returns array of selected nodes

Returns

(Node | SelectedItem<any>)[]

array of selected nodes


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


isClick

isClick(): boolean

Returns true if event is click event occurred within in the same element point

Returns

boolean


isPreventDefault

isPreventDefault(): boolean

Returns whether event has been prevented default

Returns

boolean

Inherited from

ProxyEventArgs.isPreventDefault


preventDefault

preventDefault(): DOMEventArgs

Prevents default

Returns

DOMEventArgs

this

Inherited from

ProxyEventArgs.preventDefault


setEventTarget

setEventTarget(target): DOMEventArgs

Set event target

Parameters

Name Type Description
targetEventTarget | Nodeevent target

Returns

DOMEventArgs

Inherited from

ProxyEventArgs.setEventTarget


stopPropagation

stopPropagation(preventDefault?, stopPropagation?): DOMEventArgs

Cancels event processing

Parameters

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

Returns

DOMEventArgs

this

Inherited from

ProxyEventArgs.stopPropagation