Options
All
  • Public
  • Public/Protected
  • All
Menu

Hierarchy

Index

Properties

Optional AvailableToolPanels

AvailableToolPanels: AdaptableToolPanels

Which of the ToolPanels should be available to the User to choose to select.

The Current ToolPanels that Adaptable offers are:

  • AdvancedSearch
  • Alert
  • BulkUpdate
  • CellSummary
  • Chart (if using Charting Plugin)
  • ColumnFilter
  • Dashboard
  • Export
  • Layout
  • QuickSearch
  • SmartEdit
  • SystemStatus
  • Theme

Only those ToolPanels listed here will be selectable

If you don't provide any value for this property, then ALL Adaptable ToolPanels will be available.

Default Value: Empty array

Optional Revision

Revision: number

The 'version' number of the Item.

Used for when developers want to update one section in Predefined Config while keeping others unchanged.

If the Revision number in Predefined Config is greater than the one stored in the User's state, then the section in Predefined Config will be used, and will replace the State.

If the Revision number in Predefined Config is not greater than the one stored in the User's state, then it is ignored as its already been passed into the User's state (and potentially superseded).

See Adaptable State Guide for more information.

Note: This is the only property in ConfigState - the base class for all Adaptable State objects.

Optional ShowColumnsDropdown

ShowColumnsDropdown: boolean

Whether to show the Columns dropdown in the Adaptable ToolPanel.

If 'true' then the dropdown will be visible as the penultimate item.

Clicking the button will open a dropdown listing all the Columns in your grid. You can click the checkbox to show / hide the column.

Note: if you want to move Columns in your Grid then you need to use the Column Chooser Function.

Default Value: true

Optional ShowFunctionsDropdown

ShowFunctionsDropdown: boolean

Whether to show the Home dropdown in the Adaptable ToolPanel.

If 'true' then the dropdown will be visible as the first item (with a 'house' icon).

Clicking the button will open a dropdown listing all the Functions that your Entitlements allows.

Selecting a menu item in the dropdown will open the popup for that Function.

Default Value: true

Optional ShowToolPanelsDropdown

ShowToolPanelsDropdown: boolean

Whether to show the ToolPanels dropdown in the Adaptable ToolPanel.

If 'true' then the dropdown will be visible as the last item.

Clicking the button will open a dropdown listing all the ToolPanels available (see the AvailableToolPanels property). You can click the checkbox to show / hide the ToolPanel.

Note: if you want to move / reposition the ToolPanels in the Adaptable ToolPanel then you need to open the ToolPanel Configuration popup (via the configure button).

Default Value: true

Optional VisibleButtons

VisibleButtons: AdaptableFunctionButtons

Which Function Buttons should be visible in the Adaptable ToolPanel when your application first loads.

Each button is connected to a Function in Adaptable and opens the relevant popup screen.

Default Value: [Empty Array]

Optional VisibleToolPanels

VisibleToolPanels: AdaptableToolPanels

Which ToolPanels should be visible in the Adaptable ToolPanel when your application first loads.

Note: If the AvailableToolPanels property has been set, then the visible toolbars listed here must also be included there.

Default Value: All ToolPanels

Generated using TypeDoc