Skip to main content

LabelTree Interface

A tree representing the nesting structure of transaction labels.

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 interface LabelTree

Remarks

Each transaction contributes a node whose label is its label (or undefined if no label was provided). When transactions are nested, inner transaction nodes become sublabels of outer ones.

Properties

PropertyAlertsTypeDescription
labelAlphaunknownThe label for this transaction, or undefined if no label was provided.
sublabelsAlphaLabelTree[]The label trees of any nested transactions within this one.

Property Details

label

The label for this transaction, or undefined if no label was provided.

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

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

Signature

label: unknown;

Type: unknown

sublabels

The label trees of any nested transactions within this one.

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

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

Signature

sublabels: LabelTree[];

Type: LabelTree[]