Skip to content

Commit 80f0f7e

Browse files
zhangjiangqiuzhangjiangqiu
committed
【fix】 别名导出的api doc文档修复; review by luoxiao
1 parent 2a75cd8 commit 80f0f7e

5 files changed

Lines changed: 57 additions & 57 deletions

File tree

‎src/mapboxgl/overlay/GraphThemeLayer.js‎

Lines changed: 14 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -51,7 +51,7 @@ export class Graph extends Theme {
5151
}
5252

5353
/**
54-
* @function Graph.prototype.setChartsType
54+
* @function GraphThemeLayer.prototype.setChartsType
5555
* @description 设置图表类型，此函数可动态改变图表类型。在调用此函数前请通过 chartsSetting 为新类型的图表做相关配置。
5656
* @param {string} [chartsType] - 图表类型。目前可用："Bar", "Line", "Pie"。
5757
*/
@@ -61,7 +61,7 @@ export class Graph extends Theme {
6161
}
6262

6363
/**
64-
* @function Graph.prototype.addFeatures
64+
* @function GraphThemeLayer.prototype.addFeatures
6565
* @description 向专题图图层中添加数据，支持的 feature 类型为：iServer 返回的 feature JSON 对象。
6666
* @param {ServerFeature} features - 待添加的要素。
6767
*/
@@ -86,7 +86,7 @@ export class Graph extends Theme {
8686
}
8787

8888
/**
89-
* @function Graph.prototype.redrawThematicFeatures
89+
* @function GraphThemeLayer.prototype.redrawThematicFeatures
9090
* @description 重绘所有专题要素。
9191
* 此方法包含绘制专题要素的所有步骤，包含用户数据到专题要素的转换，抽稀，缓存等步骤。
9292
* 地图漫游时调用此方法进行图层刷新。
@@ -129,7 +129,7 @@ export class Graph extends Theme {
129129
}
130130

131131
/**
132-
* @function Graph.prototype.createThematicFeature
132+
* @function GraphThemeLayer.prototype.createThematicFeature
133133
* @description 向专题图图层中添加数据, 支持的 feature 类型为:iServer 返回的 feature json 对象。
134134
* @param {Object} feature - 待添加的要素。
135135
*
@@ -150,7 +150,7 @@ export class Graph extends Theme {
150150
}
151151

152152
/**
153-
* @function Graph.prototype.drawCharts
153+
* @function GraphThemeLayer.prototype.drawCharts
154154
* @description 绘制图表。包含压盖处理。
155155
*
156156
*/
@@ -257,7 +257,7 @@ export class Graph extends Theme {
257257
}
258258

259259
/**
260-
* @function Graph.prototype.getShapesByFeatureID
260+
* @function GraphThemeLayer.prototype.getShapesByFeatureID
261261
* @description 通过 FeatureID 获取 feature 关联的所有图形。如果不传入此参数，函数将返回所有图形。
262262
* @param {number} featureID - 要素 ID。
263263
*/
@@ -277,7 +277,7 @@ export class Graph extends Theme {
277277
}
278278

279279
/**
280-
* @function Graph.prototype.isQuadrilateralOverLap
280+
* @function GraphThemeLayer.prototype.isQuadrilateralOverLap
281281
* @description 判断两个四边形是否有压盖。
282282
* @param {Array.<Object>} quadrilateral - 四边形节点数组。
283283
* @param {Array.<Object>} quadrilateral2 - 第二个四边形节点数组。
@@ -320,7 +320,7 @@ export class Graph extends Theme {
320320
}
321321

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

337337
/**
338-
* @function Graph.prototype.isChartInMap
338+
* @function GraphThemeLayer.prototype.isChartInMap
339339
* @description 判断图表是否在地图里。
340340
* @param {Bounds} mapPxBounds - 地图像素范围。
341341
* @param {Array.<Object>} chartPxBounds - 图表范围的四边形节点数组。
@@ -355,7 +355,7 @@ export class Graph extends Theme {
355355
}
356356

357357
/**
358-
* @function Graph.prototype.clearCache
358+
* @function GraphThemeLayer.prototype.clearCache
359359
* @description 清除缓存
360360
*/
361361
clearCache() {
@@ -364,7 +364,7 @@ export class Graph extends Theme {
364364
}
365365

366366
/**
367-
* @function Graph.prototype.removeFeatures
367+
* @function GraphThemeLayer.prototype.removeFeatures
368368
* @description 从专题图中删除 feature。这个函数删除所有传递进来的矢量要素。参数中的 features 数组中的每一项，必须是已经添加到当前图层中的 feature。
369369
* @param {Feature.Vector} features - 要删除的要素。
370370
*/
@@ -374,7 +374,7 @@ export class Graph extends Theme {
374374
}
375375

376376
/**
377-
* @function Graph.prototype.removeAllFeatures
377+
* @function GraphThemeLayer.prototype.removeAllFeatures
378378
* @description 移除所有的要素。
379379
*/
380380
removeAllFeatures() {
@@ -383,7 +383,7 @@ export class Graph extends Theme {
383383
}
384384

385385
/**
386-
* @function Graph.prototype.redraw
386+
* @function GraphThemeLayer.prototype.redraw
387387
* @description 重绘该图层。
388388
*/
389389
redraw() {
@@ -396,7 +396,7 @@ export class Graph extends Theme {
396396
}
397397

398398
/**
399-
* @function Graph.prototype.clear
399+
* @function GraphThemeLayer.prototype.clear
400400
* @description 清除的内容包括数据（features） 、专题要素、缓存。
401401
*/
402402
clear() {

‎src/mapboxgl/overlay/LabelThemeLayer.js‎

Lines changed: 21 additions & 21 deletions
Original file line numberDiff line numberDiff line change
@@ -36,26 +36,26 @@ export class Label extends GeoFeature {
3636
constructor(name, opt_options) {
3737
super(name, opt_options);
3838
/**
39-
* @member {boolean} [Label.prototype.isOverLay=true]
39+
* @member {boolean} [LabelThemeLayer.prototype.isOverLay=true]
4040
* @description 是否进行压盖处理，如果设为 true，将隐藏被压盖的标签。
4141
*/
4242
this.isOverLay = true;
4343
/**
44-
* @member {boolean} [Label.prototype.isAvoid=true]
44+
* @member {boolean} [LabelThemeLayer.prototype.isAvoid=true]
4545
* @description 是否进行地图边缘的避让处理，如果设为 true，将把与地图边缘相交的标签移到地图范围内，在地图边缘处做避让处理。
4646
*/
4747
this.isAvoid = true;
4848

4949
/**
50-
* @member {string} Label.prototype.themeField
50+
* @member {string} LabelThemeLayer.prototype.themeField
5151
* @description 用于指定专题要素样式的属性字段名称。</br>
5252
* 此属性字段是要用户数据（feature） attributes 中包含的字段，且字段对应的值的类型必须是数值型。</br>
5353
* 使用标签分组显示还需要设置 styleGroups 属性。
5454
*/
5555
this.themeField = null;
5656

5757
/**
58-
* @member {Array.<Object>} Label.prototype.styleGroups
58+
* @member {Array.<Object>} LabelThemeLayer.prototype.styleGroups
5959
* @description 分组样式。使用此属性需要设置 themeField 属性。</br>
6060
* 1.没有同时设置 themeField 和 styleGroups，则所有专题要素都使用本图层的 style 进行渲染；</br>
6161
* 2.同时设置 themeField 和 styleGroups，则按照 themeField 指定的字段名称获取用户数据（feature）attributes 中对应的属性值；</br>
@@ -106,7 +106,7 @@ export class Label extends GeoFeature {
106106

107107

108108
/**
109-
* @function Label.prototype.redrawThematicFeatures
109+
* @function LabelThemeLayer.prototype.redrawThematicFeatures
110110
* @description 重绘所有专题要素。</br>
111111
* 此方法包含绘制专题要素的所有步骤，包含用户数据到专题要素的转换，抽稀，缓存等步骤。</br>
112112
* 地图漫游时调用此方法进行图层刷新。
@@ -123,7 +123,7 @@ export class Label extends GeoFeature {
123123
super.redrawThematicFeatures.call(this, bounds);
124124
}
125125
/**
126-
* @function Label.prototype.removeFeatures
126+
* @function LabelThemeLayer.prototype.removeFeatures
127127
* @description 从专题图中删除 feature。这个函数删除所有传递进来的矢量要素。
128128
* @param {GeometryVector} features - 要删除的要素对象。
129129
*/
@@ -133,7 +133,7 @@ export class Label extends GeoFeature {
133133
}
134134

135135
/**
136-
* @function Label.prototype.removeAllFeatures
136+
* @function LabelThemeLayer.prototype.removeAllFeatures
137137
* @description 清除当前图层所有的矢量要素。
138138
*/
139139
removeAllFeatures() {
@@ -142,7 +142,7 @@ export class Label extends GeoFeature {
142142
}
143143

144144
/**
145-
* @function Label.prototype.createThematicFeature
145+
* @function LabelThemeLayer.prototype.createThematicFeature
146146
* @description 创建专题图要素。
147147
* @param {Object} feature - 要创建的专题图形要素。
148148
*/
@@ -170,7 +170,7 @@ export class Label extends GeoFeature {
170170

171171

172172
/**
173-
* @function Label.prototype.getDrawnLabels
173+
* @function LabelThemeLayer.prototype.getDrawnLabels
174174
* @description 获取经（压盖）处理后将要绘制在图层上的标签要素。
175175
* @param {Array.<GeometryVector>} labelFeatures - 所有标签要素的数组。
176176
* @returns {Array.<GeometryVector>} 最终要绘制的标签要素数组。
@@ -334,7 +334,7 @@ export class Label extends GeoFeature {
334334

335335

336336
/**
337-
* @function Label.prototype.getStyleByData
337+
* @function LabelThemeLayer.prototype.getStyleByData
338338
* @description 根据用户数据（feature）设置专题要素的 Style。
339339
* @param {GeometryVector} feat - 矢量要素对象。
340340
* @returns {Array.<ThemeStyle>} 专题要素的 Style。
@@ -383,7 +383,7 @@ export class Label extends GeoFeature {
383383
}
384384

385385
/**
386-
* @function Label.prototype.setLabelsStyle
386+
* @function LabelThemeLayer.prototype.setLabelsStyle
387387
* @description 设置标签要素的 Style。
388388
* @param {Array.<GeometryVector>} labelFeatures - 需要设置 Style 的标签要素数组。
389389
* @returns {Array.<GeometryVector>} 赋予 Style 后的标签要素数组。
@@ -411,7 +411,7 @@ export class Label extends GeoFeature {
411411
}
412412

413413
/**
414-
* @function Label.prototype.setStyle
414+
* @function LabelThemeLayer.prototype.setStyle
415415
* @description 设置标签要素的Style。
416416
* @param {GeometryVector} feat - 需要赋予 style 的要素。
417417
*/
@@ -461,7 +461,7 @@ export class Label extends GeoFeature {
461461
}
462462

463463
/**
464-
* @function Label.prototype.getLabelPxLocation
464+
* @function LabelThemeLayer.prototype.getLabelPxLocation
465465
* @description 获取标签要素的像素坐标。
466466
* @param {GeometryVector} feature - 标签要素。
467467
* @returns {mapboxgl.Point} 标签位置。
@@ -488,7 +488,7 @@ export class Label extends GeoFeature {
488488

489489

490490
/**
491-
* @function Label.prototype.calculateLabelBounds
491+
* @function LabelThemeLayer.prototype.calculateLabelBounds
492492
* @description 获得标签要素的最终范围。
493493
*
494494
* @param {GeometryVector} feature - 需要计算 bounds 的标签要素数。
@@ -547,7 +547,7 @@ export class Label extends GeoFeature {
547547
}
548548

549549
/**
550-
* @function Label.prototype.calculateLabelBounds2
550+
* @function LabelThemeLayer.prototype.calculateLabelBounds2
551551
* @description 获得标签要素的最终范围的另一种算法（通过记录下的标签宽高），提高计算 bounds 的效率。
552552
*
553553
* @param {GeometryVector} feature - 需要计算 bounds 的标签要素数。
@@ -643,7 +643,7 @@ export class Label extends GeoFeature {
643643
}
644644

645645
/**
646-
* @function Label.prototype.getLabelInfo
646+
* @function LabelThemeLayer.prototype.getLabelInfo
647647
* @description 根据当前位置获取绘制后的标签信息，包括标签的宽，高和行数等。
648648
* @returns {Object} 绘制后的标签信息。
649649
*/
@@ -742,7 +742,7 @@ export class Label extends GeoFeature {
742742
}
743743

744744
/**
745-
* @function Label.prototype.rotationBounds
745+
* @function LabelThemeLayer.prototype.rotationBounds
746746
* @description 旋转 bounds。
747747
*
748748
* @param {Bounds} bounds - 要旋转的 bounds。
@@ -780,7 +780,7 @@ export class Label extends GeoFeature {
780780
}
781781

782782
/**
783-
* @function Label.prototype.getRotatedLocation
783+
* @function LabelThemeLayer.prototype.getRotatedLocation
784784
* @description 获取一个点绕旋转中心顺时针旋转后的位置（此方法用于屏幕坐标）。
785785
*
786786
* @param {number} x - 旋转点横坐标。
@@ -808,7 +808,7 @@ export class Label extends GeoFeature {
808808
}
809809

810810
/**
811-
* @function Label.prototype.getAvoidInfo
811+
* @function LabelThemeLayer.prototype.getAvoidInfo
812812
* @description 获取避让的信息。
813813
*
814814
* @param {Bounds} bounds - 地图像素范围。
@@ -923,7 +923,7 @@ export class Label extends GeoFeature {
923923

924924

925925
/**
926-
* @function Label.prototype.isQuadrilateralOverLap
926+
* @function LabelThemeLayer.prototype.isQuadrilateralOverLap
927927
* @description 判断两个四边形是否有压盖。
928928
* @param {Array.<Object>} quadrilateral - 四边形节点数组。例如：[{"x":1,"y":1},{"x":3,"y":1},{"x":6,"y":4},{"x":2,"y":10},{"x":1,"y":1}]。
929929
* @param {Array.<Object>} quadrilateral2 - 第二个四边形节点数组。
@@ -968,7 +968,7 @@ export class Label extends GeoFeature {
968968
}
969969

970970
/**
971-
* @function Label.prototype.isPointInPoly
971+
* @function LabelThemeLayer.prototype.isPointInPoly
972972
* @description 判断一个点是否在多边形里面。(射线法)
973973
*
974974
* @param {Object} pt - 需要判定的点对象，该对象含有属性x(横坐标)，属性y(纵坐标)。

‎src/mapboxgl/overlay/RangeThemeLayer.js‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -37,7 +37,7 @@ export class Range extends GeoFeature {
3737
}
3838

3939
/**
40-
* @function Range.prototype.createThematicFeature
40+
* @function RangeThemeLayer.prototype.createThematicFeature
4141
* @description 创建专题图要素。
4242
* @param {Object} feature - 要创建的专题图形要素。
4343
*/
@@ -65,7 +65,7 @@ export class Range extends GeoFeature {
6565

6666
/**
6767
* @private
68-
* @function Range.prototype.getStyleByData
68+
* @function RangeThemeLayer.prototype.getStyleByData
6969
* @description 通过数据获取 style。
7070
* @param {Object} fea - 要素数据。
7171
*/

‎src/mapboxgl/overlay/RankSymbolThemeLayer.js‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -40,7 +40,7 @@ export class RankSymbol extends Graph {
4040
}
4141

4242
/**
43-
* @function RankSymbol.prototype.setSymbolType
43+
* @function RankSymbolThemeLayer.prototype.setSymbolType
4444
* @description 设置标志符号。
4545
* @param {string} [symbolType] - 符号类型。
4646
*/
@@ -50,7 +50,7 @@ export class RankSymbol extends Graph {
5050
}
5151

5252
/**
53-
* @function RankSymbol.prototype.createThematicFeature
53+
* @function RankSymbolThemeLayer.prototype.createThematicFeature
5454
* @description 创建专题图形要素。
5555
* @param {Object} feature - 要创建的专题图形要素。
5656
*/

0 commit comments

Comments
 (0)