-
Notifications
You must be signed in to change notification settings - Fork 19.6k
/
types.ts
1740 lines (1522 loc) · 49.6 KB
/
types.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
/*
* Licensed to the Apache Software Foundation (ASF) under one
* or more contributor license agreements. See the NOTICE file
* distributed with this work for additional information
* regarding copyright ownership. The ASF licenses this file
* to you under the Apache License, Version 2.0 (the
* "License"); you may not use this file except in compliance
* with the License. You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing,
* software distributed under the License is distributed on an
* "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
* KIND, either express or implied. See the License for the
* specific language governing permissions and limitations
* under the License.
*/
/**
* [Notice]:
* Consider custom bundle on demand, chart specified
* or component specified types and constants should
* not put here. Only common types and constants can
* be put in this file.
*/
import Group from 'zrender/src/graphic/Group';
import Element, {ElementEvent, ElementTextConfig} from 'zrender/src/Element';
import { DataFormatMixin } from '../model/mixin/dataFormat';
import GlobalModel from '../model/Global';
import ExtensionAPI from '../core/ExtensionAPI';
import SeriesModel from '../model/Series';
import { createHashMap, HashMap } from 'zrender/src/core/util';
import { TaskPlanCallbackReturn, TaskProgressParams } from '../core/task';
import SeriesData from '../data/SeriesData';
import { Dictionary, ElementEventName, ImageLike, TextAlign, TextVerticalAlign } from 'zrender/src/core/types';
import { PatternObject } from 'zrender/src/graphic/Pattern';
import { TooltipMarker } from './format';
import { AnimationEasing } from 'zrender/src/animation/easing';
import { LinearGradientObject } from 'zrender/src/graphic/LinearGradient';
import { RadialGradientObject } from 'zrender/src/graphic/RadialGradient';
import { RectLike } from 'zrender/src/core/BoundingRect';
import { TSpanStyleProps } from 'zrender/src/graphic/TSpan';
import { PathStyleProps } from 'zrender/src/graphic/Path';
import { ImageStyleProps } from 'zrender/src/graphic/Image';
import ZRText, { TextStyleProps } from 'zrender/src/graphic/Text';
import { Source } from '../data/Source';
import Model from '../model/Model';
import { DataStoreDimensionType } from '../data/DataStore';
import { DimensionUserOuputEncode } from '../data/helper/dimensionHelper';
// ---------------------------
// Common types and constants
// ---------------------------
export {Dictionary};
export type RendererType = 'canvas' | 'svg';
export type NullUndefined = null | undefined;
export type LayoutOrient = 'vertical' | 'horizontal';
export type HorizontalAlign = 'left' | 'center' | 'right';
export type VerticalAlign = 'top' | 'middle' | 'bottom';
// Types from zrender
export type ColorString = string;
export type ZRColor = ColorString | LinearGradientObject | RadialGradientObject | PatternObject;
export type ZRLineType = 'solid' | 'dotted' | 'dashed' | number | number[];
export type ZRFontStyle = 'normal' | 'italic' | 'oblique';
export type ZRFontWeight = 'normal' | 'bold' | 'bolder' | 'lighter' | number;
export type ZREasing = AnimationEasing;
export type ZRTextAlign = TextAlign;
export type ZRTextVerticalAlign = TextVerticalAlign;
export type ZRElementEvent = ElementEvent;
export type ZRRectLike = RectLike;
export type ZRStyleProps = PathStyleProps | ImageStyleProps | TSpanStyleProps | TextStyleProps;
export type ZRElementEventName = ElementEventName | 'globalout';
// ComponentFullType can be:
// 'a.b': means ComponentMainType.ComponentSubType.
// 'a': means ComponentMainType.
// See `checkClassType` check the restict definition.
export type ComponentFullType = string;
export type ComponentMainType = keyof ECUnitOption & string;
export type ComponentSubType = Exclude<ComponentOption['type'], undefined>;
/**
* Use `parseClassType` to parse componentType declaration to componentTypeInfo.
* For example:
* componentType declaration: 'a.b', get componentTypeInfo {main: 'a', sub: 'b'}.
* componentType declaration: '', get componentTypeInfo {main: '', sub: ''}.
*/
export interface ComponentTypeInfo {
main: ComponentMainType; // Never null/undefined. `''` represents absence.
sub: ComponentSubType; // Never null/undefined. `''` represents absence.
}
export interface ECElement extends Element {
highDownSilentOnTouch?: boolean;
onHoverStateChange?: (toState: DisplayState) => void;
// 0: normal
// 1: blur
// 2: emphasis
hoverState?: 0 | 1 | 2;
selected?: boolean;
z2EmphasisLift?: number;
z2SelectLift?: number;
/**
* Force enable animation.
* This property is useful when an ignored/invisible/removed element
* should have label animation, like the case in the bar-racing charts.
* `forceLabelAnimation` has higher priority than `disableLabelAnimation`.
*/
forceLabelAnimation?: boolean;
/**
* Force disable animation.
* `forceLabelAnimation` has higher priority than `disableLabelAnimation`.
*/
disableLabelAnimation?: boolean
/**
* Force disable overall layout
*/
disableLabelLayout?: boolean
/**
* Force disable morphing
*/
disableMorphing?: boolean
}
export interface DataHost {
getData(dataType?: SeriesDataType): SeriesData;
}
export interface DataModel extends Model<unknown>, DataHost, DataFormatMixin {
getDataParams(dataIndex: number, dataType?: SeriesDataType, el?: Element): CallbackDataParams;
}
// Pick<DataHost, 'getData'>,
// Pick<DataFormatMixin, 'getDataParams' | 'formatTooltip'> {}
interface PayloadItem {
excludeSeriesId?: OptionId | OptionId[];
animation?: PayloadAnimationPart
// TODO use unknown
[other: string]: any;
}
export interface Payload extends PayloadItem {
type: string;
escapeConnect?: boolean;
batch?: PayloadItem[];
}
export interface HighlightPayload extends Payload {
type: 'highlight';
notBlur?: boolean
}
export interface DownplayPayload extends Payload {
type: 'downplay';
notBlur?: boolean
}
// Payload includes override anmation info
export interface PayloadAnimationPart {
duration?: number
easing?: AnimationEasing
delay?: number
}
export interface SelectChangedPayload extends Payload {
type: 'selectchanged'
escapeConnect: boolean
isFromClick: boolean
fromAction: 'select' | 'unselect' | 'toggleSelected'
fromActionPayload: Payload
selected: {
seriesIndex: number
dataType?: SeriesDataType
dataIndex: number[]
}[]
}
export interface ViewRootGroup extends Group {
__ecComponentInfo?: {
mainType: string,
index: number
};
}
export interface ECElementEvent extends
ECEventData,
CallbackDataParams {
type: ZRElementEventName;
event?: ElementEvent;
}
/**
* The echarts event type to user.
* Also known as packedEvent.
*/
export interface ECActionEvent extends ECEventData {
// event type
type: string;
componentType?: string;
componentIndex?: number;
seriesIndex?: number;
escapeConnect?: boolean;
batch?: ECEventData;
}
export interface ECEventData {
// TODO use unknown
[key: string]: any;
}
export interface EventQueryItem {
// TODO use unknown
[key: string]: any;
}
export interface NormalizedEventQuery {
cptQuery: EventQueryItem;
dataQuery: EventQueryItem;
otherQuery: EventQueryItem;
}
export interface ActionInfo {
// action type
type: string;
// If not provided, use the same string of `type`.
event?: string;
// update method
update?: string;
}
export interface ActionHandler {
(payload: Payload, ecModel: GlobalModel, api: ExtensionAPI): void | ECEventData;
}
export interface OptionPreprocessor {
(option: ECUnitOption, isTheme: boolean): void
}
export interface PostUpdater {
(ecModel: GlobalModel, api: ExtensionAPI): void;
}
export interface StageHandlerReset {
(seriesModel: SeriesModel, ecModel: GlobalModel, api: ExtensionAPI, payload?: Payload):
StageHandlerProgressExecutor | StageHandlerProgressExecutor[] | void
}
export interface StageHandlerOverallReset {
(ecModel: GlobalModel, api: ExtensionAPI, payload?: Payload): void
}
export interface StageHandler {
/**
* Indicate that the task will be piped all series
* (`performRawSeries` indicate whether includes filtered series).
*/
createOnAllSeries?: boolean;
/**
* Indicate that the task will be only piped in the pipeline of this type of series.
* (`performRawSeries` indicate whether includes filtered series).
*/
seriesType?: string;
/**
* Indicate that the task will be only piped in the pipeline of the returned series.
*/
getTargetSeries?: (ecModel: GlobalModel, api: ExtensionAPI) => HashMap<SeriesModel>;
/**
* If `true`, filtered series will also be "performed".
*/
performRawSeries?: boolean;
/**
* Called only when this task in a pipeline.
*/
plan?: StageHandlerPlan;
/**
* If `overallReset` specified, an "overall task" will be created.
* "overall task" does not belong to a certain pipeline.
* They always be "performed" in certain phase (depends on when they declared).
* They has "stub"s to connect with pipelines (one stub for one pipeline),
* delivering info like "dirty" and "output end".
*/
overallReset?: StageHandlerOverallReset;
/**
* Called only when this task in a pipeline, and "dirty".
*/
reset?: StageHandlerReset;
}
export interface StageHandlerInternal extends StageHandler {
uid: string;
visualType?: 'layout' | 'visual';
// modifyOutputEnd?: boolean;
__prio: number;
__raw: StageHandler | StageHandlerOverallReset;
isVisual?: boolean; // PENDING: not used
isLayout?: boolean; // PENDING: not used
}
export type StageHandlerProgressParams = TaskProgressParams;
export interface StageHandlerProgressExecutor {
dataEach?: (data: SeriesData, idx: number) => void;
progress?: (params: StageHandlerProgressParams, data: SeriesData) => void;
}
export type StageHandlerPlanReturn = TaskPlanCallbackReturn;
export interface StageHandlerPlan {
(seriesModel: SeriesModel, ecModel: GlobalModel, api: ExtensionAPI, payload?: Payload):
StageHandlerPlanReturn
}
export interface LoadingEffectCreator {
(api: ExtensionAPI, cfg: object): LoadingEffect;
}
export interface LoadingEffect extends Element {
resize: () => void;
}
/**
* 'html' is used for rendering tooltip in extra DOM form, and the result
* string is used as DOM HTML content.
* 'richText' is used for rendering tooltip in rich text form, for those where
* DOM operation is not supported.
*/
export type TooltipRenderMode = 'html' | 'richText';
export type TooltipOrderMode = 'valueAsc' | 'valueDesc' | 'seriesAsc' | 'seriesDesc';
// ---------------------------------
// Data and dimension related types
// ---------------------------------
// Finally the user data will be parsed and stored in `list._storage`.
// `NaN` represents "no data" (raw data `null`/`undefined`/`NaN`/`'-'`).
// `Date` will be parsed to timestamp.
// Ordinal/category data will be parsed to its index if possible, otherwise
// keep its original string in list._storage.
// Check `convertValue` for more details.
export type OrdinalRawValue = string | number;
export type OrdinalNumber = number; // The number mapped from each OrdinalRawValue.
/**
* @usage For example,
* ```js
* { ordinalNumbers: [2, 5, 3, 4] }
* ```
* means that ordinal 2 should be displayed on tick 0,
* ordinal 5 should be displayed on tick 1, ...
*/
export type OrdinalSortInfo = {
ordinalNumbers: OrdinalNumber[];
};
/**
* `OptionDataValue` is the primitive value in `series.data` or `dataset.source`.
* `OptionDataValue` are parsed (see `src/data/helper/dataValueHelper.parseDataValue`)
* into `ParsedValue` and stored into `data/SeriesData` storage.
* Note:
* (1) The term "parse" does not mean `src/scale/Scale['parse']`.
* (2) If a category dimension is not mapped to any axis, its raw value will NOT be
* parsed to `OrdinalNumber` but keep the original `OrdinalRawValue` in `src/data/SeriesData` storage.
*/
export type ParsedValue = ParsedValueNumeric | OrdinalRawValue;
export type ParsedValueNumeric = number | OrdinalNumber;
/**
* `ScaleDataValue` means that the user input primitive value to `src/scale/Scale`.
* (For example, used in `axis.min`, `axis.max`, `convertToPixel`).
* Note:
* `ScaleDataValue` is a little different from `OptionDataValue`, because it will not go through
* `src/data/helper/dataValueHelper.parseDataValue`, but go through `src/scale/Scale['parse']`.
*/
export type ScaleDataValue = ParsedValueNumeric | OrdinalRawValue | Date;
export interface ScaleTick {
level?: number,
value: number
};
export interface TimeScaleTick extends ScaleTick {
/**
* Level information is used for label formatting.
* For example, a time axis may contain labels like: Jan, 8th, 16th, 23th,
* Feb, and etc. In this case, month labels like Jan and Feb should be
* displayed in a more significant way than days.
* `level` is set to be 0 when it's the most significant level, like month
* labels in the above case.
*/
level?: number
};
export interface OrdinalScaleTick extends ScaleTick {
/**
* Represents where the tick will be placed visually.
* Notice:
* The value is not the raw ordinal value. And do not changed
* after ordinal scale sorted.
* We need to:
* ```js
* const coord = dataToCoord(ordinalScale.getRawOrdinalNumber(tick.value)).
* ```
* Why place the tick value here rather than the raw ordinal value (like LogScale did)?
* Because ordinal scale sort is the different case from LogScale, where
* axis tick, splitArea should better not to be sorted, especially in
* anid(animation id) when `boundaryGap: true`.
* Only axis label are sorted.
*/
value: number
};
// Can only be string or index, because it is used in object key in some code.
// Making the type alias here just intending to show the meaning clearly in code.
export type DimensionIndex = number;
// If being a number-like string but not being defined a dimension name.
// See `List.js#getDimension` for more details.
export type DimensionIndexLoose = DimensionIndex | string;
export type DimensionName = string;
export type DimensionLoose = DimensionName | DimensionIndexLoose;
export type DimensionType = DataStoreDimensionType;
export const VISUAL_DIMENSIONS = createHashMap<number, keyof DataVisualDimensions>([
'tooltip', 'label', 'itemName', 'itemId', 'itemGroupId', 'seriesName'
]);
// The key is VISUAL_DIMENSIONS
export interface DataVisualDimensions {
// can be set as false to directly to prevent this data
// dimension from displaying in the default tooltip.
// see `Series.ts#formatTooltip`.
tooltip?: DimensionIndex | false;
label?: DimensionIndex;
itemName?: DimensionIndex;
itemId?: DimensionIndex;
itemGroupId?: DimensionIndex;
seriesName?: DimensionIndex;
}
export type DimensionDefinition = {
type?: DataStoreDimensionType,
name?: DimensionName,
displayName?: string
};
export type DimensionDefinitionLoose = DimensionDefinition['name'] | DimensionDefinition;
export const SOURCE_FORMAT_ORIGINAL = 'original' as const;
export const SOURCE_FORMAT_ARRAY_ROWS = 'arrayRows' as const;
export const SOURCE_FORMAT_OBJECT_ROWS = 'objectRows' as const;
export const SOURCE_FORMAT_KEYED_COLUMNS = 'keyedColumns' as const;
export const SOURCE_FORMAT_TYPED_ARRAY = 'typedArray' as const;
export const SOURCE_FORMAT_UNKNOWN = 'unknown' as const;
export type SourceFormat =
typeof SOURCE_FORMAT_ORIGINAL
| typeof SOURCE_FORMAT_ARRAY_ROWS
| typeof SOURCE_FORMAT_OBJECT_ROWS
| typeof SOURCE_FORMAT_KEYED_COLUMNS
| typeof SOURCE_FORMAT_TYPED_ARRAY
| typeof SOURCE_FORMAT_UNKNOWN;
export const SERIES_LAYOUT_BY_COLUMN = 'column' as const;
export const SERIES_LAYOUT_BY_ROW = 'row' as const;
export type SeriesLayoutBy = typeof SERIES_LAYOUT_BY_COLUMN | typeof SERIES_LAYOUT_BY_ROW;
// null/undefined/'auto': auto detect header, see "src/data/helper/sourceHelper".
// If number, means header lines count, or say, `startIndex`.
// Like `sourceHeader: 2`, means line 0 and line 1 are header, data start from line 2.
export type OptionSourceHeader = boolean | 'auto' | number;
export type SeriesDataType = 'main' | 'node' | 'edge';
// --------------------------------------------
// echarts option types (base and common part)
// --------------------------------------------
/**
* [ECUnitOption]:
* An object that contains definitions of components
* and other properties. For example:
*
* ```ts
* let option: ECUnitOption = {
*
* // Single `title` component:
* title: {...},
*
* // Two `visualMap` components:
* visualMap: [{...}, {...}],
*
* // Two `series.bar` components
* // and one `series.pie` component:
* series: [
* {type: 'bar', data: [...]},
* {type: 'bar', data: [...]},
* {type: 'pie', data: [...]}
* ],
*
* // A property:
* backgroundColor: '#421ae4'
*
* // A property object:
* textStyle: {
* color: 'red',
* fontSize: 20
* }
* };
* ```
*/
export type ECUnitOption = {
// Exclude these reserved word for `ECOption` to avoid to infer to "any".
baseOption?: unknown
options?: unknown
media?: unknown
timeline?: ComponentOption | ComponentOption[]
backgroundColor?: ZRColor
darkMode?: boolean | 'auto'
textStyle?: Pick<LabelOption, 'color' | 'fontStyle' | 'fontWeight' | 'fontSize' | 'fontFamily'>
useUTC?: boolean
[key: string]: ComponentOption | ComponentOption[] | Dictionary<unknown> | unknown
stateAnimation?: AnimationOption
} & AnimationOptionMixin & ColorPaletteOptionMixin;
/**
* [ECOption]:
* An object input to echarts.setOption(option).
* May be an 'option: ECUnitOption',
* or may be an object contains multi-options. For example:
*
* ```ts
* let option: ECOption = {
* baseOption: {
* title: {...},
* legend: {...},
* series: [
* {data: [...]},
* {data: [...]},
* ...
* ]
* },
* timeline: {...},
* options: [
* {title: {...}, series: {data: [...]}},
* {title: {...}, series: {data: [...]}},
* ...
* ],
* media: [
* {
* query: {maxWidth: 320},
* option: {series: {x: 20}, visualMap: {show: false}}
* },
* {
* query: {minWidth: 320, maxWidth: 720},
* option: {series: {x: 500}, visualMap: {show: true}}
* },
* {
* option: {series: {x: 1200}, visualMap: {show: true}}
* }
* ]
* };
* ```
*/
export interface ECBasicOption extends ECUnitOption {
baseOption?: ECUnitOption;
timeline?: ComponentOption | ComponentOption[];
options?: ECUnitOption[];
media?: MediaUnit[];
};
// series.data or dataset.source
export type OptionSourceData<
VAL extends OptionDataValue = OptionDataValue,
ORIITEM extends OptionDataItemOriginal<VAL> = OptionDataItemOriginal<VAL>
> =
OptionSourceDataOriginal<VAL, ORIITEM>
| OptionSourceDataObjectRows<VAL>
| OptionSourceDataArrayRows<VAL>
| OptionSourceDataKeyedColumns<VAL>
| OptionSourceDataTypedArray;
export type OptionDataItemOriginal<
VAL extends OptionDataValue = OptionDataValue
> = VAL | VAL[] | OptionDataItemObject<VAL>;
export type OptionSourceDataOriginal<
VAL extends OptionDataValue = OptionDataValue,
ORIITEM extends OptionDataItemOriginal<VAL> = OptionDataItemOriginal<VAL>
> = ArrayLike<ORIITEM>;
export type OptionSourceDataObjectRows<VAL extends OptionDataValue = OptionDataValue> =
Array<Dictionary<VAL>>;
export type OptionSourceDataArrayRows<VAL extends OptionDataValue = OptionDataValue> =
Array<Array<VAL>>;
export type OptionSourceDataKeyedColumns<VAL extends OptionDataValue = OptionDataValue> =
Dictionary<ArrayLike<VAL>>;
export type OptionSourceDataTypedArray = ArrayLike<number>;
// See also `model.js#getDataItemValue`.
export type OptionDataItem =
OptionDataValue
| Dictionary<OptionDataValue>
| OptionDataValue[]
// FIXME: In some case (markpoint in geo (geo-map.html)), dataItem is {coord: [...]}
| OptionDataItemObject<OptionDataValue>;
// Only for `SOURCE_FORMAT_KEYED_ORIGINAL`
export type OptionDataItemObject<T> = {
id?: OptionId;
name?: OptionName;
groupId?: OptionId;
value?: T[] | T;
selected?: boolean;
};
// Compat number because it is usually used and not easy to
// restrict it in practise.
export type OptionId = string | number;
export type OptionName = string | number;
export interface GraphEdgeItemObject<
VAL extends OptionDataValue
> extends OptionDataItemObject<VAL> {
/**
* Name or index of source node.
*/
source?: string | number
/**
* Name or index of target node.
*/
target?: string | number
}
export type OptionDataValue = string | number | Date;
export type OptionDataValueNumeric = number | '-';
export type OptionDataValueCategory = string;
export type OptionDataValueDate = Date | string | number;
// export type ModelOption = Dictionary<any> | any[] | string | number | boolean | ((...args: any) => any);
export type ModelOption = any;
export type ThemeOption = Dictionary<any>;
export type DisplayState = 'normal' | 'emphasis' | 'blur' | 'select';
export type DisplayStateNonNormal = Exclude<DisplayState, 'normal'>;
export type DisplayStateHostOption = {
emphasis?: Dictionary<any>,
[key: string]: any
};
// The key is VISUAL_DIMENSIONS
export interface OptionEncodeVisualDimensions {
tooltip?: OptionEncodeValue;
label?: OptionEncodeValue;
itemName?: OptionEncodeValue;
itemId?: OptionEncodeValue;
seriesName?: OptionEncodeValue;
// Notice: `value` is coordDim, not nonCoordDim.
// Group id is used for linking the aggregate relationship between two set of data.
// Which is useful in prepresenting the transition key of drilldown/up animation.
// Or hover linking.
itemGroupId?: OptionEncodeValue;
}
export interface OptionEncode extends OptionEncodeVisualDimensions {
[coordDim: string]: OptionEncodeValue | undefined
}
export type OptionEncodeValue = DimensionLoose | DimensionLoose[];
export type EncodeDefaulter = (source: Source, dimCount: number) => OptionEncode;
// TODO: TYPE Different callback param for different series
export interface CallbackDataParams {
// component main type
componentType: string;
// component sub type
componentSubType: string;
componentIndex: number;
// series component sub type
seriesType?: string;
// series component index (the alias of `componentIndex` for series)
seriesIndex?: number;
seriesId?: string;
seriesName?: string;
name: string;
dataIndex: number;
data: OptionDataItem;
dataType?: SeriesDataType;
value: OptionDataItem | OptionDataValue;
color?: ZRColor;
borderColor?: string;
dimensionNames?: DimensionName[];
encode?: DimensionUserOuputEncode;
marker?: TooltipMarker;
status?: DisplayState;
dimensionIndex?: number;
percent?: number; // Only for chart like 'pie'
// Param name list for mapping `a`, `b`, `c`, `d`, `e`
$vars: string[];
}
export type InterpolatableValue = ParsedValue | ParsedValue[];
export type DecalDashArrayX = number | (number | number[])[];
export type DecalDashArrayY = number | number[];
export interface DecalObject {
// 'image', 'triangle', 'diamond', 'pin', 'arrow', 'line', 'rect', 'roundRect', 'square', 'circle'
symbol?: string | string[]
// size relative to the dash bounding box; valued from 0 to 1
symbolSize?: number
// keep the aspect ratio and use the smaller one of width and height as bounding box size
symbolKeepAspect?: boolean
// foreground color of the pattern
color?: string
// background color of the pattern; default value is 'none' (same as 'transparent') so that the underlying series color is displayed
backgroundColor?: string
// dash-gap pattern on x
dashArrayX?: DecalDashArrayX
// dash-gap pattern on y
dashArrayY?: DecalDashArrayY
// in radians; valued from -Math.PI to Math.PI
rotation?: number
// boundary of largest tile width
maxTileWidth?: number
// boundary of largest tile height
maxTileHeight?: number
};
export interface InnerDecalObject extends DecalObject {
// Mark dirty when object may be changed.
// The record in WeakMap will be deleted.
dirty?: boolean
}
export interface MediaQuery {
minWidth?: number;
maxWidth?: number;
minHeight?: number;
maxHeight?: number;
minAspectRatio?: number;
maxAspectRatio?: number;
};
export type MediaUnit = {
query?: MediaQuery,
option: ECUnitOption
};
export type ComponentLayoutMode = {
// Only support 'box' now.
type?: 'box',
ignoreSize?: boolean | boolean[]
};
// ------------------ Mixins for Common Option Properties ------------------
export type PaletteOptionMixin = ColorPaletteOptionMixin;
export interface ColorPaletteOptionMixin {
color?: ZRColor | ZRColor[]
colorLayer?: ZRColor[][]
}
/**
* Mixin of option set to control the box layout of each component.
*/
export interface BoxLayoutOptionMixin {
width?: number | string;
height?: number | string;
top?: number | string;
right?: number | string;
bottom?: number | string;
left?: number | string;
}
export interface CircleLayoutOptionMixin {
// Can be percent
center?: (number | string)[]
// Can specify [innerRadius, outerRadius]
radius?: (number | string)[] | number | string
}
export interface ShadowOptionMixin {
shadowBlur?: number
shadowColor?: ColorString
shadowOffsetX?: number
shadowOffsetY?: number
}
export interface BorderOptionMixin {
borderColor?: ZRColor
borderWidth?: number
borderType?: ZRLineType
borderCap?: CanvasLineCap
borderJoin?: CanvasLineJoin
borderDashOffset?: number
borderMiterLimit?: number
}
export type ColorBy = 'series' | 'data';
export interface SunburstColorByMixin {
colorBy?: ColorBy
}
export type AnimationDelayCallbackParam = {
count: number
index: number
};
export type AnimationDurationCallback = (idx: number) => number;
export type AnimationDelayCallback = (idx: number, params?: AnimationDelayCallbackParam) => number;
export interface AnimationOption {
duration?: number
easing?: AnimationEasing
delay?: number
// additive?: boolean
}
/**
* Mixin of option set to control the animation of series.
*/
export interface AnimationOptionMixin {
/**
* If enable animation
*/
animation?: boolean
/**
* Disable animation when the number of elements exceeds the threshold
*/
animationThreshold?: number
// For init animation
/**
* Duration of initialize animation.
* Can be a callback to specify duration of each element
*/
animationDuration?: number | AnimationDurationCallback
/**
* Easing of initialize animation
*/
animationEasing?: AnimationEasing
/**
* Delay of initialize animation
* Can be a callback to specify duration of each element
*/
animationDelay?: number | AnimationDelayCallback
// For update animation
/**
* Delay of data update animation.
* Can be a callback to specify duration of each element
*/
animationDurationUpdate?: number | AnimationDurationCallback
/**
* Easing of data update animation.
*/
animationEasingUpdate?: AnimationEasing
/**
* Delay of data update animation.
* Can be a callback to specify duration of each element
*/
animationDelayUpdate?: number | AnimationDelayCallback
}
export interface RoamOptionMixin {
/**
* If enable roam. can be specified 'scale' or 'move'
*/
roam?: boolean | 'pan' | 'move' | 'zoom' | 'scale'
/**
* Current center position.
*/
center?: (number | string)[]
/**
* Current zoom level. Default is 1
*/
zoom?: number
scaleLimit?: {
min?: number
max?: number
}
}
// TODO: TYPE value type?
export type SymbolSizeCallback<T> = (rawValue: any, params: T) => number | number[];
export type SymbolCallback<T> = (rawValue: any, params: T) => string;
export type SymbolRotateCallback<T> = (rawValue: any, params: T) => number;
export type SymbolOffsetCallback<T> = (rawValue: any, params: T) => string | number | (string | number)[];
/**
* Mixin of option set to control the element symbol.
* Include type of symbol, and size of symbol.
*/
export interface SymbolOptionMixin<T = never> {
/**
* type of symbol, like `cirlce`, `rect`, or custom path and image.
*/
symbol?: string | (T extends never ? never : SymbolCallback<T>)
/**
* Size of symbol.
*/
symbolSize?: number | number[] | (T extends never ? never : SymbolSizeCallback<T>)
symbolRotate?: number | (T extends never ? never : SymbolRotateCallback<T>)
symbolKeepAspect?: boolean
symbolOffset?: string | number | (string | number)[] | (T extends never ? never : SymbolOffsetCallback<T>)
}
/**
* ItemStyleOption is a most common used set to config element styles.
* It includes both fill and stroke style.
*/
export interface ItemStyleOption<TCbParams = never> extends ShadowOptionMixin, BorderOptionMixin {
color?: ZRColor | (TCbParams extends never ? never : ((params: TCbParams) => ZRColor))
opacity?: number
decal?: DecalObject | 'none'
}
/**
* ItemStyleOption is a option set to control styles on lines.
* Used in the components or series like `line`, `axis`
* It includes stroke style.
*/
export interface LineStyleOption<Clr = ZRColor> extends ShadowOptionMixin {
width?: number
color?: Clr
opacity?: number
type?: ZRLineType
cap?: CanvasLineCap
join?: CanvasLineJoin
dashOffset?: number
miterLimit?: number
}
/**
* ItemStyleOption is a option set to control styles on an area, like polygon, rectangle.
* It only include fill style.
*/
export interface AreaStyleOption<Clr = ZRColor> extends ShadowOptionMixin {
color?: Clr
opacity?: number
}
type Arrayable<T extends Dictionary<any>> = { [key in keyof T]: T[key] | T[key][] };
type Dictionaryable<T extends Dictionary<any>> = { [key in keyof T]: T[key] | Dictionary<T[key]>};
export interface VisualOptionUnit {
symbol?: string
// TODO Support [number, number]?
symbolSize?: number
color?: ColorString
colorAlpha?: number
opacity?: number
colorLightness?: number
colorSaturation?: number
colorHue?: number
decal?: DecalObject
// Not exposed?
liftZ?: number
}
export type VisualOptionFixed = VisualOptionUnit;
/**
* Option about visual properties used in piecewise mapping
* Used in each piece.
*/
export type VisualOptionPiecewise = VisualOptionUnit;
/**
* Option about visual properties used in linear mapping
*/
export type VisualOptionLinear = Arrayable<VisualOptionUnit>;
/**
* Option about visual properties can be encoded from ordinal categories.
* Each value can either be a dictonary to lookup with category name, or
* be an array to lookup with category index. In this case the array length should
* be same with categories
*/
export type VisualOptionCategory = Arrayable<VisualOptionUnit> | Dictionaryable<VisualOptionUnit>;
/**
* All visual properties can be encoded.
*/
export type BuiltinVisualProperty = keyof VisualOptionUnit;
export interface TextCommonOption extends ShadowOptionMixin {
color?: string
fontStyle?: ZRFontStyle
fontWeight?: ZRFontWeight
fontFamily?: string
fontSize?: number | string
align?: HorizontalAlign