TreeViewConfigurationAlpha Class
TreeViewConfiguration extended with some alpha APIs.
To use, import via fluid-framework/alpha.
For more information about our API support guarantees, see here.
This type is "sealed," meaning that code outside of the library defining it should not implement or extend it. Future versions of this type may add members or make typing of readonly members more specific.
Signature
/** @sealed */
export declare class TreeViewConfigurationAlpha<const TSchema extends ImplicitFieldSchema = ImplicitFieldSchema> extends TreeViewConfiguration<TSchema> implements TreeSchema
Extends: TreeViewConfiguration<TSchema>
Implements: TreeSchema
Type Parameters
| Parameter | Constraint | Default | Description |
|---|---|---|---|
| TSchema | ImplicitFieldSchema | ImplicitFieldSchema |
Remarks
See asAlpha(view) for an API to downcast from TreeViewConfiguration to this type.
Constructors
| Constructor | Alerts | Description |
|---|---|---|
| (constructor)(props) | Alpha | Constructs a new instance of the TreeViewConfigurationAlpha class |
Properties
| Property | Alerts | Modifiers | Type | Description |
|---|---|---|---|---|
| definitions | Alpha | readonly | ReadonlyMap<string, SimpleNodeSchema<SchemaType.View> & TreeNodeSchema> | |
| root | Alpha | readonly | FieldSchemaAlpha | |
| stagedUpgradePolicy | Alpha | readonly | StagedSchemaUpgradePolicy | Policy for generating stored schema from the view schema during staged schema upgrades. |
Constructor Details
(constructor)
Constructs a new instance of the TreeViewConfigurationAlpha class
For more information about our API support guarantees, see here.
Signature
constructor(props: ITreeViewConfigurationAlpha<TSchema>);
Parameters
| Parameter | Type | Description |
|---|---|---|
| props | ITreeViewConfigurationAlpha<TSchema> |
Property Details
definitions
For more information about our API support guarantees, see here.
Signature
readonly definitions: ReadonlyMap<string, SimpleNodeSchema<SchemaType.View> & TreeNodeSchema>;
Type: ReadonlyMap<string, SimpleNodeSchema<SchemaType.View> & TreeNodeSchema>
root
For more information about our API support guarantees, see here.
Signature
readonly root: FieldSchemaAlpha;
Type: FieldSchemaAlpha
stagedUpgradePolicy
Policy for generating stored schema from the view schema during staged schema upgrades.
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.