Styled Columns Technical Reference

Summary

  • Styled Columns are configured at design-time in Initial Adaptable State
  • Each style section below lists all properties for that style, including inherited base types and nested objects (shared types such as CellColorRange are repeated in every section that uses them)
  • The Styled Column API section at the end covers run-time access

Styled Column State

The Styled Column section of Adaptable State contains a collection of StyledColumn objects:

PropertyTypeDescription
StyledColumnsStyledColumn[]Collection of Styled Columns

StyledColumn

Each styled column is defined as follows:

PropertyTypeDescription
BadgeStyleBadgeStyleDisplays cell values in Column as a Badge
BulletChartStyleBulletChartStyleStyles a numeric column with single-row Bullet Chart, showing value as bar, target as marker and optional bands behind bar
ColumnIdstringId of Column being styled
GradientStyleGradientStyleStyles a numeric column with a Gradient
IconStyleIconStyleStyles a column where each cell displays an icon looked up from a list of key → icon mappings
NamestringUnique Name of Styled Column - used to identify it in Adaptable UI and APIs
PercentBarStylePercentBarStyleStyles a numeric column so each cell displays a 'Bar'
RangeBarStyleRangeBarStyleStyles a numeric column as Range Bar - track showing where cell value sits between Min and Max
RatingStyleRatingStyleStyles a numeric column as a Rating - row of icons filled according to cell value
RowScopeRowScopeWhich rows will render the Styled Column (data / group / summary total)
SparklineStyleSparklineStyleDisplays a Sparkline Chart in an array column
IsReadOnlybooleanSets Entity to ReadOnly (overwriting a Strategy Entitlement of 'Full')
IsSuspendedbooleanSuspends (i.e. turns off) an Adaptable Object

RowScope

The optional RowScope property on StyledColumn controls which row types render the style:

PropertyTypeDescription
ExcludeDataRowsbooleanExclude regular data rows
ExcludeGroupRowsbooleanExclude Group Rows
ExcludeSummaryRowsbooleanExclude Summary Rows (used in Row Summaries)
ExcludeTotalRowsbooleanExclude Grand Total Rows (used in Aggregations)

Gradient Style

The Gradient Style uses a GradientStyle object:

PropertyTypeDescriptionDefault
AutoContrastTextbooleanWhen true, sets cell color from tinted background so text stays readable
FontCellFontStyleOptional cell-text styling applied by Gradient renderer on top of gradient background tint
MaxAlphanumberAlpha (0–1) at high end of the matched range’s scale1 (fully opaque at range max)
MinAlphanumberAlpha (0–1) at low end of the matched range’s scale0.15 (faint at range min)
ToolTipTextCellTextOptionsOptional AG Grid tooltip content: cell value and/or position along the range scale (%)
ZeroCentredZeroCentredColorsZero-centred diverging gradient (Col-Min0 and 0Col-Max

Numeric Styled Column

The GradientStyle extends the base NumericStyledColumn object:

PropertyTypeDescriptionDefault
CellRangesCellColorRange[]Ranges (e.g. to create traffic light effect)
ColumnComparisonColumnComparisonCompares Cell values to another Column
RangeValueTypeRangeValueTypeUsed 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 which defines a colour band between Min and Max endpoints:

PropertyTypeDescription
ColorstringCell colour to use for values that fall inside Range
Maxnumber |DynamicRangeEndpointEnd of Range, can be literal number or DynamicRangeEndpoint
Minnumber |DynamicRangeEndpointStart of Range, can be literal number or DynamicRangeEndpoint
ReverseGradientbooleanReverses the alpha ramp within this range only — values at the low end render saturated, values at the high end render faint.

Dynamic Endpoint

Min and Max properties accept either a literal number or a DynamicRangeEndpoint defined as follows:

Value
'Col-Min'
'Col-Max'
'Col-Avg'
'Col-Median'

Column Comparison

The ColumnComparison property is of type columncomparison which compares the cell value against another column's min/max span:

PropertyTypeDescription
ColorstringColour to use for the Comparison
MaxValuenumber | stringEnd value - either numeric value or Column ID
MinValuenumber | stringStart value - either numeric value or Column ID

Range Value Type

The RangeValueType property is of type RangeValueType:

Value
'Number'
'Percentage'

Zero Centred Gradient

The ZeroCentred property is of type ZeroCentredColors which allows you to create a diverging gradient centred on zero:

PropertyTypeDescription
NegativeColorstringColour applied to negative cell values (Col-Min0)
PositiveColorstringColour applied to positive cell values (0Col-Max)

Cell Styling

There are 2 properties used to for cell styling.

  • Font (of type cellfontstyle applies the cell text styling on top of the gradient tint:
PropertyTypeDescription
AlignmentAlignmentAlign to Left, Right or Center
FontSize'XSmall' | 'Small' | 'Medium' | 'Large' | 'XLarge'Size of font: XSmall, Small, Medium, Large or XLarge
FontStyle'Normal' | 'Italic'Style of font: Normal or Italic
FontWeight'Normal' | 'Bold'Weight of font: Normal or Bold
ForeColorstringFont colour in cell: hex, rgb(a) or name
TextDecoration'None' | 'Underline' | 'Overline' | 'LineThrough'Decoration of font: None, Underline, Overline or LineThrough
Value
'CellValue'
'PercentageValue'

Percent Bar Style

The Percent Bar Style uses a PercentBarStyle object:

PropertyTypeDescriptionDefault
BackColorstringBackground colour for 'Percent Bar'; leave unset if none requiredundefined
CellTextPropertiesBarStyleCellTextPropertiesOptional cell-text overlay configuration (display tokens, position, layout, alignment).
FontCellFontStyleOptional cell-text styling applied to CellText overlay
Origin'Auto' | 'Zero' | 'Min' | numberOrigin of the bar - i.e. the value the bar grows from Auto, Zero, Min or fixed number'Auto'
ToolTipTextCellTextOptionsWhether Tooltip shows Cell Value, Percent Value, both or none

Numeric Styled Column

The PercentBarStyle extends the base NumericStyledColumn object:

PropertyTypeDescriptionDefault
CellRangesCellColorRange[]Ranges (e.g. to create traffic light effect)
ColumnComparisonColumnComparisonCompares Cell values to another Column
RangeValueTypeRangeValueTypeUsed 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 and colours the bar according to where the cell value falls in each range.

PropertyTypeDescription
ColorstringCell colour to use for values that fall inside Range
Maxnumber |DynamicRangeEndpointEnd of Range, can be literal number or DynamicRangeEndpoint
Minnumber |DynamicRangeEndpointStart of Range, can be literal number or DynamicRangeEndpoint
ReverseGradientbooleanReverses the alpha ramp within this range only — values at the low end render saturated, values at the high end render faint.

Dynamic Endpoint

Min and Max properties accept either a literal number or a DynamicRangeEndpoint defined as follows:

Value
'Col-Min'
'Col-Max'
'Col-Avg'
'Col-Median'

Column Comparison

The ColumnComparison property is of type columncomparison which compares the cell value against another column's min/max span:

PropertyTypeDescription
ColorstringColour to use for the Comparison
MaxValuenumber | stringEnd value - either numeric value or Column ID
MinValuenumber | stringStart value - either numeric value or Column ID

Range Value Type

The RangeValueType property is of type RangeValueType:

Value
'Number'
'Percentage'

Cell Styling

There are 3 properties used to for cell styling.

  • Font (of type cellfontstyle — styling for the optional CellText overlay:
PropertyTypeDescription
AlignmentAlignmentAlign to Left, Right or Center
FontSize'XSmall' | 'Small' | 'Medium' | 'Large' | 'XLarge'Size of font: XSmall, Small, Medium, Large or XLarge
FontStyle'Normal' | 'Italic'Style of font: Normal or Italic
FontWeight'Normal' | 'Bold'Weight of font: Normal or Bold
ForeColorstringFont colour in cell: hex, rgb(a) or name
TextDecoration'None' | 'Underline' | 'Overline' | 'LineThrough'Decoration of font: None, Underline, Overline or LineThrough
  • CellText

  • ToolTipText

Both are of type CellTextOptions — an array of CellTextOption tokens:

Value
'CellValue'
'PercentageValue'

Badge Style

The Badge Style contains a badgestyle object:

PropertyTypeDescriptionDefault
BadgesBadgeStyleDefinition[]Collection of Badge Style Definitions
CellCellBoxStyleOptional cell-box styling applied to grid cell behind the badges
DensityBadgeDensityDensity preset shared by every badge in the column - controls inner padding.'Normal'
FontCellFontStyleOptional column-level Font (only Alignment is meaningful for Badge cells)
OverflowModeBadgeOverflowModeHow badges lay out in array-column cells where space is tight'Truncate'
SpacingnumberPixel gap between adjacent badges in array-column cells4

Badge Style Definition

Each entry in Badges is a BadgeStyleDefinition:

PropertyTypeDescriptionDefault
ExpressionAdaptableBooleanQuery
IconPropertiesBadgeIconPropertiesSettings for Icon to display alongside badge text
PillStyleBadgePillStyleStyle for the Badge pill (cut-down version of Adaptable Style)
PredicateBadgeStylePredicateOptional Rule for deciding whether Badge is displayed
ShapeBadgeShapeVisual shape of the Badge's corner radius'Rounded'

Badge Pill Style

Each Badge contains a PillStyle property; this is a subset of AdaptableStyle:

PropertyTypeDescription
BackColorstringColour background of cell: hex, rgb(a) or name
ForeColorstringFont colour in cell: hex, rgb(a) or name
BorderColorstringColour of cell border: hex, rgb(a) or name
FontWeight'Normal' | 'Bold'Weight of font: Normal or Bold
FontStyle'Normal' | 'Italic'Style of font: Normal or Italic
TextDecoration'None' | 'Underline' | 'Overline' | 'LineThrough'Decoration of font: None, Underline, Overline or LineThrough

Pill Shape

The Shape property (of type BadgeShape) defines the Shape (essentially radius) of the Pill:

Value
'Pill'
'Rounded'
'Square'

Cell Box Style

The Cell property is of type cellboxstyle and provides optional box styling behind the badge row

PropertyTypeDescription
BackColorstringColour background of cell: hex, rgb(a) or name
BorderColorstringColour of cell border: hex, rgb(a) or name
BorderRadiusnumberRounds corners of an element's outer border edge; equivalent of CSS border-radius

Cell Font Style

The Font property (of type cellfontstyle) provides font styling (although only Alignment is meaningful):

PropertyTypeDescription
AlignmentAlignmentAlign to Left, Right or Center
FontSize'XSmall' | 'Small' | 'Medium' | 'Large' | 'XLarge'Size of font: XSmall, Small, Medium, Large or XLarge
FontStyle'Normal' | 'Italic'Style of font: Normal or Italic
FontWeight'Normal' | 'Bold'Weight of font: Normal or Bold
ForeColorstringFont colour in cell: hex, rgb(a) or name
TextDecoration'None' | 'Underline' | 'Overline' | 'LineThrough'Decoration of font: None, Underline, Overline or LineThrough

Sparkline Style

The Sparkline Style contains a sparklinestyle object:

PropertyTypeDescription
CellCellBoxStyleOptional cell box styling applied to the cell behind the sparkline chart.
optionsAgSparklineOptionsAG Grid Sparkline Options

Note

Cell Box Style

The Cell is of type cellboxstyle and provides optional box styling behind the sparkline chart:

PropertyTypeDescription
BackColorstringColour background of cell: hex, rgb(a) or name
BorderColorstringColour of cell border: hex, rgb(a) or name
BorderRadiusnumberRounds corners of an element's outer border edge; equivalent of CSS border-radius

Bullet Chart Style

The Bullet Chart Style uses a BulletChartStyle object:

PropertyTypeDescriptionDefault
BackColorstringBackground colour for the chart area when no CellRanges are supplied.
BarBulletChartBarPropertiesVisual properties of the actual (foreground) bar — colour and thickness.
CellTextPropertiesBarStyleCellTextPropertiesOptional cell-text overlay configuration.
FontCellFontStyleOptional cell-text styling (colour, weight, font, alignment, …) applied by the Bullet Chart renderer to the optional CellText overlay.
Orientation'Horizontal' | 'Vertical'Orientation of the chart.'Horizontal'
Origin'Auto' | 'Zero' | numberOrigin of the actual bar.'Auto'
TargetPropertiesBulletChartTargetPropertiesTarget 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.
ToolTipTextCellTextOptionsTooltip content - same tokens ('CellValue', 'PercentageValue') as Percent Bar.

Numeric Styled Column

The BulletChartStyle extends the base NumericStyledColumn object:

PropertyTypeDescriptionDefault
CellRangesCellColorRange[]Ranges (e.g. to create traffic light effect)
ColumnComparisonColumnComparisonCompares Cell values to another Column
RangeValueTypeRangeValueTypeUsed 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 and renders qualitative background bands behind the bar:

PropertyTypeDescription
ColorstringCell colour to use for values that fall inside Range
Maxnumber |DynamicRangeEndpointEnd of Range, can be literal number or DynamicRangeEndpoint
Minnumber |DynamicRangeEndpointStart of Range, can be literal number or DynamicRangeEndpoint
ReverseGradientbooleanReverses the alpha ramp within this range only — values at the low end render saturated, values at the high end render faint.

Dynamic Endpoint

Min and Max properties accept either a literal number or a DynamicRangeEndpoint defined as follows:

Value
'Col-Min'
'Col-Max'
'Col-Avg'
'Col-Median'

Column Comparison

The ColumnComparison property is of type columncomparison which compares the cell value against another column's min/max span:

PropertyTypeDescription
ColorstringColour to use for the Comparison
MaxValuenumber | stringEnd value - either numeric value or Column ID
MinValuenumber | stringStart value - either numeric value or Column ID

Range Value Type

The RangeValueType property is of type RangeValueType:

Value
'Number'
'Percentage'

Bullet Chart Target

The TargetProperties property is a is a BulletChartTargetProperties object made up of 2 properties:

PropertyTypeDescription
MarkerBarStyleMarkerVisual style of the target marker(s).
TargetBulletChartTarget|BulletChartTarget[]Target value(s) rendered as marker(s) on the bar.

Marker

The Marker property is a is a BarStyleMarker object:

PropertyTypeDescriptionDefault
ColorstringMarker colour. Defaults to the current text colour.'var(--ab-color-text)'
Shape'Line' | 'Triangle' | 'Dot' | 'Diamond'Marker shape.
SizenumberLine thickness (for Shape: 'Line') or shape size in px.

Target

The Target property is a is a BulletChartTarget object:

Value
number
string
'Col-Avg'
'Col-Median'
BulletChartTargetDefinition

Cell Styling

There are 3 properties used to for cell styling.

  • Font (of type cellfontstyle — styling for the optional CellText overlay:
PropertyTypeDescription
AlignmentAlignmentAlign to Left, Right or Center
FontSize'XSmall' | 'Small' | 'Medium' | 'Large' | 'XLarge'Size of font: XSmall, Small, Medium, Large or XLarge
FontStyle'Normal' | 'Italic'Style of font: Normal or Italic
FontWeight'Normal' | 'Bold'Weight of font: Normal or Bold
ForeColorstringFont colour in cell: hex, rgb(a) or name
TextDecoration'None' | 'Underline' | 'Overline' | 'LineThrough'Decoration of font: None, Underline, Overline or LineThrough
  • CellText

  • ToolTipText

Both are of type CellTextOptions — an array of CellTextOption tokens:

Value
'CellValue'
'PercentageValue'

Rating Style

User guide: Rating Style

RatingStyle

PropertyTypeDescriptionDefault
AllowHalfbooleanControls partial icons for fractional values after clamping to [0, Max] — not scaling between different ranges (e.g. 10-point vs 5-star).true
CellCellBoxStyleOptional cell box styling (background colour, border, border radius) applied to the cell behind the rating icons.
EmptyColorstringOutline / fill colour for the inactive portion of the rating.a low-opacity tint of the current text colour.
FilledColorstringFill 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.
GapnumberPixel gap between adjacent icons.2
IconRatingIconShapeIcon used for each rating mark.'Star'
MaxnumberNumber of icons per cell and the upper bound of the rating scale, in the same numeric units as the cell value.5
ShowValuebooleanWhen 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
SizenumberIcon size in pixels (each icon is square). The renderer keeps the row of icons vertically centred regardless of cell height.14
ToolTipTextCellTextOptionsOptional 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):

Value
'Star'
'Heart'
'Circle'
'Thumb'

CellBoxStyle

Used by Cell — optional box styling behind the rating icons.

PropertyTypeDescription
BackColorstringColour background of cell: hex, rgb(a) or name
BorderColorstringColour of cell border: hex, rgb(a) or name
BorderRadiusnumberRounds corners of an element's outer border edge; equivalent of CSS border-radius

CellTextOption

Used by ToolTipText:

Value
'CellValue'
'PercentageValue'

Range Bar Style

User guide: Range Bar Style

RangeBarStyle extends NumericStyledColumn.

RangeBarStyle

PropertyTypeDescriptionDefault
BackColorstringBackground colour for the chart area when no CellRanges are supplied.
CellTextPropertiesBarStyleCellTextPropertiesOptional cell-text overlay configuration.
MarkerBarStyleMarkerVisual style of the cell-value marker.{ Shape: 'Diamond', Color: 'var(--ab-color-accent)', Size: 8 }
MaxRangeBarBoundUpper bound of the track for each row.
MinRangeBarBoundLower bound of the track for each row.
Orientation'Horizontal' | 'Vertical'Orientation of the range bar.'Horizontal'
OutOfRangeRangeBarOutOfRangePropertiesBehaviour when the cell value falls outside [Min, Max], plus the optional marker colour override used by Mode: 'Clamp'.
ReferenceRangeBarReferencePropertiesOptional 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.
ToolTipTextCellTextOptionsTooltip content — same tokens ('CellValue', 'PercentageValue') as Percent Bar / Bullet Chart.
TrackRangeBarTrackPropertiesVisual properties of the track (the line representing the [Min, Max] interval).

NumericStyledColumn (inherited)

PropertyTypeDescriptionDefault
CellRangesCellColorRange[]Ranges (e.g. to create traffic light effect)
ColumnComparisonColumnComparisonCompares Cell values to another Column
RangeValueTypeRangeValueTypeUsed 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).

PropertyTypeDescription
ColorstringCell colour to use for values that fall inside Range
Maxnumber |DynamicRangeEndpointEnd of Range, can be literal number or DynamicRangeEndpoint
Minnumber |DynamicRangeEndpointStart of Range, can be literal number or DynamicRangeEndpoint
ReverseGradientbooleanReverses the alpha ramp within this range only — values at the low end render saturated, values at the high end render faint.

Min and Max also accept a DynamicRangeEndpoint:

Value
'Col-Min'
'Col-Max'
'Col-Avg'
'Col-Median'

ColumnComparison

Used by ColumnComparison.

PropertyTypeDescription
ColorstringColour to use for the Comparison
MaxValuenumber | stringEnd value - either numeric value or Column ID
MinValuenumber | stringStart value - either numeric value or Column ID

RangeValueType

RangeValueType:

Value
'Number'
'Percentage'

RangeBarBound

Used by Min, Max and Reference (RangeBarBound):

Value
number
string
DynamicRangeEndpoint

Marker

Marker is a BarStyleMarker

PropertyTypeDescriptionDefault
ColorstringMarker colour. Defaults to the current text colour.'var(--ab-color-text)'
Shape'Line' | 'Triangle' | 'Dot' | 'Diamond'Marker shape.
SizenumberLine thickness (for Shape: 'Line') or shape size in px.

CellTextOption

Used by CellText and ToolTipText:

Value
'CellValue'
'PercentageValue'

Icon Style

User guide: Icon Style

IconStyle

PropertyTypeDescriptionDefault
CellCellBoxStyleOptional stying (background / border / radius) for Cell behind the Icon
CellTextPropertiesIconCellTextPropertiesCompanion 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).
FallbackPropertiesIconFallbackPropertiesBehaviour when no mapping matches the cell value, plus the icon used by Mode: 'Icon'.
FontCellFontStyleOptional cell-text styling applied to the companion text
GapnumberPixel gap between the icon and the cell text (when shown).4
MappingsIconStyleMapping[]Custom mappings for style (layered on top of a preset); leave undefined to use preset as-is
MatchModeIconStyleMatchModeHow Key is compared with the cell value (Exact or Case Insensitive)'Exact'
PresetIconStyleBuiltInPresetBuilt-in mappings to use for the Icon Style
SizenumberPixel size of icon glyph (square)18
ToolTipText('CellValue' | 'IconDescription')[]Tooltip content: CellValue (raw cell value) or IconDescription (matched mapping's Description)

IconStyleMapping

Each entry in Mappings:

PropertyTypeDescription
DescriptionstringOptional 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.
IconIconStyleSpecIcon to render when Key matches the cell value.
Keystring | number | booleanCell value that triggers this mapping. Compared using the parent (defaults to strict equality).

IconStyleSpec

Used by Icon on each mapping and by FallbackIcon (IconStyleSpec):

Value
AdaptableIcon
string

IconStyleMatchMode

Used by MatchMode (IconStyleMatchMode):

Value
'Exact'
'CaseInsensitive'

IconStyleFallback

Used by Fallback (IconStyleFallback):

Value
'Hide'
'ShowText'
'Icon'

IconStyleBuiltInPreset

Used by Preset to seed mappings in the wizard (IconStyleBuiltInPreset):

Value
'Flags'
'Currencies'
'Trend'
'Status'

CellBoxStyle

Used by Cell — optional box styling behind the icon.

PropertyTypeDescription
BackColorstringColour background of cell: hex, rgb(a) or name
BorderColorstringColour of cell border: hex, rgb(a) or name
BorderRadiusnumberRounds corners of an element's outer border edge; equivalent of CSS border-radius

CellFontStyle

Used by Font — styling for companion cell text.

PropertyTypeDescription
AlignmentAlignmentAlign to Left, Right or Center
FontSize'XSmall' | 'Small' | 'Medium' | 'Large' | 'XLarge'Size of font: XSmall, Small, Medium, Large or XLarge
FontStyle'Normal' | 'Italic'Style of font: Normal or Italic
FontWeight'Normal' | 'Bold'Weight of font: Normal or Bold
ForeColorstringFont colour in cell: hex, rgb(a) or name
TextDecoration'None' | 'Underline' | 'Overline' | 'LineThrough'Decoration of font: None, Underline, Overline or LineThrough

Cell text and tooltip tokens

CellText and ToolTipText accept an array of:

'CellValue' | 'IconDescription' — raw cell value, or the matched mapping's Description.


Styled Column API

The Styled Column API section of Adaptable API contains functions for managing Styled Columns:

MethodReturnsDescription
addStyledColumn(styledColumn)voidCreate a Styled column
canDisplaySparklines()booleanCan this AdapTable instance display Sparklines (e.g. is AG Grid SparklinesModule installed)
deleteAllStyledColumns()voidDelete all Styled Columns in State
deleteStyledColumn(styledColumn)voidDelete a Styled column
editStyledColumn(styledColumn)StyledColumnEdits a Styled Column
getActiveStyledColumnForColumn(column)StyledColumn | undefinedReturns a Styled Column for a given column
getActiveStyledColumns(config)StyledColumn[]Retrieves all active (not-suspended) Styled Columns in Adaptable State
getStyledColumnById(id, config)StyledColumnRetrieves Styled Column by Id
getStyledColumnByName(name, config)StyledColumn | undefinedRetrieves Styled Column by Name
getStyledColumnForColumnId(columnId, config)StyledColumnRetrieves Styled Column for given Column Id
getStyledColumns(config)StyledColumn[]Retrieves all Styled Columns in Adaptable State
getStyledColumnState()StyledColumnStateRetrieves Styled Column section from Adaptable State
getSuspendedStyledColumns(config)StyledColumn[]Retrieves all suspended Styled Columns in Adaptable State
hasBulletChartStyle(columnId)booleanChecks whether Column with given columnId has a Bullet Chart Style applied
hasGradientStyle(columnId)booleanChecks whether Column with given columnId has a Gradient Style applied
hasPercentBarStyle(columnId)booleanChecks whether Column with given columnId has a PercentBar Style applied
hasRatingStyle(columnId)booleanChecks whether Column with given columnId has a Rating Style applied
isSparklineStyleStyledColumn(column)booleanChecks whether Column is a Sparkline Column
openStyledColumnSettingsPanel()voidOpen Styled Column section of Settings Panel
renderSparkline(options)AgChartInstance<AgSparklineOptions> | nullRenders a standalone Sparkline into a DOM element you provide, using the same AG Charts engine as Sparkline Styled Columns.
suspendAllStyledColumn()voidSuspends all Styled Columns
suspendStyledColumn(styledColumn)voidSuspends an active Styled Column
unSuspendAllStyledColumn()voidActivates all suspended Styled Column
unSuspendStyledColumn(styledColumn)voidActivates a suspended Styled Column