@adaptabletools/adaptable
Version:
Powerful AG Grid extension which provides advanced, cutting-edge functionality to meet all DataGrid requirements
98 lines (97 loc) • 7.16 kB
TypeScript
import { AlertDefinition, RuleAlertProperties, RuleBasedAlertDefinition } from '../AdaptableState/AlertState';
import { CalculatedColumn } from '../AdaptableState/CalculatedColumnState';
import { AdaptableCellChangedAlert, AdaptableGenericAlert, AdaptableRowChangedAlert } from '../AdaptableState/Common/AdaptableAlert';
import { AdaptableColumn } from '../AdaptableState/Common/AdaptableColumn';
import { AdaptableMessageType } from '../AdaptableState/Common/AdaptableMessageType';
import { AdaptableStyle } from '../AdaptableState/Common/AdaptableStyle';
import { CellDataChangedInfo } from '../AdaptableState/Common/CellDataChangedInfo';
import { Schedule } from '../AdaptableState/Common/Schedule';
import { SystemStatusMessageInfo } from '../AdaptableState/Common/SystemStatusMessageInfo';
import { CustomSort } from '../AdaptableState/CustomSortState';
import { Report, ReportFormatType, ReportNameType, ReportSchedule } from '../AdaptableState/ExportState';
import { FormatColumn } from '../AdaptableState/FormatColumnState';
import { FreeTextColumn } from '../AdaptableState/FreeTextColumnState';
import { Layout } from '../AdaptableState/LayoutState';
import { PlusMinusNudge } from '../AdaptableState/PlusMinusState';
import { Shortcut } from '../AdaptableState/ShortcutState';
import { NotificationsOptions } from '../AdaptableOptions/NotificationsOptions';
import { CellSummmaryInfo } from '../AdaptableState/Common/CellSummary';
import { ChartDefinition, ColumnFilter, CommentThread, CustomDisplayFormatterContext, FlashingCellDefinition, RowDataChangedInfo, SpecialColumnSettings, SystemFilterPredicateId } from '../types';
import { IRowNode } from 'ag-grid-enterprise';
import { AdaptableApi, AdaptableComment, BadgeStyleDefinition, CellAddress, NamedQuery, PivotLayout, TableLayout } from '../../types';
import { ToastOptions } from '../components/Toastify';
import { StyledColumn } from '../AdaptableState/StyledColumnState';
export declare function CreateEmptyCustomSort(): CustomSort;
export declare function CreateAdaptableComment(text: string, api: AdaptableApi): AdaptableComment;
export declare function CreateEmptyCalculatedColumn(defaultSpecialColumnSettings: Partial<SpecialColumnSettings>): CalculatedColumn;
export declare function CreateEmptyNamedQuery(expression?: string): NamedQuery;
export declare function CreateEmptyPlusMinusNudge(): PlusMinusNudge;
export declare function CreateGenericAlert(alertHeader: string, alertMessage: string, alertDefinition: AlertDefinition): AdaptableGenericAlert;
export declare function CreateCellChangedAlert(alertHeader: string, alertMessage: string, alertDefinition: AlertDefinition, cellDataChangedInfo: CellDataChangedInfo): AdaptableCellChangedAlert;
export declare function CreateRowChangedAlert(alertHeader: string, alertMessage: string, alertDefinition: AlertDefinition, rowDataChangedInfo: RowDataChangedInfo): AdaptableRowChangedAlert;
export declare function CreateEmptyAlertDefinition(): RuleBasedAlertDefinition;
export declare function CreateEmptyFlashingCellDefinition(): FlashingCellDefinition;
export declare function CreateInternalAlertDefinitionForMessages(messageType: AdaptableMessageType, alertProperties?: RuleAlertProperties): RuleBasedAlertDefinition;
export declare function CreateEmptyReport(): Report;
export declare function CreateEmptyReportSchedule(reportFormat?: ReportFormatType, reportName?: ReportNameType): ReportSchedule;
export declare function CreateEmptyShortcut(): Shortcut;
export declare function CreateEmptyFormatColumn(): FormatColumn;
export declare function CreateEmptyFreeTextColumn(defaultSpecialColumnSettings: Partial<SpecialColumnSettings>): FreeTextColumn;
export declare function CreateEmptyPivotLayout(pivotLayout?: Partial<PivotLayout> & {
Name: string;
}): PivotLayout;
export declare function CreateEmptyTableLayout(tableLayout?: Partial<TableLayout> & {
Name: string;
}): TableLayout;
export declare function CreateEmptyLayout(layout?: Partial<Layout> & {
Name: string;
}): Layout;
export declare function CreateEmptyStyle(): AdaptableStyle;
export declare function CreateSystemStatusMessageInfo(message: string, type: AdaptableMessageType, furtherInfo?: string): SystemStatusMessageInfo;
export declare function CreateEmptyCellSummmary(): CellSummmaryInfo;
export declare function CreateColumnFilter(ColumnId: string, PredicateId: SystemFilterPredicateId, Inputs: any[]): ColumnFilter;
export declare function CreateEmptyStyledColumn(): StyledColumn;
export declare function CreateDefaultStyledColumnBadge(): BadgeStyleDefinition;
export declare function CreateEmptyChartDefinition(chartDefinition?: ChartDefinition): ChartDefinition;
export declare function CreateCustomDisplayFormatterContext(value: any, node: IRowNode, abColumn: AdaptableColumn, api: AdaptableApi): CustomDisplayFormatterContext;
export declare function CreateEmptyCommentThread(cellAddress: CellAddress): CommentThread;
export declare function CreateToastOptions(notificationsOptions: NotificationsOptions, { onClose, containerId }: {
onClose?: VoidFunction;
containerId: string;
}, overides?: {
duration: number | 'always';
}): ToastOptions;
export declare function CreateDefaultSchedule(): Schedule;
export declare const ObjectFactory: {
CreateEmptyCustomSort: typeof CreateEmptyCustomSort;
CreateEmptyCalculatedColumn: typeof CreateEmptyCalculatedColumn;
CreateEmptyNamedQuery: typeof CreateEmptyNamedQuery;
CreateEmptyPlusMinusNudge: typeof CreateEmptyPlusMinusNudge;
CreateGenericAlert: typeof CreateGenericAlert;
CreateCellChangedAlert: typeof CreateCellChangedAlert;
CreateRowChangedAlert: typeof CreateRowChangedAlert;
CreateEmptyAlertDefinition: typeof CreateEmptyAlertDefinition;
CreateEmptyFlashingCellDefinition: typeof CreateEmptyFlashingCellDefinition;
CreateInternalAlertDefinitionForMessages: typeof CreateInternalAlertDefinitionForMessages;
CreateEmptyReport: typeof CreateEmptyReport;
CreateEmptyReportSchedule: typeof CreateEmptyReportSchedule;
CreateEmptyShortcut: typeof CreateEmptyShortcut;
CreateEmptyFormatColumn: typeof CreateEmptyFormatColumn;
CreateEmptyFreeTextColumn: typeof CreateEmptyFreeTextColumn;
CreateEmptyLayout: typeof CreateEmptyLayout;
CreateEmptyPivotLayout: typeof CreateEmptyPivotLayout;
CreateEmptyTableLayout: typeof CreateEmptyTableLayout;
CreateColumnFilter: typeof CreateColumnFilter;
CreateEmptyStyle: typeof CreateEmptyStyle;
CreateEmptyCellSummmary: typeof CreateEmptyCellSummmary;
CreateSystemStatusMessageInfo: typeof CreateSystemStatusMessageInfo;
CreateToastOptions: typeof CreateToastOptions;
CreateCustomDisplayFormatterContext: typeof CreateCustomDisplayFormatterContext;
CreateEmptyStyledColumn: typeof CreateEmptyStyledColumn;
CreateDefaultStyledColumnBadge: typeof CreateDefaultStyledColumnBadge;
CreateEmptyChartDefinition: typeof CreateEmptyChartDefinition;
CreateEmptyCommentThread: typeof CreateEmptyCommentThread;
CreateAdaptableComment: typeof CreateAdaptableComment;
CreateDefaultSchedule: typeof CreateDefaultSchedule;
};
export default ObjectFactory;