Skip to content

Commit 22e509c

Browse files
YOUYOUNGYOUYOUNG
committed
[update]mapboxgl排查文档 review by xiongjj
1 parent 5890820 commit 22e509c

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

50 files changed

+363
-385
lines changed

‎src/classic/services/ProcessingService.js‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -95,7 +95,7 @@ export class ProcessingService extends CommonServiceBase {
9595
/**
9696
* @function SuperMap.REST.ProcessingService.prototype.addKernelDensityJob
9797
* @description 密度分析。
98-
* @param {KernelDensityJobParameter} params - 密度分析任务参数类。
98+
* @param {KernelDensityJobParameter} params - 核密度分析服务参数类。
9999
* @param {function} callback - 回调函数。
100100
* @param {number} [seconds=1000] - 获取创建成功结果的时间间隔。
101101
* @param {DataFormat} [resultFormat=DataFormat.GEOJSON] - 返回结果类型。

‎src/common/iServer/EditFeaturesParameters.js‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,7 @@ import {ServerGeometry} from './ServerGeometry';
99
* @class EditFeaturesParameters
1010
* @deprecatedclass SuperMap.EditFeaturesParameters
1111
* @category iServer Data Feature
12-
* @classdesc 数据服务中数据集添加、修改、删除参数类。
12+
* @classdesc 数据集添加、修改、删除参数类。
1313
* @category iServer Data
1414
* @param {Object} options - 参数。
1515
* @param {Array.<GeometryVector|GeoJSONObject|ol.feature>} options.features - 当前需要创建或者是修改的要素集。

‎src/common/iServer/GetFeaturesByBufferParameters.js‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -10,7 +10,7 @@ import { ServerGeometry } from './ServerGeometry';
1010
* @class GetFeaturesByBufferParameters
1111
* @deprecatedclass SuperMap.GetFeaturesByBufferParameters
1212
* @category iServer Data FeatureResults
13-
* @classdesc 数据服务中数据集缓冲区查询参数类。
13+
* @classdesc 数据集缓冲区查询参数类。
1414
* @param {Object} options - 参数。
1515
* @param {number} options.bufferDistance - buffer 距离，单位与所查询图层对应的数据集单位相同。
1616
* @param {Object} options.geometry - 空间查询条件。

‎src/common/iServer/GetFeaturesBySQLParameters.js‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@ import { GetFeaturesParametersBase } from './GetFeaturesParametersBase';
88
* @class GetFeaturesBySQLParameters
99
* @deprecatedclass SuperMap.GetFeaturesBySQLParameters
1010
* @category iServer Data FeatureResults
11-
* @classdesc 数据服务中数据集 SQL 查询参数类。
11+
* @classdesc 数据集 SQL 查询参数类。
1212
* @param {Object} options - 参数。
1313
* @param {FilterParameter} options.queryParameter - 查询过滤条件参数。
1414
* @param {Array.<string>} options.datasetNames - 数据集集合中的数据集名称列表。

‎src/common/iServer/KernelDensityJobParameter.js‎

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -143,9 +143,9 @@ export class KernelDensityJobParameter {
143143

144144
/**
145145
* @function KernelDensityJobParameter.toObject
146-
* @param {KernelDensityJobParameter} kernelDensityJobParameter - 密度分析任务参数类。
147-
* @param {KernelDensityJobParameter} tempObj - 密度分析任务参数对象。
148-
* @description 将密度分析任务参数对象转换为 JSON 对象。
146+
* @param {KernelDensityJobParameter} kernelDensityJobParameter - 核密度分析服务参数类。
147+
* @param {KernelDensityJobParameter} tempObj - 核密度分析服务参数对象。
148+
* @description 将核密度分析服务参数对象转换为 JSON 对象。
149149
* @returns JSON 对象。
150150
*/
151151
static toObject(kernelDensityJobParameter, tempObj) {

‎src/common/iServer/KernelDensityJobsService.js‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -53,7 +53,7 @@ export class KernelDensityJobsService extends ProcessingServiceBase {
5353
/**
5454
* @function KernelDensityJobsService.prototype.addKernelDensityJob
5555
* @description 新建核密度分析服务
56-
* @param {KernelDensityJobParameter} params - 创建一个空间分析的请求参数。
56+
* @param {KernelDensityJobParameter} params - 核密度分析服务参数类。
5757
* @param {number} seconds - 开始创建后，获取创建成功结果的时间间隔。
5858
*/
5959
addKernelDensityJob(params, seconds) {

‎src/leaflet/services/FeatureService.js‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -90,7 +90,7 @@ export var FeatureService = ServiceBase.extend({
9090
/**
9191
* @function FeatureService.prototype.getFeaturesByBuffer
9292
* @description 数据集 buffer 查询服务。
93-
* @param {GetFeaturesByBufferParameters} params - 数据服务中数据集缓冲区查询参数类。
93+
* @param {GetFeaturesByBufferParameters} params - 数据集缓冲区查询参数类。
9494
* @param {RequestCallback} callback - 回调函数。
9595
* @param {DataFormat} [resultFormat=DataFormat.GEOJSON] - 返回结果类型。
9696
*/
@@ -113,7 +113,7 @@ export var FeatureService = ServiceBase.extend({
113113
/**
114114
* @function FeatureService.prototype.getFeaturesBySQL
115115
* @description 数据集 SQL 查询服务。
116-
* @param {GetFeaturesBySQLParameters} params - 数据服务中数据集 SQL 查询参数类。
116+
* @param {GetFeaturesBySQLParameters} params - 数据集 SQL 查询参数类。
117117
* @param {RequestCallback} callback - 回调函数。
118118
* @param {DataFormat} [resultFormat=DataFormat.GEOJSON] - 返回结果类型。
119119
*/

‎src/mapboxgl/control/Logo.js‎

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -16,9 +16,9 @@ import {LogoBase64} from '@supermap/iclient-common/control/img/Logo';
1616
* (end)
1717
* @param {Object} options - logo 控件配置项。
1818
* @param {string} [options.imageUrl] - logo 图片地址。
19-
* @param {string} [options.width] - logo 图片宽。
20-
* @param {string} [options.height] - logo 图片高。
21-
* @param {string} [options.link] - logo 图片跳转链接。
19+
* @param {string} [options.width] - logo 图片宽度。
20+
* @param {string} [options.height] - logo 图片高度。
21+
* @param {string} [options.link] - logo图片跳转链接。
2222
* @param {string} [options.alt='SuperMap iClient'] - logo 图片失效时显示文本。
2323
* @usage
2424
*/
@@ -39,8 +39,8 @@ export class Logo {
3939

4040
/**
4141
* @function Logo.prototype.onAdd
42-
* @description 添加一个 logo。
43-
* @returns {HTMLElement} 返回创建的 logo 元素。
42+
* @description 添加Logo。
43+
* @returns {HTMLElement} 返回创建的 Logo 元素。
4444
*/
4545
onAdd(map) {
4646
this._map = map;

‎src/mapboxgl/core/Util.js‎

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -96,7 +96,7 @@ export const Util = {
9696
/**
9797
* @function Util.toGeoJSON
9898
* @description 将传入对象转为 GeoJSON 格式。
99-
* @param {Object} smObj - 待转参数。
99+
* @param {Object} smObj - 待转对象。
100100
*/
101101
toGeoJSON(smObj) {
102102
if (smObj) {
@@ -189,8 +189,8 @@ export const Util = {
189189
},
190190
/**
191191
* @description 十六进制转 RGBA 格式。
192-
* @param {Object} hex - 十六进制格式参数。
193-
* @param {number} opacity -Alpha 参数。
192+
* @param {Object} hex - 十六进制格式。
193+
* @param {number} opacity - 不透明度Alpha。
194194
* @returns {string} 生成的 RGBA 格式。
195195
*/
196196
hexToRgba(hex, opacity) {
@@ -214,7 +214,7 @@ export const Util = {
214214

215215
/**
216216
* @param {string} featureName 原始数据中的地名
217-
* @param {string} fieldName 需要匹配的地名
217+
* @param {string} fieldName 待匹配的地名
218218
* @returns {boolean} 是否匹配
219219
*/
220220
isMatchAdministrativeName(featureName, fieldName) {

‎src/mapboxgl/mapping/WebMap.js‎

Lines changed: 6 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -70,8 +70,8 @@ const DEFAULT_WELLKNOWNSCALESET = ['GoogleCRS84Quad', 'GoogleMapsCompatible'];
7070
* <div style="padding: 20px;border: 1px solid #eee;border-left-width: 5px;border-radius: 3px;border-left-color: #ce4844;">
7171
* <p style="color: #ce4844">Notice</p>
7272
* <p style="font-size: 13px">该功能依赖 <a href='https://iclient.supermap.io/web/libs/geostats/geostats.js'>geostats</a> 和 <a href='https://iclient.supermap.io/web/libs/jsonsql/jsonsql.js'>JsonSql</a> 插件，请确认引入该插件。</p>
73-
* `<script type="text/javascript" src="https://iclient.supermap.io/web/libs/geostats/geostats.js"></script>`</br>
74-
* `<script type="text/javascript" src="https://iclient.supermap.io/web/libs/jsonsql/jsonsql.js"></script>`
73+
* <p style="font-size: 13px">&lt;script type="text/javascript" src="https://iclient.supermap.io/web/libs/geostats/geostats.js"&gt;&lt;/script&gt;</p>
74+
* <p style="font-size: 13px">&lt;script type="text/javascript" src="https://iclient.supermap.io/web/libs/jsonsql/jsonsql.js"&gt;&lt;/script&gt;</p>
7575
* </div>
7676
* @param {number} id - iPortal|Online 地图 ID。
7777
* @param {Object} options - 参数。
@@ -80,7 +80,7 @@ const DEFAULT_WELLKNOWNSCALESET = ['GoogleCRS84Quad', 'GoogleMapsCompatible'];
8080
* @param {string} [options.credentialKey] - 凭证密钥。
8181
* @param {string} [options.credentialValue] - 凭证值。
8282
* @param {boolean} [options.withCredentials=false] - 请求是否携带 cookie。
83-
* @param {boolean} [options.excludePortalProxyUrl] - server 传递过来的 URL 是否带有代理。
83+
* @param {boolean} [options.excludePortalProxyUrl] - 服务端传递过来的 URL 是否带有代理。
8484
* @fires WebMap#getmapfailed
8585
* @fires WebMap#getwmtsfailed
8686
* @fires WebMap#getlayersfailed
@@ -103,8 +103,7 @@ export class WebMap extends mapboxgl.Evented {
103103
}
104104
/**
105105
* @function WebMap.prototype.resize
106-
* @description map resize。
107-
* @version 9.1.2
106+
* @description 地图 resize。
108107
*/
109108
resize() {
110109
this.map.resize();
@@ -114,7 +113,6 @@ export class WebMap extends mapboxgl.Evented {
114113
* @function WebMap.prototype.setMapId
115114
* @param {string} mapId - webMap 地图 ID。
116115
* @description 设置 WebMap ID。
117-
* @version 9.1.2
118116
*/
119117
setMapId(mapId) {
120118
this.mapId = mapId;
@@ -125,7 +123,6 @@ export class WebMap extends mapboxgl.Evented {
125123
* @function WebMap.prototype.setWebMapOptions
126124
* @param {Object} webMapOptions - webMap 参数。
127125
* @description 设置 webMap 参数。
128-
* @version 9.1.2
129126
*/
130127
setWebMapOptions(webMapOptions) {
131128
this.server = webMapOptions.server;
@@ -136,7 +133,6 @@ export class WebMap extends mapboxgl.Evented {
136133
* @function WebMap.prototype.setMapOptions
137134
* @param {Object} mapOptions - map 参数。
138135
* @description 设置 map 参数。
139-
* @version 9.1.2
140136
*/
141137
setMapOptions(mapOptions) {
142138
let { center, zoom, maxBounds, minZoom, maxZoom, isWorldCopy, bearing, pitch } = mapOptions;
@@ -1720,8 +1716,8 @@ export class WebMap extends mapboxgl.Evented {
17201716
* @description 添加图层成功。
17211717
* @property {mapboxgl.Map} map - MapBoxGL Map 对象。
17221718
* @property {Object} mapparams - 地图信息。
1723-
* @property {string} mapParams.title - 地图标题。
1724-
* @property {string} mapParams.description - 地图描述。
1719+
* @property {string} mapparams.title - 地图标题。
1720+
* @property {string} mapparams.description - 地图描述。
17251721
* @property {Array.<Object>} layers - 地图上所有的图层对象
17261722
*/
17271723
this.fire('addlayerssucceeded', { map: this.map, mapparams: this.mapParams, layers: this.layers });

0 commit comments

Comments
 (0)