API / geotoolkit / welllog / widgets / tools / DepthShiftingTool / DepthShiftingToolEventArgs
tools.DepthShiftingTool.DepthShiftingToolEventArgs
DepthShiftingToolEventArgs
↳
DepthShiftingToolEventArgs
Constructors
- [new DepthShiftingToolEventArgs(eventArgs, index, from, to)](/solutions/geotoolkit/GeoToolkit_JS/apis/classes/geotoolkit.welllog.widgets-4.tools-5.depthshiftingtool.depthshiftingtooleventargs.md#new depthshiftingtooleventargs(eventargs, index, from, to))
Methods
Constructors
• new DepthShiftingToolEventArgs(eventArgs, index, from?, to?)
| Name | Type | Description |
|---|---|---|
eventArgs | EventArgs | info about the event arguments |
index | number | depth shift index |
Optional from | number | shift from depth |
Optional to | number | shift from to |
RejectableEventArgs.constructor
Methods
▸ getCSSPoint(): Point
Returns point in css coordinates
RejectableEventArgs.getCSSPoint
▸ getEventName(): string
Returns event name
string
RejectableEventArgs.getEventName
▸ getEventTarget(): EventTarget | Node
Returns native event target
EventTarget | Node
RejectableEventArgs.getEventTarget
▸ getFrom(): number
Return shift from depth
number
▸ getIndex(): number
Return depth mapping index
number
▸ getNativeEventArgs(): Event
Returns original event args
Event
RejectableEventArgs.getNativeEventArgs
▸ getNode(): Node
Returns node on the plot
▸ getPlot(): Plot
Returns plot
plot
▸ getPlotPoint(): Point
Returns point in plot coordinate
RejectableEventArgs.getPlotPoint
▸ getTarget(): any
returns target
Deprecated
since 4.0, use getEventTarget() instead
any
target
▸ getTo(): number
Return shift to depth
number
▸ inPlot(): boolean
Returns whether event position is inside of plot
boolean
▸ isCanceled(): boolean
Returns whether event has been cancelled
boolean
RejectableEventArgs.isCanceled
▸ isPreventDefault(): boolean
Returns whether event has been prevented default
boolean
RejectableEventArgs.isPreventDefault
▸ isRejected(): boolean
return rejected state
boolean
the state
RejectableEventArgs.isRejected
▸ preventDefault(): DepthShiftingToolEventArgs
Prevents default
this
RejectableEventArgs.preventDefault
▸ reject(doReject?): DepthShiftingToolEventArgs
reject action
| Name | Type | Description |
|---|---|---|
Optional doReject | boolean | reject event or not, true by default |
this
▸ setEventTarget(target): DepthShiftingToolEventArgs
Set event target
| Name | Type | Description |
|---|---|---|
target | EventTarget | Node | event target |
RejectableEventArgs.setEventTarget
▸ setTarget(target): DepthShiftingToolEventArgs
set target
Deprecated
since 4.0, use setEventTarget() instead
| Name | Type | Description |
|---|---|---|
target | any | object that initialised this event |
this
▸ stopPropagation(preventDefault?, stopPropagation?): DepthShiftingToolEventArgs
Cancels event processing
| Name | Type | Description |
|---|---|---|
Optional preventDefault | boolean | prevent default system events |
Optional stopPropagation | boolean | stop propagation to next listener |
this