Documentation / @ripl/charts / GanttChartOptions
Interface: GanttChartOptions<TData>
Defined in: charts/src/charts/gantt.ts:77
Options for configuring a GanttChart.
Extends
Type Parameters
| Type Parameter | Default type |
|---|---|
TData | unknown |
Properties
| Property | Type | Description | Inherited from | Defined in |
|---|---|---|---|---|
animation? | boolean | Partial<ChartAnimationOptions> | Animation configuration, or a boolean toggling all transitions. See ChartAnimationOptions. | BaseChartOptions.animation | charts/src/core/chart.ts:89 |
autoRender? | boolean | Whether the chart renders automatically on construction and after every Chart.update. Defaults to true. | BaseChartOptions.autoRender | charts/src/core/chart.ts:83 |
axis? | ChartAxisInput<TData> | Axis configuration for the category and time axes. | - | charts/src/charts/gantt.ts:97 |
borderRadius? | number | Corner radius in pixels applied to each task bar. Defaults to 3. | - | charts/src/charts/gantt.ts:103 |
color? | keyof TData | ((item) => string) | Accessor for an explicit per-task colour; falls back to the generated palette. | - | charts/src/charts/gantt.ts:89 |
data | TData[] | The tasks rendered as time-spanning bars. | - | charts/src/charts/gantt.ts:79 |
end | keyof TData | ((item) => Date) | Accessor for each task's end date. | - | charts/src/charts/gantt.ts:87 |
grid? | ChartGridInput | Background grid configuration (true/false or detailed grid options). | - | charts/src/charts/gantt.ts:93 |
key | keyof TData | ((item) => string) | Accessor for each task's unique key (used for colour assignment and data joins). | - | charts/src/charts/gantt.ts:81 |
label | keyof TData | ((item) => string) | Accessor for each task's label shown on the category axis. | - | charts/src/charts/gantt.ts:83 |
padding? | Partial<ChartPadding> | Space reserved around the chart, per edge, in pixels. | BaseChartOptions.padding | charts/src/core/chart.ts:85 |
progress? | NumericAccessor<TData> | Accessor for each task's completion ratio (0–1), drawn as a progress overlay. | - | charts/src/charts/gantt.ts:91 |
showToday? | boolean | Draw a marker line at the current date. Defaults to true. | - | charts/src/charts/gantt.ts:99 |
start | keyof TData | ((item) => Date) | Accessor for each task's start date. | - | charts/src/charts/gantt.ts:85 |
title? | string | Partial<ChartTitleOptions> | Chart title as plain text, or a ChartTitleOptions object for full control. | BaseChartOptions.title | charts/src/core/chart.ts:87 |
todayColor? | string | Colour of the "today" marker line. | - | charts/src/charts/gantt.ts:101 |
tooltip? | ChartTooltipInput | Hover tooltip configuration (true/false or detailed tooltip options). | - | charts/src/charts/gantt.ts:95 |