# Density Map

Show concentrations of observations as a smooth density surface.

Canonical: https://chart.syidax.com/docs/components/density-map/

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

## sy-density-map

Explore clusters and spatial concentration among many points.

Density is an estimate, not a raw observation. Results depend on bandwidth and coordinate units.

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

| Input | Data description |
| --- | --- |
| `data` | An array of { x, y, weight? }. |
| `bandwidth` | The range over which the kernel is applied. |
| `kernel` | The kernel used for density estimation. |

- [Run in Components](https://chart.syidax.com/charts/density-map) — 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-density-map.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-density-map",
      "props": {
        "data": [
          {
            "x": 0,
            "y": 7,
            "weight": 1
          },
          {
            "x": 16,
            "y": 4,
            "weight": 2
          },
          {
            "x": 29,
            "y": -3,
            "weight": 3
          },
          {
            "x": 37,
            "y": -7,
            "weight": 1
          },
          {
            "x": 44,
            "y": -5,
            "weight": 2
          },
          {
            "x": 55,
            "y": 2,
            "weight": 3
          },
          {
            "x": -1,
            "y": 17,
            "weight": 1
          },
          {
            "x": 15,
            "y": 15,
            "weight": 2
          },
          {
            "x": 29,
            "y": 9,
            "weight": 3
          },
          {
            "x": 38,
            "y": 4,
            "weight": 1
          },
          {
            "x": 45,
            "y": 4,
            "weight": 2
          },
          {
            "x": 55,
            "y": 10,
            "weight": 3
          },
          {
            "x": -3,
            "y": 26,
            "weight": 1
          },
          {
            "x": 14,
            "y": 26,
            "weight": 2
          },
          {
            "x": 29,
            "y": 21,
            "weight": 3
          },
          {
            "x": 39,
            "y": 15,
            "weight": 1
          },
          {
            "x": 47,
            "y": 13,
            "weight": 2
          },
          {
            "x": 55,
            "y": 18,
            "weight": 3
          },
          {
            "x": -4,
            "y": 35,
            "weight": 1
          },
          {
            "x": 13,
            "y": 37,
            "weight": 2
          },
          {
            "x": 29,
            "y": 33,
            "weight": 3
          },
          {
            "x": 40,
            "y": 26,
            "weight": 1
          },
          {
            "x": 48,
            "y": 23,
            "weight": 2
          },
          {
            "x": 56,
            "y": 26,
            "weight": 3
          },
          {
            "x": -5,
            "y": 43,
            "weight": 1
          },
          {
            "x": 11,
            "y": 47,
            "weight": 2
          },
          {
            "x": 28,
            "y": 45,
            "weight": 3
          },
          {
            "x": 41,
            "y": 38,
            "weight": 1
          },
          {
            "x": 49,
            "y": 33,
            "weight": 2
          },
          {
            "x": 57,
            "y": 35,
            "weight": 3
          },
          {
            "x": -5,
            "y": 51,
            "weight": 1
          },
          {
            "x": 10,
            "y": 56,
            "weight": 2
          },
          {
            "x": 27,
            "y": 56,
            "weight": 3
          },
          {
            "x": 41,
            "y": 50,
            "weight": 1
          },
          {
            "x": 51,
            "y": 44,
            "weight": 2
          },
          {
            "x": 58,
            "y": 44,
            "weight": 3
          }
        ],
        "kernel": "gaussian",
        "bandwidth": 9,
        "columns": 60,
        "rows": 40,
        "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', 'density-map 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, weight? }.

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

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

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

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

### xMin

Explicit domain ends (an omitted end follows the point extent padded by `padding`; `x-axis` / `y-axis` `min` / `max` also set them).

| Item | Value |
| --- | --- |
| JavaScript property | `xMin` |
| HTML attribute | `x-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-xMax"></a>

### xMax

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

| Item | Value |
| --- | --- |
| JavaScript property | `xMax` |
| HTML attribute | `x-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-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 fraction of the span padded on each automatic domain end.

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

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

### cellSize

CSS px per estimate cell (the grid follows the plot size); `columns` / `rows` override it.

| Item | Value |
| --- | --- |
| JavaScript property | `cellSize` |
| HTML attribute | `cell-size` |
| Type | `number` |
| Default | `3` |

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

### columns

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

| Item | Value |
| --- | --- |
| JavaScript property | `columns` |
| HTML attribute | `columns` |
| 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-rows"></a>

### rows

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

| Item | Value |
| --- | --- |
| JavaScript property | `rows` |
| HTML attribute | `rows` |
| 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-bandwidth"></a>

### bandwidth

The range over which the kernel is applied.

| Item | Value |
| --- | --- |
| JavaScript property | `bandwidth` |
| HTML attribute | Pass objects, arrays, and callbacks as JavaScript properties |
| Type | `DensityMapBandwidthInput` |
| Default | `'auto'` |

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

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

### bandwidthUnit

`data` (default) — the bandwidth is in data units; `px` — in CSS px of the plot.

| Item | Value |
| --- | --- |
| JavaScript property | `bandwidthUnit` |
| HTML attribute | `bandwidth-unit` |
| Type | `DensityMapBandwidthUnit` |
| Default | `'data'` |
| Allowed values | `data`, `px` |

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

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

### kernel

The kernel used for density estimation.

| Item | Value |
| --- | --- |
| JavaScript property | `kernel` |
| HTML attribute | `kernel` |
| Type | `DensityMapKernel` |
| Default | `'gaussian'` |
| Allowed values | `gaussian`, `epanechnikov`, `quartic`, `triangular`, `uniform` |

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

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

### threshold

Cells under this fraction of the peak density are empty (the background shows through).

| Item | Value |
| --- | --- |
| JavaScript property | `threshold` |
| HTML attribute | `threshold` |
| Type | `number` |
| Default | `0.02` |

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

### computePath

where the estimate runs: `auto` (the GPU compute once the renderer is up, else the CPU), `cpu`, `gpu`.

| Item | Value |
| --- | --- |
| JavaScript property | `computePath` |
| HTML attribute | `compute-path` |
| Type | `DensityMapComputePathInput` |
| Default | `'auto'` |
| Allowed values | `auto`, `cpu`, `gpu` |

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

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

### colors

The colour ramp over the density domain (a scheme name, a colour list / comma list, or `[t, colour]` stops).

| Item | Value |
| --- | --- |
| JavaScript property | `colors` |
| HTML attribute | Pass objects, arrays, and callbacks as JavaScript properties |
| Type | `string \| ReadonlyArray<string> \| ReadonlyArray<readonly [number, 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-valueMin"></a>

### valueMin

Density domain ends; an omitted end follows 0 … the peak.

| Item | Value |
| --- | --- |
| JavaScript property | `valueMin` |
| HTML attribute | `value-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-valueMax"></a>

### valueMax

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

| Item | Value |
| --- | --- |
| JavaScript property | `valueMax` |
| HTML attribute | `value-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-emptyColor"></a>

### emptyColor

The colour of an empty (under-threshold) cell — transparent by default.

| Item | Value |
| --- | --- |
| JavaScript property | `emptyColor` |
| HTML attribute | `empty-color` |
| Type | `string` |
| Default | `'transparent'` |

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

### lod

The plane's level of detail: `smooth` (bilinear between cell centres — the default here), `auto`, `point`, `area`.

| Item | Value |
| --- | --- |
| JavaScript property | `lod` |
| HTML attribute | `lod` |
| Type | `DensityMapLodMode` |
| Default | `'smooth'` |
| Allowed values | `auto`, `point`, `area`, `smooth` |

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

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

### fade

the fade band above the threshold cut, as a fraction of the peak (0 = a hard edge).

| Item | Value |
| --- | --- |
| JavaScript property | `fade` |
| HTML attribute | `fade` |
| Type | `number` |
| Default | `0.06` |

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

### densityUnit

how densities read: the cell's mass (default) or mass per unit area of the data space.

| Item | Value |
| --- | --- |
| JavaScript property | `densityUnit` |
| HTML attribute | `density-unit` |
| Type | `DensityMapUnitInput` |
| Default | `'mass'` |
| Allowed values | `mass`, `per-area` |

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

<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 default OFF (the plane tiles the plot).

| 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 x / y domains; the estimate is not re-run per gesture — the field's visible sub-rectangle is mapped onto the plot. 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-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 cell tooltip (the shared cartesian tooltip input: show / trigger / format / html / connector / draggable …).

| 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

a plain-text formatter of the default tooltip (`tooltip.format` wins).

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

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

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

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

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

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

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

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

### streamMax

Points the internal stream source tracks at most (the oldest drop first).

| 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 points that feed the estimate (the whole buffer when unset).

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

### visualMap

A visual-map binding (a `sy-visual-map` snapshot + dimension); it overrides `colors` / `value-min` / `value-max` while bound.

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

### engine

`auto`, `standard` and `pro` all run the one WebGPU renderer (a Pro-only type has no other); switching never tears it down.

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

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

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

### unavailable

`fallback` shows the on-chart notice when the renderer cannot run; `error` throws.

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

- [DensityMapUnavailableBehaviour](https://chart.syidax.com/docs/types/DensityMapUnavailableBehaviour.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<DensityMapRenderResult & { tier: DensityMapEngineTier; engine?: ChartEngineStatus }>`.

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

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

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

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

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

### pointHover

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

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

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

- [DensityMapPointEventDetail](https://chart.syidax.com/docs/types/DensityMapPointEventDetail.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<DensityMapPointEventDetail>. Event names are case-sensitive.

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

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

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

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

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

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

### getActiveTier

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

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

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

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

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

### getUnavailableReason

The reason the renderer cannot run (`undefined` while it runs).

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

| Arguments | Type | Required |
| --- | --- | --- |
| `data` | `DensityMapInput` | Required |

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

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

| Arguments | Type | Required |
| --- | --- | --- |
| `point` | `DensityMapPoint \| DensityMapTuple` | Required |

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

- [DensityMapPoint](https://chart.syidax.com/docs/types/DensityMapPoint.md) — Type definition
- [DensityMapTuple](https://chart.syidax.com/docs/types/DensityMapTuple.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(points: ReadonlyArray<DensityMapPoint | DensityMapTuple>): Promise<void>
```

| Arguments | Type | Required |
| --- | --- | --- |
| `points` | `ReadonlyArray<DensityMapPoint \| DensityMapTuple>` | Required |

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

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

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

### shift

(carry-over C9) — `shift(n)` drops the n oldest points of the cloud: the `data` prop's leading entries first (a plain cloud shifts too — before a shift without a stream was a no-op), then the streamed points through the stream source. Each part fires `windowSlid` with its own count.

```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(points: ReadonlyArray<DensityMapPoint | DensityMapTuple>): Promise<void>
```

| Arguments | Type | Required |
| --- | --- | --- |
| `points` | `ReadonlyArray<DensityMapPoint \| DensityMapTuple>` | Required |

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

- [DensityMapPoint](https://chart.syidax.com/docs/types/DensityMapPoint.md) — Type definition
- [DensityMapTuple](https://chart.syidax.com/docs/types/DensityMapTuple.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<DensityMapStreamSource | undefined>
```

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

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

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

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

- [DensityMapEasing](https://chart.syidax.com/docs/types/DensityMapEasing.md) — Type definition
- [DensityMapAnimationType](https://chart.syidax.com/docs/types/DensityMapAnimationType.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 estimate cell under host-relative CSS coordinates, or null (the density waits for a pending readback).

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

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

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

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

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

### getCellValue

The density of a cell in the public unit (`null` under the threshold or outside the grid).

```typescript
getCellValue(col: number, row: number): Promise<number | null>
```

| Arguments | Type | Required |
| --- | --- | --- |
| `col` | `number` | Required |
| `row` | `number` | Required |

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

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

### getDensityAt

The density at a data-space point in the public unit (`null` outside the domain or under the threshold).

```typescript
getDensityAt(x: number, y: number): Promise<number | null>
```

| Arguments | Type | Required |
| --- | --- | --- |
| `x` | `number` | Required |
| `y` | `number` | Required |

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

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

### getValueExtent

The density extent of the estimate in the public unit (min 0, max = the peak, finite = cells over the threshold).

```typescript
getValueExtent(): Promise<DensityMapValueExtent | null>
```

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

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

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

### showTooltipAtCell

open the tooltip on a cell (col / row), honouring the tooltip input; null when off or outside.

```typescript
showTooltipAtCell(col: number, row: number): Promise<CartesianTooltipEventDetail | null>
```

| Arguments | Type | Required |
| --- | --- | --- |
| `col` | `number` | Required |
| `row` | `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-showTooltipAtIndex"></a>

### showTooltipAtIndex

open the tooltip on a cell by its index (`row * columns + col`; the facade's showTooltipAtPoint).

```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-focusCellAt"></a>

### focusCellAt

move the keyboard focus to a cell (the arrow-key state); null clears it.

```typescript
focusCellAt(col: number, row: number): Promise<DensityMapPointEventDetail | null>
```

| Arguments | Type | Required |
| --- | --- | --- |
| `col` | `number` | Required |
| `row` | `number` | Required |

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

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

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

### getGridSize

Columns × rows of the current grid.

```typescript
getGridSize(): Promise<{ columns: number; rows: number; cells: number }>
```

Return type: `Promise<{ columns: number; rows: number; cells: number }>`. Call the method after element registration and await its Promise result.

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

### getDomain

The data domain the grid spans.

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

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

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

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

### getBandwidth

The resolved bandwidth (data units, CSS px, cells; `auto` when Silverman chose it).

```typescript
getBandwidth(): Promise<DensityMapBandwidth>
```

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

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

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

### getKernelTaps

the normalised kernel taps of the current estimate per axis (length 2 × radius + 1; they sum to 1).

```typescript
getKernelTaps(): Promise<{ kernel: DensityMapKernel; x: number[]; y: number[]; radius: { x: number; y: number } }>
```

Return type: `Promise<{ kernel: DensityMapKernel; x: number[]; y: number[]; radius: { x: number; y: number } }>`. Call the method after element registration and await its Promise result.

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

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

### getComputeStats

The statistics of the last estimate (points, grid, kernel, bandwidth, radius, compute time, peak, mass).

```typescript
getComputeStats(): Promise<DensityMapComputeStats>
```

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

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

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

### getPlaneValues

a copy of the current plane (NaN = empty; cell mass), whichever path computed it (waits for a pending readback).

```typescript
getPlaneValues(): Promise<Float32Array>
```

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

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

### computeReference

the CPU reference estimate for the current inputs (the parity oracle of the GPU path; never cached).

```typescript
computeReference(): Promise<{ values: Float32Array; densityMax: number; mass: number; binned: number; finite: number; computeMs: number; radius: { x: number; y: number } }>
```

Return type: `Promise<{ values: Float32Array; densityMax: number; mass: number; binned: number; finite: number; computeMs: number; radius: { x: number; y: number } }>`. Call the method after element registration and await its Promise result.

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

### setVisualMap

Bind (or clear with null) a visual-map snapshot; it wins over the `visualMap` prop until the prop changes again.

```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 of a dimension: `value` = the density (0 … peak), `x` / `y` = the domain, `index` = the cell indexes.

```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-zoomTo"></a>

### zoomTo

Zoom to explicit windows in data units: `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 (the field's x / y domain).

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