Fdc3AdaptableButton

Button used in FDC3 Action Columns

export interface

Properties

Property Details

buttonStyle

Button's Style; can be object or function that provides ButtonStyle object

buttonStyle?: ButtonStyle | ((button: Fdc3AdaptableButton, context: Fdc3ButtonContext) => ButtonStyle);

Property Value

ButtonStyle| ((button:Fdc3AdaptableButton, context:Fdc3ButtonContext) =>ButtonStyle)

disabled

Function to disable / enable button based on evaluation result

disabled?: (button: Fdc3AdaptableButton, context: Fdc3ButtonContext) => boolean;

Property Value

(button:Fdc3AdaptableButton, context:Fdc3ButtonContext) => boolean

hidden

Function to hide the Button

hidden?: (button: Fdc3AdaptableButton, context: Fdc3ButtonContext) => boolean;

Property Value

(button:Fdc3AdaptableButton, context:Fdc3ButtonContext) => boolean

icon

Button's Icon; can be object or function that provides AdaptableIcon object

icon?: '_defaultFdc3' | AdaptableIcon | ((button: Fdc3AdaptableButton, context: Fdc3ButtonContext) => AdaptableIcon);

Property Value

'_defaultFdc3' |AdaptableIcon| ((button:Fdc3AdaptableButton, context:Fdc3ButtonContext) =>AdaptableIcon)

id

Unique id for the button

id: string;

Property Value

string

label

Button's Label; can be string or function that provides string

label?: '_defaultFdc3' | string | ((button: Fdc3AdaptableButton, context: Fdc3ButtonContext) => string);

Property Value

'_defaultFdc3' | string | ((button:Fdc3AdaptableButton, context:Fdc3ButtonContext) => string)

tooltip

Button's Tooltip; can be string or function that provides string

tooltip?: '_defaultFdc3' | string | ((button: Fdc3AdaptableButton, context: Fdc3ButtonContext) => string);

Property Value

'_defaultFdc3' | string | ((button:Fdc3AdaptableButton, context:Fdc3ButtonContext) => string)