类:旋转

ol/control/Rotate~旋转


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

重置旋转为0的按钮控件。要设置此控件的样式,请使用CSS选择器.ol-rotate。当旋转为0时,.ol-hidden CSS选择器将添加到按钮。

new Rotate(options)

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

CSS 类名。

label string | HTMLElement (defaults to '⇧')

旋转按钮的标签文本。除文本外,也可使用元素(例如span该元素可以使用。

tipLabel string (defaults to 'Reset rotation')

旋转控件的提示文本。

compassClassName string (defaults to 'ol-compass')

指南针控件的 CSS 类名。

duration number (defaults to 250)

动画持续时间(毫秒)

autoHide boolean (defaults to true)

当旋转为0时隐藏控件。

render function | undefined

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

resetNorth function | undefined

控件被点击时调用的函数。这将覆盖默认行为。resetNorth.

target HTMLElement | string | undefined

若要将控件渲染在地图视口之外,请指定目标。

触发事件:

继承

方法

递增修订计数器并触发更改事件。

dispatchEvent(event){boolean | undefined} inherited

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

Name Type 描述
event BaseEvent | string

事件对象。

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

获取一个值。

Name Type 描述
key string

键名。

返回:
值。

getKeys(){Array.<string>} inherited

获取对象属性名称列表。

返回:
属性名列表

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

返回:
地图.

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

更新而不触发事件。

将控件从当前地图移除并附加到新地图。传递 null 以仅从当前地图移除控件。子类可在此处设置事件处理程序以监听地图更改。

Name Type 描述
map Map | null

地图.

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

取消设置而不触发事件。