# Word Cloud

Represent word weights through text size.

Canonical: https://chart.syidax.com/docs/components/word-cloud/

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

## sy-word-cloud

Use for a quick overview of keyword frequency and topics.

Word length also affects perceived size. Use a table for exact rankings and values.

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

| Input | Data description |
| --- | --- |
| `values` | An array of [word, weight] or { name, weight }. |
| `weightScale` | The scale converting weights to text sizes. |

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

  const specs = [
    {
      "id": "example-chart",
      "tag": "sy-word-cloud",
      "props": {
        "engine": "standard",
        "values": [
          ["Data", 40],
          ["Design", 32],
          ["chart", 28],
          ["Usability", 24],
          ["Analysis", 20],
          ["Trust", 18],
          ["Collaboration", 16],
          ["Accessibility", 14],
          ["Performance", 12]
        ],
        "weightScale": "sqrt",
        "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', 'word-cloud 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-values"></a>

### values

An array of [word, weight] or { name, weight }.

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

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

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

### palette

Allowed values: tableau10, tableau20, observable10, paired12, set3_12. Default: 'tableau10'.

| Item | Value |
| --- | --- |
| JavaScript property | `palette` |
| HTML attribute | `palette` |
| Type | `WordCloudPaletteName` |
| Default | `'tableau10'` |
| Allowed values | `tableau10`, `tableau20`, `observable10`, `paired12`, `set3_12` |

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

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

### colors

Pass as a JavaScript property. type: ReadonlyArray<string>.

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

### minFontSize

Smallest rendered font in px (Highcharts `minFontSize`).

| Item | Value |
| --- | --- |
| JavaScript property | `minFontSize` |
| HTML attribute | `min-font-size` |
| Type | `number` |
| Default | `10` |

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

### maxFontSize

Font of the heaviest word in px (Highcharts `maxFontSize`).

| Item | Value |
| --- | --- |
| JavaScript property | `maxFontSize` |
| HTML attribute | `max-font-size` |
| Type | `number` |
| Default | `44` |

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

### weightScale

The scale converting weights to text sizes.

| Item | Value |
| --- | --- |
| JavaScript property | `weightScale` |
| HTML attribute | `weight-scale` |
| Type | `WordCloudWeightScale` |
| Default | `'linear'` |
| Allowed values | `linear`, `sqrt`, `log` |

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

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

### spiral

Spiral search pattern; `rectangular` = Highcharts default.

| Item | Value |
| --- | --- |
| JavaScript property | `spiral` |
| HTML attribute | `spiral` |
| Type | `WordCloudSpiral` |
| Default | `'rectangular'` |
| Allowed values | `rectangular`, `archimedean` |

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

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

### orientations

Number of distinct orientations in the rotation cycle (Highcharts `rotation.orientations`).

| Item | Value |
| --- | --- |
| JavaScript property | `orientations` |
| HTML attribute | `orientations` |
| Type | `number` |
| Default | `2` |

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

### rotationFrom

Rotation cycle start in degrees (Highcharts `rotation.from`).

| Item | Value |
| --- | --- |
| JavaScript property | `rotationFrom` |
| HTML attribute | `rotation-from` |
| Type | `number` |
| Default | `0` |

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

### rotationTo

Rotation cycle end in degrees (Highcharts `rotation.to`).

| Item | Value |
| --- | --- |
| JavaScript property | `rotationTo` |
| HTML attribute | `rotation-to` |
| Type | `number` |
| Default | `90` |

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

### wordPadding

Empty px kept between word boxes.

| Item | Value |
| --- | --- |
| JavaScript property | `wordPadding` |
| HTML attribute | `word-padding` |
| Type | `number` |
| Default | `2` |

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

### fontFamily

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

| Item | Value |
| --- | --- |
| JavaScript property | `fontFamily` |
| HTML attribute | `font-family` |
| Type | `string` |
| Default | `'system-ui, sans-serif'` |

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

### fontWeight

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

| Item | Value |
| --- | --- |
| JavaScript property | `fontWeight` |
| HTML attribute | `font-weight` |
| Type | `string` |
| Default | `'600'` |

<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: (word: WordCloudResolvedWord) => string.

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

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

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

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

### tooltip

Rich tooltip configuration object — the word-flavoured counterpart of the item `.tooltip` API (trigger/openMode/connector/draggable/interactive/ format/html/style/side/sizing). When set it wins over the flat `tooltip-show` / `tooltipFormat` props. Property-only.

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

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

### zoom

Viewport zoom — the `zoom` attribute the cartesian charts carry: a mode (`'x'` | `'y'` | `'xy'`), `true` (x) or an object; off by default. The drawing rectangle (the cloud below the title band) is the plot — x runs 0 → 1 left to right, y 0 → 1 bottom to top — and the words are magnified into the window; words outside it leave the rectangle. Property-only (a mode string also works as an attribute).

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

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

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

### unavailable

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

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

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

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

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

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

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

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

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

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

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

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

### pointHover

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

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

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

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

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

### pointContextMenu

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

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

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

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

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

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

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

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

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

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

### zoomChange

Every zoom / pan change (drag, pan, wheel, pinch, keyboard, API, reset).

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

### redraw

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

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

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

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

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

### getActiveTier

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

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

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

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

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

### addWord

Word-cloud-only — add a word datum.

```typescript
addWord(datum: WordCloudDatum, opts?: { insertAt?: number }): Promise<number>
```

| Arguments | Type | Required |
| --- | --- | --- |
| `datum` | `WordCloudDatum` | Required |
| `opts` | `{ insertAt?: number }` | Optional |

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

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

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

### removeWord

Word-cloud-only — remove a word by id, name, or index.

```typescript
removeWord(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-updateWord"></a>

### updateWord

Word-cloud-only — patch a word's datum fields.

```typescript
updateWord(idOrIndex: string | number, patch: Partial<Exclude<WordCloudDatum, readonly [string, number]>>): Promise<boolean>
```

| Arguments | Type | Required |
| --- | --- | --- |
| `idOrIndex` | `string \| number` | Required |
| `patch` | `Partial<Exclude<WordCloudDatum, readonly [string, number]>>` | Required |

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

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

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

### setWordWeight

Word-cloud-only — set a word's weight.

```typescript
setWordWeight(idOrIndex: string | number, weight: number): Promise<boolean>
```

| Arguments | Type | Required |
| --- | --- | --- |
| `idOrIndex` | `string \| number` | Required |
| `weight` | `number` | 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(datum: WordCloudDatum): Promise<void>
```

| Arguments | Type | Required |
| --- | --- | --- |
| `datum` | `WordCloudDatum` | Required |

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

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

| Arguments | Type | Required |
| --- | --- | --- |
| `datums` | `ReadonlyArray<WordCloudDatum>` | Required |

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

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

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

### shift

Drops the LIGHTEST words (a cloud has no timeline; "oldest" is meaningless).

```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(datums: ReadonlyArray<WordCloudDatum>): Promise<void>
```

| Arguments | Type | Required |
| --- | --- | --- |
| `datums` | `ReadonlyArray<WordCloudDatum>` | Required |

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

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

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

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

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

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

- [WordCloudEasing](https://chart.syidax.com/docs/types/WordCloudEasing.md) — Type definition
- [WordCloudAnimationType](https://chart.syidax.com/docs/types/WordCloudAnimationType.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 staggered reveal. No-op when animation is off.

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

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

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

### hitTestWord

The word under a host px position (the zoomed view is honoured: the point is taken back to the layout first).

```typescript
hitTestWord(cssX: number, cssY: number): Promise<{ index: number; id: string; name: string } | null>
```

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

Return type: `Promise<{ index: number; id: string; name: string } | null>`. Call the method after element registration and await its Promise result.

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

### getDroppedWords

Words the spiral could not fit (diagnostics parity with the layout core).

```typescript
getDroppedWords(): Promise<Array<{ index: number; id: string; name: string; weight: number }>>
```

Return type: `Promise<Array<{ index: number; id: string; name: string; weight: number }>>`. Call the method after element registration and await its Promise result.

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

### showTooltipAtWord

Word-cloud-only — programmatic tooltip open on a word.

```typescript
showTooltipAtWord(idOrIndex: string | number): Promise<WordCloudPointEventDetail | null>
```

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

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

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

### zoomTo

Zoom to explicit windows of the drawing (`x` / `y` as `{ min, max }` or `[min, max]` over 0..1; `null` clears that orientation).

```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 a fraction of the drawing (`{ 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 of the drawing (0..1 on both orientations, the id-less slot key).

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