3d-wrapper

@cognite/3d-wrapper-base > ViewerPointerEvent

Interface: ViewerPointerEvent

Extended Pointer event which included information about the objects clicked in the viewer export:

interface: ViewerPointerEvent

extends: {PointerEvent}

Hierarchy

PointerEvent

↳ ViewerPointerEvent

Index

Properties

Methods

Properties

AT_TARGET

● AT_TARGET: number

Inherited from Event.AT_TARGET

Defined in /Users/chadbissett/Documents/3d-wrapper/packages/3d-wrapper-base/node_modules/typescript/lib/lib.dom.d.ts:4899

BUBBLING_PHASE

● BUBBLING_PHASE: number

Inherited from Event.BUBBLING_PHASE

Defined in /Users/chadbissett/Documents/3d-wrapper/packages/3d-wrapper-base/node_modules/typescript/lib/lib.dom.d.ts:4900

CAPTURING_PHASE

● CAPTURING_PHASE: number

Inherited from Event.CAPTURING_PHASE

Defined in /Users/chadbissett/Documents/3d-wrapper/packages/3d-wrapper-base/node_modules/typescript/lib/lib.dom.d.ts:4901

NONE

● NONE: number

Inherited from Event.NONE

Defined in /Users/chadbissett/Documents/3d-wrapper/packages/3d-wrapper-base/node_modules/typescript/lib/lib.dom.d.ts:4902

PointerEvent

● PointerEvent: object

Defined in /Users/chadbissett/Documents/3d-wrapper/packages/3d-wrapper-base/node_modules/typescript/lib/lib.dom.d.ts:11110

Type declaration

altKey

● altKey: boolean

Inherited from MouseEvent.altKey

Defined in /Users/chadbissett/Documents/3d-wrapper/packages/3d-wrapper-base/node_modules/typescript/lib/lib.dom.d.ts:10008

bubbles

● bubbles: boolean

Inherited from Event.bubbles

Defined in /Users/chadbissett/Documents/3d-wrapper/packages/3d-wrapper-base/node_modules/typescript/lib/lib.dom.d.ts:4850

Returns true or false depending on how event was initialized. True if event goes through its target’s ancestors in reverse tree order, and false otherwise.

button

● button: number

Inherited from MouseEvent.button

Defined in /Users/chadbissett/Documents/3d-wrapper/packages/3d-wrapper-base/node_modules/typescript/lib/lib.dom.d.ts:10009

buttons

● buttons: number

Inherited from MouseEvent.buttons

Defined in /Users/chadbissett/Documents/3d-wrapper/packages/3d-wrapper-base/node_modules/typescript/lib/lib.dom.d.ts:10010

cancelBubble

● cancelBubble: boolean

Inherited from Event.cancelBubble

Defined in /Users/chadbissett/Documents/3d-wrapper/packages/3d-wrapper-base/node_modules/typescript/lib/lib.dom.d.ts:4851

cancelable

● cancelable: boolean

Inherited from Event.cancelable

Defined in /Users/chadbissett/Documents/3d-wrapper/packages/3d-wrapper-base/node_modules/typescript/lib/lib.dom.d.ts:4852

clientX

● clientX: number

Inherited from MouseEvent.clientX

Defined in /Users/chadbissett/Documents/3d-wrapper/packages/3d-wrapper-base/node_modules/typescript/lib/lib.dom.d.ts:10011

clientY

● clientY: number

Inherited from MouseEvent.clientY

Defined in /Users/chadbissett/Documents/3d-wrapper/packages/3d-wrapper-base/node_modules/typescript/lib/lib.dom.d.ts:10012

composed

● composed: boolean

Inherited from Event.composed

Defined in /Users/chadbissett/Documents/3d-wrapper/packages/3d-wrapper-base/node_modules/typescript/lib/lib.dom.d.ts:4856

Returns true or false depending on how event was initialized. True if event invokes listeners past a ShadowRoot node that is the root of its target, and false otherwise.

ctrlKey

● ctrlKey: boolean

Inherited from MouseEvent.ctrlKey

Defined in /Users/chadbissett/Documents/3d-wrapper/packages/3d-wrapper-base/node_modules/typescript/lib/lib.dom.d.ts:10013

currentTarget

● currentTarget: * EventTarget | null *

Inherited from Event.currentTarget

Defined in /Users/chadbissett/Documents/3d-wrapper/packages/3d-wrapper-base/node_modules/typescript/lib/lib.dom.d.ts:4861

Returns the object whose event listener’s callback is currently being invoked.

defaultPrevented

● defaultPrevented: boolean

Inherited from Event.defaultPrevented

Defined in /Users/chadbissett/Documents/3d-wrapper/packages/3d-wrapper-base/node_modules/typescript/lib/lib.dom.d.ts:4862

detail

● detail: number

Inherited from UIEvent.detail

Defined in /Users/chadbissett/Documents/3d-wrapper/packages/3d-wrapper-base/node_modules/typescript/lib/lib.dom.d.ts:14832

eventPhase

● eventPhase: number

Inherited from Event.eventPhase

Defined in /Users/chadbissett/Documents/3d-wrapper/packages/3d-wrapper-base/node_modules/typescript/lib/lib.dom.d.ts:4863

fromElement

● fromElement: Element

Inherited from MouseEvent.fromElement

Defined in /Users/chadbissett/Documents/3d-wrapper/packages/3d-wrapper-base/node_modules/typescript/lib/lib.dom.d.ts:10015

deprecated:

height

● height: number

Inherited from PointerEvent.height

Defined in /Users/chadbissett/Documents/3d-wrapper/packages/3d-wrapper-base/node_modules/typescript/lib/lib.dom.d.ts:11098

isPrimary

● isPrimary: boolean

Inherited from PointerEvent.isPrimary

Defined in /Users/chadbissett/Documents/3d-wrapper/packages/3d-wrapper-base/node_modules/typescript/lib/lib.dom.d.ts:11099

isTrusted

● isTrusted: boolean

Inherited from Event.isTrusted

Defined in /Users/chadbissett/Documents/3d-wrapper/packages/3d-wrapper-base/node_modules/typescript/lib/lib.dom.d.ts:4868

Returns true if event was dispatched by the user agent, and false otherwise.

layerX

● layerX: number

Inherited from MouseEvent.layerX

Defined in /Users/chadbissett/Documents/3d-wrapper/packages/3d-wrapper-base/node_modules/typescript/lib/lib.dom.d.ts:10016

layerY

● layerY: number

Inherited from MouseEvent.layerY

Defined in /Users/chadbissett/Documents/3d-wrapper/packages/3d-wrapper-base/node_modules/typescript/lib/lib.dom.d.ts:10017

metaKey

● metaKey: boolean

Inherited from MouseEvent.metaKey

Defined in /Users/chadbissett/Documents/3d-wrapper/packages/3d-wrapper-base/node_modules/typescript/lib/lib.dom.d.ts:10018

movementX

● movementX: number

Inherited from MouseEvent.movementX

Defined in /Users/chadbissett/Documents/3d-wrapper/packages/3d-wrapper-base/node_modules/typescript/lib/lib.dom.d.ts:10019

movementY

● movementY: number

Inherited from MouseEvent.movementY

Defined in /Users/chadbissett/Documents/3d-wrapper/packages/3d-wrapper-base/node_modules/typescript/lib/lib.dom.d.ts:10020

<Optional> nodeId

● nodeId: * undefined | number *

Defined in WrappedViewer/WrappedViewer.ts:55

NodeID of the Node clicked in the 3D viewer type: {number}

memberof: ViewerPointerEvent

offsetX

● offsetX: number

Inherited from MouseEvent.offsetX

Defined in /Users/chadbissett/Documents/3d-wrapper/packages/3d-wrapper-base/node_modules/typescript/lib/lib.dom.d.ts:10021

offsetY

● offsetY: number

Inherited from MouseEvent.offsetY

Defined in /Users/chadbissett/Documents/3d-wrapper/packages/3d-wrapper-base/node_modules/typescript/lib/lib.dom.d.ts:10022

pageX

● pageX: number

Inherited from MouseEvent.pageX

Defined in /Users/chadbissett/Documents/3d-wrapper/packages/3d-wrapper-base/node_modules/typescript/lib/lib.dom.d.ts:10023

pageY

● pageY: number

Inherited from MouseEvent.pageY

Defined in /Users/chadbissett/Documents/3d-wrapper/packages/3d-wrapper-base/node_modules/typescript/lib/lib.dom.d.ts:10024

<Optional> point

● point: number[]

Defined in WrappedViewer/WrappedViewer.ts:62

Location of the point clicked in the 3D space. type: {number[]}

memberof: ViewerPointerEvent

pointerId

● pointerId: number

Inherited from PointerEvent.pointerId

Defined in /Users/chadbissett/Documents/3d-wrapper/packages/3d-wrapper-base/node_modules/typescript/lib/lib.dom.d.ts:11100

pointerType

● pointerType: string

Inherited from PointerEvent.pointerType

Defined in /Users/chadbissett/Documents/3d-wrapper/packages/3d-wrapper-base/node_modules/typescript/lib/lib.dom.d.ts:11101

pressure

● pressure: number

Inherited from PointerEvent.pressure

Defined in /Users/chadbissett/Documents/3d-wrapper/packages/3d-wrapper-base/node_modules/typescript/lib/lib.dom.d.ts:11102

relatedTarget

● relatedTarget: EventTarget

Inherited from MouseEvent.relatedTarget

Defined in /Users/chadbissett/Documents/3d-wrapper/packages/3d-wrapper-base/node_modules/typescript/lib/lib.dom.d.ts:10025

returnValue

● returnValue: boolean

Inherited from Event.returnValue

Defined in /Users/chadbissett/Documents/3d-wrapper/packages/3d-wrapper-base/node_modules/typescript/lib/lib.dom.d.ts:4869

screenX

● screenX: number

Inherited from MouseEvent.screenX

Defined in /Users/chadbissett/Documents/3d-wrapper/packages/3d-wrapper-base/node_modules/typescript/lib/lib.dom.d.ts:10026

screenY

● screenY: number

Inherited from MouseEvent.screenY

Defined in /Users/chadbissett/Documents/3d-wrapper/packages/3d-wrapper-base/node_modules/typescript/lib/lib.dom.d.ts:10027

shiftKey

● shiftKey: boolean

Inherited from MouseEvent.shiftKey

Defined in /Users/chadbissett/Documents/3d-wrapper/packages/3d-wrapper-base/node_modules/typescript/lib/lib.dom.d.ts:10028

srcElement

● srcElement: * Element | null *

Inherited from Event.srcElement

Defined in /Users/chadbissett/Documents/3d-wrapper/packages/3d-wrapper-base/node_modules/typescript/lib/lib.dom.d.ts:4870

tangentialPressure

● tangentialPressure: number

Inherited from PointerEvent.tangentialPressure

Defined in /Users/chadbissett/Documents/3d-wrapper/packages/3d-wrapper-base/node_modules/typescript/lib/lib.dom.d.ts:11103

target

● target: * EventTarget | null *

Inherited from Event.target

Defined in /Users/chadbissett/Documents/3d-wrapper/packages/3d-wrapper-base/node_modules/typescript/lib/lib.dom.d.ts:4874

Returns the object to which event is dispatched (its target).

tiltX

● tiltX: number

Inherited from PointerEvent.tiltX

Defined in /Users/chadbissett/Documents/3d-wrapper/packages/3d-wrapper-base/node_modules/typescript/lib/lib.dom.d.ts:11104

tiltY

● tiltY: number

Inherited from PointerEvent.tiltY

Defined in /Users/chadbissett/Documents/3d-wrapper/packages/3d-wrapper-base/node_modules/typescript/lib/lib.dom.d.ts:11105

timeStamp

● timeStamp: number

Inherited from Event.timeStamp

Defined in /Users/chadbissett/Documents/3d-wrapper/packages/3d-wrapper-base/node_modules/typescript/lib/lib.dom.d.ts:4879

Returns the event’s timestamp as the number of milliseconds measured relative to the time origin.

toElement

● toElement: Element

Inherited from MouseEvent.toElement

Defined in /Users/chadbissett/Documents/3d-wrapper/packages/3d-wrapper-base/node_modules/typescript/lib/lib.dom.d.ts:10030

deprecated:

twist

● twist: number

Inherited from PointerEvent.twist

Defined in /Users/chadbissett/Documents/3d-wrapper/packages/3d-wrapper-base/node_modules/typescript/lib/lib.dom.d.ts:11106

type

● type: string

Inherited from Event.type

Defined in /Users/chadbissett/Documents/3d-wrapper/packages/3d-wrapper-base/node_modules/typescript/lib/lib.dom.d.ts:4885

Returns the type of event, e.g. “click”, “hashchange”, or “submit”.

view

● view: Window

Inherited from UIEvent.view

Defined in /Users/chadbissett/Documents/3d-wrapper/packages/3d-wrapper-base/node_modules/typescript/lib/lib.dom.d.ts:14833

which

● which: number

Inherited from MouseEvent.which

Defined in /Users/chadbissett/Documents/3d-wrapper/packages/3d-wrapper-base/node_modules/typescript/lib/lib.dom.d.ts:10032

deprecated:

width

● width: number

Inherited from PointerEvent.width

Defined in /Users/chadbissett/Documents/3d-wrapper/packages/3d-wrapper-base/node_modules/typescript/lib/lib.dom.d.ts:11107

x

● x: number

Inherited from MouseEvent.x

Defined in /Users/chadbissett/Documents/3d-wrapper/packages/3d-wrapper-base/node_modules/typescript/lib/lib.dom.d.ts:10033

y

● y: number

Inherited from MouseEvent.y

Defined in /Users/chadbissett/Documents/3d-wrapper/packages/3d-wrapper-base/node_modules/typescript/lib/lib.dom.d.ts:10034

Methods

composedPath

▸ composedPath(): EventTarget[]

Inherited from Event.composedPath

Defined in /Users/chadbissett/Documents/3d-wrapper/packages/3d-wrapper-base/node_modules/typescript/lib/lib.dom.d.ts:4886

Returns: EventTarget[]

getModifierState

▸ getModifierState(keyArg: string): boolean

Inherited from MouseEvent.getModifierState

Defined in /Users/chadbissett/Documents/3d-wrapper/packages/3d-wrapper-base/node_modules/typescript/lib/lib.dom.d.ts:10035

Parameters:

Name Type
keyArg string

Returns: boolean

initEvent

▸ initEvent(type: string, bubbles?: * undefined | false | true, cancelable?: * undefined | false | true): void

Inherited from Event.initEvent

Defined in /Users/chadbissett/Documents/3d-wrapper/packages/3d-wrapper-base/node_modules/typescript/lib/lib.dom.d.ts:4887

Parameters:

Name Type
type string
Optional bubbles undefined | false | true
Optional cancelable undefined | false | true

Returns: void

initMouseEvent

▸ initMouseEvent(typeArg: string, canBubbleArg: boolean, cancelableArg: boolean, viewArg: Window, detailArg: number, screenXArg: number, screenYArg: number, clientXArg: number, clientYArg: number, ctrlKeyArg: boolean, altKeyArg: boolean, shiftKeyArg: boolean, metaKeyArg: boolean, buttonArg: number, relatedTargetArg: * EventTarget | null*): void

Inherited from MouseEvent.initMouseEvent

Defined in /Users/chadbissett/Documents/3d-wrapper/packages/3d-wrapper-base/node_modules/typescript/lib/lib.dom.d.ts:10036

Parameters:

Name Type
typeArg string
canBubbleArg boolean
cancelableArg boolean
viewArg Window
detailArg number
screenXArg number
screenYArg number
clientXArg number
clientYArg number
ctrlKeyArg boolean
altKeyArg boolean
shiftKeyArg boolean
metaKeyArg boolean
buttonArg number
relatedTargetArg EventTarget | null

Returns: void

initUIEvent

▸ initUIEvent(typeArg: string, canBubbleArg: boolean, cancelableArg: boolean, viewArg: Window, detailArg: number): void

Inherited from UIEvent.initUIEvent

Defined in /Users/chadbissett/Documents/3d-wrapper/packages/3d-wrapper-base/node_modules/typescript/lib/lib.dom.d.ts:14834

Parameters:

Name Type
typeArg string
canBubbleArg boolean
cancelableArg boolean
viewArg Window
detailArg number

Returns: void

preventDefault

▸ preventDefault(): void

Inherited from Event.preventDefault

Defined in /Users/chadbissett/Documents/3d-wrapper/packages/3d-wrapper-base/node_modules/typescript/lib/lib.dom.d.ts:4888

Returns: void

stopImmediatePropagation

▸ stopImmediatePropagation(): void

Inherited from Event.stopImmediatePropagation

Defined in /Users/chadbissett/Documents/3d-wrapper/packages/3d-wrapper-base/node_modules/typescript/lib/lib.dom.d.ts:4894

Invoking this method prevents event from reaching any registered event listeners after the current one finishes running and, when dispatched in a tree, also prevents event from reaching any other objects.

Returns: void

stopPropagation

▸ stopPropagation(): void

Inherited from Event.stopPropagation

Defined in /Users/chadbissett/Documents/3d-wrapper/packages/3d-wrapper-base/node_modules/typescript/lib/lib.dom.d.ts:4898

When dispatched in a tree, invoking this method prevents event from reaching any objects other than the current object.

Returns: void