@highcharts/dashboards/es-modules/Data/Modifiers/MathModifier.d.ts

Highcharts Dashboards framework

import type DataEvent from '../DataEvent';
import type DataTable from '../DataTable';
import type { Formula } from '../Formula/Formula';
import type { MathModifierOptions } from './MathModifierOptions';
import DataModifier from './DataModifier.js';
/**
 * Replaces formula strings in a table with calculated values.
 *
 * @class
 * @name Highcharts.DataModifier.types.MathModifier
 * @augments Highcharts.DataModifier
 */
declare class MathModifier extends DataModifier {
    /**
     * Default options of MathModifier.
     * @private
     */
    static readonly defaultOptions: MathModifierOptions;
    constructor(options: Partial<MathModifierOptions>);
    options: MathModifierOptions;
    modifyTable<T extends DataTable>(table: T, eventDetail?: (DataEvent.Detail | undefined)): T;
    /**
     * Process a column by replacing formula strings with calculated values.
     *
     * @private
     *
     * @param {Highcharts.DataTable} table
     * Table to extract column from and use as reference.
     *
     * @param {string} columnName
     * Name of column to process.
     *
     * @param {number} rowIndex
     * Row index to start the replacing process from.
     *
     * @return {Highcharts.DataTableColumn}
     * Returns the processed table column.
     */
    protected processColumn(table: DataTable, columnName: string, rowIndex?: number): DataTable.Column;
    /**
     * Process a column by replacing cell values with calculated values from a
     * given formula.
     *
     * @private
     *
     * @param {Highcharts.Formula} formula
     * Formula to use for processing.
     *
     * @param {Highcharts.DataTable} table
     * Table to extract column from and use as reference.
     *
     * @param {number} rowStart
     * Row index to start the replacing process from.
     *
     * @param {number} rowEnd
     * Row index to end the replacing process.
     *
     * @return {Highcharts.DataTableColumn}
     * Returns the processed table column.
     */
    protected processColumnFormula(formula: Formula, table: DataTable, rowStart?: number, rowEnd?: number): DataTable.Column;
}
declare module './DataModifierType' {
    interface DataModifierTypes {
        Math: typeof MathModifier;
    }
}
export default MathModifier;