Skip to main content

TreeViewConfigurationAlpha Class

TreeViewConfiguration extended with some alpha APIs.

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.

Sealed

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

ParameterConstraintDefaultDescription
TSchemaImplicitFieldSchemaImplicitFieldSchema

Remarks

See asAlpha(view) for an API to downcast from TreeViewConfiguration to this type.

Constructors

ConstructorAlertsDescription
(constructor)(props)AlphaConstructs a new instance of the TreeViewConfigurationAlpha class

Properties

PropertyAlertsModifiersTypeDescription
definitionsAlphareadonlyReadonlyMap<string, SimpleNodeSchema<SchemaType.View> & TreeNodeSchema>
rootAlphareadonlyFieldSchemaAlpha

Constructor Details

(constructor)

Constructs a new instance of the TreeViewConfigurationAlpha class

This API is provided as an alpha preview and may change without notice.

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

Signature

constructor(props: ITreeViewConfiguration<TSchema>);

Parameters

ParameterTypeDescription
propsITreeViewConfiguration<TSchema>

Property Details

definitions

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 definitions: ReadonlyMap<string, SimpleNodeSchema<SchemaType.View> & TreeNodeSchema>;

Type: ReadonlyMap<string, SimpleNodeSchema<SchemaType.View> & TreeNodeSchema>

root

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 root: FieldSchemaAlpha;

Type: FieldSchemaAlpha