StyledColumn

Core Styled Column object

TypeScript
export interface StyledColumn extends
Extends

SuspendableObject

Properties

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

Property Details

BadgeStyle

Displays cell values in Column as a Badge

TypeScript
BadgeStyle?: BadgeStyle;
Property Value

BadgeStyle

BulletChartStyle

Styles a numeric column with single-row Bullet Chart, showing value as bar, target as marker and optional bands behind bar

TypeScript
BulletChartStyle?: BulletChartStyle;
Property Value

BulletChartStyle

ColumnId

Id of Column being styled

TypeScript
ColumnId: string;
Property Value

string

GradientStyle

Styles a numeric column with a Gradient

TypeScript
GradientStyle?: GradientStyle;
Property Value

GradientStyle

IconStyle

Styles a column where each cell displays an icon looked up from a list of key → icon mappings

TypeScript
IconStyle?: IconStyle;
Property Value

IconStyle

Name

Unique Name of Styled Column - used to identify it in Adaptable UI and APIs

TypeScript
Name: string;
Property Value

string

PercentBarStyle

Styles a numeric column so each cell displays a 'Bar'

TypeScript
PercentBarStyle?: PercentBarStyle;
Property Value

PercentBarStyle

RangeBarStyle

Styles a numeric column as Range Bar - track showing where cell value sits between Min and Max

TypeScript
RangeBarStyle?: RangeBarStyle;
Property Value

RangeBarStyle

RatingStyle

Styles a numeric column as a Rating - row of icons filled according to cell value

TypeScript
RatingStyle?: RatingStyle;
Property Value

RatingStyle

RowScope

Which rows will render the Styled Column (data / group / summary total)

TypeScript
RowScope?: RowScope;
Property Value

RowScope

SparklineStyle

Displays a Sparkline Chart in an array column

TypeScript
SparklineStyle?: SparklineStyle;
Property Value

SparklineStyle

IsSuspended

Inherited from SuspendableObject

Suspends (i.e. turns off) an Adaptable Object

TypeScript
IsSuspended?: boolean;
Property Value

boolean

IsReadOnly

Inherited from AdaptableObject

Sets Entity to ReadOnly (overwriting a Strategy Entitlement of 'Full')

TypeScript
IsReadOnly?: boolean;
Property Value

boolean