# FTreemapChartBuilder

- Human documentation: [https://docs.univer.ai/reference/facade/treemap-chart-builder](https://docs.univer.ai/reference/facade/treemap-chart-builder)

- Agent Markdown: [https://docs.univer.ai/reference/facade/treemap-chart-builder.md](https://docs.univer.ai/reference/facade/treemap-chart-builder.md)

- Requested language: `en-US`

- Content language: `en-US`

- Documentation version: `1.0.0-rc.0`

- Source: [facade/treemap-chart-builder.mdx](https://github.com/dream-num/documentation/blob/dev/content/reference/facade/treemap-chart-builder.mdx)

---

Fluent semantic builder for an automatically laid-out Treemap.

Field indexes are zero-based in the orientation-normalized dataset. Rendering needs at
least one ordered hierarchy field and exactly one value field. Duplicate complete paths
sum finite numeric values; blank, textual, non-finite, and final non-positive values do
not render. Parent-owned facts add to child totals. Layout is automatic and navigation
is disabled. The runtime defaults are banner parent labels and visible category-name
leaf labels; labels may hide when their rectangle cannot fit the complete content.

## Inheritance

Extends [`FChartBuilderBase`](https://docs.univer.ai/reference/facade/chart-builder-base.md). Its inherited members are available on this object.

## Example

Sheet

```ts
const fWorkbook = univerAPI.getActiveWorkbook()
const fWorksheet = fWorkbook.getSheetByName('Sheet1')
const chartInfo = fWorksheet
  .newChart(univerAPI.Enum.ChartTypeString.Treemap)
  .setSource('A1:D8')
  .setHierarchyFields([0, 1, 2])
  .setValueField(3)
  .setParentLabelLayout(univerAPI.Enum.ChartTreemapParentLabelLayout.Banner)
  .setTreemapLabel({ visible: true, color: '#334155' })
  .build()
await fWorksheet.insertChart(chartInfo)
```

Doc

```ts
const fDocument = univerAPI.getActiveDocument()
const chartInfo = fDocument
  .newChart(univerAPI.Enum.ChartTypeString.Treemap)
  .setSource([
    ['Region', 'Country', 'City', 'Sales'],
    ['Europe', 'France', 'Paris', 120],
    ['Asia', 'Japan', 'Tokyo', 180],
  ])
  .setHierarchyFields([0, 1, 2])
  .setValueField(3)
  .setParentLabelLayout(univerAPI.Enum.ChartTreemapParentLabelLayout.Banner)
  .setTreemapLabel({ visible: true, color: '#334155' })
  .build()
await fDocument.insertChart(chartInfo)
```

Slide

```ts
const fPresentation = univerAPI.getActivePresentation()
const fSlide = fPresentation.getSlideByIndex(0)
const chartInfo = fSlide
  .newChart(univerAPI.Enum.ChartTypeString.Treemap)
  .setSource([
    ['Region', 'Country', 'City', 'Sales'],
    ['Europe', 'France', 'Paris', 120],
    ['Asia', 'Japan', 'Tokyo', 180],
  ])
  .setHierarchyFields([0, 1, 2])
  .setValueField(3)
  .setParentLabelLayout(univerAPI.Enum.ChartTreemapParentLabelLayout.Banner)
  .setTreemapLabel({ visible: true, color: '#334155' })
  .build()
await fSlide.insertChart(chartInfo)
```

Board

```ts
const fBoard = univerAPI.getActiveBoard()
const chartInfo = fBoard
  .newChart(univerAPI.Enum.ChartTypeString.Treemap)
  .setSource([
    ['Region', 'Country', 'City', 'Sales'],
    ['Europe', 'France', 'Paris', 120],
    ['Asia', 'Japan', 'Tokyo', 180],
  ])
  .setHierarchyFields([0, 1, 2])
  .setValueField(3)
  .setParentLabelLayout(univerAPI.Enum.ChartTreemapParentLabelLayout.Banner)
  .setTreemapLabel({ visible: true, color: '#334155' })
  .build()
await fBoard.insertChart(chartInfo)
```

## Setup

Register [`@univerjs-pro/engine-chart`](https://docs.univer.ai/reference/packages/plugins/univerjs-pro/engine-chart.md) 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](https://docs.univer.ai/guides/sheets/getting-started/facade.md).

## `@univerjs-pro/engine-chart`

### `FTreemapChartBuilder.resetParentLabelLayout`

Removes the explicit parent layout and restores the runtime banner default.

```typescript
resetParentLabelLayout(): this
```

**Returns**

This builder for chaining.

**Examples**

```ts
builder.resetParentLabelLayout()
```

**Package:** [`@univerjs-pro/engine-chart`](https://docs.univer.ai/reference/packages/plugins/univerjs-pro/engine-chart.md) · [Type definitions](https://unpkg.com/@univerjs-pro/engine-chart@1.0.0-rc.0/lib/types/facade/builders/f-treemap-chart-builder.d.ts)

### `FTreemapChartBuilder.resetTreemapLabel`

Removes explicit leaf-label style and restores visible category-name labels.

```typescript
resetTreemapLabel(): this
```

**Returns**

This builder for chaining.

**Examples**

```ts
builder.resetTreemapLabel()
```

**Package:** [`@univerjs-pro/engine-chart`](https://docs.univer.ai/reference/packages/plugins/univerjs-pro/engine-chart.md) · [Type definitions](https://unpkg.com/@univerjs-pro/engine-chart@1.0.0-rc.0/lib/types/facade/builders/f-treemap-chart-builder.d.ts)

### `FTreemapChartBuilder.setHierarchyFields`

Replaces the ordered root-to-leaf hierarchy with zero-based field indexes.

```typescript
setHierarchyFields(indexes: readonly number[]): this
```

**Parameters**

* `indexes` — Required. Ordered hierarchy field indexes.

**Returns**

This builder for chaining.

**Examples**

```ts
builder.setHierarchyFields([0, 1, 2])
```

**Package:** [`@univerjs-pro/engine-chart`](https://docs.univer.ai/reference/packages/plugins/univerjs-pro/engine-chart.md) · [Type definitions](https://unpkg.com/@univerjs-pro/engine-chart@1.0.0-rc.0/lib/types/facade/builders/f-treemap-chart-builder.d.ts)

### `FTreemapChartBuilder.setParentLabelLayout`

Sets parent names to a reserved banner, overlapping text, or hidden.

```typescript
setParentLabelLayout(layout: TreemapParentLabelLayout): this
```

**Parameters**

* `layout` — Required. Parent-label layout mode.

**Returns**

This builder for chaining.

**Examples**

```ts
builder.setParentLabelLayout(univerAPI.Enum.ChartTreemapParentLabelLayout.Banner)
```

**Types:** [`TreemapParentLabelLayout`](https://unpkg.com/@univerjs-pro/engine-chart@1.0.0-rc.0/lib/types/enum.d.ts)

**Package:** [`@univerjs-pro/engine-chart`](https://docs.univer.ai/reference/packages/plugins/univerjs-pro/engine-chart.md) · [Type definitions](https://unpkg.com/@univerjs-pro/engine-chart@1.0.0-rc.0/lib/types/facade/builders/f-treemap-chart-builder.d.ts)

### `FTreemapChartBuilder.setTreemapLabel`

Sets leaf visibility, content, and font appearance.

```typescript
setTreemapLabel(label: DeepNullish<IChartTreemapLabelSpec>): this
```

**Parameters**

* `label` — Required. Treemap leaf-label settings.

**Returns**

This builder for chaining.

**Examples**

```ts
builder.setTreemapLabel({ visible: true, color: '#334155' })
```

**Types:** [`DeepNullish`](https://unpkg.com/@univerjs-pro/engine-chart@1.0.0-rc.0/lib/types/types.d.ts) · [`IChartTreemapLabelSpec`](https://unpkg.com/@univerjs-pro/engine-chart@1.0.0-rc.0/lib/types/types.d.ts)

**Package:** [`@univerjs-pro/engine-chart`](https://docs.univer.ai/reference/packages/plugins/univerjs-pro/engine-chart.md) · [Type definitions](https://unpkg.com/@univerjs-pro/engine-chart@1.0.0-rc.0/lib/types/facade/builders/f-treemap-chart-builder.d.ts)

### `FTreemapChartBuilder.setValueField`

Replaces the sole numeric value field with a zero-based field index.

```typescript
setValueField(index: number): this
```

**Parameters**

* `index` — Required. Numeric value field index.

**Returns**

This builder for chaining.

**Examples**

```ts
builder.setValueField(3)
```

**Package:** [`@univerjs-pro/engine-chart`](https://docs.univer.ai/reference/packages/plugins/univerjs-pro/engine-chart.md) · [Type definitions](https://unpkg.com/@univerjs-pro/engine-chart@1.0.0-rc.0/lib/types/facade/builders/f-treemap-chart-builder.d.ts)