类:鼠标位置控件

ol/control/MousePosition~鼠标位置


import MousePosition from 'ol/control/MousePosition.js';

该控件用于显示鼠标光标的二维坐标。默认采用视图投影,但支持任何已定义的投影。控件默认位于地图右上角,其位置可通过CSS选择器 .ol-mouse-position 调整。

在通常没有鼠标光标的触摸设备上,会显示当前触摸位置的坐标。

new MousePosition(options)

Name Type 描述
className string (defaults to 'ol-mouse-position')

CSS类名。

coordinateFormat CoordinateFormat | undefined

坐标格式。

projection ProjectionLike | undefined

投影:默认为视图投影。

render function | undefined

当控件需要重新渲染时调用的函数。这被称为在arequestAnimationFrame回调。

target HTMLElement | string | undefined

如果您希望控件在地图视口之外渲染,请指定目标。

placeholder string | undefined

鼠标位置不可用时显示的提示内容(例如,指针离开地图视口时)。默认情况下,初始显示为一个不换行空格,且在鼠标离开视口时保留最后的位置。当提供字符串时(例如'no position'''对于空字符串,它被用作占位符。

wrapX boolean (defaults to true)

如果投影是全球投影,则将世界水平环绕在反子午线上。

触发事件:

继承

可观察属性

Name Type 可设置 ObjectEvent type 描述
coordinateFormat CoordinateFormat | undefined 是的 change:coordinateformat

当前位置的渲染格式。

projection Projection | undefined change:projection

用于报告鼠标位置的投影。

方法

递增修订计数器并触发“change”事件。

dispatchEvent(event){boolean | undefined} inherited

分发事件并调用所有侦听该类型事件的侦听器。事件参数可以是字符串,也可以是包含 type 属性的对象。

Name Type 描述
event BaseEvent | string

事件对象。

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

获取值。

Name Type 描述
key string

键名。

返回:
值。

getCoordinateFormat(){CoordinateFormat | undefined}

返回用于渲染当前位置的坐标格式类型或未定义。

返回:
当前位置的渲染格式。

getKeys(){Array.<string>} inherited

获取对象属性名称列表。

返回:
属性名列表。

获取与此控件关联的地图。

返回:
地图.

getProjection(){Projection | undefined}

返回用于报告鼠标位置的投影。

返回:
用于报告鼠标位置的投影。

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

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

返回:
对象。

getRevision(){number} inherited

获取该对象的版本号。每次修改对象时,其版本号将自动递增。

返回:
修订。

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

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

setCoordinateFormat(format)

设置用于渲染当前位置的坐标格式类型。

Name Type 描述
format CoordinateFormat

用于渲染当前位置的格式。

将控件从当前地图移除并附加到新地图。传递 null 以仅从当前地图中删除控件。子类可以在此处设置事件处理程序以接收地图更改的通知。

Name Type 描述
map Map | null

地图.

setProjection(projection)

设置用于报告鼠标位置的投影。

Name Type 描述
projection ProjectionLike

用于报告鼠标位置的投影。

setProperties(values, silent) inherited

设置键值对集合。注意:此操作会更新现有属性并添加新属性,但不会删除任何现有属性。

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

值。

silent boolean | undefined

更新而不触发事件。

此函数用于设置控件的目标元素。若在控件已添加到地图后调用此函数(即已在控件上调用 setMap 后),则无效。若在传递给控件构造函数的选项中未设置 target,且未调用 setTarget,则控件将被添加到地图的覆盖物容器中。

Name Type 描述
target HTMLElement | string

目标。

un(type, listener) inherited

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

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

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

listener function

监听器函数。

unset(key, silent) inherited

清除属性。

Name Type 描述
key string

键名

silent boolean | undefined

在不触发事件的情况下取消设置。