IconStyle

Renders cell values as icons by looking up the cell value in a list of key → icon mappings; designed for one-glyph-per-cell visual recognition

export interface

Properties

Property Details

Cell

Optional stying (background / border / radius) for Cell behind the Icon

Cell?: CellBoxStyle;

Property Value

CellBoxStyle

CellTextProperties

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.

CellTextProperties?: IconCellTextProperties;

Property Value

IconCellTextProperties

FallbackProperties

Behaviour when no mapping matches the cell value, plus the icon used by Mode: 'Icon'.

Defaults to { Mode: 'Hide' } when omitted.

FallbackProperties?: IconFallbackProperties;

Property Value

IconFallbackProperties

Font

Optional cell-text styling applied to the companion text

Font?: CellFontStyle;

Property Value

CellFontStyle

Gap

Pixel gap between the icon and the cell text (when shown).

Gap?: number;

Default Value

4

Property Value

number

Mappings

Custom mappings for style (layered on top of a preset); leave undefined to use preset as-is

Mappings?: IconStyleMapping[];

Property Value

IconStyleMapping[]

MatchMode

How Key is compared with the cell value (Exact or Case Insensitive)

MatchMode?: IconStyleMatchMode;

Default Value

'Exact'

Property Value

IconStyleMatchMode

Preset

Built-in mappings to use for the Icon Style

Preset?: IconStyleBuiltInPreset;

Property Value

IconStyleBuiltInPreset

Size

Pixel size of icon glyph (square)

Size?: number;

Default Value

18

Property Value

number

ToolTipText

Tooltip content: CellValue (raw cell value) or IconDescription (matched mapping's Description)

ToolTipText?: ('CellValue' | 'IconDescription')[];

Property Value

('CellValue' | 'IconDescription')[]