import type { Locale } from '../../i18n';
import type { AnnotationArea, AnnotationHorizontalLine, AnnotationPoint, AnnotationVerticalLine, BackgroundColor, Brush, BarStyle, Color, CrosshairRect, Dataset, Label, Legend, StackCornerRadius, Theme, Tooltip, XLinearAxis, YBandAxis, Sort, SortLegend, BarMaxWidth, DimensionLinkage, BarDimension, BarMeasure, Page, Player } from '../../properties';
/**
 * @description 百分比条形图，适用于横向展示各类别占比关系的场景，X轴以百分比形式展示数据占比
 * 适用场景:
 * - 类别名称较长时的占比对比
 * - 多维度数据的横向构成分析
 * - 排名与占比同时展示的场景
 * @encoding
 * 百分比条形图支持以下视觉通道:
 * `yAxis`  : y轴通道, 支持`多个维度`, 按维度值映射至y轴
 * `xAxis`  : x轴通道, 支持`多个指标`, 按指标值映射至x轴
 * `detail` : 细分通道, 支持`多个维度`, 在同一个颜色系列下展示更细粒度的数据时使用
 * `color`  : 颜色通道, 支持`多个维度`或 `一个指标`, 维度颜色用于区分不同的数据系列, 指标颜色用于线性映射指标值到图形颜色
 * `tooltip`: 提示通道, 支持`多个维度`与 `多个指标`, 会在鼠标悬停在数据点上时展示
 * `label`  : 标签通道, 支持`多个维度`与 `多个指标`, 会在数据点上展示数据标签
 * @warning
 * 数据要求:
 * - 至少1个维度字段和1个度量字段
 * - 所有类别占比之和为100%
 * - 支持多系列堆叠展示占比关系
 * 默认开启的功能:
 * - 默认开启图例、坐标轴、百分比标签、提示信息、占比计算
 * @recommend
 * - 推荐字段配置: `1`个指标, `2`个维度
 * - 支持数据重塑: 至少`1`个指标, `0`个维度
 */
export interface BarPercent {
    /**
     * @description 百分比条形图，以横向百分比形式展示各类别数据占比关系
     * @type {'barPercent'}
     * @example 'barPercent'
     */
    chartType: 'barPercent';
    /**
     * @description 数据源, 符合TidyData规范的且已经聚合的数据集，用于定义图表的数据来源和结构, 用户输入的数据集并不需要进行任何处理, VSeed带有强大的数据重塑功能, 会自行进行数据重塑, 百分比条形图的数据最终会被转换为2个维度, 1个指标.
     * @type {Array<Record<string|number, any>>}
     * @example [{category:'A', value:30}, {category:'B', value:70}]
     */
    dataset: Dataset;
    /**
     * @description 维度, 第一个维度会放至Y轴, 其余维度会与指标名称(存在多个指标时)合并, 作为图例项展示.
     * @type {Dimensions}
     * @example [{id: 'category', alias: '类别'}]
     */
    dimensions?: BarDimension[];
    /**
     * @description 指标, 指标会自动合并为一个指标, 映射到X轴, 存在多个指标时, 指标名称会与其余维度合并, 作为图例项展示.
     * @type {MeasureTree}
     * @example [{id: 'value', alias: '数值占比', format: 'percent'}]
     */
    measures?: BarMeasure[];
    /**
     * 分页
     * @description 分页配置，用于配置图表的分页功能
     */
    page?: Page;
    /**
     * @description 播放器配置, 用于指定播放的字段名, 必须是维度
     */
    player?: Player;
    /**
     * @description 图表的背景颜色, 默认为透明背景, 背景颜色可以是颜色字符串, 例如'red', 'blue', 也可以是hex, rgb或rgba'#ff0000', 'rgba(255,0,0,0.5)'
     */
    backgroundColor?: BackgroundColor;
    /**
     * @description 颜色配置, 用于定义图表的颜色方案, 包括颜色列表, 颜色映射, 颜色渐变等.
     */
    color?: Color;
    /**
     * @description 标签配置, 用于定义图表的数据标签, 包括数据标签的位置, 格式, 样式等.
     */
    label?: Label;
    /**
     * @description 图例配置, 用于定义图表的图例, 包括图例的位置, 格式, 样式等.
     */
    legend?: Legend;
    /**
     * @description 提示信息配置, 用于定义图表的提示信息, 包括提示信息的位置, 格式, 样式等.
     */
    tooltip?: Tooltip;
    /**
     * 框选
     * @description 框选配置，用于开启/关闭 brush 框选能力
     */
    brush?: Brush;
    /**
     * @description x轴, 数值轴, x轴配置, 用于定义图表的x轴, 包括x轴的位置, 格式, 样式等.
     */
    xAxis?: XLinearAxis;
    /**
     * @description y轴, 类目轴, y轴配置, 用于定义图表的y轴, 包括y轴的位置, 格式, 样式等.
     */
    yAxis?: YBandAxis;
    /**
     * @description 水平提示框配置, 用于定义图表的水平提示框, 包括水平提示框的颜色、标签样式等.
     */
    crosshairRect?: CrosshairRect;
    /**
     * @description 条形图 堆叠圆角
     * @default 8
     */
    stackCornerRadius?: StackCornerRadius;
    /**
     * @description 矩形的最大高度，可以是像素值或者百分比字符串
     */
    barMaxWidth?: BarMaxWidth;
    /**
     * @description Y轴排序配置, 支持根据维度或指标排序, 以及自定义排序顺序
     * @example
     * sort: {
     *   orderBy: 'profit',
     *   order: 'asc',
     * }
     * sort: {
     *   customOrder:['2019', '2020', '2021']
     * }
     */
    sort?: Sort;
    /**
     * @description 图例排序配置, 支持根据维度或指标排序, 以及自定义排序顺序
     * @example
     * sortLegend: {
     *   orderBy: 'profit',
     *   order: 'asc',
     * }
     * sortLegend: {
     *   customOrder:['2019', '2020', '2021']
     * }
     */
    sortLegend?: SortLegend;
    /**
     * 图表的主题, 主题是优先级较低的功能配置, 包含所有图表类型共用的通用配置, 与单类图表类型共用的图表配置
     * @default light 默认为亮色主题
     * @description 内置light与dark两种主题, 用户可以通过Builder自定义主题
     * @example 'dark'
     * @example 'light'
     * @example 'customThemeName'
     */
    theme?: Theme;
    /**
     * 矩形图元样式
     * @description 条形图样式配置, 用于定义图表的条形图样式, 包括条形图的颜色, 边框, 圆角等.
     * 支持全局样式或条件样式配置
     * 数据筛选器
     * 若配置selector, 提供数值 selector, 局部数据 selector, 条件维度 selector, 条件指标 selector 共四类数据匹配能力
     * 若未配置selector, 则样式全局生效.
     */
    barStyle?: BarStyle | BarStyle[];
    /**
     * 标注点
     * @description 标注点配置, 根据选择的数据, 定义图表的标注点, 包括标注点的位置, 格式, 样式等.
     */
    annotationPoint?: AnnotationPoint | AnnotationPoint[];
    /**
     * 标注垂直线
     * @description 数值标注线(包括均值线、最大值线、最小值线等)，竖直方向展示，能够设置标注线的位置, 样式等，如需绘制均值线等数值对应的标注线请使用该配置
     */
    annotationVerticalLine?: AnnotationVerticalLine | AnnotationVerticalLine[];
    /**
     * 标注水平线
     * @description 维度值标注线，水平展示，能够设置标注线的位置, 样式等
     */
    annotationHorizontalLine?: AnnotationHorizontalLine | AnnotationHorizontalLine[];
    /**
     * 标注区域
     * @description 标注区域配置, 根据选择的数据, 定义图表的标注区域, 包括标注区域的位置, 样式等.
     */
    annotationArea?: AnnotationArea | AnnotationArea[];
    /**
     * @description 当图表开启透视功能或者指标组合的是否，是否开启维度联动功能
     * 当hover 到某个维度值时，联动高亮其他图表中相同维度值的数据
     */
    dimensionLinkage?: DimensionLinkage;
    /**
     * 语言
     * @description 图表语言配置, 支持'zh-CN'与'en-US'两种语言, 另外可以调用 intl.setLocale('zh-CN') 方法设置语言
     * @default 'zh-CN'
     */
    locale?: Locale;
}
