# DistanceMeasure
查阅Leaflet API

#### new mars2d.graphic.DistanceMeasure(options)
graphic/measure/DistanceMeasure.js 17

距离量算对象， 非直接调用，由 Measure 类统一创建及管理

参数名称 | 类型 | 描述信息
--- | --- | ---
`options` | Object | 参数对象，包括以下：
参数名称 | 类型 | 描述信息
--- | --- | ---
`style` | Polyline.StyleOptions | 样式信息
`attr` | Object | 可选 附件的属性信息，可以任意附加属性，导出geojson或json时会自动处理导出。
`label` | Label.StyleOptions | 可选 测量结果文本的样式
`id` | String | Number | 可选 矢量数据id标识

##### 参考:

- `支持的事件类型`

### 继承自

- Polyline

### 属性值

#### 只读 area : Number
graphic/Polyline.js 165

围合的面积（单位：平方米）

继承自:
  - Polyline#area

#### attr : Object
graphic/Polyline.js 173

属性信息

继承自:
  - Polyline#attr

#### 只读 center : L.LatLng
graphic/Polyline.js 143

中心点

继承自:
  - Polyline#center

#### 只读 coordinates : Array.<Array>
graphic/Polyline.js 130

经纬度位置坐标(数组对象)，示例 [ [123.123456,32.654321], [111.123456,22.654321] ]

继承自:
  - Polyline#coordinates

#### 只读 distance : Number
graphic/Polyline.js 156

距离（单位：米）

继承自:
  - Polyline#distance

#### id : String|Number
graphic/Polyline.js 100

对象的id标识

继承自:
  - Polyline#id

#### 只读 isAdded : Boolean
graphic/Polyline.js 220

是否已添加到地图

继承自:
  - Polyline#isAdded

#### latlngs : Array.<L.LatLng>
graphic/Polyline.js 112

坐标位置数组

继承自:
  - Polyline#latlngs

#### 只读 measured : Object
graphic/measure/DistanceMeasure.js 51

测量结果

#### show : Boolean
graphic/Polyline.js 199

显示隐藏状态

继承自:
  - Polyline#show

#### style : Object
graphic/Polyline.js 186

样式信息

继承自:
  - Polyline#style

### 方法

#### addEventParent(obj) → Polyline
graphic/Polyline.js 881

添加抛出事件到父类，它将接收传播的事件

参数名称 | 类型 | 描述信息
--- | --- | ---
`obj` | Object | 父类对象

##### 返回值:

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

继承自:
  - Polyline#addEventParent

#### addLatLng(latlng) → Polyline
graphic/Polyline.js 598

向折线添加一个给定点。 默认情况下，在多折线的情况下，将折线的第一个线添加，但可以通过将特定的线作为LatLng数组（您可以使用之前访问getLatLngs）来覆盖。

参数名称 | 类型 | 描述信息
--- | --- | ---
`latlng` | L.LatLng | 经纬度对象

##### 返回值:

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

继承自:
  - Polyline#addLatLng

#### addTo(map) → Polyline
graphic/Polyline.js 635

将图层添加到地图

参数名称 | 类型 | 描述信息
--- | --- | ---
`map` | Map | 地图对象

##### 返回值:

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

继承自:
  - Polyline#addTo

#### bindContextMenu(contextmenuItems) → Map
graphic/Polyline.js 788

绑定右键菜单

参数名称 | 类型 | 描述信息
--- | --- | ---
`contextmenuItems` | Array.<Object> | 右键菜单数组

##### 返回值:

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

继承自:
  - Polyline#bindContextMenu

#### bindPopup(content, options) → Polyline
graphic/Polyline.js 654

绑定Popup弹窗配置

参数名称 | 类型 | 描述信息
--- | --- | ---
`content` | String | HTMLElement | function | L.Popup | Popup弹窗内容
`options` | Map.PopupOptions | Object | 可选 Popup弹窗参数

##### 返回值:

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

继承自:
  - Polyline#bindPopup

#### bindTooltip(content, options) → Polyline
graphic/Polyline.js 721

绑定Tooltip弹窗配置

参数名称 | 类型 | 描述信息
--- | --- | ---
`content` | String | HTMLElement | function | L.Tooltip | Tooltip弹窗内容
`options` | Map.TooltipOptions | Object | 可选 Tooltip弹窗参数

##### 返回值:

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

继承自:
  - Polyline#bindTooltip

#### bringToBack() → Polyline
graphic/Polyline.js 626

将线移动到所有路径层的底部

##### 返回值:

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

继承自:
  - Polyline#bringToBack

#### bringToFront() → Polyline
graphic/Polyline.js 455

将线移动到所有路径层的顶部

##### 返回值:

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

继承自:
  - Polyline#bringToFront

#### closePopup() → Polyline
graphic/Polyline.js 684

关闭打开的弹窗

##### 返回值:

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

继承自:
  - Polyline#closePopup

#### closeTooltip() → Polyline
graphic/Polyline.js 751

关闭打开的弹窗

##### 返回值:

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

继承自:
  - Polyline#closeTooltip

#### destroy() → void
graphic/Polyline.js 902

销毁矢量对象

##### 返回值:

无

继承自:
  - Polyline#destroy

#### fire(type, data, propagate) → void
graphic/Polyline.js 842

触发指定类型的事件。

参数名称 | 类型 | 默认值 | 描述信息
--- | --- | --- | ---
`type` | String | EventType |  | 事件类型
`data` | Object |  | 可选 传输的数据或对象，可在事件回调方法中event对象中获取进行使用
`propagate` | BaseClass | Object | `null` | 可选 将事件传播给父类 (用addEventParent设置)

##### 返回值:

无

继承自:
  - Polyline#fire

#### getBounds() → L.LatLngBounds
graphic/Polyline.js 608

获取线的矩形边界

##### 返回值:

矩形边界

继承自:
  - Polyline#getBounds

#### getContextMenu() → Array.<Object>
graphic/Polyline.js 798

获取绑定的右键菜单

##### 返回值:

右键菜单数组

继承自:
  - Polyline#getContextMenu

#### getLatLngs() → Array.<L.LatLng>
graphic/Polyline.js 589

返回折线的坐标点的数组，或者在多折线的情况下返回嵌套的点阵列。

##### 返回值:

经纬度数组

继承自:
  - Polyline#getLatLngs

#### getPopup() → L.Popup
graphic/Polyline.js 712

获取当前绑定在图层上的Popup弹窗对象

##### 返回值:

Popup弹窗对象

继承自:
  - Polyline#getPopup

#### getTooltip() → L.Tooltip
graphic/Polyline.js 779

获取当前绑定在图层上的Tooltip弹窗对象

##### 返回值:

Tooltip弹窗对象

继承自:
  - Polyline#getTooltip

#### isPopupOpen() → boolean
graphic/Polyline.js 693

当前绑定的弹窗是是否打开

##### 返回值:

是否打开弹窗

继承自:
  - Polyline#isPopupOpen

#### isTooltipOpen() → boolean
graphic/Polyline.js 760

当前绑定的弹窗是是否打开

##### 返回值:

是否打开弹窗

继承自:
  - Polyline#isTooltipOpen

#### listens(type, propagate) → Boolean
graphic/Polyline.js 869

是否有绑定指定的事件

参数名称 | 类型 | 描述信息
--- | --- | ---
`type` | String | EventType | 事件类型
`propagate` | Object | 可选 是否判断指定的父类 (用addEventParent设置的)

##### 返回值:

是否存在

继承自:
  - Polyline#listens

#### off(types, fn, context) → void
graphic/Polyline.js 829

解除绑定指定类型事件监听器

参数名称 | 类型 | 描述信息
--- | --- | ---
`types` | String | EventType | Object | 可选 事件类型，Object时删除一组类型/侦听器对。
`fn` | function | 可选 绑定的监听器回调方法
`context` | Object | 可选 侦听器的上下文(this关键字将指向的对象)。

##### 返回值:

无

继承自:
  - Polyline#off

#### on(type, fn, context) → void
graphic/Polyline.js 816

绑定指定类型事件监听器

参数名称 | 类型 | 描述信息
--- | --- | ---
`type` | String | EventType | Object | 事件类型，当是Object时可以添加一组类型/侦听器对，例如 {click: onClick, mousemove: onMouseMove}
`fn` | function | 可选 绑定的监听器回调方法
`context` | Object | 可选 侦听器的上下文(this关键字将指向的对象)。

##### 返回值:

无

继承自:
  - Polyline#on

#### once(types, fn, context) → void
graphic/Polyline.js 855

绑定一次性执行的指定类型事件监听器 与on类似，监听器只会被触发一次，然后被删除。

参数名称 | 类型 | 描述信息
--- | --- | ---
`types` | String | EventType | Object | 可选 事件类型，Object时删除一组类型/侦听器对。
`fn` | function | 可选 绑定的监听器回调方法
`context` | Object | 可选 侦听器的上下文(this关键字将指向的对象)。

##### 返回值:

无

继承自:
  - Polyline#once

#### openPopup(latlng) → Polyline
graphic/Polyline.js 674

打开Popup弹窗

参数名称 | 类型 | 描述信息
--- | --- | ---
`latlng` | L.LatLng | 可选 位置,如果latlng没有设置则在默认的所在位置打开。

##### 返回值:

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

继承自:
  - Polyline#openPopup

#### openTooltip(latlng) → Polyline
graphic/Polyline.js 741

打开Tooltip弹窗

参数名称 | 类型 | 描述信息
--- | --- | ---
`latlng` | L.LatLng | 可选 位置,如果latlng没有设置则在默认的所在位置打开。

##### 返回值:

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

继承自:
  - Polyline#openTooltip

#### redraw() → Polyline
graphic/Polyline.js 617

重新绘制。在更改路径所使用的坐标之后会很有用。

##### 返回值:

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

继承自:
  - Polyline#redraw

#### remove() → Polyline
graphic/Polyline.js 645

将图层从地图上移除

##### 返回值:

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

继承自:
  - Polyline#remove

#### removeEventParent(obj) → Polyline
graphic/Polyline.js 891

移除抛出事件到父类

参数名称 | 类型 | 描述信息
--- | --- | ---
`obj` | Object | 父类对象

##### 返回值:

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

继承自:
  - Polyline#removeEventParent

#### setLatLngs(latlngs, updateEditeMarkers) → Polyline
graphic/Polyline.js 267

用给定的地理位置数组代替更新折线中的所有点。

参数名称 | 类型 | 默认值 | 描述信息
--- | --- | --- | ---
`latlngs` | Array.<L.LatLng> |  | 经纬度数组
`updateEditeMarkers` | boolean | `true` | 可选 是否在编辑状态更新编辑点

##### 返回值:

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

继承自:
  - Polyline#setLatLngs

#### setOffset(offset) → Polyline
graphic/Polyline.js 399

设置线的偏移值，常用于平行线

参数名称 | 类型 | 描述信息
--- | --- | ---
`offset` | Number | 偏移值（像素）

##### 返回值:

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

继承自:
  - Polyline#setOffset

#### setPopupContent(content) → Polyline
graphic/Polyline.js 702

设定绑定在图层上的弹窗的内容

参数名称 | 类型 | 描述信息
--- | --- | ---
`content` | String | HTMLElement | L.Popup | Popup弹窗内容

##### 返回值:

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

继承自:
  - Polyline#setPopupContent

#### setStyle(newStyle) → Polyline
graphic/Polyline.js 287

设置 样式信息 的钩子方法

参数名称 | 类型 | 描述信息
--- | --- | ---
`newStyle` | Polyline.StyleOptions | 本次更新的部分样式信息,内部会合并属性

##### 返回值:

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

继承自:
  - Polyline#setStyle

#### setTooltipContent(content) → Polyline
graphic/Polyline.js 769

设定绑定在图层上的弹窗的内容

参数名称 | 类型 | 描述信息
--- | --- | ---
`content` | String | HTMLElement | L.Tooltip | Tooltip弹窗内容

##### 返回值:

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

继承自:
  - Polyline#setTooltipContent

#### toGeoJSON(options) → Object
graphic/Polyline.js 319

将图层数据导出为GeoJSON格式规范对象。

参数名称 | 类型 | 描述信息
--- | --- | ---
`options` | Object | 可选 参数对象:
参数名称 | 类型 | 描述信息
--- | --- | ---
`precision` | Number | 可选 保留经纬度的小数位数

##### 返回值:

GeoJSON格式规范对象

继承自:
  - Polyline#toGeoJSON

#### toJSON() → Object
graphic/Polyline.js 581

将矢量数据的坐标、样式及属性等信息导出为对象，可以用于存储。

##### 返回值:

导出的坐标、样式及属性等信息

继承自:
  - Polyline#toJSON

#### unbindContextMenu() → Map
graphic/Polyline.js 807

解除绑定右键菜单

##### 返回值:

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

继承自:
  - Polyline#unbindContextMenu

#### unbindPopup() → Polyline
graphic/Polyline.js 665

解除绑定Popup弹窗配置

##### 返回值:

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

继承自:
  - Polyline#unbindPopup

#### unbindTooltip() → Polyline
graphic/Polyline.js 732

解除绑定Tooltip弹窗配置

##### 返回值:

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

继承自:
  - Polyline#unbindTooltip

#### updateText(unit) → void
graphic/measure/DistanceMeasure.js 125

更新测量结果的文本

参数名称 | 类型 | 描述信息
--- | --- | ---
`unit` | String | 计量单位,`MeasureUtil#formatDistance` 可选值：auto、m、km、mile、zhang 等。auto时根据距离值自动选用k或km

##### 返回值:

无