NuclearDispersionSystem/ant-design-vue-jeecg/node_modules/@antv/g2/esm/util/scale.d.ts
2023-09-14 14:47:11 +08:00

27 lines
881 B
TypeScript

import { Scale } from '../dependents';
import { LooseObject, ScaleOption } from '../interface';
/**
* @ignore
* 为指定的 `field` 字段数据创建 scale
* @param field 字段名
* @param [data] 数据集,可为空
* @param [scaleDef] 列定义,可为空
* @returns scale 返回创建的 Scale 实例
*/
export declare function createScaleByField(field: string | number, data?: LooseObject[] | [], scaleDef?: ScaleOption): Scale;
/**
* @ignore
* 同步 scale
* @todo 是否可以通过 scale.update() 方法进行更新
* @param scale 需要同步的 scale 实例
* @param newScale 同步源 Scale
*/
export declare function syncScale(scale: Scale, newScale: Scale): void;
/**
* @ignore
* get the scale name, if alias exist, return alias, or else field
* @param scale
* @returns the name of field
*/
export declare function getName(scale: Scale): string;