@adaptabletools/adaptable-cjs/src/AdaptableState/PlusMinusState.d.ts

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

import { BaseState } from './BaseState';
import { ColumnScope } from './Common/ColumnScope';
import { AdaptableBooleanQuery } from './Common/AdaptableQuery';
import { SuspendableObject } from '../types';
/**
 * Adaptable State Section for Plus Minus Module
 */
export interface PlusMinusState extends BaseState {
    /**
     * Array of Plus Minus Nudges
     */
    PlusMinusNudges?: PlusMinusNudge[];
}
/**
 * Defines a Plus Minus Rule - used in the Plus Minus Module
 */
export interface PlusMinusNudge extends SuspendableObject {
    /**
     * Name of the Plus Minus Nudge rule
     */
    Name: string;
    /**
     * Where Rule is applied
     */
    Scope: ColumnScope;
    /**
     * Amount by which to update cell when Rule is applied
     */
    NudgeValue: number;
    /**
     * (Optional) Boolean Expression to determine whether to apply the Nudge
     */
    Rule?: AdaptableBooleanQuery;
}