Class: Link

Extends

• Interaction

Observable Properties

Name	Type	Settable	ObjectEvent type	Description
active	boolean	yes	change:active	如果交互处于激活状态则为 true，否则为 false。

Methods

changed() inherited

Observable.js, line 68

增加修订计数器并分发 'change' 事件。

dispatchEvent(event){boolean | undefined} inherited

events/Target.js, line 85

分发事件并调用所有监听此类型事件的监听器。事件参数可以是一个字符串或一个 具有 type 属性的对象。

Name	Type	Description
event	BaseEvent | string	事件对象。

返回值：

如果有人在事件对象上调用了 preventDefault 或任何监听器返回 false，则返回 false。

get(key){*} inherited

Object.js, line 136

获取一个值。

Name	Type	Description
key	string	键名。

返回值：

值。

getActive(){boolean} inherited

interaction/Interaction.js, line 82

返回交互当前是否激活。

返回值：

如果交互处于激活状态则为 true，否则为 false。

getKeys(){Array.<string>} inherited

Object.js, line 149

获取对象属性名列表。

返回值：

属性名列表。

getMap(){Map | null} inherited

interaction/Interaction.js, line 91

获取与此交互关联的地图。

返回值：

地图。

getProperties(){NoInfer.<Properties>} inherited

Object.js, line 158

获取包含所有属性名和值的对象。

返回值：

对象。

getRevision(){number} inherited

Observable.js, line 79

获取此对象的版本号。 每次对象被修改时，其版本号将递增。

返回值：

版本号。

handleEvent(mapBrowserEvent){boolean} inherited

interaction/Interaction.js, line 101

处理地图浏览器事件。

Name	Type	Description
mapBrowserEvent	MapBrowserEvent	地图浏览器事件。

返回值：

false 以停止事件传播。

on(type, listener){EventsKey | Array<EventsKey>} inherited

Observable.js, line 152

监听特定类型的事件。

Name	Type	Description
type	string | Array.<string>	事件类型或事件类型数组。
listener	function	监听器函数。

返回值：

监听器的唯一键。如果第一个参数是事件类型数组，则返回键的数组。

once(type, listener){EventsKey | Array<EventsKey>} inherited

Observable.js, line 164

仅监听一次特定类型的事件。

Name	Type	Description
type	string | Array.<string>	事件类型或事件类型数组。
listener	function	监听器函数。

返回值：

监听器的唯一键。如果第一个参数是事件类型数组，则返回键的数组。

set(key, value, silent) inherited

Object.js, line 218

设置一个值。

Name	Type	Description
key	string	键名。
value	*	值。
silent	boolean | undefined	更新但不触发事件。

setActive(active) inherited

interaction/Interaction.js, line 111

激活或停用交互。

Name	Type	Description
active	boolean	是否激活。

setProperties(values, silent) inherited

Object.js, line 238

设置一组键值对。 注意，这会更改任何现有属性并添加新属性（不会移除任何现有属性）。

Name	Type	Description
values	Partial.<NoInfer.<Properties>>	值。
silent	boolean | undefined	更新但不触发事件。

track(key, callback){string | null}

interaction/Link.js, line 384

注册 URL 搜索参数的监听器。当相应的搜索参数因历史事件（如浏览器导航）而更改时，将使用新值调用回调函数。

Name	Type	Description
key	string	URL 搜索参数。
callback	Callback	当搜索参数更改时调用的函数。

返回值：

搜索参数的初始值（如果 URL 中不存在则为 null）。

un(type, listener) inherited

Observable.js, line 173

取消监听特定类型的事件。

Name	Type	Description
type	string | Array.<string>	事件类型或事件类型数组。
listener	function	监听器函数。

unset(key, silent) inherited

Object.js, line 262

取消设置一个属性。

Name	Type	Description
key	string	键名。
silent	boolean | undefined	取消设置但不触发事件。

update(key, value)

interaction/Link.js, line 401

使用新的搜索参数值更新 URL。如果值为 null，则从搜索参数中删除。

Name	Type	Description
key	string	URL 搜索参数。
value	string | null	更新后的值（或 null 以从 URL 中删除）。