@jsfkit/types
    Preparing search index...

    Type Alias ChartTransformBoxplot

    ChartTransformBoxplot: ChartTransformBase & {
        as?: {
            max?: string;
            mean?: string;
            median?: string;
            min?: string;
            q1?: string;
            q3?: string;
        };
        field: string;
        groupBy?: string[];
        quartileMethod?: "inclusive"
        | "exclusive";
        type: "boxplot";
    }

    Computes quartiles, whiskers, and outliers for box and whisker charts.

    Type Declaration

    • Optionalas?: {
          max?: string;
          mean?: string;
          median?: string;
          min?: string;
          q1?: string;
          q3?: string;
      }

      Names of the generated fields. A name that's absent is the same as its key, such as q1.

      • Optionalmax?: string

        The field that receives the end of the upper whisker: the largest value that isn't an outlier.

      • Optionalmean?: string

        The field that receives the mean of all the values, outliers included.

      • Optionalmedian?: string

        The field that receives the median.

      • Optionalmin?: string

        The field that receives the end of the lower whisker: the smallest value that isn't an outlier.

      • Optionalq1?: string

        The field that receives the first quartile.

      • Optionalq3?: string

        The field that receives the third quartile.

    • field: string

      The field holding the values to compute statistics for.

    • OptionalgroupBy?: string[]

      Fields to compute statistics for separately, for example ['series', 'category']. When absent, all records are one group.

    • OptionalquartileMethod?: "inclusive" | "exclusive"

      Whether quartiles include or exclude the median.

      "exclusive"
      
    • type: "boxplot"

      Computes box and whisker statistics.