custom-series/segmentedDoughnut/README.md

# @echarts-x/custom-segmented-doughnut

`segmentedDoughnut` is a custom series for [Apache ECharts](https://github.com/apache/echarts). It's typically used to show discrete progress of a task.

![segmentedDoughnut](https://raw.githubusercontent.com/apache/echarts-custom-series/main/custom-series/segmentedDoughnut/screenshots/segmentedDoughnut.svg)

[Source Code](https://github.com/apache/echarts-custom-series/tree/main/custom-series/segmentedDoughnut)

## Usage

### Browser Environment

For browser usage, use the auto-registration version that automatically installs the custom series when loaded:

```html
<script src="./node_modules/echarts/dist/echarts.js"></script>
<script src="./node_modules/@echarts-x/custom-segmented-doughnut/dist/index.auto.js"></script>
<script>
  // No need to call echarts.use(), automatically registered
  const chart = echarts.init(...);
  const option = {
    series: [{
      type: 'custom',
      renderItem: 'segmentedDoughnut',
      // ...
    }]
  }
  chart.setOption(option);
</script>
```

See [examples](./examples) for more details.

### UMD (Universal Module Definition)

For environments that need manual registration or when using AMD/CommonJS loaders:

```js
// CommonJS
const echarts = require('echarts');
const segmentedDoughnutInstaller = require('@echarts-x/custom-segmented-doughnut');
echarts.use(segmentedDoughnutInstaller);
const chart = echarts.init(...);

const option = {
  series: [{
    type: 'custom',
    renderItem: 'segmentedDoughnut',
    // ...
  }]
}
chart.setOption(option);
```

See [examples](./examples) for more details.

### ESM (ES Modules)

For modern module bundlers or native ES module environments:

```bash
npm install @echarts-x/custom-segmented-doughnut
```

```js
import * as echarts from 'echarts';
import segmentedDoughnutCustomSeriesInstaller from '@echarts-x/custom-segmented-doughnut';

echarts.use(segmentedDoughnutCustomSeriesInstaller);
const chart = echarts.init(...);

const option = {
  series: [{
    type: 'custom',
    renderItem: 'segmentedDoughnut',
    // ...
  }]
}
chart.setOption(option);
```

See [examples](./examples) for more details.

## API

### series.data

The data of the series is an array of arrays. Each sub-array represents a segment of the doughnut.

```js
const data = [];
```

### series.itemPayload

The `itemPayload` is an object that contains the following properties:

| Property | Type | Default | Description |
| -------- | ---- | ------- | ----------- |

### series.encode

To make sure the value axis and tooltip take the correct range, `encode` should be set as follows:

```js
encode: {
    x: 0,
    y: 1,
    tooltip: 2
}
```

See [test](./test/index.html) for more details.