FWordCloudChartBuilder

Fluent, type-specific Builder for Word Cloud Charts.

Inheritance

Extends FChartBuilderBase. Its inherited members are available on this object.

Example

Sheet

TypeScript

const fWorkbook = univerAPI.getActiveWorkbook()const fWorksheet = fWorkbook.getSheetByName('Sheet1')const chartInfo = fWorksheet  .newChart(univerAPI.Enum.ChartTypeString.WordCloud)  .setSource('A1:B8')  .setCategoryField(0)  .setValueFields([1])  .setShape(univerAPI.Enum.ChartWordCloudShapeEnum.Circle)  .setRepeat(true)  .build()await fWorksheet.insertChart(chartInfo)

Doc

TypeScript

const fDocument = univerAPI.getActiveDocument()const chartInfo = fDocument  .newChart(univerAPI.Enum.ChartTypeString.WordCloud)  .setSource([    ['Word', 'Frequency'],    ['Univer', 42],    ['Chart', 28],    ['Data', 18],  ])  .setCategoryField(0)  .setValueFields([1])  .setShape(univerAPI.Enum.ChartWordCloudShapeEnum.Circle)  .setRepeat(true)  .build()await fDocument.insertChart(chartInfo)

Slide

TypeScript

const fPresentation = univerAPI.getActivePresentation()const fSlide = fPresentation.getSlideByIndex(0)const chartInfo = fSlide  .newChart(univerAPI.Enum.ChartTypeString.WordCloud)  .setSource([    ['Word', 'Frequency'],    ['Univer', 42],    ['Chart', 28],    ['Data', 18],  ])  .setCategoryField(0)  .setValueFields([1])  .setShape(univerAPI.Enum.ChartWordCloudShapeEnum.Circle)  .setRepeat(true)  .build()await fSlide.insertChart(chartInfo)

Board

TypeScript

const fBoard = univerAPI.getActiveBoard()const chartInfo = fBoard  .newChart(univerAPI.Enum.ChartTypeString.WordCloud)  .setSource([    ['Word', 'Frequency'],    ['Univer', 42],    ['Chart', 28],    ['Data', 18],  ])  .setCategoryField(0)  .setValueFields([1])  .setShape(univerAPI.Enum.ChartWordCloudShapeEnum.Circle)  .setRepeat(true)  .build()await fBoard.insertChart(chartInfo)

Register @univerjs-pro/engine-chart or a preset that includes it. In plugin mode, import @univerjs-pro/engine-chart/facade. Additional methods below require their listed plugin packages. See Facade setup.

`@univerjs-pro/engine-chart`

`FWordCloudChartBuilder.clearMaskImage`

Clears the mask image configuration and returns this builder for chaining.

This method executes synchronously.

TypeScript

clearMaskImage(): this

Returns

This builder for chaining.

Examples

TypeScript

builder.clearMaskImage()

Package: @univerjs-pro/engine-chart · Type definitions

`FWordCloudChartBuilder.resetRepeat`

Restores the default of not repeating words and returns this builder for chaining.

This method executes synchronously.

TypeScript

resetRepeat(): this

Returns

This builder for chaining.

Examples

TypeScript

builder.resetRepeat()

Package: @univerjs-pro/engine-chart · Type definitions

`FWordCloudChartBuilder.resetShape`

Restores the word-cloud shape to Cloud and returns this builder for chaining.

This method executes synchronously.

TypeScript

resetShape(): this

Returns

This builder for chaining.

Examples

TypeScript

builder.resetShape()

Package: @univerjs-pro/engine-chart · Type definitions

`FWordCloudChartBuilder.setMaskImage`

Sets the mask image configuration and returns this builder for chaining.

This method executes synchronously.

TypeScript

setMaskImage(resourceId: string): this

Parameters

resourceId — Required. The host resource ID.

Returns

This builder for chaining.

Examples

TypeScript

builder.setMaskImage('resource-id')

Package: @univerjs-pro/engine-chart · Type definitions

`FWordCloudChartBuilder.setRepeat`

Sets the repeat configuration and returns this builder for chaining.

This method executes synchronously.

TypeScript

setRepeat(value: boolean): this

Parameters

value — Required. The semantic value to record.

Returns

This builder for chaining.

Examples

TypeScript

builder.setRepeat(true)

Package: @univerjs-pro/engine-chart · Type definitions

`FWordCloudChartBuilder.setShape`

Sets the shape configuration and returns this builder for chaining.

This method executes synchronously.

TypeScript

setShape(value: WordCloudShapeEnum): this

Parameters

value — Required. The semantic value to record.

Returns

This builder for chaining.

Examples

TypeScript

builder.setShape(univerAPI.Enum.ChartWordCloudShapeEnum.Cloud)

Types: WordCloudShapeEnum

Package: @univerjs-pro/engine-chart · Type definitions

How is this guide?