@railzai/railz-visualizations
Version:
Railz.ai Visualizations
82 lines (81 loc) • 3.05 kB
TypeScript
import { RVReportTypes } from '../types/enum/report-type';
import { RVFormat, RVReportFrequency, RVReportStatementSummary } from '../types';
/**
* Format date that will be shown on charts and show short form
*/
export declare const formatDate: (summary: RVReportStatementSummary, reportFrequency: RVReportFrequency, dateFormat?: RVFormat) => string[];
export declare const formatNegativeValues: (name: string, value: number) => any;
/**
* Filter data to ensure there is no undefined field result
*/
export declare const formatSeries: (summary: RVReportStatementSummary, name: string, field: string) => {
name: string;
data: RVReportStatementSummary;
};
/**
* Format number displayed on UI to 2 decimals and thousand separator
*/
export declare const formatNumber: (number: number | string, decimals?: number, minimum?: number) => string;
export declare const formatCurrencyValue: (value: number, decimals?: number, fallbackValue?: string) => string;
/**
* Determine if report type is table
*/
export declare const isBankAccounts: (reportType: RVReportTypes) => boolean;
/**
* Determine if report type is financialRatios
*/
export declare const isFinancialRatios: (reportType: RVReportTypes) => boolean;
/**
* Determine if report type is gauge
*/
export declare const isCreditScore: (reportType: RVReportTypes) => boolean;
/**
* Determine if report type is bank reconciliation
*/
export declare const isBankReconciliation: (reportType: RVReportTypes) => boolean;
/**
* Determine if report type is business valuations
*/
export declare const isBusinessValuations: (reportType: RVReportTypes) => boolean;
/**
* Determine if report type is Tax Benchmarking
*/
export declare const isTaxBenchmarking: (reportType: RVReportTypes) => boolean;
/**
* Determine if report type is pie
*/
export declare const isIncomeStatements: (reportType: RVReportTypes) => boolean;
/**
* Determine if report type is financial statements
*/
export declare const isStatements: (reportType: RVReportTypes) => boolean;
/**
* Determine if report type is transactional
*/
export declare const isTransactions: (reportType: RVReportTypes) => boolean;
/**
* Get title of report types to be displayed on the box
*/
export declare const getTitleByReportType: (reportType: RVReportTypes) => string;
/**
* Get information about reports with report frequency
*/
export declare const isRequiredReportFrequency: (reportType: RVReportTypes) => boolean;
/**
* Get information about reports with accounting method
*/
export declare const isRequiredAccountingMethod: (reportType: RVReportTypes) => boolean;
/**
* Round number and format to display
*/
export declare const roundNumber: (number: number, mantissa?: number) => string;
/**
* return an inline styling string based on a css styling object,
* taking in consideration only stirng or number styling values.
*/
export declare const fromCssObjectToInline: (cssObject?: {
[key: string]: any;
}) => string;
export declare const handleError: (responseData: {
[key: string]: any;
}) => number;