UNPKG

1.95 kBTypeScriptView Raw
1export declare type ScaleType = 'base' | 'linear' | 'cat' | 'log' | 'pow' | 'identity' | 'time' | 'timeCat';
2export declare type TickMethod = (ScaleConfig: any) => any[];
3export interface Tick {
4 /** 展示名 */
5 text: string;
6 /** 值域值 */
7 value: number;
8 /** 定义域值 */
9 tickValue: string | number;
10}
11export declare type ScaleConfig = Partial<{
12 /** 对应的字段id */
13 field: string;
14 /** 输入域、定义域 */
15 values: any[];
16 /** 定义域的最小值,d3为domain,ggplot2为limits,分类型下无效 */
17 min: any;
18 /** 定义域的最大值,分类型下无效 */
19 max: any;
20 /** 严格模式下的定义域最小值,设置后会强制 ticks 从最小值开始 */
21 minLimit?: any;
22 /** 严格模式下的定义域最大值,设置后会强制 ticks 已最大值结束 */
23 maxLimit?: any;
24 /** 数据字段的显示别名,scale内部不感知,外部注入 */
25 alias: string;
26 /** 输出域、值域,默认值为[0, 1] */
27 range: number[];
28 /** Log有效,底数 */
29 base: number;
30 /** Pow有效,指数 */
31 exponent: number;
32 /** 自动调整min、max */
33 nice: boolean;
34 /** 用于指定tick,优先级最高 */
35 ticks: any[];
36 /** tick间隔,只对分类型和时间型适用,优先级高于tickCount */
37 tickInterval: number;
38 /** tick最小间隔,只对线型适用 */
39 minTickInterval: number;
40 /** tick个数,默认值为5 */
41 tickCount: number;
42 /** ticks最大值,默认值为10 */
43 maxTickCount: number;
44 /** tick格式化函数,会影响数据在坐标轴 axis、图例 legend、tooltip 上的显示 */
45 formatter: (value: any, index?: number) => any;
46 /** 计算 ticks 的算法 */
47 tickMethod: string | TickMethod;
48 /** 时间度量 time, timeCat 时有效 */
49 mask?: string;
50 /** 是否始终保留最后一个 tick */
51 showLast?: boolean;
52}>;