Summary
- Action Column Options is used to define Action Columns
- The Action Column API provides run-time access to Action Columns
Action Column Options
The Action Column Options section of Adaptable Options is used to configure Action Columns.
| Property | Description | Default |
|---|
| actionColumns | Columns which contain an AdapTable Button - used for performing Actions | undefined |
Action Column
| Property | Description |
|---|
| actionColumnButton | Button (or list of buttons) to display in the Column |
| actionColumnSettings | Optional properties to configure the Column (e.g. filterable, resizable) |
| columnId | Mandatory 'Id'; if no value set for FriendlyName, this will also be Column name |
| friendlyName | How Column appears in Column Header, Menus; if no value set, ColumnId is used |
| rowScope | Which types of Rows should contain buttons (i.e. data, grouped, summary) |
Action Column Settings
The Action Column Settings object provides configuration properties:
| Property | Description | Default |
|---|
| resizable | Whether Column can be resized (by dragging column header edges) | true |
| suppressMenu | Whether no menu should be shown for this Column header. | false |
| suppressMovable | Whether if this Column should be movable via dragging | false |
| width | Preferred width (in pixels) for Column; if unset, calculated dynamically by AG Grid | |
The button in the Action extends the Adaptable Button defined as follows:
| Property | Description |
|---|
| buttonStyle | Style for Button - can be object or function that provides a ButtonStyle object |
| disabled | Function that disables / enables the button based on its evaluation result |
| hidden | Function which sets whether Button is hidden |
| icon | Icon for Button - can be object or function that provides a AdaptableIcon object |
| label | Label for Button - can be string or function that provides string |
| onClick | Function to invoke when button is clicked |
| tooltip | Tooltip for Button - can be string or function that provides string |
But it also contains a command property useful for wiring up Action Column Commands
| Property | Description |
|---|
| command | Command to assign to Action Column Button that displays a Row Form |
| adaptableContext | Custom application Context provided in AdaptableOptions.adaptableContext |
Action Column API
The Action Column API section of Adaptable API provides programmatic access to Action Columns: