FazBrowse GitHub Viewer | Trending |
URL:
| Home
Tools: [Download Repo ZIP]   [Original HTTPS Page]

【doc】优化doc · SuperMap/iClient-JavaScript@813faff · GitHub

/ iClient-JavaScript Public

Commit 813faff

Browse files
songyumeng
committed
【doc】优化doc
1 parent 0ade2c3 commit 813faff

35 files changed

Lines changed: 74 additions & 84 deletions

‎src/classic/services/DatasetService.js‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -33,7 +33,7 @@ export class DatasetService extends CommonServiceBase {
3333

3434
/**
3535
* @function SuperMap.REST.DatasetService.prototype.getDatasets
36-
* @description 数据集集合查询服务。
36+
* @description 根据数据源名称查询该数据源下所有数据集的信息。
3737
* @example
3838
* new SuperMap.REST.DatasetService(url).getDatasets(datasourceName,function(result){
3939
* //doSomething
@@ -51,7 +51,7 @@ export class DatasetService extends CommonServiceBase {
5151

5252
/**
5353
* @function SuperMap.REST.DatasetService.prototype.getDataset
54-
* @description 数据集信息查询服务。
54+
* @description 根据数据源名称、数据集名称查询该数据集的信息。
5555
* @example
5656
* new SuperMap.REST.DatasetService(url).getDataset(datasourceName, datasetName, function(result){
5757
* //doSomething

‎src/classic/services/DatasourceService.js‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -33,7 +33,7 @@ export class DatasourceService extends CommonServiceBase {
3333

3434
/**
3535
* @function SuperMap.REST.DatasourceService.prototype.getDatasources
36-
* @description 数据源集合查询服务。
36+
* @description 获取当前服务下所有数据源信息。
3737
* @example
3838
* new SuperMap.REST.DatasourceService(url).getDatasources(function(result){
3939
* //doSomething
@@ -47,7 +47,7 @@ export class DatasourceService extends CommonServiceBase {
4747

4848
/**
4949
* @function SuperMap.REST.DatasourceService.prototype.getDatasource
50-
* @description 数据源信息查询服务。
50+
* @description 根据数据源名称获取指定数据源的信息。
5151
* @example
5252
* new SuperMap.REST.DatasourceService(url).getDatasource(datasourceName,function(result){
5353
* //doSomething

‎src/common/iServer/DataFlowService.js‎

Lines changed: 8 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -16,8 +16,8 @@ import {SecurityManager} from '../security/SecurityManager';
1616
* @param {Object} options - 参数。
1717
* @param {function} options.style - 设置数据加载样式。
1818
* @param {function} [options.onEachFeature] - 设置每个数据加载 popup 等。
19-
* @param {GeoJSONObject} [options.geometry] - 指定几何范围，只有在该范围内的要素才能被订阅。
20-
* @param {Object} [options.excludeField] - 排除字段。
19+
* @param {GeoJSONObject} [options.geometry] - 空间范围，只有在该范围内的要素才能被接收。
20+
* @param {Object} [options.excludeField] - 过滤字段。传入此参数，接收到的信息将不包含过滤掉的字段。
2121
* @param {boolean} [options.crossOrigin] - 是否允许跨域请求。
2222
* @param {Object} [options.headers] - 请求头。
2323
* @usage
@@ -37,7 +37,7 @@ export class DataFlowService extends CommonServiceBase {
3737

3838
/**
3939
* @member {GeoJSONObject} DataFlowService.prototype.geometry
40-
* @description 指定几何范围，只有在该范围内的要素才能被订阅。
40+
* @description 空间范围，只有在该范围内的要素才能被接收。
4141
*/
4242
this.geometry = null;
4343

@@ -49,7 +49,7 @@ export class DataFlowService extends CommonServiceBase {
4949

5050
/**
5151
* @member {Object} DataFlowService.prototype.excludeField
52-
* @description 排除字段。
52+
* @description 过滤字段。传入此参数，接收到的信息将不包含过滤掉的字段。
5353
*/
5454
this.excludeField = null;
5555

@@ -129,8 +129,8 @@ export class DataFlowService extends CommonServiceBase {
129129

130130
/**
131131
* @function DataFlowService.prototype.setExcludeField
132-
* @description 设置排除字段。
133-
* @param {Object} excludeField - 排除字段。
132+
* @description 设置过滤字段。传入此参数，接收到的信息将不包含过滤掉的字段。
133+
* @param {Object} excludeField - 过滤字段。
134134
* @returns {DataFlowService} DataFlowService 的实例对象。
135135
*/
136136
setExcludeField(excludeField) {
@@ -141,8 +141,8 @@ export class DataFlowService extends CommonServiceBase {
141141

142142
/**
143143
* @function DataFlowService.prototype.setGeometry
144-
* @description 设置添加的几何要素数据。
145-
* @param {GeoJSONObject} geometry - 指定几何范围，只有在该范围内的要素才能被订阅。
144+
* @description 设置空间范围，只有在该范围内的要素才能被接收。
145+
* @param {GeoJSONObject} geometry - 空间范围。
146146
* @returns {DataFlowService} DataFlowService 的实例对象。
147147
*/
148148
setGeometry(geometry) {

‎src/common/iServer/Route.js‎

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -19,7 +19,6 @@ import {Collection} from '../commontypes/geometry/Collection';
1919
* @param {number} options.length - 路由对象的长度。单位与数据集的单位相同。
2020
* @param {number} [options.maxM] - 最大线性度量值，即所有结点到起始点的量算距离中最大值。
2121
* @param {number} [options.minM] - 最小线性度量值，即所有结点到起始点的量算距离中最小值。
22-
* @param {string} [options.type] - 数据类型，如："LINEM"。
2322
* @extends GeometryCollection
2423
* @usage
2524
*/
@@ -95,7 +94,7 @@ export class Route extends Collection {
9594
* @member {string} Route.prototype.type
9695
* @description 服务端几何对象类型。
9796
*/
98-
this.type = null;
97+
this.type = "LINEM";
9998

10099
/**
101100
* @member {Array.<string>} [Route.prototype.componentTypes=LineString]

‎src/leaflet/mapping/TiledMapLayer.js‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -37,7 +37,7 @@ import Attributions from '../core/Attributions';
3737
* @param {(number|L.Point)} [options.tileSize=256] - 瓦片大小。
3838
* @param {(NDVIParameter|HillshadeParameter)} [options.rasterfunction] - 栅格分析参数。
3939
* @param {string} [options.attribution='Map Data <span>© <a href='http://support.supermap.com.cn/product/iServer.aspx' title='SuperMap iServer' target='_blank'>SuperMap iServer</a></span>'] - 版权描述信息。
40-
* @param {Array.<number>} [options.subdomains] - 子域名数组。
40+
* @param {Array.<number>|Array.<string>} [options.subdomains] - 子域名数组。
4141
* @param {ChartSettingS57|ChartSettingS100} [options.chartSetting] - 海图显示参数设置类，用于管理海图显示环境，包括海图的显示模式、显示类型名称、颜色模式、安全水深线等各种显示风格。
4242
* @param {number} [options.overflowTiles = 0] - 绘制超出图层范围的瓦片圈数。常用于位于地图边缘的要素符号显示不全的场景。默认值为0，表示不绘制超出图层范围的瓦片。当 options.noWrap 为 true 时，overflowTiles有效。
4343
* @fires TiledMapLayer#tilesetsinfoloaded

‎src/leaflet/overlay/DataFlowLayer.js‎

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -23,15 +23,15 @@ import {
2323
* @param {Object} options - 参数。
2424
* @param {Object} [options.render='normal'] - 绘制方式。可选值为 'normal'，'mapv'。
2525
'normal' 表示以 {( {@link L.LatLng}|{@link L.Polyline}|{@link L.Polygon}|{@link L.Marker} )} 方式绘制数据流。'mapv' 表示以 {@link MapVLayer} 方式绘制实时数据。
26-
* @param {GeoJSONObject} [options.geometry] - 指定几何范围，只有在该范围内的要素才能被订阅。
26+
* @param {GeoJSONObject} [options.geometry] - 空间范围，只有在该范围内的要素才能被接收。
2727
* @param {Object} [options.prjCoordSys] - 投影坐标对象。
28-
* @param {string} [options.excludeField] - 排除字段。
28+
* @param {string} [options.excludeField] - 过滤字段。传入此参数，接收到的信息将不包含过滤掉的字段。
2929
* @param {string} [options.idField='id'] - 要素属性中表示唯一标识的字段。
30-
* @param {function} [options.pointToLayer] - 定义点要素如何绘制在地图上。
30+
* @param {function} [options.pointToLayer] - 定义点要素如何绘制在地图上的函数。当接收到数据时，内部会调用此函数，并传递 GeoJSON 点要素及其经纬度坐标。
3131
`function(geoJsonPoint, latlng) {
3232
return L.marker(latlng);
3333
}`
34-
* @param {function} [options.style] - 定义点、线、面要素样式。参数为{@link L.Path-option}。</br>
34+
* @param {function} [options.style] - 定义点、线、面要素样式的函数。返回参数为{@link L.Path-option}。当接收到数据时，内部会调用此函数，并传递 GeoJSON 要素</br>
3535
`function (feature) {
3636
return {
3737
fillColor: "red",
@@ -121,8 +121,8 @@ export var DataFlowLayer = L.LayerGroup.extend({
121121
},
122122
/**
123123
* @function DataFlowLayer.prototype.setExcludeField
124-
* @description 设置唯一字段。
125-
* @param {string} excludeField - 唯一字段。
124+
* @description 设置过滤字段。传入此参数，接收到的信息将不包含过滤掉的字段。
125+
* @param {string} excludeField - 过滤字段。
126126
*/
127127
setExcludeField: function (excludeField) {
128128
this.dataService.setExcludeField(excludeField);

‎src/leaflet/overlay/GraphThemeLayer.js‎

Lines changed: 0 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -24,11 +24,8 @@
2424
* @param {boolean} [options.isOverLay=true] - 是否进行压盖处理，如果设为 true，图表绘制过程中将隐藏对已在图层中绘制的图表产生压盖的图表。
2525
* @param {string} options.themeFields - 指定创建专题图字段。
2626
* @param {boolean} [options.alwaysMapCRS=false] - 要素坐标是否和地图坐标系一致，要素默认是经纬度坐标。
27-
* @param {Object} [options.cache] - 缓存。
28-
* @param {Object} [options.charts] - 图表。
2927
* @param {string} [options.id] - 专题图层 ID。默认使用 CommonUtil.createUniqueID("themeLayer_") 创建专题图层 ID。
3028
* @param {number} [options.opacity=1] - 图层不透明度。
31-
* @param {Array} [options.TFEvents] - 专题要素事件临时存储。
3229
* @param {Object} options.chartsSetting - 各类型图表的 chartsSetting 对象可设属性请参考具体图表模型类的注释中对 chartsSetting 对象可设属性的描述。chartsSetting 对象通常都具有以下可设的基础属性:</br>
3330
* @param {number} options.chartsSetting.width - 专题要素（图表）宽度，单位为像素。
3431
* @param {number} options.chartsSetting.height - 专题要素（图表）高度，单位为像素。

‎src/leaflet/overlay/LabelThemeLayer.js‎

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -24,7 +24,6 @@
2424
* @param {boolean} [options.alwaysMapCRS=false] - 要素坐标是否和地图坐标系一致，要素默认是经纬度坐标。
2525
* @param {boolean} [options.isOverLay=true] - 是否进行压盖处理，如果设为 true，图表绘制过程中将隐藏对已在图层中绘制的图表产生压盖的图表。
2626
* @param {number} [options.opacity=1] - 图层不透明度。
27-
* @param {Array} [options.TFEvents] - 专题要素事件临时存储。
2827
* @param {number} [options.nodesClipPixel=2] - 节点抽稀像素距离。
2928
* @param {boolean} [options.isHoverAble=false] - 图形是否在 hover 时高亮。
3029
* @param {boolean} [options.isMultiHover=false] - 是否多图形同时高亮，用于高亮同一个数据对应的所有图形（如：多面）。

‎src/leaflet/overlay/RangeThemeLayer.js‎

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -19,7 +19,6 @@ import { Util as CommonUtil } from '@supermapgis/iclient-common/commontypes/Util
1919
* @param {number} [options.opacity=1] - 图层不透明度。
2020
* @param {boolean} [options.alwaysMapCRS=false] - 要素坐标是否和地图坐标系一致，要素默认是经纬度坐标。
2121
* @param {string} [options.attribution='Map Data <span>© <a href='http://support.supermap.com.cn/product/iServer.aspx' title='SuperMap iServer' target='_blank'>SuperMap iServer</a></span>'] - 版权描述信息。
22-
* @param {Array} [options.TFEvents] - 专题要素事件临时存储。
2322
* @param {number} [options.nodesClipPixel=2] - 节点抽稀像素距离。
2423
* @param {boolean} [options.isHoverAble=false] - 图形是否在 hover 时高亮。
2524
* @param {boolean} [options.isMultiHover=false] - 是否多图形同时高亮，用于高亮同一个数据对应的所有图形（如：多面）。

‎src/leaflet/overlay/RankSymbolThemeLayer.js‎

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -25,7 +25,6 @@ import {
2525
* @param {boolean} [options.alwaysMapCRS=false] - 要素坐标是否和地图坐标系一致，要素默认是经纬度坐标。
2626
* @param {string} [options.id] - 专题图层 ID。默认使用 CommonUtil.createUniqueID("themeLayer_") 创建专题图层 ID。
2727
* @param {number} [options.opacity=1] - 图层不透明度。
28-
* @param {Array} [options.TFEvents] - 专题要素事件临时存储。
2928
* @param {string} [options.attribution='Map Data <span>© <a href='http://support.supermap.com.cn/product/iServer.aspx' title='SuperMap iServer' target='_blank'>SuperMap iServer</a></span>'] - 版权描述信息。
3029
* @usage
3130
*/

0 commit comments

Comments
 (0)
Back | FazBrowse Home | New Git URL