# CanvasImage
查阅Leaflet API

#### new mars2d.graphic.CanvasImage(options)
graphic/CanvasImage.js 8

Canvas图片矩形 矢量对象

参数名称 | 类型 | 描述信息
--- | --- | ---
`options` | Object | 参数对象，包括以下：
参数名称 | 类型 | 描述信息
--- | --- | ---
`latlngs` | Array.<L.LatLng> | 坐标数组
`style` | Image.StyleOptions | 可选 样式参数
`attr` | Object | 可选 属性信息
`popup` | String | HTMLElement | function | 可选 绑定的popup弹窗值，也可以bindPopup方法绑定
`popupOptions` | Map.PopupOptions | 可选 popup弹窗时的配置参数
`tooltip` | String | Array | function | 可选 绑定的tooltip弹窗值，也可以bindTooltip方法绑
`tooltipOptions` | Map.TooltipOptions | 可选 tooltip弹窗时的配置参数
`id` | String | Number | 可选 矢量数据id标识

##### 参考:

- `支持的事件类型`

### 继承自

- L.Path

### 属性值

#### attr : Object
graphic/CanvasImage.js 77

属性信息

#### 只读 center : L.LatLng
graphic/CanvasImage.js 69

中心点

#### 只读 coordinates : Array.<Array>
graphic/CanvasImage.js 56

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

#### id : String|Number
graphic/CanvasImage.js 31

对象的id标识

#### 只读 isAdded : Boolean
graphic/CanvasImage.js 124

是否已添加到地图

#### latlngs : Array.<L.LatLng>
graphic/CanvasImage.js 43

坐标位置数组

#### show : Boolean
graphic/CanvasImage.js 103

显示隐藏状态

#### style : Object
graphic/CanvasImage.js 90

样式信息

### 方法

#### addEventParent(obj) → CanvasImage
graphic/CanvasImage.js 644

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

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

##### 返回值:

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

#### addTo(map) → CanvasImage
graphic/CanvasImage.js 398

将图层添加到地图

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

##### 返回值:

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

#### bindContextMenu(contextmenuItems) → Map
graphic/CanvasImage.js 551

绑定右键菜单

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

##### 返回值:

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

#### bindPopup(content, options) → CanvasImage
graphic/CanvasImage.js 417

绑定Popup弹窗配置

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

##### 返回值:

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

#### bindTooltip(content, options) → CanvasImage
graphic/CanvasImage.js 484

绑定Tooltip弹窗配置

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

##### 返回值:

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

#### bringToBack() → CanvasImage
graphic/CanvasImage.js 389

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

##### 返回值:

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

#### bringToFront() → CanvasImage
graphic/CanvasImage.js 380

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

##### 返回值:

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

#### closePopup() → CanvasImage
graphic/CanvasImage.js 447

关闭打开的弹窗

##### 返回值:

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

#### closeTooltip() → CanvasImage
graphic/CanvasImage.js 514

关闭打开的弹窗

##### 返回值:

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

#### fire(type, data, propagate) → void
graphic/CanvasImage.js 605

触发指定类型的事件。

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

##### 返回值:

无

#### getBounds() → CanvasImage
graphic/CanvasImage.js 260

获取线的矩形边界

##### 返回值:

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

#### getContextMenu() → Array.<Object>
graphic/CanvasImage.js 561

获取绑定的右键菜单

##### 返回值:

右键菜单数组

#### getPopup() → L.Popup
graphic/CanvasImage.js 475

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

##### 返回值:

Popup弹窗对象

#### getRgba(latnlg) → String
graphic/CanvasImage.js 303

获取指定坐标的颜色值

参数名称 | 类型 | 描述信息
--- | --- | ---
`latnlg` | L.LatLng | 坐标

##### 返回值:

颜色值，如 rgba(255,0,0,0.5)

#### getTooltip() → L.Tooltip
graphic/CanvasImage.js 542

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

##### 返回值:

Tooltip弹窗对象

#### isPopupOpen() → boolean
graphic/CanvasImage.js 456

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

##### 返回值:

是否打开弹窗

#### isTooltipOpen() → boolean
graphic/CanvasImage.js 523

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

##### 返回值:

是否打开弹窗

#### listens(type, propagate) → Boolean
graphic/CanvasImage.js 632

是否有绑定指定的事件

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

##### 返回值:

是否存在

#### off(types, fn, context) → void
graphic/CanvasImage.js 592

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

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

##### 返回值:

无

#### on(type, fn, context) → void
graphic/CanvasImage.js 579

绑定指定类型事件监听器

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

##### 返回值:

无

#### once(types, fn, context) → void
graphic/CanvasImage.js 618

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

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

##### 返回值:

无

#### openPopup(latlng) → CanvasImage
graphic/CanvasImage.js 437

打开Popup弹窗

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

##### 返回值:

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

#### openTooltip(latlng) → CanvasImage
graphic/CanvasImage.js 504

打开Tooltip弹窗

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

##### 返回值:

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

#### redraw() → CanvasImage
graphic/CanvasImage.js 371

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

##### 返回值:

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

#### remove() → CanvasImage
graphic/CanvasImage.js 408

将图层从地图上移除

##### 返回值:

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

#### removeEventParent(obj) → CanvasImage
graphic/CanvasImage.js 654

移除抛出事件到父类

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

##### 返回值:

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

#### setBounds(bounds, updateEditeMarkers) → CanvasImage
graphic/CanvasImage.js 242

用传递的LatLngBounds边界重绘图片

参数名称 | 类型 | 默认值 | 描述信息
--- | --- | --- | ---
`bounds` | L.LatLngBounds |  | 边界
`updateEditeMarkers` | boolean | `true` | 可选 是否在编辑状态更新编辑点

##### 返回值:

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

#### setPopupContent(content) → CanvasImage
graphic/CanvasImage.js 465

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

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

##### 返回值:

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

#### setStyle(newStyle) → CanvasImage
graphic/CanvasImage.js 169

设置 样式信息 的钩子方法

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

##### 返回值:

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

#### setTooltipContent(content) → CanvasImage
graphic/CanvasImage.js 532

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

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

##### 返回值:

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

#### setUrl(url) → CanvasImage
graphic/CanvasImage.js 219

设置图片URL

参数名称 | 类型 | 描述信息
--- | --- | ---
`url` | String | 图片URL

##### 返回值:

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

#### toGeoJSON(options) → Object
graphic/CanvasImage.js 197

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

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

##### 返回值:

GeoJSON格式规范对象

#### toJSON() → Object
graphic/CanvasImage.js 363

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

##### 返回值:

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

#### unbindContextMenu() → Map
graphic/CanvasImage.js 570

解除绑定右键菜单

##### 返回值:

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

#### unbindPopup() → CanvasImage
graphic/CanvasImage.js 428

解除绑定Popup弹窗配置

##### 返回值:

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

#### unbindTooltip() → CanvasImage
graphic/CanvasImage.js 495

解除绑定Tooltip弹窗配置

##### 返回值:

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