mirror of
https://github.com/snapotter-hq/SnapOtter.git
synced 2026-08-03 07:46:42 +02:00
54 lines
2.9 KiB
Markdown
54 lines
2.9 KiB
Markdown
|
---
|
|||
|
|
description: "Создание столбчатых, линейных или круговых диаграмм из данных CSV или JSON."
|
|||
|
|
i18n_source_hash: d3c39384457b
|
|||
|
|
i18n_provenance: human
|
|||
|
|
i18n_output_hash: d4bf64976710
|
|||
|
|
---
|
|||
|
|
|
|||
|
|
# Конструктор диаграмм {#chart-maker}
|
|||
|
|
|
|||
|
|
Создание столбчатых, линейных или круговых диаграмм из данных CSV или JSON. Возвращает изображение PNG с отрисованной диаграммой.
|
|||
|
|
|
|||
|
|
## Эндпоинт API {#api-endpoint}
|
|||
|
|
|
|||
|
|
`POST /api/v1/tools/files/chart-maker`
|
|||
|
|
|
|||
|
|
Принимает multipart form data с файлом CSV или JSON и JSON-полем `settings`.
|
|||
|
|
|
|||
|
|
## Параметры {#parameters}
|
|||
|
|
|
|||
|
|
| Параметр | Тип | Обязательный | По умолчанию | Описание |
|
|||
|
|
|-----------|------|----------|---------|-------------|
|
|||
|
|
| kind | string | Нет | `"bar"` | Тип диаграммы: `bar`, `line`, `pie` |
|
|||
|
|
| title | string | Нет | - | Заголовок диаграммы (максимум 120 символов) |
|
|||
|
|
| width | integer | Нет | `960` | Ширина диаграммы в пикселях (320-2048) |
|
|||
|
|
| height | integer | Нет | `540` | Высота диаграммы в пикселях (240-1536) |
|
|||
|
|
|
|||
|
|
## Пример запроса {#example-request}
|
|||
|
|
|
|||
|
|
```bash
|
|||
|
|
curl -X POST http://localhost:1349/api/v1/tools/files/chart-maker \
|
|||
|
|
-H "Authorization: Bearer si_your-api-key" \
|
|||
|
|
-F "file=@sales.csv" \
|
|||
|
|
-F 'settings={"kind": "line", "title": "Monthly Sales", "width": 960, "height": 540}'
|
|||
|
|
```
|
|||
|
|
|
|||
|
|
## Пример ответа {#example-response}
|
|||
|
|
|
|||
|
|
```json
|
|||
|
|
{
|
|||
|
|
"jobId": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
|
|||
|
|
"downloadUrl": "/api/v1/download/a1b2c3d4-e5f6-7890-abcd-ef1234567890/sales_chart.png",
|
|||
|
|
"originalSize": 1024,
|
|||
|
|
"processedSize": 48500
|
|||
|
|
}
|
|||
|
|
```
|
|||
|
|
|
|||
|
|
## Примечания {#notes}
|
|||
|
|
|
|||
|
|
- Входные данные должны быть файлом `.csv` или `.json`. Файлы CSV должны содержать строку заголовка с именами столбцов.
|
|||
|
|
- Первый столбец используется как метка категории; второй столбец должен быть числовым и предоставляет значения данных. Используются только два столбца.
|
|||
|
|
- Входные данные JSON должны быть массивом объектов `{label, value}` или простым объектом, ключи которого становятся метками, а значения точками данных.
|
|||
|
|
- Максимум 100 точек данных. Все значения должны быть нулевыми или больше.
|
|||
|
|
- Выходной файл всегда является изображением PNG независимо от входного формата.
|