/
overlay.d.ts
1216 lines (1212 loc) · 48.2 KB
/
overlay.d.ts
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
/// <reference path="./base.d.ts" />
/// <reference path="./core.d.ts" />
declare namespace AMap {
/**
* [点标记](https://a.amap.com/jsapi/static/doc/index.html?v=2#marker)
*/
class Marker extends EventListener {
constructor(opts: MarkerOptions);
/** 获取点标记的文字提示 */
getTitle(): ?string;
/** 鼠标滑过点标时的文字提示 */
setTitle(title: string): void;
/** 当点标记未自定义图标时,获取Icon内容 */
getIcon(): Icon | string | undefined;
/** 当点标记未自定义图标时,获取Icon内容 */
setIcon(icon: Icon | string): void;
/** 获取点标记文本标签内容 */
getLabel(): TextOptions;
/** 设置点标记文本标签内容相关示例(https://lbs.amap.com/api/javascript-api/example/marker/set-marker-text-label/) */
setLabel(opts: TextOptions): void;
/** 获取点标记是否支持鼠标单击事件Boolean */
getClickable(): boolean;
/** 设置点标记是支持鼠标单击事件clickable:Boolean */
setClickable(clickable: boolean): void;
/** 获取点标记对象是否可拖拽移动Boolean */
getDraggable(): boolean;
/** 设置点标记对象是否可拖拽移动draggable:Boolean */
setDraggable(draggable: boolean): void;
/** 获取该点标记是否置顶 */
getTop(): boolean;
/** 获取鼠标悬停时的光标设置 */
getCursor(): string;
/** 地图上有多个marker时,设置是否置顶该点标记 */
setTop(isTop: boolean): void;
/** 获取鼠标悬停时的光标设置 */
getCursor(): string;
/** 设置鼠标悬停时的光标 */
setCursor(cursor: string): void;
/** 获取用户自定义属性 Any */
getExtData(): any | undefined;
/** 设置用户自定义数据 */
setExtData(extData: any): void;
/** 以给定时长/速度移动点标记到指定位置, 需加载 AMap.MoveAnimation 插件才可使用 */
moveTo(targetPosition: LngLat | Vector, opts: MoveToOptions): void;
/** 以指定的时长,点标记沿指定的路径移动,加载 AMap.MoveAnimation 后可以使用 JSAPI 2.0 可支持分段设置速度和时长 [相关示例](https://lbs.amap.com/api/jsapi-v2/example/marker/replaying-historical-running-data) */
moveAlong(path: Array<LngLat> | Array<VectorLayer> | Array<MoveAlongObj>, opts: MoveAlongOptions): void;
/** 开启点标记动画,加载 AMap.MoveAnimation 后创建的点标记可以使用 */
startMove(): void;
/** 停止点标记动画,加载 AMap.MoveAnimation 后创建的点标记可以使用 */
stopMove(): void;
/** 暂停点标记动画,加载 AMap.MoveAnimation 后创建的点标记可以使用 */
pauseMove(): void;
/** 重新启动点标记动画,加载 AMap.MoveAnimation 后创建的点标记可以使用 */
resumeMove(): void;
/** 设置尺寸 */
setSize(size: Vector | Size): void;
/** 获取点标记的叠加顺序 */
getzIndex(): number | undefined;
/** 设置点标记的叠加顺序,默认最先添加的点标记在最底层 */
setzIndex(zIndex: number): void;
/** 获取覆盖物的所有属性 */
getOptions(): OverlayOptions;
/** 获取点标记显示的自定义内容 */
getContent(): string | HTMLElement | undefined;
/** 将覆盖物加到地图上 */
add(map: Map): void;
/** 移除点标记 [相关示例](https://lbs.amap.com/api/jsapi-v2/example/marker/marker-content) */
remove(): void;
/** 获取覆盖物旋转角度 */
getAngle(): number | undefined;
/** 设置覆盖物偏移量 */
setOffset(offset: Vector | Pixel): void;
/** 设置点标记显示内容,可以是HTML要素字符串或者HTML DOM对象 */
setContent(content: HTMLElement | string): void;
/** 获取点标记范围 */
getBounds(): Bounds;
/** 获取覆盖物偏移量 */
getOffset(): Vector | Pixel | undefined | Array<number>;
/** 设置覆盖物锚点 */
Marker(anchor: string): void;
/** 获取覆盖物的地图实例 */
getMap(): Map | null;
/** 获取覆盖物锚点 */
getAnchor(): string | Vector | undefined;
/** 设置覆盖物位置 */
setPosition(position: Vector): void;
/** 获取覆盖物位置 */
getPosition(): Vector;
/** 将覆盖物设置到地图上 */
setMap(map: Map | null): void;
/** 将覆盖物加到地图上 */
addTo(map: Map): void;
/** 设置覆盖物旋转角度 */
setAngle(angle: number): void;
/** 如设置了尺寸,获取设置的尺寸 */
getSize(): Vector;
}
interface MarkerOptions {
/**
* 要显示该marker的地图对象
*/
map?: Map;
/**
* 点标记在地图上显示的位置,默认为地图中心点
*/
position?: LngLat;
/**
* 设置点标记锚点。
* @default 'top-left' 默认值
*/
anchor?: 'top-left' | 'top-center' | 'top-right' | 'middle-left' | 'center' | 'middle-right' | 'bottom-left' | 'bottom-center' | 'bottom-right';
/**
* 点标记显示位置偏移量,默认值为Pixel(-10,-34)。
* Marker指定position后,默认以marker左上角位置为基准点(若设置了anchor,则以anchor设置位置为基准点),对准所给定的position位置,若需使marker指定位置对准在position处,需根据marker的尺寸设置一定的偏移量。
*/
offset?: Pixel;
/**
* 需在点标记中显示的图标。可以是一个本地图标地址,或者 Icon 对象。有合法的 content 内容时,此属性无效
*/
icon?: string | Icon;
/**
* 点标记显示内容,可以是HTML要素字符串或者HTML DOM对象。content有效时,icon 属性将被覆盖
*/
content?: string | Object;
/**
* 鼠标点击时marker是否置顶,默认false, 不置顶(自v1.3 新增)
* @default false 默认值
*/
topWhenClick?: boolean;
/**
* 是否将覆盖物的鼠标或touch等事件冒泡到地图上(自v1.3 新增)
* @default false 默认值
*/
bubble?: boolean;
/**
* 设置点标记是否可拖拽移动
* @default false 默认值
*/
draggable?: boolean;
/**
* 设置拖拽点标记时是否开启点标记离开地图的效果
*/
raiseOnDrag?: boolean;
/**
* 指定鼠标悬停时的鼠标样式,自定义cursor,IE仅支持cur/ani/ico格式,Opera不支持自定义cursor
*/
cursor?: string;
/**
* 点标记是否可见,默认为true
* @default true 默认值
*/
visible?: boolean;
/**
* 点标记的叠加顺序。地图上存在多个点标记叠加时,通过该属性使级别较高的点标记在上层显示
* @default 100 默认值
*/
zIndex?: number;
/**
* 点标记的旋转角度,广泛用于改变车辆行驶方向,注:angle属性是使用CSS3来实现的,支持IE9及以上版本
*/
angle?: number;
/**
* 是否自动旋转。点标记在使用moveAlong动画时,路径方向若有变化,点标记是否自动调整角度,默认为false。广泛用于自动调节车辆行驶方向。IE8以下不支持旋转,autoRotation属性无效
*/
autoRotation?: boolean;
/**
* 点标记的动画效果
* 可选值:
* - `AMAP_ANIMATION_NONE` 无动画效果
* - `AMAP_ANIMATION_DROP` 点标掉落效果
* - `AMAP_ANIMATION_BOUNCE` 点标弹跳效果
* @default `AMAP_ANIMATION_NONE`
*/
animation?: string;
/**
* 点标记阴影,不设置该属性则点标记无阴影
*/
shadow?: Icon;
/**
* 鼠标滑过点标记时的文字提示,不设置则鼠标滑过点标无文字提示
*/
title?: string;
/**
* 点标记是否可点击
*/
clickable?: boolean;
/**
* 设置Marker的可点击区域,在定义的区域内可触发Marker的鼠标点击事件
*/
shape?: MarkerShape;
/**
* 用户自定义属性,支持JavaScript API任意数据类型,如Marker的id等
*/
extData?: any;
/**
* 添加文本标注。content 为文本标注的内容。
* direction 为文本标注方位(自 v1.4.14 新增属性),可选值:'top'|'right'|'bottom'|'left'|'center',默认值:'top' 。
* offset 为偏移量(默认基准点为图标左上角),如设置了 direction,以 direction 方位为基准点进行偏移。相关示例
*/
label?: { content: string; offset: Pixel, direction: 'top'|'right'|'bottom'|'left'|'center' };
}
interface MarkerEvents {
/**
* 鼠标左键单击事件
*/
onClick?(event: MapsEvent): void;
/**
* 鼠标左键双击事件
*/
onDblClick?(event: MapsEvent): void;
/**
* 鼠标右键单击事件
*/
onRightClick?(event: MapsEvent): void;
/**
* 鼠标移动
*/
onMouseMove?(event: MapsEvent): void;
/**
* 鼠标移近点标记时触发事件
*/
onMouseOver?(event: MapsEvent): void;
/**
* 鼠标移出点标记时触发事件
*/
onMouseOut?(event: MapsEvent): void;
/**
* 鼠标在点标记上按下时触发事件
*/
onMouseDown?(event: MapsEvent): void;
/**
* 鼠标在点标记上按下后抬起时触发事件
*/
onMouseUp?(event: MapsEvent): void;
/**
* 开始拖拽点标记时触发事件
*/
onDragStart?(event: MapsEvent): void;
/**
* 鼠标拖拽移动点标记时触发事件
*/
onDragging?(event: MapsEvent): void;
/**
* 点标记拖拽移动结束触发事件
*/
onDragEnd?(event: MapsEvent): void;
/**
* 点标记在执行moveTo,moveAlong动画时触发事件,Object对象的格式是{passedPath:Array.<LngLat>}。
* 其中passedPath为Marker对象在moveAlong或者moveTo过程中已经走过的路径。
*/
onMoving?(obj: { passedPath:Array<LngLat> }): void;
/**
* 点标记执行moveTo动画结束时触发事件,也可以由moveAlong方法触发
*/
onMoveEnd?(): void;
/**
* 点标记执行moveAlong动画一次后触发事件
*/
onMoveAlong?(): void;
/**
* 触摸开始时触发事件,仅适用移动设备
*/
onTouchStart?(event: MapsEvent): void;
/**
* 触摸移动进行中时触发事件,仅适用移动设备
*/
onTouchMove?(event: MapsEvent): void;
/**
* 触摸结束时触发事件,仅适用移动设备
*/
onTouchEnd?(event: MapsEvent): void;
}
class MarkerShape {
constructor(opts: MarkerShapeOptions)
}
interface MarkerShapeOptions {
/**
* 可点击区域组成元素数组,存放图形的像素坐标等信息,该数组元素由type决定:
* - circle:coords格式为 [x1, y1, r],x1,y1为圆心像素坐标,r为圆半径
* - poly: coords格式为 [x1, y1, x2, y2 … xn, yn],各x,y表示多边形边界像素坐标
* - rect: coords格式为 [x1, y1, x2, y2],x1,y1为矩形左上角像素坐标,x2,y2为矩形右下角像素坐标
* Markshape 的像素坐标是指相对于marker的左上角的像素坐标偏移量
*/
coords?: Array<number>;
/**
* 可点击区域类型,可选值:
* - circle:圆形
* - poly:多边形
* - rect:矩形
*/
type?: 'circle' | 'poly' | 'rect';
}
/**
* 构造折线对象,支持 lineString 和 MultiLineString
*/
class Polyline extends EventListener {
constructor(opts: PolylineOptions);
/**
* 获取当前折线的矩形范围对象
*/
getBounds(): Bounds | undefined;
/**
* 设置组成该折线的节点数组,支持单条折线(LngLatLike[]) 多条折线(LngLatLike[][])
* @param path 折线
*/
setPath(path?: Array<LngLatLike> | Array<Array<LngLatLike>>): void;
/**
* 获取折线的总长度(单位:米)
*/
getLength(): number;
/**
* 获取用户自定义属性
*/
getExtData(): any;
/**
* 设置用户自定义属性,支持JavaScript API任意数据类型
* @param extData
*/
setExtData(extData: any): void;
/**
* 获取线的属性
*/
getOptions(): PolylineOptions;
/**
* 获取折线路径的节点数组。
*/
getPath(): Array<LngLat> | Array<Array<LngLat>>;
/**
* 修改折线属性(包括路径的节点、线样式、是否绘制大地线等。属性详情参看PolylineOptions列表)
* @param opts
*/
setOptions(opts: PolylineOptions): void;
/**
* 判断坐标是否在折线内
* @param point
*/
contains(point: LngLatLike): boolean;
}
interface PolylineEvents {
/** 隐藏 */
onHide?(): void;
/** 显示 */
onShow?(): void;
/** 鼠标移出 */
onMouseOut?(event: MapsEvent): void;
/** 鼠标右键单击事件 */
onRightClick?(event: MapsEvent): void;
/** 鼠标左键双击事件 */
onDblClick?(event: MapsEvent): void;
/** 鼠标左键单击事件 */
onClick?(event: MapsEvent & { originEvent: MouseEvent; pos: [number, number]; vectorIndex: number; }): void;
/** 鼠标经过 */
onMouseOver?(event: MapsEvent): void;
/** 触摸结束时触发事件,仅适用移动设备 */
onTouchEnd?(event: MapsEvent): void;
/** 触摸移动进行中时触发事件,仅适用移动设备 */
onTouchMove?(event: MapsEvent): void;
/** 触摸开始时触发事件,仅适用移动设备 */
onTouchStart?(event: MapsEvent): void;
/** 鼠标抬起 */
onMouseUp?(event: MapsEvent): void;
/** 鼠标按下 */
onMouseDown?(event: MapsEvent): void;
}
interface PolylineOptions {
/**
* polyline 路径,支持 lineString 和 MultiLineString
*/
path?: Array<LngLat> | Array<Array<LngLat>>;
/**
* 多边形覆盖物的叠加顺序。地图上存在多个多边形覆盖物叠加时,通过该属性使级别较高的多边形覆盖物在上层显示
* @default 10 默认值
*/
zIndex?: number;
/**
* 是否将覆盖物的鼠标或touch等事件冒泡到地图上(自v1.3 新增)
* @default false 默认值
*/
bubble?: boolean;
/**
* 指定鼠标悬停时的鼠标样式,自定义cursor,IE仅支持 `cur/ani/ico` 格式,Opera 不支持自定义 `cursor`
*/
cursor?: string;
/**
* 线条颜色,使用16进制颜色代码赋值。默认值为 `#00D3FC`
* @default "#00D3FC" 默认值
*/
strokeColor?: string;
/**
* 轮廓线透明度,取值范围 [0,1] ,0表示完全透明,1表示不透明。默认为0.5
* @default 0.5 默认值
*/
strokeOpacity?: number;
/**
* 轮廓线宽度
* @default 2 默认值
*/
strokeWeight?: number;
/**
* 描边线宽度
* @default 2 默认值
*/
borderWeight?: number;
/**
* 是否显示描边,默认 `false`
* @default false 默认值
*/
isOutline?: boolean;
/**
* 描边的宽度,默认为 `1`
* @default 1 默认值
*/
borderWeight?: number;
/**
* @default '#00B2D5' 默认值
*/
outlineColor?: string;
/**
* 设置多边形是否可拖拽移动,默认为 `false`
* @default false 默认值
*/
draggable?: boolean;
/**
* 用户自定义属性,支持 `JavaScript API` 任意数据类型,如 `Polygon` 的 `id` 等
*/
extData?: any;
/**
* 轮廓线样式,实线:solid,虚线:dashed
* @default 'solid' 默认值
*/
strokeStyle?: 'solid' | 'dashed';
/**
* 勾勒形状轮廓的虚线和间隙的样式,此属性在 strokeStyle 为 dashed 时有效, 此属性在 `ie9+` 浏览器有效
* > **取值**
* - 实线: [0,0,0]
* - 虚线: [10,10],[10,10] 表示10个像素的实线和10个像素的空白(如此反复)组成的虚线
* - 点画线: [10,2,10],[10,2,10] 表示10个像素的实线和2个像素的空白 + 10个像素的实线和10个像素的空白 (如此反复)组成的虚线
*/
strokeDasharray?: Array<number>;
/**
* 折线拐点的绘制样式,默认值为 `miter` 尖角,其他可选值:`round` 圆角、`bevel` 斜角
* @default 'miter' 默认值
*/
lineJoin?: 'miter' | 'round' | 'bevel';
/**
* 折线两端线帽的绘制样式,默认值为 `butt` 无头,其他可选值:`round` 圆头、`square` 方头
* @default 'butt' 默认值
*/
lineCap?: 'butt' | 'round' | 'square';
/**
* 是否绘制成大地线,默认false
* @default false 默认值
*/
geodesic?: boolean;
/**
* 是否延路径显示白色方向箭头,默认false。建议折线宽度大于6时使用
* @default false 默认值
*/
showDir?: boolean;
}
/**
* 构造圆形对象,通过CircleOptions指定多边形样式
*/
class Circle extends EventListener {
constructor(opts: CircleOptions);
/** 设置圆中心点 */
setCenter(center: LngLatLike): void;
/** 设置圆形的半径 */
setRaius(radius: number): void;
/** 获取圆中心点 */
getCenter(): LngLat;
/** 获取圆形的半径 */
getRaius(): number;
/** 判断指定点坐标是否在圆内 */
contains(point: LngLatLike): void;
/** 修改圆属性(样式风格,包括组成圆形轮廓线的节点、轮廓线样式等。属性详情参看CircleOptions列表) */
setOptions(optsArg: CircleOptions): void;
/** 获取用户自定义属性 */
getExtData(): any;
/** 设置用户自定义属性,支持JavaScript API任意数据类型 */
setExtData(extData: any): void;
/** 获取圆形的属性 */
getOptions(): CircleOptions;
}
interface CircleEvents {
/** 隐藏 */
onHide?(): void;
/** 显示 */
onShow?(): void;
/** 鼠标右键单击事件 */
onRightClick?(event: MapsEvent): void;
/** 鼠标左键单击事件 */
onClick?(event: MapsEvent): void;
/** 鼠标左键单击事件 */
onTouchEnd?(event: MapsEvent): void;
/** 鼠标左键双击事件 */
onDblClick?(event: MapsEvent): void;
/** 触摸移动进行中时触发事件,仅适用移动设备 */
onTouchMove?(event: MapsEvent): void;
/** 触摸开始时触发事件,仅适用移动设备 */
onTouchStart?(event: MapsEvent): void;
/** 鼠标移出 */
onMouseOut?(event: MapsEvent): void;
/** 鼠标经过 */
onMouseOver?(event: MapsEvent): void;
/** 鼠标抬起 */
onMouseUp?(event: MapsEvent): void;
/** 鼠标按下 */
onMouseDown?(event: MapsEvent): void;
}
interface CircleOptions {
/** 圆心位置 */
center?: LngLat;
/** 圆半径,单位:米 */
radius?: number;
/**
* (default 10) 多边形覆盖物的叠加顺序。地图上存在多个多边形覆盖物叠加时,通过该属性使级别较高的多边形覆盖物在上层显示
*/
zIndex?: number;
/** (default false) 是否将覆盖物的鼠标或touch等事件冒泡到地图上(自v1.3 新增)*/
bubble?: boolean;
/** 指定鼠标悬停时的鼠标样式,自定义cursor,IE仅支持cur/ani/ico格式,Opera不支持自定义cursor */
cursor?: string;
/**
* (default #00D3FC) 轮廓线颜色,使用16进制颜色代码赋值。默认值为#00D3FC
*/
strokeColor?: string;
/**
* (default 0.9) 轮廓线透明度,取值范围 [0,1] ,0表示完全透明,1表示不透明。默认为0.9
*/
strokeOpacity?: number;
/**
* (default 2) 轮廓线宽度
*/
strokeWeight?: number;
/**
* (default #00B2D5) 多边形填充颜色,使用16进制颜色代码赋值,如:#00B2D5
*/
fillColor?: string;
/**
* (default 0.5) 多边形填充透明度,取值范围 [0,1] ,0表示完全透明,1表示不透明。默认为0.5
*/
fillOpacity?: number;
/**
* (default false) 设置多边形是否可拖拽移动,默认为false
*/
draggable?: boolean;
/**
* 用户自定义属性,支持JavaScript API任意数据类型,如Polygon的id等
*/
extData?: any;
/**
* (default solid) 轮廓线样式,实线:solid,虚线:dashed
*/
strokeStyle?: 'solid' | 'dashed';
/**
* 勾勒形状轮廓的虚线和间隙的样式,此属性在strokeStyle 为dashed 时有效, 此属性在ie9+浏览器有效 取值:
* - 实线: [0,0,0] 虚线: [10,10],[10,10] 表示10个像素的实线和10个像素的空白(如此反复)组成的虚线
* - 点画线: [10,2,10],[10,2,10] 表示10个像素的实线和2个像素的空白 + 10个像素的实线和10个像素的空白 (如此反复)组成的虚线
*/
strokeDasharray?: Array<number>;
}
class CircleMarker extends EventListener {
constructor(opts: CircleMarkerOptions);
/** 设置圆点的半径 */
setRaius(radius: number): void;
/** 获取圆点中心 */
getCenter(): LngLat;
/** 获取圆点的半径 */
getRadius(): number;
/** 修改圆点标记的属性(样式风格,包括轮廓线、填充色等。属性详情参看CircleMarkerOptions列表) */
setOptions(optsArg: CircleMarkerOptions): void;
/** 判断指定点坐标是否在圆内 */
contains(point: LngLatLike): void;
/** 获取圆点的属性 */
getOptions(): CircleMarkerOptions;
/** 获取用户自定义属性 */
getExtData(): any;
/** 设置用户自定义属性,支持JavaScript API任意数据类型 */
setExtData(extData: any): void;
/** 获取圆形的属性 */
getOptions(): CircleMarkerOptions;
}
interface CircleMarkerEvents {
/** 隐藏 */
onHide?(): void;
/** 显示 */
onShow?(): void;
/** 鼠标经过 */
onMouseover?(event: MapsEvent): void;
/** 触摸结束时触发事件,仅适用移动设备 */
onTouchend?(event: MapsEvent): void;
/** 鼠标左键单击事件 */
onClick?(event: MapsEvent): void;
/** 触摸移动进行中时触发事件,仅适用移动设备 */
onTouchmove?(event: MapsEvent): void;
/** 鼠标右键单击事件 */
onRightclick?(event: MapsEvent): void;
/** 鼠标抬起 */
onMouseup?(event: MapsEvent): void;
/** 鼠标移出 */
onMouseout?(event: MapsEvent): void;
/** 触摸开始时触发事件,仅适用移动设备 */
onTouchstart?(event: MapsEvent): void;
/** 鼠标按下 */
onMousedown?(event: MapsEvent): void;
/** 鼠标左键双击事件 */
onDblclick?(event: MapsEvent): void;
}
interface CircleMarkerOptions {
/** 圆心位置 */
center?: LngLat;
/** 圆半径,单位:px 最大值64 */
radius?: number;
/**
* (default 10) 多边形覆盖物的叠加顺序。地图上存在多个多边形覆盖物叠加时,通过该属性使级别较高的多边形覆盖物在上层显示
*/
zIndex?: number;
/** (default false) 是否将覆盖物的鼠标或touch等事件冒泡到地图上(自v1.3 新增)*/
bubble?: boolean;
/** 指定鼠标悬停时的鼠标样式,自定义cursor,IE仅支持cur/ani/ico格式,Opera不支持自定义cursor */
cursor?: string;
/** default #00D3FC) 轮廓线颜色,使用16进制颜色代码赋值。默认值为#00D3FC */
strokeColor?: string;
/** 轮廓线透明度,取值范围 [0,1] ,0表示完全透明,1表示不透明。默认为0.9 */
strokeOpacity?: number;
/** 轮廓线宽度 */
strokeWeight?: number;
/** 多边形填充颜色,使用16进制颜色代码赋值,如:#00B2D5 */
fillColor?: string;
/** 多边形填充透明度,取值范围 [0,1] ,0表示完全透明,1表示不透明。默认为0.5 */
fillOpacity?: number;
/** 设置多边形是否可拖拽移动,默认为false */
draggable?: boolean;
/** 用户自定义属性,支持JavaScript API任意数据类型,如Polygon的id等 */
extData?: any;
}
/**
* 构造多边形对象
*/
class Ellipse extends EventListener {
constructor(opts: EllipseOptions);
/** 设置椭圆的中心点 */
setCenter(center: LngLatLike): void;
/** 设置椭圆的中心点 */
setRadius(radius: [number, number]): void;
/** 获取椭圆的圆心 */
getCenter(): LngLat;
/** 获取椭圆的半径 */
getRadius(): number;
/** 判断指定点坐标是否在椭圆内 */
contains(point: LngLatLike): void;
/** 修改椭圆属性(样式风格,包括组成椭圆轮廓线的节点、轮廓线样式等。属性详情参看Ellipse */
setOptions(optsArg: EllipseOptions): void;
/** 获取用户自定义属性 */
getExtData(): any;
/** 设置用户自定义属性,支持JavaScript API任意数据类型 */
setExtData(extData: any): void;
}
interface EllipseOptions {
/**
* 椭圆圆心
*/
center?: LngLatLike;
/**
* 椭圆的半径,用2个元素的数组表示,单位:米 如: radius: [1000, 2000] 表示横向半径是1000,纵向的半径是2000
* @default [1000,1000] 默认值
*/
radius?: [number, number];
/**
* (default 10) 椭圆覆盖物的叠加顺序。地图上存在多个多边形覆盖物叠加时,通过该属性使级别较高的多边形覆盖物在上层显示
*/
zIndex?: number;
/**
* (default false) 是否将覆盖物的鼠标或touch等事件冒泡到地图上
*/
bubble?: boolean;
/**
* 指定鼠标悬停时的鼠标样式,自定义cursor,IE仅支持cur/ani/ico格式,Opera不支持自定义cursor
*/
cursor?: string;
/**
* (default #00D3FC) 线条颜色,使用16进制颜色代码赋值。默认值为#00D3FC
*/
strokeColor?: string;
/**
* (default 0.9) 轮廓线透明度,取值范围 [0,1] ,0表示完全透明,1表示不透明。默认为0.9
*/
strokeOpacity?: number;
/**
* (default 2) 轮廓线宽度
*/
strokeWeight?: number;
/**
* (default #00B2D5) 椭圆填充颜色,使用16进制颜色代码赋值,如:#00B2D5
*/
fillColor?: string;
/**
* (default 0.5) 椭圆填充透明度,取值范围 [0,1] ,0表示完全透明,1表示不透明。默认为0.5
*/
fillOpacity?: number;
/**
* (default false) 设置椭圆是否可拖拽移动,默认为false
*/
draggable?: boolean;
/**
* 用户自定义属性,支持JavaScript API任意数据类型,如 id 等
*/
extData?: object;
/**
* (default solid) 轮廓线样式,实线:solid,虚线:dashed
*/
strokeStyle?: 'solid' | 'dashed';
/**
* 勾勒形状轮廓的虚线和间隙的样式,此属性在strokeStyle 为dashed 时有效, 此属性在ie9+浏览器有效 取值:
* - 实线: [0,0,0]
* - 虚线: [10,10],[10,10] 表示10个像素的实线和10个像素的空白(如此反复)组成的虚线
* - 点画线: [10,2,10],[10,2,10] 表示10个像素的实线和2个像素的空白 + 10个像素的实线和10个像素的空白 (如此反复)组成的虚线
*/
strokeDasharray?: Array<number>;
}
interface EllipseEvents {
/** 隐藏 */
onHide?(data: { type: string, target: any }): void;
/** 显示 */
onShow?(data: { type: string, target: any }): void;
/** 鼠标左键单击事件 */
onClick?(event: MapsEvent): void;
/** 鼠标左键双击事件 */
onDblClick?(event: MapsEvent): void;
/** 鼠标右键单击事件 */
onRightClick?(event: MapsEvent): void;
/** 鼠标经过 */
onMouseOver?(event: MapsEvent): void;
/** 触摸结束时触发事件,仅适用移动设备 */
onTouchEnd?(event: MapsEvent): void;
/** 触摸移动进行中时触发事件,仅适用移动设备 */
onTouchMove?(event: MapsEvent): void;
/** 触摸开始时触发事件,仅适用移动设备 */
onTouchStart?(event: MapsEvent): void;
/** 鼠标移出 */
onMouseOut?(event: MapsEvent): void;
/** 鼠标抬起 */
onMouseUp?(event: MapsEvent): void;
/** 鼠标按下 */
onMouseDown?(event: MapsEvent): void;
}
/**
* 构造矩形对象
*/
class Rectangle extends EventListener {
constructor(opts: RectangleOptions);
/** 设置矩形的范围 */
setBounds(bounds: Bounds): void;
/** 修改矩形属性(样式风格,包括组成矩形轮廓线的节点、轮廓线样式等。属性详情参看RectangleOptions列表) */
setOptions(optsArg: RectangleOptions): void;
/** 判断坐标是否在矩形上 */
contains(point: LngLatLike): boolean;
/** 获取矩形的中心点 */
getCenter(): LngLat;
/** 获取用户自定义属性 */
getExtData(): any;
/** 设置用户自定义属性,支持JavaScript API任意数据类型 */
setExtData(extData: any): void;
/** 获取矩形的属性 */
getOptions(): RectangleOptions;
}
interface RectangleOptions {
/** 要显示该覆盖物的地图对象 */
map?: Map;
/** 矩形的范围 */
bounds?: Bounds;
/** (default 10) 矩形覆盖物的叠加顺序。地图上存在多个矩形覆盖物叠加时,通过该属性使级别较高的矩形覆盖物在上层显示 */
zIndex?: number;
/** (default false) 是否将覆盖物的鼠标或touch等事件冒泡到地图上(自v1.3 新增) */
bubble?: boolean;
/** 指定鼠标悬停时的鼠标样式,自定义cursor,IE仅支持cur/ani/ico格式,Opera不支持自定义cursor */
cursor?: string;
/** (default #00D3FC) 线条颜色,使用16进制颜色代码赋值。默认值为 #00D3FC */
strokeColor?: string;
/** (default 0.9) 轮廓线透明度,取值范围 [0,1] ,0表示完全透明,1表示不透明。默认为0.9 */
strokeOpacity?: number;
/** (default 2) 轮廓线宽度 */
strokeWeight?: number;
/** (default #00B2D5) 矩形填充颜色,使用16进制颜色代码赋值,如:#00B2D5 */
fillColor?: string;
/** (default 0.5) 矩形填充透明度,取值范围 [0,1],0 表示完全透明,1表示不透明。默认为0.5 */
fillOpacity?: number;
/** (default false) 设置矩形是否可拖拽移动,默认为false */
draggable?: boolean;
/** 用户自定义属性,支持JavaScript API任意数据类型,如Polygon的id等 */
extData?: any;
/** (default solid) 轮廓线样式,实线:solid,虚线:dashed */
strokeStyle?: 'solid' | 'dashed';
/** 勾勒形状轮廓的虚线和间隙的样式,此属性在strokeStyle 为dashed 时有效, 此属性在 ie9+ 浏览器有效 取值:
* - 实线: [0,0,0]
* - 虚线: [10,10],[10,10] 表示10个像素的实线和10个像素的空白(如此反复)组成的虚线
* - 点画线: [10,2,10],[10,2,10] 表示10个像素的实线和2个像素的空白 + 10个像素的实线和10个像素的空白 (如此反复)组成的虚线
*/
strokeDasharray?: Array<number>;
}
interface RectangleEvents {
/** 鼠标左键单击事件 */
onClick?(event: MapsEvent): void;
/** 鼠标左键双击事件 */
onDblClick?(event: MapsEvent): void;
/** 右键单击 */
onRightClick?(event: MapsEvent): void;
/** 隐藏 */
onHide?(event: { type: string; target: any }): void;
/** 显示 */
onShow?(event: { type: string; target: any }): void;
/** 鼠标按下 */
onMouseDown?(event: MapsEvent): void;
/** 鼠标抬起 */
onMouseUp?(event: MapsEvent): void;
/** 鼠标经过 */
onMouseOver?(event: MapsEvent): void;
/** 鼠标移出 */
onMouseOut?(event: MapsEvent): void;
/** 属性发生变化时 */
onChange?(event: { type: string; target: any }): void;
/** 触摸开始时触发事件,仅适用移动设备 */
onTouchStart?(event: MapsEvent): void;
/** 触摸移动进行中时触发事件,仅适用移动设备 */
onTouchMove?(event: MapsEvent): void;
/** 触摸结束时触发事件,仅适用移动设备 */
onTouchEnd?(event: MapsEvent): void;
}
/**
* 贝塞尔曲线
*/
class BezierCurve extends EventListener {
constructor(opts: BezierCurveOptions);
/** 修改折线属性(包括路径的节点、线样式、是否绘制大地线等。属性详情参看 BezierCurveOptions 列表) */
setOptions(optsArg: BezierCurveOptions): void;
/** 获取贝塞尔曲线路径的节点数组 */
getPath(): Array<Array<number>> | Array<Array<Array<number>>>;
/**
* 设置组成该折线的节点数组
* path ((Array<Array<number>> | Array<Array<Array<number>>>)) 贝瑟尔曲线的路径。
* 描述为一个二维数组规则如下:第一个元素是起点, 之后的元素同时描述控制点和途经点,之后每个元素可以有0个到2个控制点 控制点在前,途经点在最后
* [ [lng,lat] ,
* //起点0 [lng,lat,lng,lat,lng,lat] ,
* //控制点、控制点、途经点2 [lng,lat,lng,lat] //控制点、途经点3 ] 或者 [ [ [lng,lat] ],//起点0 [ [lng,lat] , [lng,lat] ],
* //控制点、途经点1 [ [lng,lat] , [lng,lat] , [lng,lat] ],//控制点、控制点、途经点2 [ [lng,lat] , [lng,lat] ]
* //控制点、途经点3 ]
*/
setPath(path: Array<Array<number>> | Array<Array<Array<number>>>): void;
/** 获取用户自定义属性 */
getExtData(): any;
/** 设置用户自定义属性,支持JavaScript API任意数据类型 */
setExtData(extData: any): void;
/** 获取线的属性 */
getOptions(): BezierCurveOptions;
/** 判断坐标是否在曲线内 */
contains(point: LngLatLike): void;
/** 获取曲线的总长度(单位:米)*/
getLength(): number;
/** 获取当前折线的矩形范围对象 */
getBounds(): Bounds | undefined;
}
interface BezierCurveOptions {
/**
* polyline 路径,支持 lineString 和 MultiLineString
* 贝瑟尔曲线的路径。描述为一个二维数组规则如下:第一个元素是起点, 之后的元素同时描述控制点和途经点,之后每个元素可以有0个到2个控制点 控制点在前,途经点在最后
* ```js
* [
* [lng, lat],
* // 起点0
* [lng, lat, lng, lat, lng, lat],
* // 控制点、控制点、途经点2
* [lng, lat, lng, lat]
* // 控制点、途经点3
* ]
* ```
*
* 或者
*
* ```js
* [
* [[lng, lat]],
* // 起点0
* [[lng, lat], [lng, lat]],
* // 控制点、途经点1
* [[lng, lat], [lng, lat], [lng, lat]],
* // 控制点、控制点、途经点2
* [[lng, lat], [lng, lat]]
* // 控制点、途经点3
* ]
* ```
*/
path?: Array<LngLat> | Array<Array<LngLat>>;
/**
* (default 10) 多边形覆盖物的叠加顺序。地图上存在多个多边形覆盖物叠加时,通过该属性使级别较高的多边形覆盖物在上层显示
*/
zIndex?: number;
/** (default false) 是否将覆盖物的鼠标或touch等事件冒泡到地图上(自v1.3 新增) */
bubble?: boolean;
/** 指定鼠标悬停时的鼠标样式,自定义cursor,IE仅支持cur/ani/ico格式,Opera不支持自定义cursor */
cursor?: string;
/** (default #00D3FC) 线条颜色,使用16进制颜色代码赋值。默认值为#00D3FC */
strokeColor?: string;
/** (default 0.5) 轮廓线透明度,取值范围 [0,1] ,0表示完全透明,1表示不透明。默认为0.5 */
strokeOpacity?: number;
/** (default 2) 轮廓线宽度 */
strokeWeight?: number;
/** (default 2) 描边线宽度 */
borderWeight?: number;
/** (default false) 是否显示描边,默认false */
isOutline?: boolean;
/** (default 1) 描边的宽度,默认为1 */
borderWeight?: number;
/** (default #00B2D5) 线条描边颜色,此项仅在isOutline为true时有效,默认:#00B2D5 */
outlineColor?: string;
/** (default false) 设置多边形是否可拖拽移动,默认为false */
draggable?: boolean;
/** 用户自定义属性,支持JavaScript API任意数据类型,如Polygon的id等 */
extData?: any;
/** (default solid) 轮廓线样式,实线:solid,虚线:dashed */
strokeStyle?: "solid" | "dashed";
}
interface BezierCurveEvents {
/** 隐藏 */
onHide?(data: {type: string, target: any}): void;
/** 显示 */
onShow?(data: {type: string, target: any}): void;
/** 鼠标左键双击事件 */
onDblClick?(event: MapsEvent): void;
/** 鼠标经过 */
onMouseOver?(event: MapsEvent): void;
/** 鼠标抬起 */
onMouseUp?(event: MapsEvent): void;
/** 鼠标按下 */
onMouseDown?(event: MapsEvent): void;
/** 鼠标左键单击事件 */
onClick?(event: MapsEvent): void;
/** 触摸结束时触发事件,仅适用移动设备 */
onTouchEnd?(event: MapsEvent): void;
/** 触摸移动进行中时触发事件,仅适用移动设备 */
onTouchMove?(event: MapsEvent): void;
/** 触摸开始时触发事件,仅适用移动设备 */
onTouchStart?(event: MapsEvent): void;
/** 鼠标右键单击事件 */
onRightClick?(event: MapsEvent): void;
/** 鼠标移出 */
onMouseOut?(event: MapsEvent): void;
}
/** 多边形 */
class Polygon extends EventListener {
constructor(opts: PolygonOptions);
/** 设置多边形轮廓线节点数组,当为“环”多边形时,path为二维数组,数组元素为多边形轮廓线的节点坐标数组 */
setPath(path: Array<LngLat> | Array<Array<LngLat>>): void;
/** 获取多边形轮廓线节点数组。其中lat和lng是经纬度参数。 */
getPath(): Array<LngLat> | Array<Array<LngLat>>;
/** 修改多边形属性(样式风格,包括组成多边形轮廓线的节点、轮廓线样式等。属性详情参看PolygonOptions列表) */
setOptions(opt:PolygonOptions): void;
/** 获取多边形的属性 */
getOptions(): PolygonOptions;
/** 获取当前多边形的矩形范围对象。(自v1.2 新增) */
getBounds(): Bounds;
/** 获取多边形的面积(单位:平方米)(自v1.1 新增) */
getArea(): number;
/** 在指定地图上显示当前的多边形。参数取值为null时,在地图上移除当前多边形(自v1.2 新增) */
setMap(map:Map): void;
/** 设置用户自定义属性,支持JavaScript API任意数据类型,如Polygon的id等 */
setExtData(ext: any): void;
/** 获取用户自定义属性 */
getExtData(): any;
/** 判断指定点坐标是否在多边形范围内 */
contains(point: LngLat): boolean;
}
interface PolygonOptions {
/** 要显示该polygon的地图对象 */
map?: Map;
/** 多边形覆盖物的叠加顺序。地图上存在多个多边形覆盖物叠加时,通过该属性使级别较高的多边形覆盖物在上层显示 默认zIndex:10 */
zIndex?: number;
/** 多边形轮廓线的节点坐标数组,当为“环”多边形时(多边形区域在多边形内显示为“岛”),path为二维数组,数组元素为多边形轮廓线的节点坐标数组, “环”多边形时,要求数组第一个元素为外多边形,其余为“岛”多边形,外多边形需包含“岛”多边形,否则程序不作处理 */
path?: Array<LngLat> | Array<Array<LngLat>>;
/** 是否将覆盖物的鼠标或touch等事件冒泡到地图上(自v1.3 新增)默认值:false */
bubble?: boolean;
/** 指定鼠标悬停时的鼠标样式,自定义cursor,IE仅支持cur/ani/ico格式,Opera不支持自定义cursor */
cursor?: string;
/** 线条颜色,使用16进制颜色代码赋值。默认值为#006600 */
strokeColor?: string;
/** 轮廓线透明度,取值范围[0,1],0表示完全透明,1表示不透明。默认为0.9 */
strokeOpacity?: number;
/** 轮廓线宽度 */
strokeWeight?: number;
/** 多边形填充颜色,使用16进制颜色代码赋值,如:#FFAA00 */
fillColor?: string;
/** 多边形填充透明度,取值范围[0,1],0表示完全透明,1表示不透明。默认为0.9 */
fillOpacity?: number;
/** 设置多边形是否可拖拽移动,默认为false */
draggable?: boolean;
/** 用户自定义属性,支持JavaScript API任意数据类型,如Polygon的id等 */