import type { Palette } from '../../palettes/types';
import type { ElementDatum } from '../../types';
/**
* 色板配置项
*
* Palette options
* @public
*/
export type PaletteOptions = Palette | CategoricalPaletteOptions | ContinuousPaletteOptions;
export type STDPaletteOptions = CategoricalPaletteOptions | ContinuousPaletteOptions;
interface CategoricalPaletteOptions extends BasePaletteOptions {
/**
* 分组取色
*
* Coloring by group
*/
type?: 'group';
/**
* 分组字段,未指定时不分组
*
* Group field, no grouping when not specified
*/
field?: string | ((datum: ElementDatum) => string);
}
interface ContinuousPaletteOptions extends BasePaletteOptions {
/**
* 基于字段值取色
*
* Coloring based on field value
*/
type?: 'value';
/**
* 取值字段
*
* Value field
*/
field?: string | ((datum: ElementDatum) => string);
}
export interface BasePaletteOptions {
/**
* 色板颜色
*
* Palette color
*/
color?: Palette;
/**
* 倒序取色
*
* Color in reverse order
*/
invert?: boolean;
}
export {};