TreeSchema Interface

TreeViewConfigurationAlpha

This API is provided as an alpha preview and may change without notice.

To use, import via fluid-framework/alpha.

For more information about our API support guarantees, see here.

Sealed

This type is "sealed," meaning that code outside of the library defining it should not implement or extend it. Future versions of this type may add members or make typing of readonly members more specific.

Signature

/** @sealed */
export interface TreeSchema extends SimpleTreeSchema

Extends: SimpleTreeSchema

Properties

Property	Alerts	Modifiers	Type	Description
definitions	Alpha	readonly	ReadonlyMap<string, SimpleNodeSchema & TreeNodeSchema>	The complete set of node schema definitions recursively referenced by the tree's root.
root	Alpha	readonly	FieldSchemaAlpha	The tree field representing the root of the tree.

Property Details

definitions

The complete set of node schema definitions recursively referenced by the tree's root.

This API is provided as an alpha preview and may change without notice.

For more information about our API support guarantees, see here.

Sealed

This type is "sealed," meaning that code outside of the library defining it should not implement or extend it. Future versions of this type may add members or make typing of readonly members more specific.

Signature

readonly definitions: ReadonlyMap<string, SimpleNodeSchema & TreeNodeSchema>;

Type: ReadonlyMap<string, SimpleNodeSchema & TreeNodeSchema>

Remarks

the keys are the schemas' identifiers.

root

The tree field representing the root of the tree.

This API is provided as an alpha preview and may change without notice.

For more information about our API support guarantees, see here.

Sealed

This type is "sealed," meaning that code outside of the library defining it should not implement or extend it. Future versions of this type may add members or make typing of readonly members more specific.

Signature

readonly root: FieldSchemaAlpha;

Type: FieldSchemaAlpha