FormatColumnApi

Provides run-time access to the Format Column Module and associated state

TypeScript

export interface

Methods

Method	Returns	Description
addFormatColumn(formatColumn)	`FormatColumn`	Adds a Format Column to Format Column State
addFormatColumns(formatColumns)	`FormatColumn[]`	Adds Format Columns to Format Column State
decrementFormatColumnPrecedence(formatColumn)	`void`	Decrement the precedence of the given FormatColumn
deleteAllFormatColumns()	`void`	Deletes all Format Columns in the State
deleteFormatColumn(formatColumn)	`void`	Deletes an existing Format Column
editFormatColumn(formatColumn)	`FormatColumn`	Edits the Format Column
findFormatColumns(formatColumnLookupCriteria)	`FormatColumn[]`	Find all Flashing Cell Definitions which match the given criteria
getActiveFormatColumns(config)	`FormatColumn[]`	Retrieves all active (not-suspended) Format Columns in Adaptable State
getDisplayFormatForColumn(column, config)	`AdaptableFormat` `\| undefined`	Retrieves the first Format Column's Adaptable Format for a given Column
getFormatColumnByName(name)	`FormatColumn` `\| undefined`	Retrieves a Format Column by its Name
getFormatColumnByUuId(id, config)	`FormatColumn`	Retrieves Format Column by the technical ID (from `FormatColumnState`)
getFormatColumns(config)	`FormatColumn[]`	Retrieves all Format Columns in Adaptable State
getFormatColumnsForColumn(column, config)	`FormatColumn[]`	Gets all FormatColumns which are defined for the given column
getFormatColumnsForColumnId(columnId, config)	`FormatColumn[]`	Gets all FormatColumns which are defined for the column with the given columnId
getFormatColumnState()	`FormatColumnState`	Retrieves Format Column section from Adaptable State
getSuspendedFormatColumns(config)	`FormatColumn[]`	Retrieves all suspended Format Columns in Adaptable State
hasCustomDisplayFormatter(formatColumn)	`boolean`	Checks if a Format Column contains a Custom Display Formatter
incrementFormatColumnPrecedence(formatColumn)	`void`	Increment the precedence of the given FormatColumn
openFormatColumnSettingsPanel()	`void`	Opens Settings Panel with Format Column section selected and visible
suspendAllFormatColumn()	`void`	Suspends all Format Columns
suspendFormatColumn(formatColumn)	`FormatColumn`	Suspends an Format column
unSuspendAllFormatColumn()	`void`	Activates all suspended Format Column
unSuspendFormatColumn(formatColumn)	`FormatColumn`	Suspends an Format column

Method Details

addFormatColumn

Adds a Format Column to Format Column State

TypeScript

addFormatColumn(formatColumn: FormatColumn): FormatColumn;

Parameters

Parameter	Type	Description
formatColumn	`FormatColumn`	Format Column to Add

Returns

FormatColumn

addFormatColumns

Adds Format Columns to Format Column State

TypeScript

addFormatColumns(formatColumns: FormatColumn[]): FormatColumn[];

Parameters

Parameter	Type
formatColumns	`FormatColumn[]`

Returns

FormatColumn[]

decrementFormatColumnPrecedence

Decrement the precedence of the given FormatColumn

TypeScript

decrementFormatColumnPrecedence(formatColumn: FormatColumn): void;

Parameters

Parameter	Type	Description
formatColumn	`FormatColumn`

Returns

void

deleteAllFormatColumns

Deletes all Format Columns in the State

TypeScript

deleteAllFormatColumns(): void;

Returns

void

deleteFormatColumn

Deletes an existing Format Column

TypeScript

deleteFormatColumn(formatColumn: FormatColumn): void;

Parameters

Parameter	Type	Description
formatColumn	`FormatColumn`	The Format Column to delete

Returns

void

editFormatColumn

Edits the Format Column

TypeScript

editFormatColumn(formatColumn: FormatColumn): FormatColumn;

Parameters

Parameter	Type	Description
formatColumn	`FormatColumn`	Format Column to Edit

Returns

FormatColumn

findFormatColumns

Find all Flashing Cell Definitions which match the given criteria

TypeScript

findFormatColumns(formatColumnLookupCriteria: AdaptableObjectLookupCriteria): FormatColumn[];

Parameters

Parameter	Type
formatColumnLookupCriteria	`AdaptableObjectLookupCriteria`

Returns

FormatColumn[]

getActiveFormatColumns

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

TypeScript

getActiveFormatColumns(config?: FormatColumnConfig): FormatColumn[];

Parameters

Parameter	Type
config	`FormatColumnConfig`

Returns

FormatColumn[]

getDisplayFormatForColumn

Retrieves the first Format Column's Adaptable Format for a given Column

TypeScript

getDisplayFormatForColumn(column: AdaptableColumn, config?: FormatColumnConfig): AdaptableFormat | undefined;

Parameters

Parameter	Type	Description
column	`AdaptableColumn`	Column to check
config	`FormatColumnConfig`

Returns

AdaptableFormat | undefined

getFormatColumnByName

Retrieves a Format Column by its Name

TypeScript

getFormatColumnByName(name: string): FormatColumn | undefined;

Parameters

Parameter	Type	Description
name	`string`	Name of the Format Column

Returns

FormatColumn | undefined

getFormatColumnByUuId

Retrieves Format Column by the technical ID (from FormatColumnState)

TypeScript

getFormatColumnByUuId(id: FormatColumn['Uuid'], config?: FormatColumnConfig): FormatColumn;

Parameters

Parameter	Type	Description
id	`FormatColumn['Uuid']`	Format Column id
config	`FormatColumnConfig`

Returns

FormatColumn

getFormatColumns

Retrieves all Format Columns in Adaptable State

TypeScript

getFormatColumns(config?: FormatColumnConfig): FormatColumn[];

Parameters

Parameter	Type
config	`FormatColumnConfig`

Returns

FormatColumn[]

getFormatColumnsForColumn

Gets all FormatColumns which are defined for the given column

TypeScript

getFormatColumnsForColumn(column: AdaptableColumn, config?: FormatColumnConfig): FormatColumn[];

Parameters

Parameter	Type	Description
column	`AdaptableColumn`	The Column for which to retrieve the Format Column
config	`FormatColumnConfig`

Returns

FormatColumn[]

getFormatColumnsForColumnId

Gets all FormatColumns which are defined for the column with the given columnId

TypeScript

getFormatColumnsForColumnId(columnId: string, config?: FormatColumnConfig): FormatColumn[];

Parameters

Parameter	Type	Description
columnId	`string`	ColumnId for which to retrieve the Format Column
config	`FormatColumnConfig`

Returns

FormatColumn[]

getFormatColumnState

Retrieves Format Column section from Adaptable State

TypeScript

getFormatColumnState(): FormatColumnState;

Returns

FormatColumnState

getSuspendedFormatColumns

Retrieves all suspended Format Columns in Adaptable State

TypeScript

getSuspendedFormatColumns(config?: FormatColumnConfig): FormatColumn[];

Parameters

Parameter	Type
config	`FormatColumnConfig`

Returns

FormatColumn[]

hasCustomDisplayFormatter

Checks if a Format Column contains a Custom Display Formatter

TypeScript

hasCustomDisplayFormatter(formatColumn: FormatColumn): boolean;

Parameters

Parameter	Type	Description
formatColumn	`FormatColumn`	Format Column

Returns

boolean

incrementFormatColumnPrecedence

Increment the precedence of the given FormatColumn

TypeScript

incrementFormatColumnPrecedence(formatColumn: FormatColumn): void;

Parameters

Parameter	Type	Description
formatColumn	`FormatColumn`

Returns

void

openFormatColumnSettingsPanel

Opens Settings Panel with Format Column section selected and visible

TypeScript

openFormatColumnSettingsPanel(): void;

Returns

void

suspendAllFormatColumn

Suspends all Format Columns

TypeScript

suspendAllFormatColumn(): void;

Returns

void

suspendFormatColumn

Suspends an Format column

TypeScript

suspendFormatColumn(formatColumn: FormatColumn): FormatColumn;

Parameters

Parameter	Type	Description
formatColumn	`FormatColumn`	The Format Column to suspend

Returns

FormatColumn

unSuspendAllFormatColumn

Activates all suspended Format Column

TypeScript

unSuspendAllFormatColumn(): void;

Returns

void

unSuspendFormatColumn

Suspends an Format column

TypeScript

unSuspendFormatColumn(formatColumn: FormatColumn): FormatColumn;

Parameters

Parameter	Type	Description
formatColumn	`FormatColumn`	The Format Column to suspend

Returns

FormatColumn

PreviousFormatColumn NextFormatColumnConfig