类:链接

ol/interaction/Link~


import Link from 'ol/interaction/Link.js';

同步地图状态与URL的交互。

new Link(options)

Name Type 描述
animate boolean | AnimationOptions (defaults to true)

视图过渡动画。

params Array<Params> (defaults to ['x', 'y', 'z', 'r', 'l'])

需跟踪的属性。默认为跟踪。x (center x), y(中心y),z(缩放),r(旋转)和l(图层).

replace boolean (defaults to false)

在不创建新浏览器历史记录条目的情况下替换当前 URL。默认情况下,地图状态的变更会向浏览器历史记录添加新条目。

prefix string (defaults to '')

默认情况下,URL 会通过搜索参数 x、y、z 和 r 进行更新。为避免与应用程序中已有的搜索参数发生冲突,您可以为该交互所使用的参数指定自定义前缀(例如 'ol:')。

触发事件:

继承

可观察属性

Name Type 可设置 ObjectEvent type 描述
active boolean 是的 change:active

true如果交互处于活动状态,false否则。

方法

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

dispatchEvent(event){boolean | undefined} inherited

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

Name Type 描述
event BaseEvent | string

事件对象。

返回:
false 如果任何监听器在事件对象上调用了 preventDefault,或者任何监听器返回了 false。

获取一个值。

Name Type 描述
key string

键名

返回:

返回交互当前是否处于激活状态。

返回:
若交互处于激活状态,则为 true;否则为 false

getKeys(){Array.<string>} inherited

获取对象属性名称列表。

返回:
属性名称列表。

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

返回:
地图.

getProperties(){Object.<string, *>} inherited

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

返回:
对象。

getRevision(){number} inherited

获取该对象的版本号。每当对象被修改时,其版本号都会递增。

返回:
修订。

handleEvent(mapBrowserEvent){boolean} inherited

处理 map browser event

Name Type 描述
mapBrowserEvent MapBrowserEvent

地图浏览器事件。

返回:
false 用于停止事件传播。

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

监听特定类型的事件。

Name Type 描述
type string | Array.<string>

事件类型或事件类型数组。

listener function

监听器函数

返回:
监听器的唯一键。若以事件类型数组作为首个参数调用,则返回键数组。

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

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

Name Type 描述
type string | Array.<string>

事件类型或事件类型的数组

listener function

监听器函数

返回:
监听器的唯一键。若以事件类型数组作为首个参数调用,则返回键的数组。

set(key, value, silent) inherited

设置值。

Name Type 描述
key string

键名

value *

值。

silent boolean | undefined

更新时不触发事件。

激活或停用交互。

Name Type 描述
active boolean

激活的。

setProperties(values, silent) inherited

设置一组键值对。请注意,此操作将修改现有属性并添加新属性,但不会删除任何现有属性。

Name Type 描述
values Object.<string, *>

值。

silent boolean | undefined

在不触发事件的情况下更新。

track(key, callback){string | null}

为 URL 查询参数注册监听器。当相应查询参数因历史记录事件(如浏览器导航)发生变化时,回调函数将以新值被调用。

Name Type 描述
key string

URL查询参数。

callback Callback

搜索参数变化时调用的函数。

返回:
搜索参数的初始值(若 URL 中缺失,则为 null)。

un(type, listener) inherited

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

Name Type 描述
type string | Array.<string>

事件类型或事件类型数组。

listener function

监听器函数。

unset(key, silent) inherited

清除属性。

Name Type 描述
key string

键名

silent boolean | undefined

取消设置而不触发事件。

update(key, value)

使用新的查询参数值更新 URL。如果值为空,则从查询参数中移除。

Name Type 描述
key string

URL查询参数。

value string | null

更新值(或设为空值以从 URL 中移除)