Skip to main content

TreeViewAlpha Interface

TreeView with proposed changes to the schema aware typing to allow use with UnsafeUnknownSchema.

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 TreeViewAlpha<in out TSchema extends ImplicitFieldSchema | UnsafeUnknownSchema> extends Omit<TreeView<ReadSchema<TSchema>>, "root" | "initialize">, TreeBranch

Extends: Omit<TreeView<ReadSchema<TSchema>>, "root" | "initialize">, TreeBranch

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​

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​

readonly events: Listenable<TreeViewEvents & TreeBranchEvents>;

Type: Listenable<TreeViewEvents & TreeBranchEvents>

root​

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​

get root(): ReadableField<TSchema>;
set root(newRoot: InsertableField<TSchema>);

Type: ReadableField<TSchema>

Method Details​

fork​

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​

fork(): ReturnType<TreeBranch["fork"]> & TreeViewAlpha<TSchema>;

Returns​

Return type: ReturnType<TreeBranch["fork"]> & TreeViewAlpha<TSchema>

initialize​

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​

initialize(content: InsertableField<TSchema>): void;

Parameters​

Parameter Type Description
content InsertableField<TSchema>