@adaptabletools/adaptable
Version:
Powerful data-agnostic HTML5 AG Grid extension which provides advanced, cutting-edge functionality to meet all DataGrid requirements
51 lines (50 loc) • 4.4 kB
TypeScript
import { AdaptablePersistentState } from '../AdaptableState';
/**
* Adaptable Toolbar collection. When setting `Toolbars` in Dashboard state, only those listed here can be included
*/
export type AdaptableDashboardToolbars = AdaptableDashboardToolbar[];
/**
* List of all the Toolbars that Adaptable provides
*/
export type AdaptableDashboardToolbar = 'Alert' | 'BulkUpdate' | 'CellSummary' | 'Charting' | 'DataChangeHistory' | 'DataSet' | 'Export' | 'ColumnFilter' | 'IPushPull' | 'Layout' | 'GridFilter' | 'OpenFin' | 'QuickSearch' | 'SmartEdit' | 'StateManagement' | 'SystemStatus' | 'Theme';
export declare const ALL_TOOLBARS: AdaptableDashboardToolbar[];
/**
* Modules which can appear in the AdapTable Status Bar
*/
export type AdaptableStatusBarPanel = 'Alert' | 'CalculatedColumn' | 'BulkUpdate' | 'CellSummary' | 'Charting' | 'Comment' | 'CustomSort' | 'Dashboard' | 'DataChangeHistory' | 'DataImport' | 'DataSet' | 'Export' | 'ColumnFilter' | 'GridFilter' | 'FlashingCell' | 'FormatColumn' | 'FreeTextColumn' | 'GridInfo' | 'Layout' | 'Note' | 'PlusMinus' | 'QuickSearch' | 'Schedule' | 'SettingsPanel' | 'SmartEdit' | 'Shortcut' | 'StateManagement' | 'StatusBar' | 'SystemStatus' | 'TeamSharing' | 'Theme' | 'ToolPanel';
export declare const ALL_STATUS_SUB_PANELS: AdaptableStatusBarPanel[];
export type AdaptableToolPanels = AdaptableToolPanel[];
/**
* Modules which can appear as AdapTable Tool Panels
*/
export type AdaptableToolPanel = 'Alert' | 'BulkUpdate' | 'CellSummary' | 'Charting' | 'Dashboard' | 'DataChangeHistory' | 'Export' | 'ColumnFilter' | 'GridFilter' | 'IPushPull' | 'Layout' | 'OpenFin' | 'QuickSearch' | 'SmartEdit' | 'StateManagement' | 'SystemStatus' | 'Theme';
export declare const ALL_TOOL_PANELS: AdaptableToolPanels;
/**
* Adaptable Module Button collection
*
* When setting the `ModuleButtons` property in Dashboard state, only the Module Buttons listed here can be included.
*/
export type AdaptableModuleButtons = AdaptableModuleButton[];
/**
* List of all the Module buttons Adaptable provides - each Module has a popup for which this is a shortcut button
*/
export type AdaptableModuleButton = 'Alert' | 'BulkUpdate' | 'CalculatedColumn' | 'CellSummary' | 'Comment' | 'CustomSort' | 'Dashboard' | 'DataChangeHistory' | 'DataImport' | 'DataSet' | 'Export' | 'ColumnFilter' | 'GridFilter' | 'NamedQuery' | 'FlashingCell' | 'FormatColumn' | 'FreeTextColumn' | 'GridInfo' | 'Layout' | 'Note' | 'OpenFin' | 'PlusMinus' | 'QuickSearch' | 'Schedule' | 'SettingsPanel' | 'Shortcut' | 'SmartEdit' | 'StyledColumn' | 'StateManagement' | 'StatusBar' | 'SystemStatus' | 'TeamSharing' | 'Theme';
export type AdaptableStateKeys = AdaptableStateKey[];
export type AdaptableStateKey = keyof AdaptablePersistentState | 'OpenFin' | 'IPushPull';
/**
* Modules provided by AdapTable, subject to Entitlements and usually have Initial Adaptable State
*/
export type AdaptableModule = 'Alert' | 'BulkUpdate' | 'CalculatedColumn' | 'CellSummary' | 'Charting' | 'Comment' | 'CustomSort' | 'Dashboard' | 'DataChangeHistory' | 'DataSet' | 'Export' | 'Fdc3' | 'ColumnFilter' | 'FlashingCell' | 'FormatColumn' | 'FreeTextColumn' | 'GridInfo' | 'ColumnInfo' | 'IPushPull' | 'Layout' | 'OpenFin' | 'PlusMinus' | 'QuickSearch' | 'Schedule' | 'SettingsPanel' | 'Shortcut' | 'SmartEdit' | 'StyledColumn' | 'StateManagement' | 'StatusBar' | 'SystemStatus' | 'TeamSharing' | 'Theme' | 'ToolPanel' | 'Note' | 'DataImport' | 'GridFilter' | 'NamedQuery';
export declare const ALL_MODULES: AdaptableModule[];
/**
* Modules which can appear in the Settings Panel
*/
export type AdaptableSettingsPanel = 'Alert' | 'CalculatedColumn' | 'Charting' | 'CustomSort' | 'Dashboard' | 'DataChangeHistory' | 'DataSet' | 'Export' | 'ColumnFilter' | 'FlashingCell' | 'FormatColumn' | 'FreeTextColumn' | 'GridInfo' | 'ColumnInfo' | 'Layout' | 'PlusMinus' | 'QuickSearch' | 'Schedule' | 'Shortcut' | 'StateManagement' | 'StatusBar' | 'StyledColumn' | 'SystemStatus' | 'TeamSharing' | 'Theme' | 'ToolPanel' | 'Note' | 'DataImport' | 'GridFilter' | 'NamedQuery' | 'Comment';
export type TypeHint<Base, Literals> = (Base & {
__subType?: true;
}) | Literals;
export type AdaptableQLModules = AdaptableQLModule[];
/**
* Modules which leverage AdapTableQL; can be used to set remote evaluation
*/
export type AdaptableQLModule = 'Alert' | 'CalculatedColumn' | 'ColumnFilter' | 'GridFilter';