Class: Attribution

ol/control/Attribution~Attribution 


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

显示与地图中图层数据源关联的所有版权信息的控件。此控件是地图中包含的默认控件之一。默认情况下，它显示在地图的右下角，但可以通过 CSS 选择器 .ol-attribution 进行更改。

new Attribution(options)

control/Attribution.js, line 53
Name Type Description
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（跨站脚本）漏洞。 仅对可信内容使用此功能，或在插入前确保内容已正确清理。
触发事件：

Extends

Methods

changed() inherited

Observable.js, line 68

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

dispatchEvent(event){boolean | undefined} inherited

events/Target.js, line 85

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

Name Type Description
event BaseEvent | string

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

get(key){*} inherited

Object.js, line 136

获取一个值。

Name Type Description
key string

键名。
返回值：
值。

getCollapsed(){boolean}

control/Attribution.js, line 336

返回true如果版权信息当前已折叠，否则返回false。

返回值：
控件是否已折叠。

getCollapsible(){boolean}

control/Attribution.js, line 295

返回true如果版权信息可折叠，否则返回false。

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

getKeys(){Array.<string>} inherited

Object.js, line 149

获取对象属性名列表。

返回值：
属性名列表。

getMap(){Map | null} inherited

control/控件。js, line 104

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

返回值：
地图。

getProperties(){NoInfer.<Properties>} inherited

Object.js, line 158

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

返回值：
对象。

getRevision(){number} inherited

Observable.js, line 79

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

返回值：
版本号。

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

Observable.js, line 152

监听特定类型的事件。

Name Type Description
type string | Array.<string>

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

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

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

Observable.js, line 164

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

Name Type Description
type string | Array.<string>

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

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

set(key, value, silent) inherited

Object.js, line 218

设置一个值。

Name Type Description
key string

键名。
value *

值。
silent boolean | undefined

更新但不触发事件。

setCollapsed(collapsed)

control/Attribution.js, line 322

根据传入参数折叠或展开版权信息。如果版权信息不可折叠或当前折叠状态已经是所请求的状态，则不会执行任何操作。

Name Type Description
collapsed boolean

控件是否已折叠。

setCollapsible(collapsible)

control/Attribution.js, line 304

设置版权信息是否可折叠。

Name Type Description
collapsible boolean

控件是否可折叠。

setMap(map) inherited

control/控件。js, line 116

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

Name Type Description
map Map | null

地图。

setProperties(values, silent) inherited

Object.js, line 238

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

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

值。
silent boolean | undefined

更新但不触发事件。

setTarget(target) inherited

control/控件。js, line 155

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

Name Type Description
target HTMLElement | string

目标。

un(type, listener) inherited

Observable.js, line 173

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

Name Type Description
type string | Array.<string>

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

监听器函数。

unset(key, silent) inherited

Object.js, line 262

取消设置一个属性。

Name Type Description
key string

键名。
silent boolean | undefined

取消设置但不触发事件。