类:归属

ol/control/Attribution~归属


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

控件用于显示地图中图层源的所有相关属性。该控件是地图内置的默认控件之一,默认显示在地图右下角,但可通过 .ol-attribution 的 CSS 选择器进行更改。

new Attribution(options)

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

CSS类名

target HTMLElement | string | undefined

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

collapsible boolean | undefined

指定归属是否可折叠。若未指定,数据源将自行控制此行为。attributionsCollapsible设置。

collapsed boolean (defaults to true)

指定版权声明是否在启动时折叠。

tipLabel string (defaults to 'Attributions')

按钮工具提示所使用的文本标签。

label string | HTMLElement (defaults to 'i')

折叠版权按钮所使用的文本标签。除了文本,还可以使用元素(例如span元素)可以使用。

expandClassName string (defaults to className + '-expand')

折叠归属按钮的CSS类名。

collapseLabel string | HTMLElement (defaults to '›')

用于展开归属信息按钮的文本标签。除文本外,也可使用元素(例如span元素)可以使用。

collapseClassName string (defaults to className + '-collapse')

展开的归属按钮的 CSS 类名。

render function | undefined

当控件需要重新渲染时调用的函数。此函数在一个上下文中被调用。requestAnimationFrame回调。

attributions string | Array.<string> | undefined

无论渲染哪些图层,可选的归属信息都将始终显示。警告:归属信息是动态渲染的innerHTML,这可能导致潜在问题XSS(跨站脚本攻击)漏洞。仅当内容受信任时才使用此功能,或确保在插入前对内容进行适当消毒。

触发事件:

继承

方法

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

dispatchEvent(event){boolean | undefined} inherited

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

Name Type 描述
event BaseEvent | string

事件对象。

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

获取值。

Name Type 描述
key string

键名。

返回:
值。

getCollapsed(){boolean}

当归属控件当前处于折叠状态时,返回 true;否则返回 false

返回:
如果组件折叠,则为真。

getCollapsible(){boolean}

若归属可折叠,返回 true;否则返回 false

返回:
小部件可折叠时为真。

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

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

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

更新时不触发事件。

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

在不触发事件的情况下清除设置。