chartjs-chart-wordcloud

Appearance

chartjs-chart-wordcloud / IWordCloudControllerDatasetOptions

Interface: IWordCloudControllerDatasetOptions ​

Defined in: work/chartjs-chart-wordcloud/chartjs-chart-wordcloud/src/controllers/WordCloudController.ts:228

Extends ​

  • ControllerDatasetOptions.ScriptableAndArrayOptions<IWordElementOptions, ScriptableContext<"wordCloud">>.ScriptableAndArrayOptions<CommonHoverOptions, ScriptableContext<"wordCloud">>.AnimationOptions<"wordCloud">

Indexable ​

[key: string]: unknown

Properties ​

autoGrow ​

autoGrow: IAutoGrowOptions

Defined in: work/chartjs-chart-wordcloud/chartjs-chart-wordcloud/src/controllers/WordCloudController.ts:243

configures the automatic growing of the canvas in case not all words can be fitted onto the screen

Default ​

ts
{ maxTries: 3, scalingFactor: 1.2}

color ​

color: ScriptableAndArray<string | CanvasGradient | CanvasPattern, ScriptableContext<"wordCloud">>

Defined in: work/chartjs-chart-wordcloud/chartjs-chart-wordcloud/src/elements/WordElement.ts:5

Inherited from ​

ScriptableAndArrayOptions.color

fit ​

fit: boolean

Defined in: work/chartjs-chart-wordcloud/chartjs-chart-wordcloud/src/controllers/WordCloudController.ts:237

whether to fit the word cloud to the map, by scaling to the actual bounds

Default ​

ts
false

maxRotation ​

maxRotation: ScriptableAndArray<number, ScriptableContext<"wordCloud">>

Defined in: work/chartjs-chart-wordcloud/chartjs-chart-wordcloud/src/elements/WordElement.ts:35

angle in degree for the max rotation

Default ​

ts
0

Inherited from ​

IWordElementOptions.maxRotation

minRotation ​

minRotation: ScriptableAndArray<number, ScriptableContext<"wordCloud">>

Defined in: work/chartjs-chart-wordcloud/chartjs-chart-wordcloud/src/elements/WordElement.ts:30

angle in degree for the min rotation

Default ​

ts
-90

Inherited from ​

IWordElementOptions.minRotation

padding ​

padding: ScriptableAndArray<number, ScriptableContext<"wordCloud">>

Defined in: work/chartjs-chart-wordcloud/chartjs-chart-wordcloud/src/elements/WordElement.ts:40

padding around each word while doing the layout

Default ​

ts
1

Inherited from ​

IWordElementOptions.padding

randomRotationSeed ​

randomRotationSeed: string

Defined in: work/chartjs-chart-wordcloud/chartjs-chart-wordcloud/src/controllers/WordCloudController.ts:249

specifies the random seed that should be used for randomly rotating words if needed

Default ​

ts
the current chart id

rotate ​

rotate: ScriptableAndArray<number, ScriptableContext<"wordCloud">>

Defined in: work/chartjs-chart-wordcloud/chartjs-chart-wordcloud/src/elements/WordElement.ts:20

rotation of the word

Default ​

ts
undefined then it will be randomly derived given the other constraints

Inherited from ​

IWordElementOptions.rotate

rotationSteps ​

rotationSteps: ScriptableAndArray<number, ScriptableContext<"wordCloud">>

Defined in: work/chartjs-chart-wordcloud/chartjs-chart-wordcloud/src/elements/WordElement.ts:25

number of rotation steps between min and max rotation

Default ​

ts
2

Inherited from ​

IWordElementOptions.rotationSteps

strokeStyle ​

strokeStyle: ScriptableAndArray<string | CanvasGradient | CanvasPattern, ScriptableContext<"wordCloud">>

Defined in: work/chartjs-chart-wordcloud/chartjs-chart-wordcloud/src/elements/WordElement.ts:10

CanvasContext2D.strokeStyle config for rendering a stroke around the text

Default ​

ts
undefined

Inherited from ​

ScriptableAndArrayOptions.strokeStyle

strokeWidth? ​

optional strokeWidth: ScriptableAndArray<undefined | number, ScriptableContext<"wordCloud">>

Defined in: work/chartjs-chart-wordcloud/chartjs-chart-wordcloud/src/elements/WordElement.ts:15

CanvasContext2D.lineWith for stroke

Default ​

ts
undefined

Inherited from ​

ScriptableAndArrayOptions.strokeWidth