Skip to main content

IInputManager

Enumerations

Button

Enumeration Members

Enumeration MemberValue
None"None"
Primary"Primary"
Secondary"Secondary"
Tertiary"Tertiary"

InputState

Enumeration Members

Enumeration MemberValue
Finished"Finished"
InProgress"InProgress"
Started"Started"

InputType

Enumeration Members

Enumeration MemberValue
Click"Click"
Hover"Hover"
Key"Key"
LongTap"LongTap"
Move"Move"
PointerDown"PointerDown"
Transform"Transform"
Wheel"Wheel"

NativeEventType

Enumeration Members

Enumeration MemberValue
KeyDown6
KeyUp7
MouseDown0
MouseMove2
MouseUp1
TouchEnd4
TouchMove5
TouchStart3
Wheel8

Interfaces

IContextMenuParams

Properties

items
items: Item[];
pointerParams
pointerParams: IPointerParams;

IInputManager

Methods

addOnInput()
addOnInput(handler): void;
Parameters
ParameterType
handler(params) => any
Returns

void

raiseNativeEvent()
raiseNativeEvent(event): void;
Parameters
ParameterType
eventINativeEvent
Returns

void

removeOnInput()
removeOnInput(handler): void;
Parameters
ParameterType
handler(params) => any
Returns

void


IInputParams

Extended by

Properties

altKey
altKey: boolean;
ctrlKey
ctrlKey: boolean;
metaKey
metaKey: boolean;
preventDefault
preventDefault: () => any;
Returns

any

shiftKey
shiftKey: boolean;
type
type: InputType;

IKeyboardEventParams

Extends

Properties

altKey
altKey: boolean;
Inherited from

IInputParams.altKey

code
code: string;
ctrlKey
ctrlKey: boolean;
Inherited from

IInputParams.ctrlKey

key
key: string;
metaKey
metaKey: boolean;
Inherited from

IInputParams.metaKey

preventDefault
preventDefault: () => any;
Returns

any

Inherited from

IInputParams.preventDefault

shiftKey
shiftKey: boolean;
Inherited from

IInputParams.shiftKey

state
state: InputState;
type
type: InputType;
Inherited from

IInputParams.type


IMovePointerParams

Extends

Properties

altKey
altKey: boolean;
Inherited from

IPointerParams.altKey

button
button: Button;
Inherited from

IPointerParams.button

clickCount
clickCount: number;
Inherited from

IPointerParams.clickCount

ctrlKey
ctrlKey: boolean;
Inherited from

IPointerParams.ctrlKey

isMobile
isMobile: boolean;
Inherited from

IPointerParams.isMobile

metaKey
metaKey: boolean;
Inherited from

IPointerParams.metaKey

page
page: PointF;
Inherited from

IPointerParams.page

preventDefault
preventDefault: () => any;
Returns

any

Inherited from

IPointerParams.preventDefault

shiftKey
shiftKey: boolean;
Inherited from

IPointerParams.shiftKey

startPage
startPage: PointF;
startWorkspace
startWorkspace: PointF;
state
state: InputState;
type
type: InputType;
Inherited from

IPointerParams.type

workspace
workspace: PointF;
Inherited from

IPointerParams.workspace


INativeEvent

Extended by

Properties

altKey
altKey: boolean;
ctrlKey
ctrlKey: boolean;
eventType
eventType: NativeEventType;
metaKey
metaKey: boolean;
preventDefault?
optional preventDefault?: () => any;
Returns

any

shiftKey
shiftKey: boolean;

INativeKeyEvent

Extends

Properties

altKey
altKey: boolean;
Inherited from

INativeEvent.altKey

code
code: string;
ctrlKey
ctrlKey: boolean;
Inherited from

INativeEvent.ctrlKey

eventType
eventType:
| KeyDown
| KeyUp;
Overrides

INativeEvent.eventType

key
key: string;
metaKey
metaKey: boolean;
Inherited from

INativeEvent.metaKey

preventDefault?
optional preventDefault?: () => any;
Returns

any

Inherited from

INativeEvent.preventDefault

shiftKey
shiftKey: boolean;
Inherited from

INativeEvent.shiftKey


INativeMouseEvent

Extends

Properties

altKey
altKey: boolean;
Inherited from

INativeEvent.altKey

button?
optional button?: Button;
coordinates
coordinates: PointF;
ctrlKey
ctrlKey: boolean;
Inherited from

INativeEvent.ctrlKey

eventType
eventType:
| MouseDown
| MouseUp
| MouseMove;
Overrides

INativeEvent.eventType

metaKey
metaKey: boolean;
Inherited from

INativeEvent.metaKey

preventDefault?
optional preventDefault?: () => any;
Returns

any

Inherited from

INativeEvent.preventDefault

shiftKey
shiftKey: boolean;
Inherited from

INativeEvent.shiftKey


INativeTouchEvent

Extends

Properties

altKey
altKey: boolean;
Inherited from

INativeEvent.altKey

changedTouches
changedTouches: PointF[];
ctrlKey
ctrlKey: boolean;
Inherited from

INativeEvent.ctrlKey

eventType
eventType:
| TouchStart
| TouchEnd
| TouchMove;
Overrides

INativeEvent.eventType

metaKey
metaKey: boolean;
Inherited from

INativeEvent.metaKey

preventDefault?
optional preventDefault?: () => any;
Returns

any

Inherited from

INativeEvent.preventDefault

shiftKey
shiftKey: boolean;
Inherited from

INativeEvent.shiftKey

touches
touches: PointF[];

INativeWheelEvent

Extends

Properties

altKey
altKey: boolean;
Inherited from

INativeEvent.altKey

ctrlKey
ctrlKey: boolean;
Inherited from

INativeEvent.ctrlKey

delta
delta: PointF;
eventType
eventType: NativeEventType;
Inherited from

INativeEvent.eventType

metaKey
metaKey: boolean;
Inherited from

INativeEvent.metaKey

preventDefault?
optional preventDefault?: () => any;
Returns

any

Inherited from

INativeEvent.preventDefault

shiftKey
shiftKey: boolean;
Inherited from

INativeEvent.shiftKey


IPointerParams

Extends

Extended by

Properties

altKey
altKey: boolean;
Inherited from

IInputParams.altKey

button
button: Button;
clickCount
clickCount: number;
ctrlKey
ctrlKey: boolean;
Inherited from

IInputParams.ctrlKey

isMobile
isMobile: boolean;
metaKey
metaKey: boolean;
Inherited from

IInputParams.metaKey

page
page: PointF;
preventDefault
preventDefault: () => any;
Returns

any

Inherited from

IInputParams.preventDefault

shiftKey
shiftKey: boolean;
Inherited from

IInputParams.shiftKey

type
type: InputType;
Inherited from

IInputParams.type

workspace
workspace: PointF;

ITransformViewportParams

Extends

Properties

altKey
altKey: boolean;
Inherited from

IInputParams.altKey

ctrlKey
ctrlKey: boolean;
Inherited from

IInputParams.ctrlKey

metaKey
metaKey: boolean;
Inherited from

IInputParams.metaKey

preventDefault
preventDefault: () => any;
Returns

any

Inherited from

IInputParams.preventDefault

scale
scale: number;
shiftKey
shiftKey: boolean;
Inherited from

IInputParams.shiftKey

state
state: InputState;
type
type: InputType;
Inherited from

IInputParams.type

zoomCenter
zoomCenter: PointF;

IWheelParams

Extends

Properties

altKey
altKey: boolean;
Inherited from

IInputParams.altKey

ctrlKey
ctrlKey: boolean;
Inherited from

IInputParams.ctrlKey

delta
delta: PointF;
metaKey
metaKey: boolean;
Inherited from

IInputParams.metaKey

preventDefault
preventDefault: () => any;
Returns

any

Inherited from

IInputParams.preventDefault

shiftKey
shiftKey: boolean;
Inherited from

IInputParams.shiftKey

type
type: InputType;
Inherited from

IInputParams.type

Functions

isNativeMouseEvent()

function isNativeMouseEvent(e): e is INativeMouseEvent;

Parameters

ParameterType
e| INativeMouseEvent | INativeTouchEvent

Returns

e is INativeMouseEvent

Was this page helpful?