forked from svgdotjs/svg.js
-
Notifications
You must be signed in to change notification settings - Fork 0
/
svg.js.d.ts
1995 lines (1786 loc) · 52.3 KB
/
svg.js.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
// Type definitions for @svgdotjs version 3.x
// Project: @svgdotjs/svg.js
// trick to keep reference to Array build-in type
declare class BuiltInArray<T> extends Array<T> {}
// camelCase to kebab-case
declare type CamelToKebab<S extends string> = S extends `${infer T}${infer U}`
? U extends Uncapitalize<U>
? `${Lowercase<T>}${CamelToKebab<U>}`
: `${Lowercase<T>}-${CamelToKebab<U>}`
: S;
declare type ConvertKeysToKebab<T> = {
[K in keyof T as CamelToKebab<K & string>]: T[K];
};
declare type KebabCSSStyleDeclaration = ConvertKeysToKebab<CSSStyleDeclaration>
// trick to have nice attribute list for CSS
declare type CSSStyleName = Exclude<
keyof KebabCSSStyleDeclaration,
'parent-rule' | 'length'
>
// create our own style declaration that includes css vars
interface CSSStyleDeclarationWithVars extends KebabCSSStyleDeclaration {
[key: `--${string}`]: string
}
declare module '@svgdotjs/svg.js' {
function SVG(): Svg
/**
* @param selectorOrHtml pass in a css selector or an html/svg string
* @param isHTML only used if first argument is an html string. Will treat the svg/html as html and not svg
*/
function SVG(selectorOrHtml: QuerySelector, isHTML?: boolean): Element
function SVG<T>(el: T): SVGTypeMapping<T>
function SVG(domElement: HTMLElement): Element
function eid(name: string): string
function get(id: string): Element
function create(name: string): any
function extend(parent: object, obj: object): void
function invent(config: object): any
function adopt(node: HTMLElement): Element
function prepare(element: HTMLElement): void
function getClass(name: string): Element
function on(
el: Node | Window,
events: string,
cb: EventListener,
binbind?: any,
options?: AddEventListenerOptions
): void
function on(
el: Node | Window,
events: Event[],
cb: EventListener,
binbind?: any,
options?: AddEventListenerOptions
): void
function off(
el: Node | Window,
events?: string,
cb?: EventListener | number,
options?: AddEventListenerOptions
): void
function off(
el: Node | Window,
events?: Event[],
cb?: EventListener | number,
options?: AddEventListenerOptions
): void
function dispatch(
node: Node | Window,
event: Event,
data?: object,
options?: object
): Event
function find(query: QuerySelector): List<Element>
function findOne(query: QuerySelector): Element | null
function getWindow(): Window
function registerWindow(win: Window, doc: Document): void
function restoreWindow(): void
function saveWindow(): void
function withWindow(
win: Window,
fn: (win: Window, doc: Document) => void
): void
let utils: {
map(array: any[], block: Function): any
filter(array: any[], block: Function): any
radians(d: number): number
degrees(r: number): number
camelCase(s: string): string
unCamelCase(s: string): string
capitalize(s: string): string
// proportionalSize
// getOrigin
}
let defaults: {
attrs: {
'fill-opacity': number
'stroke-opacity': number
'stroke-width': number
'stroke-linejoin': string
'stroke-linecap': string
fill: string
stroke: string
opacity: number
x: number
y: number
cx: number
cy: number
width: number
height: number
r: number
rx: number
ry: number
offset: number
'stop-opacity': number
'stop-color': string
'font-size': number
'font-family': string
'text-anchor': string
}
timeline: {
duration: number
ease: string
delay: number
}
}
// let easing: {
// '-'(pos: number): number;
// '<>'(pos: number): number;
// '>'(pos: number): number;
// '<'(pos: number): number;
// bezier(x1: number, y1: number, x2: number, y2: number): (t: number) => number;
// steps(steps: number, stepPosition?: "jump-start"|"jump-end"|"jump-none"|"jump-both"|"start"|"end"): (t: number, beforeFlag?: boolean) => number;
// }
let regex: {
delimiter: RegExp
dots: RegExp
hex: RegExp
hyphen: RegExp
isBlank: RegExp
isHex: RegExp
isImage: RegExp
isNumber: RegExp
isPathLetter: RegExp
isRgb: RegExp
numberAndUnit: RegExp
numbersWithDots: RegExp
pathLetters: RegExp
reference: RegExp
rgb: RegExp
transforms: RegExp
whitespace: RegExp
}
let namespaces: {
ns: string
xmlns: string
xlink: string
svgjs: string
}
interface LinkedHTMLElement extends HTMLElement {
instance: Element
}
// ************ Standard object/option/properties declaration ************
type AttrNumberValue = number | 'auto'
/**
* The SVG core attributes are all the common attributes that can be specified on any SVG element.
* More information see https://developer.mozilla.org/en-US/docs/Web/SVG/Attribute/Core
*/
interface CoreAttr {
id?: string
lang?: string
tabindex?: number
'xml:lang'?: string
}
/**
* The SVG styling attributes are all the attributes that can be specified on any SVG element to apply CSS styling effects.
* More information see https://developer.mozilla.org/en-US/docs/Web/SVG/Attribute/Styling
*/
interface StylingAttr {
/**
* a valid HTML class name
*/
class?: string
/**
* SVG css style string format. It all can be find here https://www.w3.org/TR/SVG/styling.html#StyleAttribute
*/
style?: string
}
/**
* A global attribute that can be use with any svg element
*/
interface GlobalAttr extends CoreAttr, StylingAttr {}
// TODO: implement SVG Presentation Attributes. See https://developer.mozilla.org/en-US/docs/Web/SVG/Attribute/Presentation
interface PathBaseAttr {
pathLength?: number
}
interface RadiusAxisAttr {
rx?: AttrNumberValue
ry?: AttrNumberValue
}
/**
* SVG Rectangle attribute, more information see https://developer.mozilla.org/en-US/docs/Web/SVG/Element/rect
*/
interface RectAttr extends RadiusAxisAttr, PathBaseAttr, GlobalAttr {
x?: number
y?: number
width: AttrNumberValue
height: AttrNumberValue
}
/**
* SVG Line attribute, more information see https://developer.mozilla.org/en-US/docs/Web/SVG/Element/line
*/
interface LineAttr extends PathBaseAttr, GlobalAttr {
x1?: number
y1?: number
x2?: number
y2?: number
}
/**
* SVG Circle attribute, more information see https://developer.mozilla.org/en-US/docs/Web/SVG/Element/circle
*/
interface CircleAttr extends PathBaseAttr, GlobalAttr {
cx?: number | string
cy?: number | string
r?: number | string
}
/**
* SVG Ellipse attribute, more information see https://developer.mozilla.org/en-US/docs/Web/SVG/Element/ellipse
*/
interface EllipseAttr extends PathBaseAttr, GlobalAttr {
cx?: number | string
cy?: number | string
rx?: number | string
ry?: number | string
}
/**
* SVG Path attribute, more information see https://developer.mozilla.org/en-US/docs/Web/SVG/Element/path
*/
interface PathAttr extends PathBaseAttr, GlobalAttr {
d?: string
}
/**
* SVG Path attribute, more information see https://developer.mozilla.org/en-US/docs/Web/SVG/Element/polygon
* or https://developer.mozilla.org/en-US/docs/Web/SVG/Element/polyline
*/
interface PolyAttr extends PathBaseAttr, GlobalAttr {
points?: string
}
/**
* SVG Text attribute, more information see https://developer.mozilla.org/en-US/docs/Web/SVG/Element/text
*/
interface TextAttr extends GlobalAttr {
x?: number | string
y?: number | string
dx?: number | string
dy?: number | string
lengthAdjust?: 'spacing' | 'spacingAndGlyphs'
textLength?: number | string
// see https://developer.mozilla.org/en-US/docs/Web/API/SVGNumberList
// or https://developer.mozilla.org/en-US/docs/Web/SVG/Content_type#List-of-Ts
// TODO: tbd
// rotate?: string
}
/**
* SVG TextPath attribute, more information see https://developer.mozilla.org/en-US/docs/Web/SVG/Element/textPath
*/
interface TextPathAttr extends GlobalAttr {
href?: string
lengthAdjust?: 'spacing' | 'spacingAndGlyphs'
method?: 'align' | 'stretch'
side?: 'left' | 'right'
spacing?: 'auto' | 'exact'
startOffset?: number | string
textLength?: number | string
// See https://developer.mozilla.org/en-US/docs/Web/SVG/Element/textPath
// TODO: tbd as there is no reference to see the detail of how it would look like
// path?: string
}
/**
* A generic Dom Box object.
* Notice: DOMRect is still in experiment state and document is not complete (Draft)
* See https://developer.mozilla.org/en-US/docs/Web/API/DOMRect
*/
interface DOMRect {
x?: number
y?: number
width?: number
height?: number
top?: number
right?: number
bottom?: number
left?: number
}
// ************ SVG.JS generic Conditional Types declaration ************
type SVGTypeMapping<T> = T extends HTMLElement
? Dom
: T extends SVGSVGElement
? Svg
: T extends SVGRectElement
? Rect
: T extends SVGCircleElement
? Circle
: T extends SVGPathElement
? Path
: T extends SVGTextElement
? Text
: T extends SVGTextPathElement
? TextPath
: T extends SVGGElement
? G
: T extends SVGLineElement
? Line
: T extends SVGPolylineElement
? Polyline
: T extends SVGPolygonElement
? Polygon
: T extends SVGGradientElement
? Gradient
: T extends SVGImageElement
? Image
: T extends SVGEllipseElement
? Ellipse
: T extends SVGMaskElement
? Mask
: T extends SVGMarkerElement
? Marker
: T extends SVGClipPathElement
? ClipPath
: T extends SVGTSpanElement
? Tspan
: T extends SVGSymbolElement
? Symbol
: T extends SVGUseElement
? Use
: Element
// element type as string
type SvgType = 'svg'
type ClipPathType = 'clipPath'
type TextType = 'text'
type GType = 'g'
type AType = 'a'
type ParentElement = SvgType | GType | AType
type AttrTypeMapping<T> = T extends Rect ? RectAttr : GlobalAttr
type ElementAlias =
| Dom
| Svg
| Rect
| Line
| Polygon
| Polyline
| Ellipse
| ClipPath
| Use
| Text
| Path
| TextPath
| Circle
| G
| Gradient
| Image
| Element
type ElementTypeAlias =
| typeof Dom
| typeof Svg
| typeof Rect
| typeof Line
| typeof Polygon
| typeof Polyline
| typeof Ellipse
| typeof ClipPath
| typeof Use
| typeof Text
| typeof Path
| typeof TextPath
| typeof Circle
| typeof G
| typeof Gradient
| typeof Image
| typeof Element
type AttributeReference =
| 'href'
| 'marker-start'
| 'marker-mid'
| 'marker-end'
| 'mask'
| 'clip-path'
| 'filter'
| 'fill'
// ************* SVG.JS Type Declaration *************
// ********** Locate in directory src/types **********
// SVGArray.js
// Notice: below class is defined the name as `Array` rather than `SVGArray`.
// The purpose of giving the name as `Array` is to allow it to be aligned with SVG.JS export type
// as SVG.JS export it as `Array` (to be precise `SVG.Array`) so reading through JS documentation
// should be more straightforward.
/**
* Type alias to native array.
*
* **Caution**: If argument is a string, generic type must be a number or array of number and
* the string is format as a concatenate of number separate by comma.
* This is expensive to build runtime type check for such as case so please use it carefully.
*/
type ArrayAlias<T> = BuiltInArray<T> | T[] | string
class Array<T> extends BuiltInArray<T> {
constructor(array?: ArrayAlias<T>)
/**
* Return array of generic T however it's flatten array by 1 level as it using `apply` function.
* For example: if T is a `number[]` which is the number of 2 dimension `Array<number[]>` the result will be `number[]`
*/
toArray(): any[]
/**
* return a concatenated string of each element separated by space
*/
toString(): string
valueOf(): T[]
clone(): Array<T>
toSet(): Set<T>
parse(a?: ArrayAlias<T>): T[]
to(a: any): Morphable
}
// point.js
class Point {
x: number
y: number
constructor()
constructor(position: CoordinateXY)
constructor(point: Point)
constructor(x: number, y?: number)
clone(): Point
transform(matrix: Matrix): this
transformO(matrix: Matrix): this
toArray(): ArrayXY
}
// pointArray.js
class PointArray extends Array<ArrayXY> {
constructor()
constructor(array?: ArrayAlias<ArrayXY> | number[])
toLine(): LineAttr
transform(m: Matrix | MatrixLike): PointArray
move(x: number, y: number): this
size(width: number, height: number): this
bbox(): Box
to(a: any): Morphable
toString(): string
}
// SVGNumber.js
type NumberUnit = [number, string]
class Number {
constructor()
constructor(value: Number)
constructor(value: string)
constructor(value: number, unit?: any)
constructor(n: NumberUnit)
value: number
unit: any
toString(): string
toJSON(): object // same as toString
toArray(): NumberUnit
valueOf(): number
plus(number: NumberAlias): Number
minus(number: NumberAlias): Number
times(number: NumberAlias): Number
divide(number: NumberAlias): Number
convert(unit: string): Number
to(a: any): Morphable
}
type NumberAlias = Number | number | string
// PathArray.js
type LineCommand =
| ['M' | 'm' | 'L' | 'l', number, number]
| ['H' | 'h' | 'V' | 'v', number]
| ['Z' | 'z']
type CurveCommand =
// Bezier Curves
| ['C' | 'c', number, number, number, number, number, number]
| ['S' | 's' | 'Q' | 'q', number, number, number, number]
| ['T' | 't', number, number]
// Arcs
| ['A' | 'a', number, number, number, number, number, number, number]
type PathCommand = LineCommand | CurveCommand
type PathArrayAlias = PathArray | PathCommand[] | (string | number)[] | string
class PathArray extends Array<PathCommand> {
constructor()
constructor(d: ArrayAlias<PathCommand> | PathArrayAlias)
move(x: number, y: number): this
size(width: number, height: number): this
equalCommands(other: PathArray): boolean
morph(pa: PathArray): this
parse(array?: ArrayAlias<PathCommand> | PathArrayAlias): PathCommand[]
bbox(): Box
to(a: any): Morphable
}
// Matrix.js
interface TransformData {
origin?: number[]
scaleX?: number
scaleY?: number
shear?: number
rotate?: number
translateX?: number
translateY?: number
originX?: number
originY?: number
}
interface MatrixLike {
a?: number
b?: number
c?: number
d?: number
e?: number
f?: number
}
interface MatrixExtract extends TransformData, MatrixLike {}
type FlipType = 'both' | 'x' | 'y' | boolean
type ArrayXY = [number, number]
type CoordinateXY = ArrayXY | { x: number; y: number }
interface MatrixTransformParam {
rotate?: number
flip?: FlipType
skew?: ArrayXY | number
skewX?: number
skewY?: number
scale?: ArrayXY | number
scaleX?: number
scaleY?: number
shear?: number
theta?: number
origin?: CoordinateXY | string
around?: CoordinateXY
ox?: number
originX?: number
oy?: number
originY?: number
position?: CoordinateXY
px?: number
positionX?: number
py?: number
positionY?: number
translate?: CoordinateXY
tx?: number
translateX?: number
ty?: number
translateY?: number
relative?: CoordinateXY
rx?: number
relativeX?: number
ry?: number
relativeY?: number
}
type MatrixAlias =
| MatrixLike
| TransformData
| MatrixTransformParam
| number[]
| Element
| string
class Matrix implements MatrixLike {
constructor()
constructor(source: MatrixAlias)
constructor(
a: number,
b: number,
c: number,
d: number,
e: number,
f: number
)
a: number
b: number
c: number
d: number
e: number
f: number;
// *** To Be use by Test Only in restrict mode ***
[key: string]: any
clone(): Matrix
transform(o: MatrixLike | MatrixTransformParam): Matrix
compose(o: MatrixExtract): Matrix
decompose(cx?: number, cy?: number): MatrixExtract
multiply(m: MatrixAlias | Matrix): Matrix
multiplyO(m: MatrixAlias | Matrix): this
lmultiply(m: MatrixAlias | Matrix): Matrix
lmultiplyO(m: MatrixAlias | Matrix): this
inverse(): Matrix
inverseO(): this
translate(x?: number, y?: number): Matrix
translateO(x?: number, y?: number): this
scale(x: number, y?: number, cx?: number, cy?: number): Matrix
scaleO(x: number, y?: number, cx?: number, cy?: number): this
rotate(r: number, cx?: number, cy?: number): Matrix
rotateO(r: number, cx?: number, cy?: number): this
flip(a: NumberAlias, offset?: number): Matrix
flipO(a: NumberAlias, offset?: number): this
flip(offset?: number): Matrix
shear(a: number, cx?: number, cy?: number): Matrix
shearO(a: number, cx?: number, cy?: number): this
skew(y?: number, cx?: number, cy?: number): Matrix
skewO(y?: number, cx?: number, cy?: number): this
skew(x: number, y?: number, cx?: number, cy?: number): Matrix
skewX(x: number, cx?: number, cy?: number): Matrix
skewY(y: number, cx?: number, cy?: number): Matrix
around(cx?: number, cy?: number, matrix?: Matrix): Matrix
aroundO(cx?: number, cy?: number, matrix?: Matrix): this
equals(m: Matrix): boolean
toString(): string
toArray(): number[]
valueOf(): MatrixLike
to(a: any): Morphable
}
type ListEachCallback<T> = (el: T, index: number, list: List<T>) => any
// List.js
class List<T> extends BuiltInArray<T> {
each(fn: ListEachCallback<T>): List<any>
each(name: string, ...args: any[]): List<any>
toArray(): T[]
}
class Eventobject {
[key: string]: Eventobject
}
// EventTarget.js
class EventTarget {
events: Eventobject
addEventListener(): void
dispatch(event: Event | string, data?: object): Event
dispatchEvent(event: Event): boolean
fire(event: Event | string, data?: object): this
getEventHolder(): this | Node
getEventTarget(): this | Node
on(
events: string | Event[],
cb: EventListener,
binbind?: any,
options?: AddEventListenerOptions
): this
off(
events?: string | Event[],
cb?: EventListener | number,
options?: AddEventListenerOptions
): this
removeEventListener(): void
}
// Color.js
interface ColorLike {
r: number
g: number
b: number
x: number
y: number
z: number
h: number
s: number
l: number
a: number
c: number
m: number
k: number
space: string
}
type ColorAlias = string | ColorLike
class Color implements ColorLike {
r: number
g: number
b: number
x: number
y: number
z: number
h: number
s: number
l: number
a: number
c: number
m: number
k: number
space: string
constructor()
constructor(color: ColorAlias, space?: string)
constructor(a: number, b: number, c: number, space?: string)
constructor(a: number, b: number, c: number, d: number, space?: string)
constructor(a: number[], space?: string)
rgb(): Color
lab(): Color
xyz(): Color
lch(): Color
hsl(): Color
cmyk(): Color
toHex(): string
toString(): string
toRgb(): string
toArray(): any[]
to(a: any): Morphable
fromArray(a: any): this
static random(mode: 'sine', time?: number): Color
static random(mode?: string): Color
}
// Box.js
interface BoxLike {
height: number
width: number
y: number
x: number
cx?: number
cy?: number
w?: number
h?: number
x2?: number
y2?: number
}
class Box implements BoxLike {
height: number
width: number
y: number
x: number
cx: number
cy: number
w: number
h: number
x2: number
y2: number
constructor()
constructor(source: string)
constructor(source: number[])
constructor(source: DOMRect)
constructor(x: number, y: number, width: number, height: number)
merge(box: BoxLike): Box
transform(m: Matrix): Box
addOffset(): this
toString(): string
toArray(): number[]
isNulled(): boolean
to(v: MorphValueLike): Morphable
}
// Morphable.js
type MorphValueLike =
| string
| number
| objectBag
| NonMorphable
| MatrixExtract
| Array<any>
| any[]
class Morphable {
constructor()
constructor(st: Stepper)
from(): MorphValueLike
from(v: MorphValueLike): this
to(): MorphValueLike
to(v: MorphValueLike): this
type(): any
type(t: any): this
stepper(): Stepper
stepper(st: Stepper): this
done(): boolean
at(pos: number): any
}
class objectBag {
constructor()
constructor(a: object)
valueOf(): object
toArray(): object[]
to(a: object): Morphable
fromArray(a: any[]): this
}
class NonMorphable {
constructor(a: object)
valueOf(): object
toArray(): object[]
to(a: object): Morphable
fromArray(a: object): this
}
class TransformBag {
constructor()
constructor(a: number[])
constructor(a: TransformData)
defaults: TransformData
toArray(): number[]
to(t: TransformData): Morphable
fromArray(t: number[]): this
}
interface Stepper {
done(c?: object): boolean
}
class Ease implements Stepper {
constructor()
constructor(fn: string)
constructor(fn: Function)
step(from: number, to: number, pos: number): number
done(): boolean
}
class Controller implements Stepper {
constructor(fn?: Function)
step(current: number, target: number, dt: number, c: number): number
done(c?: object): boolean
}
// Queue.js
interface QueueParam {
value: any
next?: any
prev?: any
}
class Queue {
constructor()
push(value: any): QueueParam
shift(): any
first(): number
last(): number
remove(item: QueueParam): void
}
// Timeline.js
interface ScheduledRunnerInfo {
start: number
duration: number
end: number
runner: Runner
}
class Timeline extends EventTarget {
constructor()
constructor(fn: Function)
active(): boolean
schedule(runner: Runner, delay?: number, when?: string): this
schedule(): ScheduledRunnerInfo[]
unschedule(runner: Runner): this
getEndTime(): number
updateTime(): this
persist(dtOrForever?: number | boolean): this
play(): this
pause(): this
stop(): this
finish(): this
speed(speed: number): this
reverse(yes: boolean): this
seek(dt: number): this
time(): number
time(time: number): this
source(): Function
source(fn: Function): this
}
// Runner.js
interface TimesParam {
duration: number
delay: number
when: number | string
swing: boolean
wait: number
times: number
}
type TimeLike = number | TimesParam | Stepper
type EasingCallback = (...any: any) => number
type EasingLiteral = '<>' | '-' | '<' | '>'
class Runner {
constructor()
constructor(options: Function)
constructor(options: number)
constructor(options: Controller)
static sanitise: (
duration?: TimeLike,
delay?: number,
when?: string
) => object
element(): Element
element(el: Element): this
timeline(): Timeline
timeline(timeline: Timeline): this
animate(duration?: TimeLike, delay?: number, when?: string): this
schedule(delay: number, when?: string): this
schedule(timeline: Timeline, delay?: number, when?: string): this
unschedule(): this
loop(times?: number, swing?: boolean, wait?: number): this
loop(times: TimesParam): this
delay(delay: number): this
during(fn: Function): this
queue(
initFn: Function,
runFn: Function,
retargetFn?: boolean | Function,
isTransform?: boolean
): this
after(fn: EventListener): this