UNPKG

1.33 kBTypeScriptView Raw
1import { Scale, Coordinate } from '../dependents';
2import { LooseObject, ScaleOption, ViewCfg } from '../interface';
3/**
4 * @ignore
5 * 为指定的 `field` 字段数据创建 scale
6 * @param field 字段名
7 * @param [data] 数据集,可为空
8 * @param [scaleDef] 列定义,可为空
9 * @returns scale 返回创建的 Scale 实例
10 */
11export declare function createScaleByField(field: string | number, data?: LooseObject[] | [], scaleDef?: ScaleOption): Scale;
12/**
13 * @ignore
14 * 同步 scale
15 * @todo 是否可以通过 scale.update() 方法进行更新
16 * @param scale 需要同步的 scale 实例
17 * @param newScale 同步源 Scale
18 */
19export declare function syncScale(scale: Scale, newScale: Scale): void;
20/**
21 * @ignore
22 * get the scale name, if alias exist, return alias, or else field
23 * @param scale
24 * @returns the name of field
25 */
26export declare function getName(scale: Scale): string;
27/**
28 * 根据 scale values 和 coordinate 获取分类默认 range
29 * @param scale 需要获取的 scale 实例
30 * @param coordinate coordinate 实例
31 * @param theme theme
32 */
33export declare function getDefaultCategoryScaleRange(scale: Scale, coordinate: Coordinate, theme: ViewCfg['theme']): Scale['range'];
34/**
35 * @function y轴scale的max
36 * @param {yScale}
37 */
38export declare function getMaxScale(scale: Scale): number;