MAIDR JavaScript API
    Preparing search index...

    Interface GanttData

    A gantt chart: its lanes, and how its axis reads.

    An object rather than a bare array, for the reason DumbbellData is one: a unit belongs to the chart and not to any row, and repeating it per point would let a producer emit rows that disagree about what their numbers measure.

    interface GanttData {
        points: GanttPoint[][];
        lanes?: (string | number)[];
        unit?: string;
        inclusive?: boolean;
        wrap?: number;
        firstLane?: "top" | "bottom";
    }
    Index

    Properties

    points: GanttPoint[][]

    The lanes, in the order the chart draws them, each holding the intervals of one lane.

    Either end may come first. On a chart whose bars run left to right, Up and Down follow the drawing: when the first lane is drawn above the last, Down moves to the next lane, and when it is drawn below, Up does. Which it is is measured from the highlight, or read from GanttData.firstLane where there is nothing to measure.

    Nested rather than flat so a lane with no intervals still exists: an empty row is a real statement about a schedule -- nothing is booked -- and a flat list grouped by x cannot say it.

    lanes?: (string | number)[]

    What each lane is called, in the order GanttData.points holds them.

    A populated lane names itself: every interval carries its lane in x. An empty lane holds no interval and so has nowhere to carry one, which makes it the only row a reader can navigate onto and be told nothing about -- and an empty lane is exactly the row this shape is nested to be able to express. This is where its name goes.

    Optional, and optional per entry: a chart with no empty lanes need not supply it, and the trace prefers a lane's own intervals over this when both are present, so a producer cannot make the two disagree about a populated lane.

    unit?: string

    What a unit of the axis is called: "days", "hours", "weeks".

    The length of an interval is the fact a gantt exists to carry, and a bare number does not carry it. Omitted, the trace announces the length without a unit rather than guessing one.

    A unit of time named in English -- seconds, minutes, hours, days or weeks, or one of them in the singular, in any case -- is read in the reader's language, as MAIDR's own words are, and in the singular for a length of one: "1 day", "3 Tage". Any other word is read as written.

    inclusive?: boolean

    Whether an interval's end is the last unit it covers rather than the point where it stops: a packet field written 0-15 covers 16 bits and ends on bit 15.

    Set, an interval is measured as end - start + 1 and announced with the end it was given, so the length and the ends both say what the chart draws. Omitted, end is the boundary, as a schedule's is.

    wrap?: number

    How many units of the axis one lane is drawn across, when the lanes are one axis folded into rows rather than lanes sharing an axis: a packet diagram's 32 bits a row.

    Stereo position then follows where an interval starts within its row, which is where it is drawn, rather than along the whole axis, so two intervals drawn one above the other sound in the same place. Omitted, the lanes share one axis, as a schedule's do.

    firstLane?: "top" | "bottom"

    Which end of the chart the first lane is drawn at, for a schedule whose bars run left to right and whose drawing MAIDR cannot measure: one drawn to a canvas, or one whose bars no highlight resolved. 'top' when the first lane is drawn at the top, as most schedules are; 'bottom' when it is drawn at the bottom.

    Where MAIDR can measure the drawing it does, and this is not read. Omitted where nothing can be measured, the first lane is taken to be at the bottom, as row 0 of a grid is, and Up moves to the next lane.