PlusMinusApi

Provides run-time access to the Plus / Minus Module and associated state

TypeScript

export interface

Methods

Method	Returns	Description
addPlusMinusNudge(plusMinusNudge)	`PlusMinusNudge`	Adds new Plus Minus Rule to State
applyPlusMinus(cellUpdateRequests)	`void`	Applies a Plus Minus to given cells
deletePlusMinusNudge(plusMinusNudge)	`void`	Deletes a plus minus rule
editPlusMinusNudge(plusMinusNudge)	`PlusMinusNudge`	Replaces Plus Minus Rule in State with given one
getAllActivePlusMinus(config)	`PlusMinusNudge[]`	Retrieves all active (not-suspended) Plus Minus Rules in Adaptable State with those with expressions first
getAllPlusMinus(config)	`PlusMinusNudge[]`	Retrieves all Plus Minus Rules in Adaptable State with those with expressions first
getAllSuspendedPlusMinus(config)	`PlusMinusNudge[]`	Retrieves all suspended Plus Minus Rules in Adaptable State with those with expressions first
getPlusMinusById(id, config)	`PlusMinusNudge`	Retrieves Plus Minus Rule by the technical ID (from `PlusMinusState`)
getPlusMinusNudgeByName(name)	`PlusMinusNudge` `\| undefined`	Retrieves a Plus Minus Nudge by its Name
getPlusMinusState()	`PlusMinusState`	Retrieves Plus Minus section from Adaptable State (nudge rules only). Keyboard triggers are optional on each ; unset fields fall back to `AdaptableOptions.plusMinusOptions`, then `+` / `-`.
openPlusMinusSettingsPanel()	`void`	Opens Settings Panel with Plus Minus section selected and visible
runPlusMinusNudge(plusMinusNudge, cells, direction)	`void`	Applies a Plus Minus Rule to given cells
suspendPlusMinusNudge(plusMinusNudge)	`PlusMinusNudge`	Suspends Plus Minus Rule
unSuspendPlusMinusNudge(plusMinusNudge)	`PlusMinusNudge`	Activates a suspended Plus Minus Rule

Method Details

addPlusMinusNudge

Adds new Plus Minus Rule to State

TypeScript

addPlusMinusNudge(plusMinusNudge: PlusMinusNudge): PlusMinusNudge;

Parameters

Parameter	Type	Description
plusMinusNudge	`PlusMinusNudge`	Plus Minus Rule to add

Returns

PlusMinusNudge

applyPlusMinus

Applies a Plus Minus to given cells

TypeScript

applyPlusMinus(cellUpdateRequests: CellUpdateRequest[]): void;

Parameters

Parameter	Type	Description
cellUpdateRequests	`CellUpdateRequest[]`	cells to which Rule should be applied

Returns

void

deletePlusMinusNudge

Deletes a plus minus rule

TypeScript

deletePlusMinusNudge(plusMinusNudge: PlusMinusNudge): void;

Parameters

Parameter	Type	Description
plusMinusNudge	`PlusMinusNudge`	Plus Minus Rule to delete

Returns

void

editPlusMinusNudge

Replaces Plus Minus Rule in State with given one

TypeScript

editPlusMinusNudge(plusMinusNudge: PlusMinusNudge): PlusMinusNudge;

Parameters

Parameter	Type	Description
plusMinusNudge	`PlusMinusNudge`	Plus Minus Rule to edit

Returns

PlusMinusNudge

getAllActivePlusMinus

Retrieves all active (not-suspended) Plus Minus Rules in Adaptable State with those with expressions first

TypeScript

getAllActivePlusMinus(config?: LayoutExtendedConfig): PlusMinusNudge[];

Parameters

Parameter	Type
config	`LayoutExtendedConfig`

Returns

PlusMinusNudge[]

getAllPlusMinus

Retrieves all Plus Minus Rules in Adaptable State with those with expressions first

TypeScript

getAllPlusMinus(config?: LayoutExtendedConfig): PlusMinusNudge[];

Parameters

Parameter	Type
config	`LayoutExtendedConfig`

Returns

PlusMinusNudge[]

getAllSuspendedPlusMinus

Retrieves all suspended Plus Minus Rules in Adaptable State with those with expressions first

TypeScript

getAllSuspendedPlusMinus(config?: LayoutExtendedConfig): PlusMinusNudge[];

Parameters

Parameter	Type
config	`LayoutExtendedConfig`

Returns

PlusMinusNudge[]

getPlusMinusById

Retrieves Plus Minus Rule by the technical ID (from PlusMinusState)

TypeScript

getPlusMinusById(id: PlusMinusNudge['Uuid'], config?: LayoutExtendedConfig): PlusMinusNudge;

Parameters

Parameter	Type	Description
id	`PlusMinusNudge['Uuid']`	Plus Minus id
config	`LayoutExtendedConfig`

Returns

PlusMinusNudge

getPlusMinusNudgeByName

Retrieves a Plus Minus Nudge by its Name

TypeScript

getPlusMinusNudgeByName(name: string): PlusMinusNudge | undefined;

Parameters

Parameter	Type	Description
name	`string`	Name of the Plus Minus Nudge

Returns

PlusMinusNudge | undefined

getPlusMinusState

Retrieves Plus Minus section from Adaptable State (nudge rules only). Keyboard triggers are optional on each ; unset fields fall back to AdaptableOptions.plusMinusOptions, then + / -.

TypeScript

getPlusMinusState(): PlusMinusState;

Returns

PlusMinusState

openPlusMinusSettingsPanel

Opens Settings Panel with Plus Minus section selected and visible

TypeScript

openPlusMinusSettingsPanel(): void;

Returns

void

runPlusMinusNudge

Applies a Plus Minus Rule to given cells

TypeScript

runPlusMinusNudge(plusMinusNudge: PlusMinusNudge, cells: GridCell[], direction: 'up' | 'down'): void;

Parameters

Parameter	Type	Description
plusMinusNudge	`PlusMinusNudge`	Plus Minus Rule to apply
cells	`GridCell[]`	cells to which Rule should be applied
direction	`'up' \| 'down'`	Direction of the edit

Returns

void

suspendPlusMinusNudge

Suspends Plus Minus Rule

TypeScript

suspendPlusMinusNudge(plusMinusNudge: PlusMinusNudge): PlusMinusNudge;

Parameters

Parameter	Type	Description
plusMinusNudge	`PlusMinusNudge`	Plus Minus Rule to suspend

Returns

PlusMinusNudge

unSuspendPlusMinusNudge

Activates a suspended Plus Minus Rule

TypeScript

unSuspendPlusMinusNudge(plusMinusNudge: PlusMinusNudge): PlusMinusNudge;

Parameters

Parameter	Type	Description
plusMinusNudge	`PlusMinusNudge`	Plus Minus Rule to un-suspend

Returns

PlusMinusNudge

PreviousPluginsApi NextPlusMinusNudge