Word Cloud.

COMMUNITY

Represent word weights through text size.

Live preview16 feature examples

LIVE EXAMPLE

Keyword frequency

Match the page theme
Interact with the chart to see selection and range-change results here.
OptionsChanges are reflected in the preview and code.
Appearance and style8
Legend and interaction10
Title and dimensions3

Show words with higher weights at larger sizes. All values are sample data.

View code
Current preview
<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>

Usage and data

#

Use for a quick overview of keyword frequency and topics.

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

Data contract

PropertyInput format
valuesAn array of [word, weight] or { name, weight }.
weightScaleThe scale converting weights to text sizes.

Updating data

Assign a new array or object to the property instead of mutating values inside an array. Chart events provide selection results through event.detail. When disposing of the view, clean up ResizeObserver and event listeners registered by your app.

Add to your interface

#

The code tabs below the preview contain the full data, options, event bindings, and responsive sizing for the current example. Copy them into an app project, such as Vite, that can resolve the installed packages.

Shared sy-chart API versus direct tags

API reference

#

The full public API for sy-word-cloud. Pass objects and arrays as JavaScript properties. Select a name to view usage code and type definitions.

Key properties

Attribute / PropertyType / DefaultDescription
WordCloudValuesDefault: []An array of [word, weight] or { name, weight }.
numberDefault: 520Chart width in pixels. Update with ResizeObserver when the container changes.
numberDefault: 400Chart height in pixels.
brandLogostringDefault: undefinedThe default is the Syidax logo. With the Pro chart.branding entitlement, use none or a PNG, JPEG, or WebP data URL.
brandPosition'top-left' | 'top-right' | 'bottom-left' | 'bottom-right'Default: 'bottom-right'The corner where the logo is anchored. Applies equally to Community and Pro, on screen and in image exports.
minFontSizenumberDefault: 10Smallest rendered font in px (Highcharts `minFontSize`).
maxFontSizenumberDefault: 44Font of the heaviest word in px (Highcharts `maxFontSize`).
weightScaleWordCloudWeightScaleDefault: 'linear'The scale converting weights to text sizes.
WordCloudSpiralDefault: 'rectangular'Spiral search pattern; `rectangular` = Highcharts default.
numberDefault: 2Number of distinct orientations in the rotation cycle (Highcharts `rotation.orientations`).
rotationFromnumberDefault: 0Rotation cycle start in degrees (Highcharts `rotation.from`).
rotationTonumberDefault: 90Rotation cycle end in degrees (Highcharts `rotation.to`).
wordPaddingnumberDefault: 2Empty px kept between word boxes.
chartTitlestringDefault: undefinedThe title inside the chart. Explain the data's unit and meaning alongside it.
chartSubtitlestringDefault: undefinedThe subtitle inside the chart.
tooltipShowbooleanDefault: trueWhether to display the built-in tooltip.
WordCloudTooltipInputDefault: undefinedTooltip settings for pointer-driven values, position, and content.
CartesianZoomInputDefault: undefinedSettings for zooming and the visible range.
animatedbooleanDefault: falseWhether to animate initial display and data changes.
animationDurationnumberDefault: 600Animation duration in milliseconds.
animationEasingWordCloudEasingDefault: 'ease-out'Allowed values: linear, ease-out, ease-in, ease-in-out. Default: 'ease-out'.
animationTypeWordCloudAnimationTypeDefault: undefinedAllowed values: initial, update. Default: undefined.
Other properties 11
Attribute / PropertyType / DefaultDescription
WordCloudPaletteNameDefault: 'tableau10'Allowed values: tableau10, tableau20, observable10, paired12, set3_12. Default: 'tableau10'.
ReadonlyArray<string>Default: undefinedPass as a JavaScript property. type: ReadonlyArray<string>.
fontFamilystringDefault: 'system-ui, sans-serif'Set as an HTML attribute or JavaScript property. type: string.
fontWeightstringDefault: '600'Set as an HTML attribute or JavaScript property. type: string.
tooltipFormat(word: WordCloudResolvedWord) => stringDefault: undefinedPass as a JavaScript property. type: (word: WordCloudResolvedWord) => string.
enableMouseTrackingbooleanDefault: trueSet as an HTML attribute or JavaScript property. type: boolean.
WordCloudEngineModeDefault: 'auto'Renderer selection: auto, standard, or pro. Engine selection is separate from permission to use a Pro chart type.
WordCloudUnavailableBehaviourDefault: 'fallback'Allowed values: fallback, error, throw. Default: 'fallback'.
streamSourceWordCloudStreamSourceDefault: undefinedA stream source for live data. Check the contract for the specific type.
streamWindownumberDefault: undefinedThe streaming data range to keep visible.
streamMaxnumberDefault: undefinedThe maximum number of streaming data points to retain.
Events 13
EventsDetail typeDescription
WordCloudRenderResult & { tier: WordCloudEngineTier }Emits rendering results in detail when chart drawing completes.
WordCloudPointEventDetailA point selection event. Read the selected data and index from CustomEvent.detail.
WordCloudPointEventDetail | nullCustomEvent.detail type: WordCloudPointEventDetail | null. Event names are case-sensitive.
ChartPointContextMenuEventDetail<WordCloudPointEventDetail>CustomEvent.detail type: ChartPointContextMenuEventDetail<WordCloudPointEventDetail>. Event names are case-sensitive.
{ count: number }CustomEvent.detail type: { count: number }. Event names are case-sensitive.
{ dropped: number }CustomEvent.detail type: { dropped: number }. Event names are case-sensitive.
voidCustomEvent.detail type: void. Event names are case-sensitive.
voidCustomEvent.detail type: void. Event names are case-sensitive.
voidCustomEvent.detail type: void. Event names are case-sensitive.
WordCloudTooltipShowEventDetailWhether to display the built-in tooltip.
voidCustomEvent.detail type: void. Event names are case-sensitive.
WordCloudTooltipActionEventDetailCustomEvent.detail type: WordCloudTooltipActionEventDetail. Event names are case-sensitive.
CartesianZoomChangeEventDetailEvery zoom / pan change (drag, pan, wheel, pinch, keyboard, API, reset).
Methods 26

Stencil methods return Promises. Use await within an async function to read the result.

Method / ArgumentsReturn typeDescription
Promise<WordCloudRenderResult>An asynchronous method. Check the argument and return types below.
Promise<WordCloudEngineTier>An asynchronous method. Check the argument and return types below.
datum: WordCloudDatum, opts?: { insertAt?: number }Promise<number>An asynchronous method. Check the argument and return types below.
idOrIndex: string | numberPromise<boolean>An asynchronous method. Check the argument and return types below.
idOrIndex: string | number, patch: Partial<Exclude<WordCloudDatum, readonly [string, number]>>Promise<boolean>An asynchronous method. Check the argument and return types below.
idOrIndex: string | number, weight: numberPromise<boolean>An asynchronous method. Check the argument and return types below.
datum: WordCloudDatumPromise<void>Frequency semantics: appending a word that already exists ADDS its weight to the stored entry (a live token feed grows counts in place); a new name is appended. With a bound stream source the source owns that merge.
datums: ReadonlyArray<WordCloudDatum>Promise<void>An asynchronous method. Check the argument and return types below.
count?: numberPromise<void>Drops the LIGHTEST words (a cloud has no timeline; "oldest" is meaningless).
datums: ReadonlyArray<WordCloudDatum>Promise<void>An asynchronous method. Check the argument and return types below.
Promise<WordCloudStreamSource | undefined>An asynchronous method. Check the argument and return types below.
options: { duration?: number; easing?: WordCloudEasing; enabled?: boolean; type?: WordCloudAnimationType }Promise<void>An asynchronous method. Check the argument and return types below.
Promise<void>An asynchronous method. Check the argument and return types below.
Promise<void>An asynchronous method. Check the argument and return types below.
Promise<void>Replay the initial staggered reveal. No-op when animation is off.
cssX: number, cssY: numberPromise<{ index: number; id: string; name: string } | null>The word under a host px position (the zoomed view is honoured: the point is taken back to the layout first).
Promise<Array<{ index: number; id: string; name: string; weight: number }>>Words the spiral could not fit (diagnostics parity with the layout core).
idOrIndex: string | numberPromise<WordCloudPointEventDetail | null>An asynchronous method. Check the argument and return types below.
Promise<void>An asynchronous method. Check the argument and return types below.
request: CartesianZoomRequestPromise<CartesianZoomChangeEventDetail | null>Zoom to explicit windows of the drawing (`x` / `y` as `{ min, max }` or `[min, max]` over 0..1; `null` clears that orientation).
factor: number, anchorFraction?: numberPromise<CartesianZoomChangeEventDetail | null>Scale the current windows by `factor` (< 1 zooms in) around `anchorFraction` (0..1, default centre).
delta: { x?: number; y?: number }Promise<CartesianZoomChangeEventDetail | null>Slide the zoomed windows by a fraction of the drawing (`{ x?, y? }`); a no-op at the full extent.
Promise<CartesianZoomChangeEventDetail | null>Back to the full extent.
Promise<CartesianZoomState | null>The current zoom state (`null` = full extent).
request?: CartesianZoomExtentRequestPromise<CartesianZoomExtentDetail | null>The full extent of the drawing (0..1 on both orientations, the id-less slot key).
Promise<ChartEngineStatus>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.