The Blotter API (which implements the IBlotterAPI interface) provides developers with run-time access to the Adaptable Blotter.
It attempts to offer ALL the functionality provided by the Adaptable Blotter UI in code form.
This enables developers to access the Adaptable Blotter Store at a run-time in a 'safe' way.
It also allows them to access all the functionality in the Adaptable Blotter while bypassing the UI screens altogether if they so wish.
Note to Adaptable Blotter users: If there is a method missing that you would like implemented please contact firstname.lastname@example.org
The Blotter API consists of over 35 properties.
Each of these properties is a class that contains a set of API method grouped either by Adaptable Blotter Function (e.g. AdvancedSearchAPI) or type (e.g. AuditEventApi)
Provides access to the Action Column functionality, the ActionColumn object.
Provides access to the Advanced Search function, the AdvancedSearch object and Advanced Search State.
Provides access to the Alert function (enabling the displyaing of Alerts) and Alerrt State.
Publishes the 3 Audit Events - onAuditStateChanged, onAuditCellEdited and onAuditFunctionApplied
These Events are fired through Audit Log when the auditAsEvent property for any of these properties is set to true.
Provides access to the Bulk Update function and Bulk Update State.
Provides access to the Calculated Column function (enabling the creation of Calculated Columns) and Calculated Column State.
Provides access to the Calendar function and Calendar State.
Provides access to the Cell Summary function and Cell Summary State.
Provides access to the Cell Validation function, the CellValidation object and Cell Validation State.
Provides access to the Chart function, the various Chart Definition objects and Chart State.
Provides access to the Column Caategory function, the Column Category object and Column Category State.
Provides access to the Column Caategory function.
Provides access to the Column Filter function, the Column Filter object and Column Filter State.
Provides access to the Conditional Style function, the Conditional Style object and Conditional Style State.
Methods that give access to the Predefined Config, State and Store.
Provides access to the Custom Sort function, the Custom Sort object and Custom Sort State.
Provides access to the Dashboard function, and Dashboard State.
Provides access to the Data Source function, the Data Source object and Data Source State.
Provides methods to manager User Entitlements (or Permissions)
The Api used for listenning / subscribing to the various Events fired / published by the Adaptable Blotter e.g. the SearchChanged event.
Provides access to the Export function, the Report object and Export State.
Provides access to the Flashing Cell function, the Flashing Cell object and Flashing Cell State.
Provides access to the Format Column function, the Format Column object and Format Column State.
Provides access to the FreeText Column function, the FreeText Column object and FreeText Column State.
Provides methods for managing the Grid directly e.g. setGridData which will replace the current DataSource with the one provided.
API methods used internally within the Adaptable Blotter.
It is not recommended to use this section if using the Adaptable Blotter externally
Enables developers to set up configuration when using our Partner tools (like iPushPull and Glue42)
Provides access to the Percent Bar function, the Percent Bar object and Percent Bar State.
Provides access to the Plus Minus function, the Plus Minus object and Plus Minus State.
Provides access to the Quick Search function, the Quick Search object and Quick Search State.
Provides access to the Reminder function, the Reminder object and Reminder State.
Provides access to the Shortcut function, the Shortcut object and Shortcut State.
Provides access to the Sparkline Column functionality
Provides access to System Filter State that manages the Filters that the Adaptable Blotter ships with.
Api methods related to the System Status button (shown in the Home Toolbar) that displays information about the health of the application.
Api methods related to Theme management and Theme State.
Provides access to the User Filter function, the User Filter object and User Filter State.
Provides access to User Interface State which allows you to set up colours, permitted values etc.
Generated using TypeDoc