-
Notifications
You must be signed in to change notification settings - Fork 0
/
lib.wx.std.d.ts
3028 lines (2942 loc) · 113 KB
/
lib.wx.std.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 no-default-lib="true"/>
/// <reference path="lib.wx.es6.d.ts" />
/** @description weixin mini program api type declaration */
declare namespace wx {
interface IAnyObject {
[key: string]: any;
}
interface BaseParams {
/**接口调用失败的回调函数 */
fail?: (res?: any) => void;
/**接口调用成功的回调函数 */
success?: (res?: any) => void;
/**接口调用结束的回调函数(调用成功/失败都会执行) */
complete?: (res?: any) => void;
}
interface ErrmsgParams extends BaseParams {
success?: (res?: { errMsg: string }) => void;
}
type HttpMethod = 'OPTIONS' | 'GET' | 'HEAD' | 'POST' | 'PUT' | 'DELETE' | 'TRACE' | 'CONNECT';
interface RequestParams extends BaseParams {
/**开发者服务器接口地址 */
url: string;
/**请求的参数 */
data?: Object | string;
/**设置请求的 header,header 中不能设置 Referer */
header?: Object;
/**默认为 GET 有效值:OPTIONS,GET,HEAD,POST,PUT,DELETE,TRACE,CONNECT */
method?: HttpMethod;
/**如果设为json 会尝试对返回的数据做一次 JSON.parse */
dataType?: string;
/**
* @description 设置响应的数据类型
* @since 1.7.0
*/
responseType?: 'text' | 'arraybuffer';
/**收到开发者服务成功返回的回调函数 res = { data: '开发者服务器返回的内容' } */
success?: (res?: HttpResponse) => void;
complete?: (res?: HttpResponse) => void;
}
interface RequestTask {
abort(): never;
onHeadersReceived: (callback: (headers: any) => void) => never;
}
interface HttpHeader {
/**GTM time str */
Date: string;
Allow: string;
ContentType: string;
ContentLength: string;
[key: string]: string;
}
interface HttpResponse {
data?: any | string | ArrayBuffer;
errMsg: string;
statusCode: number;
header?: HttpHeader;
}
interface UploadProgress {
progress: number;
totalBytesSent: number;
totalBytesExpectedToSend: number;
}
interface UploadTask extends RequestTask {
onProgressUpdate?: (callback: (res: UploadProgress) => void) => never;
}
interface UploadParam extends BaseParams {
/**开发者服务器 url */
url: string;
/**要上传文件资源的路径 */
filePath: string;
/**文件对应的 key , 开发者在服务器端通过这个 key 可以获取到文件二进制内容 */
name: string;
/**HTTP 请求 Header , header 中不能设置 Referer */
header?: Object;
/**HTTP 请求中其他额外的 form data */
formData?: Object;
}
interface DownloadProgress {
progress: number;
totalBytesWritten: number;
totalBytesExpectedToWrite: number;
}
interface DownloadTask extends RequestTask {
onProgressUpdate?: (callback: (res: DownloadProgress) => void) => never;
}
interface DownloadParam extends BaseParams {
/**下载资源的 url */
url: string;
/** image|audio|video */
type?: string;
/**HTTP 请求 Header */
header?: Object;
/** 下载成功后以 tempFilePath 的形式传给页面 res = { tempFilePath: '文件的临时路径' } */
success?: (res?: { tempFilePath: string }) => void;
}
interface ConnectSocketParam extends BaseParams {
/**开发者服务器接口地址 必须是 HTTPS 协议 且域名必须是后台配置的合法域名 */
url: string;
/**请求的数据 */
data?: Object;
/** HTTP Header header 中不能设置 Referer */
header?: Object;
/**默认是GET 有效值为: OPTIONS,GET,HEAD,POST,PUT,DELETE,TRACE,CONNECT */
method?: string;
/**子协议数组 */
protocols?: Array<string>;
}
interface SocketTask {
send(send: SocketMessage & BaseParams): void;
close(close: SocketClose & BaseParams): void;
onOpen(callback: (res: any) => void): void;
onClose(callback: (res: SocketClose) => void): void;
onError(callback: (res: SocketError) => void): void;
onMessage(callback: (res: SocketMessage) => void): void;
}
interface SocketError {
errMsg: string;
}
interface SocketClose extends BaseParams {
/**关闭状态码 默认1000表示正常关闭 */
code?: number;
/**一个可读的字符串 表示连接被关闭的原因 这个字符串必须是不长于123字节的UTF-8 文本 */
reason?: string;
}
interface SocketMessage {
data: string | ArrayBuffer;
}
interface ChooseImageParam extends BaseParams {
/**最多可以选择的图片张数 默认9 */
count?: number;
/**original 原图 compressed 压缩图 默认二者都有 */
sizeType?: Array<string>;
/**album 从相册选图 camera 使用相机 默认二者都有 */
sourceType?: Array<string>;
}
interface PreviewImageParam extends BaseParams {
/**当前显示图片的链接 不填则默认为 urls 的第一张 */
current?: string;
/**需要预览的图片链接列表 */
urls: Array<string>;
}
interface ImageInfoParam extends BaseParams {
/**图片的路径 可以是相对路径 临时文件路径 存储文件路径 */
src: string;
success?: (res?: { width: number; height: number; path: string; orientation: string; type: string }) => void;
}
interface RecordParam extends BaseParams {
duration?: number;
success?: (res?: { tempFilePath: string }) => void;
}
interface RecorderManager {
/**开始录音 */
start(options: RecorderManagerStartOption): void;
/**暂停录音 */
pause(): void;
/**继续录音 */
resume(): void;
/**停止录音 */
stop(): void;
/**录音开始事件 */
onStart: () => void;
/**录音暂停事件 */
onPause: () => void;
/**录音停止事件 会回调文件地址 */
onStop: (res?: { tempPath: string }) => void;
/**已录制完指定帧大小的文件 会回调录音分片结果数据。如果设置了 frameSize 则会回调此事件 */
onFrameRecorded: (res?: { frameBuffer: ArrayBuffer; isLastFrame: boolean }) => void;
/**录音错误事件 会回调错误信息 */
onError: (res?: { errMsg: string }) => void;
}
interface RecorderManagerStartOption {
/**
* 指定录音的时长 单位 ms 如果传入了合法的 duration 在到达指定的 duration 后会自动停止录音 最大值 600000(10 分钟),默认值 60000(1分钟)
*/
duration?: number;
/**采样率 */
sampleRate?: 8000 | 16000 | 44100;
/**录音通道数 */
numberOfChannels?: 1 | 2;
encodeBitRate?: 8000 | 11025 | 12000 | 16000 | 22050 | 24000 | 32000 | 44100 | 48000;
/**音频格式 */
format?: 'aac' | 'mp3';
/**指定帧大小 单位 KB 传入 frameSize 后 每录制指定帧大小的内容后 会回调录制的文件内容 不指定则不会回调 暂仅支持 mp3 格式 */
frameSize?: number;
}
interface VoiceParam extends BaseParams {
/**需要播放的语音文件的文件路径 */
filePath: string;
}
interface GetBackgroundAudioPlayerStateParam extends BaseParams {
success?: (res?: BackgroundAudioPlayerState) => void;
}
interface BackgroundAudioPlayerState {
/**选定音频的长度 单位:s 只有在当前有音乐播放时返回 */
duration: number;
/**选定音频的播放位置 单位:s 只有在当前有音乐播放时返回 */
currentPosition: number;
/** 播放状态 2:没有音乐在播放 1:播放中 0:暂停中 */
status: number;
/**音频的下载进度 整数 80 代表 80% 只有在当前有音乐播放时返回 */
downloadPercent: number;
/**歌曲数据链接 只有在当前有音乐播放时返回 */
dataUrl: string;
}
interface PlayBackgroundAudioParam extends BaseParams {
/**音乐链接 */
dataUrl: string;
/**音乐标题 */
title?: string;
/**封面URL */
coverImgUrl?: string;
}
interface SeekBackgroundAudioParam extends BaseParams {
/**音乐位置 单位:秒 */
position: number;
}
interface SaveFileParam extends BaseParams {
/**需要保存的文件的临时路径 */
tempFilePath: string;
success?: (res?: { savedFilePath?: string }) => void;
}
interface FileListParam extends BaseParams {
success?: (res?: { errMsg: string; fileList: Array<FileInfo> }) => void;
}
interface FileInfo {
/**文件的本地路径 */
filePath: string;
/**文件的保存时的时间戳 从1970/01/01 08:00:00到当前时间的秒数 */
createTime: number;
/**文件大小 单位B */
size: number;
}
interface FileInfoParam extends BaseParams {
/**文件路径 */
filePath: string;
success?: (res?: { errMsg: string; size: number; createTime: number }) => void;
}
interface RemoveFileParam extends BaseParams {
/**需要删除的文件路径 */
filePath: string;
}
interface OpenDocumentParam extends BaseParams {
/**文件路径 可通过 downFile 获得 */
filePath: string;
/**文件类型 指定文件类型打开文件 */
fileType?: 'doc' | 'xls' | 'ppt' | 'pdf' | 'docx' | 'xlsx' | 'pptx';
}
interface ChooseVideoParam extends BaseParams {
/**album 从相册选视频 camera 使用相机拍摄 默认为:['album', 'camera'] */
sourceType?: Array<string>;
/**
* 默认为true
*/
compressed?: boolean;
/**拍摄视频最长拍摄时间 单位秒 最长支持60秒 */
maxDuration?: number;
/**前置或者后置摄像头 默认为前后都有 即:['front', 'back'] */
camera?: Array<string>;
/**接口调用成功 返回视频文件的临时文件路径 */
success?: (res?: VideoInfo) => void;
}
interface AudioContext {
/**设置音频的地址 */
setSrc(src: string): void;
/**播放 */
play(): void;
/**暂停 */
pause(): void;
/**跳转到指定位置 单位 s */
seek(position: number): void;
}
interface InnerAudioContext {
/**音频的数据链接 用于直接播放 */
src: string;
/**开始播放的位置 单位:s 默认 0 */
startTime: number;
/**是否自动开始播放 默认 false */
autoplay: boolean;
/**是否循环播放 默认 false */
loop: boolean;
/**是否遵循系统静音开关 当此参数为 false 时 即使用户打开了静音开关 也能继续发出声音 默认值 true */
obeyMuteSwitch: boolean;
/**当前音频的长度 单位:s 只有在当前有合法的 src 时返回 */
readonly duration: number;
/**当前音频的播放位置 单位:s 只有在当前有合法的 src 时返回 时间不取整 保留小数点后 6 位 */
readonly currentTime: number;
/**当前是是否暂停或停止状态 true 表示暂停或停止 false 表示正在播放 */
readonly paused: boolean;
/**音频缓冲的时间点 仅保证当前播放时间点到此时间点内容已缓冲 */
readonly buffered: number;
/**播放 */
play(): void;
/**暂停 */
pause(): void;
/**停止 */
stop(): void;
/**跳转到指定位置 单位 s */
seek(position: number): void;
/**销毁当前实例 */
destroy(): void;
/**音频进入可以播放状态 但不保证后面可以流畅播放 */
onCanplay: () => void;
/**音频播放事件 */
onPlay: () => void;
/**音频暂停事件 */
onPause: () => void;
/**音频停止事件 */
onStop: () => void;
/**音频自然播放结束事件 */
onEnded: () => void;
/**音频播放进度更新事件 */
onTimeUpdate: () => void;
/**音频播放错误事件 */
onError: () => void;
/**音频加载中事件 当音频因为数据不足 需要停下来加载时会触发 */
onWaiting: () => void;
/**音频进行 seek 操作事件 */
onSeeking: () => void;
/**音频完成 seek 操作事件 */
onSeeked: () => void;
}
interface VideoContext {
/**播放 */
play(): never;
/**暂停 */
pause(): never;
/**跳转到指定位置 单位 s */
seek(position: number): never;
/**发送弹幕 danmu 包含两个属性 text,color */
sendDanmu(danmu: { text: string; color: string }): never;
/**设置倍速播放 支持的倍率有 0.5/0.8/1.0/1.25/1.5 */
playbackRate(rate: number): never;
/**进入全屏 */
requestFullScreen(): never;
/**退出全屏 */
exitFullScreen(): never;
}
interface VideoInfo {
/**选定视频的临时文件路径 */
tempFilePath: string;
/**选定视频的时间长度 */
duration: number;
/**选定视频的数据量大小 */
size: number;
/**返回选定视频的长 */
height: number;
/**返回选定视频的宽 */
width: number;
}
interface CameraContext {
/**拍照 可指定质量 成功则返回图片 */
takePhoto(param: CameraContextTakePhotoParam): void;
/**开始录像 */
startRecord(param: CameraContextStartRecordParam): void;
/**结束录像 成功则返回封面与视频 */
stopRecord(param: CameraContextStopRecord): void;
}
interface CameraContextTakePhotoParam extends BaseParams {
/**成像质量 值为high, normal, low 默认normal */
quality?: 'high' | 'normal' | 'low';
success?: (res?: { tempImagePath: string }) => void;
}
interface CameraContextStartRecordParam extends BaseParams {
/**超过30s或页面onHide时会结束录像 */
timeoutCallback?: (res?: { tempThumbPath: string; tempVideoPath: string }) => void;
}
interface CameraContextStopRecord extends BaseParams {
success?: (res?: { tempThumbPath: string; tempVideoPath: string }) => void;
}
interface SetStorageParam extends BaseParams {
/**本地缓存中的指定的 key */
key: string;
/**需要存储的内容 */
data: any;
}
interface GetStorageParam extends BaseParams {
/**本地缓存中的指定的 key */
key: string;
success: (res?: { data: any }) => void;
}
interface RemoveStorageParam extends BaseParams {
key: string;
success?: (res?: { data: any }) => void;
}
interface StorageInfoParam extends BaseParams {
success: (res?: { data: StorageInfo }) => void;
}
interface StorageInfo {
/**当前storage中所有的key */
keys: Array<string>;
/**当前占用的空间大小 单位kb */
currentSize: number;
/**限制的空间大小 单位kb */
limitSize: number;
}
interface GetLocationParam extends BaseParams {
/**默认为 wgs84 返回 gps 坐标 gcj02 返回可用于wx.openLocation的坐标 */
type?: string;
/**接口调用成功的回调函数 */
success: (res?: LocationInfo) => void;
}
interface TranslateMarkerParam extends BaseParams {
/**指定marker */
markerId: number;
/**指定marker移动到的目标点 */
destination: any;
/**移动过程中是否自动旋转marker */
autoRotate: boolean;
/**marker的旋转角度 */
rotate: number;
/**动画持续时长 默认值1000ms 平移与旋转分别计算 */
duration?: number;
/**动画结束回调函数 */
animationEnd?: Function;
}
interface LocationInfo {
/**纬度 浮点数 范围为 -90~90 负数表示南纬 */
latitude: number;
/**经度 浮点数 范围为 -180~180 负数表示西经 */
longitude: number;
/**速度 浮点数 单位 m/s */
speed: number;
/**位置的精确度 */
accuracy: number;
/**高度 单位 m */
altitude: number;
/**垂直精度 单位 m Android 无法获取 返回 0 */
verticalAccuracy: number;
/**水平精度 单位 m */
horizontalAccuracy: number;
}
interface OpenLocationParam extends BaseParams {
/**纬度 范围为 -90~90 负数表示南纬 */
latitude: number;
/**经度 范围为 -180~180 负数表示西经 */
longitude: number;
/**缩放比例 范围1~28 默认为28 */
scale?: number;
/**位置名 */
name?: string;
/**地址的详细说明 */
address?: string;
}
interface ChooseLocationParam extends BaseParams {
success: (res?: ChoosedLoaction) => void;
}
interface ChoosedLoaction {
/**位置名称 */
name: string;
/**详细地址 */
address: string;
/**纬度 浮点数 范围为-90~90 负数表示南纬 */
latitude: number;
/**经度 浮点数 范围为-180~180 负数表示西经 */
longitude: number;
}
interface NetworkTypeParam extends BaseParams {
success: (res?: { /**返回网络类型2g|3g|4g|wifi */ networkType: string }) => void;
}
interface SystemInfoParam extends BaseParams {
success: (res?: SystemInfo) => void;
}
interface SystemInfo {
/**手机品牌 */
brand: string;
/**手机型号 */
model: string;
/**设备像素比 */
pixelRatio: string;
/**窗口宽度 */
windowWidth: number;
/**窗口高度 */
windowHeight: number;
/**微信设置的语言 */
language: string;
/**微信版本号 */
version: string;
/**操作系统版本 */
system: string;
/**客户端平台 */
platform: string;
/**屏幕宽度 */
screenWidth: number;
/**屏幕高度 */
screenHeight: number;
/**用户字体大小设置 */
fontSizeSetting: string;
/**客户端基础库版本 */
SDKVersion: string;
}
interface AccelerometerInfo {
/**X 轴 */
x: number;
/**Y 轴 */
y: number;
/**Z 轴 */
z: number;
}
interface CompassInfo {
/**面对的方向度数 */
direction: number;
}
interface PhoneCallParam extends BaseParams {
/**需要拨打的电话号码 */
phoneNumber: string;
success?: () => void;
}
interface ToastParam extends BaseParams {
/**提示的内容 */
title: string;
/**图标 只支持 success|loading|none */
icon?: 'success' | 'loading' | 'none';
/**自定义图标的本地路径 image 的优先级高于 icon */
image?: string;
/**提示的延迟时间 单位毫秒 默认 1500 最大为10000 */
duration?: number;
/**是否显示透明蒙层 防止触摸穿透 默认 false */
mask?: boolean;
}
interface ModalParam extends BaseParams {
/**提示的标题 */
title: string;
/**提示的内容 */
content: string;
/**是否显示取消按钮 默认为 false */
showCancel?: boolean;
/**取消按钮的文字 默认为 取消 最多 4 个字符 */
cancelText?: string;
/**取消按钮的文字颜色 默认为 #000000 */
cancelColor?: string;
/**确定按钮的文字 默认为 确定 最多 4 个字符 */
confirmText?: string;
/**确定按钮的文字颜色 默认为 #3CC51F */
confirmColor?: string;
/**
* 接口调用成功的回调函数
* 返回res.confirm==1时 表示用户点击确定按钮
*/
success?: (res?: { confirm: boolean; cancel: boolean }) => void;
}
interface ActionSheetParam extends BaseParams {
/**按钮的文字数组 数组长度最大为10个 */
itemList: Array<string>;
/**按钮的文字颜色 默认为 #000000 */
itemColor?: string;
success?: (res?: ActionSheetResponse) => void;
}
interface ActionSheetResponse {
/**用户是否取消选择 */
cancel: boolean;
/**用户点击的按钮 从上到下的顺序 从0开始 */
tapIndex: number;
}
interface TopBarTextParam extends BaseParams {
/**置顶栏文字内容 */
text: string;
}
interface NavigationBarTitleParam extends BaseParams {
/**页面标题 */
title?: string;
}
interface NavigateToParam extends BaseParams {
/**需要跳转的应用内页面的路径 */
url: string;
}
interface TabbarIndexOption extends BaseParams {
/**从左往右的索引 */
index: number;
}
interface TabbarItemOption extends TabbarIndexOption {
/**title 文字 */
text?: string;
/**常规图片路径 建议尺寸81*61 要求为本地图片的绝对路径 */
iconPath?: string;
/**选中图片路径 建议尺寸81*61 要求为本地图片的绝对路径 */
selectedIconPath?: string;
}
interface TabbarStyleOption extends BaseParams {
/**文字颜色 hexColor */
color: number;
/**选中色 hexColor 文字 */
selectedColor: string;
/**背景色 hexColor */
backgroundColor: string;
/**选中图片路径 建议尺寸81*61 要求为本地图片的绝对路径 */
borderStyle: 'black' | 'white';
}
interface TabbarDisplayOption extends BaseParams {
/**默认false */
animation?: boolean;
}
interface TabbarBadgeOption extends TabbarIndexOption {
/**badge 内容 */
text: string;
}
interface BackgroundColorOption extends BaseParams {
/**窗口背景色 */
backgroundColor: string;
/**16进制 颜色 仅IOS 支持 */
backgroundColorTop: string;
/**16进制 颜色 仅IOS 支持 */
backgroundColorBottom: string;
}
interface AnimationParam {
/**动画持续时间 单位ms 默认值 400 */
duration?: number;
/**定义动画的效果 默认值 linear 有效值 linear,ease,ease-in,ease-in-out,ease-out,step-start,step-end */
timingFunction?: string;
/**动画延迟时间 单位 ms 默认值 0 */
delay?: string;
/**设置transform- origin 默认为"50% 50% 0" */
transformOrigin?: string;
}
/**
* 动画实例可以调用以下方法来描述动画
* 调用结束后会返回自身
* 支持链式调用的写法
*/
interface Animation {
/**
* 通过动画实例的export方法导出动画数据传递给组件的animation属性
* export 方法每次调用后会清掉之前的动画操作
*/
export(): void;
/**
* 调用动画操作方法后要调用 step() 来表示一组动画完成
* 可以在一组动画中调用任意多个动画方法
* 一组动画中的所有动画会同时开始
* 一组动画完成后才会进行下一组动画
* step 可以传入一个跟 wx.createAnimation() 一样的配置参数用于指定当前组动画的配置
*/
step(): void;
/**
* 透明度
* @param value 参数范围 0~1
*/
opacity(value: number): Animation;
/**颜色值 */
backgroundColor(color: string): Animation;
/**
* 长度值
* @param length 如果传入 Number 则默认使用 px 可传入其他自定义单位的长度值
*/
width(length: number | string): Animation;
/**
* 长度值
* @param length 如果传入 Number 则默认使用 px 可传入其他自定义单位的长度值
*/
height(length: number | string): Animation;
/**
* 长度值
* @param length 如果传入 Number 则默认使用 px 可传入其他自定义单位的长度值
*/
top(length: number | string): Animation;
/**
* 长度值
* @param length 如果传入 Number 则默认使用 px 可传入其他自定义单位的长度值
*/
left(length: number | string): Animation;
/**
* 长度值
* @param length 如果传入 Number 则默认使用 px 可传入其他自定义单位的长度值
*/
bottom(length: number | string): Animation;
/**
* 长度值
* @param length 如果传入 Number 则默认使用 px 可传入其他自定义单位的长度值
*/
right(length: number | string): Animation;
/**deg的范围-180~180 从原点顺时针旋转一个deg角度 */
rotate(deg: number): Animation;
/**deg的范围-180~180 在X轴旋转一个deg角度 */
rotateX(deg: number): Animation;
/**deg的范围-180~180 在Y轴旋转一个deg角度 */
rotateY(deg: number): Animation;
/**deg的范围-180~180 在Z轴旋转一个deg角度 */
rotateZ(deg: number): Animation;
rotate3d(x: number, y: number, z: number, deg: number): Animation;
/**一个参数时 表示在X轴 Y轴同时缩放sx倍数 两个参数时表示在X轴缩放sx倍数 在Y轴缩放sy倍数 */
scale(sx: number, sy?: number): Animation;
/**在X轴缩放sx倍数 */
scaleX(sx: number): Animation;
/**在Y轴缩放sy倍数 */
scaleY(sy: number): Animation;
/**在Z轴缩放sz倍数 */
scaleZ(sz: number): Animation;
/**在X轴缩放sx倍数 在Y轴缩放sy倍数 在Z轴缩放sz倍数 */
scale3d(sx: number, sy: number, sz: number): Animation;
/**一个参数时 表示在X轴偏移tx 单位px 两个参数时 表示在X轴偏移tx 在Y轴偏移ty 单位px */
translate(tx: number, ty?: number): Animation;
/**在X轴偏移tx 单位px */
translateX(tx: number): Animation;
/**在Y轴偏移tx 单位px */
translateY(ty: number): Animation;
/**在Z轴偏移tx 单位px */
translateZ(tz: number): Animation;
/**在X轴偏移tx 在Y轴偏移ty 在Z轴偏移tz 单位px */
translate3d(tx: number, ty: number, tz: number): Animation;
/**参数范围-180~180 一个参数时 Y轴坐标不变 X轴坐标延顺时针倾斜ax度 两个参数时 分别在X轴倾斜ax度 在Y轴倾斜ay度 */
skew(ax: number, ay?: number): Animation;
/**参数范围-180~180 Y轴坐标不变 X轴坐标延顺时针倾斜ax度 */
skewX(ax: number): Animation;
/**参数范围-180~180 X轴坐标不变 Y轴坐标延顺时针倾斜ay度 */
skewY(ay: number): Animation;
matrix(a: number, b: number, c: number, d: number, tx: number, ty: number): Animation;
matrix3d(a1: number, b1: number, c1: number, d1: number, a2: number, b2: number, c2: number, d2: number, a3: number, b3: number, c3: number, d3: number, a4: number, b4: number, c4: number, d4: number): void;
}
/**
* context只是一个记录方法调用的容器
* 用于生成记录绘制行为的actions数组
* context跟<canvas/>不存在对应关系
* 一个context生成画布的绘制动作数组可以应用于多个<canvas/>
*/
interface CanvasContext {
/**获取当前context上存储的绘图动作 */
getActions(): Array<any>;
/**清空当前的存储绘图动作 */
clearActions(): void;
/**
* 对横纵坐标进行缩放
* 在调用scale方法后
* 之后创建的路径其横纵坐标会被缩放
* 多次调用scale 倍数会相乘
* @param scaleWidth 横坐标缩放的倍数
* 1=100% 0.5=50% 2=200% 依次类推
* @param scaleHeight 纵坐标轴缩放的倍数
* 1=100% 0.5=50% 2=200% 依次类推
*/
scale(scaleWidth: number, scaleHeight: number): void;
/**
* 对坐标轴进行顺时针旋转
* 以原点为中心
* 原点可以用 translate方法修改
* 顺时针旋转当前坐标轴
* 多次调用rotate
* 旋转的角度会叠加
* @param rotate 旋转角度 以弧度计
* degrees*Math.PI/180 degrees范围为0~360
*/
rotate(rotate: number): void;
/**
* 对坐标原点进行缩放
* 对当前坐标系的原点(0,0)进行变换
* 默认的坐标系原点为页面左上角
* @param x 水平坐标平移量
* @param y 竖直坐标平移量
*/
translate(x: number, y: number): void;
/** [CanvasContext.createPattern(string image, string repetition)](CanvasContext.createPattern.md)
*
* 对指定的图像创建模式的方法,可在指定的方向上重复元图像
* @param repetition 如何重复图像
* @param image 重复的图像源,仅支持包内路径和临时路径
* 最低基础库: `1.9.90` */
createPattern(repetition: string, image: string): void;
/** [Object CanvasContext.measureText(string text)](CanvasContext.measureText.md)
*
* 测量文本尺寸信息。目前仅返回文本宽度。同步接口。
*
* 最低基础库: `1.9.90` */
measureText(text: string): { width: number };
/** [CanvasContext.save()](CanvasContext.save.md)
*
* 保存绘图上下文。
*
* **示例代码**
*
* ```javascript
*
* const ctx = wx.createCanvasContext('myCanvas')
*
* // save the default fill style
*
* ctx.save()
*
* ctx.setFillStyle('red')
*
* ctx.fillRect(10, 10, 150, 100)
*
* // restore to the previous saved state
*
* ctx.restore()
*
* ctx.fillRect(50, 50, 150, 100)
*
* ctx.draw()
*
* ```
*
* ![]((canvas/save-restore.png)) */
save(): void;
/** [CanvasContext.restore()](CanvasContext.restore.md)
*
* 恢复之前保存的绘图上下文。
*
* **示例代码**
*
* ```javascript
*
* const ctx = wx.createCanvasContext('myCanvas')
*
* // save the default fill style
*
* ctx.save()
*
* ctx.setFillStyle('red')
*
* ctx.fillRect(10, 10, 150, 100)
*
* // restore to the previous saved state
*
* ctx.restore()
*
* ctx.fillRect(50, 50, 150, 100)
*
* ctx.draw()
*
* ```
*
* ![]((canvas/save-restore.png)) */
restore(): void;
/**
* 在给定的矩形区域内 清除画布上的像素
* @param x 矩形区域左上角的x坐标
* @param y 矩形区域左上角的y坐标
* @param width 矩形区域的宽度
* @param height 矩形区域的高度
*/
clearRect(x: number, y: number, width: number, height: number): void;
/**
* 在画布上绘制被填充的文本
* @param text 在画布上输出的文本
* @param x 绘制文本的左上角x坐标位置
* @param y 绘制文本的左上角y坐标位置
*/
fillText(text: string, x?: number, y?: number, maxWidth?: number): void;
/**
* 给定的 (x, y) 位置绘制文本描边的方法
* @param text 在画布上输出的文本
* @param x 绘制文本的左上角x坐标位置
* @param y 绘制文本的左上角y坐标位置
*/
strokeText(text: string, x?: number, y?: number, maxWidth?: number): void;
/**
* 在画布上绘制图像 图像保持原始尺寸
* @param imageResource 通过chooseImage得到一个文件路径或者一个项目目录内的图片 所要绘制的图片资源
* @param x 图像左上角的x坐标
* @param y 图像左上角的y坐标
* @param width 图像宽度
* @param height 图像高度
*/
drawImage(imageResource: string, x?: number, y?: number, width?: number, height?: number): void;
/**对当前路径进行填充 */
fill(): void;
/**对当前路径进行描边 */
stroke(): void;
beginPath(): void;
/**关闭一个路径 */
closePath(): void;
/** [CanvasContext.moveTo(number x, number y)](CanvasContext.moveTo.md)
*
* 把路径移动到画布中的指定点,不创建线条。用 `stroke` 方法来画线条
*
* **示例代码**
*
* ```javascript
*
* const ctx = wx.createCanvasContext('myCanvas')
*
* ctx.moveTo(10, 10)
*
* ctx.lineTo(100, 10)
*
* ctx.moveTo(10, 50)
*
* ctx.lineTo(100, 50)
*
* ctx.stroke()
*
* ctx.draw()
*
* ```
*
* ![]((canvas/move-to.png)) */
moveTo(x: number, y: number): void;
/** [CanvasContext.lineTo(number x, number y)](CanvasContext.lineTo.md)
*
* 增加一个新点,然后创建一条从上次指定点到目标点的线。用 `stroke` 方法来画线条
*
* **示例代码**
*
* ```javascript
*
* const ctx = wx.createCanvasContext('myCanvas')
*
* ctx.moveTo(10, 10)
*
* ctx.rect(10, 10, 100, 50)
*
* ctx.lineTo(110, 60)
*
* ctx.stroke()
*
* ctx.draw()
*
* ```
*
* ![]((canvas/line-to.png)) */
lineTo(x: number, y: number): void;
/** [CanvasContext.rect(number x, number y, number width, number height)](CanvasContext.rect.md)
*
* 创建一个矩形路径。需要用 [`fill`]((CanvasContext.fill)) 或者 [`stroke`]((CanvasContext.stroke)) 方法将矩形真正的画到 `canvas` 中
*
* **示例代码**
*
* ```javascript
*
* const ctx = wx.createCanvasContext('myCanvas')
*
* ctx.rect(10, 10, 150, 75)
*
* ctx.setFillStyle('red')
*
* ctx.fill()
*
* ctx.draw()
*
* ```
*
* ![]((canvas/fill-rect.png))
* @param x 矩形路径左上角的x坐标
* @param y 矩形路径左上角的y坐标
* @param width 矩形路径的宽度
* @param height 矩形路径的高度
*/
rect(x: number, y: number, width: number, height: number): void;
/** [CanvasContext.arc(number x, number y, number r, number sAngle, number eAngle, number counterclockwise)](CanvasContext.arc.md)
*
* 创建一条弧线。
*
* - 创建一个圆可以指定起始弧度为 0,终止弧度为 2 * Math.PI。
*
* - 用 `stroke` 或者 `fill` 方法来在 `canvas` 中画弧线。
*
* **示例代码**
*
* ```javascript
*
* const ctx = wx.createCanvasContext('myCanvas')
*
* // Draw coordinates
*
* ctx.arc(100, 75, 50, 0, 2 * Math.PI)
*
* ctx.setFillStyle('#EEEEEE')
*
* ctx.fill()
*
* ctx.beginPath()
*
* ctx.moveTo(40, 75)
*
* ctx.lineTo(160, 75)
*
* ctx.moveTo(100, 15)
*
* ctx.lineTo(100, 135)
*
* ctx.setStrokeStyle('#AAAAAA')
*
* ctx.stroke()
*
* ctx.setFontSize(12)
*
* ctx.setFillStyle('black')
*
* ctx.fillText('0', 165, 78)
*
* ctx.fillText('0.5*PI', 83, 145)
*
* ctx.fillText('1*PI', 15, 78)
*
* ctx.fillText('1.5*PI', 83, 10)
*
* // Draw points