Interface: WandOptions<Sections>

Defined in: core/types.ts:173

The options of createWand.

Type Parameters

Type Parameter	Default type
Sections extends readonly AnySection[]	readonly AnySection[]

Properties

Property	Modifier	Type	Description	Defined in
autosaveDebounceMs?	readonly	number	The time between the last change and the autosave, in milliseconds. The default is 500.	core/types.ts:197
config?	readonly	ConfigPatch<ComposeConfig<Sections>>	The configuration layer above the schema defaults.	core/types.ts:181
effects?	readonly	readonly Effect<string, Schema>[]	The effects. The default is the cloud, chalk and glitter effects.	core/types.ts:177
ignoreSelector?	readonly	string	A press on an element that matches this selector does not start a stroke.	core/types.ts:189
locked?	readonly	readonly string[]	The paths that the providers and setConfig cannot change, for example glitter.maxParticles.	core/types.ts:185
plugins?	readonly	readonly Plugin<string, Schema>[]	The plugins.	core/types.ts:179
providers?	readonly	readonly ConfigProvider[]	The configuration providers, from low to high precedence.	core/types.ts:183
random?	readonly	() => number	Replaces Math.random, for example with a seeded function in tests.	core/types.ts:201
scheduler?	readonly	Scheduler	Replaces requestAnimationFrame and performance.now, for example in tests.	core/types.ts:203
shouldDraw?	readonly	DrawPredicate	Decides if a press starts a chalk stroke. The default is drawOnPress.	core/types.ts:187
silent?	readonly	boolean	Set to true to stop the console warnings.	core/types.ts:199
startAfter?	readonly	number | "ready"	Delays the first frame until ready, or for the given time in milliseconds.	core/types.ts:195
target?	readonly	HTMLElement	The element for container mode. Without it, the mode is overlay.	core/types.ts:175
touchAction?	readonly	string	The touch-action value of the target in container mode. The default is none.	core/types.ts:193
zIndex?	readonly	number	The stack order of the canvas. The default is 2147483647.	core/types.ts:191