Skip to content

Commit fd2faaa

Browse files
Wenxinyu1998Wenxinyu1998
committed
[fix]文档注释修改 src：openlayers review by jinny
1 parent 17b433e commit fd2faaa

23 files changed

+52
-52
lines changed

‎src/openlayers/control/ChangeTileVersion.js

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -189,7 +189,7 @@ export class ChangeTileVersion extends Control {
189189
* @param {string} tagName - 标签名。
190190
* @param {string} className - 类名。
191191
* @param {Object} container - 容器。
192-
* @returns {object|HTMLElement} 元素
192+
* @returns {object|HTMLElement} 元素。
193193
*/
194194
function createElement(tagName, className, container) {
195195
var el = document.createElement(tagName);
@@ -208,7 +208,7 @@ export class ChangeTileVersion extends Control {
208208
* @param {string} type - 事件类型。
209209
* @param {Object} fn -容器。
210210
* @param {Object} context -当前环境。
211-
* @returns {function} 添加的事件
211+
* @returns {function} 添加的事件。
212212
*/
213213
function addDomEvent(obj, type, fn, context) {
214214
var handler = function(e) {

‎src/openlayers/mapping/ImageSuperMapRest.js

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -24,7 +24,7 @@ import { containsExtent, getCenter, getHeight, getWidth, getForViewAndSize } fro
2424
* @param {boolean} [options.transparent=true] - 瓦片是否透明。
2525
* @param {boolean} [options.antialias=false] - 是否反走样地图。
2626
* @param {boolean} [options.cacheEnabled=true] - 是否使用服务端的缓存，true 表示使用服务端的缓存。
27-
* @param {Object} [options.prjCoordSys] - 请求的地图的坐标参考系统。当此参数设置的坐标系统不同于地图的原有坐标系统时， 系统会进行动态投影，并返回动态投影后的地图瓦片。例如：{"epsgCode":3857}。
27+
* @param {Object} [options.prjCoordSys] - 请求的地图的坐标参考系统。当此参数设置的坐标系统不同于地图的原有坐标系统时，系统会进行动态投影，并返回动态投影后的地图瓦片。例如：{"epsgCode":3857}。
2828
* @param {string} [options.layersID] - 获取进行切片的地图图层 ID，即指定进行地图切片的图层，可以是临时图层集，也可以是当前地图中图层的组合。
2929
* @param {boolean} [options.clipRegionEnabled = false] - 是否地图只显示该区域覆盖的部分。true 表示地图只显示该区域覆盖的部分。
3030
* @param {ol.geom.Geometry} [options.clipRegion] - 地图显示裁剪的区域。是一个面对象，当 clipRegionEnabled = true 时有效，即地图只显示该区域覆盖的部分。
@@ -35,14 +35,14 @@ import { containsExtent, getCenter, getHeight, getWidth, getForViewAndSize } fro
3535
* @param {boolean} [options.textOrientationFixed=false] - 文本朝向是否固定。
3636
* @param {boolean} [options.paintBackground=false] - 是否绘制地图背景。
3737
* @param {boolean} [options.maxVisibleTextSize] - 文本的最大可见尺寸，单位为像素。
38-
* @param {boolean} [options.maxVisibleVertex] - 最大几何对象可见节点数。 如果几何对象的节点数超过指定的个数，则超过的那部分节点不显示。
38+
* @param {boolean} [options.maxVisibleVertex] - 最大几何对象可见节点数。如果几何对象的节点数超过指定的个数，则超过的那部分节点不显示。
3939
* @param {boolean} [options.minVisibleTextSize] - 文本的最小可见尺寸，单位为像素。
4040
* @param {string} [options.tileversion] - 切片版本名称，_cache 为 true 时有效。
4141
* @param {string} [options.tileProxy] - 代理地址。
4242
* @param {NDVIParameter|HillshadeParameter} [options.rasterfunction] - 栅格分析参数。
43-
* @param {string} [options.format = 'png'] - 瓦片表述类型，支持 "png" 、"webp"、"bmp" 、"jpg"、 "gif" 等图片类型。
43+
* @param {string} [options.format = 'png'] - 瓦片表述类型，支持 "png" 、"webp"、"bmp" 、"jpg"、"gif" 等图片类型。
4444
* @param {Function} [options.imageLoadFunction] - 加载图片的方法。默认为function(imageTile, src) {imageTile.getImage().src = src;};
45-
* @param {string} [options.ratio=1.5] - 请求图片大小比例. 1 表示请求图片大小和地图视窗范围一致, 2 表示请求图片大小是地图视窗范围的2倍，以此类推。
45+
* @param {string} [options.ratio=1.5] - 请求图片大小比例。 1 表示请求图片大小和地图视窗范围一致，2 表示请求图片大小是地图视窗范围的2倍，以此类推。
4646
* @extends {ol.source.Image}
4747
* @usage
4848
*/

‎src/openlayers/mapping/ImageTileSuperMapRest.js

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -15,14 +15,14 @@ import { Util as CommonUtil } from '@supermap/iclient-common/commontypes/Util';
1515
* @param {Object} options - 参数。
1616
* @param {string} options.url - 服务地址。例如: http://{ip}:{port}/iserver/{imageservice-imageserviceName}/restjsr/
1717
* @param {string} options.collectionId - 影像集合（Collection）的ID，在一个影像服务中唯一标识影像集合。
18-
* @param {string} [options.sqlFilter] 显示影像的过滤条件。相当于sql查询中的where子句。支持st_geometry空间函数过滤。11.0版本暂不支持通过ECQL进行过滤。
18+
* @param {string} [options.sqlFilter] 显示影像的过滤条件。相当于SQL查询中的where子句。支持st_geometry空间函数过滤。11.0版本暂不支持通过ECQL进行过滤。
1919
* @param {ImageRenderingRule} [options.renderingRule] 指定影像显示的风格，包含拉伸显示方式、颜色表、波段组合以及应用栅格函数进行快速处理等。不指定时，使用发布服务时所配置的风格。
20-
* @param {Array.<number>} [options.ids] 返回影像集合中指定ID的影像，该id为系统维护的一个自增id，为SuperMap SDX引擎的SmID字段内容。
20+
* @param {Array.<number>} [options.ids] 返回影像集合中指定ID的影像，该ID为系统维护的一个自增ID，为SuperMap SDX引擎的SmID字段内容。
2121
* @param {Array.<string>} [options.names] 返回影像集合中指定名称影像的瓦片资源。影像名称包含文件后缀，如S-60-45.tif。
2222
* @param {string} [options.format='png'] - 瓦片表述类型，瓦片格式目前支持png、jpg和webp三种格式。
2323
* @param {boolean} [options.transparent=true] - 瓦片是否透明。默认透明。
2424
* @param {boolean} [options.cacheEnabled=true] - 启用缓存。
25-
* @param {string} [options.tileProxy] - 代理地址
25+
* @param {string} [options.tileProxy] - 代理地址。
2626
* @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>'] - 版权信息。
2727
* @extends {ol.source.XYZ}
2828
* @usage

‎src/openlayers/mapping/Tianditu.js

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -96,7 +96,7 @@ export class Tianditu extends WMTS {
9696
* @function Tianditu.getTileGrid
9797
* @description 获取瓦片网格。
9898
* @param {string} projection - 投影参考对象。
99-
* @returns {ol.tilegrid.WMTS} 返回瓦片网格对象
99+
* @returns {ol.tilegrid.WMTS} 返回瓦片网格对象。
100100
*/
101101
static getTileGrid(projection) {
102102
if (projection === "EPSG:4326" || projection === "EPSG:4490") {

‎src/openlayers/mapping/TileSuperMapRest.js

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -24,15 +24,15 @@ import TileGrid from 'ol/tilegrid/TileGrid';
2424
* @param {boolean} [options.redirect = false] - 是否重定向。
2525
* @param {boolean} [options.transparent = true] - 瓦片是否透明。
2626
* @param {boolean} [options.cacheEnabled = true] - 是否使用服务端的缓存。
27-
* @param {Object} [options.prjCoordSys] - 请求的地图的坐标参考系统。当此参数设置的坐标系统不同于地图的原有坐标系统时， 系统会进行动态投影，并返回动态投影后的地图瓦片。例如：{"epsgCode":3857}。
27+
* @param {Object} [options.prjCoordSys] - 请求的地图的坐标参考系统。当此参数设置的坐标系统不同于地图的原有坐标系统时，系统会进行动态投影，并返回动态投影后的地图瓦片。例如：{"epsgCode":3857}。
2828
* @param {string} [options.layersID] - 获取进行切片的地图图层 ID，即指定进行地图切片的图层，可以是临时图层集，也可以是当前地图中图层的组合。
2929
* @param {boolean} [options.clipRegionEnabled = false] - 是否只地图只显示该区域覆盖的部分。true 表示地图只显示该区域覆盖的部分。
3030
* @param {ol.geom.Geometry} [options.clipRegion] - 地图显示裁剪的区域。是一个面对象，当 clipRegionEnabled = true 时有效，即地图只显示该区域覆盖的部分。
3131
* @param {boolean} [options.overlapDisplayed = false] - 地图对象在同一范围内时，是否重叠显示。如果为 true，则同一范围内的对象会直接压盖；如果为 false 则通过 overlapDisplayedOptions 控制对象不压盖显示。
3232
* @param {OverlapDisplayedOptions} [options.overlapDisplayedOptions] - 避免地图对象压盖显示的过滤选项，当 overlapDisplayed 为 false 时有效，用来增强对地图对象压盖时的处理。
3333
* @param {string} [options.tileversion] - 切片版本名称，_cache 为 true 时有效。
3434
* @param {string} [options.tileProxy] - 服务代理地址。
35-
* @param {string} [options.format = 'png'] - 瓦片表述类型，支持 "png" 、"webp"、"bmp" 、"jpg"、 "gif" 等图片类型。
35+
* @param {string} [options.format = 'png'] - 瓦片表述类型，支持 "png" 、"webp"、"bmp" 、"jpg"、"gif" 等图片类型。
3636
* @param {(NDVIParameter|HillshadeParameter)} [options.rasterfunction] - 栅格分析参数。
3737
* @extends {ol.source.TileImage}
3838
* @usage

‎src/openlayers/overlay/DataFlow.js

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -15,7 +15,7 @@ import GeoJSON from 'ol/format/GeoJSON';
1515
* @param {string} [opt_options.idField = 'id'] - 要素属性中表示唯一标识的字段。
1616
* @param {GeoJSONObject} [opt_options.geometry] - 指定几何范围，该范围内的要素才能被订阅。
1717
* @param {Object} [opt_options.prjCoordSys] - 请求的地图的坐标参考系统。当此参数设置的坐标系统不同于地图的原有坐标系统时，系统会进行动态投影，并返回动态投影后的地图瓦片。例如：{"epsgCode":3857}。
18-
* @param {Object} [opt_options.excludeField] - 排除字段
18+
* @param {Object} [opt_options.excludeField] - 排除字段。
1919
* @extends {ol.source.Vector}
2020
* @example
2121
* var source = new DataFlow({

‎src/openlayers/overlay/Graph.js

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -342,7 +342,7 @@ export class Graph extends Theme {
342342

343343
/**
344344
* @function Graph.prototype.isPointInPoly
345-
* @description 判断一个点是否在多边形里面。（射线法）。
345+
* @description 判断一个点是否在多边形里面（射线法）。
346346
* @param {Object} pt - 需要判定的点对象，该对象含有属性 x（横坐标），属性 y（纵坐标）。
347347
* @param {Array.<Object>} poly - 多边形节点数组。
348348
*/
@@ -396,7 +396,7 @@ export class Graph extends Theme {
396396

397397
/**
398398
* @function Graph.prototype.removeAllFeatures
399-
* @description 移除所有的要素
399+
* @description 移除所有的要素。
400400
*/
401401
removeAllFeatures() {
402402
this.clearCache();
@@ -405,7 +405,7 @@ export class Graph extends Theme {
405405

406406
/**
407407
* @function Graph.prototype.redraw
408-
* @description 重绘该图层
408+
* @description 重绘该图层。
409409
*/
410410
redraw() {
411411
this.clearCache();
@@ -418,7 +418,7 @@ export class Graph extends Theme {
418418

419419
/**
420420
* @function Graph.prototype.clear
421-
* @description 清除的内容包括数据（features） 、专题要素、缓存。
421+
* @description 清除的内容包括数据（features）、专题要素、缓存。
422422
*/
423423
clear() {
424424
if (this.renderer) {

‎src/openlayers/overlay/Graphic.js

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -44,7 +44,7 @@ const Renderer = ['canvas', 'webgl'];
4444
* @param {ol.style.Style} [options.highLightStyle=defaultHighLightStyle] - 高亮风格。
4545
* @param {Array.<number>} [options.color=[0, 0, 0, 255]] - 要素颜色。当 {@link OverlayGraphic} 的 style 参数传入设置了 fill 的 {@link HitCloverShape} 或 {@link CloverShape}，此参数无效。
4646
* @param {Array.<number>} [options.highlightColor] - webgl 渲染时要素高亮颜色。
47-
* @param {number} [options.opacity=0.8] - 要素透明度,。当 {@link OverlayGraphic} 的 style 参数传入设置了 fillOpacity 或 strokeOpacity 的 {@link HitCloverShape} 或 {@link CloverShape}，此参数无效。
47+
* @param {number} [options.opacity=0.8] - 要素透明度。当 {@link OverlayGraphic} 的 style 参数传入设置了 fillOpacity 或 strokeOpacity 的 {@link HitCloverShape} 或 {@link CloverShape}，此参数无效。
4848
* @param {number} [options.radius=10] - 要素半径，单位像素。当 {@link OverlayGraphic} 的 style 参数传入设置了 radius 的 {@link HitCloverShape} 或 {@link CloverShape}，此参数无效。
4949
* @param {number} [options.radiusScale=1] - webgl 渲染时的要素放大倍数。
5050
* @param {number} [options.radiusMinPixels=0] - webgl 渲染时的要素半径最小值（像素）。
@@ -308,8 +308,8 @@ export class Graphic extends ImageCanvasSource {
308308

309309
/**
310310
* @function Graphic.prototype.getGraphicById
311-
* @description 通过给定一个 id，返回对应的矢量要素。
312-
* @param {string} graphicId - 矢量要素的属性 id
311+
* @description 通过给定一个 ID，返回对应的矢量要素。
312+
* @param {string} graphicId - 矢量要素的属性 ID。
313313
* @returns {OverlayGraphic} 一个匹配的 graphic。
314314
*/
315315
getGraphicById(graphicId) {

‎src/openlayers/overlay/HeatMap.js

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -18,7 +18,7 @@ import Point from 'ol/geom/Point';
1818
* @browsernamespace ol.source
1919
* @classdesc 热力图层类。
2020
* @category Visualization HeatMap
21-
* @param {string} name - 图层名称
21+
* @param {string} name - 图层名称。
2222
* @param {Object} options - 参数。
2323
* @param {ol.Map} options.map - openlayers 的 map 对象。
2424
* @param {string} [options.id] - 专题图层 ID，默认使用 CommonUtil.createUniqueID("HeatMapSource_") 创建专题图层 ID。
@@ -357,7 +357,7 @@ export class HeatMap extends ImageCanvasSource {
357357
* @param {Object} pixelP - 像素点。
358358
* @param {Object} center - 中心点。
359359
* @param {number} scaleRatio - 缩放倍数。
360-
* @returns {Array.<number>} 返回数组形比例
360+
* @returns {Array.<number>} 返回数组型比例。
361361
*/
362362
scale(pixelP, center, scaleRatio) {
363363
var x = (pixelP[0] - center[0]) * scaleRatio + center[0];
@@ -411,7 +411,7 @@ export class HeatMap extends ImageCanvasSource {
411411
* @function HeatMap.prototype.toiClientFeature
412412
* @description 转为 iClient 要素。
413413
* @param {GeoJSONObject|Array.<ol.Feature>} features - 待添加的要素数组。
414-
* @returns {FeatureVector} 转换后的 iClient 要素
414+
* @returns {FeatureVector} 转换后的 iClient 要素。
415415
*/
416416
toiClientFeature(features) {
417417
if (!Util.isArray(features)) {

‎src/openlayers/overlay/Mapv.js

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -20,7 +20,7 @@ import ImageCanvasSource from 'ol/source/ImageCanvas';
2020
* @param {Object} opt_options.mapvOptions - MapV 的配置对象。
2121
* @param {string} [opt_options.logo] - Logo（openLayers 5.0.0 及更高版本不再支持此参数）。
2222
* @param {ol.proj.Projection} [opt_options.projection] - 投影信息。
23-
* @param {number} [opt_options.ratio=1.5] - 视图比，1 表示画布是地图视口的大小，2 表示地图视口的宽度和高度的两倍，依此类推。 必须是 1 或更高。
23+
* @param {number} [opt_options.ratio=1.5] - 视图比，1 表示画布是地图视口的大小，2 表示地图视口的宽度和高度的两倍，依此类推。必须是 1 或更高。
2424
* @param {Array} [opt_options.resolutions] - 分辨率数组。
2525
* @param {ol.source.State} [opt_options.state] - 资源状态。
2626
* @param {(string|Object)} [opt_options.attributions='© 2018 百度 MapV with <span>© <a href='https://iclient.supermap.io' target='_blank'>SuperMap iClient</a></span>'] - 版权信息。

0 commit comments

Comments
 (0)
pFad - Phonifier reborn

Pfad - The Proxy pFad of © 2024 Garber Painting. All rights reserved.

Note: This service is not intended for secure transactions such as banking, social media, email, or purchasing. Use at your own risk. We assume no liability whatsoever for broken pages.


Alternative Proxies:

Alternative Proxy

pFad Proxy

pFad v3 Proxy

pFad v4 Proxy