@antv/s2/lib/utils/number-calculate.d.ts

effective spreadsheet render core lib

import { Aggregation, type ViewMetaData } from '../common/interface';
export declare const isNotNumber: (value: unknown) => boolean;
export declare const canConvertToNumber: (a?: string | number) => boolean;
/**
 * 计算数据项的和
 * @param data 数据项
 * @param field 值字段
 * @returns 算术和
 */
export declare const getDataSumByField: (data: ViewMetaData[], field: string) => number;
/**
 * 计算数据项的极值
 * @param method 最大值(max)或最小值(min)
 * @param data 数据项
 * @param field 值字段
 * @returns 最值
 */
export declare const getDataExtremumByField: (method: 'min' | 'max', data: ViewMetaData[], field: string) => number | undefined;
/**
 * 计算数据项的平均值
 * @param data 数据项
 * @param field 值字段
 * @returns 算术平均值
 */
export declare const getDataAvgByField: (data: ViewMetaData[], field: string) => number;
/**
 *
 * @param data
 */
export declare const getDataCountByField: (data: ViewMetaData[]) => number;
/**
 * totals 计算方法集合
 */
export declare const calcActionByType: {
    [type in Aggregation]: (data: ViewMetaData[], field: string) => number | undefined;
};