SheetXL - v1.0.2
    Preparing search index...

    Interface CategoryAxisLayout

    A category axis, or a date axis: one category per day, month or year from its first date to its last, each point in its date's, and labels on the major ticks only.

    interface CategoryAxisLayout {
        categories: string[];
        crossAxisId: number;
        crossBetween: "between" | "midCat";
        deleted: boolean;
        dividers?: Segment[];
        gridlines?: Segment[];
        id: number;
        kind: "category";
        labelFont: RunPropertiesJSON | null;
        labelLineHeight: number;
        labelMargin: number;
        labelRotation: number;
        labels: (string | null)[];
        labelsAt?: number;
        labelVertical?: boolean;
        levels?: CategoryLevelLayout[];
        line: IStroke.JSON | null;
        lineAt: number;
        majorGridlines: IStroke.JSON | null;
        position: AxisPosition;
        reversed: boolean;
        tickLength: number;
        tickMark: "none" | "in" | "cross" | "out";
        title: TextLayout | null;
        unitLabel?: TextLayout;
    }

    Hierarchy (View Summary)

    Index
    categories: string[]

    One label per category, formatted.

    crossAxisId: number

    The id of the axis this one crosses.

    crossBetween: "between" | "midCat"

    Whether the crossing axis crosses between categories (bands) or on them.

    deleted: boolean

    The axis is laid out, so its series have a scale, but nothing of it is drawn.

    dividers?: Segment[]

    Multi-level categories: the lines that part groups of categories, drawn in the axis line's stroke in place of tick marks, at the plot's ends and between groups, from the axis line out through the levels they part.

    gridlines?: Segment[]

    The major gridlines, in px: a line across the plot at each tick of a value axis, and between categories (or on them, midCat) of a category axis. Absent when the axis shows none.

    id: number

    The axis's id in the chart (axId).

    kind: "category"
    labelFont: RunPropertiesJSON | null

    null when the axis shows no labels.

    labelLineHeight: number

    The distance between a label's lines, in px.

    labelMargin: number

    Between the axis line and the near edge of its labels, in px.

    labelRotation: number

    The angle the labels are drawn at, in degrees counterclockwise. A label turned up ends with its top right corner on its category's center; turned down, it starts there with its top left corner. A level label is centered on its category.

    labels: (string | null)[]

    One per category, its label as drawn: its lines joined by \n, ending in … when cut short; null for a category whose label is not shown.

    labelsAt?: number

    Where the labels and tick marks are, in px as lineAt, where they do not go with the line: at the plot's low or high edge (tickLblPos low or high, a 2016 chart's categories) while the line crosses the other axis inside the plot. Absent where they go with the line.

    labelVertical?: boolean

    The labels are stacked letter over letter (vert="wordArtVert"): each label's letters are joined by \n, labelLineHeight apart. Along the bottom or top a label too tall for half the plot's outer height breaks into columns, joined by \t, side by side.

    Multi-level categories: the levels beyond labels, the nearest the axis first. Absent when the axis draws one level.

    line: IStroke.JSON | null
    lineAt: number

    Where the axis line is, in px: the y of a horizontal axis, the x of a vertical one. On the plot area's edge named by position, unless the axis crosses the other inside the plot (a scatter's x axis at y = 0 when the y values straddle zero). Labels and tick marks go with it.

    majorGridlines: IStroke.JSON | null
    position: AxisPosition
    reversed: boolean

    The axis runs from its maximum to its minimum (orientation maxMin): a vertical axis down, a horizontal one right to left. A reversed category axis puts the first category at the top or the right, and mirrors each cluster.

    tickLength: number

    In px.

    tickMark: "none" | "in" | "cross" | "out"
    title: TextLayout | null
    unitLabel?: TextLayout

    The display unit label (dispUnitsLbl) of an axis whose values are shown in a unit, beside its title.