TreeDataStoreOptions Interface
Options for defineTreeDataStore(options).
To use, import via @fluidframework/tree/alpha.
For more information about our API support guarantees, see here.
This type is "input," meaning that code outside of the library defining it should not read from it. Future versions of this type may add optional members or make typing of members more general.
Signature
export interface TreeDataStoreOptions<TSchema extends ImplicitFieldSchema> extends Pick<DataStoreOptions<never, never>, "type">
Extends: Pick<DataStoreOptions<never, never>, "type">
Type Parameters
| Parameter | Constraint | Description |
|---|---|---|
| TSchema | ImplicitFieldSchema |
Properties
| Property | Alerts | Modifiers | Type | Description |
|---|---|---|---|---|
| config | Alpha | readonly | TreeViewConfiguration<TSchema> | Configuration for the tree view to be used in this data store. |
| initializer | Alpha | optional, readonly | (creator: SharedObjectCreator) => InsertableTreeFieldFromImplicitField<TSchema> | If provided, used to initialize the tree content when creating a new instance of the data store. |
| key | Alpha | optional, readonly | SharedObjectKey<ITree> | |
| registry | Alpha | optional, readonly | Iterable<SharedObjectKindAlpha<IFluidLoadable>> | SharedObjectRegistry | If provided, must include at least a SharedTree kind in the registry. |
Property Details
config
Configuration for the tree view to be used in this data store.
For more information about our API support guarantees, see here.
Signature
readonly config: TreeViewConfiguration<TSchema>;
Type: TreeViewConfiguration<TSchema>
initializer
If provided, used to initialize the tree content when creating a new instance of the data store.
For more information about our API support guarantees, see here.
Signature
readonly initializer?: (creator: SharedObjectCreator) => InsertableTreeFieldFromImplicitField<TSchema>;
Type: (creator: SharedObjectCreator) => InsertableTreeFieldFromImplicitField<TSchema>
key
For more information about our API support guarantees, see here.
Signature
readonly key?: SharedObjectKey<ITree>;
Type: SharedObjectKey<ITree>
registry
If provided, must include at least a SharedTree kind in the registry.
For more information about our API support guarantees, see here.
Signature
readonly registry?: Iterable<SharedObjectKindAlpha<IFluidLoadable>> | SharedObjectRegistry;
Type: Iterable<SharedObjectKindAlpha<IFluidLoadable>> | SharedObjectRegistry
Remarks
configuredSharedTree can be used to customize the SharedTree kind used in the registry.