@adaptabletools/adaptable 14.0.0-canary.0 → 14.0.0-canary.2

package/src/Api/OptionsApi.d.ts

@@ -0,0 +1,131 @@
+import { GridOptions } from '@ag-grid-community/core';
+import { ActionOptions, AdaptableOptions, AdaptableQLOptions, AlertOptions, ChartingOptions, ColumnOptions, ContainerOptions, DashboardOptions, DataChangeHistoryOptions, EditOptions, EntitlementOptions, ExportOptions, FilterOptions, FlashingCellOptions, GeneralOptions, LayoutOptions, MenuOptions, NotificationsOptions, SearchOptions, SettingsPanelOptions, StateOptions, TeamSharingOptions, ToolPanelOptions, UserInterfaceOptions } from '../types';
+/**
+ * Range of functions to access AdaptableOptions
+ */
+export interface OptionsApi {
+    /**
+     * Returns `AdaptableOptions.adaptableId`
+     */
+    getAdaptableId(): string;
+    /**
+     * Returns `AdaptableOptions.adaptableStateKey`
+     */
+    getAdaptableStateKey(): string;
+    /**
+     * Returns `AdaptableOptions.autogeneratePrimaryKey`
+     */
+    getAutogeneratePrimaryKey(): boolean;
+    /**
+     * Returns `AdaptableOptions.gridOptions`
+     */
+    getAgGridOptions(): GridOptions;
+    /**
+     * Returns `AdaptableOptions.licenseKey`
+     */
+    getLicenseKey(): string;
+    /**
+     * Returns `AdaptableOptions.primaryKey`
+     */
+    getPrimaryKey(): string;
+    /**
+     * Returns `AdaptableOptions.userName`
+     */
+    getUserName(): string;
+    /**
+     * Returns provided `AdaptableOptions`
+     */
+    getAdaptableOptions(): AdaptableOptions;
+    /**
+     * Returns `AdaptableOptions.actionOptions`
+     */
+    getActionOptions(): Readonly<ActionOptions>;
+    /**
+     * Returns `AdaptableOptions.alertOptions`
+     */
+    getAlertOptions(): Readonly<AlertOptions>;
+    /**
+     * Returns `AdaptableOptions.adaptableQLOptions`
+     */
+    getAdaptableQLOptions(): Readonly<AdaptableQLOptions>;
+    /**
+     * Returns `AdaptableOptions.chartingOptions`
+     */
+    getChartingOptions(): Readonly<ChartingOptions>;
+    /**
+     * Returns `AdaptableOptions.containerOptions`
+     */
+    getContainerOptions(): Readonly<ContainerOptions>;
+    /**
+     * Returns `AdaptableOptions.columnOptions`
+     */
+    getColumnOptions(): Readonly<ColumnOptions>;
+    /**
+     * Returns `AdaptableOptions.dashboardOptions`
+     */
+    getDashboardOptions(): Readonly<DashboardOptions>;
+    /**
+     * Returns `AdaptableOptions.dataChangeHistoryOptions`
+     */
+    getDataChangeHistoryOptions(): Readonly<DataChangeHistoryOptions>;
+    /**
+     * Returns `AdaptableOptions.editOptions`
+     */
+    getEditOptions(): Readonly<EditOptions>;
+    /**
+     * Returns `AdaptableOptions.entitlementOptions`
+     */
+    getEntitlementOptions(): Readonly<EntitlementOptions>;
+    /**
+     * Returns `AdaptableOptions.exportOptions`
+     */
+    getExportOptions(): Readonly<ExportOptions>;
+    /**
+     * Returns `AdaptableOptions.filterOptions`
+     */
+    getFilterOptions(): Readonly<FilterOptions>;
+    /**
+     * Returns `AdaptableOptions.flashingCellOptions`
+     */
+    getFlashingCellOptions(): Readonly<FlashingCellOptions>;
+    /**
+     * Returns `AdaptableOptions.generalOptions`
+     */
+    getGeneralOptions(): Readonly<GeneralOptions>;
+    /**
+     * Returns `AdaptableOptions.layoutOptions`
+     */
+    getLayoutOptions(): Readonly<LayoutOptions>;
+    /**
+     * Returns `AdaptableOptions.menuOptions`
+     */
+    getMenuOptions(): Readonly<MenuOptions>;
+    /**
+     * Returns `AdaptableOptions.notificationsOptions`
+     */
+    getNotificationsOptions(): Readonly<NotificationsOptions>;
+    /**
+     * Returns `AdaptableOptions.searchOptions`
+     */
+    getSearchOptions(): Readonly<SearchOptions>;
+    /**
+     * Returns `AdaptableOptions.settingsPanelOptions`
+     */
+    getSettingsPanelOptions(): Readonly<SettingsPanelOptions>;
+    /**
+     * Returns `AdaptableOptions.stateOptions`
+     */
+    getStateOptions(): Readonly<StateOptions>;
+    /**
+     * Returns `AdaptableOptions.teamSharingOptions`
+     */
+    getTeamSharingOptions(): Readonly<TeamSharingOptions>;
+    /**
+     * Returns `AdaptableOptions.toolPanelOptions`
+     */
+    getToolPanelOptions(): Readonly<ToolPanelOptions>;
+    /**
+     * Returns `AdaptableOptions.userInterfaceOptions`
+     */
+    getUserInterfaceOptions(): Readonly<UserInterfaceOptions>;
+}

package/src/Api/OptionsApi.js

@@ -0,0 +1,2 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });

package/src/Api/PluginsApi.d.ts

@@ -3,6 +3,7 @@ import { IPushPullApi } from './IPushPullApi';
 import { Glue42Api } from './Glue42Api';
 import { OpenFinApi } from './OpenFinApi';
 import { FinanceApi } from './FinanceApi';
+import { FinsembleApi } from './FinsembleApi';
 /**
  * API methods dealing with AdapTable plugins
  */
@@ -44,4 +45,8 @@ export interface PluginsApi {
      * Returns Finance API class in Adaptable API
      */
     getFinancePluginApi(): FinanceApi;
+    /**
+     * Returns Finsemble API class in Adaptable API
+     */
+    getFinsemblePluginApi(): FinsembleApi;
 }

package/src/Api/PlusMinusApi.d.ts

@@ -16,7 +16,7 @@ export interface PlusMinusApi {
         includeLayoutNotAssociatedObjects?: boolean;
     }): PlusMinusNudge[];
     /**
-     * Retrieves Plus Minus Rule by Id
+     * Retrieves Plus Minus Rule by the technical ID (from `PlusMinusState`)
      * @param id Plus Minus id
      * @returns plus minus rule
      */
@@ -46,7 +46,7 @@ export interface PlusMinusApi {
     /**
      * Opens Settings Panel with Plus Minus section selected and visible
      */
-    showPlusMinusPopup(): void;
+    openPlusMinusSettingsPanel(): void;
     /**
      * Replaces Plus Minus Rule in State with given one
      * @param plusMinusNudge Plus Minus Rule to edit
@@ -71,4 +71,11 @@ export interface PlusMinusApi {
      * @returns plus minus rule
      */
     unSuspendPlusMinusNudge(plusMinusNudge: PlusMinusNudge): PlusMinusNudge;
+    /**
+     * TO BE REMOVED
+     */
+    /**
+     * @deprecated use `openPlusMinusSettingsPanel()` instead
+     */
+    showPlusMinusPopup(): void;
 }

package/src/Api/PredicateApi.d.ts

@@ -1,6 +1,5 @@
-import { AdaptableColumnDataType } from '../../types';
-import { AdaptablePredicateDef, AdaptablePredicate, PredicateDefHandlerParams, ModuleScope } from '../PredefinedConfig/Common/AdaptablePredicate';
-import { SystemFilterPredicateId } from '../types';
+import { AdaptableColumnDataType, SystemFilterPredicateId } from '../../types';
+import { AdaptablePredicateDef, AdaptablePredicate, PredicateDefHandlerParams, PredicateModuleScope } from '../PredefinedConfig/Common/AdaptablePredicate';
 /**
  * Functions which manage the Predicate object in AdapTable
  */
@@ -21,7 +20,7 @@ export interface PredicateApi {
      * Retrieves all Predicate Definitions for given Module Scope
      * @param moduleScope Module Scope to use
      */
-    getPredicateDefsByModuleScope(moduleScope: ModuleScope): AdaptablePredicateDef[];
+    getPredicateDefsByModuleScope(moduleScope: PredicateModuleScope): AdaptablePredicateDef[];
     /**
      * Gets the Predicate Definition for a given Id
      * @param predicateId Id of Predicate Definition
@@ -47,6 +46,11 @@ export interface PredicateApi {
      * @param predicate Predicate Definition to check
      */
     isValidPredicate(predicate: AdaptablePredicate): boolean;
+    /**
+     * Checks if all predicates are valid
+     * @param predicates Predicates Definitions to check
+     */
+    isEveryPredicateValid(predicates: AdaptablePredicate[]): boolean;
     /**
      * Main Handler function for a Predicate Definition - used by AdapTableQL
      * @param predicate Predicate to handle
@@ -55,14 +59,41 @@ export interface PredicateApi {
      */
     handlePredicate(predicate: AdaptablePredicate | undefined, params: Omit<PredicateDefHandlerParams, 'api' | 'inputs'>, defaultReturn: boolean): boolean;
     /**
-     * Gets the correct Equality-type System Predicate for a particular DataType
-     * @param dataType DataType of Column
+     * Handle and compose (with AND) the given Predicate Definitions
+     * @param predicate Predicate to handle
+     * @param params Additional inputs as required
+     * @param defaultReturn Whether to return the default
      */
-    getEqualityPredicateForDataType(dataType: AdaptableColumnDataType): SystemFilterPredicateId;
+    handlePredicates(predicates: AdaptablePredicate[], params: Omit<PredicateDefHandlerParams, 'api' | 'inputs'>, defaultReturn: boolean): boolean;
     /**
-     * Returns true if the predicate has a dropdown.
-     *
-     * @param predicate
+     * TO BE REMOVED
+     */
+    /**
+     * @deprecated use `IsEveryPredicateValid()` instead
+     */
+    arePredicatesValid(predicates: AdaptablePredicate[]): boolean;
+    /**
+     * @deprecated internal method, will be removed in next major release
      */
     hasPredicateValues(predicate: AdaptablePredicate): boolean;
+    /**
+     * @deprecated internal method, will be removed in next major release
+     */
+    getFilterPredicateDefs(): AdaptablePredicateDef[];
+    /**
+     * @deprecated internal method, will be removed in next major release
+     */
+    getAlertPredicateDefs(): AdaptablePredicateDef[];
+    /**
+     * @deprecated internal method, will be removed in next major release
+     */
+    getFormatColumnPredicateDefs(): AdaptablePredicateDef[];
+    /**
+     * @deprecated internal method, will be removed in next major release
+     */
+    getFlashingCellPredicateDefs(): AdaptablePredicateDef[];
+    /**
+     * @deprecated internal method, will be removed in next major release
+     */
+    getEqualityPredicateForDataType(dataType: AdaptableColumnDataType): SystemFilterPredicateId;
 }

package/src/Api/QueryApi.d.ts

@@ -1,4 +1,4 @@
-import { QueryState, NamedQuery } from '../PredefinedConfig/QueryState';
+import { NamedQuery, QueryState } from '../PredefinedConfig/QueryState';
 /**
  * Provides run-time access to Named and Current Queries
  */
@@ -11,7 +11,7 @@ export interface QueryApi {
     /**
      * Gets all Named Queries in Adaptable State
      */
-    getAllNamedQuery(): NamedQuery[];
+    getNamedQueries(): NamedQuery[];
     /**
      * Retrieves Named Query with given name from State
      * @param namedQueryName Name of Named Query
@@ -25,24 +25,10 @@ export interface QueryApi {
         valid: boolean;
         message: string;
     };
-    /**
-     * Returns the name of all the referenced Named Queries as an array of strings
-     * @param expression query string
-     */
-    getReferencedNamedQueryNames(expression: string): string[];
-    /**
-     * Returns all the references in the AdaptableState of the NamedQuery with the given name
-     * @param namedQueryName namedQuery name
-     */
-    getNamedQueryModuleReferences(namedQueryName: string): string[];
     /**
      * Opens Settings Panel with Query section selected and visible
      */
-    showQueryPopup(): void;
-    /**
-     * Opens Expanded Query Popup screen
-     */
-    showExpandedQueryPopup(): void;
+    openQuerySettingsPanel(): void;
     /**
      * Set a Query as Current Query
      * @param query - Query to set
@@ -63,7 +49,26 @@ export interface QueryApi {
      */
     expandCurrentQuery(query?: string): void;
     /**
-     * Fires Query Run Event - typically used to enable querying on the server
+     * TO BE REMOVED
+     */
+    /**
+     * @deprecated use `getNamedQueries()` instead
+     */
+    getAllNamedQuery(): NamedQuery[];
+    /**
+     * @deprecated internal method, will be removed in next major release
+     */
+    getReferencedNamedQueryNames(expression: string): string[];
+    /**
+     * @deprecated internal method, will be removed in next major release
+     */
+    getNamedQueryModuleReferences(namedQueryName: string): string[];
+    /**
+     * @deprecated use `openQuerySettingsPanel()` instead
+     */
+    showQueryPopup(): void;
+    /**
+     * @deprecated internal method, will be removed in next major release
      */
     fireQueryRunEvent(): void;
 }

package/src/Api/QueryLanguageApi.d.ts

@@ -1,6 +1,6 @@
 import { AdaptableModule } from '../PredefinedConfig/Common/Types';
-import { ExpressionFunctionMap } from '../types';
 import { AdaptableQuery } from '../PredefinedConfig/Common/AdaptableQuery';
+import { AdaptableColumnBase } from '../PredefinedConfig/Common/AdaptableColumn';
 /**
  * Functions related to AdapTableQL (the Adaptable Query Language)
  */
@@ -39,13 +39,9 @@ export interface QueryLanguageApi {
      */
     getColumnsFromExpression(expression: string): string[];
     /**
-     * Returns all columns that can be used in an Expression
+     * Returns whether a Column is Queryable
      */
-    getQueryableColumnIds(): string[];
-    /**
-     * Returns the current Module Expression Map
-     */
-    getModuleExpressionFunctionMap(): ExpressionFunctionMap;
+    isColumnQueryable(adaptableColumnBase: AdaptableColumnBase): boolean;
     /**
      * Runs the AST that AdapTableQL creates for an Expression - useful when evaluating remotely
      * @param expression expression to be run

package/src/Api/QuickSearchApi.d.ts

@@ -31,7 +31,11 @@ export interface QuickSearchApi {
      */
     setQuickSearchStyle(style: AdaptableStyle): void;
     /**
-     * Opens Settings Panel with Quick Search section selected and visible
+     * @deprecated use `openQuickSearchSettingsPanel()` instead
      */
     showQuickSearchPopup(): void;
+    /**
+     * Opens Settings Panel with Quick Search section selected and visible
+     */
+    openQuickSearchSettingsPanel(): void;
 }

package/src/Api/ScheduleApi.d.ts

@@ -16,7 +16,7 @@ export interface ScheduleApi {
      * Retrieves the Schedule section from Adaptable State
      * @returns schedules
      */
-    getAllSchedule(): BaseSchedule[];
+    getSchedules(): BaseSchedule[];
     /**
      * Retrieves Schedule by id
      * @param id Schedule id
@@ -27,19 +27,19 @@ export interface ScheduleApi {
      * Retrieves all Reminder-based Schedules from Schedule State
      * @returns reminder schedules
      */
-    getAllReminderSchedule(config?: {
+    getReminderSchedules(config?: {
         includeLayoutNotAssociatedObjects?: boolean;
     }): ReminderSchedule[];
     /**
      * Retrieves all active (not-suspended) Reminder-based Schedules from Schedule State
      * @returns reminder schedules
      */
-    getAllActiveReminderSchedule(): ReminderSchedule[];
+    getActiveReminderSchedules(): ReminderSchedule[];
     /**
      * Retrieves all suspended Reminder-based Schedules from Schedule State
      * @returns reminder schedules
      */
-    getAllSuspendedReminderSchedule(): ReminderSchedule[];
+    getSuspendedReminderSchedules(): ReminderSchedule[];
     /**
      * Adds Reminder-based Schedule
      * @param ReminderSchedule Reminder Schedule to add
@@ -73,19 +73,19 @@ export interface ScheduleApi {
      * Retrieves all Report / Export Schedules from Schedule State
      * @returns report schedules
      */
-    getAllReportSchedule(config?: {
+    getReportSchedules(config?: {
         includeLayoutNotAssociatedObjects?: boolean;
     }): ReportSchedule[];
     /**
      * Retrieves all active (not-suspended) Report / Export Schedules from Schedule State
      * @returns report schedules
      */
-    getAllActiveReportSchedule(): ReportSchedule[];
+    getActiveReportSchedules(): ReportSchedule[];
     /**
      * Retrieves all suspended Report / Export Schedules from Schedule State
      * @returns report schedules
      */
-    getAllSuspendedReportSchedule(): ReportSchedule[];
+    getSuspendedReportSchedules(): ReportSchedule[];
     /**
      * Adds Report / Export Schedule
      * @param ReportSchedule Report / export Schedule to add
@@ -119,19 +119,19 @@ export interface ScheduleApi {
      * Retrieves all ipushpull-based Schedules from Schedule State
      * @returns IPushPull schedules
      */
-    getAllIPushPullSchedule(config?: {
+    getIPushPullSchedules(config?: {
         includeLayoutNotAssociatedObjects?: boolean;
     }): IPushPullSchedule[];
     /**
      * Retrieves all active (not-suspended) ipushpull-based Schedules from Schedule State
      * @returns IPushPull schedules
      */
-    getAllActiveIPushPullSchedule(): IPushPullSchedule[];
+    getActiveIPushPullSchedules(): IPushPullSchedule[];
     /**
      * Retrieves all suspended ipushpull-based Schedules from Schedule State
      * @returns IPushPull schedules
      */
-    getAllSuspendedIPushPullSchedule(): IPushPullSchedule[];
+    getSuspendedIPushPullSchedules(): IPushPullSchedule[];
     /**
      * Add ipushpull-based Schedule
      * @param IPushPullSchedule ipushpull-based Schedule to add
@@ -165,19 +165,19 @@ export interface ScheduleApi {
      * Retrieves all Glue42-based Schedules from Schedule State
      * @returns Glue42 schedules
      */
-    getAllGlue42Schedule(config?: {
+    getGlue42Schedules(config?: {
         includeLayoutNotAssociatedObjects?: boolean;
     }): Glue42Schedule[];
     /**
      * Retrieves all active (not-suspended) Glue42-based Schedules from Schedule State
      * @returns Glue42 schedules
      */
-    getAllActiveGlue42Schedule(): Glue42Schedule[];
+    getActiveGlue42Schedules(): Glue42Schedule[];
     /**
      * Retrieves all suspended Glue42-based Schedules from Schedule State
      * @returns Glue42 schedules
      */
-    getAllSuspendedGlue42Schedule(): Glue42Schedule[];
+    getSuspendedGlue42Schedules(): Glue42Schedule[];
     /**
      * Add Glue42-based Schedule
      * @param Glue42Schedule Glue42-based Schedule to add
@@ -211,19 +211,19 @@ export interface ScheduleApi {
      * Retrieves all OpenFin-based Schedules from Schedule State
      * @returns OpenFin schedules
      */
-    getAllOpenFinSchedule(config?: {
+    getOpenFinSchedules(config?: {
         includeLayoutNotAssociatedObjects?: boolean;
     }): OpenFinSchedule[];
     /**
      * Retrieves all active (not-suspended) OpenFin-based Schedules from Schedule State
      * @returns OpenFin schedules
      */
-    getAllActiveOpenFinSchedule(): OpenFinSchedule[];
+    getActiveOpenFinSchedules(): OpenFinSchedule[];
     /**
      * Retrieves all suspended OpenFin-based Schedules from Schedule State
      * @returns OpenFin schedules
      */
-    getAllSuspendedOpenFinSchedule(): OpenFinSchedule[];
+    getSuspendedOpenFinSchedules(): OpenFinSchedule[];
     /**
      * Add OpenFin-based Schedule
      * @param OpenFinSchedule OpenFin-based Schedule to add
@@ -263,5 +263,86 @@ export interface ScheduleApi {
     /**
      * Opens Settings Panel with Schedule section selected and visible
      */
+    openScheduleSettingsPanel(): void;
+    /**
+     * TO BE REMOVED
+     */
+    /**
+     * @deprecated use `getSchedules()` instead
+     */
+    getAllSchedule(): BaseSchedule[];
+    /**
+     * @deprecated use `getReminderSchedules()` instead
+     */
+    getAllReminderSchedule(config?: {
+        includeLayoutNotAssociatedObjects?: boolean;
+    }): ReminderSchedule[];
+    /**
+     * @deprecated use `getActiveReminderSchedules()` instead
+     */
+    getAllActiveReminderSchedule(): ReminderSchedule[];
+    /**
+     * @deprecated use `getSuspendedReminderSchedules()` instead
+     */
+    getAllSuspendedReminderSchedule(): ReminderSchedule[];
+    /**
+     * @deprecated use `getReportSchedules()` instead
+     */
+    getAllReportSchedule(config?: {
+        includeLayoutNotAssociatedObjects?: boolean;
+    }): ReportSchedule[];
+    /**
+     * @deprecated use `getActiveReportSchedules()` instead
+     */
+    getAllActiveReportSchedule(): ReportSchedule[];
+    /**
+     * @deprecated use `getSuspendedReportSchedules()` instead
+     */
+    getAllSuspendedReportSchedule(): ReportSchedule[];
+    /**
+     * @deprecated use `getIPushPullSchedules()` instead
+     */
+    getAllIPushPullSchedule(config?: {
+        includeLayoutNotAssociatedObjects?: boolean;
+    }): IPushPullSchedule[];
+    /**
+     * @deprecated use `getActiveIPushPullSchedules()` instead
+     */
+    getAllActiveIPushPullSchedule(): IPushPullSchedule[];
+    /**
+     * @deprecated use `getSuspendedIPushPullSchedules()` instead
+     */
+    getAllSuspendedIPushPullSchedule(): IPushPullSchedule[];
+    /**
+     * @deprecated use `getGlue42Schedules()` instead
+     */
+    getAllGlue42Schedule(config?: {
+        includeLayoutNotAssociatedObjects?: boolean;
+    }): Glue42Schedule[];
+    /**
+     * @deprecated use `getActiveGlue42Schedules()` instead
+     */
+    getAllActiveGlue42Schedule(): Glue42Schedule[];
+    /**
+     * @deprecated use `getSuspendedGlue42Schedules()` instead
+     */
+    getAllSuspendedGlue42Schedule(): Glue42Schedule[];
+    /**
+     * @deprecated use `getOpenFinSchedules()` instead
+     */
+    getAllOpenFinSchedule(config?: {
+        includeLayoutNotAssociatedObjects?: boolean;
+    }): OpenFinSchedule[];
+    /**
+     * @deprecated use `getActiveOpenFinSchedules()` instead
+     */
+    getAllActiveOpenFinSchedule(): OpenFinSchedule[];
+    /**
+     * @deprecated use `getSuspendedOpenFinSchedules()` instead
+     */
+    getAllSuspendedOpenFinSchedule(): OpenFinSchedule[];
+    /**
+     * @deprecated use `openScheduleSettingsPanel()` instead
+     */
     showSchedulePopup(): void;
 }

package/src/Api/ScopeApi.d.ts

@@ -1,6 +1,6 @@
 import { AdaptableColumn } from '../PredefinedConfig/Common/AdaptableColumn';
 import { AdaptableScope, ScopeDataType } from '../PredefinedConfig/Common/AdaptableScope';
-import { CellColorRange } from '../PredefinedConfig/FormatColumnState';
+import { CellColorRange } from '../PredefinedConfig/StyledColumnState';
 /**
  * Provides access to a suite of functions related to the `Scope` object
  */

package/src/Api/SettingsPanelApi.d.ts

@@ -7,10 +7,21 @@ export interface SettingsPanelApi {
      * Opens Settings Panel and displays specified Module (if provided) or first available one
      * @param moduleName name of Module to display
      */
-    showSettingsPanel(moduleName?: AdaptableModule): void;
+    openSettingsPanel(moduleName?: AdaptableModule): void;
     /**
      * Opens Settings Panel with the Custom Settings Panel, provided by name, displayed
      * @param name name of Custom Settings Panel to display
      */
+    openCustomSettingsPanel(name: string): void;
+    /**
+     * TO BE REMOVED
+     */
+    /**
+     * @deprecated use `openSettingsPanel()` instead
+     */
+    showSettingsPanel(moduleName?: AdaptableModule): void;
+    /**
+     * @deprecated use `openCustomSettingsPanel()` instead
+     */
     showCustomSettingsPanel(name: string): void;
 }

package/src/Api/ShortcutApi.d.ts

@@ -11,7 +11,7 @@ export interface ShortcutApi {
      * Gets all Shortcuts in Adaptable State
      * @returns shortcuts
      */
-    getAllShortcut(config?: {
+    getShortcuts(config?: {
         includeLayoutNotAssociatedObjects?: boolean;
     }): Shortcut[];
     /**
@@ -24,12 +24,12 @@ export interface ShortcutApi {
      * Gets all active (not-suspended) Shortcuts in Adaptable State
      * @returns shortcuts
      */
-    getAllActiveShortcut(): Shortcut[];
+    getActiveShortcuts(): Shortcut[];
     /**
      * Gets all suspended Shortcuts in Adaptable State
      * @returns shortcuts
      */
-    getAllSuspendedShortcut(): Shortcut[];
+    getSuspendedShortcuts(): Shortcut[];
     /**
      * Adds new Shortcut to the state
      * @param shortcut Shortcut to add
@@ -41,10 +41,6 @@ export interface ShortcutApi {
      * @param shortcut Shortcut to delete
      */
     deleteShortcut(shortcut: Shortcut): void;
-    /**
-     * Deletes all Shortcuts in Adaptable State
-     */
-    deleteAllShortcut(): void;
     /**
      * Suspends Shortcut definition
      * @param shortcut Shortcut to suspend
@@ -60,5 +56,30 @@ export interface ShortcutApi {
     /**
      * Opens Settings Panel with Shortcut section selected and visible
      */
+    openShortcutSettingsPanel(): void;
+    /**
+     * TO BE REMOVED
+     */
+    /**
+     * @deprecated use `getShortcuts()` instead
+     */
+    getAllShortcut(config?: {
+        includeLayoutNotAssociatedObjects?: boolean;
+    }): Shortcut[];
+    /**
+     * @deprecated use `getActiveShortcuts()` instead
+     */
+    getAllActiveShortcut(): Shortcut[];
+    /**
+     * @deprecated use `getSuspendedShortcuts()` instead
+     */
+    getAllSuspendedShortcut(): Shortcut[];
+    /**
+     * @deprecated use `deleteAllShortcuts()` instead
+     */
+    deleteAllShortcut(): void;
+    /**
+     * @deprecated use `openShortcutSettingsPanel()` instead
+     */
     showShortcutPopup(): void;
 }