StyledColumnApi

Provides run-time access to Styled Column Module and associated state

TypeScript

export interface

Methods

Method	Returns	Description
addStyledColumn(styledColumn)	`void`	Create a Styled column
canDisplaySparklines()	`boolean`	Can this AdapTable instance display Sparklines (e.g. is AG Grid SparklinesModule installed)
deleteAllStyledColumns()	`void`	Delete all Styled Columns in State
deleteStyledColumn(styledColumn)	`void`	Delete a Styled column
editStyledColumn(styledColumn)	`StyledColumn`	Edits a Styled Column
getActiveStyledColumnForColumn(column)	`StyledColumn` `\| undefined`	Returns a Styled Column for a given column
getActiveStyledColumns(config)	`StyledColumn[]`	Retrieves all active (not-suspended) Styled Columns in Adaptable State
getStyledColumnById(id, config)	`StyledColumn`	Retrieves Styled Column by Id
getStyledColumnByName(name, config)	`StyledColumn` `\| undefined`	Retrieves Styled Column by Name
getStyledColumnForColumnId(columnId, config)	`StyledColumn`	Retrieves Styled Column for given Column Id
getStyledColumns(config)	`StyledColumn[]`	Retrieves all Styled Columns in Adaptable State
getStyledColumnState()	`StyledColumnState`	Retrieves Styled Column section from Adaptable State
getSuspendedStyledColumns(config)	`StyledColumn[]`	Retrieves all suspended Styled Columns in Adaptable State
hasBulletChartStyle(columnId)	`boolean`	Checks whether Column with given `columnId` has a Bullet Chart Style applied
hasGradientStyle(columnId)	`boolean`	Checks whether Column with given `columnId` has a Gradient Style applied
hasPercentBarStyle(columnId)	`boolean`	Checks whether Column with given `columnId` has a PercentBar Style applied
hasRatingStyle(columnId)	`boolean`	Checks whether Column with given `columnId` has a Rating Style applied
isSparklineStyleStyledColumn(column)	`boolean`	Checks whether Column is a Sparkline Column
openStyledColumnSettingsPanel()	`void`	Open Styled Column section of Settings Panel
renderSparkline(options)	`AgChartInstance<AgSparklineOptions> \| null`	Renders a standalone Sparkline into a DOM element you provide, using the same AG Charts engine as Sparkline Styled Columns.
suspendAllStyledColumn()	`void`	Suspends all Styled Columns
suspendStyledColumn(styledColumn)	`void`	Suspends an active Styled Column
unSuspendAllStyledColumn()	`void`	Activates all suspended Styled Column
unSuspendStyledColumn(styledColumn)	`void`	Activates a suspended Styled Column

Method Details

addStyledColumn

Create a Styled column

TypeScript

addStyledColumn(styledColumn: StyledColumn): void;

Parameters

Parameter	Type	Description
styledColumn	`StyledColumn`

Returns

void

canDisplaySparklines

Can this AdapTable instance display Sparklines (e.g. is AG Grid SparklinesModule installed)

TypeScript

canDisplaySparklines(): boolean;

Returns

boolean

deleteAllStyledColumns

Delete all Styled Columns in State

TypeScript

deleteAllStyledColumns(): void;

Returns

void

deleteStyledColumn

Delete a Styled column

TypeScript

deleteStyledColumn(styledColumn: StyledColumn): void;

Parameters

Parameter	Type	Description
styledColumn	`StyledColumn`

Returns

void

editStyledColumn

Edits a Styled Column

TypeScript

editStyledColumn(styledColumn: StyledColumn): StyledColumn;

Parameters

Parameter	Type	Description
styledColumn	`StyledColumn`	Styled Column to edit

Returns

StyledColumn

getActiveStyledColumnForColumn

Returns a Styled Column for a given column

TypeScript

getActiveStyledColumnForColumn(column: AdaptableColumn): StyledColumn | undefined;

Parameters

Parameter	Type	Description
column	`AdaptableColumn`	Column to check

Returns

StyledColumn | undefined

getActiveStyledColumns

Retrieves all active (not-suspended) Styled Columns in Adaptable State

TypeScript

getActiveStyledColumns(config?: LayoutExtendedConfig): StyledColumn[];

Parameters

Parameter	Type
config	`LayoutExtendedConfig`

Returns

StyledColumn[]

getStyledColumnById

Retrieves Styled Column by Id

TypeScript

getStyledColumnById(id: StyledColumn['Uuid'], config?: LayoutExtendedConfig): StyledColumn;

Parameters

Parameter	Type	Description
id	`StyledColumn['Uuid']`	Styled Column id
config	`LayoutExtendedConfig`

Returns

StyledColumn

getStyledColumnByName

Retrieves Styled Column by Name

TypeScript

getStyledColumnByName(name: StyledColumn['Name'], config?: LayoutExtendedConfig): StyledColumn | undefined;

Parameters

Parameter	Type	Description
name	`StyledColumn['Name']`	Styled Column name
config	`LayoutExtendedConfig`

Returns

StyledColumn | undefined

getStyledColumnForColumnId

Retrieves Styled Column for given Column Id

TypeScript

getStyledColumnForColumnId(columnId: StyledColumn['ColumnId'], config?: LayoutExtendedConfig): StyledColumn;

Parameters

Parameter	Type	Description
columnId	`StyledColumn['ColumnId']`	Styled Column id
config	`LayoutExtendedConfig`

Returns

StyledColumn

getStyledColumns

Retrieves all Styled Columns in Adaptable State

TypeScript

getStyledColumns(config?: LayoutExtendedConfig): StyledColumn[];

Parameters

Parameter	Type
config	`LayoutExtendedConfig`

Returns

StyledColumn[]

getStyledColumnState

Retrieves Styled Column section from Adaptable State

TypeScript

getStyledColumnState(): StyledColumnState;

Returns

StyledColumnState

getSuspendedStyledColumns

Retrieves all suspended Styled Columns in Adaptable State

TypeScript

getSuspendedStyledColumns(config?: LayoutExtendedConfig): StyledColumn[];

Parameters

Parameter	Type
config	`LayoutExtendedConfig`

Returns

StyledColumn[]

hasBulletChartStyle

Checks whether Column with given columnId has a Bullet Chart Style applied

TypeScript

hasBulletChartStyle(columnId: string): boolean;

Parameters

Parameter	Type	Description
columnId	`string`	column ID

Returns

boolean

hasGradientStyle

Checks whether Column with given columnId has a Gradient Style applied

TypeScript

hasGradientStyle(columnId: string): boolean;

Parameters

Parameter	Type	Description
columnId	`string`	column ID

Returns

boolean

hasPercentBarStyle

Checks whether Column with given columnId has a PercentBar Style applied

TypeScript

hasPercentBarStyle(columnId: string): boolean;

Parameters

Parameter	Type	Description
columnId	`string`	column ID

Returns

boolean

hasRatingStyle

Checks whether Column with given columnId has a Rating Style applied

TypeScript

hasRatingStyle(columnId: string): boolean;

Parameters

Parameter	Type	Description
columnId	`string`	column ID

Returns

boolean

isSparklineStyleStyledColumn

Checks whether Column is a Sparkline Column

TypeScript

isSparklineStyleStyledColumn(column: AdaptableColumn): boolean;

Parameters

Parameter	Type
column	`AdaptableColumn`

Returns

boolean

openStyledColumnSettingsPanel

Open Styled Column section of Settings Panel

TypeScript

openStyledColumnSettingsPanel(): void;

Returns

void

renderSparkline

Renders a standalone Sparkline 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 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.

TypeScript

renderSparkline(options: AgSparklineOptions): AgChartInstance<AgSparklineOptions> | null;

Parameters

Parameter	Type
options	`AgSparklineOptions`

Returns

AgChartInstance<AgSparklineOptions> | null

suspendAllStyledColumn

Suspends all Styled Columns

TypeScript

suspendAllStyledColumn(): void;

Returns

void

suspendStyledColumn

Suspends an active Styled Column

TypeScript

suspendStyledColumn(styledColumn: StyledColumn): void;

Parameters

Parameter	Type	Description
styledColumn	`StyledColumn`

Returns

void

unSuspendAllStyledColumn

Activates all suspended Styled Column

TypeScript

unSuspendAllStyledColumn(): void;

Returns

void

unSuspendStyledColumn

Activates a suspended Styled Column

TypeScript

unSuspendStyledColumn(styledColumn: StyledColumn): void;

Parameters

Parameter	Type	Description
styledColumn	`StyledColumn`

Returns

void

PreviousStyledColumn NextStyledColumnState