@adaptabletools/adaptable/src/AdaptableState/StyledColumns/PercentBarStyle.d.ts

Powerful AG Grid extension which provides advanced, cutting-edge functionality to meet all DataGrid requirements

import { CellFontStyle } from '../Common/AdaptableStyle';
import { BarStyleCellTextProperties } from './Common/BarStyleProperties';
import { CellTextOptions } from './Common/CellTextOptions';
import { NumericStyledColumn } from './Common/NumericStyledColumn';
/**
 * Style used to display Percent Bars in Special Column Style
 */
export interface PercentBarStyle extends NumericStyledColumn {
    /**
     * Optional cell-text overlay configuration (display tokens, position, layout, alignment).
     */
    CellTextProperties?: BarStyleCellTextProperties;
    /**
     * Whether Tooltip shows Cell Value, Percent Value, both or none
     */
    ToolTipText?: CellTextOptions;
    /**
     * Background colour for 'Percent Bar'; leave unset if none required
     * @defaultValue undefined
     */
    BackColor?: string;
    /**
     * Origin of the bar - i.e. the value the bar grows from Auto, Zero, Min or fixed number
     *
     * @defaultValue 'Auto'
     */
    Origin?: 'Auto' | 'Zero' | 'Min' | number;
    /**
     * Optional cell-text styling applied to `CellText` overlay
     */
    Font?: CellFontStyle;
}