TreeSchema Interface
This API is provided as an alpha preview and may change without notice.
To use, import via @fluidframework/tree/alpha.
For more information about our API support guarantees, see here.
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.
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.
Signature
readonly root: FieldSchemaAlpha;
Type: FieldSchemaAlpha