# Gantt

Arrange task durations and progress on a timeline.

Canonical: https://chart.syidax.com/docs/components/gantt/

<a id="overview"></a>

## sy-gantt-chart

Manage project schedules, milestones, and baselines together.

This display example does not save tasks. Connect application persistence to editing events to save changes.

Base chart tier: Pro. Features such as additional renderers and custom branding have separate entitlement requirements.

| Input | Data description |
| --- | --- |
| `data` | An array of tasks as { id, label, start, end?, progress?, milestone?, baseline? }. progress ranges from 0 to 1. |

- [Run in Components](https://chart.syidax.com/charts/gantt) — Change options and view framework-specific code
- [Shared installation and integration](https://chart.syidax.com/docs/getting-started.md)

<a id="example"></a>

## Complete implementation example

```html
<div id="chart-container" style="width: 100%; min-width: 0;"></div>

<script type="module">
  import { defineCustomElement as define0 } from '@syidax/advanced-pro/components/sy-gantt-chart.js';
  define0();

  // Pro: complete registerLicense at app startup using your issued certificate.
  // The website preview certificate is not for use in customer apps.
  const specs = [
    {
      "id": "example-chart",
      "tag": "sy-gantt-chart",
      "props": {
        "data": [
          {
            "id": "research",
            "label": "Research",
            "start": "2026-01-05",
            "end": "2026-01-09",
            "progress": 1,
            "color": "#8263d9"
          },
          {
            "id": "design",
            "label": "Design",
            "start": "2026-01-08",
            "end": "2026-01-16",
            "progress": 0.65,
            "color": "#239c91"
          },
          {
            "id": "build",
            "label": "Implementation",
            "start": "2026-01-14",
            "end": "2026-01-26",
            "progress": 0.3,
            "color": "#e99954"
          },
          {
            "id": "launch",
            "label": "Release",
            "start": "2026-01-28",
            "milestone": true
          }
        ],
        "width": 640,
        "height": 360,
        "brandPosition": "bottom-right",
        "brandLogo": ""
      }
    }
  ];
  const container = document.querySelector('#chart-container');
  const elements = specs.map(({ tag, id, props }) => {
    const element = document.createElement(tag);
    element.id = id;
    Object.assign(element, props);
    element.setAttribute('aria-label', 'gantt example chart');
    return element;
  });
  container.replaceChildren(...elements);
  const chart = elements.at(-1);
  const onEvent = event => {
    console.log('taskClick', event.detail);
  };
  chart.addEventListener('taskClick', onEvent);
  const observer = new ResizeObserver(([entry]) => {
    const width = Math.max(160, Math.floor(entry.contentRect.width));
    elements.forEach(element => { element.width = width; });
  });
  observer.observe(container);

  // In an SPA, call this function when the view is disposed.
  function disposeChart() {
    observer.disconnect();
    chart.removeEventListener('taskClick', onEvent);
    container.replaceChildren();
  }
</script>
```

<a id="props"></a>

## Properties

<a id="property-data"></a>

### data

An array of tasks as { id, label, start, end?, progress?, milestone?, baseline? }. progress ranges from 0 to 1.

| Item | Value |
| --- | --- |
| JavaScript property | `data` |
| HTML attribute | Pass objects, arrays, and callbacks as JavaScript properties |
| Type | `GanttData` |
| Default | `undefined` |

undefined means this property was not explicitly set. The effective value may depend on the chart type and other settings.

- [GanttData](https://chart.syidax.com/docs/types/GanttData.md) — Type definition

<a id="property-width"></a>

### width

Chart width in pixels. If the container width changes, update width from a ResizeObserver.

| Item | Value |
| --- | --- |
| JavaScript property | `width` |
| HTML attribute | `width` |
| Type | `number` |
| Default | `900` |

<a id="property-height"></a>

### height

Chart height in pixels. Allow space for axes, titles, and the legend.

| Item | Value |
| --- | --- |
| JavaScript property | `height` |
| HTML attribute | `height` |
| Type | `number` |
| Default | `400` |

<a id="property-brandLogo"></a>

### brandLogo

The default is the Syidax symbol and wordmark. With the Pro chart.branding entitlement, set none to remove it or provide a PNG, JPEG, or WebP data URL to replace it.

| Item | Value |
| --- | --- |
| JavaScript property | `brandLogo` |
| HTML attribute | `brand-logo` |
| Type | `string` |
| Default | `undefined` |

undefined means this property was not explicitly set. The effective value may depend on the chart type and other settings.

<a id="property-brandPosition"></a>

### brandPosition

The corner where the logo is anchored. Community and Pro both support all four corners, using the same position on screen and in image exports.

| Item | Value |
| --- | --- |
| JavaScript property | `brandPosition` |
| HTML attribute | `brand-position` |
| Type | `'top-left' \| 'top-right' \| 'bottom-left' \| 'bottom-right'` |
| Default | `'bottom-right'` |
| Allowed values | `top-left`, `top-right`, `bottom-left`, `bottom-right` |

<a id="property-barHeight"></a>

### barHeight

Maximum task bar height and gap in CSS pixels.

| Item | Value |
| --- | --- |
| JavaScript property | `barHeight` |
| HTML attribute | `bar-height` |
| Type | `number` |
| Default | `24` |

<a id="property-rowGap"></a>

### rowGap

Set as an HTML attribute or JavaScript property. type: number.

| Item | Value |
| --- | --- |
| JavaScript property | `rowGap` |
| HTML attribute | `row-gap` |
| Type | `number` |
| Default | `4` |

<a id="property-barRadius"></a>

### barRadius

Set as an HTML attribute or JavaScript property. type: number.

| Item | Value |
| --- | --- |
| JavaScript property | `barRadius` |
| HTML attribute | `bar-radius` |
| Type | `number` |
| Default | `3` |

<a id="property-progressShow"></a>

### progressShow

Set as an HTML attribute or JavaScript property. type: boolean.

| Item | Value |
| --- | --- |
| JavaScript property | `progressShow` |
| HTML attribute | `progress-show` |
| Type | `boolean` |
| Default | `true` |

<a id="property-progressColor"></a>

### progressColor

Set as an HTML attribute or JavaScript property. type: string.

| Item | Value |
| --- | --- |
| JavaScript property | `progressColor` |
| HTML attribute | `progress-color` |
| Type | `string` |
| Default | `'auto'` |

<a id="property-taskLabelFormat"></a>

### taskLabelFormat

Pass as a JavaScript property. type: (task:GanttTask)=>string.

| Item | Value |
| --- | --- |
| JavaScript property | `taskLabelFormat` |
| HTML attribute | Pass objects, arrays, and callbacks as JavaScript properties |
| Type | `(task:GanttTask)=>string` |
| Default | `undefined` |

undefined means this property was not explicitly set. The effective value may depend on the chart type and other settings.

- [GanttTask](https://chart.syidax.com/docs/types/GanttTask.md) — Type definition

<a id="property-timeDomain"></a>

### timeDomain

Optional full timeline extent in epoch milliseconds.

| Item | Value |
| --- | --- |
| JavaScript property | `timeDomain` |
| HTML attribute | Pass objects, arrays, and callbacks as JavaScript properties |
| Type | `readonly [number, number]` |
| Default | `undefined` |

undefined means this property was not explicitly set. The effective value may depend on the chart type and other settings.

<a id="property-criticalPath"></a>

### criticalPath

Pass as a JavaScript property. type: GanttCriticalPathInput.

| Item | Value |
| --- | --- |
| JavaScript property | `criticalPath` |
| HTML attribute | Pass objects, arrays, and callbacks as JavaScript properties |
| Type | `GanttCriticalPathInput` |
| Default | `undefined` |

undefined means this property was not explicitly set. The effective value may depend on the chart type and other settings.

- [GanttCriticalPathInput](https://chart.syidax.com/docs/types/GanttCriticalPathInput.md) — Type definition

<a id="property-taskEditing"></a>

### taskEditing

Opt-in task move/resize. Committed local edits are queried through getTasks/getTaskEdits; source updates supersede them.

| Item | Value |
| --- | --- |
| JavaScript property | `taskEditing` |
| HTML attribute | Pass objects, arrays, and callbacks as JavaScript properties |
| Type | `GanttTaskEditingInput` |
| Default | `undefined` |

undefined means this property was not explicitly set. The effective value may depend on the chart type and other settings.

- [GanttTaskEditingInput](https://chart.syidax.com/docs/types/GanttTaskEditingInput.md) — Type definition

<a id="property-baseline"></a>

### baseline

Reference-date strips, visible by default when tasks include baseline dates.

| Item | Value |
| --- | --- |
| JavaScript property | `baseline` |
| HTML attribute | Pass objects, arrays, and callbacks as JavaScript properties |
| Type | `GanttBaselineStyleInput` |
| Default | `undefined` |

undefined means this property was not explicitly set. The effective value may depend on the chart type and other settings.

- [GanttBaselineStyleInput](https://chart.syidax.com/docs/types/GanttBaselineStyleInput.md) — Type definition

<a id="property-dependencies"></a>

### dependencies

Pass as a JavaScript property. type: ReadonlyArray<GanttDependencyInput>.

| Item | Value |
| --- | --- |
| JavaScript property | `dependencies` |
| HTML attribute | Pass objects, arrays, and callbacks as JavaScript properties |
| Type | `ReadonlyArray<GanttDependencyInput>` |
| Default | `undefined` |

undefined means this property was not explicitly set. The effective value may depend on the chart type and other settings.

- [GanttDependencyInput](https://chart.syidax.com/docs/types/GanttDependencyInput.md) — Type definition

<a id="property-dependencyStyle"></a>

### dependencyStyle

Pass as a JavaScript property. type: GanttDependencyStyleInput.

| Item | Value |
| --- | --- |
| JavaScript property | `dependencyStyle` |
| HTML attribute | Pass objects, arrays, and callbacks as JavaScript properties |
| Type | `GanttDependencyStyleInput` |
| Default | `undefined` |

undefined means this property was not explicitly set. The effective value may depend on the chart type and other settings.

- [GanttDependencyStyleInput](https://chart.syidax.com/docs/types/GanttDependencyStyleInput.md) — Type definition

<a id="property-timeAxis"></a>

### timeAxis

Pass as a JavaScript property. type: GanttTimeAxisInput.

| Item | Value |
| --- | --- |
| JavaScript property | `timeAxis` |
| HTML attribute | Pass objects, arrays, and callbacks as JavaScript properties |
| Type | `GanttTimeAxisInput` |
| Default | `undefined` |

undefined means this property was not explicitly set. The effective value may depend on the chart type and other settings.

- [GanttTimeAxisInput](https://chart.syidax.com/docs/types/GanttTimeAxisInput.md) — Type definition

<a id="property-crosshair"></a>

### crosshair

Pass as a JavaScript property. type: CartesianCrosshairInput.

| Item | Value |
| --- | --- |
| JavaScript property | `crosshair` |
| HTML attribute | Pass objects, arrays, and callbacks as JavaScript properties |
| Type | `CartesianCrosshairInput` |
| Default | `undefined` |

undefined means this property was not explicitly set. The effective value may depend on the chart type and other settings.

- [CartesianCrosshairInput](https://chart.syidax.com/docs/types/CartesianCrosshairInput.md) — Type definition

<a id="property-crosshairTimeUnit"></a>

### crosshairTimeUnit

Crosshair time badge precision; hour by default. Uses timeAxis.utc without changing event timestamps.

| Item | Value |
| --- | --- |
| JavaScript property | `crosshairTimeUnit` |
| HTML attribute | `crosshair-time-unit` |
| Type | `GanttCrosshairTimeUnit` |
| Default | `'hour'` |
| Allowed values | `year`, `month`, `week`, `day`, `hour`, `minute`, `second` |

- [GanttCrosshairTimeUnit](https://chart.syidax.com/docs/types/GanttCrosshairTimeUnit.md) — Type definition

<a id="property-color"></a>

### color

Set as an HTML attribute or JavaScript property. type: string.

| Item | Value |
| --- | --- |
| JavaScript property | `color` |
| HTML attribute | `color` |
| Type | `string` |
| Default | `'auto'` |

<a id="property-activeColor"></a>

### activeColor

Set as an HTML attribute or JavaScript property. type: string.

| Item | Value |
| --- | --- |
| JavaScript property | `activeColor` |
| HTML attribute | `active-color` |
| Type | `string` |
| Default | `'#f59e0b'` |

<a id="property-taskLabels"></a>

### taskLabels

Allowed values: auto, show, hide. Default: 'auto'.

| Item | Value |
| --- | --- |
| JavaScript property | `taskLabels` |
| HTML attribute | `task-labels` |
| Type | `GanttLabelMode` |
| Default | `'auto'` |
| Allowed values | `auto`, `show`, `hide` |

- [GanttLabelMode](https://chart.syidax.com/docs/types/GanttLabelMode.md) — Type definition

<a id="property-chartTitle"></a>

### chartTitle

The title inside the chart. Explain the data's unit and meaning alongside it.

| Item | Value |
| --- | --- |
| JavaScript property | `chartTitle` |
| HTML attribute | `chart-title` |
| Type | `string` |
| Default | `undefined` |

undefined means this property was not explicitly set. The effective value may depend on the chart type and other settings.

<a id="property-chartSubtitle"></a>

### chartSubtitle

The subtitle inside the chart.

| Item | Value |
| --- | --- |
| JavaScript property | `chartSubtitle` |
| HTML attribute | `chart-subtitle` |
| Type | `string` |
| Default | `undefined` |

undefined means this property was not explicitly set. The effective value may depend on the chart type and other settings.

<a id="property-enableMouseTracking"></a>

### enableMouseTracking

Set as an HTML attribute or JavaScript property. type: boolean.

| Item | Value |
| --- | --- |
| JavaScript property | `enableMouseTracking` |
| HTML attribute | `enable-mouse-tracking` |
| Type | `boolean` |
| Default | `true` |

<a id="property-tooltip"></a>

### tooltip

Tooltip settings for pointer-driven values, position, and content.

| Item | Value |
| --- | --- |
| JavaScript property | `tooltip` |
| HTML attribute | Pass objects, arrays, and callbacks as JavaScript properties |
| Type | `CartesianTooltipInput` |
| Default | `undefined` |
| Literals in the type | `auto`, `off` |

undefined means this property was not explicitly set. The effective value may depend on the chart type and other settings.

- [CartesianTooltipInput](https://chart.syidax.com/docs/types/CartesianTooltipInput.md) — Type definition

<a id="property-tooltipEnabled"></a>

### tooltipEnabled

Set as an HTML attribute or JavaScript property. type: boolean.

| Item | Value |
| --- | --- |
| JavaScript property | `tooltipEnabled` |
| HTML attribute | `tooltip-show` |
| Type | `boolean` |
| Default | `true` |

<a id="property-tooltipFormat"></a>

### tooltipFormat

Pass as a JavaScript property. type: (detail: GanttHitDetail) => string.

| Item | Value |
| --- | --- |
| JavaScript property | `tooltipFormat` |
| HTML attribute | Pass objects, arrays, and callbacks as JavaScript properties |
| Type | `(detail: GanttHitDetail) => string` |
| Default | `undefined` |

undefined means this property was not explicitly set. The effective value may depend on the chart type and other settings.

- [GanttHitDetail](https://chart.syidax.com/docs/types/GanttHitDetail.md) — Type definition

<a id="property-animated"></a>

### animated

Whether to animate initial display and data changes.

| Item | Value |
| --- | --- |
| JavaScript property | `animated` |
| HTML attribute | `animate` |
| Type | `boolean` |
| Default | `false` |

<a id="property-animationDuration"></a>

### animationDuration

Animation duration in milliseconds.

| Item | Value |
| --- | --- |
| JavaScript property | `animationDuration` |
| HTML attribute | `animation-duration` |
| Type | `number` |
| Default | `600` |

<a id="property-animationEasing"></a>

### animationEasing

Allowed values: linear, ease-out, ease-in, ease-in-out. Default: 'ease-out'.

| Item | Value |
| --- | --- |
| JavaScript property | `animationEasing` |
| HTML attribute | `animation-easing` |
| Type | `GanttEasing` |
| Default | `'ease-out'` |
| Allowed values | `linear`, `ease-out`, `ease-in`, `ease-in-out` |

- [GanttEasing](https://chart.syidax.com/docs/types/GanttEasing.md) — Type definition

<a id="property-animationType"></a>

### animationType

Allowed values: initial, update. Default: undefined.

| Item | Value |
| --- | --- |
| JavaScript property | `animationType` |
| HTML attribute | `animation-type` |
| Type | `GanttAnimationType` |
| Default | `undefined` |
| Allowed values | `initial`, `update` |

undefined means this property was not explicitly set. The effective value may depend on the chart type and other settings.

- [GanttAnimationType](https://chart.syidax.com/docs/types/GanttAnimationType.md) — Type definition

<a id="property-streamSource"></a>

### streamSource

A stream source for live data. Check the contract for the specific type.

| Item | Value |
| --- | --- |
| JavaScript property | `streamSource` |
| HTML attribute | Pass objects, arrays, and callbacks as JavaScript properties |
| Type | `GanttStreamSource` |
| Default | `undefined` |

undefined means this property was not explicitly set. The effective value may depend on the chart type and other settings.

- [GanttStreamSource](https://chart.syidax.com/docs/types/GanttStreamSource.md) — Type definition

<a id="property-streamMax"></a>

### streamMax

The maximum number of streaming data points to retain.

| Item | Value |
| --- | --- |
| JavaScript property | `streamMax` |
| HTML attribute | `stream-max` |
| Type | `number` |
| Default | `undefined` |

undefined means this property was not explicitly set. The effective value may depend on the chart type and other settings.

<a id="property-streamWindow"></a>

### streamWindow

The streaming data range to keep visible.

| Item | Value |
| --- | --- |
| JavaScript property | `streamWindow` |
| HTML attribute | `stream-window` |
| Type | `number` |
| Default | `undefined` |

undefined means this property was not explicitly set. The effective value may depend on the chart type and other settings.

<a id="property-zoom"></a>

### zoom

Settings for zooming and the visible range.

| Item | Value |
| --- | --- |
| JavaScript property | `zoom` |
| HTML attribute | Pass objects, arrays, and callbacks as JavaScript properties |
| Type | `CartesianZoomInput` |
| Default | `undefined` |
| Literals in the type | `auto`, `off`, `true`, `false`, `x`, `y`, `xy`, `inside` |

undefined means this property was not explicitly set. The effective value may depend on the chart type and other settings.

- [CartesianZoomInput](https://chart.syidax.com/docs/types/CartesianZoomInput.md) — Type definition

<a id="property-engine"></a>

### engine

Renderer selection: auto, standard, or pro. Engine selection is separate from permission to use a Pro chart type.

| Item | Value |
| --- | --- |
| JavaScript property | `engine` |
| HTML attribute | `engine` |
| Type | `GanttEngineMode` |
| Default | `'auto'` |
| Allowed values | `auto`, `standard`, `pro` |

- [GanttEngineMode](https://chart.syidax.com/docs/types/GanttEngineMode.md) — Type definition

<a id="property-unavailable"></a>

### unavailable

Allowed values: fallback, error. Default: 'fallback'.

| Item | Value |
| --- | --- |
| JavaScript property | `unavailable` |
| HTML attribute | `unavailable` |
| Type | `GanttUnavailableBehaviour` |
| Default | `'fallback'` |
| Allowed values | `fallback`, `error` |

- [GanttUnavailableBehaviour](https://chart.syidax.com/docs/types/GanttUnavailableBehaviour.md) — Type definition

<a id="events"></a>

## Events

<a id="event-rendered"></a>

### rendered

Emits rendering results in detail when chart drawing completes.

Event name: `rendered`. Names are case-sensitive. Read the payload from `detail` on `CustomEvent<GanttRenderResult & { tier: GanttEngineTier }>`.

```javascript
chart.addEventListener('rendered', event => {
  console.log(event.detail); // GanttRenderResult & { tier: GanttEngineTier }
});
```

- [GanttRenderResult](https://chart.syidax.com/docs/types/GanttRenderResult.md) — Type definition
- [GanttEngineTier](https://chart.syidax.com/docs/types/GanttEngineTier.md) — Type definition

<a id="event-dependencyClick"></a>

### dependencyClick

CustomEvent.detail type: GanttDependencyHitDetail. Event names are case-sensitive.

Event name: `dependencyClick`. Names are case-sensitive. Read the payload from `detail` on `CustomEvent<GanttDependencyHitDetail>`.

```javascript
chart.addEventListener('dependencyClick', event => {
  console.log(event.detail); // GanttDependencyHitDetail
});
```

- [GanttDependencyHitDetail](https://chart.syidax.com/docs/types/GanttDependencyHitDetail.md) — Type definition

<a id="event-dependencyHover"></a>

### dependencyHover

CustomEvent.detail type: GanttDependencyHitDetail | null. Event names are case-sensitive.

Event name: `dependencyHover`. Names are case-sensitive. Read the payload from `detail` on `CustomEvent<GanttDependencyHitDetail | null>`.

```javascript
chart.addEventListener('dependencyHover', event => {
  console.log(event.detail); // GanttDependencyHitDetail | null
});
```

- [GanttDependencyHitDetail](https://chart.syidax.com/docs/types/GanttDependencyHitDetail.md) — Type definition

<a id="event-dependencySelectionChange"></a>

### dependencySelectionChange

CustomEvent.detail type: GanttDependencySelectionChange. Event names are case-sensitive.

Event name: `dependencySelectionChange`. Names are case-sensitive. Read the payload from `detail` on `CustomEvent<GanttDependencySelectionChange>`.

```javascript
chart.addEventListener('dependencySelectionChange', event => {
  console.log(event.detail); // GanttDependencySelectionChange
});
```

- [GanttDependencySelectionChange](https://chart.syidax.com/docs/types/GanttDependencySelectionChange.md) — Type definition

<a id="event-taskClick"></a>

### taskClick

CustomEvent.detail type: GanttHitDetail. Event names are case-sensitive.

Event name: `taskClick`. Names are case-sensitive. Read the payload from `detail` on `CustomEvent<GanttHitDetail>`.

```javascript
chart.addEventListener('taskClick', event => {
  console.log(event.detail); // GanttHitDetail
});
```

- [GanttHitDetail](https://chart.syidax.com/docs/types/GanttHitDetail.md) — Type definition

<a id="event-taskHover"></a>

### taskHover

CustomEvent.detail type: GanttHitDetail | null. Event names are case-sensitive.

Event name: `taskHover`. Names are case-sensitive. Read the payload from `detail` on `CustomEvent<GanttHitDetail | null>`.

```javascript
chart.addEventListener('taskHover', event => {
  console.log(event.detail); // GanttHitDetail | null
});
```

- [GanttHitDetail](https://chart.syidax.com/docs/types/GanttHitDetail.md) — Type definition

<a id="event-taskEditStart"></a>

### taskEditStart

CustomEvent.detail type: GanttTaskEditEventDetail. Event names are case-sensitive.

Event name: `taskEditStart`. Names are case-sensitive. Read the payload from `detail` on `CustomEvent<GanttTaskEditEventDetail>`.

```javascript
chart.addEventListener('taskEditStart', event => {
  console.log(event.detail); // GanttTaskEditEventDetail
});
```

- [GanttTaskEditEventDetail](https://chart.syidax.com/docs/types/GanttTaskEditEventDetail.md) — Type definition

<a id="event-taskEditMove"></a>

### taskEditMove

CustomEvent.detail type: GanttTaskEditEventDetail. Event names are case-sensitive.

Event name: `taskEditMove`. Names are case-sensitive. Read the payload from `detail` on `CustomEvent<GanttTaskEditEventDetail>`.

```javascript
chart.addEventListener('taskEditMove', event => {
  console.log(event.detail); // GanttTaskEditEventDetail
});
```

- [GanttTaskEditEventDetail](https://chart.syidax.com/docs/types/GanttTaskEditEventDetail.md) — Type definition

<a id="event-taskEditEnd"></a>

### taskEditEnd

Cancelable before local dates, completion and row order commit. preventDefault restores the prior state.

Event name: `taskEditEnd`. Names are case-sensitive. Read the payload from `detail` on `CustomEvent<GanttTaskEditEventDetail>`.

```javascript
chart.addEventListener('taskEditEnd', event => {
  console.log(event.detail); // GanttTaskEditEventDetail
});
```

- [GanttTaskEditEventDetail](https://chart.syidax.com/docs/types/GanttTaskEditEventDetail.md) — Type definition

<a id="event-taskEditCancel"></a>

### taskEditCancel

CustomEvent.detail type: GanttTaskEditEventDetail. Event names are case-sensitive.

Event name: `taskEditCancel`. Names are case-sensitive. Read the payload from `detail` on `CustomEvent<GanttTaskEditEventDetail>`.

```javascript
chart.addEventListener('taskEditCancel', event => {
  console.log(event.detail); // GanttTaskEditEventDetail
});
```

- [GanttTaskEditEventDetail](https://chart.syidax.com/docs/types/GanttTaskEditEventDetail.md) — Type definition

<a id="event-selectionChanged"></a>

### selectionChanged

CustomEvent.detail type: GanttSelectionChangeEventDetail. Event names are case-sensitive.

Event name: `selectionChanged`. Names are case-sensitive. Read the payload from `detail` on `CustomEvent<GanttSelectionChangeEventDetail>`.

```javascript
chart.addEventListener('selectionChanged', event => {
  console.log(event.detail); // GanttSelectionChangeEventDetail
});
```

- [GanttSelectionChangeEventDetail](https://chart.syidax.com/docs/types/GanttSelectionChangeEventDetail.md) — Type definition

<a id="event-pointContextMenu"></a>

### pointContextMenu

CustomEvent.detail type: ChartPointContextMenuEventDetail<GanttHitDetail>. Event names are case-sensitive.

Event name: `pointContextMenu`. Names are case-sensitive. Read the payload from `detail` on `CustomEvent<ChartPointContextMenuEventDetail<GanttHitDetail>>`.

```javascript
chart.addEventListener('pointContextMenu', event => {
  console.log(event.detail); // ChartPointContextMenuEventDetail<GanttHitDetail>
});
```

- [ChartPointContextMenuEventDetail](https://chart.syidax.com/docs/types/ChartPointContextMenuEventDetail.md) — Type definition
- [GanttHitDetail](https://chart.syidax.com/docs/types/GanttHitDetail.md) — Type definition

<a id="event-appended"></a>

### appended

CustomEvent.detail type: { count: number; replaced: number }. Event names are case-sensitive.

Event name: `appended`. Names are case-sensitive. Read the payload from `detail` on `CustomEvent<{ count: number; replaced: number }>`.

```javascript
chart.addEventListener('appended', event => {
  console.log(event.detail); // { count: number; replaced: number }
});
```

<a id="event-windowSlid"></a>

### windowSlid

CustomEvent.detail type: { dropped: number }. Event names are case-sensitive.

Event name: `windowSlid`. Names are case-sensitive. Read the payload from `detail` on `CustomEvent<{ dropped: number }>`.

```javascript
chart.addEventListener('windowSlid', event => {
  console.log(event.detail); // { dropped: number }
});
```

<a id="event-tooltipShow"></a>

### tooltipShow

Whether to display the built-in tooltip.

Event name: `tooltipShow`. Names are case-sensitive. Read the payload from `detail` on `CustomEvent<CartesianTooltipEventDetail>`.

```javascript
chart.addEventListener('tooltipShow', event => {
  console.log(event.detail); // CartesianTooltipEventDetail
});
```

- [CartesianTooltipEventDetail](https://chart.syidax.com/docs/types/CartesianTooltipEventDetail.md) — Type definition

<a id="event-tooltipHide"></a>

### tooltipHide

CustomEvent.detail type: void. Event names are case-sensitive.

Event name: `tooltipHide`. Names are case-sensitive. Read the payload from `detail` on `CustomEvent<void>`.

```javascript
chart.addEventListener('tooltipHide', event => {
  console.log(event.detail); // void
});
```

<a id="event-tooltipAction"></a>

### tooltipAction

CustomEvent.detail type: CartesianTooltipActionEventDetail. Event names are case-sensitive.

Event name: `tooltipAction`. Names are case-sensitive. Read the payload from `detail` on `CustomEvent<CartesianTooltipActionEventDetail>`.

```javascript
chart.addEventListener('tooltipAction', event => {
  console.log(event.detail); // CartesianTooltipActionEventDetail
});
```

- [CartesianTooltipActionEventDetail](https://chart.syidax.com/docs/types/CartesianTooltipActionEventDetail.md) — Type definition

<a id="event-chartAnimationStart"></a>

### chartAnimationStart

CustomEvent.detail type: void. Event names are case-sensitive.

Event name: `chartAnimationStart`. Names are case-sensitive. Read the payload from `detail` on `CustomEvent<void>`.

```javascript
chart.addEventListener('chartAnimationStart', event => {
  console.log(event.detail); // void
});
```

<a id="event-chartAnimationEnd"></a>

### chartAnimationEnd

CustomEvent.detail type: void. Event names are case-sensitive.

Event name: `chartAnimationEnd`. Names are case-sensitive. Read the payload from `detail` on `CustomEvent<void>`.

```javascript
chart.addEventListener('chartAnimationEnd', event => {
  console.log(event.detail); // void
});
```

<a id="event-chartAnimationInterrupted"></a>

### chartAnimationInterrupted

CustomEvent.detail type: void. Event names are case-sensitive.

Event name: `chartAnimationInterrupted`. Names are case-sensitive. Read the payload from `detail` on `CustomEvent<void>`.

```javascript
chart.addEventListener('chartAnimationInterrupted', event => {
  console.log(event.detail); // void
});
```

<a id="event-zoomChange"></a>

### zoomChange

CustomEvent.detail type: CartesianZoomChangeEventDetail. Event names are case-sensitive.

Event name: `zoomChange`. Names are case-sensitive. Read the payload from `detail` on `CustomEvent<CartesianZoomChangeEventDetail>`.

```javascript
chart.addEventListener('zoomChange', event => {
  console.log(event.detail); // CartesianZoomChangeEventDetail
});
```

- [CartesianZoomChangeEventDetail](https://chart.syidax.com/docs/types/CartesianZoomChangeEventDetail.md) — Type definition

<a id="event-crosshairMove"></a>

### crosshairMove

CustomEvent.detail type: CartesianCrosshairEventDetail | null. Event names are case-sensitive.

Event name: `crosshairMove`. Names are case-sensitive. Read the payload from `detail` on `CustomEvent<CartesianCrosshairEventDetail | null>`.

```javascript
chart.addEventListener('crosshairMove', event => {
  console.log(event.detail); // CartesianCrosshairEventDetail | null
});
```

- [CartesianCrosshairEventDetail](https://chart.syidax.com/docs/types/CartesianCrosshairEventDetail.md) — Type definition

<a id="methods"></a>

## Methods

<a id="method-getCriticalPath"></a>

### getCriticalPath

An asynchronous method. Check the argument and return types below.

```typescript
getCriticalPath(): Promise<GanttCriticalPathResult>
```

Return type: `Promise<GanttCriticalPathResult>`. Call the method after element registration and await its Promise result.

- [GanttCriticalPathResult](https://chart.syidax.com/docs/types/GanttCriticalPathResult.md) — Type definition

<a id="method-getDependencies"></a>

### getDependencies

An asynchronous method. Check the argument and return types below.

```typescript
getDependencies(): Promise<GanttDependencyDataset>
```

Return type: `Promise<GanttDependencyDataset>`. Call the method after element registration and await its Promise result.

- [GanttDependencyDataset](https://chart.syidax.com/docs/types/GanttDependencyDataset.md) — Type definition

<a id="method-getDependencyPaths"></a>

### getDependencyPaths

An asynchronous method. Check the argument and return types below.

```typescript
getDependencyPaths(): Promise<GanttDependencyPath[]>
```

Return type: `Promise<GanttDependencyPath[]>`. Call the method after element registration and await its Promise result.

- [GanttDependencyPath](https://chart.syidax.com/docs/types/GanttDependencyPath.md) — Type definition

<a id="method-hitTestDependency"></a>

### hitTestDependency

An asynchronous method. Check the argument and return types below.

```typescript
hitTestDependency(cssX: number, cssY: number): Promise<GanttDependencyHitDetail|null>
```

| Arguments | Type | Required |
| --- | --- | --- |
| `cssX` | `number` | Required |
| `cssY` | `number` | Required |

Return type: `Promise<GanttDependencyHitDetail|null>`. Call the method after element registration and await its Promise result.

- [GanttDependencyHitDetail](https://chart.syidax.com/docs/types/GanttDependencyHitDetail.md) — Type definition

<a id="method-getDependencySelection"></a>

### getDependencySelection

An asynchronous method. Check the argument and return types below.

```typescript
getDependencySelection(): Promise<GanttDependencySelection>
```

Return type: `Promise<GanttDependencySelection>`. Call the method after element registration and await its Promise result.

- [GanttDependencySelection](https://chart.syidax.com/docs/types/GanttDependencySelection.md) — Type definition

<a id="method-selectDependencyAt"></a>

### selectDependencyAt

An asynchronous method. Check the argument and return types below.

```typescript
selectDependencyAt(index: number): Promise<GanttDependencyHitDetail|null>
```

| Arguments | Type | Required |
| --- | --- | --- |
| `index` | `number` | Required |

Return type: `Promise<GanttDependencyHitDetail|null>`. Call the method after element registration and await its Promise result.

- [GanttDependencyHitDetail](https://chart.syidax.com/docs/types/GanttDependencyHitDetail.md) — Type definition

<a id="method-showDependencyTooltipAtIndex"></a>

### showDependencyTooltipAtIndex

An asynchronous method. Check the argument and return types below.

```typescript
showDependencyTooltipAtIndex(index: number): Promise<CartesianTooltipEventDetail|null>
```

| Arguments | Type | Required |
| --- | --- | --- |
| `index` | `number` | Required |

Return type: `Promise<CartesianTooltipEventDetail|null>`. Call the method after element registration and await its Promise result.

- [CartesianTooltipEventDetail](https://chart.syidax.com/docs/types/CartesianTooltipEventDetail.md) — Type definition

<a id="method-redraw"></a>

### redraw

Redraw the chart using its current data and options. Inspect the rendered result after the returned Promise resolves.

```typescript
redraw(): Promise<GanttRenderResult>
```

Return type: `Promise<GanttRenderResult>`. Call the method after element registration and await its Promise result.

- [GanttRenderResult](https://chart.syidax.com/docs/types/GanttRenderResult.md) — Type definition

<a id="method-getEngineStatus"></a>

### getEngineStatus

Requested engine vs what runs, and why (CHART-ADD-08); a frozen or unlicensed chart reports the license outcome.

```typescript
getEngineStatus(): Promise<ChartEngineStatus>
```

Return type: `Promise<ChartEngineStatus>`. Call the method after element registration and await its Promise result.

- [ChartEngineStatus](https://chart.syidax.com/docs/types/ChartEngineStatus.md) — Type definition

<a id="method-getActiveTier"></a>

### getActiveTier

An asynchronous method. Check the argument and return types below.

```typescript
getActiveTier(): Promise<GanttEngineTier>
```

Return type: `Promise<GanttEngineTier>`. Call the method after element registration and await its Promise result.

- [GanttEngineTier](https://chart.syidax.com/docs/types/GanttEngineTier.md) — Type definition

<a id="method-getUnavailableReason"></a>

### getUnavailableReason

Why the WebGPU renderer could not run (the fallback notice's reason); undefined when nothing fell back.

```typescript
getUnavailableReason(): Promise<string | undefined>
```

Return type: `Promise<string | undefined>`. Call the method after element registration and await its Promise result.

<a id="method-setData"></a>

### setData

Replace the bar set.

```typescript
setData(data: GanttData): Promise<void>
```

| Arguments | Type | Required |
| --- | --- | --- |
| `data` | `GanttData` | Required |

Return type: `Promise<void>`. Call the method after element registration and await its Promise result.

- [GanttData](https://chart.syidax.com/docs/types/GanttData.md) — Type definition

<a id="method-getTasks"></a>

### getTasks

An asynchronous method. Check the argument and return types below.

```typescript
getTasks(): Promise<GanttTask[]>
```

Return type: `Promise<GanttTask[]>`. Call the method after element registration and await its Promise result.

- [GanttTask](https://chart.syidax.com/docs/types/GanttTask.md) — Type definition

<a id="method-getTask"></a>

### getTask

An asynchronous method. Check the argument and return types below.

```typescript
getTask(index: number): Promise<GanttTask | null>
```

| Arguments | Type | Required |
| --- | --- | --- |
| `index` | `number` | Required |

Return type: `Promise<GanttTask | null>`. Call the method after element registration and await its Promise result.

- [GanttTask](https://chart.syidax.com/docs/types/GanttTask.md) — Type definition

<a id="method-getTaskById"></a>

### getTaskById

An asynchronous method. Check the argument and return types below.

```typescript
getTaskById(id: string): Promise<GanttTask | null>
```

| Arguments | Type | Required |
| --- | --- | --- |
| `id` | `string` | Required |

Return type: `Promise<GanttTask | null>`. Call the method after element registration and await its Promise result.

- [GanttTask](https://chart.syidax.com/docs/types/GanttTask.md) — Type definition

<a id="method-getDiagnostics"></a>

### getDiagnostics

Normalization diagnostics for the effective base and stream source.

```typescript
getDiagnostics(): Promise<GanttDiagnostics>
```

Return type: `Promise<GanttDiagnostics>`. Call the method after element registration and await its Promise result.

- [GanttDiagnostics](https://chart.syidax.com/docs/types/GanttDiagnostics.md) — Type definition

<a id="method-getTaskCount"></a>

### getTaskCount

An asynchronous method. Check the argument and return types below.

```typescript
getTaskCount(): Promise<number>
```

Return type: `Promise<number>`. Call the method after element registration and await its Promise result.

<a id="method-getExtent"></a>

### getExtent

An asynchronous method. Check the argument and return types below.

```typescript
getExtent(): Promise<GanttExtent>
```

Return type: `Promise<GanttExtent>`. Call the method after element registration and await its Promise result.

- [GanttExtent](https://chart.syidax.com/docs/types/GanttExtent.md) — Type definition

<a id="method-getLayout"></a>

### getLayout

Host-local geometry as shown. Scale fields preserve ellipses under non-uniform viewport zoom.

```typescript
getLayout(): Promise<GanttLayoutResult>
```

Return type: `Promise<GanttLayoutResult>`. Call the method after element registration and await its Promise result.

- [GanttLayoutResult](https://chart.syidax.com/docs/types/GanttLayoutResult.md) — Type definition

<a id="method-getBaselines"></a>

### getBaselines

Reference comparisons for every accepted task, including hidden/offscreen baselines. Positive variance means later or longer.

```typescript
getBaselines(): Promise<GanttBaselineComparison[]>
```

Return type: `Promise<GanttBaselineComparison[]>`. Call the method after element registration and await its Promise result.

- [GanttBaselineComparison](https://chart.syidax.com/docs/types/GanttBaselineComparison.md) — Type definition

<a id="method-appendPoint"></a>

### appendPoint

Append one value to the stream. Check the argument type and the licensing requirements for streaming.

```typescript
appendPoint(task: GanttTaskInput): Promise<void>
```

| Arguments | Type | Required |
| --- | --- | --- |
| `task` | `GanttTaskInput` | Required |

Return type: `Promise<void>`. Call the method after element registration and await its Promise result.

- [GanttTaskInput](https://chart.syidax.com/docs/types/GanttTaskInput.md) — Type definition

<a id="method-appendBatch"></a>

### appendBatch

Append multiple values to the stream. Check the argument type and the licensing requirements for streaming.

```typescript
appendBatch(tasks: ReadonlyArray<GanttTaskInput>): Promise<void>
```

| Arguments | Type | Required |
| --- | --- | --- |
| `tasks` | `ReadonlyArray<GanttTaskInput>` | Required |

Return type: `Promise<void>`. Call the method after element registration and await its Promise result.

- [GanttTaskInput](https://chart.syidax.com/docs/types/GanttTaskInput.md) — Type definition

<a id="method-shift"></a>

### shift

Drop the oldest streamed categories (the `data` boxes are not the stream).

```typescript
shift(count: number): Promise<void>
```

| Arguments | Type | Required |
| --- | --- | --- |
| `count` | `number` | Required |

Return type: `Promise<void>`. Call the method after element registration and await its Promise result.

<a id="method-replace"></a>

### replace

Swap the streamed set (`replace([])` clears it); the base `values` never leave. Without `chart.streaming` the dies upsert into the base like a batch (quietly: no `appended`, no `binChanged`, as a ring replace).

```typescript
replace(tasks: ReadonlyArray<GanttTaskInput>): Promise<void>
```

| Arguments | Type | Required |
| --- | --- | --- |
| `tasks` | `ReadonlyArray<GanttTaskInput>` | Required |

Return type: `Promise<void>`. Call the method after element registration and await its Promise result.

- [GanttTaskInput](https://chart.syidax.com/docs/types/GanttTaskInput.md) — Type definition

<a id="method-getStreamSource"></a>

### getStreamSource

The stream session's source (Chart Pro): like the stream methods it waits for a license still being confirmed.

```typescript
getStreamSource(): Promise<GanttStreamSource | undefined>
```

Return type: `Promise<GanttStreamSource | undefined>`. Call the method after element registration and await its Promise result.

- [GanttStreamSource](https://chart.syidax.com/docs/types/GanttStreamSource.md) — Type definition

<a id="method-pauseAnimation"></a>

### pauseAnimation

Pause the current animation.

```typescript
pauseAnimation(): Promise<void>
```

Return type: `Promise<void>`. Call the method after element registration and await its Promise result.

<a id="method-resumeAnimation"></a>

### resumeAnimation

Resume a paused animation.

```typescript
resumeAnimation(): Promise<void>
```

Return type: `Promise<void>`. Call the method after element registration and await its Promise result.

<a id="method-replayAnimation"></a>

### replayAnimation

Replay the initial sweep from min → value(s). No-op when animation is off / reduced.

```typescript
replayAnimation(): Promise<void>
```

Return type: `Promise<void>`. Call the method after element registration and await its Promise result.

<a id="method-setAnimation"></a>

### setAnimation

An asynchronous method. Check the argument and return types below.

```typescript
setAnimation(options: { enabled?: boolean; duration?: number; easing?: GanttEasing; type?: GanttAnimationType }): Promise<void>
```

| Arguments | Type | Required |
| --- | --- | --- |
| `options` | `{ enabled?: boolean; duration?: number; easing?: GanttEasing; type?: GanttAnimationType }` | Required |

Return type: `Promise<void>`. Call the method after element registration and await its Promise result.

- [GanttEasing](https://chart.syidax.com/docs/types/GanttEasing.md) — Type definition
- [GanttAnimationType](https://chart.syidax.com/docs/types/GanttAnimationType.md) — Type definition

<a id="method-hitTest"></a>

### hitTest

The box under a host-local CSS point (the nearest slot, within half a pitch), or null.

```typescript
hitTest(cssX: number, cssY: number): Promise<GanttHitDetail | null>
```

| Arguments | Type | Required |
| --- | --- | --- |
| `cssX` | `number` | Required |
| `cssY` | `number` | Required |

Return type: `Promise<GanttHitDetail | null>`. Call the method after element registration and await its Promise result.

- [GanttHitDetail](https://chart.syidax.com/docs/types/GanttHitDetail.md) — Type definition

<a id="method-selectTaskAt"></a>

### selectTaskAt

An asynchronous method. Check the argument and return types below.

```typescript
selectTaskAt(index: number): Promise<GanttHitDetail | null>
```

| Arguments | Type | Required |
| --- | --- | --- |
| `index` | `number` | Required |

Return type: `Promise<GanttHitDetail | null>`. Call the method after element registration and await its Promise result.

- [GanttHitDetail](https://chart.syidax.com/docs/types/GanttHitDetail.md) — Type definition

<a id="method-clearSelection"></a>

### clearSelection

Release the selection (emits selectionChanged when there was one).

```typescript
clearSelection(): Promise<void>
```

Return type: `Promise<void>`. Call the method after element registration and await its Promise result.

<a id="method-getSelection"></a>

### getSelection

The selection: the selected node's / link's detail (`null` = none); its anchors are Pro-derived, refused without a valid license.

```typescript
getSelection(): Promise<GanttSelection>
```

Return type: `Promise<GanttSelection>`. Call the method after element registration and await its Promise result.

- [GanttSelection](https://chart.syidax.com/docs/types/GanttSelection.md) — Type definition

<a id="method-showTooltipAtIndex"></a>

### showTooltipAtIndex

open the tooltip on a box (the facade's `showTooltipAtPoint` routes here); null off the boxes or with the tooltip off.

```typescript
showTooltipAtIndex(index: number): Promise<CartesianTooltipEventDetail | null>
```

| Arguments | Type | Required |
| --- | --- | --- |
| `index` | `number` | Required |

Return type: `Promise<CartesianTooltipEventDetail | null>`. Call the method after element registration and await its Promise result.

- [CartesianTooltipEventDetail](https://chart.syidax.com/docs/types/CartesianTooltipEventDetail.md) — Type definition

<a id="method-showTooltipAtPoint"></a>

### showTooltipAtPoint

Open the tooltip for a dot programmatically. `pointIndex` is the category (row) index; the optional `seriesIndex` selects a group within that row (defaults to the first visible group's dot in the row). Returns the emitted tooltip detail, or null when no dot resolves / the tooltip is disabled.

```typescript
showTooltipAtPoint(index: number): Promise<CartesianTooltipEventDetail | null>
```

| Arguments | Type | Required |
| --- | --- | --- |
| `index` | `number` | Required |

Return type: `Promise<CartesianTooltipEventDetail | null>`. Call the method after element registration and await its Promise result.

- [CartesianTooltipEventDetail](https://chart.syidax.com/docs/types/CartesianTooltipEventDetail.md) — Type definition

<a id="method-hideTooltip"></a>

### hideTooltip

Close the currently visible tooltip.

```typescript
hideTooltip(): Promise<void>
```

Return type: `Promise<void>`. Call the method after element registration and await its Promise result.

<a id="method-getTaskEdits"></a>

### getTaskEdits

Committed local dates, completion and displaced rows; never mutates caller data.

```typescript
getTaskEdits(): Promise<GanttTaskEdit[]>
```

Return type: `Promise<GanttTaskEdit[]>`. Call the method after element registration and await its Promise result.

- [GanttTaskEdit](https://chart.syidax.com/docs/types/GanttTaskEdit.md) — Type definition

<a id="method-resetTaskEdits"></a>

### resetTaskEdits

An asynchronous method. Check the argument and return types below.

```typescript
resetTaskEdits(id?: string): Promise<void>
```

| Arguments | Type | Required |
| --- | --- | --- |
| `id` | `string` | Optional |

Return type: `Promise<void>`. Call the method after element registration and await its Promise result.

<a id="method-cancelTaskEdit"></a>

### cancelTaskEdit

An asynchronous method. Check the argument and return types below.

```typescript
cancelTaskEdit(): Promise<boolean>
```

Return type: `Promise<boolean>`. Call the method after element registration and await its Promise result.

<a id="method-zoomTo"></a>

### zoomTo

Zoom to an explicit millisecond x window. Task rows do not accept y zoom requests.

```typescript
zoomTo(request: CartesianZoomRequest): Promise<CartesianZoomChangeEventDetail | null>
```

| Arguments | Type | Required |
| --- | --- | --- |
| `request` | `CartesianZoomRequest` | Required |

Return type: `Promise<CartesianZoomChangeEventDetail | null>`. Call the method after element registration and await its Promise result.

- [CartesianZoomChangeEventDetail](https://chart.syidax.com/docs/types/CartesianZoomChangeEventDetail.md) — Type definition
- [CartesianZoomRequest](https://chart.syidax.com/docs/types/CartesianZoomRequest.md) — Type definition

<a id="method-zoomBy"></a>

### zoomBy

Scale the current windows by `factor` (< 1 zooms in) around `anchorFraction` (0..1, default centre).

```typescript
zoomBy(factor: number, anchorFraction?: number): Promise<CartesianZoomChangeEventDetail | null>
```

| Arguments | Type | Required |
| --- | --- | --- |
| `factor` | `number` | Required |
| `anchorFraction` | `number` | Optional |

Return type: `Promise<CartesianZoomChangeEventDetail | null>`. Call the method after element registration and await its Promise result.

- [CartesianZoomChangeEventDetail](https://chart.syidax.com/docs/types/CartesianZoomChangeEventDetail.md) — Type definition

<a id="method-panBy"></a>

### panBy

Slide the zoomed windows by milliseconds (`{ x?, y? }`); a no-op at the full extent.

```typescript
panBy(delta: { x?: number; y?: number }): Promise<CartesianZoomChangeEventDetail | null>
```

| Arguments | Type | Required |
| --- | --- | --- |
| `delta` | `{ x?: number; y?: number }` | Required |

Return type: `Promise<CartesianZoomChangeEventDetail | null>`. Call the method after element registration and await its Promise result.

- [CartesianZoomChangeEventDetail](https://chart.syidax.com/docs/types/CartesianZoomChangeEventDetail.md) — Type definition

<a id="method-resetZoom"></a>

### resetZoom

Reset the zoomed or panned range to the original data range.

```typescript
resetZoom(): Promise<CartesianZoomChangeEventDetail | null>
```

Return type: `Promise<CartesianZoomChangeEventDetail | null>`. Call the method after element registration and await its Promise result.

- [CartesianZoomChangeEventDetail](https://chart.syidax.com/docs/types/CartesianZoomChangeEventDetail.md) — Type definition

<a id="method-getZoom"></a>

### getZoom

Read the current zoom range. Check the return type's nullability and the range for each axis.

```typescript
getZoom(): Promise<CartesianZoomState | null>
```

Return type: `Promise<CartesianZoomState | null>`. Call the method after element registration and await its Promise result.

- [CartesianZoomState](https://chart.syidax.com/docs/types/CartesianZoomState.md) — Type definition

<a id="method-getZoomExtent"></a>

### getZoomExtent

The full timestamp extent and axis key (`null` before the first layout).

```typescript
getZoomExtent(request?: CartesianZoomExtentRequest): Promise<CartesianZoomExtentDetail | null>
```

| Arguments | Type | Required |
| --- | --- | --- |
| `request` | `CartesianZoomExtentRequest` | Optional |

Return type: `Promise<CartesianZoomExtentDetail | null>`. Call the method after element registration and await its Promise result.

- [CartesianZoomExtentDetail](https://chart.syidax.com/docs/types/CartesianZoomExtentDetail.md) — Type definition
- [CartesianZoomExtentRequest](https://chart.syidax.com/docs/types/CartesianZoomExtentRequest.md) — Type definition

<a id="method-getDataTable"></a>

### getDataTable

Current normalized table, including the retained stream; independent of GPU availability.

```typescript
getDataTable(): Promise<ChartDataTable>
```

Return type: `Promise<ChartDataTable>`. Call the method after element registration and await its Promise result.

- [ChartDataTable](https://chart.syidax.com/docs/types/ChartDataTable.md) — Type definition

<a id="method-getLabels"></a>

### getLabels

the placed node labels in HOST-local CSS px as shown (the plot offset added; under a zoom the labels of the nodes outside the window are left out), shown or hidden with the reason.

```typescript
getLabels(): Promise<GanttLabel[]>
```

Return type: `Promise<GanttLabel[]>`. Call the method after element registration and await its Promise result.

- [GanttLabel](https://chart.syidax.com/docs/types/GanttLabel.md) — Type definition

<a id="method-getTimeAxis"></a>

### getTimeAxis

An asynchronous method. Check the argument and return types below.

```typescript
getTimeAxis(): Promise<GanttTimeAxisModel>
```

Return type: `Promise<GanttTimeAxisModel>`. Call the method after element registration and await its Promise result.

- [GanttTimeAxisModel](https://chart.syidax.com/docs/types/GanttTimeAxisModel.md) — Type definition

<a id="method-showCrosshairAt"></a>

### showCrosshairAt

Quiet sync API: epoch milliseconds and a zero-based task row; no crosshairMove feedback loop.

```typescript
showCrosshairAt(request: CartesianCrosshairShowRequest): Promise<boolean>
```

| Arguments | Type | Required |
| --- | --- | --- |
| `request` | `CartesianCrosshairShowRequest` | Required |

Return type: `Promise<boolean>`. Call the method after element registration and await its Promise result.

- [CartesianCrosshairShowRequest](https://chart.syidax.com/docs/types/CartesianCrosshairShowRequest.md) — Type definition

<a id="method-hideCrosshair"></a>

### hideCrosshair

hide the crosshair shown by `showCrosshairAt` (or the pointer's).

```typescript
hideCrosshair(): Promise<void>
```

Return type: `Promise<void>`. Call the method after element registration and await its Promise result.