@adaptabletools/adaptable/src/AdaptableOptions/OpenFinPluginOptions.d.ts

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

import { AdaptableAlert } from '../AdaptableState/Common/AdaptableAlert';
/**
 * Options required for when using the OpenFin plugin
 */
export interface OpenFinPluginOptions {
    /**
     * How long (in ms) AdapTable throttles when sending data update to OpenFin
     * @defaultValue 2000
     */
    throttleTime?: number;
    /**
     * Timeout (in ms) for OpenFin Notifications to expire; set false for notifications not to auto-dismiss
     * @defaultValue 5000
     */
    notificationTimeout?: number | false;
    /**
     * Icon to show in Notification - uses the value supplied in UserInterfaceOptions
     * @defaultValue true
     */
    showAppIconInNotifications?: true;
    /**
     * Updates OpenFin Notification object before it's displayed (just add/remove properties); return false to stop Notification showing
     * @returns false | undefined
     */
    onShowNotification?: (notification: any, alert?: AdaptableAlert) => any;
    /**
     * Converts AdapTable Alerts configured to display in popup as OpenFin Notifications
     * @defaultValue true
     */
    showAdaptableAlertsAsNotifications?: boolean;
    /**
     * Function which is invoked when a button in OpenFin notification is clicked
     */
    onNotificationAction?: (event: {
        notification: any;
        type: string;
        trigger: string;
        result: {
            task: string;
        };
    }) => any;
    /**
     * Action to perform when a data change in Live Excel report triggers Prevent Edit Alert failure
     */
    onValidationFailureInExcel?: 'override' | 'show-notification' | 'show-undo-notification';
}