@adaptabletools/adaptable
Version:
Powerful data-agnostic HTML5 AG Grid extension which provides advanced, cutting-edge functionality to meet all DataGrid requirements
350 lines (349 loc) • 20 kB
TypeScript
import * as Redux from 'redux';
import { InternalState } from '../../AdaptableState/InternalState';
import { PreviewInfo } from '../../Utilities/Interface/Preview';
import { Report, ReportFormatType, ReportNameType } from '../../AdaptableState/ExportState';
import { BulkUpdateValidationResult } from '../../Strategy/Interface/IBulkUpdateModule';
import { AdaptableAlert } from '../../AdaptableState/Common/AdaptableAlert';
import { SystemStatusMessageInfo } from '../../AdaptableState/Common/SystemStatusMessageInfo';
import { SummaryOperation } from '../../AdaptableState/Common/Enums';
import { CellDataChangedInfo } from '../../AdaptableState/Common/CellDataChangedInfo';
import { SmartEditOperation } from '../../AdaptableOptions/EditOptions';
import { DataImportedInfo, DataSet, CellAddress, CellSummmaryInfo, AdaptableMenuItem, AdaptableColumn, ExportDestinationType } from '../../types';
import { ChartModel } from 'ag-grid-enterprise';
import { CachedQuery } from '../../AdaptableState/NamedQueryState';
import { SelectedCellInfo } from '../../AdaptableState/Selection/SelectedCellInfo';
import { SelectedRowInfo } from '../../AdaptableState/Selection/SelectedRowInfo';
import { CellHighlightInfo, RowHighlightInfo, RowsHighlightInfo } from '../../types';
import { IRowNode } from 'ag-grid-enterprise';
export declare const SET_COLUMNS = "SET_COLUMNS";
export declare const SET_SELECTED_CELLS = "SET_SELECTED_CELLS";
export declare const SET_SELECTED_ROWS = "SET_SELECTED_ROWS";
export declare const SET_SETTINGS_PANEL_ITEMS = "SET_SETTINGS_PANEL_ITEMS";
export declare const SET_DASHBOARD_MODULE_BUTTONS = "SET_DASHBOARD_MODULE_BUTTONS";
export declare const HIGHLIGHT_CELL_ADD = "HIGHLIGHT_CELL_ADD";
export declare const HIGHLIGHT_CELL_DELETE = "HIGHLIGHT_CELL_DELETE";
export declare const HIGHLIGHT_CELL_DELETE_ALL = "HIGHLIGHT_CELL_DELETE_ALL";
export declare const HIGHLIGHT_ROW_ADD = "HIGHLIGHT_ROW_ADD";
export declare const HIGHLIGHT_ROWS_ADD = "HIGHLIGHT_ROWS_ADD";
export declare const HIGHLIGHT_ROW_DELETE = "HIGHLIGHT_ROW_DELETE";
export declare const HIGHLIGHT_ROWS_DELETE = "HIGHLIGHT_ROWS_DELETE";
export declare const HIGHLIGHT_ROW_DELETE_ALL = "HIGHLIGHT_ROW_DELETE_ALL";
export declare const ALERT_ADD = "ALERT_ADD";
export declare const ALERT_DELETE = "ALERT_DELETE";
export declare const ALERT_DELETE_ALL = "ALERT_DELETE_ALL";
export declare const ALERT_REMOVE_CELL_HIGHLIGHT = "ALERT_REMOVE_CELL_HIGHLIGHT";
export declare const ALERT_REMOVE_ROW_HIGHLIGHT = "ALERT_REMOVE_ROW_HIGHLIGHT";
export declare const SYSTEM_STATUS_MESSAGE_INFO_ADD = "SYSTEM_STATUS_MESSAGE_INFO_ADD";
export declare const SYSTEM_STATUS_MESSAGE_INFO_DELETE = "SYSTEM_STATUS_MESSAGE_INFO_DELETE";
export declare const SYSTEM_STATUS_MESSAGE_INFO_DELETE_ALL = "SYSTEM_STATUS_MESSAGE_INFO_DELETE_ALL";
export declare const SMARTEDIT_CHECK_CELL_SELECTION = "SMARTEDIT_CHECK_CELL_SELECTION";
export declare const SMARTEDIT_FETCH_PREVIEW = "SMARTEDIT_FETCH_PREVIEW";
export declare const SMARTEDIT_SET_VALID_SELECTION = "SMARTEDIT_SET_VALID_SELECTION";
export declare const SMARTEDIT_SET_PREVIEW = "SMARTEDIT_SET_PREVIEW";
export declare const SMART_EDIT_CHANGE_VALUE = "SMART_EDIT_CHANGE_VALUE";
export declare const SMART_EDIT_CHANGE_OPERATION = "SMART_EDIT_CHANGE_OPERATION";
export declare const BULK_UPDATE_CHECK_CELL_SELECTION = "BULK_UPDATE_CHECK_CELL_SELECTION";
export declare const BULK_UPDATE_SET_VALID_SELECTION = "BULK_UPDATE_SET_VALID_SELECTION";
export declare const BULK_UPDATE_SET_PREVIEW = "BULK_UPDATE_SET_PREVIEW";
export declare const BULK_UPDATE_CHANGE_VALUE = "BULK_UPDATE_CHANGE_VALUE";
export declare const CACHED_QUERY_ADD = "CACHED_QUERY_ADD";
export declare const CELL_SUMMARY_CHANGE_OPERATION = "CELL_SUMMARY_CHANGE_OPERATION";
export declare const SET_CELL_SUMMARY_INFO = "SET_CELL_SUMMARY_INFO";
export declare const CREATE_CELL_SUMMARY_INFO = "CREATE_CELL_SUMMARY_INFO";
export declare const LICENSE_SHOW_WATERMARK = "LICENSE_SHOW_WATERMARK";
export declare const LICENSE_DISABLE_PERSISTENCE = "LICENSE_DISABLE_PERSISTENCE";
export declare const DATA_CHANGE_HISTORY_ADD = "DATA_CHANGE_HISTORY_ADD";
export declare const DATA_CHANGE_HISTORY_UNDO = "DATA_CHANGE_HISTORY_UNDO";
export declare const DATA_CHANGE_HISTORY_CLEAR_ROW = "DATA_CHANGE_HISTORY_CLEAR_ROW";
export declare const DATA_CHANGE_HISTORY_ENABLE = "DATA_CHANGE_HISTORY_ENABLE";
export declare const DATA_CHANGE_HISTORY_DISABLE = "DATA_CHANGE_HISTORY_DISABLE";
export declare const DATA_CHANGE_HISTORY_SUSPEND = "DATA_CHANGE_HISTORY_SUSPEND";
export declare const DATA_CHANGE_HISTORY_RESUME = "DATA_CHANGE_HISTORY_RESUME";
export declare const SETTINGS_PANEL_SET = "SETTINGS_PANEL_SET";
export declare const QUICK_FILTER_BAR_SHOW = "QUICK_FILTER_BAR_SHOW";
export declare const QUICK_FILTER_BAR_HIDE = "QUICK_FILTER_BAR_HIDE";
export declare const DISABLE_DELETE_CONFIRMATION = "DISABLE_DELETE_CONFIRMATION";
export declare const LAYOUT_SHOW_NOT_ASSOCIATED_OBJECTS = "LAYOUT_SHOW_NOT_ASSOCIATED_OBJECTS";
export declare const DASHBOARD_REFRESH = "DASHBOARD_REFRESH";
export declare const DATA_SET_SELECT = "DATA_SET_SELECT";
export declare const CHARTING_SET_CURRENT_CHART_MODELS = "CHARTING_SET_CURRENT_CHART_MODELS";
export declare const SET_QUICK_SEARCH_FLOATING_VISIBILITY = "SET_QUICK_SEARCH_FLOATING_VISIBILITY";
export declare const SYSTEM_EXPORT_BEGIN = "SYSTEM_EXPORT_BEGIN";
export declare const SYSTEM_EXPORT_END = "SYSTEM_EXPORT_END";
export declare const CELL_POPUP_SHOW = "CELL_POPUP_SHOW";
export declare const CELL_POPUP_HIDE = "CELL_POPUP_HIDE";
export declare const CELL_POPUP_EDIT_FOCUSED_ENTITY = "CELL_POPUP_EDIT_FOCUSED_ENTITY";
export declare const SUMMARY_ROW_SET = "SUMMARY_ROW_SET";
export declare const DATA_IMPORT_COMPLETED = "DATA_IMPORT_COMPLETED";
export interface SetColumnsAction extends Redux.Action {
columns: AdaptableColumn[];
}
export interface SetSelectedCellsAction extends Redux.Action {
selectedCellInfo: SelectedCellInfo;
}
export interface SetSelectedRowsAction extends Redux.Action {
selectedRowInfo: SelectedRowInfo;
}
export interface HighlightCellAddAction extends Redux.Action {
cellHighlightInfo: CellHighlightInfo;
}
export interface HighlightCellDeleteAction extends Redux.Action {
primaryKeyValue: CellHighlightInfo['primaryKeyValue'];
columnId: CellHighlightInfo['columnId'];
}
export interface HighlightCellDeleteAllAction extends Redux.Action {
}
export interface HighlightRowAddAction extends Redux.Action {
rowHighlightInfo: RowHighlightInfo;
}
export interface HighlightRowDeleteAction extends Redux.Action {
primaryKeyValue: RowHighlightInfo['primaryKeyValue'];
}
export interface HighlightRowsAddAction extends Redux.Action {
rowsHighlightInfo: RowsHighlightInfo;
}
export interface HighlightRowsDeleteAction extends Redux.Action {
primaryKeyValues: RowsHighlightInfo['primaryKeyValues'];
}
export interface HighlightRowDeleteAllAction extends Redux.Action {
}
export interface RefreshCellsAction extends Redux.Action {
rowNodes: IRowNode[];
columnIds: string[];
}
export interface SystemExportBeginAction extends Redux.Action {
reportName: ReportNameType;
reportFormat: ReportFormatType;
exportDestination: ExportDestinationType;
}
export interface SystemExportEndAction extends Redux.Action {
}
export declare const HighlightCellAdd: (cellHighlightInfo: CellHighlightInfo) => HighlightCellAddAction;
export declare const HighlightCellDelete: (primaryKeyValue: CellHighlightInfo['primaryKeyValue'], columnId: CellHighlightInfo['columnId']) => HighlightCellDeleteAction;
export declare const HighlightCellDeleteAll: () => HighlightCellDeleteAllAction;
export declare const HighlightRowAdd: (rowHighlightInfo: RowHighlightInfo) => HighlightRowAddAction;
export declare const HighlightRowsAdd: (rowsHighlightInfo: RowsHighlightInfo) => HighlightRowsAddAction;
export declare const HighlightRowDelete: (primaryKeyValue: RowHighlightInfo['primaryKeyValue']) => HighlightRowDeleteAction;
export declare const GridHighlightRowsDelete: (primaryKeyValues: RowsHighlightInfo['primaryKeyValues']) => HighlightRowsDeleteAction;
export declare const GridHighlightRowDeleteAll: () => HighlightRowDeleteAllAction;
export interface SetSettingsPanelItemsAction extends Redux.Action {
menuItems: AdaptableMenuItem[];
}
export interface SetDasboardModuleButtonsAction extends Redux.Action {
menuItems: AdaptableMenuItem[];
}
export interface SetLiveReportRunningOnAction extends Redux.Action {
}
export interface SetLiveReportRunningOffAction extends Redux.Action {
}
export declare const SetColumns: (Columns: AdaptableColumn[]) => SetColumnsAction;
export declare const SetSelectedCells: (SelectedCellInfo: SelectedCellInfo) => SetSelectedCellsAction;
export declare const SetSelectedRows: (SelectedRowInfo: SelectedRowInfo) => SetSelectedRowsAction;
export declare const SetSettingsPanelItems: (MenuItems: AdaptableMenuItem[]) => SetSettingsPanelItemsAction;
export declare const SetDasboardModuleButtons: (MenuItems: AdaptableMenuItem[]) => SetDasboardModuleButtonsAction;
export interface DataImportCompletedAction extends Redux.Action {
dataImportedInfo: DataImportedInfo;
}
export interface AdaptableAlertAddAction extends Redux.Action {
alert: AdaptableAlert;
maxAlerts: number;
}
export interface AdaptableAlertDeleteAction extends Redux.Action {
alert: AdaptableAlert;
}
export interface AdaptableAlertDeleteAllAction extends Redux.Action {
alerts: AdaptableAlert[];
}
export interface AdaptableAlertRemoveCellHighlightAction extends Redux.Action {
alert: AdaptableAlert;
}
export interface AdaptableAlertRemoveRowHighlightAction extends Redux.Action {
alert: AdaptableAlert;
}
export interface SystemStatusMessageInfoAddAction extends Redux.Action {
systemStatusMessageInfo: SystemStatusMessageInfo;
maxSystemStatusMessagesInStore: number;
}
export interface SystemStatusMessageInfoDeleteAction extends Redux.Action {
systemStatusMessageInfo: SystemStatusMessageInfo;
}
export interface SystemStatusMessageInfoDeleteAllAction extends Redux.Action {
}
export interface SetAvailableFilterValuesAction extends Redux.Action {
columnId: string;
values: any[] | undefined;
}
export interface CreateCellSummaryInfoAction extends Redux.Action {
}
export interface SetCellSummaryInfoAction extends Redux.Action {
cellSummaryInfo: CellSummmaryInfo;
}
export interface ReportStartLiveAction extends Redux.Action {
report: Report;
reportDestination: 'OpenfinExcel';
pageName: string;
}
export interface ReportStopLiveAction extends Redux.Action {
report: Report;
reportDestination: 'OpenfinExcel';
}
export interface SmartEditChangeValueAction extends Redux.Action {
value: number;
}
export interface SmartEditChangeOperationAction extends Redux.Action {
smartEditOperation: SmartEditOperation;
}
export interface SmartEditCheckCellSelectionAction extends Redux.Action {
}
export interface SmartEditFetchPreviewAction extends Redux.Action {
}
export interface SmartEditSetPreviewAction extends Redux.Action {
smartEditPreviewInfo: PreviewInfo;
}
export interface SmartEditSetValidSelectionAction extends Redux.Action {
isValidSmartEditSelection: boolean;
}
export interface BulkUpdateCheckCellSelectionAction extends Redux.Action {
}
export interface BulkUpdateSetPreviewAction extends Redux.Action {
bulkUpdatePreviewInfo: PreviewInfo;
}
export interface BulkUpdateChangeValueAction extends Redux.Action {
bulkUpdateValue: string;
}
export interface BulkUpdateSetValidSelectionAction extends Redux.Action {
bulkUpdateValidationResult: BulkUpdateValidationResult;
}
export interface ValuesFilterSearchStringChangeAction extends Redux.Action {
valuesFilterSearchString: string;
}
export interface SetNewColumnListOrderAction extends Redux.Action {
visibleColumnList: string[];
}
export interface CachedQueryAddAction extends Redux.Action {
cachedQuery: CachedQuery;
}
export interface CellSummaryChangeOperationAction extends Redux.Action {
cellSummaryOperation: SummaryOperation | string;
}
export interface LicenseShowWatermarkAction extends Redux.Action {
text: string;
}
export interface LicenseDisablePersistenceAction extends Redux.Action {
}
export interface DataChangeHistoryAction extends Redux.Action {
changeInfo: CellDataChangedInfo;
uniqueKey: string;
}
export interface DataChangeHistoryAddAction extends DataChangeHistoryAction {
}
export interface DataChangeHistoryUndoAction extends DataChangeHistoryAction {
}
export interface DataChangeHistoryClearRowAction extends DataChangeHistoryAction {
}
export interface DataChangeHistoryEnableAction extends Redux.Action {
}
export interface DataChangeHistoryDisableAction extends Redux.Action {
}
export interface DataChangeHistorySuspendAction extends Redux.Action {
}
export interface DataChangeHistoryResumeAction extends Redux.Action {
}
export interface DisableDeleteConfirmationAction extends Redux.Action {
}
export interface DashboardRefreshAction extends Redux.Action {
}
export interface SettingsPanelSetAction extends Redux.Action {
name: string;
settings: InternalState['SettingsPanel']['0'];
}
export interface QuickFilterBarShowAction extends Redux.Action {
}
export interface QuickFilterBarHideAction extends Redux.Action {
}
export interface LayoutShowNotAssociatedObjectsAction extends Redux.Action {
showNotAssociatedObjects: boolean;
}
export interface DataSetSelectAction extends Redux.Action {
dataSet: DataSet;
}
export interface ChartingSetCurrentChartModelsAction extends Redux.Action {
chartModels: ChartModel[];
}
export interface SetPreviousGroupedColumnIndexAction extends Redux.Action {
layoutId: string;
columnId: string;
columnIndex: number;
}
export interface VisualExportBeginAction extends Redux.Action {
}
export interface VisualExportEndAction extends Redux.Action {
}
export interface QuickSearchFloatingVisibilityAction extends Redux.Action {
visible: boolean;
}
export interface CellPopupShowAction extends Redux.Action {
cellPosition: CellAddress;
editMode?: boolean;
}
export interface CellPopupEditFocusedEntityAction extends Redux.Action {
focusedEntity: 'Note' | 'Comment';
}
export interface CellPopupHideAction extends Redux.Action {
}
export declare const AdaptableAlertAdd: (alert: AdaptableAlert, maxAlerts: number) => AdaptableAlertAddAction;
export declare const AdaptableAlertDelete: (alert: AdaptableAlert) => AdaptableAlertDeleteAction;
export declare const AdaptableAlertDeleteAll: (alerts: AdaptableAlert[]) => AdaptableAlertDeleteAllAction;
export declare const AdaptableAlertRemoveCellHighlight: (alert: AdaptableAlert) => AdaptableAlertRemoveCellHighlightAction;
export declare const AdaptableAlertRemoveRowHighlight: (alert: AdaptableAlert) => AdaptableAlertRemoveRowHighlightAction;
export declare const CreateCellSummaryInfo: () => CreateCellSummaryInfoAction;
export declare const SetCellSummaryInfo: (CellSummary: CellSummmaryInfo) => SetCellSummaryInfoAction;
export declare const SystemStatusMessageInfoAdd: (SystemStatusMessageInfo: SystemStatusMessageInfo, MaxSystemStatusMessagesInStore: number) => SystemStatusMessageInfoAddAction;
export declare const SystemStatusMessageInfoDelete: (SystemStatusMessageInfo: SystemStatusMessageInfo) => SystemStatusMessageInfoDeleteAction;
export declare const SystemStatusMessageInfoDeleteAll: () => SystemStatusMessageInfoDeleteAllAction;
export declare const SmartEditChangeValue: (value: number) => SmartEditChangeValueAction;
export declare const SmartEditChangeOperation: (smartEditOperation: SmartEditOperation) => SmartEditChangeOperationAction;
export declare const SmartEditCheckCellSelection: () => SmartEditCheckCellSelectionAction;
export declare const SmartEditSetValidSelection: (IsValidSmartEditSelection: boolean) => SmartEditSetValidSelectionAction;
export declare const SmartEditSetPreview: (SmartEditPreviewInfo: PreviewInfo) => SmartEditSetPreviewAction;
export declare const BulkUpdateCheckCellSelection: () => BulkUpdateCheckCellSelectionAction;
export declare const BulkUpdateSetValidSelection: (bulkUpdateValidationResult: BulkUpdateValidationResult) => BulkUpdateSetValidSelectionAction;
export declare const BulkUpdateSetPreview: (BulkUpdatePreviewInfo: PreviewInfo) => BulkUpdateSetPreviewAction;
export declare const BulkUpdateChangeValue: (bulkUpdateValue: string) => BulkUpdateChangeValueAction;
export declare const CachedQueryAdd: (cachedQuery: CachedQuery) => CachedQueryAddAction;
export declare const CellSummaryChangeOperation: (cellSummaryOperation: SummaryOperation | string) => CellSummaryChangeOperationAction;
export declare const LicenseShowWatermark: (text: string) => LicenseShowWatermarkAction;
export declare const LicenseDisablePersistence: () => LicenseDisablePersistenceAction;
export declare const DataChangeHistoryAdd: (changeInfo: CellDataChangedInfo, uniqueKey: string) => DataChangeHistoryAddAction;
export declare const DataChangeHistoryUndo: (changeInfo: CellDataChangedInfo, uniqueKey: string) => DataChangeHistoryUndoAction;
export declare const DataChangeHistoryClearRow: (changeInfo: CellDataChangedInfo, uniqueKey: string) => DataChangeHistoryClearRowAction;
export declare const DataChangeHistoryEnable: () => DataChangeHistoryEnableAction;
export declare const DataChangeHistoryDisable: () => DataChangeHistoryDisableAction;
export declare const DataChangeHistorySuspend: () => DataChangeHistorySuspendAction;
export declare const DataChangeHistoryResume: () => DataChangeHistoryResumeAction;
export declare const SettingsPanelSet: (name: string, settings: InternalState['SettingsPanel']['0']) => SettingsPanelSetAction;
export declare const QuickFilterBarShow: () => QuickFilterBarShowAction;
export declare const QuickFilterBarHide: () => QuickFilterBarHideAction;
export declare const LayoutShowNotAssociatedObjects: (showNotAssociatedObjects: boolean) => LayoutShowNotAssociatedObjectsAction;
export declare const DashboardRefresh: () => DashboardRefreshAction;
export declare const DataSetSelect: (dataSet: DataSet) => DataSetSelectAction;
export declare const ChartingSetCurrentChartModels: (chartModels: ChartModel[]) => ChartingSetCurrentChartModelsAction;
export declare const ChartingCurrentChartModelsSelector: (state: InternalState) => ChartModel[];
export declare const DisableDeleteConfirmation: () => DisableDeleteConfirmationAction;
export declare const SystemExportBegin: (reportName: ReportNameType, reportFormat: ReportFormatType, exportDestination: ExportDestinationType) => SystemExportBeginAction;
export declare const SystemExportEnd: () => SystemExportEndAction;
export declare const QuickSearchFloatingVisibility: (visible: boolean) => QuickSearchFloatingVisibilityAction;
export declare const CellPopupShow: (cellPosition: CellAddress, editMode?: boolean) => CellPopupShowAction;
export declare const CellPopupEditFocusedEntity: (focusedEntity: 'Note' | 'Comment') => CellPopupEditFocusedEntityAction;
export declare const RowSummarySet: (rowSummaries: InternalState['RowSummary']['rowSummaries']) => {
readonly type: "SUMMARY_ROW_SET";
readonly rowSummaries: import("../../AdaptableState/InternalState").SystemRowSummary[];
};
export declare const CellPopupHide: () => CellPopupHideAction;
export declare const DisableDeleteConfirmationSelector: (state: InternalState) => boolean;
export declare const QuickSearchFloatingVisibilitySelector: (state: InternalState) => boolean;
export declare const CommentsAndNotesSelector: (state: InternalState) => CellAddress;
export declare const CommentsAndNotesEditModeSelector: (state: InternalState) => boolean;
export declare const CommentsAndNotesFocusedEntitySelector: (state: InternalState) => "Comment" | "Note";
export declare const DataImportCompleted: (dataImportedInfo: DataImportedInfo) => DataImportCompletedAction;
export declare const InternalReducer: Redux.Reducer<InternalState>;