Skip to main content

API

This section describes the API of the ui-reports library.

Interfaces​

FINANCIAL_STATISTIC​

export enum FINANCIAL_STATISTIC {
  donutRevenue,
  donutExpense,
  predictedRevenue,
  predictedExpense,
  doneRevenue,
  doneExpense,
  predictedWeekBalance,
  predictedEndOfMonthBalance,
  lateRevenue,
  lateExpense,
  lineDailyBalance,
  barMonthlyComparative,
}

ResultItem​

interface ResultItem {
  bank_id?: BANK;
  index?: number;
  percent?: number;
  value?: number;
  name?: string;
}

DashboardActionProperties​

export interface DashboardActionProperties {
  label?: string;
  label$?: Observable<string>;
  asyncLabel?: boolean;
  imagePath: string;
  trackingModel?: TRACKING_MODELS;
}

RecordsSummaryProperties​

interface RecordsSummaryProperties {
  label: string;
  key: keyof DashboardRecordsCount;
  redirectTo: 'cashFlow' | 'conciliationGroup';
  queryParams?: RecordListFilters;
  trackingModel?: TRACKING_MODELS;
  onClick?: () => void;
}

BarGraphDataItem​

export interface BarGraphDataItem {
  name: string;
  series: {
    name: string;
    value: number;
  }[];
}

BarGraphHoveredItem​

interface BarGraphHoveredItem {
  name: string;
  value: number;
  label: string;
  series: string;
}

DonutDataItem​

export interface DonutDataItem {
  name: string;
  value: number;
  type: 'main' | 'secondary';
}

LineGraphDataItem​

export interface LineGraphDataItem {
  name: string;
  series: {
    name: string;
    value: number;
  }[];
}

LineGraphSelectedItem​

interface LineGraphSelectedItem {
  name: string;
  value: number;
  series: string;
}

ComparativeObject​

export interface ComparativeItem {
  class: string;
  text: string;
  percent?: string;
  tip?: string;
}

export type ComparativeObject = Record<string, ComparativeItem[]>;

Enums​

DASHBOARD_RECORD_STATUS​

export enum DASHBOARD_RECORD_STATUS {
  unclassified,
  unidentified,
  scheduled,
  late,
  conciliationGroup,
  partiallyClassified,
}

Types​

ComparativePeriod​

export type ComparativePeriod = 'monthly' | 'bimonthly' | 'quarterly' | 'semiannual' | 'yearly' | '';