Options
All
  • Public
  • Public/Protected
  • All
Menu

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 support@adaptabletools.com

The Blotter API consists of over 35 properties.

Eeach 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)

Hierarchy

  • IBlotterApi

Implemented by

Index

Properties

actionColumnApi

actionColumnApi: IActionColumnApi

Provides access to the Advanced Search function, the ActionColumn object.

advancedSearchApi

advancedSearchApi: IAdvancedSearchApi

Provides access to the Advanced Search function, the AdvancedSearch object and Advanced Search State.

alertApi

alertApi: IAlertApi

Provides access to the Alert function (enabling the displyaing of Alerts) and Alerrt State.

auditEventApi

auditEventApi: IAuditEventApi

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.

bulkUpdateApi

bulkUpdateApi: IBulkUpdateApi

Provides access to the Bulk Update function and Bulk Update State.

calculatedColumnApi

calculatedColumnApi: ICalculatedColumnApi

Provides access to the Calculated Column function (enabling the creation of Calculated Columns) and Calculated Column State.

calendarApi

calendarApi: ICalendarApi

Provides access to the Calendar function and Calendar State.

cellSummaryApi

cellSummaryApi: ICellSummaryApi

Provides access to the Cell Summary function and Cell Summary State.

cellValidationApi

cellValidationApi: ICellValidationApi

Provides access to the Cell Validation function, the CellValidation object and Cell Validation State.

chartApi

chartApi: IChartApi

Provides access to the Chart function, the various Chart Definition objects and Chart State.

columnCategoryApi

columnCategoryApi: IColumnCategoryApi

Provides access to the Column Caategory function, the Column Category object and Column Category State.

columnFilterApi

columnFilterApi: IColumnFilterApi

Provides access to the Column Filter function, the Column Filter object and Column Filter State.

conditionalStyleApi

conditionalStyleApi: IConditionalStyleApi

Provides access to the Conditional Style function, the Conditional Style object and Conditional Style State.

configApi

configApi: IConfigApi

Methods that give access to the Predefined Config, State and Store.

customSortApi

customSortApi: ICustomSortApi

Provides access to the Custom Sort function, the Custom Sort object and Custom Sort State.

dashboardApi

dashboardApi: IDashboardApi

Provides access to the Dashboard function, and Dashboard State.

dataSourceApi

dataSourceApi: IDataSourceApi

Provides access to the Data Source function, the Data Source object and Data Source State.

entitlementApi

entitlementApi: IEntitlementApi

Provides methods to manager User Entitlements (or Permissions)

eventApi

eventApi: IEventApi

The Api used for listenning / subscribing to the various Events fired / published by the Adaptable Blotter e.g. the SearchChanged event.

exportApi

exportApi: IExportApi

Provides access to the Export function, the Report object and Export State.

flashingCellApi

flashingCellApi: IFlashingCellApi

Provides access to the Flashing Cell function, the Flashing Cell object and Flashing Cell State.

formatColumnApi

formatColumnApi: IFormatColumnApi

Provides access to the Format Column function, the Format Column object and Format Column State.

freeTextColumnApi

freeTextColumnApi: IFreeTextColumnApi

Provides access to the FreeText Column function, the FreeText Column object and FreeText Column State.

gridApi

gridApi: IGridApi

Provides methods for managing the Grid directly e.g. setGridData which will replace the current DataSource with the one provided.

internalApi

internalApi: IInternalApi

API methods used internally within the Adaptable Blotter.

It is not recommended to use this section if using the Adaptable Blotter externally

layoutApi

layoutApi: ILayoutApi

Provides access to the Layout function, the Layout object and Layout State.

namedFilterApi

namedFilterApi: INamedFilterApi

percentBarApi

percentBarApi: IPercentBarApi

Provides access to the Percent Bar function, the Percent Bar object and Percent Bar State.

plusMinusApi

plusMinusApi: IPlusMinusApi

Provides access to the Plus Minus function, the Plus Minus object and Plus Minus State.

quickSearchApi

quickSearchApi: IQuickSearchApi

Provides access to the Quick Search function, the Quick Search object and Quick Search State.

reminderApi

reminderApi: IReminderApi

Provides access to the Reminder function, the Reminder object and Reminder State.

shortcutApi

shortcutApi: IShortcutApi

Provides access to the Shortcut function, the Shortcut object and Shortcut State.

smartEditApi

smartEditApi: ISmartEditApi

Provides access to the Layout function, the Layout object and Layout State.

systemFilterApi

systemFilterApi: ISystemFilterApi

Provides access to System Filter State that manages the Filters that the Adaptable Blotter ships with.

systemStatusApi

systemStatusApi: ISystemStatusApi

Api methods related to the System Status button (shown in the Home Toolbar) that displays information about the health of the application.

themeApi

themeApi: IThemeApi

Api methods related to Theme management and Theme State.

userFilterApi

userFilterApi: IUserFilterApi

Provides access to the User Filter function, the User Filter object and User Filter State.

userInterfaceApi

userInterfaceApi: IUserInterfaceApi

Provides access to User Interface State which allows you to set up colours, permitted values etc.

Generated using TypeDoc