import { ActionColumnOptions, AdaptableOptions, AlertOptions, CalendarOptions, CellSummaryOptions, ChartingOptions, ColumnMenuOptions, ColumnOptions, CommentOptions, ContainerOptions, ContextMenuOptions, CustomSortOptions, DashboardOptions, DataChangeHistoryOptions, DataImportOptions, DataSetOptions, EditOptions, EntitlementOptions, ExportOptions, ExpressionOptions, Fdc3Options, FilterOptions, FlashingCellOptions, FormatColumnOptions, LayoutOptions, NoteOptions, NotificationsOptions, PredicateOptions, QuickSearchOptions, RowFormOptions, SettingsPanelOptions, StateOptions, TeamSharingOptions, ToolPanelOptions, UserInterfaceOptions } from '../types'; /** * Range of functions to access Adaptable Options */ export interface OptionsApi { /** * Returns `AdaptableOptions.adaptableId` */ getAdaptableId(): string; /** * Returns `AdaptableOptions.adaptableStateKey` */ getAdaptableStateKey(): string; /** * Returns `AdaptableOptions.autogeneratePrimaryKey` */ isAutogeneratePrimaryKey(): boolean; /** * Returns `AdaptableOptions.licenseKey` */ getLicenseKey(): string; /** * Returns `AdaptableOptions.primaryKey` */ getPrimaryKey(): string; /** * Returns `AdaptableOptions.userName` */ getUserName(): string; /** * Returns provided `AdaptableOptions` */ getAdaptableOptions(): Readonly; /** * Returns `AdaptableOptions.actionColumnOptions` */ getActionColumnOptions(): Readonly; /** * Returns `AdaptableOptions.alertOptions` */ getAlertOptions(): Readonly; /** * Returns `AdaptableOptions.expressionOptions` */ getExpressionOptions(): Readonly; /** * Returns `AdaptableOptions.calendarOptions` */ getCalendarOptions(): Readonly; /** * Returns `AdaptableOptions.cellSummaryOptions` */ getCellSummaryOptions(): Readonly; /** * Returns `AdaptableOptions.chartingOptions` */ getChartingOptions(): Readonly; /** * Returns `AdaptableOptions.containerOptions` */ getContainerOptions(): Readonly; /** * Returns `AdaptableOptions.columnOptions` */ getColumnOptions(): Readonly; /** * Returns `AdaptableOptions.commentOptions` */ getCommentOptions(): Readonly; /** * Returns `AdaptableOptions.customSortOptions` */ getCustomSortOptions(): Readonly; /** * Returns `AdaptableOptions.dashboardOptions` */ getDashboardOptions(): Readonly; /** * Returns `AdaptableOptions.dataChangeHistoryOptions` */ getDataChangeHistoryOptions(): Readonly; /** * Returns `AdaptableOptions.dataSetOptions` */ getDataSetOptions(): Readonly; /** * Returns `AdaptableOptions.editOptions` */ getEditOptions(): Readonly; /** * Returns `AdaptableOptions.entitlementOptions` */ getEntitlementOptions(): Readonly; /** * Returns `AdaptableOptions.exportOptions` */ getExportOptions(): Readonly; /** * Returns `AdaptableOptions.filterOptions` */ getFilterOptions(): Readonly; /** * Returns `AdaptableOptions.flashingCellOptions` */ getFlashingCellOptions(): Readonly; /** * Returns `AdaptableOptions.layoutOptions` */ getLayoutOptions(): Readonly; /** * Returns `AdaptableOptions.columnMenuOptions` */ getColumnMenuOptions(): Readonly; /** * Returns `AdaptableOptions.contextMenuOptions` */ getContextMenuOptions(): Readonly; /** * Returns `AdaptableOptions.notificationsOptions` */ getNotificationsOptions(): Readonly; /** * Returns `AdaptableOptions.rowFormOptions` */ getRowFormOptions(): Readonly; /** * Returns `AdaptableOptions.quickSearchOptions` */ getQuickSearchOptions(): Readonly; /** * Returns `AdaptableOptions.formatColumnOptions` */ getFormatColumnOptions(): Readonly; /** * Returns `AdaptableOptions.noteOptions` */ getNoteOptions(): Readonly; /** * Returns `AdaptableOptions.predicateOptions` */ getPredicateOptions(): Readonly; /** * Returns `AdaptableOptions.settingsPanelOptions` */ getSettingsPanelOptions(): Readonly; /** * Returns `AdaptableOptions.stateOptions` */ getStateOptions(): Readonly; /** * Returns `AdaptableOptions.teamSharingOptions` */ getTeamSharingOptions(): Readonly; /** * Returns `AdaptableOptions.toolPanelOptions` */ getToolPanelOptions(): Readonly; /** * Returns `AdaptableOptions.userInterfaceOptions` */ getUserInterfaceOptions(): Readonly; /** * Returns `AdaptableOptions.fdc3Options` */ getFdc3Options(): Readonly; /** * Returns `AdaptableOptions.dataImportOptions` */ getDataImportOptions(): Readonly; /** * Returns `AdaptableOptions.adaptableContext` */ getAdaptableContext>(): TContext; /** * Adds a key-value pair to the AdaptableContext * @param key - The key to add * @param value - The value to add */ addToAdaptableContext>(key: keyof TContext, value: TContext[keyof TContext]): void; /** * Removes a key from the AdaptableContext * @param key - The key to remove */ removeFromAdaptableContext>(key: keyof TContext): void; /** * Clears all key-value pairs from the AdaptableContext */ clearAdaptableContext(): void; }