# FGaugeChartBuilder

> Language fallback: requested `zh-CN`; content is `en-US`.

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

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

- Requested language: `zh-CN`

- Content language: `en-US`

- Documentation version: `1.0.0-rc.0`

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

---

Fluent semantic builder for Google-style label/value Gauge data.

The category field is the label and exactly one value field is selected. Each
finite numeric observation renders as an independently wrapped gauge; invalid
values are skipped without coercion. Scale defaults to 0–100. Out-of-range raw
values retain their source formatting for detail and tooltip text while only
the rendered indicator is clamped. Angles use degrees, length/offset ratios use
0–1 units, and range bounds use scale-domain values. All style is chart-wide.
Layout is derived at render time and is never part of this builder's state.

## Inheritance

Extends [`FChartBuilderBase`](https://docs.univer.ai/zh-CN/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.Gauge)
  .setSource('A1:B4')
  .setCategoryField(0)
  .setGaugeValueField(1)
  .setGaugeMode(univerAPI.Enum.ChartGaugeMode.Modern)
  .setGaugeScale({ min: 0, max: 100 })
  .setGaugeTicks({ majorDivisions: 10, minorDivisionsPerMajor: 5 })
  .setGaugeAngles({ startAngle: 225, endAngle: -45 })
  .setGaugeRanges([{ from: 0, to: 60, color: '#dc2626' }])
  .setGaugeAxisLine({ visible: true, width: 12 })
  .setGaugeAxisTick({ visible: true, length: 6 })
  .setGaugeSplitLine({ visible: true, length: 12 })
  .setGaugeAxisLabel({ visible: true, color: '#334155' })
  .setGaugePointer({
    visible: true,
    shape: univerAPI.Enum.ChartGaugePointerShape.Needle,
    color: '#2563eb',
  })
  .setGaugeAnchor({ visible: true, size: 8 })
  .setGaugeProgress({ visible: true, width: 12 })
  .setGaugeTitle({ visible: true, color: '#334155' })
  .setGaugeDetail({ visible: true, color: '#0f172a' })
  .build()
await fWorksheet.insertChart(chartInfo)
```

Doc

```ts
const fDocument = univerAPI.getActiveDocument()
const chartInfo = fDocument
  .newChart(univerAPI.Enum.ChartTypeString.Gauge)
  .setSource([
    ['Metric', 'Value'],
    ['Completion', 72],
  ])
  .setCategoryField(0)
  .setGaugeValueField(1)
  .setGaugeMode(univerAPI.Enum.ChartGaugeMode.Modern)
  .setGaugeScale({ min: 0, max: 100 })
  .setGaugeTicks({ majorDivisions: 10, minorDivisionsPerMajor: 5 })
  .setGaugeAngles({ startAngle: 225, endAngle: -45 })
  .setGaugeRanges([{ from: 0, to: 60, color: '#dc2626' }])
  .setGaugeAxisLine({ visible: true, width: 12 })
  .setGaugeAxisTick({ visible: true, length: 6 })
  .setGaugeSplitLine({ visible: true, length: 12 })
  .setGaugeAxisLabel({ visible: true, color: '#334155' })
  .setGaugePointer({
    visible: true,
    shape: univerAPI.Enum.ChartGaugePointerShape.Needle,
    color: '#2563eb',
  })
  .setGaugeAnchor({ visible: true, size: 8 })
  .setGaugeProgress({ visible: true, width: 12 })
  .setGaugeTitle({ visible: true, color: '#334155' })
  .setGaugeDetail({ visible: true, color: '#0f172a' })
  .build()
await fDocument.insertChart(chartInfo)
```

Slide

```ts
const fPresentation = univerAPI.getActivePresentation()
const fSlide = fPresentation.getSlideByIndex(0)
const chartInfo = fSlide
  .newChart(univerAPI.Enum.ChartTypeString.Gauge)
  .setSource([
    ['Metric', 'Value'],
    ['Completion', 72],
  ])
  .setCategoryField(0)
  .setGaugeValueField(1)
  .setGaugeMode(univerAPI.Enum.ChartGaugeMode.Modern)
  .setGaugeScale({ min: 0, max: 100 })
  .setGaugeTicks({ majorDivisions: 10, minorDivisionsPerMajor: 5 })
  .setGaugeAngles({ startAngle: 225, endAngle: -45 })
  .setGaugeRanges([{ from: 0, to: 60, color: '#dc2626' }])
  .setGaugeAxisLine({ visible: true, width: 12 })
  .setGaugeAxisTick({ visible: true, length: 6 })
  .setGaugeSplitLine({ visible: true, length: 12 })
  .setGaugeAxisLabel({ visible: true, color: '#334155' })
  .setGaugePointer({
    visible: true,
    shape: univerAPI.Enum.ChartGaugePointerShape.Needle,
    color: '#2563eb',
  })
  .setGaugeAnchor({ visible: true, size: 8 })
  .setGaugeProgress({ visible: true, width: 12 })
  .setGaugeTitle({ visible: true, color: '#334155' })
  .setGaugeDetail({ visible: true, color: '#0f172a' })
  .build()
await fSlide.insertChart(chartInfo)
```

Board

```ts
const fBoard = univerAPI.getActiveBoard()
const chartInfo = fBoard
  .newChart(univerAPI.Enum.ChartTypeString.Gauge)
  .setSource([
    ['Metric', 'Value'],
    ['Completion', 72],
  ])
  .setCategoryField(0)
  .setGaugeValueField(1)
  .setGaugeMode(univerAPI.Enum.ChartGaugeMode.Modern)
  .setGaugeScale({ min: 0, max: 100 })
  .setGaugeTicks({ majorDivisions: 10, minorDivisionsPerMajor: 5 })
  .setGaugeAngles({ startAngle: 225, endAngle: -45 })
  .setGaugeRanges([{ from: 0, to: 60, color: '#dc2626' }])
  .setGaugeAxisLine({ visible: true, width: 12 })
  .setGaugeAxisTick({ visible: true, length: 6 })
  .setGaugeSplitLine({ visible: true, length: 12 })
  .setGaugeAxisLabel({ visible: true, color: '#334155' })
  .setGaugePointer({
    visible: true,
    shape: univerAPI.Enum.ChartGaugePointerShape.Needle,
    color: '#2563eb',
  })
  .setGaugeAnchor({ visible: true, size: 8 })
  .setGaugeProgress({ visible: true, width: 12 })
  .setGaugeTitle({ visible: true, color: '#334155' })
  .setGaugeDetail({ visible: true, color: '#0f172a' })
  .build()
await fBoard.insertChart(chartInfo)
```

## Setup

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

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

### `FGaugeChartBuilder.resetGaugeAnchor`

Resets the Gauge center anchor to renderer defaults.

```typescript
resetGaugeAnchor(): this
```

**Returns**

This builder for chaining.

**Examples**

```ts
builder.resetGaugeAnchor()
```

**Package:** [`@univerjs-pro/engine-chart`](https://docs.univer.ai/zh-CN/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-gauge-chart-builder.d.ts)

### `FGaugeChartBuilder.resetGaugeAngles`

Resets Gauge angles to renderer defaults.

```typescript
resetGaugeAngles(): this
```

**Returns**

This builder for chaining.

**Examples**

```ts
builder.resetGaugeAngles()
```

**Package:** [`@univerjs-pro/engine-chart`](https://docs.univer.ai/zh-CN/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-gauge-chart-builder.d.ts)

### `FGaugeChartBuilder.resetGaugeAxisLabel`

Resets Gauge scale labels to renderer defaults.

```typescript
resetGaugeAxisLabel(): this
```

**Returns**

This builder for chaining.

**Examples**

```ts
builder.resetGaugeAxisLabel()
```

**Package:** [`@univerjs-pro/engine-chart`](https://docs.univer.ai/zh-CN/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-gauge-chart-builder.d.ts)

### `FGaugeChartBuilder.resetGaugeAxisLine`

Resets Gauge axis-line styling to renderer defaults.

```typescript
resetGaugeAxisLine(): this
```

**Returns**

This builder for chaining.

**Examples**

```ts
builder.resetGaugeAxisLine()
```

**Package:** [`@univerjs-pro/engine-chart`](https://docs.univer.ai/zh-CN/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-gauge-chart-builder.d.ts)

### `FGaugeChartBuilder.resetGaugeAxisTick`

Resets Gauge minor ticks to renderer defaults.

```typescript
resetGaugeAxisTick(): this
```

**Returns**

This builder for chaining.

**Examples**

```ts
builder.resetGaugeAxisTick()
```

**Package:** [`@univerjs-pro/engine-chart`](https://docs.univer.ai/zh-CN/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-gauge-chart-builder.d.ts)

### `FGaugeChartBuilder.resetGaugeDetail`

Resets the Gauge value detail to renderer defaults.

```typescript
resetGaugeDetail(): this
```

**Returns**

This builder for chaining.

**Examples**

```ts
builder.resetGaugeDetail()
```

**Package:** [`@univerjs-pro/engine-chart`](https://docs.univer.ai/zh-CN/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-gauge-chart-builder.d.ts)

### `FGaugeChartBuilder.resetGaugeMode`

Resets the Gauge display mode to its default.

```typescript
resetGaugeMode(): this
```

**Returns**

This builder for chaining.

**Examples**

```ts
builder.resetGaugeMode()
```

**Package:** [`@univerjs-pro/engine-chart`](https://docs.univer.ai/zh-CN/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-gauge-chart-builder.d.ts)

### `FGaugeChartBuilder.resetGaugePointer`

Resets the Gauge pointer to renderer defaults.

```typescript
resetGaugePointer(): this
```

**Returns**

This builder for chaining.

**Examples**

```ts
builder.resetGaugePointer()
```

**Package:** [`@univerjs-pro/engine-chart`](https://docs.univer.ai/zh-CN/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-gauge-chart-builder.d.ts)

### `FGaugeChartBuilder.resetGaugeProgress`

Resets Gauge progress-arc settings to renderer defaults.

```typescript
resetGaugeProgress(): this
```

**Returns**

This builder for chaining.

**Examples**

```ts
builder.resetGaugeProgress()
```

**Package:** [`@univerjs-pro/engine-chart`](https://docs.univer.ai/zh-CN/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-gauge-chart-builder.d.ts)

### `FGaugeChartBuilder.resetGaugeRanges`

Clears authored Gauge scale ranges.

```typescript
resetGaugeRanges(): this
```

**Returns**

This builder for chaining.

**Examples**

```ts
builder.resetGaugeRanges()
```

**Package:** [`@univerjs-pro/engine-chart`](https://docs.univer.ai/zh-CN/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-gauge-chart-builder.d.ts)

### `FGaugeChartBuilder.resetGaugeScale`

Resets the Gauge scale to 0 through 100.

```typescript
resetGaugeScale(): this
```

**Returns**

This builder for chaining.

**Examples**

```ts
builder.resetGaugeScale()
```

**Package:** [`@univerjs-pro/engine-chart`](https://docs.univer.ai/zh-CN/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-gauge-chart-builder.d.ts)

### `FGaugeChartBuilder.resetGaugeSplitLine`

Resets Gauge major division lines to renderer defaults.

```typescript
resetGaugeSplitLine(): this
```

**Returns**

This builder for chaining.

**Examples**

```ts
builder.resetGaugeSplitLine()
```

**Package:** [`@univerjs-pro/engine-chart`](https://docs.univer.ai/zh-CN/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-gauge-chart-builder.d.ts)

### `FGaugeChartBuilder.resetGaugeTitle`

Resets the Gauge title to renderer defaults.

```typescript
resetGaugeTitle(): this
```

**Returns**

This builder for chaining.

**Examples**

```ts
builder.resetGaugeTitle()
```

**Package:** [`@univerjs-pro/engine-chart`](https://docs.univer.ai/zh-CN/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-gauge-chart-builder.d.ts)

### `FGaugeChartBuilder.setGaugeAnchor`

Sets the center anchor rendered beneath the Gauge pointer.

```typescript
setGaugeAnchor(value: IChartGaugeAnchorSpec): this
```

**Parameters**

* `value` — Required. Gauge anchor settings.

**Returns**

This builder for chaining.

**Examples**

```ts
builder.setGaugeAnchor({ visible: true, size: 8 })
```

**Types:** [`IChartGaugeAnchorSpec`](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/zh-CN/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-gauge-chart-builder.d.ts)

### `FGaugeChartBuilder.setGaugeAngles`

Sets the Gauge start and end angles.

```typescript
setGaugeAngles(value: IChartGaugeAnglesSpec): this
```

**Parameters**

* `value` — Required. Gauge angle settings in degrees.

**Returns**

This builder for chaining.

**Examples**

```ts
builder.setGaugeAngles({ startAngle: 225, endAngle: -45 })
```

**Types:** [`IChartGaugeAnglesSpec`](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/zh-CN/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-gauge-chart-builder.d.ts)

### `FGaugeChartBuilder.setGaugeAxisLabel`

Sets Gauge scale-label visibility, formatting, and styling.

```typescript
setGaugeAxisLabel(value: DeepNullish<IChartGaugeAxisLabelSpec>): this
```

**Parameters**

* `value` — Required. Gauge scale-label settings.

**Returns**

This builder for chaining.

**Examples**

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

**Types:** [`DeepNullish`](https://unpkg.com/@univerjs-pro/engine-chart@1.0.0-rc.0/lib/types/types.d.ts) · [`IChartGaugeAxisLabelSpec`](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/zh-CN/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-gauge-chart-builder.d.ts)

### `FGaugeChartBuilder.setGaugeAxisLine`

Sets Gauge axis-line visibility and styling.

```typescript
setGaugeAxisLine(value: IChartGaugeAxisLineSpec): this
```

**Parameters**

* `value` — Required. Gauge axis-line settings.

**Returns**

This builder for chaining.

**Examples**

```ts
builder.setGaugeAxisLine({ visible: true, width: 12 })
```

**Types:** [`IChartGaugeAxisLineSpec`](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/zh-CN/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-gauge-chart-builder.d.ts)

### `FGaugeChartBuilder.setGaugeAxisTick`

Sets Gauge minor tick visibility and styling.

```typescript
setGaugeAxisTick(value: IChartGaugeAxisTickSpec): this
```

**Parameters**

* `value` — Required. Gauge minor-tick settings.

**Returns**

This builder for chaining.

**Examples**

```ts
builder.setGaugeAxisTick({ visible: true, length: 6 })
```

**Types:** [`IChartGaugeAxisTickSpec`](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/zh-CN/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-gauge-chart-builder.d.ts)

### `FGaugeChartBuilder.setGaugeDetail`

Sets the Gauge value-detail formatter, styling, and offset.

```typescript
setGaugeDetail(value: DeepNullish<IChartGaugeDetailSpec>): this
```

**Parameters**

* `value` — Required. Gauge detail settings.

**Returns**

This builder for chaining.

**Examples**

```ts
builder.setGaugeDetail({ visible: true, color: '#0f172a' })
```

**Types:** [`DeepNullish`](https://unpkg.com/@univerjs-pro/engine-chart@1.0.0-rc.0/lib/types/types.d.ts) · [`IChartGaugeDetailSpec`](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/zh-CN/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-gauge-chart-builder.d.ts)

### `FGaugeChartBuilder.setGaugeMode`

Sets the Gauge display mode.

```typescript
setGaugeMode(value: ChartGaugeMode): this
```

**Parameters**

* `value` — Required. Gauge display mode.

**Returns**

This builder for chaining.

**Examples**

```ts
builder.setGaugeMode(univerAPI.Enum.ChartGaugeMode.Modern)
```

**Types:** [`ChartGaugeMode`](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/zh-CN/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-gauge-chart-builder.d.ts)

### `FGaugeChartBuilder.setGaugePointer`

Sets the pointer visibility, dimensions, color, and semantic shape preset.

```typescript
setGaugePointer(value: IChartGaugePointerSpec): this
```

**Parameters**

* `value` — Required. Gauge pointer settings.

**Returns**

This builder for chaining.

**Examples**

```ts
builder.setGaugePointer({
  visible: true,
  shape: univerAPI.Enum.ChartGaugePointerShape.Needle,
  color: '#2563eb',
})
```

**Types:** [`IChartGaugePointerSpec`](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/zh-CN/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-gauge-chart-builder.d.ts)

### `FGaugeChartBuilder.setGaugeProgress`

Sets Gauge progress-arc visibility and styling.

```typescript
setGaugeProgress(value: IChartGaugeProgressSpec): this
```

**Parameters**

* `value` — Required. Gauge progress-arc settings.

**Returns**

This builder for chaining.

**Examples**

```ts
builder.setGaugeProgress({ visible: true, width: 12 })
```

**Types:** [`IChartGaugeProgressSpec`](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/zh-CN/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-gauge-chart-builder.d.ts)

### `FGaugeChartBuilder.setGaugeRanges`

Sets colored Gauge scale ranges in scale-domain units.

```typescript
setGaugeRanges(value: readonly IChartGaugeRangeSpec[]): this
```

**Parameters**

* `value` — Required. Gauge scale ranges.

**Returns**

This builder for chaining.

**Examples**

```ts
builder.setGaugeRanges([{ from: 0, to: 60, color: '#dc2626' }])
```

**Types:** [`IChartGaugeRangeSpec`](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/zh-CN/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-gauge-chart-builder.d.ts)

### `FGaugeChartBuilder.setGaugeScale`

Sets the Gauge minimum, maximum, and optional major-division count.

```typescript
setGaugeScale(value: IChartGaugeScaleSpec): this
```

**Parameters**

* `value` — Required. Gauge scale settings.

**Returns**

This builder for chaining.

**Examples**

```ts
builder.setGaugeScale({ min: 0, max: 100, splitNumber: 10 })
```

**Types:** [`IChartGaugeScaleSpec`](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/zh-CN/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-gauge-chart-builder.d.ts)

### `FGaugeChartBuilder.setGaugeSplitLine`

Sets Gauge major division-line visibility and styling.

```typescript
setGaugeSplitLine(value: IChartGaugeSplitLineSpec): this
```

**Parameters**

* `value` — Required. Gauge division-line settings.

**Returns**

This builder for chaining.

**Examples**

```ts
builder.setGaugeSplitLine({ visible: true, length: 12 })
```

**Types:** [`IChartGaugeSplitLineSpec`](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/zh-CN/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-gauge-chart-builder.d.ts)

### `FGaugeChartBuilder.setGaugeTicks`

Sets regular major scale divisions and minor divisions per major interval.

```typescript
setGaugeTicks(value: IChartGaugeTicksPatch): this
```

**Parameters**

* `value` — Required. Gauge tick settings.

**Returns**

This builder for chaining.

**Examples**

```ts
builder.setGaugeTicks({ majorDivisions: 10, minorDivisionsPerMajor: 5 })
```

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

**Package:** [`@univerjs-pro/engine-chart`](https://docs.univer.ai/zh-CN/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-gauge-chart-builder.d.ts)

### `FGaugeChartBuilder.setGaugeTitle`

Sets the per-observation Gauge title styling and offset.

```typescript
setGaugeTitle(value: IChartGaugeTitleSpec): this
```

**Parameters**

* `value` — Required. Gauge title settings.

**Returns**

This builder for chaining.

**Examples**

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

**Types:** [`IChartGaugeTitleSpec`](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/zh-CN/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-gauge-chart-builder.d.ts)

### `FGaugeChartBuilder.setGaugeValueField`

Selects the only value field; labels use `setCategoryField()`.

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

**Parameters**

* `index` — Required. Zero-based value field index.

**Returns**

This builder for chaining.

**Examples**

```ts
builder.setGaugeValueField(1)
```

**Package:** [`@univerjs-pro/engine-chart`](https://docs.univer.ai/zh-CN/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-gauge-chart-builder.d.ts)