Skip to content

Commit

Permalink
docs(Pie): add formatter description (#57)
Browse files Browse the repository at this point in the history
  • Loading branch information
arhayka authored Apr 20, 2022
1 parent 4baa0f0 commit 0399e9e
Showing 1 changed file with 3 additions and 0 deletions.
3 changes: 3 additions & 0 deletions src/__private__/components/Pie/__stories__/Pie.docs.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -105,6 +105,8 @@ export function PieExampleDonut() {
- `title` — это подпись (общее число или название сектора),
- `content` — значение (сумма или величина сектора).

Поменять формат, в котором выводится статистика, можно с помощью свойства `formatter`.

Если вам нужен пустой пончик, укажите `false` в обоих свойствах.

[Подробнее о статистике](https://g2plot.antv.vision/en/docs/api/plots/pie#statistic-)
Expand Down Expand Up @@ -191,4 +193,5 @@ export function LineExampleMultiLine() {
| [`angleField`](#круг) | `string` | - | Поле с величиной сектора |
| [`innerRadius`](#пончик) | `string` | - | Диаметр пустого пространства внутри пончика (от 0 до 1) |
| [`statistic`](#пончик-со-статистикой) | `boolean` | - | Формат статистики. Работает, если `innerRadius` > 0 |
| [`formatter`](#пончик-со-статистикой) | `(text: string, item: ListItem, index: number) => any;` | - | Колбэк-функция, с помощью которой можно отформатировать любое текстовое поле. Например, подпись в центре пончика (`statistic.title`), подпись к значению в тултипе или название элемента в легенде |
| `className` | `string` | - | Дополнительный CSS-класс компонента

0 comments on commit 0399e9e

Please sign in to comment.