@adaptabletools/adaptable/src/Utilities/ObjectFactory.d.ts

Powerful data-agnostic HTML5 AG Grid extension which provides advanced, cutting-edge functionality to meet all DataGrid requirements

import { AlertDefinition, AlertProperties } 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 { ScheduleType } from '../AdaptableState/Common/Enums';
import { BaseSchedule, 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 { IPushPullSchedule } from '../AdaptableState/IPushPullState';
import { Layout } from '../AdaptableState/LayoutState';
import { OpenFinReport, OpenFinSchedule } from '../AdaptableState/OpenFinState';
import { PlusMinusNudge } from '../AdaptableState/PlusMinusState';
import { ReminderSchedule } from '../AdaptableState/ScheduleState';
import { Shortcut } from '../AdaptableState/ShortcutState';
import { IPushPullReport } from '../AdaptableState/InternalState';
import { NotificationsOptions } from '../AdaptableOptions/NotificationsOptions';
import { CellSummmaryInfo } from '../AdaptableState/Common/CellSummary';
import { AdaptableTheme, ChartDefinition, ColumnFilter, CommentThread, CustomDisplayFormatterContext, FlashingCellDefinition, RowDataChangedInfo, SpecialColumnSettings, SystemFilterPredicateId } from '../types';
import { IRowNode } from 'ag-grid-enterprise';
import { AdaptableApi, AdaptableComment, BadgeStyleDefinition, CellAddress, NamedQuery, PivotLayout } 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(): AlertDefinition;
export declare function CreateEmptyFlashingCellDefinition(): FlashingCellDefinition;
export declare function CreateInternalAlertDefinitionForMessages(messageType: AdaptableMessageType, alertProperties?: AlertProperties): AlertDefinition;
export declare function CreateEmptyReport(): Report;
export declare function CreateEmptyBaseSchedule(scheduleType: ScheduleType): BaseSchedule;
export declare function CreateEmptyReminderSchedule(): ReminderSchedule;
export declare function CreateEmptyReportSchedule(): ReportSchedule;
export declare function CreateEmptyIPushPullReport(): IPushPullReport;
export declare function CreateEmptyOpenFinReport(): OpenFinReport;
export declare function CreateEmptyIPushPullSchedule(): IPushPullSchedule;
export declare function CreateEmptyOpenFinSchedule(): OpenFinSchedule;
export declare function CreateIPushPullSchedule(iPushPullReport: IPushPullReport): IPushPullSchedule;
export declare function CreateReportSchedule(reportName: ReportNameType, reportFormat: ReportFormatType): ReportSchedule;
export declare function CreateEmptySchedule(): Schedule;
export declare function CreateEmptyShortcut(): Shortcut;
export declare function CreateEmptyFormatColumn(): FormatColumn;
export declare function CreateEmptyFreeTextColumn(defaultSpecialColumnSettings: Partial<SpecialColumnSettings>): FreeTextColumn;
export declare function CreateEmptyPivotLayout(layout?: Partial<PivotLayout> & {
    Name: string;
}): PivotLayout;
export declare function CreateEmptyLayout(layout?: Partial<Layout> & {
    Name: string;
}, adaptableColumns?: AdaptableColumn[]): 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 CreateEmptyTheme(name?: string): AdaptableTheme;
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 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;
    CreateEmptyBaseSchedule: typeof CreateEmptyBaseSchedule;
    CreateEmptyReminderSchedule: typeof CreateEmptyReminderSchedule;
    CreateEmptyReportSchedule: typeof CreateEmptyReportSchedule;
    CreateEmptyIPushPullSchedule: typeof CreateEmptyIPushPullSchedule;
    CreateEmptyIPushPullReport: typeof CreateEmptyIPushPullReport;
    CreateIPushPullSchedule: typeof CreateIPushPullSchedule;
    CreateReportSchedule: typeof CreateReportSchedule;
    CreateEmptyOpenFinReport: typeof CreateEmptyOpenFinReport;
    CreateEmptyOpenFinSchedule: typeof CreateEmptyOpenFinSchedule;
    CreateEmptySchedule: typeof CreateEmptySchedule;
    CreateEmptyShortcut: typeof CreateEmptyShortcut;
    CreateEmptyFormatColumn: typeof CreateEmptyFormatColumn;
    CreateEmptyFreeTextColumn: typeof CreateEmptyFreeTextColumn;
    CreateEmptyLayout: typeof CreateEmptyLayout;
    CreateEmptyPivotLayout: typeof CreateEmptyPivotLayout;
    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;
    CreateEmptyTheme: typeof CreateEmptyTheme;
    CreateEmptyCommentThread: typeof CreateEmptyCommentThread;
    CreateAdaptableComment: typeof CreateAdaptableComment;
};
export default ObjectFactory;