# WMS 图层（WMSLayer）
WMS图层用于展示WMS规格的栅格图层服务。
new aimap.WMSLayer(layerOptions: Object)
# 初始化参数
# LayerOptions参数说明
| 字段名 | 类型 | 说明 |
|---|---|---|
| id | string | 默认值为${type}.${uuid}，该值不允许重复。 |
| map | Map | 地图对象，如果设置，该图层会自动加载到地图中，如果未设置，需要手动加载图层：addTo(map)。 |
| zIndex | number | 图层在地图中所属的垂直方向的位置索引，默认为 0。 |
| minZoom | number | 能显示的最小的zoom level，默认 3。 |
| maxZoom | number | 能显示的最大的zoom level（但不包括这个Level），默认20。 |
data必须 | Data | 支持 WMS 规格的栅格瓦片图层服务，具体参见：WMS规格定义。 |
| dataOptions | DataOptions | 数据源的其他配置项，包括数据源的级别范围，额外的处理流程等。具体参见：DataOptions 配置。 |
| style | Style | 本图层支持与栅格相关的样式配置，包括：栅格样式（Raster）。 |
| wms | WMSOptions | 与 WMS 相关的其他参数，包括 WMS 服务的范围，dpi等。具体参见：WMSOptions 配置。 |
# WMSOptions参数说明
| 字段名 | 类型 | 说明 |
|---|---|---|
| dpi | number | 图像的像素密度，默认值：300。 |
| bbox | Array<number> | WMS 服务的范围，表示方式：[minX, minY, maxX, maxY]，默认值：[-180, -85, 180, 85]。 |
# 示例
# 实例变量
# id
此图层的 id，如果在初始化图层的参数中指定，则为参数中的 id，否则 SDK 内部会自动生成一个 id。
# 示例
var wmsLayer = new aimap.WMSLayer({...});
console.log(wmsLayer.id); // "wms.9db79b01-f3c0-4da6-a36a-b4d5827c4e37"
2
# type
此图层的类型，对于本图层， type 为固定值：wms。
# 示例
var wmsLayer = new aimap.WMSLayer({...});
console.log(wmsLayer.type); // "wms"
2
# 实例方法
addTo(map)
如果在初始化图层时，没有传入地图对象参数，则需要使用此方法来将图层添加到地图上。
参数
map(Map)：需要添加本图层的地图对象。
返回值
WMSLayer：this
remove()
将本图层从地图中移除，并销毁相关的资源。
返回值
WMSLayer：this
show()
显示该图层。
返回值
WMSLayer：this
hide()
隐藏该图层。
返回值
WMSLayer：this
setzIndex(zIndex, options?)
设置图层在 z 轴上的顺序。数值越大，层级越高。
参数
zIndex(number | String)：大于 0 的整数或者表示地图初始化样式中自带的图层 id。
options(SetzIndexOptions)：设置层级的更多参数，具体参见：SetzIndexOptions 配置。
返回值
WMSLayer：this
setStyle(style, options?)
增量更新图层的样式。
参数
style(style)：样式对象，这些样式将增量更新到图层已有的样式上，支持的样式与当前图层一致。
options(SetStyleOptions)：设置新样式的其他配置项，具体参见：SetStyleOptions 配置。
返回值
WMSLayer：this
setData(data, options?)
重新指定数据，原有的数据会被清除掉。
参数
data(Data)：与 layeroptions参数说明 中的Data字段定义一致。
options(SetDataOptions)：指定新数据源的其他配置项，具体参见：SetDataOptions 配置。
返回值
WMSLayer：this
setPopup(popup, options)
为图层设置弹窗对象。
参数
popup(Popup | string)：Popup对象，或者弹窗中想要显示的内容文本。
options(Options)：弹窗的配置项，具体参见：Popup 配置
返回值
WMSLayer：this
togglePopup()
切换弹窗的显示，隐藏效果。
返回值
WMSLayer：this
on(type, listener)
为图层绑定事件监听。
参数
type(string)：事件类型，支持的事件类型可参考 图层事件。
listener(Function)：如果此处使用匿名函数，则后续将无法解绑。
返回值
WMSLayer：this
once(type, listener)
为图层绑定事件监听，事件只会响应一次。
参数
type(string)：事件类型，支持的事件类型可参考 图层事件。
listener(Function)：如果此处使用匿名函数，则后续将无法解绑。
返回值
WMSLayer：this
off(type, listener)
解除已绑定事件监听。
参数
type(string)：事件类型，支持的事件类型可参考 图层事件。
listener(Function)：通过 on 或者 once 绑定的事件对象。
返回值
WMSLayer：this
# 图层事件
mousedown
当鼠标点击图层时触发。
mouseup
当鼠标在图层中松开时触发。
click
当鼠标在图层同一点处点击并松开时触发。
dblclick
当鼠标双击图层同一点时触发。
mousemove
当鼠标在图层中移动时触发。
mouseenter
当鼠标从某一图层外部或地图画布外部进入当前图层的可见部分时触发。
mouseleave
当鼠标离开当前图层的可见部分时触发。