PercentBarApi

Provides run-time access to Percent Bar function and associated state

TypeScript
export interface PercentBarApi

Methods

MethodDescription
addPercentBar(percentBar)Adds new Percent Bar to Adaptable State
deletePercentBar(columnId)Deletes Percent Bar from Adaptable State
editPercentBar(percentBar)Edits (replaces) existing Percent Bar
editPercentBarShowValue(showValue, columnId)Whether Percent Bar additionally displays cell's value
getAllPercentBar()Retrieves all Percent Bars in Adaptable State
getPercentBarByColumn(columnId)Retrieves Percent Bar for given column
getPercentBarMaxValue(percentBar, node)Gets Maximum Value for a Node to show in Percent Bar
getPercentBarMinValue(percentBar, node)Gets Minimum Value for a Node to show in Percent Bar
getPercentBarState()Retrieves Percent Bar section from Adaptable State
showPercentBarPopup()Opens Percent Bar popup screen

Method Details

addPercentBar

Adds new Percent Bar to Adaptable State

TypeScript
addPercentBar(percentBar: PercentBar): void;
Parameters
ParameterTypeDescription
percentBarPercentBarPercent Bar to add
Returns

void

deletePercentBar

Deletes Percent Bar from Adaptable State

TypeScript
deletePercentBar(columnId: string): void;
Parameters
ParameterTypeDescription
columnIdstringColumn which contains the Percent Bar
Returns

void

editPercentBar

Edits (replaces) existing Percent Bar

TypeScript
editPercentBar(percentBar: PercentBar): void;
Parameters
ParameterTypeDescription
percentBarPercentBarPercent Bar to edit
Returns

void

editPercentBarShowValue

Whether Percent Bar additionally displays cell's value

TypeScript
editPercentBarShowValue(showValue: boolean, columnId: string): void;
Parameters
ParameterTypeDescription
showValuebooleanwhether or not to show the cell's value
columnIdstringColumn which contains the Percent Bar
Returns

void

getAllPercentBar

Retrieves all Percent Bars in Adaptable State

TypeScript
getAllPercentBar(): PercentBar[];
Returns

PercentBar[]

getPercentBarByColumn

Retrieves Percent Bar for given column

TypeScript
getPercentBarByColumn(columnId: string): PercentBar;
Parameters
ParameterTypeDescription
columnIdstringColumn which has the Percent Bar
Returns

PercentBar

getPercentBarMaxValue

Gets Maximum Value for a Node to show in Percent Bar

TypeScript
getPercentBarMaxValue(percentBar: PercentBar, node: any): number;
Parameters
ParameterTypeDescription
percentBarPercentBarPercent Bar to Check
nodeanyThe Current Node
Returns

number

getPercentBarMinValue

Gets Minimum Value for a Node to show in Percent Bar

TypeScript
getPercentBarMinValue(percentBar: PercentBar, node: any): number;
Parameters
ParameterTypeDescription
percentBarPercentBarPercent Bar to Check
nodeanyThe Current Node
Returns

number

getPercentBarState

Retrieves Percent Bar section from Adaptable State

TypeScript
getPercentBarState(): PercentBarState;
Returns

PercentBarState

showPercentBarPopup

Opens Percent Bar popup screen

TypeScript
showPercentBarPopup(): void;
Returns

void