@deephaven/jsapi-types
    Preparing search index...

    Interface ColumnStatistics

    Represents statistics for a given table column.

    Statistics are exposed via ColumnStatistics.statisticsMap, keyed by display name (for example, "COUNT" or "AVG"). For each statistic name, ColumnStatistics.getType() returns the expected type name for formatting purposes, or null to indicate that the column's formatting should be used.

    If present, ColumnStatistics.uniqueValues returns a map of unique values (as strings) to their occurrence counts.

    interface ColumnStatistics {
        get statisticsMap(): Map<string, object>;
        get uniqueValues(): Map<string, number>;
        getType(name: string): string;
    }
    Index
    • get statisticsMap(): Map<string, object>

      Gets a map of each statistic's display name to its value.

      Returns Map<string, object>

      Map of String and Object

    • get uniqueValues(): Map<string, number>

      Gets a map of each unique value's name to the count of how many times it occurred in the column. This map will be empty for tables containing more than 19 unique values.

      Returns Map<string, number>

      Map of String double

    • Gets the type of formatting that should be used for given statistic. A null return value means that the column formatting should be used.

      Parameters

      • name: string

        the display name of the statistic

      Returns string

      String