IChartWordCloudProps
interface
Chart
Props for <OrigamChartWordCloud>. Reads series[0]; each datum must be a { text, value, color? } object. Controls font sizes, rotation strategy, font family/weight, and optional value formatters.
TypeScript
Definition
The TypeScript interface definition as found in the origam source. Click the copy icon to copy the snippet.
Inheritance
Extends
Parent interfaces this one inherits from. Their properties are available on every consumer of this interface.
API
Properties
Every property declared by this interface, with its type, optionality and default.
- minFontSizenumber12
- Minimum font size in px applied to the word with the lowest value.
- maxFontSizenumber64
- Maximum font size in px applied to the word with the highest value.
- rotationTChartWordCloudRotation'none'
- Word rotation strategy: 'none' (all horizontal), 'random' (uniform random in [-30°, 30°]), or 'orthogonal' (0° or 90° alternating by index parity).
- fontFamilystring'inherit'
- Font family applied to all words. Defaults to inherit so it picks up the host page typeface.
- fontWeightnumber | string600
- Font weight applied to all words.
- xAxisFormat(value: number | string) => string
- X-axis / value formatter. Unused for word clouds; kept for API symmetry with other chart families.
- yAxisFormat(value: number) => string
- Y-axis formatter applied to the value shown in the tooltip. When omitted the raw number is displayed.
Ecosystem
Used by
Components and composables that extend or consume this interface.
Usage
Examples
Ready-to-paste code snippets using this interface.
Word cloud with orthogonal rotation and custom fonts