@jtopo/core / Keyboard

Class: Keyboard

键盘抽象

示例：

// 绑定快捷键
let keyboard = stage.keyboard;

keyboard.bindKey('Shift+a', ()=> { 
   console.log('shift+a');  
});

// 解绑
keyboard.unbind('Shift+a');

Hierarchy

• EventTarget<EventsMap>

  ↳ Keyboard

Table of contents

Constructors

• constructor

Properties

• disabled

Methods

• addEventListener
• bindKey
• disable
• dispatchEvent
• enable
• getKeyBinding
• hasListener
• isAltDown
• isControlDown
• isKeyRegistered
• isKeydown
• isMetaDown
• isShiftDown
• on
• removeEventListener
• unbind

Constructors

constructor

new Keyboard()

Overrides

EventTarget.constructor

Properties

disabled

Readonly disabled: boolean = false

是否禁用

Methods

addEventListener

addEventListener<K>(type, callback): () => void

增加事件监听

Type parameters

Name	Type
K	extends KeyboardEventType

Parameters

Name	Type	Description
type	K	事件类型
callback	EventCallback<EventsMap[K]>

Returns

fn

(): void

Returns

void

Inherited from

EventTarget.addEventListener

---

bindKey

bindKey(keyInfo, fn, preventDefault?): void

绑定按键 (重复绑定会覆盖)

Parameters

Name	Type	Default value	Description
keyInfo	string	undefined	例如"Control+a" 、"Meta+a"、 ”G" 、”Shift+1“
fn	Function	undefined	-
preventDefault	boolean	false	-

Returns

void

---

disable

disable(): void

禁用jtopo的快捷键

Returns

void

---

dispatchEvent

dispatchEvent(event): void

分发事件

Parameters

Name	Type
event	any

Returns

void

Inherited from

EventTarget.dispatchEvent

---

enable

enable(): void

启用jtopo默认的快捷键

Returns

void

---

getKeyBinding

getKeyBinding(keyInfo): KeyboardBindOptions

获取按键绑定的函数

Parameters

Name	Type
keyInfo	string

Returns

KeyboardBindOptions

---

hasListener

hasListener<K>(type): boolean

是否有该类型的监听

Type parameters

Name	Type
K	extends KeyboardEventType

Parameters

Name	Type
type	K

Returns

boolean

Inherited from

EventTarget.hasListener

---

isAltDown

isAltDown(): boolean

Returns

boolean

---

isControlDown

isControlDown(): boolean

Returns

boolean

---

isKeyRegistered

isKeyRegistered(keyInfo): boolean

判断按键是否已经注册

Parameters

Name	Type
keyInfo	string

Returns

boolean

---

isKeydown

isKeydown(keyInfo): boolean

指定的单个键是否按下

Parameters

Name	Type
keyInfo	string

Returns

boolean

---

isMetaDown

isMetaDown(): boolean

Returns

boolean

---

isShiftDown

isShiftDown(): boolean

Returns

boolean

---

on

on<K>(type, callback): () => void

addEventLister的别名

Type parameters

Name	Type
K	extends KeyboardEventType

Parameters

Name	Type
type	K
callback	EventCallback<EventsMap[K]>

Returns

fn

(): void

Returns

void

Inherited from

EventTarget.on

---

removeEventListener

removeEventListener<K>(type, callback): any

移除一个事件监听

Type parameters

Name	Type
K	extends KeyboardEventType

Parameters

Name	Type
type	K
callback	EventCallback<EventsMap[K]>

Returns

any

Inherited from

EventTarget.removeEventListener

---

unbind

unbind(keyInfo): void

解绑按键

Parameters

Name	Type	Description
keyInfo	string	例如"Control+a" 、"Meta+a"、 ”G" 、”Shift+1“

Returns

void