TreeViewConfigurationAlpha Class
TreeViewConfiguration extended with some alpha APIs.
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.
Signature
/** @sealed */
export declare class TreeViewConfigurationAlpha<const TSchema extends ImplicitFieldSchema = ImplicitFieldSchema> extends TreeViewConfiguration<TSchema> implements TreeSchema
Extends: TreeViewConfiguration<TSchema>
Implements: TreeSchema
Type Parameters
| Parameter | Constraint | Default | Description |
|---|---|---|---|
| TSchema | ImplicitFieldSchema | ImplicitFieldSchema |
Constructors
| Constructor | Alerts | Description |
|---|---|---|
| (constructor)(props) | Alpha |
Constructs a new instance of the TreeViewConfigurationAlpha class |
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. |
Constructor Details
(constructor)
Constructs a new instance of the TreeViewConfigurationAlpha class
This API is provided as an alpha preview and may change without notice.
For more information about our API support guarantees, see here.
Signature
constructor(props: ITreeViewConfiguration<TSchema>);
Parameters
| Parameter | Type | Description |
|---|---|---|
| props | ITreeViewConfiguration<TSchema> |
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