AdapTable Types Reference

AdaptableButton

Defines a Button that appears in numerous places including Adaptable Form

TypeScript
export interface AdaptableButton<CONTEXT_TYPE extends BaseContext> extends
Extends

Identifiable

Properties

PropertyDescription
buttonStyleStyle for Button - can be object or function that provides a ButtonStyle object
disabledFunction that disables / enables the button based on its evaluation result
hiddenFunction which sets whether Button is hidden
iconIcon for Button - can be object or function that provides a AdaptableIcon object
labelLabel for Button - can be string or function that provides string
onClickFunction to invoke when button is clicked
tooltipTooltip for Button - can be string or function that provides string

Property Details

buttonStyle

Style for Button - can be object or function that provides a ButtonStyle object

TypeScript
buttonStyle?: ButtonStyle | ((button: AdaptableButton<CONTEXT_TYPE>, context: CONTEXT_TYPE) => ButtonStyle);
Property Value

ButtonStyle| ((button:AdaptableButton<CONTEXT_TYPE>, context: CONTEXT_TYPE) =>ButtonStyle)

disabled

Function that disables / enables the button based on its evaluation result

TypeScript
disabled?: (button: AdaptableButton<CONTEXT_TYPE>, context: CONTEXT_TYPE) => boolean;
Property Value

(button:AdaptableButton<CONTEXT_TYPE>, context: CONTEXT_TYPE) => boolean

hidden

Function which sets whether Button is hidden

TypeScript
hidden?: (button: AdaptableButton<CONTEXT_TYPE>, context: CONTEXT_TYPE) => boolean;
Property Value

(button:AdaptableButton<CONTEXT_TYPE>, context: CONTEXT_TYPE) => boolean

icon

Icon for Button - can be object or function that provides a AdaptableIcon object

TypeScript
icon?: AdaptableIcon | ((button: AdaptableButton<CONTEXT_TYPE>, context: CONTEXT_TYPE) => AdaptableIcon);
Property Value

AdaptableIcon| ((button:AdaptableButton<CONTEXT_TYPE>, context: CONTEXT_TYPE) =>AdaptableIcon)

label

Label for Button - can be string or function that provides string

TypeScript
label?: string | ((button: AdaptableButton<CONTEXT_TYPE>, context: CONTEXT_TYPE) => string);
Property Value

string | ((button:AdaptableButton<CONTEXT_TYPE>, context: CONTEXT_TYPE) => string)

onClick

Function to invoke when button is clicked

TypeScript
onClick?: (button: AdaptableButton<CONTEXT_TYPE>, context: CONTEXT_TYPE) => void;
Property Value

(button:AdaptableButton<CONTEXT_TYPE>, context: CONTEXT_TYPE) => void

tooltip

Tooltip for Button - can be string or function that provides string

TypeScript
tooltip?: string | ((button: AdaptableButton<CONTEXT_TYPE>, context: CONTEXT_TYPE) => string);
Property Value

string | ((button:AdaptableButton<CONTEXT_TYPE>, context: CONTEXT_TYPE) => string)

PreviousAdaptableBooleanQueryNextAdaptableCalculatedColumnQuery