new GetLayersLegendInfoParameters(options)

Usage

// 浏览器
<script type="text/javascript" src="https://iclient.supermap.io/dist/leaflet/iclient-leaflet.js"></script>
<script>
  new L.supermap.GetLayersLegendInfoParameters(options);
  
  // 弃用的写法
  new SuperMap.GetLayersLegendInfoParameters(options);

</script>

// ES6 Import
import { GetLayersLegendInfoParameters } from '@supermapgis/iclient-leaflet';

new GetLayersLegendInfoParameters(options);

common/iServer/GetLayersLegendInfoParameters.js, line 6

Name Type Description

options

Object

参数。

Name	Type	Default	Description
`bbox`	string		查询与此矩形框有交集的图层的图例，当 layers 参数未设置时，bbox 是必填参数。格式：bbox=xmin,ymin,xmax,ymax。
`layers`	string		图层过滤，当 bbox 参数未设置时，layers 是必填参数。语法：[show\|hide]:layerName1,layerName2。show 表示只返回指定图层的图例，hide 表示指定图层图例不返回，其他查询出来的图层图例都返回。例如：show:country@World@@World，表示只返回 country@World@@World 图层的图例。
`transparent`	boolean	true	可选图例图片是否背景透明。true 代表背景透明。
`mapScale`	number		可选地图比例尺。当 returnVisibleOnly 为 true 时，mapScale 是必填参数。
`returnVisibleOnly`	boolean	false	可选是否只返回当前地图范围内可见要素的图例。
`width`	number	16	可选返回图例的宽度。单位为像素。
`height`	number	16	可选返回图例的高度。单位为像素。

Version:

11.1.1

Members

bboxstring

查询与此矩形框有交集的图层的图例，当layers 参数未设置时，bbox 是必填参数。格式：bbox=xmin,ymin,xmax,ymax。

heightnumber

返回图例的高度。单位为像素。

Default Value:

layersstring

图层过滤，当 bbox 参数未设置时，layers 是必填参数。语法：[show|hide]:layerName1,layerName2。show 表示只返回指定图层的图例，hide 表示指定图层图例不返回，其他查询出来的图层图例都返回。例如：show:country@World@@World，表示只返回 country@World@@World 图层的图例。

mapScalenumber

地图比例尺。当 returnVisibleOnly 为 true 时，mapScale 是必填参数。

returnVisibleOnlyboolean

是否只返回当前地图范围内可见要素的图例。

transparentboolean

图例图片是否背景透明。

Default Value:

widthnumber

返回图例的宽度。单位为像素。

Default Value:

Methods

destroy() common/iServer/GetLayersLegendInfoParameters.js, line 74

释放资源，将引用的资源属性置空。

Class: GetLayersLegendInfoParameters