# Surface 3d

Show gridded measurements as a continuous 3D surface.

Canonical: https://chart.syidax.com/docs/components/surface-3d/

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

## sy-surface-3d

Explore a value across two coordinates, such as temperature, elevation, or a response surface.

Watch for perspective and occlusion. Change the camera angle and supplement precise values with data.

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

| Input | Data description |
| --- | --- |
| `data` | A grid as { x, y, z }. z[row][column] is the height at x[column], y[row]. null creates a gap. |

- [Run in Components](https://chart.syidax.com/charts/surface-3d) — 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-surface-3d.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-surface-3d",
      "props": {
        "data": {
          "x": [-2, -1, 0, 1, 2],
          "y": [-2, -1, 0, 1, 2],
          "z": [
            [0, 3, 4, 3, 0],
            [3, 6, 7, 6, 3],
            [4, 7, 8, 7, 4],
            [3, 6, 7, 6, 3],
            [0, 3, 4, 3, 0]
          ]
        },
        "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', 'surface-3d 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

A grid as { x, y, z }. z[row][column] is the height at x[column], y[row]. null creates a gap.

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

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

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

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

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

### colors

Pass as a JavaScript property. type: HeatmapColorInput.

| Item | Value |
| --- | --- |
| JavaScript property | `colors` |
| HTML attribute | Pass objects, arrays, and callbacks as JavaScript properties |
| Type | `HeatmapColorInput` |
| Default | `'viridis'` |

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

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

### colorDomain

Pass as a JavaScript property. type: Surface3DDomain.

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

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

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

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

### missingColor

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

| Item | Value |
| --- | --- |
| JavaScript property | `missingColor` |
| HTML attribute | `missing-color` |
| Type | `string` |
| Default | `'#94a3b8'` |

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

### surfaceSize

Pass as a JavaScript property. type: Scene3DVector.

| Item | Value |
| --- | --- |
| JavaScript property | `surfaceSize` |
| HTML attribute | Pass objects, arrays, and callbacks as JavaScript properties |
| Type | `Scene3DVector` |
| Default | `[2,2,2]` |

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

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

### opacity

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

| Item | Value |
| --- | --- |
| JavaScript property | `opacity` |
| HTML attribute | `opacity` |
| Type | `number` |
| Default | `1` |

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

### legend

Whether to show a legend for series or items.

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

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

### locale

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

| Item | Value |
| --- | --- |
| JavaScript property | `locale` |
| HTML attribute | `locale` |
| Type | `string` |
| Default | `'en-US'` |

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

### axes

Pass as a JavaScript property. type: Surface3DAxesOptions|boolean|string.

| Item | Value |
| --- | --- |
| JavaScript property | `axes` |
| HTML attribute | Pass objects, arrays, and callbacks as JavaScript properties |
| Type | `Surface3DAxesOptions\|boolean\|string` |
| Default | `undefined` |

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

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

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

### wireframe

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

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

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

### wireWidth

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

| Item | Value |
| --- | --- |
| JavaScript property | `wireWidth` |
| HTML attribute | `wire-width` |
| Type | `number` |
| Default | `.8` |

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

### wireColor

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

| Item | Value |
| --- | --- |
| JavaScript property | `wireColor` |
| HTML attribute | `wire-color` |
| Type | `string` |
| Default | `'#475569'` |

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

### material

Pass as a JavaScript property. type: Scene3DMaterialOptions.

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

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

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

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

### lighting

Pass as a JavaScript property. type: Scene3DLightingOptions.

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

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

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

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

### camera

Pass as a JavaScript property. type: Scene3DCameraOptions|string.

| Item | Value |
| --- | --- |
| JavaScript property | `camera` |
| HTML attribute | Pass objects, arrays, and callbacks as JavaScript properties |
| Type | `Scene3DCameraOptions\|string` |
| Default | `undefined` |

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

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

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

### orbit

Pass as a JavaScript property. type: Orbit3DOptions|boolean|string.

| Item | Value |
| --- | --- |
| JavaScript property | `orbit` |
| HTML attribute | Pass objects, arrays, and callbacks as JavaScript properties |
| Type | `Orbit3DOptions\|boolean\|string` |
| Default | `undefined` |

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

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

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

### showEmpty

Whether the component shows its own empty-geometry notice.

| Item | Value |
| --- | --- |
| JavaScript property | `showEmpty` |
| HTML attribute | `show-empty` |
| Type | `boolean` |
| Default | `true` |

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

### activeColor

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

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

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

### enableMouseTracking

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

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

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

### tooltip

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

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

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

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

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

### tooltipEnabled

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

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

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

### tooltipFormat

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

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

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

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

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

### crosshair

Pass as a JavaScript property. type: CartesianCrosshairInput.

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

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

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

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

### crosshairSnapDistance

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

| Item | Value |
| --- | --- |
| JavaScript property | `crosshairSnapDistance` |
| HTML attribute | `crosshair-snap-distance` |
| Type | `number` |
| Default | `12` |

<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 | `Surface3DEasing` |
| Default | `'ease-out'` |
| Allowed values | `linear`, `ease-out`, `ease-in`, `ease-in-out` |

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

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

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

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

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

### streamMax

The maximum number of streaming data points to retain.

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

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

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

### engine

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

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

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

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

### unavailable

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

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

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

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

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

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

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

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

### pointHover

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

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

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

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

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

### selectionChanged

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

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

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

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

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

### pointContextMenu

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

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

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

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

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

### cameraChange

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

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

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

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

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

### crosshairMove

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

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

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

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

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

### appended

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

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

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

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

### windowSlid

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

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

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

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

### tooltipShow

Whether to display the built-in tooltip.

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

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

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

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

### tooltipHide

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

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

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

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

### tooltipAction

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

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

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

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

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

### chartAnimationStart

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

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

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

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

### chartAnimationEnd

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

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

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

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

### chartAnimationInterrupted

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

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

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

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

### dataValidationError

CustomEvent.detail type: {message:string}. Event names are case-sensitive.

Event name: `dataValidationError`. Names are case-sensitive. Read the payload from `detail` on `CustomEvent<{message:string}>`.

```javascript
chart.addEventListener('dataValidationError', event => {
  console.log(event.detail); // {message:string}
});
```

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

## Methods

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

### appendPoint

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

```typescript
appendPoint(row: Surface3DRowInput): Promise<void>
```

| Arguments | Type | Required |
| --- | --- | --- |
| `row` | `Surface3DRowInput` | Required |

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

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

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

### appendPoints

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

```typescript
appendPoints(rows: ReadonlyArray<Surface3DRowInput>): Promise<void>
```

| Arguments | Type | Required |
| --- | --- | --- |
| `rows` | `ReadonlyArray<Surface3DRowInput>` | Required |

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

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

| Arguments | Type | Required |
| --- | --- | --- |
| `rows` | `ReadonlyArray<Surface3DRowInput>` | Required |

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

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

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

### shiftPoints

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

```typescript
shiftPoints(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-shift"></a>

### shift

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

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

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

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

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

### clearStream

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

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

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(rows: ReadonlyArray<Surface3DRowInput>): Promise<void>
```

| Arguments | Type | Required |
| --- | --- | --- |
| `rows` | `ReadonlyArray<Surface3DRowInput>` | Required |

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

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

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

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

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

### setData

Replace the bar set.

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

| Arguments | Type | Required |
| --- | --- | --- |
| `data` | `Surface3DData` | Required |

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

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

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

### getData

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

```typescript
getData(): Promise<Surface3DGrid>
```

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

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

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

### getDiagnostics

Normalization diagnostics for the effective base and stream source.

```typescript
getDiagnostics(): Promise<{ missingHeights: number; invalidHeights: number; missingValues: number; invalidValues: number; }>
```

Return type: `Promise<{ missingHeights: number; invalidHeights: number; missingValues: number; invalidValues: number; }>`. Call the method after element registration and await its Promise result.

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

### getLayout

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

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

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

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

### setAnimation

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

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

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

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

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

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

### getCamera

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

```typescript
getCamera(): Promise<Scene3DCameraOptions>
```

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

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

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

### setCamera

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

```typescript
setCamera(options: Scene3DCameraOptions): Promise<void>
```

| Arguments | Type | Required |
| --- | --- | --- |
| `options` | `Scene3DCameraOptions` | Required |

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

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

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

### setProjection

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

```typescript
setProjection(projection: Scene3DProjection): Promise<void>
```

| Arguments | Type | Required |
| --- | --- | --- |
| `projection` | `Scene3DProjection` | Required |

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

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

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

### resetCamera

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

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

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

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

### saveCamera

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

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

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

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

### fitSurface

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

```typescript
fitSurface(padding?: number): Promise<void>
```

| Arguments | Type | Required |
| --- | --- | --- |
| `padding` | `number` | Optional |

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

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

### zoomBy

A factor below one moves closer. Perspective changes distance; orthographic changes zoom.

```typescript
zoomBy(factor: number): Promise<void>
```

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

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

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

### rotateBy

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

```typescript
rotateBy(azimuth: number, polar?: number): Promise<void>
```

| Arguments | Type | Required |
| --- | --- | --- |
| `azimuth` | `number` | Required |
| `polar` | `number` | Optional |

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

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

### panBy

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

```typescript
panBy(x: number, y: number): Promise<void>
```

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

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

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

### resetZoom

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

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

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

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

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

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

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

### getActiveTier

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

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

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

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

### getEngineStatus

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

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

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

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

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

### recycleGpu

Without the grant (or while frozen) nothing is recycled: no GPU work starts.

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

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

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

### hitTest

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

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

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

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

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

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

### selectPointAt

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

```typescript
selectPointAt(row: number, column: number): Promise<Surface3DHitDetail|null>
```

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

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

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

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

### clearSelection

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

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

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

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

### getSelection

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

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

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

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

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

### showTooltipAtPoint

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

```typescript
showTooltipAtPoint(row: number, column: number): Promise<CartesianTooltipEventDetail|null>
```

| Arguments | Type | Required |
| --- | --- | --- |
| `row` | `number` | Required |
| `column` | `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 box (the facade's `showTooltipAtPoint` routes here); null off the boxes or with the tooltip off.

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

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

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

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

<a id="method-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-showCrosshairAt"></a>

### showCrosshairAt

show the crosshair at a data position (a linked chart's cursor) without emitting `crosshairMove`; false when it falls outside the plot.

```typescript
showCrosshairAt(row: number, column: number): Promise<boolean>
```

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

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

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

### showCrosshairAtData

Quiet cross-chart synchronization in data units, including positions between grid samples.

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

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

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

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

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

### hideCrosshair

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

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

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

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

### getCSV

The tape as a CSV table (ISO time, OHLC, volume).

```typescript
getCSV(options?: CsvOptions): Promise<string>
```

| Arguments | Type | Required |
| --- | --- | --- |
| `options` | `CsvOptions` | Optional |

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

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

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

### getTable

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

```typescript
getTable(): Promise<string>
```

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