Docs Charts Timeline

TimelineChart

import { TimelineChart } from "@grassroot/charts-react";
 
const timeline = [
  {
    id: "research",
    label: "Customer research",
    start: "2026-01-12",
    end: "2026-02-06",
    lane: "Discovery",
  },
  {
    id: "prototype",
    label: "Workflow prototype",
    start: "2026-02-09",
    end: "2026-03-06",
    lane: "Discovery",
  },
  {
    id: "synthesis",
    label: "Research synthesis",
    start: "2026-03-02",
    end: "2026-03-20",
    lane: "Discovery",
  },
  {
    id: "beta",
    label: "Private beta",
    start: "2026-03-09",
    end: "2026-04-24",
    lane: "Delivery",
  },
  {
    id: "migration",
    label: "Customer migration",
    start: "2026-04-13",
    end: "2026-06-26",
    lane: "Delivery",
  },
  {
    id: "warehouse",
    label: "Warehouse cutover",
    start: "2026-05-11",
    end: "2026-08-14",
    lane: "Delivery",
  },
  {
    id: "pilot",
    label: "Partner pilot",
    start: "2026-07-06",
    end: "2026-09-18",
    lane: "Enablement",
  },
  {
    id: "academy",
    label: "Docs and academy",
    start: "2026-08-17",
    end: "2026-10-30",
    lane: "Enablement",
  },
  {
    id: "playbooks",
    label: "Support playbooks",
    start: "2026-09-07",
    end: "2026-10-16",
    lane: "Enablement",
  },
  {
    id: "eu-launch",
    label: "EU regional launch",
    start: "2026-09-21",
    end: "2026-10-30",
    lane: "Rollout",
  },
  {
    id: "us-launch",
    label: "US regional launch",
    start: "2026-10-12",
    end: "2026-11-20",
    lane: "Rollout",
  },
  {
    id: "ga",
    label: "General availability",
    start: "2026-12-01",
    lane: "Rollout",
    milestone: true,
  },
];
 
export default function TimelineChartDemo() {
  return (
    <div>
      <TimelineChart ariaLabel="Customer data platform rollout across discovery, delivery, enablement, and launch, 2026" items={timeline} />
    </div>
  );
}

<script setup lang="ts">
import { TimelineChart } from "@grassroot/charts-vue";
 
const timeline = [
  {
    id: "research",
    label: "Customer research",
    start: "2026-01-12",
    end: "2026-02-06",
    lane: "Discovery",
  },
  {
    id: "prototype",
    label: "Workflow prototype",
    start: "2026-02-09",
    end: "2026-03-06",
    lane: "Discovery",
  },
  {
    id: "synthesis",
    label: "Research synthesis",
    start: "2026-03-02",
    end: "2026-03-20",
    lane: "Discovery",
  },
  {
    id: "beta",
    label: "Private beta",
    start: "2026-03-09",
    end: "2026-04-24",
    lane: "Delivery",
  },
  {
    id: "migration",
    label: "Customer migration",
    start: "2026-04-13",
    end: "2026-06-26",
    lane: "Delivery",
  },
  {
    id: "warehouse",
    label: "Warehouse cutover",
    start: "2026-05-11",
    end: "2026-08-14",
    lane: "Delivery",
  },
  {
    id: "pilot",
    label: "Partner pilot",
    start: "2026-07-06",
    end: "2026-09-18",
    lane: "Enablement",
  },
  {
    id: "academy",
    label: "Docs and academy",
    start: "2026-08-17",
    end: "2026-10-30",
    lane: "Enablement",
  },
  {
    id: "playbooks",
    label: "Support playbooks",
    start: "2026-09-07",
    end: "2026-10-16",
    lane: "Enablement",
  },
  {
    id: "eu-launch",
    label: "EU regional launch",
    start: "2026-09-21",
    end: "2026-10-30",
    lane: "Rollout",
  },
  {
    id: "us-launch",
    label: "US regional launch",
    start: "2026-10-12",
    end: "2026-11-20",
    lane: "Rollout",
  },
  {
    id: "ga",
    label: "General availability",
    start: "2026-12-01",
    lane: "Rollout",
    milestone: true,
  },
];
</script>
 
<template>
  <TimelineChart aria-label="Customer data platform rollout across discovery, delivery, enablement, and launch, 2026" :items="timeline" />
</template>

import { ChangeDetectionStrategy, Component } from "@angular/core";
import { GrassrootTimelineChart } from "@grassroot/charts-angular";
 
@Component({
  selector: "app-timeline-chart-chart-demo",
  standalone: true,
  imports: [GrassrootTimelineChart],
  changeDetection: ChangeDetectionStrategy.OnPush,
  template: `<grassroot-timeline-chart
    [ariaLabel]="'Customer data platform rollout across discovery, delivery, enablement, and launch, 2026'"
    [items]="timeline"
  />`,
})
export class TimelineChartDemoComponent {
  readonly timeline = [
    {
      id: "research",
      label: "Customer research",
      start: "2026-01-12",
      end: "2026-02-06",
      lane: "Discovery",
    },
    {
      id: "prototype",
      label: "Workflow prototype",
      start: "2026-02-09",
      end: "2026-03-06",
      lane: "Discovery",
    },
    {
      id: "synthesis",
      label: "Research synthesis",
      start: "2026-03-02",
      end: "2026-03-20",
      lane: "Discovery",
    },
    {
      id: "beta",
      label: "Private beta",
      start: "2026-03-09",
      end: "2026-04-24",
      lane: "Delivery",
    },
    {
      id: "migration",
      label: "Customer migration",
      start: "2026-04-13",
      end: "2026-06-26",
      lane: "Delivery",
    },
    {
      id: "warehouse",
      label: "Warehouse cutover",
      start: "2026-05-11",
      end: "2026-08-14",
      lane: "Delivery",
    },
    {
      id: "pilot",
      label: "Partner pilot",
      start: "2026-07-06",
      end: "2026-09-18",
      lane: "Enablement",
    },
    {
      id: "academy",
      label: "Docs and academy",
      start: "2026-08-17",
      end: "2026-10-30",
      lane: "Enablement",
    },
    {
      id: "playbooks",
      label: "Support playbooks",
      start: "2026-09-07",
      end: "2026-10-16",
      lane: "Enablement",
    },
    {
      id: "eu-launch",
      label: "EU regional launch",
      start: "2026-09-21",
      end: "2026-10-30",
      lane: "Rollout",
    },
    {
      id: "us-launch",
      label: "US regional launch",
      start: "2026-10-12",
      end: "2026-11-20",
      lane: "Rollout",
    },
    {
      id: "ga",
      label: "General availability",
      start: "2026-12-01",
      lane: "Rollout",
      milestone: true,
    },
  ];
}
 
export default TimelineChartDemoComponent;

<script lang="ts">
  import { TimelineChart } from "@grassroot/charts-svelte";
 
  const timeline = [
    {
      id: "research",
      label: "Customer research",
      start: "2026-01-12",
      end: "2026-02-06",
      lane: "Discovery",
    },
    {
      id: "prototype",
      label: "Workflow prototype",
      start: "2026-02-09",
      end: "2026-03-06",
      lane: "Discovery",
    },
    {
      id: "synthesis",
      label: "Research synthesis",
      start: "2026-03-02",
      end: "2026-03-20",
      lane: "Discovery",
    },
    {
      id: "beta",
      label: "Private beta",
      start: "2026-03-09",
      end: "2026-04-24",
      lane: "Delivery",
    },
    {
      id: "migration",
      label: "Customer migration",
      start: "2026-04-13",
      end: "2026-06-26",
      lane: "Delivery",
    },
    {
      id: "warehouse",
      label: "Warehouse cutover",
      start: "2026-05-11",
      end: "2026-08-14",
      lane: "Delivery",
    },
    {
      id: "pilot",
      label: "Partner pilot",
      start: "2026-07-06",
      end: "2026-09-18",
      lane: "Enablement",
    },
    {
      id: "academy",
      label: "Docs and academy",
      start: "2026-08-17",
      end: "2026-10-30",
      lane: "Enablement",
    },
    {
      id: "playbooks",
      label: "Support playbooks",
      start: "2026-09-07",
      end: "2026-10-16",
      lane: "Enablement",
    },
    {
      id: "eu-launch",
      label: "EU regional launch",
      start: "2026-09-21",
      end: "2026-10-30",
      lane: "Rollout",
    },
    {
      id: "us-launch",
      label: "US regional launch",
      start: "2026-10-12",
      end: "2026-11-20",
      lane: "Rollout",
    },
    {
      id: "ga",
      label: "General availability",
      start: "2026-12-01",
      lane: "Rollout",
      milestone: true,
    },
  ];
</script>
 
<TimelineChart ariaLabel="Customer data platform rollout across discovery, delivery, enablement, and launch, 2026" items={timeline} />

/** @jsxImportSource solid-js */
import { TimelineChart } from "@grassroot/charts-solid";
 
const timeline = [
  {
    id: "research",
    label: "Customer research",
    start: "2026-01-12",
    end: "2026-02-06",
    lane: "Discovery",
  },
  {
    id: "prototype",
    label: "Workflow prototype",
    start: "2026-02-09",
    end: "2026-03-06",
    lane: "Discovery",
  },
  {
    id: "synthesis",
    label: "Research synthesis",
    start: "2026-03-02",
    end: "2026-03-20",
    lane: "Discovery",
  },
  {
    id: "beta",
    label: "Private beta",
    start: "2026-03-09",
    end: "2026-04-24",
    lane: "Delivery",
  },
  {
    id: "migration",
    label: "Customer migration",
    start: "2026-04-13",
    end: "2026-06-26",
    lane: "Delivery",
  },
  {
    id: "warehouse",
    label: "Warehouse cutover",
    start: "2026-05-11",
    end: "2026-08-14",
    lane: "Delivery",
  },
  {
    id: "pilot",
    label: "Partner pilot",
    start: "2026-07-06",
    end: "2026-09-18",
    lane: "Enablement",
  },
  {
    id: "academy",
    label: "Docs and academy",
    start: "2026-08-17",
    end: "2026-10-30",
    lane: "Enablement",
  },
  {
    id: "playbooks",
    label: "Support playbooks",
    start: "2026-09-07",
    end: "2026-10-16",
    lane: "Enablement",
  },
  {
    id: "eu-launch",
    label: "EU regional launch",
    start: "2026-09-21",
    end: "2026-10-30",
    lane: "Rollout",
  },
  {
    id: "us-launch",
    label: "US regional launch",
    start: "2026-10-12",
    end: "2026-11-20",
    lane: "Rollout",
  },
  {
    id: "ga",
    label: "General availability",
    start: "2026-12-01",
    lane: "Rollout",
    milestone: true,
  },
];
 
export default function TimelineChartDemo() {
  return <TimelineChart ariaLabel="Customer data platform rollout across discovery, delivery, enablement, and launch, 2026" items={timeline} />;
}

Installation

API Reference

Import

import { TimelineChart } from "@grassroot/charts-react";

Props

Prop

Type

Default

Requirement

Description

items

readonly TimelineItem[]

—

required

—

layout

"linear" | "spiral" | undefined

—

optional

—

brushDomain

ChartXDomain | undefined

—

optional

—

defaultBrushDomain

ChartXDomain | undefined

—

optional

—

onBrushDomainChange

((domain: ChartXDomain) => void) | undefined

—

optional

—

zoomDomain

ChartXDomain | undefined

—

optional

—

defaultZoomDomain

ChartXDomain | undefined

—

optional

—

onZoomDomainChange

((domain: ChartXDomain) => void) | undefined

—

optional

—

zoomOnBrush

boolean | undefined

—

optional

—

formatXValue

((value: Date, index: number) => string) | undefined

—

optional

—

locale

string | readonly string[] | undefined

—

optional

—

timeZone

string | undefined

—

optional

—

referenceLines

readonly { value: Date | string | number; label?: string; }[] | undefined

—

optional

—

referenceBands

readonly { from: Date | string | number; to: Date | string | number; label?: string; }[] | undefined

—

optional

—

Prop: items
Type: readonly TimelineItem[]
Default: —
Requirement: required
Description: —

Prop: layout
Type: "linear" | "spiral" | undefined
Default: —
Requirement: optional
Description: —

Prop: brushDomain
Type: ChartXDomain | undefined
Default: —
Requirement: optional
Description: —

Prop: defaultBrushDomain
Type: ChartXDomain | undefined
Default: —
Requirement: optional
Description: —

Prop: onBrushDomainChange
Type: ((domain: ChartXDomain) => void) | undefined
Default: —
Requirement: optional
Description: —

Prop: zoomDomain
Type: ChartXDomain | undefined
Default: —
Requirement: optional
Description: —

Prop: defaultZoomDomain
Type: ChartXDomain | undefined
Default: —
Requirement: optional
Description: —

Prop: onZoomDomainChange
Type: ((domain: ChartXDomain) => void) | undefined
Default: —
Requirement: optional
Description: —

Prop: zoomOnBrush
Type: boolean | undefined
Default: —
Requirement: optional
Description: —

Prop: formatXValue
Type: ((value: Date, index: number) => string) | undefined
Default: —
Requirement: optional
Description: —

Prop: locale
Type: string | readonly string[] | undefined
Default: —
Requirement: optional
Description: —

Prop: timeZone
Type: string | undefined
Default: —
Requirement: optional
Description: —

Prop: referenceLines
Type: readonly { value: Date | string | number; label?: string; }[] | undefined
Default: —
Requirement: optional
Description: —

Prop: referenceBands
Type: readonly { from: Date | string | number; to: Date | string | number; label?: string; }[] | undefined
Default: —
Requirement: optional
Description: —

Prop: legend
Type: boolean | import("@grassroot/chart-spec").LegendConfig | undefined
Default: —
Requirement: optional
Description: —

Prop: tooltip
Type: boolean | import("./base").ExpandedChartTooltipConfig<unknown> | undefined
Default: —
Requirement: optional
Description: —

Prop: animation
Type: boolean | import("./base").ExpandedChartAnimationConfig | undefined
Default: —
Requirement: optional
Description: —

Prop: onHiddenSeriesChange
Type: ((ids: readonly string[]) => void) | undefined
Default: —
Requirement: optional
Description: —

Prop: onActiveDatumChange
Type: ((id: string | null) => void) | undefined
Default: —
Requirement: optional
Description: —

Prop: renderer
Type: ChartRenderer | undefined
Default: —
Requirement: optional
Description: —

Prop: className
Type: string | undefined
Default: —
Requirement: optional
Description: —

Prop: theme
Type: import("@grassroot/theme").PartialChartTheme | undefined
Default: —
Requirement: optional
Description: —

Prop: title
Type: string | undefined
Default: —
Requirement: optional
Description: —

Prop: description
Type: string | undefined
Default: —
Requirement: optional
Description: —

Prop: ariaLabel
Type: string | undefined
Default: —
Requirement: optional
Description: —

Prop: keyboardNavigation
Type: boolean | undefined
Default: —
Requirement: optional
Description: —

Prop: width
Type: number | undefined
Default: —
Requirement: optional
Description: —

Prop: height
Type: number | undefined
Default: —
Requirement: optional
Description: —

Prop: gpuBackend
Type: ChartGpuBackend | undefined
Default: —
Requirement: optional
Description: —

Prop: rendererStrategy
Type: Partial<import("@grassroot/core").ChartRendererStrategy> | undefined
Default: —
Requirement: optional
Description: —

Prop: renderPlanMode
Type: "svg" | "host" | undefined
Default: —
Requirement: optional
Description: —

Prop: showGrid
Type: boolean | undefined
Default: —
Requirement: optional
Description: —

Prop: interactive
Type: boolean | undefined
Default: —
Requirement: optional
Description: Gates every pointer/keyboard interaction the shell owns (hit-test on pointer move, focus-to-first, arrow navigation, Escape) and, with `keyboardNavigation`, whether the plot surface is focusable at all.

Prop: hiddenSeries
Type: readonly string[] | undefined
Default: —
Requirement: optional
Description: —

Prop: defaultHiddenSeries
Type: readonly string[] | undefined
Default: —
Requirement: optional
Description: —

Prop: activeDatum
Type: string | null | undefined
Default: —
Requirement: optional
Description: —

Prop: defaultActiveDatum
Type: string | null | undefined
Default: —
Requirement: optional
Description: Uncontrolled initial value for the `activeDatum`/`onActiveDatumChange` pair.

Prop: speed
Type: number | undefined
Default: —
Requirement: optional
Description: Playback-speed multiplier for entrance/ambient motion.

Prop: morphDurationMs
Type: number | undefined
Default: —
Requirement: optional
Description: How long a dataset change tweens, in milliseconds.

Prop: replayToken
Type: string | number | undefined
Default: —
Requirement: optional
Description: Changing this value replays the entrance animation.

Events

Event	Payload
`onBrushDomainChange`	`((domain: ChartXDomain) => void) \| undefined`
`onZoomDomainChange`	`((domain: ChartXDomain) => void) \| undefined`
`onHiddenSeriesChange`	`((ids: readonly string[]) => void) \| undefined`
`onActiveDatumChange`	`((id: string \| null) => void) \| undefined`

Content regions

children
dataSummary

Native attributes

Standard DOM and ARIA attributes not listed above spread onto the root element.

Import

import { TimelineChart } from "@grassroot/charts-vue";

Props

Prop

Type

Default

Requirement

className

string | undefined

—

optional

gpuBackend

"auto" | "webgpu" | "webgl2" | undefined

—

optional

width

number | undefined

—

optional

height

number | undefined

—

optional

renderer

ChartRenderer | undefined

—

optional

rendererStrategy

Partial<ChartRendererStrategy> | undefined

—

optional

renderPlanMode

"svg" | "host" | undefined

"host"

optional

showGrid

boolean | undefined

—

optional

legend

boolean | LegendConfig | undefined

false

optional

animation

ChartAnimationInput | undefined

—

optional

interactive

boolean | undefined

true

optional

keyboardNavigation

boolean | undefined

true

optional

hiddenSeries

readonly string[] | undefined

—

optional

Prop: className
Type: string | undefined
Default: —
Requirement: optional

Prop: gpuBackend
Type: "auto" | "webgpu" | "webgl2" | undefined
Default: —
Requirement: optional

Prop: width
Type: number | undefined
Default: —
Requirement: optional

Prop: height
Type: number | undefined
Default: —
Requirement: optional

Prop: renderer
Type: ChartRenderer | undefined
Default: —
Requirement: optional

Prop: rendererStrategy
Type: Partial<ChartRendererStrategy> | undefined
Default: —
Requirement: optional

Prop: renderPlanMode
Type: "svg" | "host" | undefined
Default: "host"
Requirement: optional

Prop: showGrid
Type: boolean | undefined
Default: —
Requirement: optional

Prop: legend
Type: boolean | LegendConfig | undefined
Default: false
Requirement: optional

Prop: tooltip
Type: boolean | TooltipBehaviorConfig | undefined
Default: true
Requirement: optional

Prop: animation
Type: ChartAnimationInput | undefined
Default: —
Requirement: optional

Prop: interactive
Type: boolean | undefined
Default: true
Requirement: optional

Prop: keyboardNavigation
Type: boolean | undefined
Default: true
Requirement: optional

Prop: hiddenSeries
Type: readonly string[] | undefined
Default: —
Requirement: optional

Prop: defaultHiddenSeries
Type: readonly string[] | undefined
Default: () => []
Requirement: optional

Prop: activeDatum
Type: string | null | undefined
Default: —
Requirement: optional

Prop: defaultActiveDatum
Type: string | null | undefined
Default: —
Requirement: optional

Prop: speed
Type: number | undefined
Default: —
Requirement: optional

Prop: morphDurationMs
Type: number | undefined
Default: —
Requirement: optional

Prop: replayToken
Type: string | number | undefined
Default: —
Requirement: optional

Prop: theme
Type: PartialChartTheme | undefined
Default: —
Requirement: optional

Prop: title
Type: string | undefined
Default: —
Requirement: optional

Prop: description
Type: string | undefined
Default: —
Requirement: optional

Prop: ariaLabel
Type: string | undefined
Default: —
Requirement: optional

Prop: items
Type: readonly TimelineItem[]
Default: —
Requirement: required

Prop: layout
Type: "linear" | "spiral" | undefined
Default: —
Requirement: optional

Prop: formatXValue
Type: ((value: Date, index: number) => string) | undefined
Default: —
Requirement: optional

Prop: locale
Type: string | readonly string[] | undefined
Default: —
Requirement: optional

Prop: timeZone
Type: string | undefined
Default: —
Requirement: optional

Prop: referenceLines
Type: readonly { readonly value: Date | string | number; readonly label?: string; }[] | undefined
Default: —
Requirement: optional

Prop: referenceBands
Type: readonly { readonly from: Date | string | number; readonly to: Date | string | number; readonly label?: string; }[] | undefined
Default: —
Requirement: optional

Prop: brushDomain
Type: ChartXDomain | undefined
Default: —
Requirement: optional

Prop: defaultBrushDomain
Type: ChartXDomain | undefined
Default: —
Requirement: optional

Prop: zoomDomain
Type: ChartXDomain | undefined
Default: —
Requirement: optional

Prop: defaultZoomDomain
Type: ChartXDomain | undefined
Default: —
Requirement: optional

Prop: zoomOnBrush
Type: boolean | undefined
Default: false
Requirement: optional

Events

Event	Payload
`hiddenSeriesChange`	`[ids: readonly string[]]`
`activeDatumChange`	`[id: string \| null]`
`brushDomainChange`	`[domain: ChartXDomain]`
`zoomDomainChange`	`[domain: ChartXDomain]`

Content regions

dataSummary
default

Import

import { ChangeDetectionStrategy, Component } from "@angular/core";
import { GrassrootTimelineChart } from "@grassroot/charts-angular";

Props

Prop

Type

Default

Requirement

renderer

ChartRenderer

—

optional

gpuBackend

ChartGpuBackend

—

optional

rendererStrategy

Partial<ChartRendererStrategy>

—

optional

renderPlanMode

"svg" | "host"

"host"

optional

ariaLabel

string

—

optional

title

string

—

optional

description

string

—

optional

theme

PartialChartTheme

—

optional

animation

ChartAnimationInput

—

optional

interactive

boolean

true

optional

keyboardNavigation

boolean

true

optional

legend

boolean | LegendConfig

—

optional

hiddenSeries

readonly string[]

—

optional

Prop: renderer
Type: ChartRenderer
Default: —
Requirement: optional

Prop: gpuBackend
Type: ChartGpuBackend
Default: —
Requirement: optional

Prop: rendererStrategy
Type: Partial<ChartRendererStrategy>
Default: —
Requirement: optional

Prop: renderPlanMode
Type: "svg" | "host"
Default: "host"
Requirement: optional

Prop: ariaLabel
Type: string
Default: —
Requirement: optional

Prop: title
Type: string
Default: —
Requirement: optional

Prop: description
Type: string
Default: —
Requirement: optional

Prop: theme
Type: PartialChartTheme
Default: —
Requirement: optional

Prop: animation
Type: ChartAnimationInput
Default: —
Requirement: optional

Prop: interactive
Type: boolean
Default: true
Requirement: optional

Prop: keyboardNavigation
Type: boolean
Default: true
Requirement: optional

Prop: tooltip
Type: boolean | TooltipBehaviorConfig
Default: true
Requirement: optional

Prop: legend
Type: boolean | LegendConfig
Default: —
Requirement: optional

Prop: hiddenSeries
Type: readonly string[]
Default: —
Requirement: optional

Prop: defaultHiddenSeries
Type: readonly string[]
Default: []
Requirement: optional

Prop: activeDatum
Type: string | null
Default: —
Requirement: optional

Prop: defaultActiveDatum
Type: string | null
Default: null
Requirement: optional

Prop: speed
Type: number
Default: —
Requirement: optional

Prop: morphDurationMs
Type: number
Default: —
Requirement: optional

Prop: replayToken
Type: string | number
Default: —
Requirement: optional

Prop: brushDomain
Type: ChartXDomain
Default: —
Requirement: optional

Prop: defaultBrushDomain
Type: ChartXDomain
Default: —
Requirement: optional

Prop: zoomDomain
Type: ChartXDomain
Default: —
Requirement: optional

Prop: defaultZoomDomain
Type: ChartXDomain
Default: null
Requirement: optional

Prop: zoomOnBrush
Type: boolean
Default: false
Requirement: optional

Prop: items
Type: readonly TimelineItem[]
Default: —
Requirement: required

Prop: layout
Type: TimelineChartOptions["layout"]
Default: —
Requirement: optional

Prop: width
Type: number
Default: —
Requirement: optional

Prop: height
Type: number
Default: —
Requirement: optional

Prop: showGrid
Type: boolean
Default: —
Requirement: optional

Prop: formatXValue
Type: TimelineChartOptions["formatXValue"]
Default: —
Requirement: optional

Prop: locale
Type: TimelineChartOptions["locale"]
Default: —
Requirement: optional

Prop: timeZone
Type: TimelineChartOptions["timeZone"]
Default: —
Requirement: optional

Prop: referenceLines
Type: TimelineChartOptions["referenceLines"]
Default: —
Requirement: optional

Prop: referenceBands
Type: TimelineChartOptions["referenceBands"]
Default: —
Requirement: optional

Prop: className
Type: string
Default: —
Requirement: optional

Events

Event	Payload
`activeDatumChange`	`string \| null`
`hiddenSeriesChange`	`readonly string[]`
`brushDomainChange`	`ChartXDomain`
`zoomDomainChange`	`ChartXDomain`

Content regions

dataSummary
default

Import

import { TimelineChart } from "@grassroot/charts-svelte";

Props

Prop

Type

Default

Requirement

items

readonly TimelineItem[]

—

required

layout

TimelineChartOptions["layout"]

—

optional

formatXValue

TimelineChartOptions["formatXValue"]

—

optional

locale

TimelineChartOptions["locale"]

—

optional

timeZone

TimelineChartOptions["timeZone"]

—

optional

referenceLines

TimelineChartOptions["referenceLines"]

—

optional

referenceBands

TimelineChartOptions["referenceBands"]

—

optional

brushDomain

{ readonly start: number; readonly end: number } | null

—

optional

defaultBrushDomain

{ readonly start: number; readonly end: number } | null

—

optional

onBrushDomainChange

(domain: { readonly start: number; readonly end: number } | null) => void

—

optional

zoomDomain

{ readonly start: number; readonly end: number } | null

—

optional

defaultZoomDomain

{ readonly start: number; readonly end: number } | null

null

optional

onZoomDomainChange

(domain: { readonly start: number; readonly end: number } | null) => void

—

optional

zoomOnBrush

boolean

false

optional

Prop: items
Type: readonly TimelineItem[]
Default: —
Requirement: required

Prop: layout
Type: TimelineChartOptions["layout"]
Default: —
Requirement: optional

Prop: formatXValue
Type: TimelineChartOptions["formatXValue"]
Default: —
Requirement: optional

Prop: locale
Type: TimelineChartOptions["locale"]
Default: —
Requirement: optional

Prop: timeZone
Type: TimelineChartOptions["timeZone"]
Default: —
Requirement: optional

Prop: referenceLines
Type: TimelineChartOptions["referenceLines"]
Default: —
Requirement: optional

Prop: referenceBands
Type: TimelineChartOptions["referenceBands"]
Default: —
Requirement: optional

Prop: brushDomain
Type: { readonly start: number; readonly end: number } | null
Default: —
Requirement: optional

Prop: defaultBrushDomain
Type: { readonly start: number; readonly end: number } | null
Default: —
Requirement: optional

Prop: onBrushDomainChange
Type: (domain: { readonly start: number; readonly end: number } | null) => void
Default: —
Requirement: optional

Prop: zoomDomain
Type: { readonly start: number; readonly end: number } | null
Default: —
Requirement: optional

Prop: defaultZoomDomain
Type: { readonly start: number; readonly end: number } | null
Default: null
Requirement: optional

Prop: onZoomDomainChange
Type: (domain: { readonly start: number; readonly end: number } | null) => void
Default: —
Requirement: optional

Prop: zoomOnBrush
Type: boolean
Default: false
Requirement: optional

Prop: onHiddenSeriesChange
Type: (ids: readonly string[]) => void
Default: —
Requirement: optional

Prop: onActiveDatumChange
Type: (id: string | null) => void
Default: —
Requirement: optional

Prop: class
Type: string
Default: —
Requirement: optional

Prop: style
Type: string
Default: —
Requirement: optional

Prop: width
Type: number
Default: —
Requirement: optional

Prop: height
Type: number
Default: —
Requirement: optional

Prop: renderer
Type: ChartRenderer
Default: —
Requirement: optional

Prop: gpuBackend
Type: ChartGpuBackend
Default: —
Requirement: optional

Prop: rendererStrategy
Type: Partial<ChartRendererStrategy>
Default: —
Requirement: optional

Prop: renderPlanMode
Type: "svg" | "host"
Default: "host"
Requirement: optional

Prop: showGrid
Type: boolean
Default: —
Requirement: optional

Prop: legend
Type: boolean | LegendConfig
Default: false
Requirement: optional

Prop: tooltip
Type: boolean | TooltipBehaviorConfig
Default: true
Requirement: optional

Prop: animation
Type: ChartAnimationInput
Default: —
Requirement: optional

Prop: interactive
Type: boolean
Default: true
Requirement: optional

Prop: keyboardNavigation
Type: boolean
Default: true
Requirement: optional

Prop: hiddenSeries
Type: readonly string[]
Default: —
Requirement: optional

Prop: defaultHiddenSeries
Type: readonly string[]
Default: —
Requirement: optional

Prop: activeDatum
Type: string | null
Default: —
Requirement: optional

Prop: defaultActiveDatum
Type: string | null
Default: —
Requirement: optional

Prop: speed
Type: number
Default: —
Requirement: optional

Prop: morphDurationMs
Type: number
Default: —
Requirement: optional

Prop: replayToken
Type: string | number
Default: —
Requirement: optional

Prop: theme
Type: PartialChartTheme
Default: —
Requirement: optional

Prop: title
Type: string
Default: —
Requirement: optional

Prop: description
Type: string
Default: —
Requirement: optional

Prop: ariaLabel
Type: string
Default: —
Requirement: optional

Events

Event	Payload
`onBrushDomainChange`	`(domain: { readonly start: number; readonly end: number } \| null) => void`
`onZoomDomainChange`	`(domain: { readonly start: number; readonly end: number } \| null) => void`
`onHiddenSeriesChange`	`(ids: readonly string[]) => void`
`onActiveDatumChange`	`(id: string \| null) => void`

Content regions

children
dataSummary

Import

import { TimelineChart } from "@grassroot/charts-solid";

Props

Prop

Type

Default

Requirement

items

readonly TimelineItem[]

—

required

layout

TimelineChartOptions["layout"]

—

optional

formatXValue

(value: Date, index: number) => string

—

optional

locale

string | readonly string[]

—

optional

timeZone

string

—

optional

referenceLines

readonly { readonly value: Date | string | number; readonly label?: string }[]

—

optional

referenceBands

readonly { readonly from: Date | string | number; readonly to: Date | string | number; readonly label?: string }[]

—

optional

brushDomain

ChartXDomain

—

optional

defaultBrushDomain

ChartXDomain

—

optional

onBrushDomainChange

(domain: ChartXDomain) => void

—

optional

zoomDomain

ChartXDomain

—

optional

defaultZoomDomain

ChartXDomain

—

optional

onZoomDomainChange

(domain: ChartXDomain) => void

—

optional

zoomOnBrush

boolean

—

optional

Prop: items
Type: readonly TimelineItem[]
Default: —
Requirement: required

Prop: layout
Type: TimelineChartOptions["layout"]
Default: —
Requirement: optional

Prop: formatXValue
Type: (value: Date, index: number) => string
Default: —
Requirement: optional

Prop: locale
Type: string | readonly string[]
Default: —
Requirement: optional

Prop: timeZone
Type: string
Default: —
Requirement: optional

Prop: referenceLines
Type: readonly { readonly value: Date | string | number; readonly label?: string }[]
Default: —
Requirement: optional

Prop: referenceBands
Type: readonly { readonly from: Date | string | number; readonly to: Date | string | number; readonly label?: string }[]
Default: —
Requirement: optional

Prop: brushDomain
Type: ChartXDomain
Default: —
Requirement: optional

Prop: defaultBrushDomain
Type: ChartXDomain
Default: —
Requirement: optional

Prop: onBrushDomainChange
Type: (domain: ChartXDomain) => void
Default: —
Requirement: optional

Prop: zoomDomain
Type: ChartXDomain
Default: —
Requirement: optional

Prop: defaultZoomDomain
Type: ChartXDomain
Default: —
Requirement: optional

Prop: onZoomDomainChange
Type: (domain: ChartXDomain) => void
Default: —
Requirement: optional

Prop: zoomOnBrush
Type: boolean
Default: —
Requirement: optional

Prop: onActiveDatumChange
Type: (id: string | null) => void
Default: —
Requirement: optional

Prop: onHiddenSeriesChange
Type: (ids: readonly string[]) => void
Default: —
Requirement: optional

Prop: class
Type: string
Default: —
Requirement: optional

Prop: style
Type: JSX.CSSProperties
Default: —
Requirement: optional

Prop: width
Type: number
Default: —
Requirement: optional

Prop: height
Type: number
Default: —
Requirement: optional

Prop: renderer
Type: ChartRenderer
Default: —
Requirement: optional

Prop: gpuBackend
Type: ChartGpuBackend
Default: —
Requirement: optional

Prop: rendererStrategy
Type: Partial<ChartRendererStrategy>
Default: —
Requirement: optional

Prop: renderPlanMode
Type: "svg" | "host"
Default: —
Requirement: optional

Prop: showGrid
Type: boolean
Default: —
Requirement: optional

Prop: legend
Type: boolean | LegendConfig
Default: —
Requirement: optional

Prop: tooltip
Type: boolean | TooltipBehaviorConfig
Default: —
Requirement: optional

Prop: animation
Type: ChartAnimationInput
Default: —
Requirement: optional

Prop: interactive
Type: boolean
Default: —
Requirement: optional

Prop: keyboardNavigation
Type: boolean
Default: —
Requirement: optional

Prop: hiddenSeries
Type: readonly string[]
Default: —
Requirement: optional

Prop: defaultHiddenSeries
Type: readonly string[]
Default: —
Requirement: optional

Prop: activeDatum
Type: string | null
Default: —
Requirement: optional

Prop: defaultActiveDatum
Type: string | null
Default: —
Requirement: optional

Prop: speed
Type: number
Default: —
Requirement: optional

Prop: morphDurationMs
Type: number
Default: —
Requirement: optional

Prop: replayToken
Type: string | number
Default: —
Requirement: optional

Prop: theme
Type: PartialChartTheme
Default: —
Requirement: optional

Prop: title
Type: string
Default: —
Requirement: optional

Prop: description
Type: string
Default: —
Requirement: optional

Prop: ariaLabel
Type: string
Default: —
Requirement: optional

Events

Event	Payload
`onBrushDomainChange`	`(domain: ChartXDomain) => void`
`onZoomDomainChange`	`(domain: ChartXDomain) => void`
`onActiveDatumChange`	`(id: string \| null) => void`
`onHiddenSeriesChange`	`(ids: readonly string[]) => void`

Content regions

children
dataSummary