ViewContent Interface

The portion of SharedTree data typically persisted by the container. Usable with independentInitializedView(config, options, content) to create a TreeView without loading a container.

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

export interface ViewContent

Properties

Property	Alerts	Modifiers	Type	Description
idCompressor	Alpha	readonly	IIdCompressor	IIdCompressor which will be used to decompress any compressed identifiers in tree as well as for any other identifiers added to the view.
schema	Alpha	readonly	JsonCompatible	Persisted schema from extractPersistedSchema(schema, minVersionForCollab, includeStaged).
tree	Alpha	readonly	JsonCompatible<IFluidHandle>	Compressed tree from exportCompressed(tree, options).

Property Details

idCompressor

IIdCompressor which will be used to decompress any compressed identifiers in tree as well as for any other identifiers added to the view.

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 idCompressor: IIdCompressor;

Type: IIdCompressor

schema

Persisted schema from extractPersistedSchema(schema, minVersionForCollab, includeStaged).

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 schema: JsonCompatible;

Type: JsonCompatible

tree

Compressed tree from exportCompressed(tree, options).

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 tree: JsonCompatible<IFluidHandle>;

Type: JsonCompatible<IFluidHandle>

Remarks

This is an owning reference: consumers of this content might modify this data in place (for example when applying edits) to avoid copying.