TreeViewAlpha Interface
TreeView with proposed changes to the schema aware typing to allow use with UnsafeUnknownSchema. \
To use, import via fluid-framework/alpha.
For more information about our API support guarantees, see here.
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 TreeViewAlpha<in out TSchema extends ImplicitFieldSchema | UnsafeUnknownSchema> extends Omit<TreeViewBeta<ReadSchema<TSchema>>, "root" | "initialize" | "fork">, TreeBranchAlpha
Extends: Omit<TreeViewBeta<ReadSchema<TSchema>>, "root" | "initialize" | "fork">, TreeBranchAlpha
Type Parameters
| Parameter | Constraint | Description |
|---|---|---|
| TSchema | ImplicitFieldSchema | UnsafeUnknownSchema |
Properties
| Property | Alerts | Modifiers | Type | Description |
|---|---|---|---|---|
| events | Alpha | readonly | Listenable<TreeViewEvents & TreeBranchEvents> | |
| root | Alpha | ReadableField<TSchema> |
Methods
| Method | Alerts | Return Type | Description |
|---|---|---|---|
| fork() | Alpha | ReturnType<TreeBranch["fork"]> & TreeViewAlpha<TSchema> | |
| initialize(content) | Alpha | void |
Property Details
events
For more information about our API support guarantees, see here.
Signature
readonly events: Listenable<TreeViewEvents & TreeBranchEvents>;
Type: Listenable<TreeViewEvents & TreeBranchEvents>
root
For more information about our API support guarantees, see here.
Signature
get root(): ReadableField<TSchema>;
set root(newRoot: InsertableField<TSchema>);
Type: ReadableField<TSchema>
Method Details
fork
For more information about our API support guarantees, see here.
Signature
fork(): ReturnType<TreeBranch["fork"]> & TreeViewAlpha<TSchema>;
Returns
Return type: ReturnType<TreeBranch["fork"]> & TreeViewAlpha<TSchema>
initialize
For more information about our API support guarantees, see here.
Signature
initialize(content: InsertableField<TSchema>): void;
Parameters
| Parameter | Type | Description |
|---|---|---|
| content | InsertableField<TSchema> |