Word Cloud

values

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

• WordCloudValues

  Type definition

width

Chart width in pixels. If the container width changes, update width from a ResizeObserver.

height

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

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.

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

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.

palette

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

• WordCloudPaletteName

  Type definition

colors

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

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

minFontSize

Smallest rendered font in px (Highcharts minFontSize).

maxFontSize

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

weightScale

The scale converting weights to text sizes.

• WordCloudWeightScale

  Type definition

spiral

Spiral search pattern; rectangular = Highcharts default.

• WordCloudSpiral

  Type definition

orientations

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

rotationFrom

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

rotationTo

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

wordPadding

Empty px kept between word boxes.

fontFamily

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

fontWeight

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

chartTitle

The title inside the chart. Explain the data's unit and meaning alongside it.

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

chartSubtitle

The subtitle inside the chart.

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

tooltipShow

Whether to display the built-in tooltip.

tooltipFormat

Pass as a JavaScript property. type: (word: WordCloudResolvedWord) => string.

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

• WordCloudResolvedWord

  Type definition

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.

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

• WordCloudTooltipInput

  Type definition

enableMouseTracking

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

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).

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

• CartesianZoomInput

  Type definition

engine

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

• WordCloudEngineMode

  Type definition

unavailable

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

• WordCloudUnavailableBehaviour

  Type definition

streamSource

A stream source for live data. Check the contract for the specific type.

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

• WordCloudStreamSource

  Type definition

streamWindow

The streaming data range to keep visible.

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

streamMax

The maximum number of streaming data points to retain.

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

animated

Whether to animate initial display and data changes.

animationDuration

Animation duration in milliseconds.

animationEasing

Allowed values: linear, ease-out, ease-in, ease-in-out. Default: 'ease-out'.

• WordCloudEasing

  Type definition

animationType

Allowed values: initial, update. Default: undefined.

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

• WordCloudAnimationType

  Type definition

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 }>.

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

• WordCloudRenderResult

  Type definition

• WordCloudEngineTier

  Type definition

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

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

• WordCloudPointEventDetail

  Type definition

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

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

• WordCloudPointEventDetail

  Type definition

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

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

• ChartPointContextMenuEventDetail

  Type definition

• WordCloudPointEventDetail

  Type definition

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 }>.

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

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 }>.

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

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

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

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

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

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

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

tooltipShow

Whether to display the built-in tooltip.

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

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

• WordCloudTooltipShowEventDetail

  Type definition

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

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

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

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

• WordCloudTooltipActionEventDetail

  Type definition

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

chart.addEventListener('zoomChange', event => {
  console.log(event.detail); // CartesianZoomChangeEventDetail
});

• CartesianZoomChangeEventDetail

  Type definition

redraw

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

redraw(): Promise<WordCloudRenderResult>

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

• WordCloudRenderResult

  Type definition

getActiveTier

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

getActiveTier(): Promise<WordCloudEngineTier>

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

• WordCloudEngineTier

  Type definition

addWord

Word-cloud-only — add a word datum.

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

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

• WordCloudDatum

  Type definition

removeWord

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

removeWord(idOrIndex: string | number): Promise<boolean>

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

updateWord

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

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

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

• WordCloudDatum

  Type definition

setWordWeight

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

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

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

appendPoint

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

appendPoint(datum: WordCloudDatum): Promise<void>

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

• WordCloudDatum

  Type definition

appendBatch

Append multiple values to the stream. Check the argument type and the licensing requirements for streaming.

appendBatch(datums: ReadonlyArray<WordCloudDatum>): Promise<void>

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

• WordCloudDatum

  Type definition

shift

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

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

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

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).

replace(datums: ReadonlyArray<WordCloudDatum>): Promise<void>

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

• WordCloudDatum

  Type definition

getStreamSource

The stream session's source (Chart Pro): like the stream methods it waits for a license still being confirmed.

getStreamSource(): Promise<WordCloudStreamSource | undefined>

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

• WordCloudStreamSource

  Type definition

setAnimation

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

setAnimation(options: { duration?: number; easing?: WordCloudEasing; enabled?: boolean; type?: WordCloudAnimationType }): Promise<void>

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

• WordCloudEasing

  Type definition

• WordCloudAnimationType

  Type definition

pauseAnimation

Pause the current animation.

pauseAnimation(): Promise<void>

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

resumeAnimation

Resume a paused animation.

resumeAnimation(): Promise<void>

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

replayAnimation

Replay the initial staggered reveal. No-op when animation is off.

replayAnimation(): Promise<void>

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

hitTestWord

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

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

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

getDroppedWords

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

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.

showTooltipAtWord

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

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

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

• WordCloudPointEventDetail

  Type definition

hideTooltip

Close the currently visible tooltip.

hideTooltip(): Promise<void>

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

zoomTo

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

zoomTo(request: CartesianZoomRequest): Promise<CartesianZoomChangeEventDetail | null>

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

• CartesianZoomChangeEventDetail

  Type definition

• CartesianZoomRequest

  Type definition

zoomBy

Scale the current windows by factor (< 1 zooms in) around anchorFraction (0..1, default centre).

zoomBy(factor: number, anchorFraction?: number): Promise<CartesianZoomChangeEventDetail | null>

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

• CartesianZoomChangeEventDetail

  Type definition

panBy

Slide the zoomed windows by a fraction of the drawing ({ x?, y? }); a no-op at the full extent.

panBy(delta: { x?: number; y?: number }): Promise<CartesianZoomChangeEventDetail | null>

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

• CartesianZoomChangeEventDetail

  Type definition

resetZoom

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

resetZoom(): Promise<CartesianZoomChangeEventDetail | null>

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

• CartesianZoomChangeEventDetail

  Type definition

getZoom

Read the current zoom range. Check the return type's nullability and the range for each axis.

getZoom(): Promise<CartesianZoomState | null>

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

• CartesianZoomState

  Type definition

getZoomExtent

The full extent of the drawing (0..1 on both orientations, the id-less slot key).

getZoomExtent(request?: CartesianZoomExtentRequest): Promise<CartesianZoomExtentDetail | null>

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

• CartesianZoomExtentDetail

  Type definition

• CartesianZoomExtentRequest

  Type definition

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.

getEngineStatus(): Promise<ChartEngineStatus>

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

• ChartEngineStatus

  Type definition