# Radar

Compare multiple metrics in a single outline.

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

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

## sy-radar-chart

Compare product or team capabilities normalized to the same scale.

Axis order changes the shape's appearance. Do not directly compare raw values with different units.

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

| Input | Data description |
| --- | --- |
| `data` | Each series is { name, data, color? }. |
| `categories` | Metric names in the same order as data. |
| `min` | Together with max, defines the shared measurement range. |

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

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

## Complete implementation example

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

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

  const specs = [
    {
      "id": "example-chart",
      "tag": "sy-radar-chart",
      "props": {
        "engine": "standard",
        "categories": ["Performance", "Quality", "Price", "Support", "Scalability"],
        "data": [
          {
            "name": "A",
            "data": [90, 80, 65, 85, 70],
            "color": "#8263d9"
          },
          {
            "name": "B",
            "data": [70, 90, 85, 60, 80],
            "color": "#239c91"
          }
        ],
        "min": 0,
        "max": 100,
        "variant": "area",
        "legend": true,
        "width": 640,
        "height": 360,
        "brandPosition": "bottom-right",
        "brandLogo": ""
      }
    }
  ];
  const container = document.querySelector('#chart-container');
  const elements = specs.map(({ tag, id, props }) => {
    const element = document.createElement(tag);
    element.id = id;
    Object.assign(element, props);
    element.setAttribute('aria-label', 'radar 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

Each series is { name, data, color? }.

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

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

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

### categories

Metric names in the same order as data.

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

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

### min

Together with max, defines the shared measurement range.

| Item | Value |
| --- | --- |
| JavaScript property | `min` |
| HTML attribute | Pass objects, arrays, and callbacks as JavaScript properties |
| Type | `number \| 'auto'` |
| Default | `'auto'` |
| Literals in the type | `auto` |

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

### max

Allowed values: auto. Default: 'auto'.

| Item | Value |
| --- | --- |
| JavaScript property | `max` |
| HTML attribute | Pass objects, arrays, and callbacks as JavaScript properties |
| Type | `number \| 'auto'` |
| Default | `'auto'` |
| Literals in the type | `auto` |

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

### tickInterval

Allowed values: auto. Default: 'auto'.

| Item | Value |
| --- | --- |
| JavaScript property | `tickInterval` |
| HTML attribute | Pass objects, arrays, and callbacks as JavaScript properties |
| Type | `number \| 'auto'` |
| Default | `'auto'` |
| Literals in the type | `auto` |

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

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

### height

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

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

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

### brandLogo

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

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

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

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

### brandPosition

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

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

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

### variant

Allowed values: area, line. Default: 'line'.

| Item | Value |
| --- | --- |
| JavaScript property | `variant` |
| HTML attribute | `variant` |
| Type | `RadarChartVariant` |
| Default | `'line'` |
| Allowed values | `area`, `line` |

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

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

### startAngle

Angle of category 0 in DEGREES (0 = 12 o'clock, clockwise +).

| Item | Value |
| --- | --- |
| JavaScript property | `startAngle` |
| HTML attribute | `start-angle` |
| Type | `number` |
| Default | `0` |

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

### size

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

| Item | Value |
| --- | --- |
| JavaScript property | `size` |
| HTML attribute | Pass objects, arrays, and callbacks as JavaScript properties |
| Type | `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-centerX"></a>

### centerX

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

| Item | Value |
| --- | --- |
| JavaScript property | `centerX` |
| HTML attribute | Pass objects, arrays, and callbacks as JavaScript properties |
| Type | `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-centerY"></a>

### centerY

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

| Item | Value |
| --- | --- |
| JavaScript property | `centerY` |
| HTML attribute | Pass objects, arrays, and callbacks as JavaScript properties |
| Type | `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-color"></a>

### color

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

| Item | Value |
| --- | --- |
| JavaScript property | `color` |
| HTML attribute | `color` |
| Type | `string` |
| Default | `'#2563eb'` |

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

### colors

Multi-series palette. Per-series `color` always wins.

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

### lineWidth

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

| Item | Value |
| --- | --- |
| JavaScript property | `lineWidth` |
| HTML attribute | `line-width` |
| Type | `number` |
| Default | `2` |

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

### fillOpacity

Area-variant fill alpha (0..1).

| Item | Value |
| --- | --- |
| JavaScript property | `fillOpacity` |
| HTML attribute | `fill-opacity` |
| Type | `number` |
| Default | `0.25` |

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

### gridShape

Allowed values: circle, polygon. Default: 'polygon'.

| Item | Value |
| --- | --- |
| JavaScript property | `gridShape` |
| HTML attribute | `grid-shape` |
| Type | `RadarGridShape` |
| Default | `'polygon'` |
| Allowed values | `circle`, `polygon` |

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

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

### gridColor

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

| Item | Value |
| --- | --- |
| JavaScript property | `gridColor` |
| HTML attribute | `grid-color` |
| Type | `string` |
| Default | `'#e5e7eb'` |

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

### showMarkers

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

| Item | Value |
| --- | --- |
| JavaScript property | `showMarkers` |
| HTML attribute | `show-markers` |
| Type | `boolean` |
| Default | `true` |

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

### markerRadius

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

| Item | Value |
| --- | --- |
| JavaScript property | `markerRadius` |
| HTML attribute | `marker-radius` |
| Type | `number` |
| Default | `3` |

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

### showRingLabels

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

| Item | Value |
| --- | --- |
| JavaScript property | `showRingLabels` |
| HTML attribute | `show-ring-labels` |
| Type | `boolean` |
| Default | `true` |

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

### ringLabelColor

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

| Item | Value |
| --- | --- |
| JavaScript property | `ringLabelColor` |
| HTML attribute | `ring-label-color` |
| Type | `string` |
| Default | `'#9ca3af'` |

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

### ringLabelFontSize

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

| Item | Value |
| --- | --- |
| JavaScript property | `ringLabelFontSize` |
| HTML attribute | `ring-label-font-size` |
| Type | `number` |
| Default | `10` |

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

### ringLabelFormat

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

| Item | Value |
| --- | --- |
| JavaScript property | `ringLabelFormat` |
| HTML attribute | `ring-label-format` |
| 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-categoryLabelColor"></a>

### categoryLabelColor

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

| Item | Value |
| --- | --- |
| JavaScript property | `categoryLabelColor` |
| HTML attribute | `category-label-color` |
| Type | `string` |
| Default | `'#374151'` |

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

### categoryLabelFontSize

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

| Item | Value |
| --- | --- |
| JavaScript property | `categoryLabelFontSize` |
| HTML attribute | `category-label-font-size` |
| Type | `number` |
| Default | `12` |

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

### tooltipShow

Whether to display the built-in tooltip.

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

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

### tooltipFormat

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

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

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

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

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

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

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

### crosshair

Crosshair guide — the SAME parameter names as the cartesian charts, read on the polar pane. Off by default. Accepts `true` / a partial spec `{ show, mode, snap, color, dash }`. `mode 'vertical'` → the category axis guide = a radial spoke; `mode 'horizontal'` → the value axis guide = a concentric ring; `mode 'cross'` → both. `snap 'nearest'` snaps to the nearest vertex, `'index'` to the nearest category, `'off'` is the raw pointer. Objects can't ride an attribute — set it as a property (or via a `<sy-chart>` script).

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

### legendPosition

Where the legend is positioned.

| Item | Value |
| --- | --- |
| JavaScript property | `legendPosition` |
| HTML attribute | `legend-position` |
| Type | `RadarChartLegendPosition` |
| Default | `'bottom'` |
| Allowed values | `top`, `bottom`, `left`, `right` |

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

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

### legendItems

Pass as a JavaScript property. type: LegendItem[].

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

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

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

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

### activeSeriesIndex

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

| Item | Value |
| --- | --- |
| JavaScript property | `activeSeriesIndex` |
| HTML attribute | `active-series-index` |
| 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-seriesActiveTrigger"></a>

### seriesActiveTrigger

Allowed values: hover, click, custom. Default: 'click'.

| Item | Value |
| --- | --- |
| JavaScript property | `seriesActiveTrigger` |
| HTML attribute | `series-active-trigger` |
| Type | `RadarChartSeriesActiveTrigger` |
| Default | `'click'` |
| Allowed values | `hover`, `click`, `custom` |

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

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

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

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

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

### editable

Enables direct pointer editing of point values.

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

<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 | `RadarChartStreamSource` |
| Default | `undefined` |

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

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

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

### streamWindow

The streaming data range to keep visible.

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

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

<a id="property-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 | `RadarChartEngineMode` |
| Default | `'auto'` |
| Allowed values | `auto`, `standard`, `pro` |

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

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

### proThreshold

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

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

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

### unavailable

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

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

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

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

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

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

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

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

### pointHover

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

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

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

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

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

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

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

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

### pointChange

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

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

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

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

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

### legendItemClick

CustomEvent.detail type: { index: number; seriesId: string; label: string; disabled: boolean }. Event names are case-sensitive.

Event name: `legendItemClick`. Names are case-sensitive. Read the payload from `detail` on `CustomEvent<{ index: number; seriesId: string; label: string; disabled: boolean }>`.

```javascript
chart.addEventListener('legendItemClick', event => {
  console.log(event.detail); // { index: number; seriesId: string; label: string; disabled: boolean }
});
```

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

### seriesToggled

CustomEvent.detail type: { index: number; seriesId: string; disabled: boolean }. Event names are case-sensitive.

Event name: `seriesToggled`. Names are case-sensitive. Read the payload from `detail` on `CustomEvent<{ index: number; seriesId: string; disabled: boolean }>`.

```javascript
chart.addEventListener('seriesToggled', event => {
  console.log(event.detail); // { index: number; seriesId: string; disabled: boolean }
});
```

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

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

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

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

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

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

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

## Methods

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

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

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

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

### getActiveTier

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

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

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

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

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

### setData

Replace the bar set.

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

| Arguments | Type | Required |
| --- | --- | --- |
| `data` | `RadarChartData` | Required |

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

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

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

### addSeries

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

```typescript
addSeries(series: RadarChartData[number], opts?: { insertAt?: number }): Promise<number>
```

| Arguments | Type | Required |
| --- | --- | --- |
| `series` | `RadarChartData[number]` | Required |
| `opts` | `{ insertAt?: number }` | Optional |

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

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

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

### removeSeries

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

```typescript
removeSeries(idOrIndex: string | number): Promise<boolean>
```

| Arguments | Type | Required |
| --- | --- | --- |
| `idOrIndex` | `string \| number` | Required |

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

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

### updateSeries

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

```typescript
updateSeries(idOrIndex: string | number, patch: Partial<RadarChartData[number]>): Promise<boolean>
```

| Arguments | Type | Required |
| --- | --- | --- |
| `idOrIndex` | `string \| number` | Required |
| `patch` | `Partial<RadarChartData[number]>` | Required |

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

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

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

### updatePoint

Radar-only — patch one category value in a series.

```typescript
updatePoint(seriesIdOrIndex: string | number, categoryIdOrIndex: string | number, value: number | null): Promise<boolean>
```

| Arguments | Type | Required |
| --- | --- | --- |
| `seriesIdOrIndex` | `string \| number` | Required |
| `categoryIdOrIndex` | `string \| number` | Required |
| `value` | `number \| null` | Required |

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

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

### appendPoint

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

```typescript
appendPoint(frame: RadarStreamFrame): Promise<void>
```

| Arguments | Type | Required |
| --- | --- | --- |
| `frame` | `RadarStreamFrame` | Required |

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

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

| Arguments | Type | Required |
| --- | --- | --- |
| `frames` | `ReadonlyArray<RadarStreamFrame>` | Required |

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

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

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

### shift

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

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

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

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(frames: ReadonlyArray<RadarStreamFrame>): Promise<void>
```

| Arguments | Type | Required |
| --- | --- | --- |
| `frames` | `ReadonlyArray<RadarStreamFrame>` | Required |

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

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

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

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

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

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

- [RadarChartEasing](https://chart.syidax.com/docs/types/RadarChartEasing.md) — Type definition
- [RadarChartAnimationType](https://chart.syidax.com/docs/types/RadarChartAnimationType.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 box under a host-local CSS point (the nearest slot, within half a pitch), or null.

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

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

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

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

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

### showTooltipAt

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

```typescript
showTooltipAt(seriesIndex: number, categoryIndex: number): Promise<RadarChartPointerEventDetail | null>
```

| Arguments | Type | Required |
| --- | --- | --- |
| `seriesIndex` | `number` | Required |
| `categoryIndex` | `number` | Required |

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

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

### getEngineStatus

Requested engine vs what runs, and why (CHART-ADD-08): always Standard (this type has no WebGPU renderer); read without side effects, never consults the license.

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