@zhsz/cool-design-dv
Version:
50 lines (49 loc) • 1.83 kB
TypeScript
/**
* 把用户的列配置转换成标准的配置格式
* @param {string|object[]} columns
* @return {*}
*
* @example
*
* 用户的配置有以下格式
* 1、数据项是字符串，如：['月份', '销量']
* 2、数据项是对象形式，如：
* [
* {name:'month',displayName:'月份'},
* {name:'value', displayName:'销量', type:'int', unit:'k', precision:0, sort:true|asc|desc}
* ]
* 其中 name、displayName、type是echarts自带功能， unit、precision 是自扩展功能
* type 表示数据类型，通常不需要设置，echarts 会自动识别，可选值：number | ordinal | float | float | time
* unit 表示转换数据单位，需要对数据进行转换时设置，可选值：k（千） | w（万） | p（百分比）
* precision 转换数据精度，保留几位小数，默认：0
* sort 排序，从大到小
*
* 该函数的作用是统一把用户配置都转换成标准的对象配置形式
*/
export declare function columnsToStandard({ columns }: {
columns?: never[] | undefined;
}): {
name: never;
}[];
/**
* 构造 dataset
* @param {Object[]} standardColumns 标准列配置
* @param {string} id
* @param {string[]|Object[]} columns 列配置
* @param {array[]|object[]} rows 行数据
* @param {string} layout 用行还是列对应到系列上，即 echarts 的配置seriesLayoutBy, 可选：column | row ，默认：column
* @param {boolean} header 数据是否包含列头，默认echarts自动判断
* @param {object} settings 配置
* @return {Object}
*/
export declare function createDataset(standardColumns: any, { id, rows, layout, header }: {
id: any;
rows: any;
layout?: string | undefined;
header: any;
}, settings: any): {
id: any;
dimensions: any;
source: any[][];
sourceHeader: any;
};