Documentation / @ripl/charts / GanttChartOptions
Interface: GanttChartOptions<TData> ​
Defined in: charts/src/charts/gantt.ts:94
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:128 |
autoRender? | boolean | Whether the chart renders automatically on construction and after every Chart.update. Defaults to true. | BaseChartOptions.autoRender | charts/src/core/chart.ts:122 |
axis? | ChartAxisInput<TData> | Axis configuration for the category and time axes. | - | charts/src/charts/gantt.ts:120 |
borderRadius? | number | Corner radius in pixels applied to each task bar. Defaults to 3. | - | charts/src/charts/gantt.ts:128 |
colorBy? | keyof TData | ((item) => string) | Optional per-item color accessor; falls back to the generated palette. | - | charts/src/charts/gantt.ts:106 |
data | TData[] | The tasks rendered as time-spanning bars. | - | charts/src/charts/gantt.ts:96 |
dependencies? | keyof TData | ((item) => string[]) | Accessor for the keys of the tasks each task depends on. When provided, a curved connector is drawn from every predecessor task's end to this task's start (finish-to-start). Return an empty array, or omit the option entirely, for a task with no dependencies. | - | charts/src/charts/gantt.ts:114 |
description? | string | Accessible description announced by screen readers (sets the rendering element's ARIA label). Defaults to the title text. | BaseChartOptions.description | charts/src/core/chart.ts:132 |
end | keyof TData | ((item) => Date) | Accessor for each task's end date. | - | charts/src/charts/gantt.ts:104 |
format? | ValueFormatInput | Format applied to the numeric progress value shown in the task tooltip. Defaults to a percentage. | - | charts/src/charts/gantt.ts:122 |
grid? | ChartGridInput | Background grid configuration (true/false or detailed grid options). | - | charts/src/charts/gantt.ts:116 |
key | keyof TData | ((item) => string) | Accessor for each task's unique key (used for color assignment and data joins). | - | charts/src/charts/gantt.ts:98 |
label | keyof TData | ((item) => string) | Accessor for each task's label shown on the category axis. | - | charts/src/charts/gantt.ts:100 |
padding? | PaddingInput | Space reserved around the chart, in pixels. A single number applies to all four edges; a [top, right, bottom, left] tuple or a partial { top, right, bottom, left } object sets individual edges, leaving unspecified edges at the default. Defaults to 16. | BaseChartOptions.padding | charts/src/core/chart.ts:124 |
progress? | NumericAccessor<TData> | Accessor for each task's completion ratio (0–1), drawn as a progress overlay. | - | charts/src/charts/gantt.ts:108 |
showToday? | boolean | Draw a marker line at the current date. Defaults to true. | - | charts/src/charts/gantt.ts:124 |
start | keyof TData | ((item) => Date) | Accessor for each task's start date. | - | charts/src/charts/gantt.ts:102 |
theme? | string | Theme | Theme for this chart: a registered name ('light'/'dark'/'auto'), or a Theme. Falls back to the module default (see setDefaultTheme). | BaseChartOptions.theme | charts/src/core/chart.ts:130 |
title? | string | Partial<ChartTitleOptions> | Chart title as plain text, or a ChartTitleOptions object for full control. | BaseChartOptions.title | charts/src/core/chart.ts:126 |
todayColor? | string | Color of the "today" marker line. | - | charts/src/charts/gantt.ts:126 |
tooltip? | ChartTooltipInput | Hover tooltip configuration (true/false or detailed tooltip options). | - | charts/src/charts/gantt.ts:118 |