# Bubble

Read three measures through point position and size.

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

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

## sy-bubble-chart

Compare markets, products, or projects with two coordinates and a magnitude.

Overlapping bubbles can hide small items. State the meaning and unit of z.

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

| Input | Data description |
| --- | --- |
| `data` | An array of { x, y, z, name? }. x and y determine position; z determines size. |

- [Run in Components](https://chart.syidax.com/charts/bubble) — 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/components/sy-bubble-chart.js';
  define0();

  const specs = [
    {
      "id": "example-chart",
      "tag": "sy-bubble-chart",
      "props": {
        "data": [
          {
            "x": 20,
            "y": 70,
            "z": 30,
            "name": "A"
          },
          {
            "x": 45,
            "y": 55,
            "z": 60,
            "name": "B"
          },
          {
            "x": 75,
            "y": 80,
            "z": 45,
            "name": "C"
          },
          {
            "x": 60,
            "y": 30,
            "z": 20,
            "name": "D"
          }
        ],
        "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', 'bubble 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

An array of { x, y, z, name? }. x and y determine position; z determines size.

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

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

- [BubbleData](https://chart.syidax.com/docs/types/BubbleData.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: both axes on by default.

| 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 (Storybook parity, 2026-09-10): `'x'` | `'y'` | `'xy'` | `true` (x) enable the drag rectangle, the pan, the Ctrl + wheel, the pinch and the keyboard (`+` / `-` / `Escape`) on the primary axes; an object refines `mode` / `drag` / `keyboard` / `minRangePx` / `resetButton` / `pan` / `wheel` / `pinch` / `inside`. Off by default; the methods (`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-padding"></a>

### padding

The automatic domain pads each span by this share (default 5 %).

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

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

### color

The bubble colour: the border, and the fill at `fill-alpha`.

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

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

### fillAlpha

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

| Item | Value |
| --- | --- |
| JavaScript property | `fillAlpha` |
| HTML attribute | `fill-alpha` |
| Type | `number` |
| Default | `DEFAULT_FILL_ALPHA` |

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

### borderColor

The border colour (`auto` = the bubble colour) and its thickness in CSS px (0 = none).

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

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

### borderWidth

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

| Item | Value |
| --- | --- |
| JavaScript property | `borderWidth` |
| HTML attribute | `border-width` |
| Type | `number` |
| Default | `1` |

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

### activeColor

The accent fill of the hovered / focused bubble.

| Item | Value |
| --- | --- |
| JavaScript property | `activeColor` |
| HTML attribute | `active-color` |
| Type | `string` |
| Default | `DEFAULT_ACTIVE_COLOR` |

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

### minRadius

The radius range in CSS px the z range maps onto.

| Item | Value |
| --- | --- |
| JavaScript property | `minRadius` |
| HTML attribute | `min-radius` |
| Type | `number` |
| Default | `BUBBLE_DEFAULT_MIN_RADIUS` |

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

### maxRadius

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

| Item | Value |
| --- | --- |
| JavaScript property | `maxRadius` |
| HTML attribute | `max-radius` |
| Type | `number` |
| Default | `BUBBLE_DEFAULT_MAX_RADIUS` |

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

### sizeScale

`area` (the disc area proportional to z; the default) or `radius`.

| Item | Value |
| --- | --- |
| JavaScript property | `sizeScale` |
| HTML attribute | `size-scale` |
| Type | `BubbleSizeScale \| string` |
| Default | `'area'` |

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

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

### zMin

The z range (the data's when unset): z at or below `z-min` takes the min radius, at or above `z-max` the max.

| Item | Value |
| --- | --- |
| JavaScript property | `zMin` |
| HTML attribute | `z-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-zMax"></a>

### zMax

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

| Item | Value |
| --- | --- |
| JavaScript property | `zMax` |
| HTML attribute | `z-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-layout"></a>

### layout

`xy` places the bubbles on the two axes; `pack` packs them into a cluster centred on the plot (the axes hidden).

| Item | Value |
| --- | --- |
| JavaScript property | `layout` |
| HTML attribute | `layout` |
| Type | `BubbleLayoutMode \| string` |
| Default | `'xy'` |

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

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

### packPadding

Pack mode: the gap between tangent bubbles in CSS px; `contain` only shrinks the cluster to fit, `fill` scales it to touch the shorter side.

| Item | Value |
| --- | --- |
| JavaScript property | `packPadding` |
| HTML attribute | `pack-padding` |
| Type | `number` |
| Default | `2` |

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

### packFit

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

| Item | Value |
| --- | --- |
| JavaScript property | `packFit` |
| HTML attribute | `pack-fit` |
| Type | `BubblePackFit \| string` |
| Default | `'contain'` |

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

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

### visualMap

a visual-map binding (a `sy-visual-map` snapshot + dimension: `value` / `z` colour by z, `x`, `y`, `index`) filling every bubble through its ramp; a datum's own `color` wins.

| Item | Value |
| --- | --- |
| JavaScript property | `visualMap` |
| HTML attribute | Pass objects, arrays, and callbacks as JavaScript properties |
| Type | `VisualMapBinding \| null` |
| Default | `undefined` |

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

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

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

### shading

`flat` (the default) or `sphere` (a highlight towards the top-left and a darker rim — the three-dimensional cue) with its strength 0 … 1.

| Item | Value |
| --- | --- |
| JavaScript property | `shading` |
| HTML attribute | `shading` |
| Type | `BubbleShading \| string` |
| Default | `'flat'` |

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

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

### shadeStrength

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

| Item | Value |
| --- | --- |
| JavaScript property | `shadeStrength` |
| HTML attribute | `shade-strength` |
| Type | `number` |
| Default | `1` |

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

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

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

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

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

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

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

### streamSource

§3.6: an external stream source (bubbles append); without one the chart keeps its own on the first push. Chart Pro (`chart.streaming`): ignored without it.

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

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

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

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

### streamMax

Bubbles tracked by the internal stream at most (the oldest leave as `windowSlid`). Chart Pro (`chart.streaming`).

| 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 bubbles the chart renders (the whole buffer when unset). Chart Pro (`chart.streaming`).

| 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

`auto` (the Standard renderer below `pro-threshold` bubbles, the WebGPU renderer from there with Chart Pro), `standard` or `pro`.

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

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

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

### proThreshold

`auto` switches to the WebGPU renderer at this many bubbles (a missing or non-positive value uses 50,000).

| Item | Value |
| --- | --- |
| JavaScript property | `proThreshold` |
| HTML attribute | `pro-threshold` |
| Type | `number` |
| Default | `BUBBLE_DEFAULT_PRO_THRESHOLD` |

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

### unavailable

`fallback` (the Standard renderer and the notice) or `error` (an explicit `engine="pro"` that cannot run throws).

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

- [BubbleUnavailableBehaviour](https://chart.syidax.com/docs/types/BubbleUnavailableBehaviour.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<BubbleRenderResult & { tier: BubbleEngineTier }>`.

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

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

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

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

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

### pointHover

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

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

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

- [BubblePointEventDetail](https://chart.syidax.com/docs/types/BubblePointEventDetail.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-pointContextMenu"></a>

### pointContextMenu

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

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

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

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

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

### appended

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

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

```javascript
chart.addEventListener('appended', event => {
  console.log(event.detail); // { count: 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="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="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<BubbleRenderResult>
```

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

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

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

### getActiveTier

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

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

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

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

| Arguments | Type | Required |
| --- | --- | --- |
| `data` | `BubbleData` | Required |

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

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

| Arguments | Type | Required |
| --- | --- | --- |
| `datum` | `BubbleDatumInput` | Required |

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

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

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

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

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

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

### shift

Drop the oldest streamed bubbles (the `data` bubbles are not the stream); with nothing streamed it does nothing and asks nothing.

```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<BubbleDatumInput>): Promise<void>
```

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

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

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

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

- [BubbleStreamSource](https://chart.syidax.com/docs/types/BubbleStreamSource.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?: BubbleEasing; enabled?: boolean; type?: BubbleAnimationType }): Promise<void>
```

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

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

- [BubbleEasing](https://chart.syidax.com/docs/types/BubbleEasing.md) — Type definition
- [BubbleAnimationType](https://chart.syidax.com/docs/types/BubbleAnimationType.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 bubble under a host-local CSS point (the smallest disc containing it), or null.

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

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

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

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

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

### getPoint

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

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

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

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

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

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

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

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

### getExtent

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

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

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

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

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

### getDomain

The data domain the grid spans.

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

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

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

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

### getRadiusScale

The z → radius mapping the chart resolved (the z range, the radius range in CSS px, the scale).

```typescript
getRadiusScale(): Promise<BubbleRadiusScale>
```

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

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

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

### getPackLayout

the packed cluster in plot CSS px (null in xy mode): the scale applied to the radii, the enclosing circle, one circle per bubble.

```typescript
getPackLayout(): Promise<BubblePackLayout | null>
```

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

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

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

### setVisualMap

Bind (or clear) a visual map: every bubble is filled through it on the next frame (a datum's own colour still wins).

```typescript
setVisualMap(binding: VisualMapBinding | null): Promise<VisualMapBinding | null>
```

| Arguments | Type | Required |
| --- | --- | --- |
| `binding` | `VisualMapBinding \| null` | Required |

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

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

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

### getVisualMap

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

```typescript
getVisualMap(): Promise<VisualMapBinding | null>
```

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

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

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

### getVisualExtent

The extent a bound `sy-visual-map` adopts as its domain: z (`value` / `z`), x, y, or the index range.

```typescript
getVisualExtent(request?: VisualMapExtentRequest): Promise<VisualMapExtent | null>
```

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

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

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

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

### showTooltipAtIndex

Open the tooltip on a bubble (the facade's `showTooltipAtPoint` routes here); null off the bubbles 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 bubble (null off the bubbles); emits pointHover like the walk.

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

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

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

- [BubblePointEventDetail](https://chart.syidax.com/docs/types/BubblePointEventDetail.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 — master axes (pack mode: the unit square).

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

The requested engine, the engine that draws and why — the last engine decision. A Chart Pro license decision names `chart.webgpu` and its state; renderer causes (not in this build, no WebGPU, a failed GPU) stay apart and never list an entitlement.

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