Skip to content
Last updated

API / geotoolkit / controls / tools / AbstractShapeSelectionEventArgs / AbstractShapeSelectionEventArgs

Class: AbstractShapeSelectionEventArgs

tools.AbstractShapeSelectionEventArgs.AbstractShapeSelectionEventArgs

ProxyEventArgs

Hierarchy

Table of contents

Constructors
  • [new AbstractShapeSelectionEventArgs(eventArgs, selection, coordinates)](/solutions/geotoolkit/GeoToolkit_JS/apis/classes/geotoolkit.controls.tools.abstractshapeselectioneventargs.abstractshapeselectioneventargs.md#new abstractshapeselectioneventargs(eventargs, selection, coordinates))
Methods

Contents

Constructors

new AbstractShapeSelectionEventArgs(eventArgs, selection, coordinates)

• Protected new AbstractShapeSelectionEventArgs(eventArgs, selection, coordinates)

Creates AbstractShapeSelectionSelectionEventArgs

Parameters

Name Type Description
eventArgsEventArgscontains info about the event
selection(Node | SelectedItem<any&gt;)[]array of selected nodes
coordinatesObjectcoordinates
coordinates.xnumber[]
coordinates.ynumber[]

Overrides

ProxyEventArgs.constructor

Methods

getCSSPoint

▸ getCSSPoint(): Point

Returns point in css coordinates

Returns

Point

Inherited from

ProxyEventArgs.getCSSPoint


getCoordinates

▸ getCoordinates(): Object

Gets painted shape's coordinates in model coordinates

Returns

Object

NameType
xnumber[]
ynumber[]

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


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&gt;)[]

gets array of selected nodes

Returns

(Node | SelectedItem<any&gt;)[]

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


isPreventDefault

▸ isPreventDefault(): boolean

Returns whether event has been prevented default

Returns

boolean

Inherited from

ProxyEventArgs.isPreventDefault


preventDefault

▸ preventDefault(): AbstractShapeSelectionEventArgs

Prevents default

Returns

AbstractShapeSelectionEventArgs

this

Inherited from

ProxyEventArgs.preventDefault


setEventTarget

▸ setEventTarget(target): AbstractShapeSelectionEventArgs

Set event target

Parameters

Name Type Description
targetEventTarget | Nodeevent target

Returns

AbstractShapeSelectionEventArgs

Inherited from

ProxyEventArgs.setEventTarget


setSelection

▸ setSelection(selection): AbstractShapeSelectionEventArgs

set selection

Parameters

Name Type Description
selection(Node | SelectedItem<any&gt;)[]array of selected nodes

Returns

AbstractShapeSelectionEventArgs


stopPropagation

▸ stopPropagation(preventDefault?, stopPropagation?): AbstractShapeSelectionEventArgs

Cancels event processing

Parameters

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

Returns

AbstractShapeSelectionEventArgs

this

Inherited from

ProxyEventArgs.stopPropagation