@adaptabletools/adaptable
Version:
Powerful AG Grid extension which provides advanced, cutting-edge functionality to meet all DataGrid requirements
49 lines (48 loc) • 1.51 kB
TypeScript
import { CellFontStyle } from '../Common/AdaptableStyle';
import { CellTextOptions } from './Common/CellTextOptions';
import { NumericStyledColumn } from './Common/NumericStyledColumn';
/**
* Colours for a zero-centred diverging gradient: negative and positive bands that meet at `0`
*/
export interface ZeroCentredColors {
/**
* Colour applied to negative cell values (`Col-Min`…`0`)
*/
NegativeColor: string;
/**
* Colour applied to positive cell values (`0`…`Col-Max`)
*/
PositiveColor: string;
}
/**
* Used to display Gradient Styles
*/
export interface GradientStyle extends NumericStyledColumn {
/**
* Zero-centred diverging gradient (`Col-Min`…`0` and `0`…`Col-Max`
*/
ZeroCentred?: ZeroCentredColors;
/**
* Alpha (0–1) at **low** end of the matched range’s scale
*
* @defaultValue 0.15 (faint at range min)
*/
MinAlpha?: number;
/**
* Alpha (0–1) at **high** end of the matched range’s scale
* @defaultValue 1 (fully opaque at range max)
*/
MaxAlpha?: number;
/**
* When true, sets cell `color` from tinted background so text stays readable
*/
AutoContrastText?: boolean;
/**
* Optional AG Grid tooltip content: cell value and/or position along the range scale (%)
*/
ToolTipText?: CellTextOptions;
/**
* Optional cell-text styling applied by Gradient renderer **on top of** gradient background tint
*/
Font?: CellFontStyle;
}