# Label
查阅Leaflet API

#### new mars2d.graphic.Label(options)
graphic/Label.js 48

文本点 矢量对象

参数名称 | 类型 | 描述信息
--- | --- | ---
`options` | Object | 参数对象，包括以下：
参数名称 | 类型 | 默认值 | 描述信息
--- | --- | --- | ---
`latlng` | L.LatLng | Array.<Number> |  | 坐标位置
`style` | Label.StyleOptions |  | 可选 样式参数
`attr` | Object |  | 可选 属性信息
`hasEdit` | Boolean | `true` | 可选 是否可以编辑
`isAutoEditing` | Boolean | `false` | 可选 是否构造后就自动启动编辑(需要hasEdit:true时)
`popup` | String | HTMLElement | function |  | 可选 绑定的popup弹窗值，也可以bindPopup方法绑定
`popupOptions` | Map.PopupOptions |  | 可选 popup弹窗时的配置参数
`tooltip` | String | Array | function |  | 可选 绑定的tooltip弹窗值，也可以bindTooltip方法绑
`tooltipOptions` | Map.TooltipOptions |  | 可选 tooltip弹窗时的配置参数
`id` | String | Number |  | 可选 矢量数据id标识

##### 参考:

- `支持的事件类型`

### 继承自

- DivGraphic

### 属性值

#### attr : Object
graphic/Marker.js 172

属性信息

继承自:
  - Marker#attr

#### 只读 center : L.LatLng
graphic/Marker.js 164

中心点

继承自:
  - Marker#center

#### 只读 container : HTMLElement
graphic/Marker.js 228

获取对象的DOM容器

继承自:
  - Marker#container

#### coordinates : Array.<Array>
graphic/Marker.js 151

获取或设置 经度、纬度位置坐标(数组对象)，示例 [ [123.123456,32.654321] ]

继承自:
  - Marker#coordinates

#### 只读 divSize : Object
graphic/Marker.js 237

获取当前图标对应DIV的高宽，返回结果示例：{width:10,height;20}

继承自:
  - Marker#divSize

#### id : String|Number
graphic/Marker.js 113

对象的id标识

继承自:
  - Marker#id

#### 只读 isAdded : Boolean
graphic/Marker.js 219

是否已添加到地图

继承自:
  - Marker#isAdded

#### latlng : L.LatLng
graphic/Marker.js 125

坐标位置

继承自:
  - Marker#latlng

#### latlngs : Array.<L.LatLng>
graphic/Marker.js 139

坐标位置数组 , 主要为了兼容线面数据的使用（比如标绘中）

继承自:
  - Marker#latlngs

#### show : Boolean
graphic/Marker.js 198

显示隐藏状态

继承自:
  - Marker#show

#### style : Object
graphic/Marker.js 185

样式信息

继承自:
  - Marker#style

#### testPoint : Boolean
graphic/Marker.js 255

是否显示测试点，可以进行用于比较测试div的位置，方便调试CSS。

继承自:
  - Marker#testPoint

#### text : String
graphic/Label.js 73

文本内容

### 方法

#### addEventParent(obj) → Marker
graphic/Marker.js 801

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

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

##### 返回值:

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

继承自:
  - Marker#addEventParent

#### addTo(map) → Marker
graphic/Marker.js 555

将图层添加到地图

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

##### 返回值:

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

继承自:
  - Marker#addTo

#### bindContextMenu(contextmenuItems) → Map
graphic/Marker.js 708

绑定右键菜单

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

##### 返回值:

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

继承自:
  - Marker#bindContextMenu

#### bindPopup(content, options) → Marker
graphic/Marker.js 574

绑定Popup弹窗配置

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

##### 返回值:

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

继承自:
  - Marker#bindPopup

#### bindTooltip(content, options) → Marker
graphic/Marker.js 641

绑定Tooltip弹窗配置

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

##### 返回值:

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

继承自:
  - Marker#bindTooltip

#### closePopup() → Marker
graphic/Marker.js 604

关闭打开的弹窗

##### 返回值:

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

继承自:
  - Marker#closePopup

#### closeTooltip() → Marker
graphic/Marker.js 671

关闭打开的弹窗

##### 返回值:

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

继承自:
  - Marker#closeTooltip

#### destroy() → void
graphic/Marker.js 822

销毁矢量对象

##### 返回值:

无

继承自:
  - Marker#destroy

#### fire(type, data, propagate) → void
graphic/Marker.js 762

触发指定类型的事件。

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

##### 返回值:

无

继承自:
  - Marker#fire

#### getContextMenu() → Array.<Object>
graphic/Marker.js 718

获取绑定的右键菜单

##### 返回值:

右键菜单数组

继承自:
  - Marker#getContextMenu

#### getLatLng() → L.LatLng
graphic/Marker.js 526

返回图标点的LatLng经纬度对象

##### 返回值:

经纬度对象

继承自:
  - Marker#getLatLng

#### getPopup() → L.Popup
graphic/Marker.js 632

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

##### 返回值:

Popup弹窗对象

继承自:
  - Marker#getPopup

#### getTooltip() → L.Tooltip
graphic/Marker.js 699

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

##### 返回值:

Tooltip弹窗对象

继承自:
  - Marker#getTooltip

#### isPopupOpen() → boolean
graphic/Marker.js 613

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

##### 返回值:

是否打开弹窗

继承自:
  - Marker#isPopupOpen

#### isTooltipOpen() → boolean
graphic/Marker.js 680

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

##### 返回值:

是否打开弹窗

继承自:
  - Marker#isTooltipOpen

#### listens(type, propagate) → Boolean
graphic/Marker.js 789

是否有绑定指定的事件

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

##### 返回值:

是否存在

继承自:
  - Marker#listens

#### off(types, fn, context) → void
graphic/Marker.js 749

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

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

##### 返回值:

无

继承自:
  - Marker#off

#### on(type, fn, context) → void
graphic/Marker.js 736

绑定指定类型事件监听器

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

##### 返回值:

无

继承自:
  - Marker#on

#### once(types, fn, context) → void
graphic/Marker.js 775

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

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

##### 返回值:

无

继承自:
  - Marker#once

#### openPopup(latlng) → Marker
graphic/Marker.js 594

打开Popup弹窗

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

##### 返回值:

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

继承自:
  - Marker#openPopup

#### openTooltip(latlng) → Marker
graphic/Marker.js 661

打开Tooltip弹窗

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

##### 返回值:

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

继承自:
  - Marker#openTooltip

#### remove() → Marker
graphic/Marker.js 565

将图层从地图上移除

##### 返回值:

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

继承自:
  - Marker#remove

#### removeEventParent(obj) → Marker
graphic/Marker.js 811

移除抛出事件到父类

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

##### 返回值:

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

继承自:
  - Marker#removeEventParent

#### setLatLng(latlng, updateEditeMarkers) → Marker
graphic/Marker.js 376

修改位置

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

##### 返回值:

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

继承自:
  - Marker#setLatLng

#### setOpacity(opacity) → Marker
graphic/Marker.js 545

改变透明度

参数名称 | 类型 | 描述信息
--- | --- | ---
`opacity` | Number | 透明度

##### 返回值:

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

继承自:
  - Marker#setOpacity

#### setPopupContent(content) → Marker
graphic/Marker.js 622

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

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

##### 返回值:

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

继承自:
  - Marker#setPopupContent

#### setRotationAngle(angle) → Marker
graphic/Marker.js 426

设置 旋转角度（度数值，0-360度）

参数名称 | 类型 | 描述信息
--- | --- | ---
`angle` | Number | 旋转角度（度数值，0-360度）

##### 返回值:

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

继承自:
  - Marker#setRotationAngle

#### setStyle(newStyle) → Marker
graphic/Marker.js 438

设置 样式信息 的钩子方法

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

##### 返回值:

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

继承自:
  - Marker#setStyle

#### setTooltipContent(content) → Marker
graphic/Marker.js 689

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

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

##### 返回值:

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

继承自:
  - Marker#setTooltipContent

#### setZIndexOffset(offset) → Marker
graphic/Marker.js 535

改变zIndex顺序

参数名称 | 类型 | 描述信息
--- | --- | ---
`offset` | Number | zIndex顺序

##### 返回值:

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

继承自:
  - Marker#setZIndexOffset

#### toGeoJSON(options) → Object
graphic/Marker.js 497

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

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

##### 返回值:

GeoJSON格式规范对象

继承自:
  - Marker#toGeoJSON

#### toJSON() → Object
graphic/Marker.js 518

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

##### 返回值:

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

继承自:
  - Marker#toJSON

#### unbindContextMenu() → Map
graphic/Marker.js 727

解除绑定右键菜单

##### 返回值:

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

继承自:
  - Marker#unbindContextMenu

#### unbindPopup() → Marker
graphic/Marker.js 585

解除绑定Popup弹窗配置

##### 返回值:

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

继承自:
  - Marker#unbindPopup

#### unbindTooltip() → Marker
graphic/Marker.js 652

解除绑定Tooltip弹窗配置

##### 返回值:

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

继承自:
  - Marker#unbindTooltip

### 定义的类型

#### mars2d.graphic.Label.StyleOptions
graphic/Label.js 7

文本点 支持的样式信息

##### 属性:

属性名称 | 类型 | 可选 | 默认值 | 描述信息
--- | --- | --- | --- | ---
`text` | String | <可选> | "文字" | 文本内容，换行可以用换行符'\n'。
`horizontalOrigin` | HorizontalOrigin | <可选> |  | 横向方向的定位
`verticalOrigin` | VerticalOrigin | <可选> |  | 垂直方向的定位
`offsetX` | Number | <可选> |  | horizontalOrigin定位基础上，横向方向偏移数值
`offsetY` | Number | <可选> |  | verticalOrigin定位基础上，垂直方向偏移数值
`iconAnchor` | L.Point | Array.<Number> | <可选> |  | 自定义图标的“指示地理位置的锚点”的坐标（相对于其左上角）。 以便图标显示准确位于标记的地理位置。 如果指定大小，则iconAnchor默认为图标中心点，也可以在带有负边距的CSS中设置。设置后horizontalOrigin、verticalOrigin即失效。
`color` | String | <可选> | "#ffffff" | 文本颜色
`opacity` | Number | <可选> | 1.0 | 透明度，取值范围：0.0-1.0
`font_family` | String | <可选> | "楷体" | 字体 ,可选项：微软雅黑,宋体,楷体,隶书,黑体 等
`font_size` | Number | <可选> | 30 | 字体大小
`font_weight` | String | <可选> | "normal" | 是否加粗 ,可选项：bold (解释：是),normal (解释：否),
`font_style` | String | <可选> | "normal" | 是否斜体 ,可选项：italic (解释：是),normal (解释：否),
`font` | string | <可选> | '30px normal normal 楷体' | 上叙4个属性的一次性指定CSS字体的属性。
`border` | Boolean | <可选> | false | 是否边线
`border_width` | Number | <可选> |  | 边线宽度
`border_style` | String | <可选> |  | 边线透明度
`border_color` | String | <可选> |  | 边线颜色
`background` | Boolean | <可选> | false | 是否背景
`background_color` | String | <可选> |  | 背景颜色
`className` | String | <可选> |  | 自定义样式class名称
`minZoom` | Number | <可选> |  | 限定显示的最小的级别
`maxZoom` | Number | <可选> |  | 限定显示的最大的级别
`draggable` | Boolean | <可选> | false | 标记是否可以用鼠标/触摸拖动
`keyboard` | Boolean | <可选> | true | 标记是否可以用键盘按键并按回车键
`zIndexOffset` | Number | <可选> | 0 | 默认情况下，注记图片的叠置顺序由纬度自动设置.如果你想将某一注记放置于其他之上可用这个选项，设置一个较大的值即可，比如1000（或是相反地设置一个较大的负值）
`riseOnHover` | Boolean | <可选> | false | 如果为true，当您将鼠标悬停在其上时，标记将会放在其他顶部。
`riseOffset` | Number | <可选> | 250 | 用于riseOnHover功能的z-index偏移量。
`interactive` | Boolean | <可选> | true | 是否触发鼠标事件，如果false，该层不会发出鼠标事件，并且将作为底层地图的一部分。
`merge` | Boolean | <可选> |  | 当label是其他对象的附加对象时，是否合并在marker一个div内，比如用于聚合
`highlight` | Label.StyleOptions | <可选> |  | 【预留功能，待后续版本开发】鼠标移入或单击(type:'click')后的对应高亮的部分样式，创建Graphic后也可以openHighlight、closeHighlight方法来手动调用