Namespace: Event

Event

事件处理函数.

Usage
// 浏览器
<script type="text/javascript" src="https://iclient.supermap.io/dist/mapboxgl/iclient-mapboxgl.js"></script>
<script>
  const element = mapboxgl.supermap.Event.element();

  // 弃用的写法
  const result = SuperMap.Event.element();

</script>

// ES6 Import
import { Event } from '@supermapgis/iclient-mapboxgl';

const result = Event.element();

Members

KEY_BACKSPACEnumber

KEY_BACKSPACE

Default Value:
8

KEY_DELETEnumber

KEY_DELETE

Default Value:
46

KEY_DOWNnumber

KEY_DOWN

Default Value:
40

KEY_ESCnumber

KEY_ESC

Default Value:
27

KEY_LEFTnumber

KEY_LEFT

Default Value:
37

KEY_RETURNnumber

KEY_RETURN

Default Value:
13

KEY_RIGHTnumber

KEY_RIGHT

Default Value:
39

KEY_SPACEnumber

KEY_SPACE

Default Value:
32

KEY_TABnumber

KEY_TAB

Default Value:
9

KEY_UPnumber

KEY_UP

Default Value:
38

observersObject

事件观察者列表。

Default Value:
false

Methods

element(event){HTMLElement}

common/commontypes/Event.js, line 114

监听浏览器 DOM 事件。

Name Type Description
event Event

Event 对象。
Returns:
Type Description
HTMLElement 触发事件的 DOM 元素。

findElement(event, tagName){HTMLElement}

common/commontypes/Event.js, line 184

查询触发指定事件的 DOM 元素。

Name Type Description
event Event

Event 对象。
tagName string

html 标签名。
Returns:
Type Description
HTMLElement DOM 元素。

isLeftClick(event){boolean}

common/commontypes/Event.js, line 141

确定事件是否由左键单击引起。

Name Type Description
event Event

Event 对象。
Returns:
Type Description
boolean 是否点击鼠标左键。

isMultiTouch(event){boolean}

common/commontypes/Event.js, line 132

判断事件是否由多点触控引起。

Name Type Description
event Event

Event 对象。
Returns:
Type Description
boolean 是否存在多个当前在与触摸表面接触的 Touch 对象。

isRightClick(event){boolean}

common/commontypes/Event.js, line 151

确定事件是否由鼠标右键单击引起。

Name Type Description
event Event

Event 对象。
Returns:
Type Description
boolean 是否点击鼠标右键。

isSingleTouch(event){boolean}

common/commontypes/Event.js, line 123

判断事件是否由单次触摸引起。

Name Type Description
event Event

Event 对象。
Returns:
Type Description
boolean 是否有且只有一个当前在与触摸表面接触的 Touch 对象。

observe(elementParam, name, observer, useCapture)

common/commontypes/Event.js, line 200

监听事件，注册事件处理方法。

Name Type Default Description
elementParam HTMLElement | string

待监听的 DOM 对象或者其 ID 标识。
name string

监听事件的类别名称。
observer function

注册的事件处理方法。
useCapture boolean false 可选

是否捕获。

stop(event, allowDefault)

common/commontypes/Event.js, line 161

阻止事件冒泡。

Name Type Description
event Event

Event 对象。
allowDefault boolean

默认为 false，表示阻止事件的默认行为。

stopObserving(elementParam, name, observer, useCapture){boolean}

common/commontypes/Event.js, line 279

移除事件监听和注册的事件处理方法。注意：事件的移除和监听相对应，移除时的各属性信息必须监听时保持一致才能确保事件移除成功。

Name Type Default Description
elementParam HTMLElement | string

被监听的 DOM 元素或者其 ID。
name string

需要移除的被监听事件名称。
observer function

需要移除的事件处理方法。
useCapture boolean false 可选

是否捕获。
Returns:
Type Description
boolean 监听事件是否被移除。

stopObservingElement(elementParam)

common/commontypes/Event.js, line 256

移除给定 DOM 元素的监听事件。

Name Type Description
elementParam HTMLElement | string

待监听的 DOM 对象或者其 ID 标识。

unloadCache()

common/commontypes/Event.js, line 331

移除缓存中的监听事件。