# Error Bar

Show uncertainty or a range around a central value.

Canonical: https://chart.syidax.com/docs/components/error-bar/

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

## sy-error-bar-chart

Represent means with confidence intervals, tolerances, or measurement ranges.

Error bars do not determine their own meaning. Explain whether they represent standard deviation, a confidence interval, or another range.

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

| Input | Data description |
| --- | --- |
| `data` | Use { category, value, low, high } or a symmetric error. |

- [Run in Components](https://chart.syidax.com/charts/error-bar) — 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-error-bar-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-error-bar-chart",
      "props": {
        "data": [
          {
            "category": "A",
            "value": 40,
            "low": 32,
            "high": 48
          },
          {
            "category": "B",
            "value": 55,
            "low": 50,
            "high": 63
          },
          {
            "category": "C",
            "value": 47,
            "low": 38,
            "high": 54
          }
        ],
        "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', 'error-bar example chart');
    return element;
  });
  container.replaceChildren(...elements);
  const chart = elements.at(-1);
  const onEvent = event => {
    console.log('pointClick', event.detail);
  };
  chart.addEventListener('pointClick', 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('pointClick', onEvent);
    container.replaceChildren();
  }
</script>
```

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

## Properties

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

### data

Use { category, value, low, high } or a symmetric error.

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

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

- [ErrorBarData](https://chart.syidax.com/docs/types/ErrorBarData.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 | `360` |

<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-xAxis"></a>

### xAxis

Configure the horizontal axis type, categories, range, and formatting. For a category axis, match the categories order to the value array indices. Charts supporting multiple axes can accept an axis array.

| Item | Value |
| --- | --- |
| JavaScript property | `xAxis` |
| HTML attribute | Pass objects, arrays, and callbacks as JavaScript properties |
| Type | `XAxisInput` |
| 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.

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

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

### yAxis

Configure the vertical axis range, ticks, labels, and direction. Use consistent units for comparisons, and consider a zero baseline when comparing bar lengths.

| Item | Value |
| --- | --- |
| JavaScript property | `yAxis` |
| HTML attribute | Pass objects, arrays, and callbacks as JavaScript properties |
| Type | `YAxisInput` |
| 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.

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

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

### gridLines

Grid lines: the value axis's on by default, the category axis's off.

| Item | Value |
| --- | --- |
| JavaScript property | `gridLines` |
| HTML attribute | Pass objects, arrays, and callbacks as JavaScript properties |
| Type | `CartesianGridLinesInput` |
| 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.

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

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

### crosshair

Crosshair that follows the cursor across the plot.

| 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-zoom"></a>

### zoom

Zoom: `'x'` | `'y'` | `'xy'` | `true` (x) enable the drag rectangle, the pan (Shift + drag, the arrows), Ctrl + wheel, the pinch and the keyboard (`+` / `-` / `Escape`) on the primary axes; an object refines them (`mode` / `drag` / `pan` / `wheel` / `pinch` / `keyboard` / `minRangePx` / `resetButton` / `inside`). Off by default; `zoomTo` / `zoomBy` / `panBy` / `resetZoom` work regardless of the gesture switches.

| 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-yMin"></a>

### yMin

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

| Item | Value |
| --- | --- |
| JavaScript property | `yMin` |
| HTML attribute | `y-min` |
| 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-yMax"></a>

### yMax

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

| Item | Value |
| --- | --- |
| JavaScript property | `yMax` |
| HTML attribute | `y-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-padding"></a>

### padding

The automatic domain pads the span over the bounds by this share (default 5 %); bar mode joins zero.

| Item | Value |
| --- | --- |
| JavaScript property | `padding` |
| HTML attribute | `padding` |
| Type | `number` |
| Default | `0.05` |

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

### color

The marker / column colour, the whisker + cap colour, the hovered / focused point.

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

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

### errorColor

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

| Item | Value |
| --- | --- |
| JavaScript property | `errorColor` |
| HTML attribute | `error-color` |
| Type | `string` |
| Default | `DEFAULT_ERROR_COLOR` |

<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 | `DEFAULT_ACTIVE_COLOR` |

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

### showBars

Bar mode: a column from zero to the value instead of a marker (the domain joins zero).

| Item | Value |
| --- | --- |
| JavaScript property | `showBars` |
| HTML attribute | `show-bars` |
| Type | `boolean` |
| Default | `false` |

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

### barWidth

The column's share of the slot pitch (0.6), clamped between `bar-min-px` and `bar-max-px`.

| Item | Value |
| --- | --- |
| JavaScript property | `barWidth` |
| HTML attribute | `bar-width` |
| Type | `number` |
| Default | `ERROR_BAR_DEFAULT_BAR_RATIO` |

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

### barMinPx

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

| Item | Value |
| --- | --- |
| JavaScript property | `barMinPx` |
| HTML attribute | `bar-min-px` |
| Type | `number` |
| Default | `ERROR_BAR_DEFAULT_MIN_PX` |

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

### barMaxPx

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

| Item | Value |
| --- | --- |
| JavaScript property | `barMaxPx` |
| HTML attribute | `bar-max-px` |
| Type | `number` |
| Default | `ERROR_BAR_DEFAULT_MAX_PX` |

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

### capWidth

The caps' share of the slot pitch (0.3; clamped 4 … 40 px; 0 hides them), their switch.

| Item | Value |
| --- | --- |
| JavaScript property | `capWidth` |
| HTML attribute | `cap-width` |
| Type | `number` |
| Default | `ERROR_BAR_DEFAULT_CAP_RATIO` |

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

### showCaps

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

| Item | Value |
| --- | --- |
| JavaScript property | `showCaps` |
| HTML attribute | `show-caps` |
| Type | `boolean` |
| Default | `true` |

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

### markerSize

The marker's size and the whisker's thickness in CSS px.

| Item | Value |
| --- | --- |
| JavaScript property | `markerSize` |
| HTML attribute | `marker-size` |
| Type | `number` |
| Default | `ERROR_BAR_DEFAULT_MARKER_PX` |

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

### whiskerWidth

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

| Item | Value |
| --- | --- |
| JavaScript property | `whiskerWidth` |
| HTML attribute | `whisker-width` |
| Type | `number` |
| Default | `ERROR_BAR_DEFAULT_WHISKER_PX` |

<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

The point tooltip (the shared cartesian tooltip input: trigger, format, html, connector …), its switch, a formatter of the default text.

| 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: ErrorBarPointEventDetail) => string.

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

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

- [ErrorBarPointEventDetail](https://chart.syidax.com/docs/types/ErrorBarPointEventDetail.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 | `ErrorBarEasing` |
| Default | `'ease-out'` |
| Allowed values | `linear`, `ease-out`, `ease-in`, `ease-in-out` |

- [ErrorBarEasing](https://chart.syidax.com/docs/types/ErrorBarEasing.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 | `ErrorBarAnimationType` |
| 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.

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

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

### streamSource

§3.6: an external stream source (category upserts); without one the chart keeps its own on the first push.

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

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

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

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

### streamMax

Points tracked by the internal stream at most (the oldest leave as `windowSlid`).

| 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 newest N streamed items the chart renders (the whole buffer when unset): the N categories pushed most recently keep their points, older streamed categories revert to their `data` point or leave.

| 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-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 | `ErrorBarEngineMode` |
| Default | `'auto'` |
| Allowed values | `auto`, `standard`, `pro` |

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

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

### unavailable

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

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

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

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

## Events

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

### rendered

Every drawn frame; `engine` is the engine status (requested / effective / code / the governing license feature).

Event name: `rendered`. Names are case-sensitive. Read the payload from `detail` on `CustomEvent<ErrorBarRenderResult & { tier: ErrorBarEngineTier; engine?: ChartEngineStatus }>`.

```javascript
chart.addEventListener('rendered', event => {
  console.log(event.detail); // ErrorBarRenderResult & { tier: ErrorBarEngineTier; engine?: ChartEngineStatus }
});
```

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

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

### pointClick

A point selection event. Read the selected data and index from CustomEvent.detail.

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

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

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

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

### pointHover

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

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

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

- [ErrorBarPointEventDetail](https://chart.syidax.com/docs/types/ErrorBarPointEventDetail.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="event-zoomChange"></a>

### zoomChange

Fired after every zoom change (drag / pan / wheel / pinch / keyboard / api / reset) with the new state.

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-pointContextMenu"></a>

### pointContextMenu

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

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

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

- [ChartPointContextMenuEventDetail](https://chart.syidax.com/docs/types/ChartPointContextMenuEventDetail.md) — Type definition
- [ErrorBarPointEventDetail](https://chart.syidax.com/docs/types/ErrorBarPointEventDetail.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

The shared tooltip events (the controller emits them).

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="methods"></a>

## Methods

<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-redraw"></a>

### redraw

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

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

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

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

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

### getActiveTier

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

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

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

- [ErrorBarEngineTier](https://chart.syidax.com/docs/types/ErrorBarEngineTier.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: ErrorBarData): Promise<void>
```

| Arguments | Type | Required |
| --- | --- | --- |
| `data` | `ErrorBarData` | Required |

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

- [ErrorBarData](https://chart.syidax.com/docs/types/ErrorBarData.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(datum: ErrorBarDatumInput): Promise<void>
```

| Arguments | Type | Required |
| --- | --- | --- |
| `datum` | `ErrorBarDatumInput` | Required |

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

- [ErrorBarDatumInput](https://chart.syidax.com/docs/types/ErrorBarDatumInput.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(data: ReadonlyArray<ErrorBarDatumInput>): Promise<void>
```

| Arguments | Type | Required |
| --- | --- | --- |
| `data` | `ReadonlyArray<ErrorBarDatumInput>` | Required |

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

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

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

### shift

Drop the oldest streamed points (the `data` points 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(data: ReadonlyArray<ErrorBarDatumInput>): Promise<void>
```

| Arguments | Type | Required |
| --- | --- | --- |
| `data` | `ReadonlyArray<ErrorBarDatumInput>` | Required |

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

- [ErrorBarDatumInput](https://chart.syidax.com/docs/types/ErrorBarDatumInput.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<ErrorBarStreamSource | undefined>
```

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

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

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

### setAnimation

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

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

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

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

- [ErrorBarEasing](https://chart.syidax.com/docs/types/ErrorBarEasing.md) — Type definition
- [ErrorBarAnimationType](https://chart.syidax.com/docs/types/ErrorBarAnimationType.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-hitTest"></a>

### hitTest

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

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

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

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

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

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

### getPoint

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

```typescript
getPoint(index: number): Promise<ErrorBarPoint | null>
```

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

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

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

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

### getPointByCategory

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

```typescript
getPointByCategory(category: string): Promise<ErrorBarPoint | null>
```

| Arguments | Type | Required |
| --- | --- | --- |
| `category` | `string` | Required |

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

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

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

### getPointCount

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

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

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

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

### getPoints

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

```typescript
getPoints(): Promise<ErrorBarPoint[]>
```

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

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

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

### getCategories

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

```typescript
getCategories(): Promise<string[]>
```

Return type: `Promise<string[]>`. 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<ErrorBarExtent>
```

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

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

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

### getDomain

The data domain the grid spans.

```typescript
getDomain(): Promise<ErrorBarDomain>
```

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

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

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

### showTooltipAtIndex

Open the tooltip on a point (the facade's `showTooltipAtPoint` routes here); null off the points 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-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-focusPointAt"></a>

### focusPointAt

Move the keyboard focus ring to a point (null off the points); emits pointHover like the walk.

```typescript
focusPointAt(index: number): Promise<ErrorBarPointEventDetail | null>
```

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

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

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

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

### zoomTo

Zoom to explicit windows: `x` / `y` as `{ min, max }` or `[min, max]` (`null` clears that orientation); `xAxis` / `yAxis` name the axis by id or slot index (default: the primary axis).

```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 data units (`{ 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 extent (and key) of the primary — or the named — axes (`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-getEngineStatus"></a>

### getEngineStatus

Requested engine vs what runs, and why (CHART-ADD-08): the decision for the current inputs, read without side effects (ProChartLicense.engineStatus); a renderer that failed at run time reports engine-unsupported.

```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