Options
All
  • Public
  • Public/Protected
  • All
Menu

The AdaptableApi provides developers with run-time access to AdapTable.

It offers ALL the functionality provided by the AdapTable UI through code.

This enables developers to access the AdapTable Store, and all AdapTable functionality, at run-time in a 'safe' way.

It also allows them to bypass the UI screens altogether if they so wish.

The AdaptableApiApi is essentially just a wrapper around the AdapTable Store but provides additional error-checking, logging, and auditing. And it also ensures that the immutable "purity" of the store is maintained.

Note to AdapTable users: If there is a method missing from AdaptableApi that you would like implemented, please contact support@adaptabletools.com and we will add it

Accessing the AdaptableApi

The AdaptableApi is the only object returned by the AdapTable static constructor.

If you are using one of the Framework Wrappers then the AdaptableApi is available to you through the AdaptableReady event.

Api functions

AdaptableApi consists of over 50 sets of properties.

Most of these properties are each a class that contains a set of Api methods grouped either by AdapTable Function (e.g. ConditionalStyleApi) or type (e.g. AuditEventApi)

In addition there are a few api classes designed primarily for internal use which deal with how AdapTable itself works (e.g. gridApi, columnApi, gridApi)

Function-Related Api classes

Api Class Details
actionColumnApi Manages Action Columns which contain buttons with bespoke click logic
alertApi Adaptable Alerts provide bespoke notifications and messages
applicationApi Use Application Data Entries to manage custom state and data
auditEventApi Listen to the Audit Events published by the Audit Log
bulkUpdateApi Run Bulk Update so mutliple selected cells are given same value
calculatedColumnApi Manages Calculated Columns which contain custom expressions
calendarApi Allows you to choose which Calendar AdapTable will use in its date filters
cellSummaryApi Choose which Cell Summaries to display when cells are selected
cellValidationApi Manages the Cell Validation function so that Grid cell edits are validated
chartApi Deals with the Chart functionality (available through a plugin)
conditionalStyleApi Set bespoke Conditional Stylesfor rows and columns depending on cell data
customSortApi Manages Custom Sorts allowing bespoke column sorting
dashboardApi Large series of functions allowing full customisation of Adaptable Dashboard
dataSourceApi Deals with Data Sources used in Server Searching
exportApi Run reports either manually or at scheduled times
filterApi Manages various filters provided by AdapTable
flashingCellApi Manages the Flashing Cell
freeTextColumnApi Configures FreeText Columns - special columns containing bespoke data
gradientColumnApi Aids creation of visual Gradient Columns
layoutApi Manages Layouts - sets of column order and visibility
percentBarApi Aids creation and editing of visual {@link PercentBarState: Percent Bars}
queryApi Functions relating to the saveable, cross-column Queries
quickSearchApi Functions for running and clearing Quick Search
reminderApi Manages Reminders (scheduled Alerts)
scheduleApi Supports Schedules for running Actions at set time
shortcutApi Deals with Shortcuts for faster & safer data entry
smartEditApi Functions for managing the Smart Edit function to enable better editing
sparklineColumnApi For Sparkline Columns - ideal for historical or array-based data
systemStatusApi Manages how the System Status function will display run-time messages
themeApi Deals with Themes both AdapTable and Custom
toolPanelApi Functions for working with the AdapTable Tool Panel
updatedRowApi Manges Updated Rows which indicated which rows have updated

General Api classes

Api Class Details
columnApi Large number of column-related functions
configApi Series of functions managing Predefined Config and User State
entitlementsApi Manages User Entitlements (essentially Permissions)
eventApi Subscribe to some of the many Events that AdapTable fires
gridApi Series of Grid-management related functions e.g. get/set data
internalapi Used for internal purposes only - not designed for external use
pluginsApi Series of functions for when using Plugins
predicateApi Helper functions for the Predicate - boolean return function
scopeApi Many methods to manage the Scope object
userInterfaceApi Many properties & methods to manage the User Interface

Hierarchy

  • AdaptableApi

Index

Properties

actionColumnApi

actionColumnApi: ActionColumnApi

Provides access to the Action Column functionality, the ActionColumn object.

alertApi

alertApi: AlertApi

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

applicationApi

applicationApi: ApplicationApi

Enables use of the Application Function which lets developers render their own toolbar and screen (if required).

auditEventApi

auditEventApi: AuditEventApi

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: BulkUpdateApi

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

calculatedColumnApi

calculatedColumnApi: CalculatedColumnApi

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

calendarApi

calendarApi: CalendarApi

Provides access to the Calendar function and Calendar State.

cellSummaryApi

cellSummaryApi: CellSummaryApi

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

cellValidationApi

cellValidationApi: CellValidationApi

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

chartApi

chartApi: ChartApi

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

columnApi

columnApi: ColumnApi

Provides a number of column-related methods

conditionalStyleApi

conditionalStyleApi: ConditionalStyleApi

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

configApi

configApi: ConfigApi

Methods that give access to the Adaptable State and Store.

customSortApi

customSortApi: CustomSortApi

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

dashboardApi

dashboardApi: DashboardApi

Provides access to the Dashboard function, and Dashboard State.

dataSourceApi

dataSourceApi: DataSourceApi

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

destroy

destroy: (config?: { destroyApi?: boolean; unmount: boolean }) => void

Cleanup method - should be called only when using the vanilla javascript component, as framework components cleanup is performed when the component is destroyed/unmounted.

Type declaration

    • (config?: { destroyApi?: boolean; unmount: boolean }): void
    • Parameters

      • Optional config: { destroyApi?: boolean; unmount: boolean }
        • Optional destroyApi?: boolean
        • unmount: boolean

      Returns void

entitlementsApi

entitlementsApi: EntitlementsApi

Provides methods to manager User Entitlements (or Permissions)

eventApi

eventApi: EventApi

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

exportApi

exportApi: ExportApi

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

filterApi

filterApi: FilterApi

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

flashingCellApi

flashingCellApi: FlashingCellApi

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

formatColumnApi

formatColumnApi: FormatColumnApi

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

freeTextColumnApi

freeTextColumnApi: FreeTextColumnApi

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

gradientColumnApi

gradientColumnApi: GradientColumnApi

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

gridApi

gridApi: GridApi

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

internalApi

internalApi: InternalApi

Api methods used internally within AdapTable.

This api class is not intended for developers to use and it is not recommended to use this section if accessing AdapTable at runtime through code

layoutApi

layoutApi: LayoutApi

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

percentBarApi

percentBarApi: PercentBarApi

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

pluginsApi

pluginsApi: PluginsApi

Provides access to the Plugins functionality of AdapTable - currently 8 in total including Charting and Finance and with more to come in due course.

Use this api to get hold of the api for any plugins (i.e. for ipushpull, OpenFin etc)

e.g. to get the ipushpull Api do:


const ipushpullApi: IPushPullApi = adaptableApi.pluginsApi.getPluginApi('ipushpull');

plusMinusApi

plusMinusApi: PlusMinusApi

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

predicateApi

predicateApi: PredicateApi

Functions relating to the Predicate object - a boolean-return function used in Filters and Alerts

queryApi

queryApi: QueryApi

Provides access to functions related to a Query - a cross-column search.

quickSearchApi

quickSearchApi: QuickSearchApi

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

reminderApi

reminderApi: ReminderApi

Provides access to the Reminder function

scheduleApi

scheduleApi: ScheduleApi

Provides access to the Schedule function which allows you to create schedules for Reminders, Reports and ipushpull.

scopeApi

scopeApi: ScopeApi

Manages the Scope object - used in many functions to determine where an object is applied

shortcutApi

shortcutApi: ShortcutApi

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

smartEditApi

smartEditApi: SmartEditApi

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

sparklineColumnApi

sparklineColumnApi: SparklineColumnApi

Provides access to the Sparkline Column functionality

Only used if the Charts Plugin has been enabled.

systemStatusApi

systemStatusApi: SystemStatusApi

Api methods related to the System Status function which displays information about the health of the application.

teamSharingApi

teamSharingApi: TeamSharingApi

Functions related to team-sharing whereby users can create and share objects at run-time with colleagues

themeApi

themeApi: ThemeApi

Api methods related to Theme management and Theme State.

toolPanelApi

toolPanelApi: ToolPanelApi

Provides access to the ToolPanel function, and ToolPanel State.

updatedRowApi

updatedRowApi: UpdatedRowApi

Provides access to the Updated Row function and Updated Row State.

userInterfaceApi

userInterfaceApi: UserInterfaceApi

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

Generated using TypeDoc