@antv/g2plot/lib/plots/liquid/types.d.ts

An interactive and responsive charting library

import { PathCommand } from '@antv/g-base';
import { Options, StyleAttr, ColorAttr, Statistic, ShapeStyle } from '../../types';
/**
 * @title 轮廓
 */
declare type Outline = Partial<{
    /**
     * @title 外环的宽度
     * @default "2px"
     */
    readonly border: number;
    /**
     * @title 内外的边距
     * @default "0px"
     */
    readonly distance: number;
    /**
     * @title 外环的样式
     */
    readonly style?: Pick<ShapeStyle, 'stroke' | 'strokeOpacity'>;
}>;
declare type Wave = Partial<{
    /**
     * @title 波形的数量
     * @default 3
     */
    readonly count: number;
    /**
     * @title 波形的长度
     * @default 192
     */
    readonly length: number;
}>;
declare type ShapeCallback = (x: number, y: number, width: number, height: number) => PathCommand[];
/**
 * @title 配置类型定义
 */
export interface LiquidOptions extends Omit<Options, 'data'> {
    /**
     * @title 指标比例
     */
    readonly percent: number;
    /**
     * @title 配置水波图的颜色
     * @description 使用默认色板的颜色
     */
    readonly color?: ColorAttr;
    /**
     * @title 水波的外半径
     * @description 范围0-1
     * @default 0.9
     */
    readonly radius?: number;
    /**
     * @title 水波图的样式
     */
    readonly liquidStyle?: StyleAttr;
    /**
     * @title 指标文本组件
     */
    readonly statistic?: Statistic;
    /**
     * @title 外环轮廓
     */
    readonly outline?: Outline;
    /**
     * @title 波的配置
     */
    readonly wave?: Wave;
    /**
     * @title 波的形状配置
     * @description （'circle' | 'rect' | 'triangle' | 'diamond'）
     */
    readonly shape?: string | ShapeCallback;
}
/**
 * @title 水波图自定义 的 customInfo
 */
export declare type CustomInfo = {
    radius?: LiquidOptions['radius'];
    outline?: LiquidOptions['outline'];
    wave?: LiquidOptions['wave'];
    shape?: LiquidOptions['shape'];
    background?: string;
    animation?: LiquidOptions['animation'];
};
export {};