Class: OverviewMap

ol/control/OverviewMap~OverviewMap


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

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

new OverviewMap(options)

Name Type Description
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

鹰眼地图的自定义视图(应使用与主地图相同的投影)。如果未提供,将使用与主地图相同投影的默认视图。

触发事件:

Extends

Methods

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

dispatchEvent(event){boolean | undefined} inherited

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

Name Type Description
event BaseEvent | string

事件对象。

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

获取一个值。

Name Type Description
key string

键名。

返回值:
值。

getCollapsed(){boolean}

判断鹰眼地图是否已折叠。

返回值:
鹰眼地图是否已折叠。

getCollapsible(){boolean}

返回true如果鹰眼地图可折叠,否则返回false

返回值:
控件是否可折叠。

getKeys(){Array.<string>} inherited

获取对象属性名列表。

返回值:
属性名列表。

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

返回值:
地图。

getOverviewMap(){Map}

返回鹰眼地图。

返回值:
鹰眼地图。

getProperties(){NoInfer.<Properties>} inherited

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

返回值:
对象。

getRevision(){number} inherited

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

返回值:
版本号。

getRotateWithView(){boolean}

返回true如果鹰眼地图视图可以旋转,否则返回false

返回值:
控件视图是否可以旋转。

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

监听特定类型的事件。

Name Type Description
type string | Array.<string>

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

listener function

监听器函数。

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

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

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

Name Type Description
type string | Array.<string>

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

listener function

监听器函数。

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

set(key, value, silent) inherited

设置一个值。

Name Type Description
key string

键名。

value *

值。

silent boolean | undefined

更新但不触发事件。

setCollapsed(collapsed)

根据传入参数折叠或展开鹰眼地图。如果鹰眼地图不可折叠或当前折叠状态已经是所请求的状态,则不会执行任何操作。

Name Type Description
collapsed boolean

控件是否已折叠。

setCollapsible(collapsible)

设置鹰眼地图是否可折叠。

Name Type Description
collapsible boolean

控件是否可折叠。

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

Name Type Description
map Map | null

地图。

setProperties(values, silent) inherited

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

Name Type Description
values Partial.<NoInfer.<Properties>>

值。

silent boolean | undefined

更新但不触发事件。

setRotateWithView(rotateWithView)

设置鹰眼地图视图是否应随主地图视图旋转。

Name Type Description
rotateWithView boolean

控件视图是否应旋转。

此函数用于设置控件的目标元素。如果在控件添加到地图之后调用(即在控件上调用了 setMap 之后),则不会产生任何效果。如果在传递给控件构造函数的选项中没有设置 target,并且也没有调用 setTarget,则控件将被添加到地图的叠加容器中。

Name Type Description
target HTMLElement | string

目标。

un(type, listener) inherited

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

Name Type Description
type string | Array.<string>

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

listener function

监听器函数。

unset(key, silent) inherited

取消设置一个属性。

Name Type Description
key string

键名。

silent boolean | undefined

取消设置但不触发事件。