DistanceLegend
查阅Cesium API

new mars3d.control.DistanceLegend(options)
control/DistanceLegend.js 36

比例尺 控件

参数名称 类型 描述信息
options object 可选

参数对象，包括以下：

参数名称 类型 默认值 描述信息
unit string 'auto' 可选

计量单位, 可选值：auto(根据距离值自动选用k或km)、m(米)、km(公里)、wm(万米)、mile(海里)、zhang(丈)
getLangText function 可选

获取单位文本的对应方法, 或者调用 map.setLangText("_公里", "km") 统一修改
decimal number 0 可选

保留的小数位
className string 可选

样式名称，可以外部自定义样式
style object 可选

可以传任意CSS样式值，如:

参数名称 类型 描述信息
top string 可选

css定位top位置, 如 top: '10px'
bottom string 可选

css定位bottom位置，支持配置'toolbar'自动跟随Toolbar
left string 可选

css定位left位置
right string 可选

css定位right位置
id string | number createGuid() 可选

对象的id标识
enabled boolean true 可选

对象的启用状态
parentContainer HTMLElement 可选

控件加入的父容器，默认为map所在的DOM map.container
insertIndex number 可选

可以自定义插入到父容器中的index顺序，默认是插入到最后面。
insertBefore HTMLElement | string 可选

可以自定义插入到指定兄弟容器的前面，与insertIndex二选一。
参考:

继承自

属性值

只读 container : HTMLElement
control/BaseControl.js 66

当前控件的DOM对象

继承自:

只读 distance : number
control/DistanceLegend.js 68

当前比例尺值（单位：米）

enabled : boolean
core/BaseThing.js 99

设置对象的启用和禁用状态。

继承自:

只读 id : string|number
core/BaseThing.js 86

对象的id标识

继承自:

只读 isAdded : boolean
core/BaseThing.js 67

是否已添加到地图

继承自:

只读 isDestroy : boolean
core/BaseThing.js 77

是否已经销毁了

继承自:

只读 parentContainer : HTMLElement
control/BaseControl.js 75

父容器DOM对象

继承自:

只读 parentContainerId : string
control/BaseControl.js 87

父容器DOM对象的ID

继承自:

show : boolean
control/BaseControl.js 35

设置DOM容器的显示隐藏

继承自:

只读 state : State
core/BaseThing.js 56

当前对象的状态

继承自:

只读 type : string
control/BaseControl.js 57

控件类型

继承自:

方法

abstract _addedHook() → void
control/BaseControl.js 301

对象添加到地图上的创建钩子方法， 每次add时都会调用

返回值:

无

继承自:

abstract _mountedHook() → void
control/BaseControl.js 291

对象添加到地图前创建一些对象的钩子方法， 只会调用一次

返回值:

无

继承自:

abstract _removedHook() → void
control/BaseControl.js 311

对象从地图上移除的创建钩子方法， 每次remove时都会调用

返回值:

无

继承自:

addTo(map) → BaseControl
control/BaseControl.js 162

添加到地图上，同 map.addControl

参数名称 类型 描述信息
map Map

地图对象
返回值:

当前对象本身，可以链式调用

继承自:

getLangText(key) → string
control/BaseControl.js 444

获取当前key对应语言的文本内容。

参数名称 类型 描述信息
key string

文本key
返回值:

lang参数指定的对应文本内容

继承自:

reload() → void
control/BaseControl.js 139

重新加载

返回值:

无

继承自:

remove(destroy) → void
control/BaseControl.js 175

从地图上移除，同map.removeControl

参数名称 类型 描述信息
destroy boolean 可选

是否调用destroy释放
返回值:

无

继承自:

setOptions(options, funOptions) → BaseThing|BaseControl|object
core/BaseThing.js 246

更新图层参数

参数名称 类型 描述信息
options object

与类的构造方法参数相同
funOptions object 可选

方法参数

参数名称 类型 默认值 描述信息
merge boolean true 可选

是否合并参数, 如是完整覆盖不合并老的options，请传入fasle
返回值:

当前对象本身，可以链式调用

继承自:

setStyle(style) → void
control/BaseControl.js 330

设置新的css样式信息

参数名称 类型 描述信息
style object

css样式
返回值:

无

继承自:

toJSON() → object
core/BaseThing.js 268

将对象转为Json简单对象，用于存储后再传参加载

返回值:

Json简单对象

继承自:

定义的类型

mars3d.control.DistanceLegend.EventType
control/DistanceLegend.js 20

当前类支持的EventType事件类型

属性:
属性名称 类型 描述信息
change string

比例尺发生变化
使用示例:
//绑定监听事件
distanceLegend.on(mars3d.EventType.change, function (event) {
  console.log('比例尺发生变化', event)
})
参考:
下载离线API文档