Skip to content

Commit 17b433e

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

22 files changed

+83
-83
lines changed

‎src/mapboxgl/core/MapExtend.js

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -123,7 +123,7 @@ export var MapExtend = function () {
123123
* @function MapExtend.prototype.moveTo
124124
* @description 将图层移动到某个图层之前。
125125
* @param {string} layerID -待插入的图层 ID。
126-
* @param {boolean} [beforeLayerID] - 是否将本图层插入到图层 id 为 layerID 的图层之前(如果为 false 则将本图层插入到图层 id 为 layerID 的图层之后)。
126+
* @param {boolean} [beforeLayerID] - 是否将本图层插入到图层 ID 为 layerID 的图层之前(如果为 false 则将本图层插入到图层 ID 为 layerID 的图层之后)。
127127
*/
128128
function moveLayer(layerID, beforeLayerID) {
129129
var layer = document.getElementById(layerID);

‎src/mapboxgl/overlay/DeckglLayer.js

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -12,18 +12,18 @@ import { Util } from '../core/Util';
1212
* @classdesc Deckgl 高效率图层，该图图层为综合图层，通过该图层可创建 高效率点图层、路径图层（线图层）、高效率面图层、曲线图层、
1313
* 正六边形图层（蜂巢图层）、网格图层，只需给定相依配置，因此，在创建图层之前，请仔细阅读参数配置。
1414
* @param {string} layerTypeID - 高效率图层类型 ID，包括 "scatter-plot" 高效率点图层、"path-layer" 路径图层（线图层）、
15-
* "polygon-layer" 高效率面图层、 "arc-layer" 曲线图层、"hexagon-layer" 正六边形图层（蜂巢图层）、"screen-grid-layer" 网格图层。
15+
* "polygon-layer" 高效率面图层、"arc-layer" 曲线图层、"hexagon-layer" 正六边形图层（蜂巢图层）、"screen-grid-layer" 网格图层。
1616
*
1717
* @param {Object} options - 图层配置项，包括以下参数：
1818
* @param {Object} [options.layerId] - DeckglLayer 图层 Dom 元素 ID。默认使用 CommonUtil.createUniqueID("graphicLayer_" + this.layerTypeID + "_") 创建专题图层 ID。
1919
* @param {Array.<GeoJSONObject>} options.data - 图层数据,支持 GeoJSON 规范数据类型。
2020
* @param {Object} options.callback - deckgl 图层回调函数配置项。
2121
* @param {Object} options.props - deckgl 图层配置项, 在该参数下配置图层配置项：
22-
* @param {boolean} options.props.coverage - "hexagon-layer" 配置项：六边形半径乘数，介于0 - 1之间。六边形的最终半径通过覆盖半径计算。 注意：覆盖范围不会影响分数的分配方式。 分配方式的半径仅由半径属性确定；
22+
* @param {boolean} options.props.coverage - "hexagon-layer" 配置项：六边形半径乘数，介于0 - 1之间。六边形的最终半径通过覆盖半径计算。注意：覆盖范围不会影响分数的分配方式。分配方式的半径仅由半径属性确定；
2323
* @param {boolean} options.props.hexagonAggregator - "hexagon-layer" 配置项：* @param {boolean}
2424
* @param {Object} options.props.lightSettings - 光照配置项。
25-
* @param {Array} options.props.lightSettings.lightsPosition - 光照配置项：指定为`[x，y，z]`的光在平面阵列中的位置`, 在一个平面阵列。 长度应该是 `3 x numberOfLights`。
26-
* @param {Array} options.props.lightSettings.lightsStrength - 光照配置项：平面阵列中指定为“[x，y]`的灯的强度。 长度应该是`2 x numberOfLights`。
25+
* @param {Array} options.props.lightSettings.lightsPosition - 光照配置项：指定为`[x，y，z]`的光在平面阵列中的位置`, 在一个平面阵列。长度应该是 `3 x numberOfLights`。
26+
* @param {Array} options.props.lightSettings.lightsStrength - 光照配置项：平面阵列中指定为“[x，y]`的灯的强度。长度应该是`2 x numberOfLights`。
2727
* @param {number} [options.props.lightSettings.numberOfLights=1] - 光照配置项：光照值,最大值为 `5`。
2828
* @param {number} [options.props.lightSettings.coordinateSystem=COORDINATE_SYSTEM.LNGLAT] - 光照配置项：指定灯位置的坐标系。
2929
* @param {number} [options.props.lightSettings.coordinateOrigin=[0, 0, 0]] - 光照配置项：指定灯位置的坐标原点。
@@ -66,7 +66,7 @@ import { Util } from '../core/Util';
6666
* @param {boolean} [options.props.strokeWidth=1] - "arc-layer" 配置项：线宽。
6767
* @param {boolean} [options.props.radius=1000] - "hexagon-layer" 配置项：六边形半径值。
6868
* @param {boolean} [options.props.extruded=false] - "hexagon-layer" 配置项：是否拉伸要素。
69-
* @param {boolean} [options.props.upperPercentile=100] - "hexagon-layer" 配置项：筛选箱并通过upperPercentile重新计算颜色。 颜色值大于upperPercentile的六边形将被隐藏。
69+
* @param {boolean} [options.props.upperPercentile=100] - "hexagon-layer" 配置项：筛选箱并通过upperPercentile重新计算颜色。颜色值大于upperPercentile的六边形将被隐藏。
7070
* @param {boolean} [options.props.elevationScale=1] - "hexagon-layer" 配置项：高程乘数，实际海拔高度由 elevationScale * getElevation（d）计算。 elevationScale是一个方便的属性，可以在不更新数据的情况下缩放所有六边形。
7171
* @param {boolean} [options.props.colorDomain=false] - "hexagon-layer" 配置项：色阶。
7272
* @param {boolean} [options.props.colorRange=[[255,255,178,255],[254,217,118,255],[254,178,76,255],[253,141,60,255],[240,59,32,255],[189,0,38,255]]] - "hexagon-layer" 配置项：色带。
@@ -77,7 +77,7 @@ export class DeckglLayer {
7777
// Util.extend(defaultProps, options);
7878
/**
7979
* @member {string} DeckglLayer.prototype.id
80-
* @description 高效率点图层 id。
80+
* @description 高效率点图层 ID。
8181
*/
8282
this.layerTypeID = layerTypeID;
8383
/**
@@ -165,7 +165,7 @@ export class DeckglLayer {
165165
* @function DeckglLayer.prototype.moveTo
166166
* @description 将图层移动到某个图层之前。
167167
* @param {string} layerID - 待插入的图层 ID。
168-
* @param {boolean} [before=true] - 是否将本图层插入到图层 id 为 layerID 的图层之前。
168+
* @param {boolean} [before=true] - 是否将本图层插入到图层 ID 为 layerID 的图层之前。
169169
*/
170170
moveTo(layerID, before) {
171171
var layer = document.getElementById(this.id);

‎src/mapboxgl/overlay/GraphThemeLayer.js

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -320,7 +320,7 @@ export class Graph extends Theme {
320320

321321
/**
322322
* @function GraphThemeLayer.prototype.isPointInPoly
323-
* @description 判断一个点是否在多边形里面。(射线法)
323+
* @description 判断一个点是否在多边形里面（射线法）。
324324
* @param {Object} pt - 需要判定的点对象，该对象含有属性 x (横坐标)，属性 y (纵坐标)。
325325
* @param {Array.<Object>} poly - 多边形节点数组。
326326
*/
@@ -355,7 +355,7 @@ export class Graph extends Theme {
355355

356356
/**
357357
* @function GraphThemeLayer.prototype.clearCache
358-
* @description 清除缓存
358+
* @description 清除缓存。
359359
*/
360360
clearCache() {
361361
this.cache = {};

‎src/mapboxgl/overlay/GraphicLayer.js

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -43,7 +43,7 @@ export class GraphicLayer {
4343
let opt = Util.extend(this, defaultProps, options);
4444
/**
4545
* @member {string} GraphicLayer.prototype.id
46-
* @description 高效率点图层 id。
46+
* @description 高效率点图层 ID。
4747
*/
4848
this.id = id || CommonUtil.createUniqueID("graphicLayer_");
4949
/**
@@ -248,8 +248,8 @@ export class GraphicLayer {
248248

249249
/**
250250
* @function GraphicLayer.prototype.getGraphicById
251-
* @description 通过给定一个 id，返回对应的矢量要素。
252-
* @param {string} graphicId - 矢量要素的属性 id
251+
* @description 通过给定一个 ID，返回对应的矢量要素。
252+
* @param {string} graphicId - 矢量要素的属性 ID。
253253
* @returns {Graphic} 一个匹配的 graphic。
254254
*/
255255
getGraphicById(graphicId) {
@@ -365,7 +365,7 @@ export class GraphicLayer {
365365
* @function GraphicLayer.prototype.moveTo
366366
* @description 将图层移动到某个图层之前。
367367
* @param {string} layerID - 待插入的图层 ID。
368-
* @param {boolean} [before=true] - 是否将本图层插入到图层 id 为 layerID 的图层之前。
368+
* @param {boolean} [before=true] - 是否将本图层插入到图层 ID 为 layerID 的图层之前。
369369
*/
370370
moveTo(layerID, before) {
371371
var layer = document.getElementById(this.id);

‎src/mapboxgl/overlay/GraticuleLayer.js

Lines changed: 14 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -35,22 +35,22 @@ import mapboxgl from 'mapbox-gl';
3535
*/
3636

3737
/**
38-
* @typedef {Object} GraticuleLayer.LabelStyle - 标签样式
39-
* @property {Array.<string>} [textFont = ['Calibri','sans-serif']] - 字体样式
40-
* @property {string} [textSize = '12px'] - 字体大小
41-
* @property {string} [textColor ='rgba(0,0,0,1)'] - 字体颜色
42-
* @property {string} [textHaloColor ='rgba(255,255,255,1)'] - 描边颜色
43-
* @property {number} [textHaloWidth = 1] - 描边宽度
44-
* @property {string} [textAnchor = 'bottom'] - 字体基线: "center", "left", "right", "top", "bottom", "top-left", "top-right", "bottom-left", "bottom-right"
38+
* @typedef {Object} GraticuleLayer.LabelStyle - 标签样式。
39+
* @property {Array.<string>} [textFont = ['Calibri','sans-serif']] - 字体样式。
40+
* @property {string} [textSize = '12px'] - 字体大小。
41+
* @property {string} [textColor ='rgba(0,0,0,1)'] - 字体颜色。
42+
* @property {string} [textHaloColor ='rgba(255,255,255,1)'] - 描边颜色。
43+
* @property {number} [textHaloWidth = 1] - 描边宽度。
44+
* @property {string} [textAnchor = 'bottom'] - 字体基线: "center", "left", "right", "top", "bottom", "top-left", "top-right", "bottom-left", "bottom-right"。
4545
*/
4646

4747
/**
48-
* @typedef {Object} GraticuleLayer.StrokeStyle - 线样式
49-
* @property {string} [lineColor = 'red'] - 线颜色
50-
* @property {string} [lineCap = 'round'] - 线端点风格：butt, round, square
51-
* @property {string} [lineJoin = round] - 线连接样式：bevel, round, miter
52-
* @property {Array.<number>} [lindDasharray = [0.5,4]] - 虚线样式
53-
* @property {number} [lineWidth = 1] - 线宽
48+
* @typedef {Object} GraticuleLayer.StrokeStyle - 线样式。
49+
* @property {string} [lineColor = 'red'] - 线颜色。
50+
* @property {string} [lineCap = 'round'] - 线端点风格：butt, round, square。
51+
* @property {string} [lineJoin = round] - 线连接样式：bevel, round, miter。
52+
* @property {Array.<number>} [lindDasharray = [0.5,4]] - 虚线样式。
53+
* @property {number} [lineWidth = 1] - 线宽。
5454
*/
5555

5656
const defaultTextStyle = {
@@ -217,7 +217,7 @@ export class GraticuleLayer {
217217

218218
/**
219219
* @function GraticuleLayer.prototype.setIntervals
220-
* @description 设置经纬度的间隔（以度为单位)
220+
* @description 设置经纬度的间隔（以度为单位）。
221221
* @param {number|function} interval - 经纬度的间隔（以度为单位），可以是数字，也可以是函数，参数是map。
222222
*/
223223
setIntervals(interval) {

‎src/mapboxgl/overlay/HeatMapLayer.js

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -23,7 +23,7 @@ import { GeoText } from '@supermap/iclient-common/commontypes/geometry/GeoText';
2323
* @param {boolean} [options.loadWhileAnimating=true] - 是否实时重绘。(当绘制大数据量要素的情况下会出现卡顿，建议把该参数设为false)。
2424
* @param {number} [options.opacity=1] - 图层不透明度。
2525
* @param {Array.<string>} [options.colors=['blue','cyan','lime','yellow','red']] - 颜色线性渐变数组,颜色值必须为canvas所支。
26-
* @param {boolean} [options.useGeoUnit=false] - 使用地理单位，即默认热点半径默认使用像素单位。 当设置为 true 时，热点半径和图层地理坐标保持一致。
26+
* @param {boolean} [options.useGeoUnit=false] - 使用地理单位，即默认热点半径默认使用像素单位。当设置为 true 时，热点半径和图层地理坐标保持一致。
2727
* @extends {mapboxgl.Evented}
2828
* @fires HeatMapLayer#featuresadded
2929
* @fires HeatMapLayer#changelayer
@@ -44,7 +44,7 @@ export class HeatMapLayer extends mapboxgl.Evented {
4444

4545
/**
4646
* @member {string} HeatMapLayer.prototype.id
47-
* @description 热力图图层 id。
47+
* @description 热力图图层 ID。
4848
*/
4949
this.id = _options.id ? _options.id : CommonUtil.createUniqueID("HeatMapLayer_");
5050

@@ -79,7 +79,7 @@ export class HeatMapLayer extends mapboxgl.Evented {
7979

8080
/**
8181
* @member {boolean} [HeatMapLayer.prototype.useGeoUnit=false]
82-
* @description 使用地理单位，即默认热点半径默认使用像素单位。 当设置为 true 时，热点半径和图层地理坐标保持一致。
82+
* @description 使用地理单位，即默认热点半径默认使用像素单位。当设置为 true 时，热点半径和图层地理坐标保持一致。
8383
*/
8484
this.useGeoUnit = _options.useGeoUnit ? _options.useGeoUnit : false;
8585

@@ -577,7 +577,7 @@ export class HeatMapLayer extends mapboxgl.Evented {
577577
* @function HeatMapLayer.prototype.moveTo
578578
* @description 将图层移动到某个图层之前。
579579
* @param {string} layerID - 待插入的图层ID。
580-
* @param {boolean} [before=true] - 是否将本图层插入到图层 id 为 layerID 的图层之前(如果为 false 则将本图层插入到图层 id 为 layerID 的图层之后)。
580+
* @param {boolean} [before=true] - 是否将本图层插入到图层 ID 为 layerID 的图层之前(如果为 false 则将本图层插入到图层 ID 为 layerID 的图层之后)。
581581
*/
582582
moveTo(layerID, before) {
583583
var layer = document.getElementById(this.rootCanvas.id);

‎src/mapboxgl/overlay/LabelThemeLayer.js

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -969,10 +969,10 @@ export class Label extends GeoFeature {
969969

970970
/**
971971
* @function LabelThemeLayer.prototype.isPointInPoly
972-
* @description 判断一个点是否在多边形里面。(射线法)
972+
* @description 判断一个点是否在多边形里面（射线法）。
973973
*
974-
* @param {Object} pt - 需要判定的点对象，该对象含有属性x(横坐标)，属性y(纵坐标)。
975-
* @param {Array.<Object>} poly - 多边形节点数组。例如一个四边形：[{"x":1,"y":1},{"x":3,"y":1},{"x":6,"y":4},{"x":2,"y":10},{"x":1,"y":1}]
974+
* @param {Object} pt - 需要判定的点对象，该对象含有属性x（横坐标），属性y（纵坐标）。
975+
* @param {Array.<Object>} poly - 多边形节点数组。例如一个四边形：[{"x":1,"y":1},{"x":3,"y":1},{"x":6,"y":4},{"x":2,"y":10},{"x":1,"y":1}]。
976976
* @returns {boolean} 点是否在多边形内。
977977
*/
978978
isPointInPoly(pt, poly) {

‎src/mapboxgl/overlay/MapvLayer.js

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -70,7 +70,7 @@ export class MapvLayer {
7070
* @function MapvLayer.prototype.moveTo
7171
* @description 将图层移动到某个图层之前。
7272
* @param {string} layerID - 待插入的图层 ID。
73-
* @param {boolean} [before=true] - 是否将本图层插入到图层 id 为 layerID 的图层之前。
73+
* @param {boolean} [before=true] - 是否将本图层插入到图层 ID 为 layerID 的图层之前。
7474
*/
7575
moveTo(layerID, before) {
7676
const layer = document.getElementById(this.canvas.id);

‎src/mapboxgl/overlay/RangeTheme3DLayer.js

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@ import {Theme3DLayer} from './theme/Theme3DLayer';
88
* @class RangeTheme3DLayer
99
* @category Visualization Theme
1010
* @classdesc 三维分段专题图。
11-
* @param {string} [id] - 专题图图层 id。默认使用 CommonUtil.createUniqueID("theme3DLayer") 创建专题图层 ID。
11+
* @param {string} [id] - 专题图图层 ID。默认使用 CommonUtil.createUniqueID("theme3DLayer") 创建专题图层 ID。
1212
* @param {Object} layerOptions - 专题图图层配置项,参数继承自 Theme3DLayer。
1313
* @param {Array} [layerOptions.heightStops] - 新增参数，数据高度分段数组。
1414
* @param {Array} layerOptions.colorStops - 新增参数，数据颜色分段数组。

‎src/mapboxgl/overlay/ThreeLayer.js

Lines changed: 8 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -136,7 +136,7 @@ export class ThreeLayer extends mapboxgl.Evented {
136136

137137
/**
138138
* @function ThreeLayer.prototype.getScene
139-
* @description 获取threejs 场景对象
139+
* @description 获取 threejs 场景对象。
140140
* @returns {THREE.Scene} threejs 场景对象。
141141
*/
142142
getScene() {
@@ -145,7 +145,7 @@ export class ThreeLayer extends mapboxgl.Evented {
145145

146146
/**
147147
* @function ThreeLayer.prototype.getCamera
148-
* @description 获取threejs 相机。
148+
* @description 获取 threejs 相机。
149149
* @returns {THREE.Camera} threejs 相机。
150150
*/
151151
getCamera() {
@@ -238,9 +238,9 @@ export class ThreeLayer extends mapboxgl.Evented {
238238

239239
/**
240240
* @function ThreeLayer.prototype.lngLatToPosition
241-
* @description 经纬度转threejs 3D 失量对象。
241+
* @description 经纬度转threejs 3D 矢量对象。
242242
* @param {(Array.<number>|Object)} lngLat - 经纬度坐标。
243-
* @returns {THREE.Vector3} threejs 3D 失量对象。
243+
* @returns {THREE.Vector3} threejs 3D 矢量对象。
244244
*/
245245
lngLatToPosition(lngLat) {
246246
let zoom = Transform.projection.nativeMaxZoom;
@@ -250,11 +250,11 @@ export class ThreeLayer extends mapboxgl.Evented {
250250

251251
/**
252252
* @function ThreeLayer.prototype.distanceToThreeVector3
253-
* @description 计算距离指定坐标给定距离的新坐标的 threejs 3D 失量对象。
254-
* @param {number} x - x 轴距离,单位米。
255-
* @param {number} y - y 轴距离,单位米。
253+
* @description 计算距离指定坐标给定距离的新坐标的 threejs 3D 矢量对象。
254+
* @param {number} x - x 轴距离，单位米。
255+
* @param {number} y - y 轴距离，单位米。
256256
* @param {(Array.<number>|Object)} lngLat - 源坐标。
257-
* @returns {THREE.Vector3} 目标点的 threejs 3D 失量对象。
257+
* @returns {THREE.Vector3} 目标点的 threejs 3D 矢量对象。
258258
*/
259259
distanceToThreeVector3(x, y, lngLat) {
260260
let map = this._map;

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