IconStyleMapping

One mapping in an — Key is matched against the cell's raw value, Icon is what gets drawn when it matches.

TypeScript
export interface

Properties

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).

Property Details

Description

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.

TypeScript
Description?: string;
Property Value

string

Icon

Icon to render when Key matches the cell value.

See — accepts an AdaptableIcon (system / URL / element) or a plain string for emoji.

TypeScript
Icon: IconStyleSpec;
Property Value

IconStyleSpec

Key

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).

TypeScript
Key: string | number | boolean;
Property Value

string | number | boolean

PreviousIconStyleFallbackNextIconStyleMatchMode