Skip to content

API / geotoolkit / widgets / overlays / AnnotationEventArgs / AnnotationEventArgs

Class: AnnotationEventArgs

overlays.AnnotationEventArgs.AnnotationEventArgs

Creates default implementation of the annotation overlay event args

Hierarchy

Table of contents

Constructors
  • [new AnnotationEventArgs(annotation, eventArgs)](/solutions/geotoolkit/GeoToolkit_JS/apis/classes/geotoolkit.widgets-1.overlays.annotationeventargs.annotationeventargs.md#new annotationeventargs(annotation, eventargs))
Methods

Contents

Constructors

new AnnotationEventArgs(annotation, eventArgs)

• new AnnotationEventArgs(annotation, eventArgs)

Parameters

Name Type Description
annotationIAnnotation | Annotationannotation
eventArgsEventArgscontains info about the event

Overrides

ProxyEventArgs.constructor

Methods

cancel

▸ cancel(): AnnotationEventArgs

Cancel event

Returns

AnnotationEventArgs

this


getAnnotation

▸ getAnnotation(): IAnnotation | Annotation

Return annotation

Returns

IAnnotation | Annotation


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


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


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(): AnnotationEventArgs

Prevents default

Returns

AnnotationEventArgs

this

Inherited from

ProxyEventArgs.preventDefault


setAnnotation

▸ setAnnotation(annotation): AnnotationEventArgs

Set object

Parameters

Name Type Description
annotationIAnnotation | Annotationannotation object

Returns

AnnotationEventArgs

this


setEventTarget

▸ setEventTarget(target): AnnotationEventArgs

Set event target

Parameters

Name Type Description
targetEventTarget | Nodeevent target

Returns

AnnotationEventArgs

Inherited from

ProxyEventArgs.setEventTarget


stopPropagation

▸ stopPropagation(preventDefault?, stopPropagation?): AnnotationEventArgs

Cancels event processing

Parameters

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

Returns

AnnotationEventArgs

this

Inherited from

ProxyEventArgs.stopPropagation