[fix]调整地图服务图例资源查询参数说明

Author: Wenxinyu1998

src/common/iServer/GetLayersLegendInfoParameters.js

@@ -10,11 +10,11 @@ import {Util} from '../commontypes/Util';
  * @classdesc 图例参数类。该类用于设置图例的尺寸、背景透明、可见范围等参数。
  * @version 11.1.1
  * @param {Object} options - 参数。
- * @param {string} options.bbox - 查询与此矩形框有交集的图层的图例，当 layers 参数未设置时，bbox 是必填参数。格式：bbox=xmin,ymin,xmax,ymax。
+ * @param {string} options.bbox - 查询与此矩形框有交集的图层的图例；当 returnVisibleOnly=true 时，表示在 bbox 里有要素的图层的图例。当 layers 参数未设置时，bbox 是必填参数。格式：bbox=xmin,ymin,xmax,ymax。
  * @param {string} options.layers - 图层过滤，当 bbox 参数未设置时，layers 是必填参数。语法：[show|hide]:layerName1,layerName2。show 表示只返回指定图层的图例，hide 表示指定图层图例不返回，其他查询出来的图层图例都返回。例如：show:country@World@@World，表示只返回 country@World@@World 图层的图例。
  * @param {boolean} [options.transparent=true] - 图例图片是否背景透明。true 代表背景透明。
- * @param {number} [options.mapScale] - 地图比例尺。当 returnVisibleOnly 为 true 时，mapScale 是必填参数。
- * @param {boolean} [options.returnVisibleOnly=false] - 是否只返回当前地图范围内可见要素的图例。
+ * @param {number} [options.mapScale] - 地图比例尺。当 returnVisibleOnly 为 true 时，返回在可见比例尺范围的图层的图例。
+ * @param {boolean} [options.returnVisibleOnly=false] - 是否只返回当前地图范围内可见要素的图例。<br>如果只传 returnVisibleOnly=true，则仅返回可见图层的图例; <br>如果传了 returnVisibleOnly=true 并且 mapScale 也设置了值，则返回可见图层，指定的比例尺在可见比例尺范围里的图层的图例; <br>如果传了 returnVisibleOnly=true, mapScale= *, bbox= *，则返回可见图层，指定的比例尺在可见比例尺范围里，且在 bbox 范围内有要素的图层的图例。
  * @param {number} [options.width=16] - 返回图例的宽度。单位为像素。
  * @param {number} [options.height=16] - 返回图例的高度。单位为像素。
 
@@ -26,7 +26,7 @@ export class GetLayersLegendInfoParameters {
     constructor(options) {
         /**
          * @member {string} GetLayersLegendInfoParameters.prototype.bbox
-         * @description 查询与此矩形框有交集的图层的图例，当layers 参数未设置时，bbox 是必填参数。格式：bbox=xmin,ymin,xmax,ymax。
+         * @description 查询与此矩形框有交集的图层的图例；当 returnVisibleOnly=true 时，表示在 bbox 里有要素的图层的图例。当layers 参数未设置时，bbox 是必填参数。格式：bbox=xmin,ymin,xmax,ymax。
          */
         this.bbox = null;
 
@@ -44,13 +44,14 @@ export class GetLayersLegendInfoParameters {
 
         /**
          * @member {number} GetLayersLegendInfoParameters.prototype.mapScale
-         * @description  地图比例尺。当 returnVisibleOnly 为 true 时，mapScale 是必填参数。
+         * @description  地图比例尺。当 returnVisibleOnly 为 true 时，返回在可见比例尺范围的图层的图例。
          */
         this.mapScale = null;
 
         /**
          * @member {boolean} [GetLayersLegendInfoParameters.prototype.returnVisibleOnly=false]
-         * @description  是否只返回当前地图范围内可见要素的图例。
+         * @description  是否只返回当前地图范围内可见要素的图例。<br>如果只传 returnVisibleOnly=true，则仅返回可见图层的图例; <br>如果传了 returnVisibleOnly=true 并且 mapScale 也设置了值，则返回可见图层，指定的比例尺在可见比例尺范围里的图层的图例; <br>如果传了 returnVisibleOnly=true, mapScale= *, bbox= *，则返回可见图层，指定的比例尺在可见比例尺范围里，且在 bbox 范围内有要素的图层的图例。
+
          */
         this.returnVisibleOnly = null;