@jsfkit/types
    Preparing search index...

    Type Alias ChartAxisCrossing

    ChartAxisCrossing: (
        | { type: "auto" }
        | { type: "min" }
        | { type: "max" }
        | { type: "value"; value: number }
    ) & { axis?: string }

    Which perpendicular axis an axis crosses, and where. The position is measured on the crossed axis: min and max are its ends, and value is a value on its scale.

    Type Declaration

    • { type: "auto" }
      • type: "auto"

        Crosses at zero on the crossed axis, or at its end nearest zero when zero is outside its range. On a category axis, this is the start of the axis.

    • { type: "min" }
      • type: "min"

        Crosses at the crossed axis's minimum.

    • { type: "max" }
      • type: "max"

        Crosses at the crossed axis's maximum.

    • { type: "value"; value: number }
      • type: "value"

        Crosses at a value on the crossed axis's scale.

      • value: number

        The value to cross at, on the crossed axis's scale. For a category axis, this is a category number, counting from 1.

    • Optionalaxis?: string

      The axis that this axis crosses, named by its id. When absent, it's the other axis of the same plot: a plot's value axis crosses its category (or x) axis, and its category, x, and depth axes cross its value axis.

    Settings

    Member Visibility