Skip to content

Commit f4b130d

Browse files
committed
fix leaflet 高性能图层相关注释
1 parent 968b0af commit f4b130d

File tree

4 files changed

+32
-26
lines changed

4 files changed

+32
-26
lines changed

dist/iclient9-leaflet.js

Lines changed: 16 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -32760,10 +32760,13 @@ function _interopRequireDefault(obj) { return obj && obj.__esModule ? obj : { "d
3276032760

3276132761
/**
3276232762
* @class L.supermap.graphic
32763-
* @classdesc 图形类
32763+
* @classdesc 高效率点图层要素类
3276432764
* @category Visualization Graphic
3276532765
* @extends L.Class{@linkdoc-leaflet/#class}
32766-
* @param options - {Object} 图形参数
32766+
* @param options -{object} 图形参数
32767+
* @param options.latLng -{L.LatLng} 经纬度
32768+
* @param options.style -{L.supermap.circleStyle|L.supermap.cloverStyle|L.supermap.imageStyle} 点样式
32769+
* @param options.attributes -{Object} 要素属性
3276732770
*/
3276832771
var Graphic = exports.Graphic = _leaflet2["default"].Class.extend({
3276932772

@@ -32779,7 +32782,7 @@ var Graphic = exports.Graphic = _leaflet2["default"].Class.extend({
3277932782
/**
3278032783
* @function L.supermap.graphic.prototype.setLatLng
3278132784
* @description 设置经纬度
32782-
* @param latLng - {L.latLng} 经纬度参数
32785+
* @param latLng -{L.LatLng} 经纬度参数
3278332786
*/
3278432787
setLatLng: function setLatLng(latLng) {
3278532788
this._latLng = latLng;
@@ -32789,7 +32792,7 @@ var Graphic = exports.Graphic = _leaflet2["default"].Class.extend({
3278932792
* @deprecated
3279032793
* @function L.supermap.graphic.prototype.setCanvas
3279132794
* @description 设置画布,已弃用该设置,请使用setStyle接口
32792-
* @param canvas - {Object} 传入需要设置的画布
32795+
* @param canvas - {HTMLCanvasElement} 传入需要设置的画布
3279332796
*/
3279432797
setCanvas: function setCanvas(canvas) {
3279532798
this._style = canvas;
@@ -32807,7 +32810,7 @@ var Graphic = exports.Graphic = _leaflet2["default"].Class.extend({
3280732810
/**
3280832811
* @function L.supermap.graphic.prototype.getLatLng
3280932812
* @description 获取经纬度
32810-
* @return {L.latLng} 经纬度
32813+
* @return {L.LatLng} 经纬度
3281132814
*/
3281232815

3281332816
getLatLng: function getLatLng() {
@@ -32836,16 +32839,16 @@ var Graphic = exports.Graphic = _leaflet2["default"].Class.extend({
3283632839
/**
3283732840
* @function L.supermap.graphic.prototype.setStyle
3283832841
* @description 设置样式
32839-
* @param canvas - {HTMLCanvasElement} 传入需要设置的画布
32842+
* @param style - {L.supermap.circleStyle|L.supermap.imageStyle|L.supermap.cloverStyle} 样式
3284032843
*/
32841-
setStyle: function setStyle(canvas) {
32842-
this._style = canvas;
32844+
setStyle: function setStyle(style) {
32845+
this._style = style;
3284332846
},
3284432847

3284532848
/**
3284632849
* @function L.supermap.graphic.prototype.getStyle
3284732850
* @description 获取样式
32848-
* @return {L.supermap.CircleStyle|L.supermap.ImageStyle|L.supermap.CloverStyle} 样式
32851+
* @return {L.supermap.circleStyle|L.supermap.imageStyle|L.supermap.cloverStyle} 样式
3284932852
*/
3285032853
getStyle: function getStyle() {
3285132854
return this._style;
@@ -62430,7 +62433,7 @@ var CloverStyle = exports.CloverStyle = _leaflet2["default"].Class.extend({
6243062433
},
6243162434

6243262435
/**
62433-
* @function: L.supermap.cloverStyle.prototype.drawSector
62436+
* @function L.supermap.cloverStyle.prototype.drawSector
6243462437
* @description 绘制扇形
6243562438
* @param ctx - {CanvasRenderingContext2D} context对象
6243662439
* @param x - {number} 中心点 x
@@ -65427,7 +65430,7 @@ function _interopRequireDefault(obj) { return obj && obj.__esModule ? obj : { "d
6542765430
* @classdesc 高效率点图层类。
6542865431
* @category Visualization Graphic
6542965432
* @extends L.Path{@linkdoc-leaflet/#path}
65430-
* @param graphics - {Array<L.supermap.Graphic>} 图形对象
65433+
* @param graphics - {Array<L.supermap.graphic>} 图形对象
6543165434
* @param options - {Object} 图层参数。<br>
6543265435
* handleClick - {function} 图层点击响应事件函数。
6543365436
*/
@@ -65470,7 +65473,7 @@ var GraphicLayer = exports.GraphicLayer = _leaflet2["default"].Path.extend({
6547065473
/**
6547165474
* @function L.supermap.graphicLayer.prototype.setGraphics
6547265475
* @description 设置绘制的点要素数据,会覆盖之前的所有要素
65473-
* @param {Array<L.supermap.Graphic>} graphics - 点要素对象数组
65476+
* @param {Array<L.supermap.graphic>} graphics - 点要素对象数组
6547465477
*/
6547565478
setGraphics: function setGraphics(graphics) {
6547665479
this.graphics = [];
@@ -65483,7 +65486,7 @@ var GraphicLayer = exports.GraphicLayer = _leaflet2["default"].Path.extend({
6548365486
/**
6548465487
* @function L.supermap.graphicLayer.prototype.addGraphics
6548565488
* @description 追加点要素,不会覆盖之前的要素
65486-
* @param {Array<L.supermap.Graphic>} graphics - 点要素对象数组
65489+
* @param {Array<L.supermap.graphic>} graphics - 点要素对象数组
6548765490
*/
6548865491
addGraphics: function addGraphics(graphics) {
6548965492
this.graphics = this.graphics || [];

src/leaflet/overlay/GraphicLayer.js

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@ import '../core/Base';
66
* @classdesc 高效率点图层类。
77
* @category Visualization Graphic
88
* @extends L.Path{@linkdoc-leaflet/#path}
9-
* @param graphics - {Array<L.supermap.Graphic>} 图形对象
9+
* @param graphics - {Array<L.supermap.graphic>} 图形对象
1010
* @param options - {Object} 图层参数。<br>
1111
* handleClick - {function} 图层点击响应事件函数。
1212
*/
@@ -49,7 +49,7 @@ export var GraphicLayer = L.Path.extend({
4949
/**
5050
* @function L.supermap.graphicLayer.prototype.setGraphics
5151
* @description 设置绘制的点要素数据,会覆盖之前的所有要素
52-
* @param {Array<L.supermap.Graphic>} graphics - 点要素对象数组
52+
* @param {Array<L.supermap.graphic>} graphics - 点要素对象数组
5353
*/
5454
setGraphics(graphics) {
5555
this.graphics = [];
@@ -61,7 +61,7 @@ export var GraphicLayer = L.Path.extend({
6161
/**
6262
* @function L.supermap.graphicLayer.prototype.addGraphics
6363
* @description 追加点要素,不会覆盖之前的要素
64-
* @param {Array<L.supermap.Graphic>} graphics - 点要素对象数组
64+
* @param {Array<L.supermap.graphic>} graphics - 点要素对象数组
6565
*/
6666
addGraphics(graphics) {
6767
this.graphics = this.graphics || [];

src/leaflet/overlay/graphic/CloverStyle.js

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -65,7 +65,7 @@ export var CloverStyle = L.Class.extend({
6565
},
6666

6767
/**
68-
* @function: L.supermap.cloverStyle.prototype.drawSector
68+
* @function L.supermap.cloverStyle.prototype.drawSector
6969
* @description 绘制扇形
7070
* @param ctx - {CanvasRenderingContext2D} context对象
7171
* @param x - {number} 中心点 x

src/leaflet/overlay/graphic/Graphic.js

Lines changed: 12 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -3,10 +3,13 @@ import '../../core/Base';
33

44
/**
55
* @class L.supermap.graphic
6-
* @classdesc 图形类
6+
* @classdesc 高效率点图层要素类
77
* @category Visualization Graphic
88
* @extends L.Class{@linkdoc-leaflet/#class}
9-
* @param options - {Object} 图形参数
9+
* @param options -{object} 图形参数
10+
* @param options.latLng -{L.LatLng} 经纬度
11+
* @param options.style -{L.supermap.circleStyle|L.supermap.cloverStyle|L.supermap.imageStyle} 点样式
12+
* @param options.attributes -{Object} 要素属性
1013
*/
1114
export var Graphic = L.Class.extend({
1215

@@ -22,7 +25,7 @@ export var Graphic = L.Class.extend({
2225
/**
2326
* @function L.supermap.graphic.prototype.setLatLng
2427
* @description 设置经纬度
25-
* @param latLng - {L.latLng} 经纬度参数
28+
* @param latLng -{L.LatLng} 经纬度参数
2629
*/
2730
setLatLng: function (latLng) {
2831
this._latLng = latLng;
@@ -32,7 +35,7 @@ export var Graphic = L.Class.extend({
3235
* @deprecated
3336
* @function L.supermap.graphic.prototype.setCanvas
3437
* @description 设置画布,已弃用该设置,请使用setStyle接口
35-
* @param canvas - {Object} 传入需要设置的画布
38+
* @param canvas - {HTMLCanvasElement} 传入需要设置的画布
3639
*/
3740
setCanvas: function (canvas) {
3841
this._style = canvas;
@@ -51,7 +54,7 @@ export var Graphic = L.Class.extend({
5154
/**
5255
* @function L.supermap.graphic.prototype.getLatLng
5356
* @description 获取经纬度
54-
* @return {L.latLng} 经纬度
57+
* @return {L.LatLng} 经纬度
5558
*/
5659

5760
getLatLng: function () {
@@ -80,16 +83,16 @@ export var Graphic = L.Class.extend({
8083
/**
8184
* @function L.supermap.graphic.prototype.setStyle
8285
* @description 设置样式
83-
* @param canvas - {HTMLCanvasElement} 传入需要设置的画布
86+
* @param style - {L.supermap.circleStyle|L.supermap.imageStyle|L.supermap.cloverStyle} 样式
8487
*/
85-
setStyle: function (canvas) {
86-
this._style = canvas;
88+
setStyle: function (style) {
89+
this._style = style;
8790
},
8891

8992
/**
9093
* @function L.supermap.graphic.prototype.getStyle
9194
* @description 获取样式
92-
* @return {L.supermap.CircleStyle|L.supermap.ImageStyle|L.supermap.CloverStyle} 样式
95+
* @return {L.supermap.circleStyle|L.supermap.imageStyle|L.supermap.cloverStyle} 样式
9396
*/
9497
getStyle: function () {
9598
return this._style;

0 commit comments

Comments
 (0)