Word Cloud.
COMMUNITYRepresent word weights through text size.
LIVE EXAMPLE
Keyword frequency
Appearance and style8
Legend and interaction10
Title and dimensions3
Show words with higher weights at larger sizes. All values are sample data.
View code
<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
| Property | Input format |
|---|---|
values | An array of [word, weight] or { name, weight }. |
weightScale | The 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.
Feature examples
#Try 16 interactive feature examples and inspect their code. Select “Edit in preview” to combine more options in the settings panel above.
Word rotation
Show frequency distribution using words at different angles.
View code
Font size range
Set minimum and maximum font sizes based on weight.
View code
Inspect values with the pointer
Point to data to view the value at that location.
View code
Drag to zoom and pan
Drag to zoom and hold Shift to pan. Use Ctrl + wheel to zoom in or out.
View code
Replay animation
Redraw the same example to inspect its initial display animation.
View code
Animation
Compare 1 examples of Animation. Buttons and options update both the live result and source code.
View code
Large datasets
Compare 1 examples of Large datasets. Buttons and options update both the live result and source code.
View code
Size
Compare 1 examples of Size. Buttons and options update both the live result and source code.
View code
Tooltip
Compare 12 examples of Tooltip. Buttons and options update both the live result and source code.
View code
Data input
Compare 1 examples of Data input. Buttons and options update both the live result and source code.
View code
Zoom and pan
Compare 6 examples of Zoom and pan. Buttons and options update both the live result and source code.
View code
Context menu
Compare 1 examples of Context menu. Buttons and options update both the live result and source code.
View code
Data context menu
Compare 1 examples of Data context menu. Buttons and options update both the live result and source code.
View code
Read coordinates and data
Compare 1 examples of Read coordinates and data. Buttons and options update both the live result and source code.
View code
Overview
Compare 3 examples of Overview. Buttons and options update both the live result and source code.
View code
Streaming · Add and update live dataPRO
Compare 3 examples of Add and update live data. Buttons and options update both the live result and source code.
View code
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.
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 / Property | Type / Default | Description |
|---|---|---|
WordCloudValuesDefault: [] | An array of [word, weight] or { name, weight }. | |
numberDefault: 520 | Chart width in pixels. Update with ResizeObserver when the container changes. | |
numberDefault: 400 | Chart height in pixels. | |
| brandLogo | stringDefault: undefined | The 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. |
| minFontSize | numberDefault: 10 | Smallest rendered font in px (Highcharts `minFontSize`). |
| maxFontSize | numberDefault: 44 | Font of the heaviest word in px (Highcharts `maxFontSize`). |
| weightScale | WordCloudWeightScaleDefault: 'linear' | The scale converting weights to text sizes. |
WordCloudSpiralDefault: 'rectangular' | Spiral search pattern; `rectangular` = Highcharts default. | |
numberDefault: 2 | Number of distinct orientations in the rotation cycle (Highcharts `rotation.orientations`). | |
| rotationFrom | numberDefault: 0 | Rotation cycle start in degrees (Highcharts `rotation.from`). |
| rotationTo | numberDefault: 90 | Rotation cycle end in degrees (Highcharts `rotation.to`). |
| wordPadding | numberDefault: 2 | Empty px kept between word boxes. |
| chartTitle | stringDefault: undefined | The title inside the chart. Explain the data's unit and meaning alongside it. |
| chartSubtitle | stringDefault: undefined | The subtitle inside the chart. |
| tooltipShow | booleanDefault: true | Whether to display the built-in tooltip. |
WordCloudTooltipInputDefault: undefined | Tooltip settings for pointer-driven values, position, and content. | |
CartesianZoomInputDefault: undefined | Settings for zooming and the visible range. | |
| animated | booleanDefault: false | Whether to animate initial display and data changes. |
| animationDuration | numberDefault: 600 | Animation duration in milliseconds. |
| animationEasing | WordCloudEasingDefault: 'ease-out' | Allowed values: linear, ease-out, ease-in, ease-in-out. Default: 'ease-out'. |
| animationType | WordCloudAnimationTypeDefault: undefined | Allowed values: initial, update. Default: undefined. |
Other properties 11
| Attribute / Property | Type / Default | Description |
|---|---|---|
WordCloudPaletteNameDefault: 'tableau10' | Allowed values: tableau10, tableau20, observable10, paired12, set3_12. Default: 'tableau10'. | |
ReadonlyArray<string>Default: undefined | Pass as a JavaScript property. type: ReadonlyArray<string>. | |
| fontFamily | stringDefault: 'system-ui, sans-serif' | Set as an HTML attribute or JavaScript property. type: string. |
| fontWeight | stringDefault: '600' | Set as an HTML attribute or JavaScript property. type: string. |
| tooltipFormat | (word: WordCloudResolvedWord) => stringDefault: undefined | Pass as a JavaScript property. type: (word: WordCloudResolvedWord) => string. |
| enableMouseTracking | booleanDefault: true | Set 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'. | |
| streamSource | WordCloudStreamSourceDefault: undefined | A stream source for live data. Check the contract for the specific type. |
| streamWindow | numberDefault: undefined | The streaming data range to keep visible. |
| streamMax | numberDefault: undefined | The maximum number of streaming data points to retain. |
Events 13
| Events | Detail type | Description |
|---|---|---|
WordCloudRenderResult & { tier: WordCloudEngineTier } | Emits rendering results in detail when chart drawing completes. | |
WordCloudPointEventDetail | A point selection event. Read the selected data and index from CustomEvent.detail. | |
WordCloudPointEventDetail | null | CustomEvent.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. | |
void | CustomEvent.detail type: void. Event names are case-sensitive. | |
void | CustomEvent.detail type: void. Event names are case-sensitive. | |
void | CustomEvent.detail type: void. Event names are case-sensitive. | |
WordCloudTooltipShowEventDetail | Whether to display the built-in tooltip. | |
void | CustomEvent.detail type: void. Event names are case-sensitive. | |
WordCloudTooltipActionEventDetail | CustomEvent.detail type: WordCloudTooltipActionEventDetail. Event names are case-sensitive. | |
CartesianZoomChangeEventDetail | Every 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 / Arguments | Return type | Description |
|---|---|---|
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 | number | Promise<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: number | Promise<boolean> | An asynchronous method. Check the argument and return types below. |
| datum: WordCloudDatum | Promise<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?: number | Promise<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: number | Promise<{ 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 | number | Promise<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: CartesianZoomRequest | Promise<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?: number | Promise<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?: CartesianZoomExtentRequest | Promise<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. |
No matching APIs.