ScaleControl

定义于: src/ui/control/scale_control.ts:33

ScaleControl是一个显示当前地图比例的控件；它使用度量系统（公制、英制或者米），适合地图中心的纬度；ScaleControl使用mapbox-gl-rtl-text插件的RTL布局支持；

示例

map.addControl(new ScaleControl({
    maxWidth: 80,
    unit: 'imperial'
}));

实现

• IControl

构造函数

构造函数

new ScaleControl(options?: ScaleControlOptions): ScaleControl

定义于: src/ui/control/scale_control.ts:42

参数

返回

ScaleControl

方法

getDefaultPosition()

getDefaultPosition(): ControlPosition

定义于: src/ui/control/scale_control.ts:46

可选择为此控件提供默认位置；如果实现了此方法，并且调用Map#addControl时没有提供position参数，则会使用getDefaultPosition返回的值作为控件的位置；

返回

ControlPosition

控件位置，为addControl中有效的值之一；

实现

IControl.getDefaultPosition

getUnit()

getUnit(): string

定义于: src/ui/control/scale_control.ts:59

获取控件当前的单位系统；

返回

string

控件的单位系统，作为imperial、metric或nautical之一；

onAdd()

onAdd(map: Map): HTMLElement

定义于: src/ui/control/scale_control.ts:76

在地图上注册控件，并让其有机会注册事件监听器和资源；此方法由Map#addControl在内部调用；

参数

返回

HTMLElement

控件的容器元素；这应该由控件创建并由onAdd返回，而不附加到DOM：地图将根据需要将控件的元素插入到DOM中；

实现

IControl.onAdd

onRemove()

onRemove(): void

定义于: src/ui/control/scale_control.ts:96

在地图上注销控件，并让其有机会分离事件监听器和资源；此方法由Map#removeControl在内部调用；

返回

void

实现

IControl.onRemove

setUnit()

setUnit(unit: string): void

定义于: src/ui/control/scale_control.ts:67

修改控件的单位系统；

参数

返回

void