Skip to main content

SummaryTreeBuilder Class

A helper class for building summary trees.

WARNING: This API is provided as an alpha preview and may change without notice. Use at your own risk.

Signature​

export declare class SummaryTreeBuilder implements ISummaryTreeWithStats

Implements: ISummaryTreeWithStats

Remarks​

Uses the builder pattern.

Constructors​

Constructor Alerts Description
(constructor)(params) Alpha Constructs a new instance of the SummaryTreeBuilder class

Properties​

Property Alerts Modifiers Type Description
stats Alpha readonly Readonly<ISummaryStats>
summary Alpha readonly ISummaryTree

Constructor Details​

(constructor)​

Constructs a new instance of the SummaryTreeBuilder class

WARNING: This API is provided as an alpha preview and may change without notice. Use at your own risk.

Signature​

constructor(params?: {
        groupId?: string;
    });

Parameters​

Parameter Modifiers Type Description
params optional { groupId?: string; }

Property Details​

stats​

WARNING: This API is provided as an alpha preview and may change without notice. Use at your own risk.

Signature​

get stats(): Readonly<ISummaryStats>;

Type: Readonly<ISummaryStats>

summary​

WARNING: This API is provided as an alpha preview and may change without notice. Use at your own risk.

Signature​

get summary(): ISummaryTree;

Type: ISummaryTree