# Styled Columns Technical Reference Canonical page: https://www.adaptabletools.com/docs/technical-reference-styled-column ## Styled Column State | Property | Type | Description | | --- | --- | --- | | [StyledColumns](https://www.adaptabletools.com/docs/reference/styledcolumnstate.md#styledcolumns) | [`StyledColumn`](https://www.adaptabletools.com/docs/reference/styledcolumn.md)`[]` | Styled Columns to apply. Each one names a column and sets exactly one style property. | ### StyledColumn Each styled column is defined as follows: | Property | Type | Description | | --- | --- | --- | | [BadgeStyle](https://www.adaptabletools.com/docs/reference/styledcolumn.md#badgestyle) | [`BadgeStyle`](https://www.adaptabletools.com/docs/reference/badgestyle.md) | Any column. Draws the cell value as a pill. A `numberArray` or `textArray` column draws one pill per element; other array types are drawn as a single value.

`Badges` is the list of pill definitions. A `Rule` is an AdapTableQL boolean expression, evaluated per cell (and per element on a number or text array). Rules are tried in list order and the first match wins. A badge with no `Rule` is the fallback when no rule matches; if several have no rule, the first of those is used. `Density`, `Spacing` and `OverflowMode` (`Truncate`, `Wrap` or `Scroll`) apply to the whole column. | | [BulletChartStyle](https://www.adaptabletools.com/docs/reference/styledcolumn.md#bulletchartstyle) | [`BulletChartStyle`](https://www.adaptabletools.com/docs/reference/bulletchartstyle.md) | Numeric column. Draws a bullet chart in the cell: the value as a bar, a target as a marker, and optional qualitative bands behind the bar.

`CellRanges` colours those background bands (poor / ok / good). They are not a colour switch for the bar itself, which is what Percent Bar uses `CellRanges` for. `TargetProperties` supplies the target. `Orientation` is `Horizontal` (the default) or `Vertical`; a vertical chart needs a tall row. | | [ColumnId](https://www.adaptabletools.com/docs/reference/styledcolumn.md#columnid) | `string` | `colId` of the column this style draws.

AdapTable uses the first Styled Column with this `ColumnId`. | | [GradientStyle](https://www.adaptabletools.com/docs/reference/styledcolumn.md#gradientstyle) | [`GradientStyle`](https://www.adaptabletools.com/docs/reference/gradientstyle.md) | Numeric column. Tints the cell background by where the value sits in a range.

The cell text stays. Set `CellRanges` for bands (a traffic-light scale), or `ZeroCentred` for a diverging colour either side of 0. `ColumnComparison` measures this cell against another column. `RangeValueType` is `Number` (the default) or `Percentage` (0–100). | | [IconStyle](https://www.adaptabletools.com/docs/reference/styledcolumn.md#iconstyle) | [`IconStyle`](https://www.adaptabletools.com/docs/reference/iconstyle.md) | Scalar column. Looks the cell value up in `Mappings` (and an optional `Preset`) and draws the matching icon.

Array columns are not supported; use `BadgeStyle` to draw one glyph per array element. `Preset` is `Flags`, `Currencies`, `Trend` or `Status`. `MatchMode` is `Exact` (the default) or `CaseInsensitive`. When nothing matches, `FallbackProperties.Mode` is `Hide` (the default), `ShowText` or `Icon`. | | [Name](https://www.adaptabletools.com/docs/reference/styledcolumn.md#name) | `string` | Name shown in the Settings Panel and used by `styledColumnApi` to find this definition.

Unique among Styled Columns. | | [PercentBarStyle](https://www.adaptabletools.com/docs/reference/styledcolumn.md#percentbarstyle) | [`PercentBarStyle`](https://www.adaptabletools.com/docs/reference/percentbarstyle.md) | Numeric column. Draws a bar whose length is the cell value on the column's scale.

`CellRanges` colours the bar by which band the value falls in. `Origin` is where the bar grows from: `Auto` (the default), `Zero`, `Min`, or a fixed number. `ColumnComparison` measures the cell against another column. | | [RangeBarStyle](https://www.adaptabletools.com/docs/reference/styledcolumn.md#rangebarstyle) | [`RangeBarStyle`](https://www.adaptabletools.com/docs/reference/rangebarstyle.md) | Numeric column. Draws a track from `Min` to `Max` and a marker at the cell value.

`Min` and `Max` are required. Each can be a number, another column's `colId` (that row's value), or `Col-Min`, `Col-Max`, `Col-Avg` or `Col-Median` across the visible rows. `Reference` is an optional second marker (a target or a previous close). `CellRanges` draws background bands on the track. | | [RatingStyle](https://www.adaptabletools.com/docs/reference/styledcolumn.md#ratingstyle) | [`RatingStyle`](https://www.adaptabletools.com/docs/reference/ratingstyle.md) | Numeric column. Draws a row of icons (stars by default) filled in proportion to the cell value.

`Max` is both the number of icons and the top of the scale, in the same units as the cell value. The default is 5, so a value of 4 fills four of five stars. The value is clamped to `[0, Max]`. `AllowHalf` (the default) fills the boundary icon by the fraction; otherwise the value rounds to a whole icon. `Icon` is `Star`, `Heart`, `Circle` or `Thumb`. | | [RowScope](https://www.adaptabletools.com/docs/reference/styledcolumn.md#rowscope) | [`RowScope`](https://www.adaptabletools.com/docs/reference/rowscope.md) | Which row kinds draw the style: data (leaf) rows, group rows, summary rows and grand-total rows.

Each `Exclude*` flag turns that kind off. When `RowScope` is omitted, Badge draws on every row kind and every other style draws on every kind except group rows.

Sparkline ignores this for non-data rows: it only draws on leaf rows, because the cell value has to be the array of points. | | [SparklineStyle](https://www.adaptabletools.com/docs/reference/styledcolumn.md#sparklinestyle) | [`SparklineStyle`](https://www.adaptabletools.com/docs/reference/sparklinestyle.md) | Numeric-array column. The cell value is the series, and AG Grid's sparkline renderer draws it.

`options` is an AG Charts sparkline options object (`type: 'line'`, `'bar'`, `'area'` or `'column'`). Only leaf data rows are drawn. | | [IsReadOnly](https://www.adaptabletools.com/docs/reference/styledcolumn.md#isreadonly) | `boolean` | Sets Entity to ReadOnly (overwriting a Strategy Entitlement of 'Full') | | [IsSuspended](https://www.adaptabletools.com/docs/reference/styledcolumn.md#issuspended) | `boolean` | Suspends (i.e. turns off) an Adaptable Object | ### RowScope The optional `RowScope` property on [`StyledColumn`](https://www.adaptabletools.com/docs/reference/styledcolumn.md) controls which row types render the style: | Property | Type | Description | | --- | --- | --- | | [ExcludeDataRows](https://www.adaptabletools.com/docs/reference/rowscope.md#excludedatarows) | `boolean` | Exclude regular data rows | | [ExcludeGroupRows](https://www.adaptabletools.com/docs/reference/rowscope.md#excludegrouprows) | `boolean` | Exclude Group Rows | | [ExcludeSummaryRows](https://www.adaptabletools.com/docs/reference/rowscope.md#excludesummaryrows) | `boolean` | Exclude Summary Rows (used in Row Summaries) | | [ExcludeTotalRows](https://www.adaptabletools.com/docs/reference/rowscope.md#excludetotalrows) | `boolean` | Exclude Grand Total Rows (used in Aggregations) | --- ## Gradient Style | Property | Type | Description | Default | | --- | --- | --- | --- | | [AutoContrastText](https://www.adaptabletools.com/docs/reference/gradientstyle.md#autocontrasttext) | `boolean` | When true, sets cell `color` from tinted background so text stays readable | | | [Font](https://www.adaptabletools.com/docs/reference/gradientstyle.md#font) | [`CellFontStyle`](https://www.adaptabletools.com/docs/reference/cellfontstyle.md) | Optional cell-text styling applied by Gradient renderer **on top of** gradient background tint | | | [MaxAlpha](https://www.adaptabletools.com/docs/reference/gradientstyle.md#maxalpha) | `number` | Alpha (0–1) at **high** end of the matched range’s scale | 1 (fully opaque at range max) | | [MinAlpha](https://www.adaptabletools.com/docs/reference/gradientstyle.md#minalpha) | `number` | Alpha (0–1) at **low** end of the matched range’s scale | 0.15 (faint at range min) | | [ToolTipText](https://www.adaptabletools.com/docs/reference/gradientstyle.md#tooltiptext) | [`CellTextOptions`](https://www.adaptabletools.com/docs/reference/celltextoptions.md) | Optional AG Grid tooltip content: cell value and/or position along the range scale (%) | | | [ZeroCentred](https://www.adaptabletools.com/docs/reference/gradientstyle.md#zerocentred) | [`ZeroCentredColors`](https://www.adaptabletools.com/docs/reference/zerocentredcolors.md) | Zero-centred diverging gradient (`Col-Min`…`0` and `0`…`Col-Max` | | #### Cell Color Ranges | Property | Type | Description | | --- | --- | --- | | [Color](https://www.adaptabletools.com/docs/reference/cellcolorrange.md#color) | `string` | Cell colour to use for values that fall inside Range | | [Max](https://www.adaptabletools.com/docs/reference/cellcolorrange.md#max) | `number \| `[`DynamicRangeEndpoint`](https://www.adaptabletools.com/docs/reference/dynamicrangeendpoint.md) | End of Range, can be literal number or DynamicRangeEndpoint | | [Min](https://www.adaptabletools.com/docs/reference/cellcolorrange.md#min) | `number \| `[`DynamicRangeEndpoint`](https://www.adaptabletools.com/docs/reference/dynamicrangeendpoint.md) | Start of Range, can be literal number or DynamicRangeEndpoint | | [ReverseGradient](https://www.adaptabletools.com/docs/reference/cellcolorrange.md#reversegradient) | `boolean` | Reverses the alpha ramp **within this range only** — values at the *low*
end render saturated, values at the *high* end render faint.

Useful as a Gradient Style option when the natural reading is
"lower-is-darker" (e.g. lower trade IDs are older / more important, so
deserve more visual emphasis than newer ones).

Only honoured by Gradient Style. | #### Dynamic Endpoint `Min` and `Max` properties accept either a literal number or a [`DynamicRangeEndpoint`](https://www.adaptabletools.com/docs/reference/dynamicrangeendpoint.md) defined as follows: [See API: dynamicrangeendpoint](https://www.adaptabletools.com/docs/reference/dynamicrangeendpoint.md) #### Column Comparison | Property | Type | Description | | --- | --- | --- | | [Color](https://www.adaptabletools.com/docs/reference/columncomparison.md#color) | `string` | Colour to use for the Comparison | | [MaxValue](https://www.adaptabletools.com/docs/reference/columncomparison.md#maxvalue) | `number \| string` | End value - either numeric value or Column ID | | [MinValue](https://www.adaptabletools.com/docs/reference/columncomparison.md#minvalue) | `number \| string` | Start value - either numeric value or Column ID | #### Range Value Type The `RangeValueType` property is of type [`RangeValueType`](https://www.adaptabletools.com/docs/reference/rangevaluetype.md): [See API: rangevaluetype](https://www.adaptabletools.com/docs/reference/rangevaluetype.md) #### Zero Centred Gradient | Property | Type | Description | Default | | --- | --- | --- | --- | | [NegativeColor](https://www.adaptabletools.com/docs/reference/zerocentredcolors.md#negativecolor) | `string` | Colour applied to negative cell values (`Col-Min`…`0`) | `var(--ab-color-destructive)` | | [PositiveColor](https://www.adaptabletools.com/docs/reference/zerocentredcolors.md#positivecolor) | `string` | Colour applied to positive cell values (`0`…`Col-Max`) | `var(--ab-color-success)` | #### Cell Styling There are 2 properties used to for cell styling. - `Font` (of type [`cellfontstyle`](https://www.adaptabletools.com/docs/reference/cellfontstyle.md) applies the cell text styling on top of the gradient tint: | Property | Type | Description | | --- | --- | --- | | [Alignment](https://www.adaptabletools.com/docs/reference/cellfontstyle.md#alignment) | `Alignment` | Align to `Left`, `Right` or `Center` | | [FontSize](https://www.adaptabletools.com/docs/reference/cellfontstyle.md#fontsize) | `'XSmall' \| 'Small' \| 'Medium' \| 'Large' \| 'XLarge'` | Size of font: `XSmall`, `Small`, `Medium`, `Large` or `XLarge` | | [FontStyle](https://www.adaptabletools.com/docs/reference/cellfontstyle.md#fontstyle) | `'Normal' \| 'Italic'` | Style of font: `Normal` or `Italic` | | [FontWeight](https://www.adaptabletools.com/docs/reference/cellfontstyle.md#fontweight) | `'Normal' \| 'Bold'` | Weight of font: `Normal` or `Bold` | | [ForeColor](https://www.adaptabletools.com/docs/reference/cellfontstyle.md#forecolor) | `string` | Font colour in cell: hex, rgb(a) or name | | [TextDecoration](https://www.adaptabletools.com/docs/reference/cellfontstyle.md#textdecoration) | `'None' \| 'Underline' \| 'Overline' \| 'LineThrough'` | Decoration of font: `None`, `Underline`, `Overline` or `LineThrough` | - `ToolTipText` (of type [`CellTextOptions`](https://www.adaptabletools.com/docs/reference/celltextoptions.md)) is an array of [`CellTextOption`](https://www.adaptabletools.com/docs/reference/celltextoption.md) tokens: [See API: celltextoption](https://www.adaptabletools.com/docs/reference/celltextoption.md) --- ## Percent Bar Style | Property | Type | Description | Default | | --- | --- | --- | --- | | [BackColor](https://www.adaptabletools.com/docs/reference/percentbarstyle.md#backcolor) | `string` | Background colour for 'Percent Bar'; leave unset if none required | undefined | | [CellTextProperties](https://www.adaptabletools.com/docs/reference/percentbarstyle.md#celltextproperties) | [`BarStyleCellTextProperties`](https://www.adaptabletools.com/docs/reference/barstylecelltextproperties.md) | Optional cell-text overlay configuration (display tokens, position, layout, alignment). | | | [Font](https://www.adaptabletools.com/docs/reference/percentbarstyle.md#font) | [`CellFontStyle`](https://www.adaptabletools.com/docs/reference/cellfontstyle.md) | Optional cell-text styling applied to `CellText` overlay | | | [Origin](https://www.adaptabletools.com/docs/reference/percentbarstyle.md#origin) | `'Auto' \| 'Zero' \| 'Min' \| number` | Origin of the bar - i.e. the value the bar grows from Auto, Zero, Min or fixed number | 'Auto' | | [ToolTipText](https://www.adaptabletools.com/docs/reference/percentbarstyle.md#tooltiptext) | [`CellTextOptions`](https://www.adaptabletools.com/docs/reference/celltextoptions.md) | Whether Tooltip shows Cell Value, Percent Value, both or none | | #### Cell Color Ranges | Property | Type | Description | | --- | --- | --- | | [Color](https://www.adaptabletools.com/docs/reference/cellcolorrange.md#color) | `string` | Cell colour to use for values that fall inside Range | | [Max](https://www.adaptabletools.com/docs/reference/cellcolorrange.md#max) | `number \| `[`DynamicRangeEndpoint`](https://www.adaptabletools.com/docs/reference/dynamicrangeendpoint.md) | End of Range, can be literal number or DynamicRangeEndpoint | | [Min](https://www.adaptabletools.com/docs/reference/cellcolorrange.md#min) | `number \| `[`DynamicRangeEndpoint`](https://www.adaptabletools.com/docs/reference/dynamicrangeendpoint.md) | Start of Range, can be literal number or DynamicRangeEndpoint | | [ReverseGradient](https://www.adaptabletools.com/docs/reference/cellcolorrange.md#reversegradient) | `boolean` | Reverses the alpha ramp **within this range only** — values at the *low*
end render saturated, values at the *high* end render faint.

Useful as a Gradient Style option when the natural reading is
"lower-is-darker" (e.g. lower trade IDs are older / more important, so
deserve more visual emphasis than newer ones).

Only honoured by Gradient Style. | #### Dynamic Endpoint `Min` and `Max` properties accept either a literal number or a [`DynamicRangeEndpoint`](https://www.adaptabletools.com/docs/reference/dynamicrangeendpoint.md) defined as follows: [See API: dynamicrangeendpoint](https://www.adaptabletools.com/docs/reference/dynamicrangeendpoint.md) #### Column Comparison | Property | Type | Description | | --- | --- | --- | | [Color](https://www.adaptabletools.com/docs/reference/columncomparison.md#color) | `string` | Colour to use for the Comparison | | [MaxValue](https://www.adaptabletools.com/docs/reference/columncomparison.md#maxvalue) | `number \| string` | End value - either numeric value or Column ID | | [MinValue](https://www.adaptabletools.com/docs/reference/columncomparison.md#minvalue) | `number \| string` | Start value - either numeric value or Column ID | #### Range Value Type The `RangeValueType` property is of type [`RangeValueType`](https://www.adaptabletools.com/docs/reference/rangevaluetype.md): [See API: rangevaluetype](https://www.adaptabletools.com/docs/reference/rangevaluetype.md) #### Cell Styling There are 3 properties used for cell styling. - `Font` (of type [`cellfontstyle`](https://www.adaptabletools.com/docs/reference/cellfontstyle.md)) — styling for the cell-text overlay: | Property | Type | Description | | --- | --- | --- | | [Alignment](https://www.adaptabletools.com/docs/reference/cellfontstyle.md#alignment) | `Alignment` | Align to `Left`, `Right` or `Center` | | [FontSize](https://www.adaptabletools.com/docs/reference/cellfontstyle.md#fontsize) | `'XSmall' \| 'Small' \| 'Medium' \| 'Large' \| 'XLarge'` | Size of font: `XSmall`, `Small`, `Medium`, `Large` or `XLarge` | | [FontStyle](https://www.adaptabletools.com/docs/reference/cellfontstyle.md#fontstyle) | `'Normal' \| 'Italic'` | Style of font: `Normal` or `Italic` | | [FontWeight](https://www.adaptabletools.com/docs/reference/cellfontstyle.md#fontweight) | `'Normal' \| 'Bold'` | Weight of font: `Normal` or `Bold` | | [ForeColor](https://www.adaptabletools.com/docs/reference/cellfontstyle.md#forecolor) | `string` | Font colour in cell: hex, rgb(a) or name | | [TextDecoration](https://www.adaptabletools.com/docs/reference/cellfontstyle.md#textdecoration) | `'None' \| 'Underline' \| 'Overline' \| 'LineThrough'` | Decoration of font: `None`, `Underline`, `Overline` or `LineThrough` | - `CellTextProperties` (of type [`BarStyleCellTextProperties`](https://www.adaptabletools.com/docs/reference/barstylecelltextproperties.md)) — overlay layout around the bar: | Property | Type | Description | | --- | --- | --- | | [CellTextLayout](https://www.adaptabletools.com/docs/reference/barstylecelltextproperties.md#celltextlayout) | [`BarStyleCellTextLayout`](https://www.adaptabletools.com/docs/reference/barstylecelltextlayout.md) | Per-value placement on the 3 × 3 grid around / on the bar/chart. | `CellTextLayout` is a [`BarStyleCellTextLayout`](https://www.adaptabletools.com/docs/reference/barstylecelltextlayout.md): | Property | Type | Description | | --- | --- | --- | | [CellValue](https://www.adaptabletools.com/docs/reference/barstylecelltextlayout.md#cellvalue) | [`BarStyleCellTextPlacement`](https://www.adaptabletools.com/docs/reference/barstylecelltextplacement.md) | Placement of the formatted cell value. | | [PercentValue](https://www.adaptabletools.com/docs/reference/barstylecelltextlayout.md#percentvalue) | [`BarStyleCellTextPlacement`](https://www.adaptabletools.com/docs/reference/barstylecelltextplacement.md) | Placement of the percent value (the cell value's position along the bar's
`[min, max]` scale as a 0–100% reading). | Each value is a [`BarStyleCellTextPlacement`](https://www.adaptabletools.com/docs/reference/barstylecelltextplacement.md): | Property | Type | Description | Default | | --- | --- | --- | --- | | [Horizontal](https://www.adaptabletools.com/docs/reference/barstylecelltextplacement.md#horizontal) | [`BarStyleCellTextHorizontalAlignment`](https://www.adaptabletools.com/docs/reference/barstylecelltexthorizontalalignment.md) | Horizontal alignment within its vertical band. | 'Left' | | [Vertical](https://www.adaptabletools.com/docs/reference/barstylecelltextplacement.md#vertical) | [`BarStyleCellTextVerticalAlignment`](https://www.adaptabletools.com/docs/reference/barstylecelltextverticalalignment.md) | Vertical position relative to the bar/chart. | 'Below' | `Horizontal` is a [`BarStyleCellTextHorizontalAlignment`](https://www.adaptabletools.com/docs/reference/barstylecelltexthorizontalalignment.md): [See API: barstylecelltexthorizontalalignment](https://www.adaptabletools.com/docs/reference/barstylecelltexthorizontalalignment.md) `Vertical` is a [`BarStyleCellTextVerticalAlignment`](https://www.adaptabletools.com/docs/reference/barstylecelltextverticalalignment.md): [See API: barstylecelltextverticalalignment](https://www.adaptabletools.com/docs/reference/barstylecelltextverticalalignment.md) - `ToolTipText` (of type [`CellTextOptions`](https://www.adaptabletools.com/docs/reference/celltextoptions.md)) — an array of [`CellTextOption`](https://www.adaptabletools.com/docs/reference/celltextoption.md) tokens: [See API: celltextoption](https://www.adaptabletools.com/docs/reference/celltextoption.md) --- ## Badge Style | Property | Type | Description | Default | | --- | --- | --- | --- | | [Badges](https://www.adaptabletools.com/docs/reference/badgestyle.md#badges) | [`BadgeStyleDefinition`](https://www.adaptabletools.com/docs/reference/badgestyledefinition.md)`[]` | Collection of Badge Style Definitions | | | [Cell](https://www.adaptabletools.com/docs/reference/badgestyle.md#cell) | [`CellBoxStyle`](https://www.adaptabletools.com/docs/reference/cellboxstyle.md) | Optional cell-box styling applied to grid cell **behind** the badges | | | [Density](https://www.adaptabletools.com/docs/reference/badgestyle.md#density) | [`BadgeDensity`](https://www.adaptabletools.com/docs/reference/badgedensity.md) | Density preset shared by every badge in the column - controls inner padding. | 'Normal' | | [Font](https://www.adaptabletools.com/docs/reference/badgestyle.md#font) | [`CellFontStyle`](https://www.adaptabletools.com/docs/reference/cellfontstyle.md) | Optional column-level Font (only Alignment is meaningful for Badge cells) | | | [OverflowMode](https://www.adaptabletools.com/docs/reference/badgestyle.md#overflowmode) | [`BadgeOverflowMode`](https://www.adaptabletools.com/docs/reference/badgeoverflowmode.md) | How badges lay out in array-column cells where space is tight | 'Truncate' | | [Spacing](https://www.adaptabletools.com/docs/reference/badgestyle.md#spacing) | `number` | Pixel gap between adjacent badges in array-column cells | 4 | #### Badge Density `Density` is a [`BadgeDensity`](https://www.adaptabletools.com/docs/reference/badgedensity.md): [See API: badgedensity](https://www.adaptabletools.com/docs/reference/badgedensity.md) #### Badge Overflow `OverflowMode` is a [`BadgeOverflowMode`](https://www.adaptabletools.com/docs/reference/badgeoverflowmode.md): [See API: badgeoverflowmode](https://www.adaptabletools.com/docs/reference/badgeoverflowmode.md) #### Badge Style Definition | Property | Type | Description | Default | | --- | --- | --- | --- | | [IconProperties](https://www.adaptabletools.com/docs/reference/badgestyledefinition.md#iconproperties) | [`BadgeIconProperties`](https://www.adaptabletools.com/docs/reference/badgeiconproperties.md) | Settings for Icon to display alongside badge text | | | [PillStyle](https://www.adaptabletools.com/docs/reference/badgestyledefinition.md#pillstyle) | [`BadgePillStyle`](https://www.adaptabletools.com/docs/reference/badgepillstyle.md) | Style for the Badge **pill** (cut-down version of Adaptable Style) | | | [Rule](https://www.adaptabletools.com/docs/reference/badgestyledefinition.md#rule) | `string` | Optional AdapTableQL boolean expression for deciding whether Badge is displayed.
References to the Styled Column's own column resolve per cell value —
and, for array columns, per array element. | | | [Shape](https://www.adaptabletools.com/docs/reference/badgestyledefinition.md#shape) | [`BadgeShape`](https://www.adaptabletools.com/docs/reference/badgeshape.md) | Visual shape of the Badge's corner radius | 'Rounded' | #### Badge Icon | Property | Type | Description | Default | | --- | --- | --- | --- | | [Gap](https://www.adaptabletools.com/docs/reference/badgeiconproperties.md#gap) | `number` | Pixel gap between the icon and the badge text. Falls back to the badge
`Density` preset when omitted; ignored when is `true`. | | | [Icon](https://www.adaptabletools.com/docs/reference/badgeiconproperties.md#icon) | [`AdaptableIcon`](https://www.adaptabletools.com/docs/reference/adaptableicon.md) | Icon to display in the badge. | | | [IconOnly](https://www.adaptabletools.com/docs/reference/badgeiconproperties.md#icononly) | `boolean` | Only show the icon and no badge text. | | | [Position](https://www.adaptabletools.com/docs/reference/badgeiconproperties.md#position) | `'Start' \| 'End'` | Position of the icon in the badge — `'Start'` or `'End'`. | 'Start' | `Icon` is an [`AdaptableIcon`](https://www.adaptabletools.com/docs/reference/adaptableicon.md): a system icon (`{ name }`), a custom icon (`{ src }`), or an element. #### Badge Pill Style Each Badge contains a `PillStyle` property; this is a subset of [`AdaptableStyle`](https://www.adaptabletools.com/docs/reference/adaptablestyle.md): #### Pill Shape The `Shape` property (of type [`BadgeShape`](https://www.adaptabletools.com/docs/reference/badgeshape.md)) defines the Shape (essentially radius) of the Pill: [See API: badgeshape](https://www.adaptabletools.com/docs/reference/badgeshape.md) #### Cell Box Style The `Cell` property is of type [`cellboxstyle`](https://www.adaptabletools.com/docs/reference/cellboxstyle.md) and provides optional box styling behind the badge row | Property | Type | Description | | --- | --- | --- | | [BackColor](https://www.adaptabletools.com/docs/reference/cellboxstyle.md#backcolor) | `string` | Colour background of cell: hex, rgb(a) or name | | [BorderColor](https://www.adaptabletools.com/docs/reference/cellboxstyle.md#bordercolor) | `string` | Colour of cell border: hex, rgb(a) or name | | [BorderRadius](https://www.adaptabletools.com/docs/reference/cellboxstyle.md#borderradius) | `number` | Rounds corners of an element's outer border edge; equivalent of CSS border-radius | #### Cell Font Style The `Font` property (of type [`cellfontstyle`](https://www.adaptabletools.com/docs/reference/cellfontstyle.md)) provides font styling (although only `Alignment` is meaningful): | Property | Type | Description | | --- | --- | --- | | [Alignment](https://www.adaptabletools.com/docs/reference/cellfontstyle.md#alignment) | `Alignment` | Align to `Left`, `Right` or `Center` | | [FontSize](https://www.adaptabletools.com/docs/reference/cellfontstyle.md#fontsize) | `'XSmall' \| 'Small' \| 'Medium' \| 'Large' \| 'XLarge'` | Size of font: `XSmall`, `Small`, `Medium`, `Large` or `XLarge` | | [FontStyle](https://www.adaptabletools.com/docs/reference/cellfontstyle.md#fontstyle) | `'Normal' \| 'Italic'` | Style of font: `Normal` or `Italic` | | [FontWeight](https://www.adaptabletools.com/docs/reference/cellfontstyle.md#fontweight) | `'Normal' \| 'Bold'` | Weight of font: `Normal` or `Bold` | | [ForeColor](https://www.adaptabletools.com/docs/reference/cellfontstyle.md#forecolor) | `string` | Font colour in cell: hex, rgb(a) or name | | [TextDecoration](https://www.adaptabletools.com/docs/reference/cellfontstyle.md#textdecoration) | `'None' \| 'Underline' \| 'Overline' \| 'LineThrough'` | Decoration of font: `None`, `Underline`, `Overline` or `LineThrough` | --- ## Sparkline Style The [Sparkline Style](https://www.adaptabletools.com/docs/handbook-styled-column-sparkline/index.md) contains a [`sparklinestyle`](https://www.adaptabletools.com/docs/reference/sparklinestyle.md) object: | Property | Type | Description | | --- | --- | --- | | [Cell](https://www.adaptabletools.com/docs/reference/sparklinestyle.md#cell) | [`CellBoxStyle`](https://www.adaptabletools.com/docs/reference/cellboxstyle.md) | Optional cell box styling applied to the cell behind the sparkline chart.

When set, this property "claims" the Cell slice for the column: any
Format Column matching this column has its Cell-box properties stripped.
When unset, Format Column Cell properties inherit through normally —
useful for letting a row's themed background show through behind the
sparkline. | | [options](https://www.adaptabletools.com/docs/reference/sparklinestyle.md#options) | `AgSparklineOptions` | AG Grid Sparkline Options | - The `options` property accepts [AG Grid Sparkline options](https://www.ag-grid.com/javascript-data-grid/sparklines-overview/) - See the AG Grid documentation for the full property list #### Cell Box Style The `Cell` is of type [`cellboxstyle`](https://www.adaptabletools.com/docs/reference/cellboxstyle.md) and provides optional box styling behind the sparkline chart: | Property | Type | Description | | --- | --- | --- | | [BackColor](https://www.adaptabletools.com/docs/reference/cellboxstyle.md#backcolor) | `string` | Colour background of cell: hex, rgb(a) or name | | [BorderColor](https://www.adaptabletools.com/docs/reference/cellboxstyle.md#bordercolor) | `string` | Colour of cell border: hex, rgb(a) or name | | [BorderRadius](https://www.adaptabletools.com/docs/reference/cellboxstyle.md#borderradius) | `number` | Rounds corners of an element's outer border edge; equivalent of CSS border-radius | --- ## Bullet Chart Style The [Bullet Chart Style](https://www.adaptabletools.com/docs/handbook-styled-column-bullet/index.md) uses a [`BulletChartStyle`](https://www.adaptabletools.com/docs/reference/bulletchartstyle.md) object: | Property | Type | Description | Default | | --- | --- | --- | --- | | [BackColor](https://www.adaptabletools.com/docs/reference/bulletchartstyle.md#backcolor) | `string` | Background colour for the chart area when no `CellRanges` are supplied. | | | [Bar](https://www.adaptabletools.com/docs/reference/bulletchartstyle.md#bar) | [`BulletChartBarProperties`](https://www.adaptabletools.com/docs/reference/bulletchartbarproperties.md) | Visual properties of the actual (foreground) bar — colour and thickness. | | | [CellTextProperties](https://www.adaptabletools.com/docs/reference/bulletchartstyle.md#celltextproperties) | [`BarStyleCellTextProperties`](https://www.adaptabletools.com/docs/reference/barstylecelltextproperties.md) | Optional cell-text overlay configuration. | | | [Font](https://www.adaptabletools.com/docs/reference/bulletchartstyle.md#font) | [`CellFontStyle`](https://www.adaptabletools.com/docs/reference/cellfontstyle.md) | Optional cell-text styling (colour, weight, font, alignment, …) applied
by the Bullet Chart renderer to the optional `CellText` overlay.

When set, this property "claims" the Font slice for the column: any
Format Column matching this column has its Font properties stripped.
When unset, Format Column Font properties inherit through normally. | | | [Orientation](https://www.adaptabletools.com/docs/reference/bulletchartstyle.md#orientation) | `'Horizontal' \| 'Vertical'` | Orientation of the chart.

- `'Horizontal'` (default) - bands and bar run left-to-right; markers
are vertical lines / shapes positioned along the x-axis.
- `'Vertical'` - bands and bar run bottom-to-top; markers are
horizontal lines / shapes positioned along the y-axis.

Note: vertical bullet charts need a tall row height to be readable
(we recommend at least 60px). AG Grid row height is a per-grid setting
(`gridOptions.rowHeight` or `getRowHeight`). | 'Horizontal' | | [Origin](https://www.adaptabletools.com/docs/reference/bulletchartstyle.md#origin) | `'Auto' \| 'Zero' \| number` | Origin of the actual bar.

- `'Auto'` (default) - the bar grows from the left edge unless any cell
value or range endpoint is negative, in which case it grows from `0`
- `'Zero'` - the bar always grows from `0` (centred axis); positive
values extend right, negative values extend left
- any number - the bar grows from that fixed origin | 'Auto' | | [TargetProperties](https://www.adaptabletools.com/docs/reference/bulletchartstyle.md#targetproperties) | [`BulletChartTargetProperties`](https://www.adaptabletools.com/docs/reference/bulletcharttargetproperties.md) | Target value(s) rendered as marker(s) on the bar, plus the chart-level
default marker style. Per-target overrides are possible via the
object form. | | | [ToolTipText](https://www.adaptabletools.com/docs/reference/bulletchartstyle.md#tooltiptext) | [`CellTextOptions`](https://www.adaptabletools.com/docs/reference/celltextoptions.md) | Tooltip content - same tokens (`'CellValue'`, `'PercentageValue'`) as
Percent Bar. | | #### Numeric Styled Column The [`BulletChartStyle`](https://www.adaptabletools.com/docs/reference/bulletchartstyle.md) extends the base [`NumericStyledColumn`](https://www.adaptabletools.com/docs/reference/numericstyledcolumn.md) object: | Property | Type | Description | Default | | --- | --- | --- | --- | | [CellRanges](https://www.adaptabletools.com/docs/reference/numericstyledcolumn.md#cellranges) | [`CellColorRange`](https://www.adaptabletools.com/docs/reference/cellcolorrange.md)`[]` | Ranges (e.g. to create traffic light effect) | | | [ColumnComparison](https://www.adaptabletools.com/docs/reference/numericstyledcolumn.md#columncomparison) | [`ColumnComparison`](https://www.adaptabletools.com/docs/reference/columncomparison.md) | Compares Cell values to another Column | | | [RangeValueType](https://www.adaptabletools.com/docs/reference/numericstyledcolumn.md#rangevaluetype) | [`RangeValueType`](https://www.adaptabletools.com/docs/reference/rangevaluetype.md) | Used with Ranges; can be Number (any number or Col-Min/Col-Max) or 'Percentage' (values 0-100) | Number | #### Cell Color Ranges The `CellRanges` property is an object of type [`cellcolorrange`](https://www.adaptabletools.com/docs/reference/cellcolorrange.md) and renders qualitative background bands behind the bar: | Property | Type | Description | | --- | --- | --- | | [Color](https://www.adaptabletools.com/docs/reference/cellcolorrange.md#color) | `string` | Cell colour to use for values that fall inside Range | | [Max](https://www.adaptabletools.com/docs/reference/cellcolorrange.md#max) | `number \| `[`DynamicRangeEndpoint`](https://www.adaptabletools.com/docs/reference/dynamicrangeendpoint.md) | End of Range, can be literal number or DynamicRangeEndpoint | | [Min](https://www.adaptabletools.com/docs/reference/cellcolorrange.md#min) | `number \| `[`DynamicRangeEndpoint`](https://www.adaptabletools.com/docs/reference/dynamicrangeendpoint.md) | Start of Range, can be literal number or DynamicRangeEndpoint | | [ReverseGradient](https://www.adaptabletools.com/docs/reference/cellcolorrange.md#reversegradient) | `boolean` | Reverses the alpha ramp **within this range only** — values at the *low*
end render saturated, values at the *high* end render faint.

Useful as a Gradient Style option when the natural reading is
"lower-is-darker" (e.g. lower trade IDs are older / more important, so
deserve more visual emphasis than newer ones).

Only honoured by Gradient Style. | #### Dynamic Endpoint `Min` and `Max` properties accept either a literal number or a [`DynamicRangeEndpoint`](https://www.adaptabletools.com/docs/reference/dynamicrangeendpoint.md) defined as follows: [See API: dynamicrangeendpoint](https://www.adaptabletools.com/docs/reference/dynamicrangeendpoint.md) #### Column Comparison The `ColumnComparison` property is of type [`columncomparison`](https://www.adaptabletools.com/docs/reference/columncomparison.md) which compares the cell value against another column's min/max span: | Property | Type | Description | | --- | --- | --- | | [Color](https://www.adaptabletools.com/docs/reference/columncomparison.md#color) | `string` | Colour to use for the Comparison | | [MaxValue](https://www.adaptabletools.com/docs/reference/columncomparison.md#maxvalue) | `number \| string` | End value - either numeric value or Column ID | | [MinValue](https://www.adaptabletools.com/docs/reference/columncomparison.md#minvalue) | `number \| string` | Start value - either numeric value or Column ID | #### Range Value Type The `RangeValueType` property is of type [`RangeValueType`](https://www.adaptabletools.com/docs/reference/rangevaluetype.md): [See API: rangevaluetype](https://www.adaptabletools.com/docs/reference/rangevaluetype.md) #### Bullet Chart Target The `TargetProperties` property is a [`BulletChartTargetProperties`](https://www.adaptabletools.com/docs/reference/bulletcharttarget.md) object made up of 2 properties: | Property | Type | Description | | --- | --- | --- | | [Marker](https://www.adaptabletools.com/docs/reference/bulletcharttargetproperties.md#marker) | [`BarStyleMarker`](https://www.adaptabletools.com/docs/reference/barstylemarker.md) | Visual style of the target marker(s).

When `Target` is an array, this style applies to all markers; pass a
`Target` object with its own `Marker` property to override per-marker. | | [Target](https://www.adaptabletools.com/docs/reference/bulletcharttargetproperties.md#target) | [`BulletChartTarget`](https://www.adaptabletools.com/docs/reference/bulletcharttarget.md)` \| `[`BulletChartTarget`](https://www.adaptabletools.com/docs/reference/bulletcharttarget.md)`[]` | Target value(s) rendered as marker(s) on the bar.

Each Target can be:
- `number` - a fixed target value
- `string` - a column id; the row's value in that column is used as the target
- `'Col-Avg'` \| `'Col-Median'` - computed across visible rows

Pass an array to render multiple targets (e.g. primary + stretch goal). | #### Marker The `Marker` property is a [`BarStyleMarker`](https://www.adaptabletools.com/docs/reference/barstylemarker.md) object: | Property | Type | Description | Default | | --- | --- | --- | --- | | [Color](https://www.adaptabletools.com/docs/reference/barstylemarker.md#color) | `string` | Marker colour. Defaults to the current text colour. | 'var(--ab-color-text)' | | [Shape](https://www.adaptabletools.com/docs/reference/barstylemarker.md#shape) | `'Line' \| 'Triangle' \| 'Dot' \| 'Diamond'` | Marker shape. | | | [Size](https://www.adaptabletools.com/docs/reference/barstylemarker.md#size) | `number` | Line thickness (for `Shape: 'Line'`) or shape size in px. | | #### Target The `Target` property is a [`BulletChartTarget`](https://www.adaptabletools.com/docs/reference/bulletcharttarget.md) object: [See API: bulletcharttarget](https://www.adaptabletools.com/docs/reference/bulletcharttarget.md) The object form is a [`BulletChartTargetDefinition`](https://www.adaptabletools.com/docs/reference/bulletcharttargetdefinition.md): | Property | Type | Description | | --- | --- | --- | | [Label](https://www.adaptabletools.com/docs/reference/bulletcharttargetdefinition.md#label) | `string` | Optional label displayed in the tooltip alongside the marker value. | | [Marker](https://www.adaptabletools.com/docs/reference/bulletcharttargetdefinition.md#marker) | [`BarStyleMarker`](https://www.adaptabletools.com/docs/reference/barstylemarker.md) | Per-target marker override. Falls back to `BulletChartTargetProperties.Marker`. | | [Value](https://www.adaptabletools.com/docs/reference/bulletcharttargetdefinition.md#value) | `number \| string \| 'Col-Avg' \| 'Col-Median'` | Resolvable value: number, column id, `Col-Avg` or `Col-Median`. | #### Bar `Bar` is a [`BulletChartBarProperties`](https://www.adaptabletools.com/docs/reference/bulletchartbarproperties.md) object: | Property | Type | Description | Default | | --- | --- | --- | --- | | [Color](https://www.adaptabletools.com/docs/reference/bulletchartbarproperties.md#color) | `string` | Colour of the actual (foreground) bar drawn on top of any bands. | 'var(--ab-color-primary)' | | [Height](https://www.adaptabletools.com/docs/reference/bulletchartbarproperties.md#height) | `number` | Height of the actual bar in px (the bands sit a few px taller behind it).

For vertical orientation this is interpreted as the bar's *width*
(i.e. its short axis); the long axis stretches to fit the cell. | 8 | #### Cell Styling There are 3 properties used for cell styling. - `Font` (of type [`cellfontstyle`](https://www.adaptabletools.com/docs/reference/cellfontstyle.md)) — styling for the cell-text overlay: | Property | Type | Description | | --- | --- | --- | | [Alignment](https://www.adaptabletools.com/docs/reference/cellfontstyle.md#alignment) | `Alignment` | Align to `Left`, `Right` or `Center` | | [FontSize](https://www.adaptabletools.com/docs/reference/cellfontstyle.md#fontsize) | `'XSmall' \| 'Small' \| 'Medium' \| 'Large' \| 'XLarge'` | Size of font: `XSmall`, `Small`, `Medium`, `Large` or `XLarge` | | [FontStyle](https://www.adaptabletools.com/docs/reference/cellfontstyle.md#fontstyle) | `'Normal' \| 'Italic'` | Style of font: `Normal` or `Italic` | | [FontWeight](https://www.adaptabletools.com/docs/reference/cellfontstyle.md#fontweight) | `'Normal' \| 'Bold'` | Weight of font: `Normal` or `Bold` | | [ForeColor](https://www.adaptabletools.com/docs/reference/cellfontstyle.md#forecolor) | `string` | Font colour in cell: hex, rgb(a) or name | | [TextDecoration](https://www.adaptabletools.com/docs/reference/cellfontstyle.md#textdecoration) | `'None' \| 'Underline' \| 'Overline' \| 'LineThrough'` | Decoration of font: `None`, `Underline`, `Overline` or `LineThrough` | - `CellTextProperties` (of type [`BarStyleCellTextProperties`](https://www.adaptabletools.com/docs/reference/barstylecelltextproperties.md)) — overlay layout around the chart: | Property | Type | Description | | --- | --- | --- | | [CellTextLayout](https://www.adaptabletools.com/docs/reference/barstylecelltextproperties.md#celltextlayout) | [`BarStyleCellTextLayout`](https://www.adaptabletools.com/docs/reference/barstylecelltextlayout.md) | Per-value placement on the 3 × 3 grid around / on the bar/chart. | `CellTextLayout` is a [`BarStyleCellTextLayout`](https://www.adaptabletools.com/docs/reference/barstylecelltextlayout.md): | Property | Type | Description | | --- | --- | --- | | [CellValue](https://www.adaptabletools.com/docs/reference/barstylecelltextlayout.md#cellvalue) | [`BarStyleCellTextPlacement`](https://www.adaptabletools.com/docs/reference/barstylecelltextplacement.md) | Placement of the formatted cell value. | | [PercentValue](https://www.adaptabletools.com/docs/reference/barstylecelltextlayout.md#percentvalue) | [`BarStyleCellTextPlacement`](https://www.adaptabletools.com/docs/reference/barstylecelltextplacement.md) | Placement of the percent value (the cell value's position along the bar's
`[min, max]` scale as a 0–100% reading). | Each value is a [`BarStyleCellTextPlacement`](https://www.adaptabletools.com/docs/reference/barstylecelltextplacement.md): | Property | Type | Description | Default | | --- | --- | --- | --- | | [Horizontal](https://www.adaptabletools.com/docs/reference/barstylecelltextplacement.md#horizontal) | [`BarStyleCellTextHorizontalAlignment`](https://www.adaptabletools.com/docs/reference/barstylecelltexthorizontalalignment.md) | Horizontal alignment within its vertical band. | 'Left' | | [Vertical](https://www.adaptabletools.com/docs/reference/barstylecelltextplacement.md#vertical) | [`BarStyleCellTextVerticalAlignment`](https://www.adaptabletools.com/docs/reference/barstylecelltextverticalalignment.md) | Vertical position relative to the bar/chart. | 'Below' | `Horizontal` is a [`BarStyleCellTextHorizontalAlignment`](https://www.adaptabletools.com/docs/reference/barstylecelltexthorizontalalignment.md): [See API: barstylecelltexthorizontalalignment](https://www.adaptabletools.com/docs/reference/barstylecelltexthorizontalalignment.md) `Vertical` is a [`BarStyleCellTextVerticalAlignment`](https://www.adaptabletools.com/docs/reference/barstylecelltextverticalalignment.md): [See API: barstylecelltextverticalalignment](https://www.adaptabletools.com/docs/reference/barstylecelltextverticalalignment.md) - `ToolTipText` (of type [`CellTextOptions`](https://www.adaptabletools.com/docs/reference/celltextoptions.md)) — an array of [`CellTextOption`](https://www.adaptabletools.com/docs/reference/celltextoption.md) tokens: [See API: celltextoption](https://www.adaptabletools.com/docs/reference/celltextoption.md) --- ## Rating Style User guide: [Rating Style](https://www.adaptabletools.com/docs/handbook-styled-column-rating/index.md) #### RatingStyle | Property | Type | Description | Default | | --- | --- | --- | --- | | [AllowHalf](https://www.adaptabletools.com/docs/reference/ratingstyle.md#allowhalf) | `boolean` | Controls **partial icons** for fractional values after clamping to
`[0, Max]` — not scaling between different ranges (e.g. 10-point vs
5-star).

When `true`, the decimal part fills part of the next icon (e.g. `3.5`
with `Max: 5` → three full icons + one half-filled + one empty).
When `false`, the clamped value is rounded with `Math.round` before
drawing, so only whole icons appear. | true | | [Cell](https://www.adaptabletools.com/docs/reference/ratingstyle.md#cell) | [`CellBoxStyle`](https://www.adaptabletools.com/docs/reference/cellboxstyle.md) | Optional cell box styling (background colour, border, border radius)
applied to the cell behind the rating icons.

When set, this property "claims" the Cell slice for the column: any
Format Column matching this column has its Cell-box properties stripped
(so a Format Column `BackColor` cannot tint the cell behind a Rating).
When unset, Format Column Cell properties inherit through normally —
useful for tinting a row of stars to match a Format Column theme. | | | [EmptyColor](https://www.adaptabletools.com/docs/reference/ratingstyle.md#emptycolor) | `string` | Outline / fill colour for the inactive portion of the rating.

Drawn as a subtle background icon so the user can see the maximum
possible rating at a glance even when the cell value is low. | a low-opacity tint of the current text colour. | | [FilledColor](https://www.adaptabletools.com/docs/reference/ratingstyle.md#filledcolor) | `string` | Fill colour for the active (filled) portion of the rating. | 'var(--ab-color-warn, #f5a623)' — a warm amber that reads well on both light and dark themes. | | [Gap](https://www.adaptabletools.com/docs/reference/ratingstyle.md#gap) | `number` | Pixel gap between adjacent icons. | 2 | | [Icon](https://www.adaptabletools.com/docs/reference/ratingstyle.md#icon) | [`RatingIconShape`](https://www.adaptabletools.com/docs/reference/ratingiconshape.md) | Icon used for each rating mark. | 'Star' | | [Max](https://www.adaptabletools.com/docs/reference/ratingstyle.md#max) | `number` | Number of icons per cell **and** the upper bound of the rating scale,
in the **same numeric units as the cell value**.

The renderer clamps the cell value to `[0, Max]` and maps that number
directly to filled icons (e.g. `Max: 5` and value `4` → four units of
fill across five icons — roughly four stars, not “4 out of 10 scaled
to five stars”). Values above `Max` show as fully filled; values below
`0` show as empty.

To show a 1–10 score as five stars, use a calculated column (e.g.
`value / 2`) or set `Max` to match your data range (e.g. `Max: 10`
for ten icons), unless a future `ScaleMin` / `ScaleMax` option is added. | 5 | | [ShowValue](https://www.adaptabletools.com/docs/reference/ratingstyle.md#showvalue) | `boolean` | When `true`, the numeric cell value is also displayed alongside the
icons (e.g. `★★★★☆ 4.2`). Useful when precise scores matter beyond
the visual approximation. | false | | [Size](https://www.adaptabletools.com/docs/reference/ratingstyle.md#size) | `number` | Icon size in pixels (each icon is square). The renderer keeps the
row of icons vertically centred regardless of cell height. | 14 | | [ToolTipText](https://www.adaptabletools.com/docs/reference/ratingstyle.md#tooltiptext) | [`CellTextOptions`](https://www.adaptabletools.com/docs/reference/celltextoptions.md) | Optional AG Grid tooltip content — `CellValue` and/or `PercentageValue`.
`PercentageValue` is the clamped cell value as a percent of `Max`
(`clamp(value, 0, Max) / Max`, same scale as the icon fill). | | #### RatingIconShape Used by `Icon` ([`RatingIconShape`](https://www.adaptabletools.com/docs/reference/ratingiconshape.md)): [See API: ratingiconshape](https://www.adaptabletools.com/docs/reference/ratingiconshape.md) #### CellBoxStyle Used by `Cell` — optional box styling behind the rating icons. | Property | Type | Description | | --- | --- | --- | | [BackColor](https://www.adaptabletools.com/docs/reference/cellboxstyle.md#backcolor) | `string` | Colour background of cell: hex, rgb(a) or name | | [BorderColor](https://www.adaptabletools.com/docs/reference/cellboxstyle.md#bordercolor) | `string` | Colour of cell border: hex, rgb(a) or name | | [BorderRadius](https://www.adaptabletools.com/docs/reference/cellboxstyle.md#borderradius) | `number` | Rounds corners of an element's outer border edge; equivalent of CSS border-radius | #### CellTextOption Used by `ToolTipText`: [See API: celltextoption](https://www.adaptabletools.com/docs/reference/celltextoption.md) --- ## Range Bar Style User guide: [Range Bar Style](https://www.adaptabletools.com/docs/handbook-styled-column-range-bar/index.md) [`RangeBarStyle`](https://www.adaptabletools.com/docs/reference/rangebarstyle.md) extends [`NumericStyledColumn`](https://www.adaptabletools.com/docs/reference/numericstyledcolumn.md). #### RangeBarStyle | Property | Type | Description | Default | | --- | --- | --- | --- | | [BackColor](https://www.adaptabletools.com/docs/reference/rangebarstyle.md#backcolor) | `string` | Background colour for the chart area when no `CellRanges` are supplied. | | | [CellTextProperties](https://www.adaptabletools.com/docs/reference/rangebarstyle.md#celltextproperties) | [`BarStyleCellTextProperties`](https://www.adaptabletools.com/docs/reference/barstylecelltextproperties.md) | Optional cell-text overlay configuration. | | | [Marker](https://www.adaptabletools.com/docs/reference/rangebarstyle.md#marker) | [`BarStyleMarker`](https://www.adaptabletools.com/docs/reference/barstylemarker.md) | Visual style of the cell-value marker. | `{ Shape: 'Diamond', Color: 'var(--ab-color-accent)', Size: 8 }` | | [Max](https://www.adaptabletools.com/docs/reference/rangebarstyle.md#max) | [`RangeBarBound`](https://www.adaptabletools.com/docs/reference/rangebarbound.md) | Upper bound of the track for each row.

See `Min` for the supported value forms. | | | [Min](https://www.adaptabletools.com/docs/reference/rangebarstyle.md#min) | [`RangeBarBound`](https://www.adaptabletools.com/docs/reference/rangebarbound.md) | Lower bound of the track for each row.

Can be:
- `number` — a fixed lower bound shared by every row
- `string` — a column id; the row's value in that column is used
- `'Col-Min' \| 'Col-Max' \| 'Col-Avg' \| 'Col-Median'` — a column-wide
aggregate computed across the visible rows | | | [Orientation](https://www.adaptabletools.com/docs/reference/rangebarstyle.md#orientation) | `'Horizontal' \| 'Vertical'` | Orientation of the range bar. | `'Horizontal'` | | [OutOfRange](https://www.adaptabletools.com/docs/reference/rangebarstyle.md#outofrange) | [`RangeBarOutOfRangeProperties`](https://www.adaptabletools.com/docs/reference/rangebaroutofrangeproperties.md) | Behaviour when the cell value falls outside `[Min, Max]`, plus the
optional marker colour override used by `Mode: 'Clamp'`.

Defaults to `{ Mode: 'Clamp' }` when omitted. | | | [Reference](https://www.adaptabletools.com/docs/reference/rangebarstyle.md#reference) | [`RangeBarReferenceProperties`](https://www.adaptabletools.com/docs/reference/rangebarreferenceproperties.md) | Optional reference value (e.g. previous close, target, midpoint) drawn
as a *second* marker on the track, together with its marker styling.
Leave unset to draw only the cell-value marker. | | | [ToolTipText](https://www.adaptabletools.com/docs/reference/rangebarstyle.md#tooltiptext) | [`CellTextOptions`](https://www.adaptabletools.com/docs/reference/celltextoptions.md) | Tooltip content — same tokens (`'CellValue'`, `'PercentageValue'`)
as Percent Bar / Bullet Chart. | | | [Track](https://www.adaptabletools.com/docs/reference/rangebarstyle.md#track) | [`RangeBarTrackProperties`](https://www.adaptabletools.com/docs/reference/rangebartrackproperties.md) | Visual properties of the track (the line representing the `[Min, Max]`
interval). | | #### NumericStyledColumn (inherited) | Property | Type | Description | Default | | --- | --- | --- | --- | | [CellRanges](https://www.adaptabletools.com/docs/reference/numericstyledcolumn.md#cellranges) | [`CellColorRange`](https://www.adaptabletools.com/docs/reference/cellcolorrange.md)`[]` | Ranges (e.g. to create traffic light effect) | | | [ColumnComparison](https://www.adaptabletools.com/docs/reference/numericstyledcolumn.md#columncomparison) | [`ColumnComparison`](https://www.adaptabletools.com/docs/reference/columncomparison.md) | Compares Cell values to another Column | | | [RangeValueType](https://www.adaptabletools.com/docs/reference/numericstyledcolumn.md#rangevaluetype) | [`RangeValueType`](https://www.adaptabletools.com/docs/reference/rangevaluetype.md) | Used with Ranges; can be Number (any number or Col-Min/Col-Max) or 'Percentage' (values 0-100) | Number | #### CellColorRange Used by `CellRanges` — optional qualitative bands behind the track (same conventions as Bullet Chart). | Property | Type | Description | | --- | --- | --- | | [Color](https://www.adaptabletools.com/docs/reference/cellcolorrange.md#color) | `string` | Cell colour to use for values that fall inside Range | | [Max](https://www.adaptabletools.com/docs/reference/cellcolorrange.md#max) | `number \| `[`DynamicRangeEndpoint`](https://www.adaptabletools.com/docs/reference/dynamicrangeendpoint.md) | End of Range, can be literal number or DynamicRangeEndpoint | | [Min](https://www.adaptabletools.com/docs/reference/cellcolorrange.md#min) | `number \| `[`DynamicRangeEndpoint`](https://www.adaptabletools.com/docs/reference/dynamicrangeendpoint.md) | Start of Range, can be literal number or DynamicRangeEndpoint | | [ReverseGradient](https://www.adaptabletools.com/docs/reference/cellcolorrange.md#reversegradient) | `boolean` | Reverses the alpha ramp **within this range only** — values at the *low*
end render saturated, values at the *high* end render faint.

Useful as a Gradient Style option when the natural reading is
"lower-is-darker" (e.g. lower trade IDs are older / more important, so
deserve more visual emphasis than newer ones).

Only honoured by Gradient Style. | `Min` and `Max` also accept a [`DynamicRangeEndpoint`](https://www.adaptabletools.com/docs/reference/dynamicrangeendpoint.md): [See API: dynamicrangeendpoint](https://www.adaptabletools.com/docs/reference/dynamicrangeendpoint.md) #### ColumnComparison Used by `ColumnComparison`. | Property | Type | Description | | --- | --- | --- | | [Color](https://www.adaptabletools.com/docs/reference/columncomparison.md#color) | `string` | Colour to use for the Comparison | | [MaxValue](https://www.adaptabletools.com/docs/reference/columncomparison.md#maxvalue) | `number \| string` | End value - either numeric value or Column ID | | [MinValue](https://www.adaptabletools.com/docs/reference/columncomparison.md#minvalue) | `number \| string` | Start value - either numeric value or Column ID | #### RangeValueType [`RangeValueType`](https://www.adaptabletools.com/docs/reference/rangevaluetype.md): [See API: rangevaluetype](https://www.adaptabletools.com/docs/reference/rangevaluetype.md) #### RangeBarBound Used by `Min`, `Max` and `Reference` ([`RangeBarBound`](https://www.adaptabletools.com/docs/reference/rangebarbound.md)): [See API: rangebarbound](https://www.adaptabletools.com/docs/reference/rangebarbound.md) #### Marker `Marker` is a BarStyleMarker | Property | Type | Description | Default | | --- | --- | --- | --- | | [Color](https://www.adaptabletools.com/docs/reference/barstylemarker.md#color) | `string` | Marker colour. Defaults to the current text colour. | 'var(--ab-color-text)' | | [Shape](https://www.adaptabletools.com/docs/reference/barstylemarker.md#shape) | `'Line' \| 'Triangle' \| 'Dot' \| 'Diamond'` | Marker shape. | | | [Size](https://www.adaptabletools.com/docs/reference/barstylemarker.md#size) | `number` | Line thickness (for `Shape: 'Line'`) or shape size in px. | | #### Reference `Reference` is a [`RangeBarReferenceProperties`](https://www.adaptabletools.com/docs/reference/rangebarreferenceproperties.md) object: | Property | Type | Description | Default | | --- | --- | --- | --- | | [Marker](https://www.adaptabletools.com/docs/reference/rangebarreferenceproperties.md#marker) | [`BarStyleMarker`](https://www.adaptabletools.com/docs/reference/barstylemarker.md) | Visual style of the reference marker. | `{ Shape: 'Line', Color: 'var(--ab-color-foreground)', Size: 2 }` | | [Value](https://www.adaptabletools.com/docs/reference/rangebarreferenceproperties.md#value) | [`RangeBarBound`](https://www.adaptabletools.com/docs/reference/rangebarbound.md) | Resolvable reference value (number / column id / 'Col-Min' \| 'Col-Max'
\| 'Col-Avg' \| 'Col-Median'`). Same forms as `RangeBarStyle.Min` / `Max. | | #### Out of Range `OutOfRange` is a [`RangeBarOutOfRangeProperties`](https://www.adaptabletools.com/docs/reference/rangebaroutofrangeproperties.md) object: | Property | Type | Description | Default | | --- | --- | --- | --- | | [Color](https://www.adaptabletools.com/docs/reference/rangebaroutofrangeproperties.md#color) | `string` | Marker colour override applied when the cell value is out of range
(only used with `Mode: 'Clamp'`). Useful to draw attention to
"off-scale" rows. | | | [Mode](https://www.adaptabletools.com/docs/reference/rangebaroutofrangeproperties.md#mode) | `'Clamp' \| 'Overflow' \| 'Hide'` | Behaviour when the cell value falls outside `[Min, Max]`.

- `'Clamp'` (default) — clamp the marker to the nearest end of the
track and (optionally) re-colour it via `Color`
- `'Overflow'` — draw the marker outside the track at its true position
- `'Hide'` — omit the cell-value marker entirely | `'Clamp'` | #### Track `Track` is a [`RangeBarTrackProperties`](https://www.adaptabletools.com/docs/reference/rangebartrackproperties.md) object: | Property | Type | Description | Default | | --- | --- | --- | --- | | [Color](https://www.adaptabletools.com/docs/reference/rangebartrackproperties.md#color) | `string` | Track colour. | 'var(--ab-color-foreground, #999)' at low alpha | | [Height](https://www.adaptabletools.com/docs/reference/rangebartrackproperties.md#height) | `number` | Track thickness in px (the *short* axis — height in horizontal,
width in vertical). | 4 | #### Cell text and tooltip `CellTextProperties` is a [`BarStyleCellTextProperties`](https://www.adaptabletools.com/docs/reference/barstylecelltextproperties.md): | Property | Type | Description | | --- | --- | --- | | [CellTextLayout](https://www.adaptabletools.com/docs/reference/barstylecelltextproperties.md#celltextlayout) | [`BarStyleCellTextLayout`](https://www.adaptabletools.com/docs/reference/barstylecelltextlayout.md) | Per-value placement on the 3 × 3 grid around / on the bar/chart. | `CellTextLayout` is a [`BarStyleCellTextLayout`](https://www.adaptabletools.com/docs/reference/barstylecelltextlayout.md): | Property | Type | Description | | --- | --- | --- | | [CellValue](https://www.adaptabletools.com/docs/reference/barstylecelltextlayout.md#cellvalue) | [`BarStyleCellTextPlacement`](https://www.adaptabletools.com/docs/reference/barstylecelltextplacement.md) | Placement of the formatted cell value. | | [PercentValue](https://www.adaptabletools.com/docs/reference/barstylecelltextlayout.md#percentvalue) | [`BarStyleCellTextPlacement`](https://www.adaptabletools.com/docs/reference/barstylecelltextplacement.md) | Placement of the percent value (the cell value's position along the bar's
`[min, max]` scale as a 0–100% reading). | Each value is a [`BarStyleCellTextPlacement`](https://www.adaptabletools.com/docs/reference/barstylecelltextplacement.md): | Property | Type | Description | Default | | --- | --- | --- | --- | | [Horizontal](https://www.adaptabletools.com/docs/reference/barstylecelltextplacement.md#horizontal) | [`BarStyleCellTextHorizontalAlignment`](https://www.adaptabletools.com/docs/reference/barstylecelltexthorizontalalignment.md) | Horizontal alignment within its vertical band. | 'Left' | | [Vertical](https://www.adaptabletools.com/docs/reference/barstylecelltextplacement.md#vertical) | [`BarStyleCellTextVerticalAlignment`](https://www.adaptabletools.com/docs/reference/barstylecelltextverticalalignment.md) | Vertical position relative to the bar/chart. | 'Below' | `Horizontal` is a [`BarStyleCellTextHorizontalAlignment`](https://www.adaptabletools.com/docs/reference/barstylecelltexthorizontalalignment.md): [See API: barstylecelltexthorizontalalignment](https://www.adaptabletools.com/docs/reference/barstylecelltexthorizontalalignment.md) `Vertical` is a [`BarStyleCellTextVerticalAlignment`](https://www.adaptabletools.com/docs/reference/barstylecelltextverticalalignment.md): [See API: barstylecelltextverticalalignment](https://www.adaptabletools.com/docs/reference/barstylecelltextverticalalignment.md) `ToolTipText` is a [`CellTextOptions`](https://www.adaptabletools.com/docs/reference/celltextoptions.md) array of [`CellTextOption`](https://www.adaptabletools.com/docs/reference/celltextoption.md) tokens: [See API: celltextoption](https://www.adaptabletools.com/docs/reference/celltextoption.md) --- ## Icon Style User guide: [Icon Style](https://www.adaptabletools.com/docs/handbook-styled-column-icon/index.md) #### IconStyle | Property | Type | Description | Default | | --- | --- | --- | --- | | [Cell](https://www.adaptabletools.com/docs/reference/iconstyle.md#cell) | [`CellBoxStyle`](https://www.adaptabletools.com/docs/reference/cellboxstyle.md) | Optional stying (background / border / radius) for Cell behind the Icon | | | [CellTextProperties](https://www.adaptabletools.com/docs/reference/iconstyle.md#celltextproperties) | `IconCellTextProperties` | Companion text to render alongside a matched icon (Cell Value and/or
the matched mapping's Description) and where it sits relative to the
icon (Before / After / Above / Below).

Mirrors the `CellTextProperties` grouping used by `PercentBarStyle`,
`BulletChartStyle` and `RangeBarStyle` for consistency. | | | [FallbackProperties](https://www.adaptabletools.com/docs/reference/iconstyle.md#fallbackproperties) | `IconFallbackProperties` | Behaviour when no mapping matches the cell value, plus the icon used
by `Mode: 'Icon'`.

Defaults to `{ Mode: 'Hide' }` when omitted. | | | [Font](https://www.adaptabletools.com/docs/reference/iconstyle.md#font) | [`CellFontStyle`](https://www.adaptabletools.com/docs/reference/cellfontstyle.md) | Optional cell-text styling applied to the companion text | | | [Gap](https://www.adaptabletools.com/docs/reference/iconstyle.md#gap) | `number` | Pixel gap between the icon and the cell text (when shown). | `4` | | [Mappings](https://www.adaptabletools.com/docs/reference/iconstyle.md#mappings) | [`IconStyleMapping`](https://www.adaptabletools.com/docs/reference/iconstylemapping.md)`[]` | Custom mappings for style (layered on top of a preset); leave undefined to use preset as-is | | | [MatchMode](https://www.adaptabletools.com/docs/reference/iconstyle.md#matchmode) | [`IconStyleMatchMode`](https://www.adaptabletools.com/docs/reference/iconstylematchmode.md) | How `Key` is compared with the cell value (Exact or Case Insensitive) | `'Exact'` | | [Preset](https://www.adaptabletools.com/docs/reference/iconstyle.md#preset) | [`IconStyleBuiltInPreset`](https://www.adaptabletools.com/docs/reference/iconstylebuiltinpreset.md) | Built-in mappings to use for the Icon Style | | | [Size](https://www.adaptabletools.com/docs/reference/iconstyle.md#size) | `number` | Pixel size of icon glyph (square) | `18` | | [ToolTipText](https://www.adaptabletools.com/docs/reference/iconstyle.md#tooltiptext) | `('CellValue' \| 'IconDescription')[]` | Tooltip content: `CellValue` (raw cell value) or `IconDescription` (matched mapping's `Description`) | | #### IconStyleMapping Each entry in `Mappings`: | Property | Type | Description | | --- | --- | --- | | [Description](https://www.adaptabletools.com/docs/reference/iconstylemapping.md#description) | `string` | Optional human-readable description of this mapping (e.g. the full
country name when `Key` is an ISO code). Surfaced in the tooltip and
by the wizard's mappings list. | | [Icon](https://www.adaptabletools.com/docs/reference/iconstylemapping.md#icon) | [`IconStyleSpec`](https://www.adaptabletools.com/docs/reference/iconstylespec.md) | Icon to render when `Key` matches the cell value.

See — accepts an `AdaptableIcon` (system /
URL / element) or a plain string for emoji. | | [Key](https://www.adaptabletools.com/docs/reference/iconstylemapping.md#key) | `string \| number \| boolean` | Cell value that triggers this mapping. Compared using the parent
(defaults to strict equality).

Booleans and numbers are accepted to support typed columns (e.g.
`Key: true` for an `isLive` flag, `Key: 0` for a status code). | #### IconStyleSpec Used by `Icon` on each mapping and by `FallbackIcon` ([`IconStyleSpec`](https://www.adaptabletools.com/docs/reference/iconstylespec.md)): [See API: iconstylespec](https://www.adaptabletools.com/docs/reference/iconstylespec.md) #### IconStyleMatchMode Used by `MatchMode` ([`IconStyleMatchMode`](https://www.adaptabletools.com/docs/reference/iconstylematchmode.md)): [See API: iconstylematchmode](https://www.adaptabletools.com/docs/reference/iconstylematchmode.md) #### IconStyleFallback `FallbackProperties.Mode` is an [`IconStyleFallback`](https://www.adaptabletools.com/docs/reference/iconstylefallback.md): [See API: iconstylefallback](https://www.adaptabletools.com/docs/reference/iconstylefallback.md) `FallbackProperties` itself has two properties: | Property | Type | Description | | --- | --- | --- | | `Mode` | `IconStyleFallback` | What to draw when no mapping matches. Defaults to `Hide` | | `Icon` | `IconStyleSpec` | Icon used when `Mode` is `Icon` | #### IconStyleBuiltInPreset Used by `Preset` to seed mappings in the wizard ([`IconStyleBuiltInPreset`](https://www.adaptabletools.com/docs/reference/iconstylebuiltinpreset.md)): [See API: iconstylebuiltinpreset](https://www.adaptabletools.com/docs/reference/iconstylebuiltinpreset.md) #### CellBoxStyle Used by `Cell` — optional box styling behind the icon. | Property | Type | Description | | --- | --- | --- | | [BackColor](https://www.adaptabletools.com/docs/reference/cellboxstyle.md#backcolor) | `string` | Colour background of cell: hex, rgb(a) or name | | [BorderColor](https://www.adaptabletools.com/docs/reference/cellboxstyle.md#bordercolor) | `string` | Colour of cell border: hex, rgb(a) or name | | [BorderRadius](https://www.adaptabletools.com/docs/reference/cellboxstyle.md#borderradius) | `number` | Rounds corners of an element's outer border edge; equivalent of CSS border-radius | #### CellFontStyle Used by `Font` — styling for companion cell text. | Property | Type | Description | | --- | --- | --- | | [Alignment](https://www.adaptabletools.com/docs/reference/cellfontstyle.md#alignment) | `Alignment` | Align to `Left`, `Right` or `Center` | | [FontSize](https://www.adaptabletools.com/docs/reference/cellfontstyle.md#fontsize) | `'XSmall' \| 'Small' \| 'Medium' \| 'Large' \| 'XLarge'` | Size of font: `XSmall`, `Small`, `Medium`, `Large` or `XLarge` | | [FontStyle](https://www.adaptabletools.com/docs/reference/cellfontstyle.md#fontstyle) | `'Normal' \| 'Italic'` | Style of font: `Normal` or `Italic` | | [FontWeight](https://www.adaptabletools.com/docs/reference/cellfontstyle.md#fontweight) | `'Normal' \| 'Bold'` | Weight of font: `Normal` or `Bold` | | [ForeColor](https://www.adaptabletools.com/docs/reference/cellfontstyle.md#forecolor) | `string` | Font colour in cell: hex, rgb(a) or name | | [TextDecoration](https://www.adaptabletools.com/docs/reference/cellfontstyle.md#textdecoration) | `'None' \| 'Underline' \| 'Overline' \| 'LineThrough'` | Decoration of font: `None`, `Underline`, `Overline` or `LineThrough` | #### Cell text `CellTextProperties` is an `IconCellTextProperties` object: | Property | Type | Description | | --- | --- | --- | | `CellText` | `('CellValue' \| 'IconDescription')[]` | Text rendered beside a matched icon: the raw cell value, the mapping `Description`, or both | | `CellTextPosition` | `'Before' \| 'After' \| 'Above' \| 'Below'` | Where that text sits relative to the icon. Defaults to `After` | `ToolTipText` accepts the same tokens: `'CellValue'` or `'IconDescription'`. --- ## Styled Column API | Method | Returns | Description | | --- | --- | --- | | [addStyledColumn(styledColumn)](https://www.adaptabletools.com/docs/reference/styledcolumnapi.md#addstyledcolumn) | `void` | Adds a Styled Column to state. | | [canDisplaySparklines()](https://www.adaptabletools.com/docs/reference/styledcolumnapi.md#candisplaysparklines) | `boolean` | Can this AdapTable instance display Sparklines (e.g. is AG Grid SparklinesModule installed) | | [deleteAllStyledColumns()](https://www.adaptabletools.com/docs/reference/styledcolumnapi.md#deleteallstyledcolumns) | `void` | Delete all Styled Columns in State | | [deleteStyledColumn(styledColumn)](https://www.adaptabletools.com/docs/reference/styledcolumnapi.md#deletestyledcolumn) | `void` | Deletes a Styled Column from state. | | [editStyledColumn(styledColumn)](https://www.adaptabletools.com/docs/reference/styledcolumnapi.md#editstyledcolumn) | [`StyledColumn`](https://www.adaptabletools.com/docs/reference/styledcolumn.md) | Edits a Styled Column | | [getActiveStyledColumnForColumn(column)](https://www.adaptabletools.com/docs/reference/styledcolumnapi.md#getactivestyledcolumnforcolumn) | [`StyledColumn`](https://www.adaptabletools.com/docs/reference/styledcolumn.md)` \| undefined` | Returns a Styled Column for a given column | | [getActiveStyledColumns()](https://www.adaptabletools.com/docs/reference/styledcolumnapi.md#getactivestyledcolumns) | [`StyledColumn`](https://www.adaptabletools.com/docs/reference/styledcolumn.md)`[]` | Retrieves all active (not-suspended) Styled Columns in Adaptable State | | [getStyledColumnById(id)](https://www.adaptabletools.com/docs/reference/styledcolumnapi.md#getstyledcolumnbyid) | [`StyledColumn`](https://www.adaptabletools.com/docs/reference/styledcolumn.md) | Retrieves Styled Column by Id | | [getStyledColumnByName(name)](https://www.adaptabletools.com/docs/reference/styledcolumnapi.md#getstyledcolumnbyname) | [`StyledColumn`](https://www.adaptabletools.com/docs/reference/styledcolumn.md)` \| undefined` | Retrieves Styled Column by Name | | [getStyledColumnForColumnId(columnId)](https://www.adaptabletools.com/docs/reference/styledcolumnapi.md#getstyledcolumnforcolumnid) | [`StyledColumn`](https://www.adaptabletools.com/docs/reference/styledcolumn.md) | Retrieves Styled Column for given Column Id | | [getStyledColumns()](https://www.adaptabletools.com/docs/reference/styledcolumnapi.md#getstyledcolumns) | [`StyledColumn`](https://www.adaptabletools.com/docs/reference/styledcolumn.md)`[]` | Retrieves all Styled Columns in Adaptable State | | [getStyledColumnState()](https://www.adaptabletools.com/docs/reference/styledcolumnapi.md#getstyledcolumnstate) | [`StyledColumnState`](https://www.adaptabletools.com/docs/reference/styledcolumnstate.md) | Retrieves Styled Column section from Adaptable State | | [getSuspendedStyledColumns()](https://www.adaptabletools.com/docs/reference/styledcolumnapi.md#getsuspendedstyledcolumns) | [`StyledColumn`](https://www.adaptabletools.com/docs/reference/styledcolumn.md)`[]` | Retrieves all suspended Styled Columns in Adaptable State | | [hasBulletChartStyle(columnId)](https://www.adaptabletools.com/docs/reference/styledcolumnapi.md#hasbulletchartstyle) | `boolean` | Checks whether Column with given `columnId` has a Bullet Chart Style applied | | [hasGradientStyle(columnId)](https://www.adaptabletools.com/docs/reference/styledcolumnapi.md#hasgradientstyle) | `boolean` | Checks whether Column with given `columnId` has a Gradient Style applied | | [hasPercentBarStyle(columnId)](https://www.adaptabletools.com/docs/reference/styledcolumnapi.md#haspercentbarstyle) | `boolean` | Checks whether Column with given `columnId` has a PercentBar Style applied | | [hasRatingStyle(columnId)](https://www.adaptabletools.com/docs/reference/styledcolumnapi.md#hasratingstyle) | `boolean` | Checks whether Column with given `columnId` has a Rating Style applied | | [isSparklineStyleStyledColumn(column)](https://www.adaptabletools.com/docs/reference/styledcolumnapi.md#issparklinestylestyledcolumn) | `boolean` | Whether this column is drawn as a sparkline. | | [openStyledColumnSettingsPanel()](https://www.adaptabletools.com/docs/reference/styledcolumnapi.md#openstyledcolumnsettingspanel) | `void` | Open Styled Column section of Settings Panel | | [renderSparkline(options)](https://www.adaptabletools.com/docs/reference/styledcolumnapi.md#rendersparkline) | `AgChartInstance \| null` | Renders a standalone [Sparkline](https://www.ag-grid.com/javascript-data-grid/sparklines-overview/)
into a DOM element you provide, using the same AG Charts engine as Sparkline Styled Columns.

Provide at least `container` (where to render) and `data` (what to plot) on `options`; see
[AgSparklineOptions](https://www.ag-grid.com/javascript-data-grid/sparklines-overview/) for the
full set (`type`, `width`/`height`, `min`/`max`, etc.).

The caller owns the returned instance and is responsible for its lifecycle: call `update()` to
re-render it when the data or options change, and `destroy()` to dispose of it (e.g. when the
`container` is removed) to avoid memory leaks. AdapTable does not track or clean it up for you. | | [suspendAllStyledColumn()](https://www.adaptabletools.com/docs/reference/styledcolumnapi.md#suspendallstyledcolumn) | `void` | Suspends all Styled Columns | | [suspendStyledColumn(styledColumn)](https://www.adaptabletools.com/docs/reference/styledcolumnapi.md#suspendstyledcolumn) | `void` | Suspends an active Styled Column so its style is no longer drawn. | | [unSuspendAllStyledColumn()](https://www.adaptabletools.com/docs/reference/styledcolumnapi.md#unsuspendallstyledcolumn) | `void` | Activates all suspended Styled Column | | [unSuspendStyledColumn(styledColumn)](https://www.adaptabletools.com/docs/reference/styledcolumnapi.md#unsuspendstyledcolumn) | `void` | Activates a suspended Styled Column so its style is drawn again. |