Skip to content

Commit aea34b0

Browse files
committed
[fix]文档注释修改 src:leaflet review by jinny
1 parent 5cc928f commit aea34b0

23 files changed

+44
-45
lines changed

src/leaflet/core/Proj4Leaflet.js

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -114,7 +114,7 @@ L.Proj.Projection = L.Class.extend({
114114
* @param {Array.<number>} [options.scaleDenominators] - 比例尺分母数组。
115115
* @param {Array.<number>} [options.resolutions] - 分辨率数组。
116116
* @param {(Array.<number>|L.Bounds)} [options.bounds] - 范围。
117-
* @param {number} [options.dpi=96] - dpi
117+
* @param {number} [options.dpi=96] - DPI
118118
* @param {Array.<number>} [options.wrapLng] - 定义经度(水平)坐标轴是否在给定范围内环绕。大多数情况下默认为[-180,180]。
119119
* @example
120120
* var crs =new CRS("EPSG:4326",{

src/leaflet/core/Transform.js

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -8,8 +8,7 @@ import { Util as CommonUtil } from '@supermap/iclient-common/commontypes/Util';
88
* @function transform
99
* @description 转换要素坐标。
1010
* @category BaseTypes Util
11-
* @param {(L.Marker|L.CircleMarker|L.Polyline|L.Polygon|L.Rectangle|L.LatLngBounds|L.Bounds|Object)} feature - 待转换要素:Leaflet Vector Layers 。
12-
* 的 {@link L.Marker}|{@link L.CircleMarker}|{@link L.Polyline}|{@link L.Polygon}|{@link L.Rectangle}|{@link L.LatLngBounds}|{@link L.Bounds}|{@link GeoJSONObject} 类型。
11+
* @param {(L.Marker|L.CircleMarker|L.Polyline|L.Polygon|L.Rectangle|L.LatLngBounds|L.Bounds|Object)} feature - 待转换要素:Leaflet Vector Layers 的 {@link L.Marker}|{@link L.CircleMarker}|{@link L.Polyline}|{@link L.Polygon}|{@link L.Rectangle}|{@link L.LatLngBounds}|{@link L.Bounds}|{@link GeoJSONObject} 类型。
1312
* @param {CRS} [sourceCRS=L.CRS.EPSG4326] - 转换要素的源坐标系。
1413
* @param {CRS} targetCRS - 转换要素的目标坐标系。
1514
* @returns {GeoJSONObject} 返回 GeoJSON 规范的数据类型。

src/leaflet/core/Util.js

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -181,7 +181,7 @@ export var normalizeScale = function(scale) {
181181
/**
182182
* @function getResolutionFromScaleDpi
183183
* @category BaseTypes Util
184-
* @description 根据比例尺和 dpi 计算屏幕分辨率。
184+
* @description 根据比例尺和 DPI 计算屏幕分辨率。
185185
* @param {number} scale - 比例尺。
186186
* @param {number} dpi - 图像分辨率,表示每英寸内的像素个数。
187187
* @param {string} [coordUnit] - 投影坐标系统的地图单位。

src/leaflet/mapping/ImageMapLayer.js

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -24,7 +24,7 @@ import { toSuperMapGeometry } from '../core/Util';
2424
* @param {boolean} [options.cacheEnabled=true] - 是否启用缓存。
2525
* @param {boolean} [options.clipRegionEnabled=false] - 是否启用地图裁剪。
2626
* @param {L.Path} [options.clipRegion] - 地图显示裁剪的区域(区域为一个面对象)。当 clipRegionEnabled = true 时有效,即地图只显示该区域覆盖的部分。
27-
* @param {Object} [options.prjCoordSys] - 请求的地图的坐标参考系统。 如:prjCoordSys={"epsgCode":3857}。
27+
* @param {Object} [options.prjCoordSys] - 请求的地图的坐标参考系统。如:prjCoordSys={"epsgCode":3857}。
2828
* @param {boolean} [options.overlapDisplayed=false] - 地图对象在同一范围内,是否重叠显示。
2929
* @param {string} [options.overlapDisplayedOptions] - 避免地图对象压盖显示的过滤选项。
3030
* @param {number} [options.opacity=1] - 图层不透明度。
@@ -37,7 +37,7 @@ import { toSuperMapGeometry } from '../core/Util';
3737
* @param {string} [options.className] - 自定义 dom 元素的 className。
3838
* @param {number} [options.updateInterval=150] - 平移时图层延迟刷新间隔时间。
3939
* @param {string} [options.tileProxy] - 服务代理地址。
40-
* @param {string} [options.format='png'] - 瓦片表述类型,支持 "png" 、"webp"、"bmp" 、"jpg"、 "gif" 等图片格式。
40+
* @param {string} [options.format='png'] - 瓦片表述类型,支持 "png" 、"webp"、"bmp" 、"jpg"、"gif" 等图片格式。
4141
* @param {(NDVIParameter|HillshadeParameter)} [options.rasterfunction] - 栅格分析参数。
4242
* @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>'] - 版权信息。
4343
* @fires ImageMapLayer#load
@@ -59,7 +59,7 @@ export var ImageMapLayer = Layer.extend({
5959
clipRegionEnabled: false,
6060
//地图显示裁剪的区域
6161
clipRegion: null,
62-
//请求的地图的坐标参考系统。 如:prjCoordSys= {"epsgCode":3857}。
62+
//请求的地图的坐标参考系统。如:prjCoordSys= {"epsgCode":3857}。
6363
prjCoordSys: null,
6464
//地图对象在同一范围内,是否重叠显示
6565
overlapDisplayed: false,

src/leaflet/mapping/ImageTileLayer.js

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -19,9 +19,9 @@ import { SecurityManager } from '@supermap/iclient-common/security/SecurityManag
1919
* @param {string} url - 服务地址,例如: http://{ip}:{port}/iserver/{imageservice-imageserviceName}/restjsr/
2020
* @param {Object} options - 参数。
2121
* @param {string} options.collectionId - 影像集合(Collection)的ID,在一个影像服务中唯一标识影像集合。
22-
* @param {string} [options.sqlFilter] 对所显示影像的过滤条件。相当于sql查询中的where子句。支持st_geometry空间函数过滤。11.0版本暂不支持通过ECQL进行过滤。
22+
* @param {string} [options.sqlFilter] 对所显示影像的过滤条件。相当于SQL查询中的where子句。支持st_geometry空间函数过滤。11.0版本暂不支持通过ECQL进行过滤。
2323
* @param {ImageRenderingRule} [options.renderingRule] 指定影像显示的风格,包含拉伸显示方式、颜色表、波段组合以及应用栅格函数进行快速处理等。不指定时,使用发布服务时所配置的风格。
24-
* @param {Array.<number>} [options.ids] 返回影像集合中指定ID的影像,该id为系统维护的一个自增id,为SuperMap SDX引擎的SmID字段内容。
24+
* @param {Array.<number>} [options.ids] 返回影像集合中指定ID的影像,该ID为系统维护的一个自增ID,为SuperMap SDX引擎的SmID字段内容。
2525
* @param {Array.<string>} [options.names] 返回影像集合中指定名称影像的瓦片资源。影像名称包含文件后缀,如S-60-45.tif。
2626
* @param {string} [options.format='png'] - 瓦片表述类型,瓦片格式目前支持png、jpg和webp三种格式。
2727
* @param {boolean} [options.transparent=true] - 瓦片是否透明。默认透明。

src/leaflet/mapping/TiandituTileLayer.js

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -20,7 +20,7 @@ import Attributions from '../core/Attributions';
2020
* @param {string} [options.format='tiles'] - 格式。
2121
* @param {boolean} [options.isLabel=false] - 是否是标注图层。
2222
* @param {Array.<number>} [options.subdomains=[0, 1, 2, 3, 4, 5, 6, 7]] - 子域名数组。
23-
* @param {string} [options.attribution='Map Data <a href='https://www.tianditu.gov.cn' target='_blank'><img style='background-color:transparent;bottom:2px;opacity:1;' src='https://api.tianditu.gov.cn/img/map/logo.png' width='53px' height='22px' opacity='0'></a>'] - 版权信息
23+
* @param {string} [options.attribution='Map Data <a href='https://www.tianditu.gov.cn' target='_blank'><img style='background-color:transparent;bottom:2px;opacity:1;' src='https://api.tianditu.gov.cn/img/map/logo.png' width='53px' height='22px' opacity='0'></a>'] - 版权信息
2424
* @param {string} [options.noWrap=true] - 图层是否 X 方向平铺。
2525
* @usage
2626
*/

src/leaflet/mapping/TiledMapLayer.js

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -27,13 +27,13 @@
2727
* @param {boolean} [options.cacheEnabled=true] - 启用缓存。
2828
* @param {boolean} [options.clipRegionEnabled=false] - 是否启用地图裁剪。
2929
* @param {L.Path} [options.clipRegion] - 地图显示裁剪的区域。是一个面对象,当 clipRegionEnabled = true 时有效,即地图只显示该区域覆盖的部分。
30-
* @param {Object} [options.prjCoordSys] - 请求的地图的坐标参考系统。 如:prjCoordSys={"epsgCode":3857}。
30+
* @param {Object} [options.prjCoordSys] - 请求的地图的坐标参考系统。如:prjCoordSys={"epsgCode":3857}。
3131
* @param {boolean} [options.overlapDisplayed=false] - 地图对象在同一范围内时,是否重叠显示。
3232
* @param {string} [options.overlapDisplayedOptions] - 避免地图对象压盖显示的过滤选项。
3333
* @param {string} [options.tileversion] - 切片版本名称,cacheEnabled 为 true 时有效。如果没有设置 tileversion 参数,而且当前地图的切片集中存在多个版本,则默认使用最后一个更新版本。
3434
* @param {CRS} [options.crs] - 坐标系统类。
3535
* @param {string} [options.tileProxy] - 服务代理地址。
36-
* @param {string} [options.format='png'] - 瓦片表述类型,支持 "png" 、"webp"、"bmp" 、"jpg"、 "gif" 等图片格式。
36+
* @param {string} [options.format='png'] - 瓦片表述类型,支持 "png"、"webp"、"bmp"、"jpg"、"gif" 等图片格式。
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>'] - 版权信息。
@@ -54,7 +54,7 @@ export var TiledMapLayer = L.TileLayer.extend({
5454
clipRegionEnabled: false,
5555
//地图显示裁剪的区域
5656
clipRegion: null,
57-
//请求的地图的坐标参考系统。 如:prjCoordSys={"epsgCode":3857}
57+
//请求的地图的坐标参考系统。如:prjCoordSys={"epsgCode":3857}
5858
prjCoordSys: null,
5959
//地图对象在同一范围内时,是否重叠显示
6060
overlapDisplayed: false,

src/leaflet/mapping/initMap.js

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -20,7 +20,7 @@ import proj4 from 'proj4';
2020
* @param {Object} [options] - 参数。
2121
* @param {L.MapOptions} [options.mapOptions] - 地图参数,未设置的情况下,默认使用 SuperMap iServer 服务参数进行设置。
2222
* @param {Object} [options.layerOptions] - 图层参数,参考<a href="TiledMapLayer.html">TiledMapLayer</a>的参数。
23-
* @returns {Promise} Promise 对象, 返回{ map, layer }。
23+
* @returns {Promise} Promise 对象,返回{ map, layer }。
2424
* @usage
2525
* ```
2626
* // 浏览器
@@ -69,7 +69,7 @@ export function initMap(url, options) {
6969
* @param {Object} mapJSONObj - 地图参数。
7070
* @param {Object} mapJSONObj.prjCoordSys - 投影配置。
7171
* @param {Object} mapJSONObj.bounds - 范围。
72-
* @param {number} mapJSONObj.dpi - dpi
72+
* @param {number} mapJSONObj.dpi - DPI
7373
* @param {Array} mapJSONObj.visibleScales - 自定义比例尺。
7474
* @param {Array} mapJSONObj.coordUnit - 地图单位。
7575
* @param {Object} [mapOptions] - 地图参数。

src/leaflet/overlay/DataFlowLayer.js

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -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) {

src/leaflet/overlay/GraphThemeLayer.js

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -101,7 +101,7 @@ export var GraphThemeLayer = ThemeLayer.extend({
101101

102102
/**
103103
* @function GraphThemeLayer.prototype.redrawThematicFeatures
104-
* @description 重绘所有专题要素 此方法包含绘制专题要素的所有步骤,包含用户数据到专题要素的转换,压盖处理,缓存等步骤。地图漫游时调用此方法进行图层刷新。
104+
* @description 重绘所有专题要素此方法包含绘制专题要素的所有步骤,包含用户数据到专题要素的转换,压盖处理,缓存等步骤。地图漫游时调用此方法进行图层刷新。
105105
* @param {L.Bounds} bounds - 重绘的范围。
106106
*/
107107
redrawThematicFeatures: function (bounds) {
@@ -344,7 +344,7 @@ export var GraphThemeLayer = ThemeLayer.extend({
344344

345345
/**
346346
* @function GraphThemeLayer.prototype.clear
347-
* @description 清除图层。清除的内容包括数据(features) 、专题要素、缓存。
347+
* @description 清除图层。清除的内容包括数据(features)、专题要素、缓存。
348348
*/
349349
clear: function () {
350350
var me = this;

0 commit comments

Comments
 (0)