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 fluid-framework/alpha.

For more information about our API support guarantees, see here.

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	Type	Description
stagedUpgradePolicy	Alpha	optional, readonly	StagedSchemaUpgradePolicy	Policy for generating stored schema from the view schema.

Property Details

stagedUpgradePolicy

Policy for generating stored schema from the view schema.

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 omitted or undefined, defaults to restrictive which does not enable any staged schema upgrades.

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),
});