Defines a Plus Minus Rule - used in the Plus Minus Module

TypeScript
export interface PlusMinusNudge extends
Extends

SuspendableObject

Properties

PropertyDescription
NameName of the Plus Minus Nudge rule
NudgeValueAmount by which to update cell when Rule is applied
Rule(Optional) Boolean Expression to determine whether to apply the Nudge
ScopeWhere Rule is applied
IsReadOnlySets Entity to ReadOnly (overwriting a Strategy Entitlement of 'Full')
IsSuspendedSuspends (i.e. turns off) an Adaptable Object

Property Details

Name

Name of the Plus Minus Nudge rule

TypeScript
Name: string;
Property Value

string

NudgeValue

Amount by which to update cell when Rule is applied

TypeScript
NudgeValue: number;
Property Value

number

Rule

(Optional) Boolean Expression to determine whether to apply the Nudge

TypeScript
Rule?: AdaptableBooleanQuery;
Property Value

AdaptableBooleanQuery

Scope

Where Rule is applied

TypeScript
Scope: ColumnScope;
Property Value

ColumnScope

IsSuspended

Inherited from SuspendableObject

Suspends (i.e. turns off) an Adaptable Object

TypeScript
IsSuspended?: boolean;
Property Value

boolean

IsReadOnly

Inherited from AdaptableObject

Sets Entity to ReadOnly (overwriting a Strategy Entitlement of 'Full')

TypeScript
IsReadOnly?: boolean;
Property Value

boolean