@railzai/railz-visualizations/dist/types/helpers/chart.utils.d.ts

Railz.ai Visualizations

import { RVConfiguration, RVFilterAll, RVOptions, RVOptionsBarStyle, RVUpdateChartParameter, RVCreditScoreSummary, RVOptionsBankReconciliationStyle } from '../types';
/**
 * @function getConfiguration: if configuration is a string, convert to an object
 * Validate that configuration is present, if not, return formatted configuration as undefined
 * @param configuration: Authentication configuration
 */
export declare const getConfiguration: (configuration: RVConfiguration | string) => RVConfiguration;
/**
 * @function getFilter: if filter is a string, convert to an object
 * @param filter: Filter query
 */
export declare const getFilter: (filter: RVFilterAll | string) => RVFilterAll;
export declare const validateRequiredParams: (filter: RVFilterAll) => boolean;
export declare const validateIndustryCodeAndRegionParams: (filter: RVFilterAll) => boolean;
export declare const validateBusinessServiceNameParams: (filter: RVFilterAll) => boolean;
export declare const validateDateParams: (filter: RVFilterAll) => boolean;
export declare const validateReportFrequencyParams: (filter: RVFilterAll) => boolean;
export declare const validateReportTypeParams: (filter: RVFilterAll) => boolean;
/**
 * @function checkAccessibilityFromOptions:
 * Check if options passed are accessibility friendly
 * @param options: Whitelabeling options
 */
export declare const checkAccessibilityFromOptions: (options: RVOptions) => void;
/**
 * getOptions: if option is a string, convert to an object
 * and check if options are accessible
 * @param options: Whitelabeling options
 * @param filter: Filter query
 */
export declare const getOptions: (options: RVOptions | string) => RVOptions;
/**
 * getData: if data is a string, convert to an object
 */
export declare const getData: (options: RVCreditScoreSummary | string) => RVCreditScoreSummary;
/**
 * getBarOptionsStyle: if option is a string, convert to an object
 * this is used if railz-progress-bar is used directly
 * @param options: Whitelabeling options
 */
export declare const getBarOptionsStyle: (options: RVOptionsBarStyle | string) => RVOptionsBarStyle | never;
/**
 * getBankReconciliationOptionsStyle: if option is a string, convert to an object
 * this is used if railz-bank-reconciliation is used directly
 * @param options: Whitelabeling options
 */
export declare const getBankReconciliationOptionsStyle: (options: RVOptionsBankReconciliationStyle | string) => RVOptionsBankReconciliationStyle | never;
/**
 * getHighchartsParams: Combine generic stacked bar line chart
 * options and formatted data based on a given report type
 * into one option for highcharts usage
 * @param dataFormatted: formatted highchart data based on report type
 * @param options: Whitelabeling options
 */
export declare const getHighchartsParams: ({ dataFormatted, options, }: RVUpdateChartParameter) => any | never;