---
title: "IInputManager | Customer's Canvas On-Premises"
canonical: "https://customerscanvas.com/docs/on-premises/design-atoms-js/reference/design-atoms/IInputManager/"
---

# IInputManager

> ***

## Enumerations

### Button

#### Enumeration Members

| Enumeration Member | Value |
| ------ | ------ |
|  `None` | `"None"` |
|  `Primary` | `"Primary"` |
|  `Secondary` | `"Secondary"` |
|  `Tertiary` | `"Tertiary"` |

### InputState

#### Enumeration Members

| Enumeration Member | Value |
| ------ | ------ |
|  `Finished` | `"Finished"` |
|  `InProgress` | `"InProgress"` |
|  `Started` | `"Started"` |

***

### InputType

#### Enumeration Members

| Enumeration Member | Value |
| ------ | ------ |
|  `Click` | `"Click"` |
|  `Hover` | `"Hover"` |
|  `Key` | `"Key"` |
|  `LongTap` | `"LongTap"` |
|  `Move` | `"Move"` |
|  `PointerDown` | `"PointerDown"` |
|  `Transform` | `"Transform"` |
|  `Wheel` | `"Wheel"` |

***

### NativeEventType

#### Enumeration Members

| Enumeration Member | Value |
| ------ | ------ |
|  `KeyDown` | `6` |
|  `KeyUp` | `7` |
|  `MouseDown` | `0` |
|  `MouseMove` | `2` |
|  `MouseUp` | `1` |
|  `TouchEnd` | `4` |
|  `TouchMove` | `5` |
|  `TouchStart` | `3` |
|  `Wheel` | `8` |

## Interfaces

### IContextMenuParams

#### Properties

##### items

```ts
items: Item[];
```

##### pointerParams

```ts
pointerParams: IPointerParams;
```

***

### IInputManager

#### Methods

##### addOnInput()

```ts
addOnInput(handler): void;
```

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `handler` | (`params`) => `any` |

###### Returns

`void`

##### raiseNativeEvent()

```ts
raiseNativeEvent(event): void;
```

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `event` | [`INativeEvent`](#inativeevent) |

###### Returns

`void`

##### removeOnInput()

```ts
removeOnInput(handler): void;
```

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `handler` | (`params`) => `any` |

###### Returns

`void`

***

### IInputParams

#### Extended by

- [`IPointerParams`](#ipointerparams)
- [`IWheelParams`](#iwheelparams)
- [`ITransformViewportParams`](#itransformviewportparams)
- [`IKeyboardEventParams`](#ikeyboardeventparams)

#### Properties

##### altKey

```ts
altKey: boolean;
```

##### ctrlKey

```ts
ctrlKey: boolean;
```

##### metaKey

```ts
metaKey: boolean;
```

##### preventDefault

```ts
preventDefault: () => any;
```

###### Returns

`any`

##### shiftKey

```ts
shiftKey: boolean;
```

##### type

```ts
type: InputType;
```

***

### IKeyboardEventParams

#### Extends

- [`IInputParams`](#iinputparams)

#### Properties

##### altKey

```ts
altKey: boolean;
```

###### Inherited from

[`IInputParams`](#iinputparams).[`altKey`](#altkey)

##### code

```ts
code: string;
```

##### ctrlKey

```ts
ctrlKey: boolean;
```

###### Inherited from

[`IInputParams`](#iinputparams).[`ctrlKey`](#ctrlkey)

##### key

```ts
key: string;
```

##### metaKey

```ts
metaKey: boolean;
```

###### Inherited from

[`IInputParams`](#iinputparams).[`metaKey`](#metakey)

##### preventDefault

```ts
preventDefault: () => any;
```

###### Returns

`any`

###### Inherited from

[`IInputParams`](#iinputparams).[`preventDefault`](#preventdefault)

##### shiftKey

```ts
shiftKey: boolean;
```

###### Inherited from

[`IInputParams`](#iinputparams).[`shiftKey`](#shiftkey)

##### state

```ts
state: InputState;
```

##### type

```ts
type: InputType;
```

###### Inherited from

[`IInputParams`](#iinputparams).[`type`](#type)

***

### IMovePointerParams

#### Extends

- [`IPointerParams`](#ipointerparams)

#### Properties

##### altKey

```ts
altKey: boolean;
```

###### Inherited from

[`IPointerParams`](#ipointerparams).[`altKey`](#altkey-8)

##### button

```ts
button: Button;
```

###### Inherited from

[`IPointerParams`](#ipointerparams).[`button`](#button-3)

##### clickCount

```ts
clickCount: number;
```

###### Inherited from

[`IPointerParams`](#ipointerparams).[`clickCount`](#clickcount-1)

##### ctrlKey

```ts
ctrlKey: boolean;
```

###### Inherited from

[`IPointerParams`](#ipointerparams).[`ctrlKey`](#ctrlkey-8)

##### isMobile

```ts
isMobile: boolean;
```

###### Inherited from

[`IPointerParams`](#ipointerparams).[`isMobile`](#ismobile-1)

##### metaKey

```ts
metaKey: boolean;
```

###### Inherited from

[`IPointerParams`](#ipointerparams).[`metaKey`](#metakey-8)

##### page

```ts
page: PointF;
```

###### Inherited from

[`IPointerParams`](#ipointerparams).[`page`](#page-1)

##### preventDefault

```ts
preventDefault: () => any;
```

###### Returns

`any`

###### Inherited from

[`IPointerParams`](#ipointerparams).[`preventDefault`](#preventdefault-8)

##### shiftKey

```ts
shiftKey: boolean;
```

###### Inherited from

[`IPointerParams`](#ipointerparams).[`shiftKey`](#shiftkey-8)

##### startPage

```ts
startPage: PointF;
```

##### startWorkspace

```ts
startWorkspace: PointF;
```

##### state

```ts
state: InputState;
```

##### type

```ts
type: InputType;
```

###### Inherited from

[`IPointerParams`](#ipointerparams).[`type`](#type-3)

##### workspace

```ts
workspace: PointF;
```

###### Inherited from

[`IPointerParams`](#ipointerparams).[`workspace`](#workspace-1)

***

### INativeEvent

#### Extended by

- [`INativeKeyEvent`](#inativekeyevent)
- [`INativeMouseEvent`](#inativemouseevent)
- [`INativeTouchEvent`](#inativetouchevent)
- [`INativeWheelEvent`](#inativewheelevent)

#### Properties

##### altKey

```ts
altKey: boolean;
```

##### ctrlKey

```ts
ctrlKey: boolean;
```

##### eventType

```ts
eventType: NativeEventType;
```

##### metaKey

```ts
metaKey: boolean;
```

##### preventDefault?

```ts
optional preventDefault?: () => any;
```

###### Returns

`any`

##### shiftKey

```ts
shiftKey: boolean;
```

***

### INativeKeyEvent

#### Extends

- [`INativeEvent`](#inativeevent)

#### Properties

##### altKey

```ts
altKey: boolean;
```

###### Inherited from

[`INativeEvent`](#inativeevent).[`altKey`](#altkey-3)

##### code

```ts
code: string;
```

##### ctrlKey

```ts
ctrlKey: boolean;
```

###### Inherited from

[`INativeEvent`](#inativeevent).[`ctrlKey`](#ctrlkey-3)

##### eventType

```ts
eventType: 
  | KeyDown
  | KeyUp;
```

###### Overrides

[`INativeEvent`](#inativeevent).[`eventType`](#eventtype)

##### key

```ts
key: string;
```

##### metaKey

```ts
metaKey: boolean;
```

###### Inherited from

[`INativeEvent`](#inativeevent).[`metaKey`](#metakey-3)

##### preventDefault?

```ts
optional preventDefault?: () => any;
```

###### Returns

`any`

###### Inherited from

[`INativeEvent`](#inativeevent).[`preventDefault`](#preventdefault-3)

##### shiftKey

```ts
shiftKey: boolean;
```

###### Inherited from

[`INativeEvent`](#inativeevent).[`shiftKey`](#shiftkey-3)

***

### INativeMouseEvent

#### Extends

- [`INativeEvent`](#inativeevent)

#### Properties

##### altKey

```ts
altKey: boolean;
```

###### Inherited from

[`INativeEvent`](#inativeevent).[`altKey`](#altkey-3)

##### button?

```ts
optional button?: Button;
```

##### coordinates

```ts
coordinates: PointF;
```

##### ctrlKey

```ts
ctrlKey: boolean;
```

###### Inherited from

[`INativeEvent`](#inativeevent).[`ctrlKey`](#ctrlkey-3)

##### eventType

```ts
eventType: 
  | MouseDown
  | MouseUp
  | MouseMove;
```

###### Overrides

[`INativeEvent`](#inativeevent).[`eventType`](#eventtype)

##### metaKey

```ts
metaKey: boolean;
```

###### Inherited from

[`INativeEvent`](#inativeevent).[`metaKey`](#metakey-3)

##### preventDefault?

```ts
optional preventDefault?: () => any;
```

###### Returns

`any`

###### Inherited from

[`INativeEvent`](#inativeevent).[`preventDefault`](#preventdefault-3)

##### shiftKey

```ts
shiftKey: boolean;
```

###### Inherited from

[`INativeEvent`](#inativeevent).[`shiftKey`](#shiftkey-3)

***

### INativeTouchEvent

#### Extends

- [`INativeEvent`](#inativeevent)

#### Properties

##### altKey

```ts
altKey: boolean;
```

###### Inherited from

[`INativeEvent`](#inativeevent).[`altKey`](#altkey-3)

##### changedTouches

```ts
changedTouches: PointF[];
```

##### ctrlKey

```ts
ctrlKey: boolean;
```

###### Inherited from

[`INativeEvent`](#inativeevent).[`ctrlKey`](#ctrlkey-3)

##### eventType

```ts
eventType: 
  | TouchStart
  | TouchEnd
  | TouchMove;
```

###### Overrides

[`INativeEvent`](#inativeevent).[`eventType`](#eventtype)

##### metaKey

```ts
metaKey: boolean;
```

###### Inherited from

[`INativeEvent`](#inativeevent).[`metaKey`](#metakey-3)

##### preventDefault?

```ts
optional preventDefault?: () => any;
```

###### Returns

`any`

###### Inherited from

[`INativeEvent`](#inativeevent).[`preventDefault`](#preventdefault-3)

##### shiftKey

```ts
shiftKey: boolean;
```

###### Inherited from

[`INativeEvent`](#inativeevent).[`shiftKey`](#shiftkey-3)

##### touches

```ts
touches: PointF[];
```

***

### INativeWheelEvent

#### Extends

- [`INativeEvent`](#inativeevent)

#### Properties

##### altKey

```ts
altKey: boolean;
```

###### Inherited from

[`INativeEvent`](#inativeevent).[`altKey`](#altkey-3)

##### ctrlKey

```ts
ctrlKey: boolean;
```

###### Inherited from

[`INativeEvent`](#inativeevent).[`ctrlKey`](#ctrlkey-3)

##### delta

```ts
delta: PointF;
```

##### eventType

```ts
eventType: NativeEventType;
```

###### Inherited from

[`INativeEvent`](#inativeevent).[`eventType`](#eventtype)

##### metaKey

```ts
metaKey: boolean;
```

###### Inherited from

[`INativeEvent`](#inativeevent).[`metaKey`](#metakey-3)

##### preventDefault?

```ts
optional preventDefault?: () => any;
```

###### Returns

`any`

###### Inherited from

[`INativeEvent`](#inativeevent).[`preventDefault`](#preventdefault-3)

##### shiftKey

```ts
shiftKey: boolean;
```

###### Inherited from

[`INativeEvent`](#inativeevent).[`shiftKey`](#shiftkey-3)

***

### IPointerParams

#### Extends

- [`IInputParams`](#iinputparams)

#### Extended by

- [`IMovePointerParams`](#imovepointerparams)

#### Properties

##### altKey

```ts
altKey: boolean;
```

###### Inherited from

[`IInputParams`](#iinputparams).[`altKey`](#altkey)

##### button

```ts
button: Button;
```

##### clickCount

```ts
clickCount: number;
```

##### ctrlKey

```ts
ctrlKey: boolean;
```

###### Inherited from

[`IInputParams`](#iinputparams).[`ctrlKey`](#ctrlkey)

##### isMobile

```ts
isMobile: boolean;
```

##### metaKey

```ts
metaKey: boolean;
```

###### Inherited from

[`IInputParams`](#iinputparams).[`metaKey`](#metakey)

##### page

```ts
page: PointF;
```

##### preventDefault

```ts
preventDefault: () => any;
```

###### Returns

`any`

###### Inherited from

[`IInputParams`](#iinputparams).[`preventDefault`](#preventdefault)

##### shiftKey

```ts
shiftKey: boolean;
```

###### Inherited from

[`IInputParams`](#iinputparams).[`shiftKey`](#shiftkey)

##### type

```ts
type: InputType;
```

###### Inherited from

[`IInputParams`](#iinputparams).[`type`](#type)

##### workspace

```ts
workspace: PointF;
```

***

### ITransformViewportParams

#### Extends

- [`IInputParams`](#iinputparams)

#### Properties

##### altKey

```ts
altKey: boolean;
```

###### Inherited from

[`IInputParams`](#iinputparams).[`altKey`](#altkey)

##### ctrlKey

```ts
ctrlKey: boolean;
```

###### Inherited from

[`IInputParams`](#iinputparams).[`ctrlKey`](#ctrlkey)

##### metaKey

```ts
metaKey: boolean;
```

###### Inherited from

[`IInputParams`](#iinputparams).[`metaKey`](#metakey)

##### preventDefault

```ts
preventDefault: () => any;
```

###### Returns

`any`

###### Inherited from

[`IInputParams`](#iinputparams).[`preventDefault`](#preventdefault)

##### scale

```ts
scale: number;
```

##### shiftKey

```ts
shiftKey: boolean;
```

###### Inherited from

[`IInputParams`](#iinputparams).[`shiftKey`](#shiftkey)

##### state

```ts
state: InputState;
```

##### type

```ts
type: InputType;
```

###### Inherited from

[`IInputParams`](#iinputparams).[`type`](#type)

##### zoomCenter

```ts
zoomCenter: PointF;
```

***

### IWheelParams

#### Extends

- [`IInputParams`](#iinputparams)

#### Properties

##### altKey

```ts
altKey: boolean;
```

###### Inherited from

[`IInputParams`](#iinputparams).[`altKey`](#altkey)

##### ctrlKey

```ts
ctrlKey: boolean;
```

###### Inherited from

[`IInputParams`](#iinputparams).[`ctrlKey`](#ctrlkey)

##### delta

```ts
delta: PointF;
```

##### metaKey

```ts
metaKey: boolean;
```

###### Inherited from

[`IInputParams`](#iinputparams).[`metaKey`](#metakey)

##### preventDefault

```ts
preventDefault: () => any;
```

###### Returns

`any`

###### Inherited from

[`IInputParams`](#iinputparams).[`preventDefault`](#preventdefault)

##### shiftKey

```ts
shiftKey: boolean;
```

###### Inherited from

[`IInputParams`](#iinputparams).[`shiftKey`](#shiftkey)

##### type

```ts
type: InputType;
```

###### Inherited from

[`IInputParams`](#iinputparams).[`type`](#type)

## Functions

### isNativeMouseEvent()

```ts
function isNativeMouseEvent(e): e is INativeMouseEvent;
```

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `e` | \| [`INativeMouseEvent`](#inativemouseevent) \| [`INativeTouchEvent`](#inativetouchevent) |

#### Returns

`e is INativeMouseEvent`