MAIDR Documentation - v4.4.0
    Preparing search index...

    Interface GanttChartConfig

    Configuration for gantt charts, timelines and swimlane diagrams. Optional when chartType is 'gantt'.

    One data row is one interval: xKey names its lane and the two yKeys entries its start and end, both as positions on the same numeric axis. Dates therefore have to arrive as epoch milliseconds — a Date is not a position, and a length in milliseconds needs unit to read as one.

    interface GanttChartConfig {
        lanes?: (string | number)[];
        labelKey?: string;
        unit?: string;
    }
    Index

    Properties

    lanes?: (string | number)[]

    The lanes, in the order the chart draws them.

    Declared rather than derived so an EMPTY lane survives: nothing booked is a real statement about a schedule, and a lane with no rows cannot name itself. A lane a row names but this list omits is appended at the end rather than dropped.

    labelKey?: string

    Key holding what an individual interval is called, when its lane is not already its name. A lane commonly holds several — a resource booked twice, a phase that pauses — and without this they are announced by position alone.

    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.