Initial State Reference
Summary
- AdapTable instances can be pre-populated at Design Time with Initial Adaptable State
- These are the objects that Users require for first time use
- When Adaptable loads, the Initial State is saved into Adaptable State
Developers are able to populate each new AdapTable instance with Initial Adaptable State.
This means that when end-users open the new application for the first time, they won't simply see a clean AG Grid instance but, rather, one pre-loaded with Filters, Styles, Edit Rules, Reports etc.
Find Out More
- See Providing Initial AdapTable State for more details
- Consult the Adaptable State Guide for details on how to load and persist AdapTable State
These are the available sections in Initial State:
| Property | Description | Details |
|---|---|---|
| Alert | Defines Alerts when important things happen | Details |
| Application | Empty state section for Devs to store own data with rest of state | Details |
| Calculated Column | Columns that display value (based on an Expression) | Details |
| Charting | Named Charts (wrapping Chart models) | Details |
| Custom Sort | Sort columns in non-standard (e.g. non alphabetical) ways | Details |
| Dashboard | Gives devs control over look & feel of Dashboard (above grid) | Details |
| Export | Collection of Custom Reports to export as needed | Details |
| Flashing Cell | Definitions of which cells flash in response to data changes | Details |
| Format Column | Objects that style a column either fully or using a Condition | Details |
| Freetext Column | Bespoke columns that get stored in state for users' notes | Details |
| Layout | Named sets of column props (visibility, order, grouping, sorts etc) | Details |
| Named Query | Queries available for use across multiple AdapTable Modules | Details |
| Notes | Collection of personal Notes that are edited at Cell level | Details |
| Plus Minus | Rules regarding result of user clicking '+' or '-' in numeric cell | Details |
| Quick Search | Configues matching cell styles, and whether to filter also | Details |
| Schedule | Schedules for Reports and Reminders | Details |
| Shortcut | Collection of objects to encourage fast and safe data entry | Details |
| Status Bar | Configures Adaptable components in AG Grid Status Bar | Details |
| Styled Column | Collection of Badges, Gradient Columns, Percent Bars & Sparklines | Details |
| Theme | Specifies current Theme and lists Custom themes | Details |
| Tool Panel | Order & visibility of AdapTable Tool Panel controls (side of grid) | Details |
| User Interface | Sets visibility of all AdapTable's UI elements | Details |
Find Out More
See the Types Section for the full definition of the initialState object