AdapTable Version:

Framework:

FlashingCellApi

Provides run-time access to Flashing Cell functionality and associated State

TypeScript

export interface

Methods

Method	Description
addFlashingCellDefinition(flashingCellDefinition)	Adds a Flashing Cell Definition to State
addFlashingCellDefinitions(flashingCellDefinitions)	Adds provided Flashing Cell Definitions
clearAllFlashingCells()	Clears all Cells and Rows which have been flashed (primarily used if duration is 'Always')
deleteFlashingCellDefinition(flashingCellDefinition)	Deletes a Flashing Cell
editFlashingCellDefinition(flashingCellDefinition)	Edits Flashing Cell Definition in State with given one
editFlashingCellDefinitions(flashingCellDefinitions)	Edits provided Flashing Cell Definitions
findFlashingCellDefinitions(flashingCellLookupCriteria)	Find all Flashing Cell Definitions which match the given criteria
getActiveFlashingCellDefinitions(config)	Retrieves all active (non-suspended) cell Definitions in Flashing Cell State
getFlashingCellDefinitionById(id, config)	Retrieves Flashing Cell Definition by the technical ID (from `FlashingCellState`)
getFlashingCellDefinitionByName(name)	Retrieves a Flashing Cell Definition by its Name
getFlashingCellDefinitions(config)	Retrieves all Flashing Cell Definitions in Flashing Cell State
getFlashingCellFlashTarget(flashingCellDefinition)	Returns `FlashTarget` of the given Flashing Cell Definition
getFlashingCellPredicateDefsForScope(scope)	Retrieves all Predicate Defs that match given Scope
getFlashingCellState()	Retrieves Flashing Cell section from Adaptable State
getSuspendedFlashingCellDefinitions(config)	Retrieves all suspended Cell Definitions in Flashing Cell State
isAnyFlashingCellActive()	Is there any cells/rows currently being flashed
setFlashingCellDefinitions(flashingCellDefinitions)	Sets a collection of Flashing Cell Definitions into State
showFlashingCell(flashingCellToShow)	Evaluates the given Flashing Cell Definition and flashes the correspondent cells/rows
suspendAllFlashingCellDefinition()	Suspends all FlashingCell Definitions
suspendFlashingCellDefinition(flashingCellDefinition)	Suspends a Flashing Cell Definition
unSuspendAllFlashingCellDefinition()	Activates all suspended Flashing Cell Definition
unSuspendFlashingCellDefinition(flashingCellDefinition)	Activates a suspended Flashing Cell Definition

Method Details

addFlashingCellDefinition

Adds a Flashing Cell Definition to State

TypeScript

addFlashingCellDefinition(flashingCellDefinition: FlashingCellDefinition): FlashingCellDefinition;

Parameters

Parameter	Type	Description
flashingCellDefinition	`FlashingCellDefinition`	Flashing Cell Definition to Add

Returns

FlashingCellDefinition

addFlashingCellDefinitions

Adds provided Flashing Cell Definitions

TypeScript

addFlashingCellDefinitions(flashingCellDefinitions: FlashingCellDefinition[]): FlashingCellDefinition[];

Parameters

Parameter	Type	Description
flashingCellDefinitions	`FlashingCellDefinition[]`	Flashing Cell Definition to Add

Returns

FlashingCellDefinition[]

clearAllFlashingCells

Clears all Cells and Rows which have been flashed (primarily used if duration is 'Always')

TypeScript

clearAllFlashingCells(): void;

Returns

void

deleteFlashingCellDefinition

Deletes a Flashing Cell

TypeScript

deleteFlashingCellDefinition(flashingCellDefinition: FlashingCellDefinition): void;

Parameters

Parameter	Type	Description
flashingCellDefinition	`FlashingCellDefinition`	flashing cell to delete

Returns

void

editFlashingCellDefinition

Edits Flashing Cell Definition in State with given one

TypeScript

editFlashingCellDefinition(flashingCellDefinition: FlashingCellDefinition): FlashingCellDefinition;

Parameters

Parameter	Type	Description
flashingCellDefinition	`FlashingCellDefinition`	Flashing Cell Definition to Edit

Returns

FlashingCellDefinition

editFlashingCellDefinitions

Edits provided Flashing Cell Definitions

TypeScript

editFlashingCellDefinitions(flashingCellDefinitions: FlashingCellDefinition[]): FlashingCellDefinition[];

Parameters

Parameter	Type	Description
flashingCellDefinitions	`FlashingCellDefinition[]`	Flashing Cell Definitions to Edit

Returns

FlashingCellDefinition[]

findFlashingCellDefinitions

Find all Flashing Cell Definitions which match the given criteria

TypeScript

findFlashingCellDefinitions(flashingCellLookupCriteria: AdaptableObjectLookupCriteria): FlashingCellDefinition[];

Parameters

Parameter	Type	Description
flashingCellLookupCriteria	`AdaptableObjectLookupCriteria`	lookup criteria

Returns

FlashingCellDefinition[]

getActiveFlashingCellDefinitions

Retrieves all active (non-suspended) cell Definitions in Flashing Cell State

TypeScript

getActiveFlashingCellDefinitions(config?: LayoutExtendedConfig): FlashingCellDefinition[];

Parameters

Parameter	Type
config	`LayoutExtendedConfig`

Returns

FlashingCellDefinition[]

getFlashingCellDefinitionById

Retrieves Flashing Cell Definition by the technical ID (from FlashingCellState)

TypeScript

getFlashingCellDefinitionById(id: FlashingCellDefinition['Uuid'], config?: LayoutExtendedConfig): FlashingCellDefinition;

Parameters

Parameter	Type	Description
id	`FlashingCellDefinition['Uuid']`	Flashing Cell Definition Id
config	`LayoutExtendedConfig`

Returns

FlashingCellDefinition

getFlashingCellDefinitionByName

Retrieves a Flashing Cell Definition by its Name

TypeScript

getFlashingCellDefinitionByName(name: string): FlashingCellDefinition | undefined;

Parameters

Parameter	Type	Description
name	`string`	Name of the Flashing Cell Definition

Returns

FlashingCellDefinition | undefined

getFlashingCellDefinitions

Retrieves all Flashing Cell Definitions in Flashing Cell State

TypeScript

getFlashingCellDefinitions(config?: LayoutExtendedConfig): FlashingCellDefinition[];

Parameters

Parameter	Type
config	`LayoutExtendedConfig`

Returns

FlashingCellDefinition[]

getFlashingCellFlashTarget

Returns FlashTarget of the given Flashing Cell Definition

TypeScript

getFlashingCellFlashTarget(flashingCellDefinition: FlashingCellDefinition): FlashingCellDefinition['FlashTarget'];

Parameters

Parameter	Type	Description
flashingCellDefinition	`FlashingCellDefinition`	Flashing Cell Definition to check

Returns

FlashingCellDefinition['FlashTarget']

getFlashingCellPredicateDefsForScope

Retrieves all Predicate Defs that match given Scope

TypeScript

getFlashingCellPredicateDefsForScope(scope: ColumnScope): AdaptablePredicateDef[];

Parameters

Parameter	Type	Description
scope	`ColumnScope`	the Scope to check

Returns

AdaptablePredicateDef[]

getFlashingCellState

Retrieves Flashing Cell section from Adaptable State

TypeScript

getFlashingCellState(): FlashingCellState;

Returns

FlashingCellState

getSuspendedFlashingCellDefinitions

Retrieves all suspended Cell Definitions in Flashing Cell State

TypeScript

getSuspendedFlashingCellDefinitions(config?: LayoutExtendedConfig): FlashingCellDefinition[];

Parameters

Parameter	Type
config	`LayoutExtendedConfig`

Returns

FlashingCellDefinition[]

isAnyFlashingCellActive

Is there any cells/rows currently being flashed

TypeScript

isAnyFlashingCellActive(): boolean;

Returns

boolean

setFlashingCellDefinitions

Sets a collection of Flashing Cell Definitions into State

TypeScript

setFlashingCellDefinitions(flashingCellDefinitions: FlashingCellDefinition[]): void;

Parameters

Parameter	Type	Description
flashingCellDefinitions	`FlashingCellDefinition[]`	Flashing Cell Definitions to Add to State

Returns

void

showFlashingCell

Evaluates the given Flashing Cell Definition and flashes the correspondent cells/rows

TypeScript

showFlashingCell(flashingCellToShow: AdaptableFlashingCell): void;

Parameters

Parameter	Type	Description
flashingCellToShow	`AdaptableFlashingCell`	Flashing Cell Definition to show

Returns

void

suspendAllFlashingCellDefinition

Suspends all FlashingCell Definitions

TypeScript

suspendAllFlashingCellDefinition(): void;

Returns

void

suspendFlashingCellDefinition

Suspends a Flashing Cell Definition

TypeScript

suspendFlashingCellDefinition(flashingCellDefinition: FlashingCellDefinition): FlashingCellDefinition;

Parameters

Parameter	Type	Description
flashingCellDefinition	`FlashingCellDefinition`	Flashing Cell Definition to Suspend

Returns

FlashingCellDefinition

unSuspendAllFlashingCellDefinition

Activates all suspended Flashing Cell Definition

TypeScript

unSuspendAllFlashingCellDefinition(): void;

Returns

void

unSuspendFlashingCellDefinition

Activates a suspended Flashing Cell Definition

TypeScript

unSuspendFlashingCellDefinition(flashingCellDefinition: FlashingCellDefinition): FlashingCellDefinition;

Parameters

Parameter	Type	Description
flashingCellDefinition	`FlashingCellDefinition`	Flashing Cell Definition to Un-Suspend (activate)

Returns

FlashingCellDefinition

PreviousFilterOptions NextFlashingCellDefinition