Word Cloud

A word cloud is a visual representation for text data to visualize keywords or tags. Tags are usually single words, and the importance of each tag is shown with size or color. This format is useful for quickly perceiving the most prominent terms and for locating a term alphabetically to determine its relative prominence.

Quick Start

To create a word cloud, use import the WordCloud and give it some data.

import { WordCloud } from 'reaviz';


export default function App() {
return (
  <WordCloud
    height={300}
    width={300}
    data={[
      { key: 'HTML', data: 70 },
      { key: 'CSS', data: 65 },
      { key: 'Docker', data: 40 },
      { key: 'AWS', data: 30 },
      { key: 'Git', data: 25 }
    ]}
  />
);
}

import { WordCloud } from 'reaviz';

export default function App() {
return (
  <WordCloud
    height={300}
    width={300}
    data={[
      { key: 'HTML', data: 70 },
      { key: 'CSS', data: 65 },
      { key: 'Docker', data: 40 },
      { key: 'AWS', data: 30 },
      { key: 'Git', data: 25 }
    ]}
  />
);
}

API

WordCloud

Name	Type	Default
`data`	`ChartShallowDataShape[]` Data to render in the word cloud. The ‘key’ represents the word and ‘data’ represents its frequency/weight.	`[]`
`fontSizeRange`	`[number, number]` Font size range [min, max].	`[12, 50]`
`fontFamily`	`string` Font family to use.	`'Arial'`
`padding`	`number` Padding between words.	`3`
`rotationAngles`	`[number, number]` Rotation angles for words.	`[-30, 30]`
`rotations`	`number` Number of possible rotations.	`2`
`colorScheme`	`string[]` Custom color scheme for words.	`schemes.cybertron`
`onLabelClick`	`(event: MouseEvent<Element, MouseEvent>, data: ChartShallowDataShape) => void` Event triggered when a word is clicked.
`onLabelMouseEnter`	`(event: PointerEvent<Element>, data: ChartShallowDataShape) => void` Mouse enter handler.
`onLabelMouseLeave`	`(event: PointerEvent<Element>, data: ChartShallowDataShape) => void` Mouse leave handler.
`id`	`string` Id of the chart.
`width`	`number` Width of the chart. If not provided will autosize.
`height`	`number` Height of the chart. If not provided will autosize.
`margins`	`Margins` Margins for the chart.
`className`	`string` Classnames for the chart.
`containerClassName`	`string` Classnames for the chart.
`style`	`StyleHTMLAttributes<SVGSVGElement>` Additional css styles.
`center`	`boolean` Center the chart. Used mainly internally.
`centerX`	`boolean` Center chart on X Axis only. Used mainly internally.
`centerY`	`boolean` Center chart on Y Axis only. Used mainly internally.

WordCloudLabel

Name	Type	Default
`text`	`string` Text to display.
`fontSize`	`number` Font size in pixels.
`fontFamily`	`string` Font family to use.
`fill`	`string` Fill color for the text.
`x`	`number` X position of the text.
`y`	`number` Y position of the text.
`rotate`	`number` Rotation angle in degrees.
`data`	`ChartShallowDataShape` Original data point.
`className`	`string` Additional className to apply.
`tooltip`	`ReactElement<ChartTooltipProps, FC<Partial<ChartTooltipProps>>> \| null` Tooltip element.	`<ChartTooltip />`
`onClick`	`(event: MouseEvent<Element, MouseEvent>, data: ChartShallowDataShape) => void` Click handler.
`onMouseEnter`	`(event: PointerEvent<Element>, data: ChartShallowDataShape) => void` Mouse enter handler.
`onMouseLeave`	`(event: PointerEvent<Element>, data: ChartShallowDataShape) => void` Mouse leave handler.