ITreeViewConfigurationAlpha Interface

Property-bag configuration for TreeViewConfigurationAlpha construction.

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.

Input

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 ITreeViewConfigurationAlpha<TSchema extends ImplicitFieldSchema = ImplicitFieldSchema> extends ITreeViewConfiguration<TSchema>

Extends: ITreeViewConfiguration<TSchema>

Type Parameters

Parameter	Constraint	Default	Description
TSchema	ImplicitFieldSchema	ImplicitFieldSchema

Properties

Property	Alerts	Modifiers	Default Value	Type	Description
stagedUpgradePolicy	Alpha	optional, readonly	restrictive	StagedSchemaUpgradePolicy	Policy for generating stored schema from the view schema during staged schema upgrades.

Property Details

stagedUpgradePolicy

Policy for generating stored schema from the view schema during staged schema upgrades.

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 stagedUpgradePolicy?: StagedSchemaUpgradePolicy;

Type: StagedSchemaUpgradePolicy

Remarks

If provided, this policy is used when generating stored schema to include in documents via initialize / upgradeSchema as well as in snapshotSchemaCompatibility(options) to validate the compatibility of such documents.

Example

Enabling specific staged upgrades

const config = new TreeViewConfigurationAlpha({
  schema: MySchema,
  stagedUpgradePolicy: StagedSchemaUpgradePolicy.enabledStagedUpgrades(myUpgrade),
});