OpenLayers v10.9.0 API - Class: ScaleLine

new ScaleLine(options) control/ScaleLine.js, line 78

Name	Type	Description
`className`	string \| undefined	CSS 类名。当配置 `bar: true` 时，默认为 `ol-scale-bar`。否则默认为 `ol-scale-line`。
`minWidth`	number (defaults to 64)	OGC 默认 dpi 下的最小宽度（像素）。宽度将根据使用的 dpi 进行调整。
`maxWidth`	number \| undefined	OGC 默认 dpi 下的最大宽度（像素）。宽度将根据使用的 dpi 进行调整。
`render`	function \| undefined	控件需要重新渲染时调用的函数。此函数在 `requestAnimationFrame` 回调中调用。
`target`	HTMLElement \| string \| undefined	如果希望控件在地图视口之外渲染，请指定目标。
`units`	Units (defaults to 'metric')	单位。
`bar`	boolean (defaults to false)	渲染比例尺条而非线条。
`steps`	number (defaults to 4)	比例尺条使用的步数。使用偶数效果最佳。仅在 `bar` 为 `true` 时适用。
`text`	boolean (defaults to false)	在比例尺条上方渲染文本比例尺。仅在 `bar` 为 `true` 时适用。
`dpi`	number \| undefined	输出设备（如打印机）的 dpi。仅在 `bar` 为 `true` 时适用。如果未定义，将假定 OGC 默认屏幕像素大小为 0.28mm。

触发事件：

change (BaseEvent) - 通用更改事件。当修订计数器增加时触发。
change:units (ObjectEvent)
error (BaseEvent) - 通用错误事件。当发生错误时触发。
propertychange (ObjectEvent) - 当属性更改时触发。

Extends

Control

Observable Properties

Name	Type	Settable	ObjectEvent type	Description
`units`	Units	yes	`change:units`	比例线中使用的单位。

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	键名。

返回值：

值。

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

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

返回值：

版本号。

getUnits(){Units} control/ScaleLine.js, line 198

返回比例线中使用的单位。

返回值：

比例线中使用的单位。

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	更新但不触发事件。

setDpi(dpi) control/ScaleLine.js, line 224

指定输出设备（如打印机）的 dpi。

Name	Type	Description
`dpi`	number \| undefined	输出设备的 dpi。

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	目标。

setUnits(units) control/ScaleLine.js, line 215

设置比例线中使用的单位。

Name	Type	Description
`units`	Units	比例线中使用的单位。

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	取消设置但不触发事件。