数据上图 WebApp 扩展定制开放接口

addTileLayer()

将 iServer RESTMAP 服务以瓦片图层的形式添加到右侧地图上。

用法：

new DataViz.Plugins.DatavizPlugins().addTileLayer(layerInfo, url, token, addLayerCallback)

参数说明：

参数	类型	描述
layerInfo	object	【必填参数】图层信息。对象需包含： id：图层 id，不可设置为1（会与底图冲突） name：图层名称示例：{id: 11, name: '瓦片图层'}
url	string	【必填参数】 iServer RESTMAP 服务地址，url 需填到地图名称级别
token	string	【可选参数】服务地址对应的密钥。若服务是私有服务，必须传此参数
addLayerCallback	Function	【可选参数】回调函数。图层添加成功，无返回值；失败会返回失败信息

addVectorLayerFromUrl()

将 iServer RESTDATA 服务以矢量图层的形式添加到右侧地图上。

用法：

new DataViz.Plugins.DatavizPlugins().addVectorLayerFromUrl(layerInfo, url, addLayerCallback)

参数说明：

参数	类型	描述
layerInfo	object	【必填参数】图层信息。对象需包含： id：图层 id，不可设置为1（会与底图冲突） name：图层名称示例：{id: 11, name: '矢量图层'}
url	string	【必填参数】 iServer RESTDATA 服务地址，url 需填到数据集级别
addLayerCallback	Function	【可选参数】回调函数。图层添加成功，无返回值；失败会返回失败信息

addVectorLayerFromJSON()

将 geojson 格式的数据以矢量图层的形式添加到右侧地图上。

用法：

new DataViz.Plugins.DatavizPlugins().addVectorLayerFromJSON(layerInfo, geojson, projection, addLayerCallback)

参数说明：

参数	类型	描述
layerInfo	object	【必填参数】图层信息。对象需包含： id：图层 id，不可设置为1（会与底图冲突） name：图层名称示例：{id: 11, name: '矢量图层'}
geojson	geojson	【必填参数】标准的 geojson 格式数据
projection	string	【必填参数】 geojson 数据的坐标系示例：EPSG:4326
addLayerCallback	Function	【可选参数】回调函数。图层添加成功，无返回值；失败会返回失败信息

addMarkerLayerFromUrl()

将 iServer RESTDATA 服务以标注图层的形式添加到右侧地图上。

用法：

new DataViz.Plugins.DatavizPlugins().addMarkerLayerFromUrl(layerInfo, url, addLayerCallback)

参数说明：

参数	类型	描述
layerInfo	object	【必填参数】图层信息。对象需包含： id：图层 id，不可设置为1（会与底图冲突） name：图层名称示例：{id: 11, name: '标注图层'}
url	string	【必填参数】 iServer RESTDATA 服务地址，url 需填到数据集级别
addLayerCallback	Function	【可选参数】回调函数。图层添加成功，无返回值；失败会返回失败信息

addMarkerLayerFromJSON()

将 geojson 格式的数据以标注图层的形式添加到右侧地图上。

用法：

new DataViz.Plugins.DatavizPlugins().addMarkerLayerFromJSON(layerInfo, geojson, projection, addLayerCallback)

参数说明：

参数	类型	描述
layerInfo	object	【必填参数】图层信息。对象需包含： id：图层 id，不可设置为1（会与底图冲突） name：图层名称示例：{id: 11, name: '标注图层'}
geojson	geojson	【必填参数】标准的 geojson 格式数据
projection	string	【必填参数】 geojson 数据的坐标系示例：EPSG:4326
addLayerCallback	Function	【可选参数】回调函数。图层添加成功，无返回值；失败会返回失败信息

addWMTSLayer()

添加一个 WMTSLayer 到右侧地图上。

用法：

new DataViz.Plugins.DatavizPlugins().addWMTSLayer(layerInfo, projection, addLayerCallback)

参数说明：

参数	类型	描述
layerInfo	object	【必填参数】图层信息。该对象包含参数较多，请查看下面表格的详细介绍。
projection	string	【必填参数】当前需要添加图层的坐标系。坐标系需与底图保持一致。示例：EPSG:4326
addLayerCallback	Function	【可选参数】回调函数。图层添加成功，无返回值；失败会返回失败信息

上表中 layerInfo 对象详细参数如下：

参数	类型	描述
id	string、number	【必填参数】图层 id，不可设置为1（会与底图冲突）
name	string	【必填参数】图层名称。
url	string	【必填参数】 WMTS 服务地址。支持所有符合 OGC 规范的 WMTS 服务地址。
layer	string	【必填参数】 WMTS 服务中的图层名称。
tileMatrixSet	string	【必填参数】 WMTS 服务中的图层对应的瓦片矩阵集。
requestEncoding	string	【可选参数】 WMTS 服务访问模式，可选 HTTP KVP（key-Value Pair）或 REST 两种访问模式。默认使用 KVP。

addWMSLayer()

添加一个 WMTSLayer 到右侧地图上。

用法：

new DataViz.Plugins.DatavizPlugins().addWMSLayer(layerInfo, addLayerCallback)

参数说明：

参数	类型	描述
layerInfo	object	【必填参数】图层信息。该对象包含参数较多，请查看下面表格的详细介绍。
addLayerCallback	Function	【可选参数】回调函数。图层添加成功，无返回值；失败会返回失败信息

上表中 layerInfo 对象详细参数如下：

参数	类型	描述
id	string、number	【必填参数】图层 id，不可设置为1（会与底图冲突）
name	string	【必填参数】图层名称。
url	string	【必填参数】 WMS 服务地址。支持所有符合 OGC 规范的 WMS 服务地址。
layers	array <string>	【必填参数】 WMTS 服务中的图层列表。列表中第一个图层在最底，下一个图层放到前一个的上面，依次类推。图层名称是服务元数据中的<Layer><Name>元素的字符数据内容。
projection	string	【必填参数】当前需要添加图层的坐标系。坐标系需与底图保持一致。示例：EPSG:4326

getWMTSCapabilities()

获取 WMTS 服务的服务能力文档。

用法：

new DataViz.Plugins.DatavizPlugins().getWMTSCapabilities(url, isKvp)

参数说明：

参数	类型	描述
url	string	【必填参数】 WMTS 服务地址。
isKvp	boolean	【必填参数】请求文档的 url 方式。true 为kvp 方式；false 为 restful 方式

removeLayerById()

从当前地图删除指定 id 的图层。

用法：

new DataViz.Plugins.DatavizPlugins().removeLayerById(layerId)

参数说明：

参数	类型	描述
layerId	string、number	【必填参数】要删除的图层对应的 id

getOLMap()

获取当前地图对象。

用法：

new DataViz.Plugins.DatavizPlugins().getOLMap()

返回值：

ol.Map 对象