Skip to content

@graphty/graph-io / styles / PlanOptions

Interface: PlanOptions ​

Defined in: styles/plan/plan.ts:97

Options of planStyles().

Properties ​

budget? ​

readonly optional budget?: StyleWorkBudget

Defined in: styles/plan/plan.ts:101

The counted work budget; defaults to a fresh StyleBudget.


rawColumns? ​

readonly optional rawColumns?: object

Defined in: styles/plan/plan.ts:108

Data columns the reader read the values from: they are never offered as explanations of themselves.

edge? ​

readonly optional edge?: readonly string[]

Edge columns.

node? ​

readonly optional node?: readonly string[]

Node columns.


signal? ​

readonly optional signal?: AbortSignal

Defined in: styles/plan/plan.ts:115

Cancels the planning.


toolDefaults? ​

readonly optional toolDefaults?: boolean

Defined in: styles/plan/plan.ts:99

Whether to add the writing tool's defaults as a rule at the bottom; defaults to true.