@railzai/railz-visualizations
Version:
Railz.ai Visualizations
32 lines (31 loc) • 1.68 kB
TypeScript
import { RVChartOptionsParameter, RVChartStatementBaseParameter, RVChartStatementParameter, RVFilterStatements, RVFormattedStatementData, RVFormattedStatementResponse, RVReportRequestParameter } from '../../types';
/**
* Setup Highcharts options for bar charts
*/
export declare const getOptionsBarChart: ({ categories, series, colors, chart, }: RVChartOptionsParameter) => any;
/**
* Formats data into Highcharts format for cashflow statement
*/
export declare const formatCashflowData: ({ summary, reportFrequency, chart, date, }: RVChartStatementBaseParameter) => RVFormattedStatementData;
/**
* Formats data into Highcharts format for balance sheet
*/
export declare const formatBalanceSheetData: ({ summary, reportFrequency, chart, date, }: RVChartStatementBaseParameter) => RVFormattedStatementData;
/**
* Formats data into Highcharts format for income statement
*/
export declare const formatIncomeStatementData: ({ summary, reportFrequency, chart, date, }: RVChartStatementBaseParameter) => RVFormattedStatementData;
/**
* Formats retrieved data into Highcharts format based on different report type
*/
export declare const formatData: (statementParameter: RVChartStatementParameter) => RVFormattedStatementData;
/**
* Make API call based on expected parameters for financial statements data type
*/
export declare const getReportData: ({ filter, }: RVReportRequestParameter) => Promise<RVFormattedStatementResponse>;
/**
* Checks whether we need to add reconstruct: true to the params or not
* @param {RVStatementsFilter} filter - Current filter
* @returns {boolean}
*/
export declare const shouldAddReconstructParam: (filter: RVFilterStatements) => boolean;