TreeConfiguration Class

Configuration for how to schematize a tree.

Signature

export declare class TreeConfiguration<TSchema extends ImplicitFieldSchema = ImplicitFieldSchema>

Parameter	Constraint	Default	Description
TSchema	ImplicitFieldSchema	ImplicitFieldSchema

Constructor	Description
(constructor)(schema, initialTree)	Constructs a new instance of the `TreeConfiguration` class

Property	Modifiers	Type	Description
initialTree	`readonly`	() => InsertableTreeFieldFromImplicitField<TSchema>
schema	`readonly`	TSchema

Constructs a new instance of the TreeConfiguration class

constructor(schema: TSchema, initialTree: () => InsertableTreeFieldFromImplicitField<TSchema>);

Parameter	Type	Description
schema	TSchema	The schema which the application wants to view the tree with.
initialTree	() => InsertableTreeFieldFromImplicitField<TSchema>	A function that returns the default tree content to initialize the tree with iff the tree is uninitialized (meaning it does not even have any schema set at all). If `initialTree` returns any actual node instances, they should be recreated each time `initialTree` runs. This is because if the config is used a second time any nodes that were not recreated could error since nodes cannot be inserted into the tree multiple times.

readonly initialTree: () => InsertableTreeFieldFromImplicitField<TSchema>;

readonly schema: TSchema;