Visualization
    Preparing search index...

    Interface DataViewHierarchy

    Represents a hierarchy for a DataViewCategoricalAxis.

    interface DataViewHierarchy {
        isEmpty: boolean;
        leafCount: number;
        levels: DataViewHierarchyLevel[];
        name: string;
        root(
            abortPredicate?: AbortPredicate,
        ): Promise<null | DataViewHierarchyNode>;
    }
    Index

    Properties

    isEmpty leafCount levels name

    Methods

    root

    Properties

    isEmpty: boolean

    Gets a value indicating whether the hierarchy is empty, i.e. the axis expression is empty, or not. For convenience, an empty hierarchy will have one single node that may contain all rows in the dataview.

    leafCount: number

    Gets the total number of leaf nodes in the hierarchy.

    levels: DataViewHierarchyLevel[]

    Gets the levels of this hierarchy. The root node has no corresponding level.

    name: string

    Gets the name of this hierarchy, the same as the associated DataViewCategoricalAxis.

    Methods

    • Gets the virtual root node of the hierarchy. The level of the root node is -1. Spotfire does not usually render the root node in visualization.

      Parameters

      • OptionalabortPredicate: AbortPredicate

        Optional. Predicate to determine whether the operation should be aborted when there is new, non-streaming, data available. If this predicate returns true the promise will be rejected. The default behavior is that reading will be aborted when new non-streaming update is available.

      Returns Promise<null | DataViewHierarchyNode>

      null if reading data was aborted, otherwise a DataViewHierarchyNode.

    Settings

    Member Visibility

    On This Page

    Properties
    Methods