@widergy/web-utils/lib/consumptionGraphics.d.ts

Utility GO! Web utils

import { Account, BarDataColors, Bars, Bill, CarbonFootprintKpis, CarbonFootprintValues, ChartData, Coefficients, Consumption, ConsumptionData, ConsumptionHistory, Day, Days, EnableSelection, HighlightColors, IndicatorsConfig, Period, PeriodConcepts, PeriodConsumptionType, Periods, Styles } from './constants/consumptionInterfaces';
export declare const getPagination: (granularity: string, year: number, day: number, period: number) => number;
export declare const extractPeriod: (value?: string) => number;
export declare const extractYear: (value?: string) => number;
export declare const getMonthLabel: (key: string) => string;
export declare const getMonthsFromChartData: (data: {
    key: string;
}[]) => Set<string>;
export declare const getMonthIndicators: (config: IndicatorsConfig) => {
    label: string;
    x: number;
    textAnchor: string;
}[];
export declare const getDayIndicators: (indicators: {
    label: string;
    range: number;
}[]) => (config: IndicatorsConfig) => {
    x: number;
    label?: string;
    range?: number;
    textAnchor: string;
    withLine: boolean;
}[];
export declare const carbonFootprintValue: (currentData: CarbonFootprintValues[]) => number;
export declare const getPeriodDuration: (startDate: Date | string, endDate: Date | string) => number;
export declare const getGranularityLength: (granularity: string, data: {
    periods: Periods[];
}, selectedPeriod?: number | undefined | null) => number;
export declare const getDateIndexInPeriod: (startDate: Date | string, date: Date | string) => number;
export declare const getHiredPower: (chartData: ChartData, selectedYear: string, selectedPeriod: number) => number | Date | undefined;
export declare const getHighestConsumption: (days: Days[]) => Days;
export declare const getTooltipContent: (period: number, year: number | string, periodText?: string) => string;
export declare const getPeriodData: (consumption: Consumption[], metric: string, type: string, forCsv?: boolean, carbonDioxidePerKilowattHour?: number, isCarbonFootprintTab?: boolean) => string | number | undefined;
export declare const processChartData: (unprocessedData: ChartData, dataType: string, granularity: string, year: string, withLastYear: boolean, selectedPeriod: number | undefined | null, selectedDay: string | undefined | null, periodChartData: {
    days: Day[];
}, unit: string, carbonDioxidePerKilowattHour: number, isCarbonFootprintTab: boolean, roundMetricValue: Function) => any[];
export declare const processTempData: (chartData: ChartData, granularity: string, year: string, withLastYear: boolean, selectedPeriod: number | undefined | null) => any[];
export declare const getCurrentDay: (periodChartData: {
    days: Day[];
}, selectedDay: string | undefined | null) => Day | undefined;
export declare const getColors: (key: string, periodConcepts: PeriodConcepts[], defaultColor: string) => string;
export declare const processData: (unprocessedData: ChartData, currentTab: string, year: string, withGradient?: boolean, defaultTangentGradientColor?: string) => any[] | undefined;
export declare const generateCSVData: (consumptionHistory: ConsumptionHistory) => {
    carbonFootprint?: number | undefined;
    year: number;
    month: string;
    period_started_on: string;
    period_ended_on: string;
    consumption: number;
    consumption_on_peak: number;
    consumption_remainder: number;
    consumption_valley: number;
    amount: string | number;
    power_billed_on_peak: number;
    power_billed_remainder: number;
    power_billed_valley: number;
    phi_tangent: number;
    purchased_power: number;
    billed_power: number;
}[];
export declare const addConcepts: (config: Bars, concepts: string[], hasConcepts: boolean) => Bars;
export declare const removeDots: (value: string) => string;
export declare const getLinearData: (bills: any[] | undefined, lines: any[] | undefined, isCarbonFootprintTab: boolean, carbonDioxidePerKilowattHour: number) => {
    data: {
        xCoordinate: number;
        value: any;
    }[];
    type: string;
    color: any;
    customLineProps: {
        fill: string;
        strokeDasharray: string;
        strokeWidth: string;
    };
}[];
export declare const getXAxisDefinition: (bills: Bill[] | undefined, billDetails: Bill, yearsToDisplay: string[] | undefined, getYearColor: Function, activeColor: string, disabledColor: string, fullPeriodLabel: boolean | undefined, square: object, labelBackgroundPadding: number) => {
    mainLabel: string;
    mainLabelStyles: {
        fontWeight: string;
    };
    color: string;
    circle: false;
    square: false | object;
    labelBackgroundPadding: number;
}[];
export declare const getAnnualcarbonFootprintKpiValues: (carbonFootprintKpis: CarbonFootprintKpis[]) => {
    carbonFootprintAnnualConsumption: number;
    kmPerKilowattHourAnnual: number;
    treesPerKilowattHourAnnual: number;
};
export declare const isPeriodCurrentYear: (period: string) => boolean;
export declare const formatPeriod: (period: string, monthYearFormat?: boolean) => string;
export declare const getBarData: (consumptionData: ConsumptionData[], colors: BarDataColors, highlightColors: HighlightColors) => {
    isCurrentYear: boolean;
    value: number;
    color: string;
    clickable: boolean;
    highlightColor: string;
    bimester: string;
    client_number: string;
    period_started_on: string;
    period_ended_on: string;
    consumption_unit: import("./constants/consumptionInterfaces").ConsumptionUnitV0;
    amount: number;
    billed_power: number;
    purchased_power: number;
    month: string;
    year: number;
}[];
export declare const getXAxisDefinitionV0: (consumptionData: ConsumptionData[], monthYearFormat: boolean, colors: BarDataColors) => {
    mainLabel: string;
    selectedLabelBackground: string;
    labelBackgroundPadding: number;
}[];
export declare const references: (styles: Styles) => {
    id: string;
    label: string;
    className: string;
    check: ({ isCurrentYear, value }: {
        isCurrentYear: boolean;
        value: number;
    }) => boolean;
}[];
export declare const handleCheckProfile: (currentAccount: Account, goToDashboard: Function, getForm: Function, openAlertDialog: Function, notifyEventToUtility: Function, notifyText: string) => boolean;
export declare const desagregateConcepts: (bill: ConsumptionHistory) => {};
export declare const generateCarbonFootprintData: (consumption: number, coefficients: Coefficients) => {
    carbonFootprint?: undefined;
    kmPerKilowattHour?: undefined;
    treesPerKilowattHour?: undefined;
    sheetsPerKilowattHour?: undefined;
} | {
    carbonFootprint: number;
    kmPerKilowattHour: number;
    treesPerKilowattHour: number;
    sheetsPerKilowattHour: number;
};
export declare const getConcepts: (history: ConsumptionHistory[]) => string[];
export declare const generateCarbonFootprintTotalConsumption: (periodConsumptionType: PeriodConsumptionType[], carbonFootprintCoefficient: number) => number;
export declare const isCurrentPeriod: (periodEndDate: string | Date) => boolean;
export declare const getMostRecentYear: (chartData: ChartData) => string;
export declare const getAvailableYears: (chartData: ChartData) => {
    value: string;
    label: string;
}[];
export declare const hasPreviousNonSmartDataCheck: ({ lastYearIsSmart, value, isCurrentYear, }: {
    lastYearIsSmart: boolean;
    value: number;
    isCurrentYear: boolean;
}) => boolean;
export declare const hasPreviousSmartDataCheck: ({ lastYearIsSmart, value, isCurrentYear, }: {
    lastYearIsSmart: boolean;
    value: number;
    isCurrentYear: boolean;
}) => boolean;
export declare const hasCurrentSmartDataCheck: ({ isSmart, value, isCurrentYear, }: {
    isSmart: boolean;
    value: number;
    isCurrentYear: boolean;
}) => boolean;
export declare const hasCurrentNonSmartDataCheck: ({ isSmart, value, isCurrentYear, }: {
    isSmart: boolean;
    value: number;
    isCurrentYear: boolean;
}) => boolean;
export declare const hasCurrentAverageTemperatureCheck: ({ value, isCurrentYear, }: {
    value: number;
    isCurrentYear: boolean;
}) => boolean;
export declare const hasPreviousAverageTemperatureCheck: ({ value, isCurrentYear, }: {
    value: number;
    isCurrentYear: boolean;
}) => boolean;
export declare const hasHolidaysCheck: ({ highlighted }: {
    highlighted: boolean;
}) => boolean;
export declare const hasExceededPowerCheck: ({ overHiredPower }: {
    overHiredPower: boolean;
}) => boolean;
export declare const hasAmount: (id: string) => ({ id: ownId, value }: {
    id: string;
    value: any;
}) => boolean;
export declare const getMetricByType: (currentPeriod: Periods | any, consumptionType: string, consumptionMetric: string, metricType: string) => any;
export declare const noValues: (data: CarbonFootprintValues[], isArray: boolean | undefined) => boolean;
export declare const noImportAmountValues: (data: any[]) => boolean;
export declare const getCurrentPeriod: (chartData: ChartData, selectedYear: number | string, selectedPeriod: number | undefined | null) => Periods | undefined;
export declare const linearScaler: (domain: number[], range: number[]) => any;
export declare const getStartAngle: (elem: number, numOfElements: number) => number;
export declare const getEndAngle: (elem: number, numOfElements: number) => number;
export declare const hasPeriodFinished: (period: Period) => boolean;
export declare const isFuturePeriod: (period: Period) => boolean;
export declare const getpercentageOfPeriod: (period: Period) => number;
export declare const percentage: (percent: number, total: number) => number;
export declare const getConsumptionPercentage: ({ highestConsumptionAmount, hiredPowerValue, isOverHired, }: {
    highestConsumptionAmount: number;
    hiredPowerValue: number;
    isOverHired: boolean;
}) => number;
export declare const getDaysFromData: (chartData: ChartData, currentYear: string, currentPeriod: number | undefined) => Day[];
export declare const getInitialValues: (granularity: string, currentYear: string, currentPeriod: number | undefined, currentDay: string | undefined) => {
    label: number | undefined;
    value: number | undefined;
} | {
    label: string | undefined;
    value: string | undefined;
} | undefined;
export declare const granularitySelectionOptions: (chartData: ChartData, selectedYear: string, periods: any[] | undefined, selectedPeriod: number | undefined, days: any[] | undefined, returnToGranularity: Function, enableSelection: EnableSelection) => {
    [x: string]: {
        selectable: boolean;
        options: {
            value: string;
            label: string;
        }[];
    }[] | ({
        selectable: boolean;
        value: string;
        onClick: () => any;
        options?: undefined;
    } | {
        selectable: boolean;
        options: {
            value: any;
            label: string;
        }[];
        value?: undefined;
        onClick?: undefined;
    })[] | ({
        selectable: boolean;
        value: string;
        onClick: () => any;
        options?: undefined;
    } | {
        selectable: boolean;
        options: {
            label: string;
            value: any;
        }[];
        value?: undefined;
        onClick?: undefined;
    })[];
};
export declare const getBreadCrumbsOptions: (chartData: ChartData, currentYear: string, currentPeriod: number | undefined, granularity: string, returnToGranularity: Function | any, enableSelection: EnableSelection) => {
    selectable: boolean;
    options: {
        value: string;
        label: string;
    }[];
}[] | ({
    selectable: boolean;
    value: string;
    onClick: () => any;
    options?: undefined;
} | {
    selectable: boolean;
    options: {
        value: any;
        label: string;
    }[];
    value?: undefined;
    onClick?: undefined;
})[] | ({
    selectable: boolean;
    value: string;
    onClick: () => any;
    options?: undefined;
} | {
    selectable: boolean;
    options: {
        label: string;
        value: any;
    }[];
    value?: undefined;
    onClick?: undefined;
})[];
export declare const changeValue: (indexOfCurrentValue: number, options: {
    label: string | number;
    value: string | number;
}[], handleOnChange: Function, nextValue: boolean | undefined) => any;