Skip to content

Commit 0127971

Browse files
committed
[fix]遗漏的doc优化
1 parent 93c10ec commit 0127971

7 files changed

Lines changed: 9 additions & 9 deletions

File tree

src/common/iServer/QueryByBoundsParameters.js

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -21,7 +21,7 @@ import {QueryParameters} from './QueryParameters';
2121
* @param {number} [options.startRecord=0] - 查询起始记录位置。
2222
* @param {number} [options.holdTime=10] - 资源在服务端保存的时间,单位为分钟。
2323
* @param {boolean} [options.returnCustomResult=false] - 是否返回查询结果的查询范围信息,当 returnContent=false 时有效。如果为 true,返回查询结果的查询范围信息。如果为 false,则不返回查询范围信息。
24-
* @param {boolean} [options.returnContent=true] - 是否立即返回新创建资源的表述还是返回新资源的 URI。
24+
* @param {boolean} [options.returnContent=true] - 是否立即返回新创建资源的表述还是返回新资源的 URI。如果为 true,则直接返回新创建资源,即查询结果的表述。如果为 false,则返回的是查询结果资源的 URI。
2525
* @param {boolean} [options.returnFeatureWithFieldCaption = false] - 返回的查询结果要素字段标识是否为字段别名。为 false 时,返回的是字段名;为 true 时,返回的是字段别名。
2626
* @usage
2727
*/

src/common/iServer/QueryByDistanceParameters.js

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -23,7 +23,7 @@ import {QueryParameters} from './QueryParameters';
2323
* @param {number} [options.holdTime=10] - 资源在服务端保存的时间,单位为分钟。
2424
* @param {boolean} [options.returnCustomResult=false] -仅供三维使用。是否返回查询结果的 Bounds 信息,当 returnContent=false 时有效。如果为 true,返回查询结果的 Bounds 信息。如果为 false,则不返回 Bounds 信息。
2525
* @param {boolean} [options.isNearest=false] - 是否为最近距离查询。
26-
* @param {boolean} [options.returnContent=true] - 是否立即返回新创建资源的表述还是返回新资源的 URI。
26+
* @param {boolean} [options.returnContent=true] - 是否立即返回新创建资源的表述还是返回新资源的 URI。如果为 true,则直接返回新创建资源,即查询结果的表述。如果为 false,则返回的是查询结果资源的 URI。
2727
* @param {boolean} [options.returnFeatureWithFieldCaption = false] - 返回的查询结果要素字段标识是否为字段别名。为 false 时,返回的是字段名;为 true 时,返回的是字段别名。
2828
* @usage
2929
*/

src/common/iServer/QueryBySQLParameters.js

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -20,7 +20,7 @@ import {QueryParameters} from './QueryParameters';
2020
* @param {number} [options.startRecord=0] - 查询起始记录位置。
2121
* @param {number} [options.holdTime=10] - 资源在服务端保存的时间,单位为分钟。
2222
* @param {boolean} [options.returnCustomResult=false] - 仅供三维使用。是否返回查询结果的 Bounds 信息,当 returnContent=false 时有效。如果为 true,返回查询结果的 Bounds 信息。如果为 false,则不返回 Bounds 信息。
23-
* @param {boolean} [options.returnContent=true] - 是否立即返回新创建资源的表述还是返回新资源的 URI。
23+
* @param {boolean} [options.returnContent=true] - 是否立即返回新创建资源的表述还是返回新资源的 URI。如果为 true,则直接返回新创建资源,即查询结果的表述。如果为 false,则返回的是查询结果资源的 URI。
2424
* @param {boolean} [options.returnFeatureWithFieldCaption = false] - 返回的查询结果要素字段标识是否为字段别名。为 false 时,返回的是字段名;为 true 时,返回的是字段别名。
2525
* @usage
2626
*/

src/common/iServer/UGCMapLayer.js

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -19,7 +19,7 @@ import {UGCLayer} from './UGCLayer';
1919
* @param {boolean} [options.symbolScalable] - 是否允许图层的符号大小随图缩放。
2020
* @param {number} [options.symbolScale] - 图层符号缩放的基准比例尺。
2121
* @param {boolean} [options.overlapDisplayed=false] - 地图对象在同一范围内时,是否重叠显示,如果为 true,则同一范围内的对象会直接压盖;如果为 false 则通过 overlapDisplayedOptions 控制对象不压盖显示。
22-
* @param {OverlapDisplayedOptions} [options.overlapDisplayedOptions] - 避免地图对象压盖显示的过滤选项,当 overlapDisplayed 为 false 时有效。在文本或专题图元素显示较密集的区域,文本之间或专题元素之间会发生相互压盖的现象, 该类可以分别控制各种类型的对象的压盖显示情况,以处理地图中各种类型对象的压盖显示问题。
22+
* @param {OverlapDisplayedOptions} [options.overlapDisplayedOptions] - 避免地图对象压盖显示的过滤选项,当 overlapDisplayed 为 false 时有效。在文本或专题图元素显示较密集的区域,文本之间或专题元素之间会发生相互压盖的现象,此选项可以分别控制各种类型的对象的压盖显示情况,以处理地图中各种类型对象的压盖显示问题。
2323
* @usage
2424
*/
2525
export class UGCMapLayer extends UGCLayer {
@@ -77,7 +77,7 @@ export class UGCMapLayer extends UGCLayer {
7777
/**
7878
* @member {OverlapDisplayedOptions} UGCMapLayer.prototype.overlapDisplayedOptions
7979
* @description 避免地图对象压盖显示的过滤选项,当 overlapDisplayed 为 false 时有效。<br>
80-
* 在文本或专题图元素显示较密集的区域,文本之间或专题元素之间会发生相互压盖的现象, 该类可以分别控制各种类型的对象的压盖显示情况,以处理地图中各种类型对象的压盖显示问题。
80+
* 在文本或专题图元素显示较密集的区域,文本之间或专题元素之间会发生相互压盖的现象, 此选项可以分别控制各种类型的对象的压盖显示情况,以处理地图中各种类型对象的压盖显示问题。
8181
*/
8282
this.overlapDisplayedOptions = null;
8383

src/leaflet/mapping/ImageMapLayer.js

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -27,7 +27,7 @@ import { toSuperMapGeometry } from '../core/Util';
2727
* @param {L.Path} [options.clipRegion] - 地图显示裁剪的区域(区域为一个面对象)。当 clipRegionEnabled = true 时有效,即地图只显示该区域覆盖的部分。
2828
* @param {Object} [options.prjCoordSys] - 请求的地图的坐标参考系统。如:prjCoordSys={"epsgCode":3857}。
2929
* @param {boolean} [options.overlapDisplayed=false] - 地图对象在同一范围内,是否重叠显示。
30-
* @param {string} [options.overlapDisplayedOptions] - 避免地图对象压盖显示的过滤选项,当 overlapDisplayed 为 false 时有效。在文本或专题图元素显示较密集的区域,文本之间或专题元素之间会发生相互压盖的现象, 该类可以分别控制各种类型的对象的压盖显示情况,以处理地图中各种类型对象的压盖显示问题。
30+
* @param {string} [options.overlapDisplayedOptions] - 避免地图对象压盖显示的过滤选项,当 overlapDisplayed 为 false 时有效。在文本或专题图元素显示较密集的区域,文本之间或专题元素之间会发生相互压盖的现象, 此选项可以分别控制各种类型的对象的压盖显示情况,以处理地图中各种类型对象的压盖显示问题。
3131
* @param {number} [options.opacity=1] - 图层不透明度。
3232
* @param {string} [options.alt] - 图像无法显示时的提示文字。
3333
* @param {string} [options.pane='tilePane'] - 图层所归属的 map DOM 的分组。

src/leaflet/mapping/TiledMapLayer.js

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -29,7 +29,7 @@ import Attributions from '../core/Attributions';
2929
* @param {L.Path} [options.clipRegion] - 地图显示裁剪的区域。是一个面对象,当 clipRegionEnabled = true 时有效,即地图只显示该区域覆盖的部分。
3030
* @param {Object} [options.prjCoordSys] - 请求的地图瓦片的坐标参考系统。 如:prjCoordSys={"epsgCode":3857}。当此参数设置的坐标系统不同于地图的原有坐标系统时, 系统会进行坐标转换,并返回坐标转换后的地图瓦片。
3131
* @param {boolean} [options.overlapDisplayed=false] - 地图对象在同一范围内时,是否重叠显示,如果为 true,则同一范围内的对象会直接压盖;如果为 false 则通过 overlapDisplayedOptions 控制对象不压盖显示。
32-
* @param {string} [options.overlapDisplayedOptions] - 避免地图对象压盖显示的过滤选项,当 overlapDisplayed 为 false 时有效。在文本或专题图元素显示较密集的区域,文本之间或专题元素之间会发生相互压盖的现象, 该类可以分别控制各种类型的对象的压盖显示情况,以处理地图中各种类型对象的压盖显示问题。
32+
* @param {string} [options.overlapDisplayedOptions] - 避免地图对象压盖显示的过滤选项,当 overlapDisplayed 为 false 时有效。在文本或专题图元素显示较密集的区域,文本之间或专题元素之间会发生相互压盖的现象, 此选项可以分别控制各种类型的对象的压盖显示情况,以处理地图中各种类型对象的压盖显示问题。
3333
* @param {string} [options.tileversion] - 切片版本名称,cacheEnabled 为 true 时有效。如果没有设置 tileversion 参数,而且当前地图的切片集中存在多个版本,则默认使用最后一个更新版本。
3434
* @param {CRS} [options.crs] - 坐标系统类。
3535
* @param {string} [options.tileProxy] - 服务代理地址。

src/leaflet/overlay/DataFlowLayer.js

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -31,7 +31,7 @@ import {
3131
`function(geoJsonPoint, latlng) {
3232
return L.marker(latlng);
3333
}`
34-
* @param {function} [options.style] - 定义点、线、面要素样式的函数。返回参数为{@link L.Path-option}。当接收到数据时,内部会调用此函数,并传递 GeoJSON 要素</br>
34+
* @param {function} [options.style] - 定义点、线、面要素样式的函数。返回参数为{@link L.Path-option}。当接收到数据时,内部会调用此函数,并传递 GeoJSON 要素</br>
3535
`function (feature) {
3636
return {
3737
fillColor: "red",
@@ -132,7 +132,7 @@ export var DataFlowLayer = L.LayerGroup.extend({
132132

133133
/**
134134
* @function DataFlowLayer.prototype.setGeometry
135-
* @description 设置几何要素
135+
* @description 设置空间范围,只有在该范围内的要素才能被接收
136136
* @param {GeoJSONObject} geometry - 待设置的 GeoJSON 几何要素对象。
137137
*/
138138
setGeometry: function (geometry) {

0 commit comments

Comments
 (0)