-
Name Type 描述 classNamestring | undefined CSS类名。默认为
ol-scale-bar配置为bar: true否则,默认为ol-scale-line.minWidthnumber (defaults to 64) 在 OGC 默认 dpi 下的最小像素宽度,宽度将根据所用 dpi 自动适配。
maxWidthnumber | undefined 在OGC默认dpi下的最大像素宽度,将根据所用dpi自动调整。
renderfunction | undefined 当控件需要重新渲染时调用的函数。这被调用在
requestAnimationFrame回调targetHTMLElement | string | undefined 如果您希望控件在地图视口之外渲染,请指定目标。
unitsUnits (defaults to 'metric') 单位。
barboolean (defaults to false) 渲染比例尺而不是线。
stepsnumber (defaults to 4) 比例尺应设置的步数。建议使用偶数以获得最佳效果。此设置仅适用于以下情况。
bar是true.textboolean (defaults to false) 渲染比例尺上方的比例文本。仅适用于以下情况
bar是true.dpinumber | undefined 输出设备(如打印机)的dpi。仅适用于以下情况。
bar是true若未定义,则采用 OGC 默认屏幕像素大小为 0.28 毫米。触发事件:
change(BaseEvent) - 通用更改事件,在修订计数器增加时触发。-
change:units(ObjectEvent) errorBaseEvent基本事件 - 通用错误事件,在错误发生时触发。propertychangeObjectEvent事件对象 - 当属性更改时触发。
继承
可观察属性
| Name | Type | 可设置 | ObjectEvent type | 描述 |
|---|---|---|---|---|
units |
Units | 是的 | change:units |
比例尺中使用的单位。 |
方法
-
递增修订计数器并触发'change'事件。
-
分发一个事件,并调用所有监听此类型事件的监听器。事件参数可以是字符串,也可以是具有
type属性的对象。Name Type 描述 eventBaseEvent | string 事件对象。
返回:
false如果任何人在事件对象上调用了 preventDefault,或者任何侦听器返回了 false。
-
获取值。
Name Type 描述 keystring 键名。
返回:
值。
-
获取对象属性名称列表
返回:
属性名列表
-
获取与此控件关联的地图。
返回:
地图.
-
获取包含全部属性名称及其对应值的对象。
返回:
对象。
-
获取该对象的版本号。每次修改该对象时,其版本号将自动递增。
返回:
修订版。
-
返回比例尺所使用的单位。
返回:
比例尺中使用的单位。
-
监听特定类型的事件。
Name Type 描述 typestring | Array.<string> 事件类型或事件类型数组。
listenerfunction 监听器函数。
返回:
监听器的唯一键。如果以事件类型数组作为第一个参数调用,则返回将是键的数组。
-
针对特定类型的事件进行一次性监听。
Name Type 描述 typestring | Array.<string> 事件类型或事件类型数组
listenerfunction 监听器函数
返回:
监听器的唯一键。若以事件类型数组作为首个参数调用,则返回键数组。
-
设置值。
Name Type 描述 keystring 键名
value* 值。
silentboolean | undefined 更新时避免触发事件。
-
设置输出设备(如打印机)的dpi。
Name Type 描述 dpinumber | undefined 输出设备的分辨率(dpi)。
-
将控件从当前地图移除并附加到新地图。 传递
null以仅从当前地图中移除控件。 子类可设置事件处理程序来接收此处地图更改的通知。Name Type 描述 mapMap | null 地图.
-
设置键值对集合。请注意,此操作将修改现有属性并添加新属性,但不会删除任何现有属性。
Name Type 描述 valuesObject.<string, *> 值。
silentboolean | undefined 更新而不触发事件。
-
此函数用于设置控件的目标元素。若在控件已添加到地图后调用此函数(即已在控件上调用
setMap后),则无效。若在传递给控件构造函数的选项中未设置target,且未调用setTarget,则控件将被添加到地图的覆盖层容器中。Name Type 描述 targetHTMLElement | string 目标元素。
-
设置比例尺的单位。
Name Type 描述 unitsUnits 比例尺中使用的单位。
-
取消监听特定类型的事件。
Name Type 描述 typestring | Array.<string> 事件类型或事件类型数组。
listenerfunction 监听器函数
-
清除属性。
Name Type 描述 keystring 键名。
silentboolean | undefined 在不触发事件的前提下取消设置。