# EchartsLayer
查阅Leaflet API

#### new mars2d.layer.EchartsLayer(options)
plugins/mars2d-echarts/EchartsLayer.js 20

Echarts图层， 【需要引入 echarts 库 和 mars2d-echarts 插件库】

参数名称 | 类型 | 描述信息
--- | --- | ---
`options` | EchartsLayer.Options | Object | 参数对象

### 继承自

- L.Layer

### 属性值

#### id : String|Number
plugins/mars2d-echarts/EchartsLayer.js 69

对象的id标识

#### 只读 isAdded : Boolean
plugins/mars2d-echarts/EchartsLayer.js 47

是否已添加到地图

#### 只读 layer : HTMLCanvasElement
plugins/mars2d-echarts/EchartsLayer.js 96

echarts对象，是echarts.init方法返回的 echartsInstance 实例

##### 参考:

- https://echarts.apache.org/zh/api.html#echartsInstance

#### name : String
plugins/mars2d-echarts/EchartsLayer.js 82

名称 标识

#### pid : String|Number
plugins/mars2d-echarts/EchartsLayer.js 56

对象的pid标识

### 方法

#### off(eventName, callback, context) → EchartsLayer
plugins/mars2d-echarts/EchartsLayer.js 238

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

参数名称 | 类型 | 描述信息
--- | --- | ---
`eventName` | string | * | 可选 事件名称，全小写，例如'click'，'mousemove', 'legendselected'
`callback` | function | 可选 绑定的监听器回调方法,未传值时解绑所有指定类型对应事件
`context` | object | 可选 侦听器的上下文(this关键字将指向的对象)。

##### 返回值:

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

#### on(eventName, callback, context) → EchartsLayer
plugins/mars2d-echarts/EchartsLayer.js 212

绑定事件处理函数,

参数名称 | 类型 | 描述信息
--- | --- | ---
`eventName` | string | * | 可选 事件名称，全小写，例如'click'，'mousemove', 'legendselected' ,可以参考echarts官网说明
`callback` | function | 可选 绑定的监听器回调方法
`context` | object | 可选 侦听器的上下文(this关键字将指向的对象)。

##### 返回值:

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

#### onByQuery(eventName, query, callback, context) → EchartsLayer
plugins/mars2d-echarts/EchartsLayer.js 225

带条件的绑定事件处理函数

参数名称 | 类型 | 描述信息
--- | --- | ---
`eventName` | string | 事件名称，全小写，例如'click'，'mousemove', 'legendselected'
`query` | string | object | 可选的过滤条件，能够只在指定的组件或者元素上进行响应。可以参考echarts官网说明
`callback` | function | 绑定的监听器回调方法
`context` | object | 可选 侦听器的上下文(this关键字将指向的对象)

##### 返回值:

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

#### setEchartsOption(option, notMerge, lazyUpdate) → void
plugins/mars2d-echarts/EchartsLayer.js 197

设置图表实例的配置项以及数据， 万能接口，所有参数和数据的修改都可以通过 setOption 完成， ECharts 会合并新的参数和数据，然后刷新图表。 如果开启动画的话，ECharts 找到两组数据之间的差异然后通过合适的动画去表现数据的变化。

参数名称 | 类型 | 默认值 | 描述信息
--- | --- | --- | ---
`option` | Object |  | 图表的配置项和数据，具体见 Echarts配置项手册。
`notMerge` | Boolean | `false` | 可选 是否不跟之前设置的 option 进行合并。默认为 false。即表示合并。合并的规则，详见 组件合并模式。如果为 true，表示所有组件都会被删除，然后根据新 option 创建所有新组件。
`lazyUpdate` | Boolean | `false` | 可选 在设置完 option 后是否不立即更新图表，默认为 false，即同步立即更新。如果为 true，则会在下一个 animation frame 中，才更新图表。

##### 返回值:

无

##### 参考:

- https://echarts.apache.org/zh/api.html#echartsInstance.setOption

#### setZIndex(zIndex) → void
plugins/mars2d-echarts/EchartsLayer.js 150

设置层级

参数名称 | 类型 | 描述信息
--- | --- | ---
`zIndex` | number | canvas层级

##### 返回值:

无

### 定义的类型

#### mars2d.layer.EchartsLayer.Options
plugins/mars2d-echarts/EchartsLayer.js 7

Echarts图层参数

##### 属性:

属性名称 | 类型 | 可选 | 默认值 | 描述信息
--- | --- | --- | --- | ---
`Echarts本身` | Object | <可选> |  | 支持Echarts本身所有Options参数，具体查阅 Echarts配置项手册
`id` | String | Number | <可选> | createGuid() | 图层id标识
`pid` | String | Number | <可选> | -1 | 图层父级的id，一般图层管理中使用
`name` | String | <可选> | '' | 图层名称
`pane` | String | <可选> | 'overlayPane' | 指定图层添加到地图的哪个pane的DIV中，用于控制不同层级显示的，优先级高于zIndex。