类:概览地图

ol/control/OverviewMap~概览地图


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

创建一个新控件,其中一个地图作为另一个已定义地图的概览地图。

new OverviewMap(options)

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

CSS类名

collapsed boolean (defaults to true)

控件初始是否折叠(展开)

collapseLabel string | HTMLElement (defaults to '‹')

用于展开式鹰眼图按钮的文本标签。除文本外,也可使用元素(例如span元素可以使用。

collapsible boolean (defaults to true)

控件是否可折叠。

label string | HTMLElement (defaults to '›')

折叠概览图按钮的文本标签。也可使用元素(例如图标)。span元素)可以使用。

layers Array<BaseLayer> | Collection<BaseLayer> | undefined

概览图的图层。

render function | undefined

控件需要重新渲染时所调用的函数。该函数在requestAnimationFrame回调函数。

rotateWithView boolean (defaults to false)

控制视图是否应随主地图视图旋转?

target HTMLElement | string | undefined

如需将控件渲染到地图视口之外,请指定目标。

tipLabel string (defaults to 'Overview map')

用于按钮提示的文本标签。

view View | undefined

概览地图的自定义视图(需使用与主地图相同的投影)。若未提供,将使用与主地图相同投影的默认视图。

触发事件:

继承

方法

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

dispatchEvent(event){boolean | undefined} inherited

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

Name Type 描述
event BaseEvent | string

事件对象。

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

获取值。

Name Type 描述
key string

键名。

返回:
值。

getCollapsed(){boolean}

确定概览地图是否折叠。

返回:
概览图已折叠。

getCollapsible(){boolean}

若概览地图可折叠,返回 true;否则返回 false

返回:
若组件可折叠,则为 true。

getKeys(){Array.<string>} inherited

获取对象属性名称列表。

返回:
属性名列表。

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

返回:
地图.

getOverviewMap(){Map}

返回概览图。

返回:
概览图。

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

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

返回:
对象。

getRevision(){number} inherited

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

返回:
修订。

getRotateWithView(){boolean}

若概览地图视图可旋转,返回 true;否则返回 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

更新而不触发事件。

setCollapsed(collapsed)

根据传入的参数折叠或展开概览图。若概览图不可折叠,或当前折叠状态已符合请求,则不执行任何操作。

Name Type 描述
collapsed boolean

小部件折叠时为真。

setCollapsible(collapsible)

设置概览地图是否可折叠。

Name Type 描述
collapsible boolean

如果组件可折叠,则为真。

将该控件从当前地图中移除,并添加至新地图。 传递 null 可仅将控件从当前地图中移除。 子类可在此处设置事件监听器,以便在地图发生变化时收到通知。

Name Type 描述
map Map | null

地图.

setProperties(values, silent) inherited

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

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

值。

silent boolean | undefined

更新而不触发事件。

setRotateWithView(rotateWithView)

设置概览地图视图是否随主地图视图旋转。

Name Type 描述
rotateWithView boolean

若视图需旋转,则为真。

该函数用于设置控件的目标元素。若在控件已添加到地图后调用(即在控件上调用 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

取消设置且不触发事件。