budget-view-chart/dist/DataProcessor.d.ts

A React chart component specialising in display budget for personal finance.

import { type BudgetRecord } from './data.interface';
/**
 * Data structure representing a budget item
 */
export declare class BudgetData {
    name: string;
    description: string;
    monthlyBudget: number;
    amount: number;
    xStart: number;
    xLength: number;
    yStart: number;
    yLength: number;
    static EChartsDataSetDimensions: {
        name: string;
        type: string;
    }[];
}
/**
 * Data structure representing a block on the chart
 */
export declare class ChartData {
    type: 'breakdown' | 'aggregate';
    name: string;
    description: string;
    monthlyBudget: number;
    month: number;
    amount: number;
    xStart: number;
    xLength: number;
    yStart: number;
    yLength: number;
    static EChartsDataSetDimensions: {
        name: string;
        type: string;
    }[];
}
export declare class DataProcessor {
    budgetRecords: BudgetRecord[];
    TOTAL_X: number;
    TOTAL_Y: number;
    totalBudget: number;
    totalAmount: number;
    budgetNames: string[];
    /**
     * Construct a DataProcessor
     * @param {BudgetRecord[]} budgetRecords
     * @param {number} TOTAL_X
     * @param {number} TOTAL_Y
     */
    constructor(budgetRecords: BudgetRecord[], TOTAL_X: number, TOTAL_Y: number);
    getHighestY: () => number;
    getLowestY: () => number;
    getBudgetData: () => BudgetData[];
    /**
     *
     * @returns {ChartData[]}
     */
    getChartData: () => ChartData[];
    getMonthlyAggregatedChartData: () => ChartData[][];
}