Skip to content

Аннотации

Декларативные пометки в координатах данных — рисуются поверх серий и переживают зум/ресайз. Интерактивное рисование — в будущих фазах.

Модульная сборка

В сборке через grafit-charts/core аннотации — отдельный модуль: register(annotationsModule).

ts
import { getData } from './data';
import type { ChartOptions } from 'grafit-charts';

export function createOptions(): ChartOptions {
  return {
    data: getData(),
    title: { text: 'Annotations' },
    series: [{ type: 'line', xField: 'month', yField: 'price', name: 'Price' }],
    annotations: [
      { type: 'horizontal-line', value: 180, stroke: '#e5484d', label: { text: 'resistance 180' } },
      { type: 'range', axis: 'x', range: ['Mar', 'Apr'], label: { text: 'correction' } },
      { type: 'line', start: { x: 'Jan', y: 140 }, end: { x: 'Aug', y: 196 }, stroke: '#21a06c', lineDash: [6, 4] },
      { type: 'text', x: 'Jun', y: 192, text: 'peak' },
    ],
    legend: { enabled: false },
  };
}
ts
export function getData() {
  return [
    { month: 'Jan', price: 142 },
    { month: 'Feb', price: 149 },
    { month: 'Mar', price: 161 },
    { month: 'Apr', price: 155 },
    { month: 'May', price: 171 },
    { month: 'Jun', price: 188 },
    { month: 'Jul', price: 179 },
    { month: 'Aug', price: 195 },
  ];
}

Горизонтальные и вертикальные линии можно перетаскивать мышью (всегда включено).

Типы

ТипПоляОписание
horizontal-linevalue, stroke?, lineDash?, label?горизонтальный уровень
vertical-linevalue (категория/дата), …вертикальная отметка
linestart: {x, y}, end: {x, y}произвольный отрезок (трендовая)
textx, y, text, color?, fontSize?подпись в точке данных
rangeaxis: 'x' | 'y', range: [a, b], fill?, label?закрашенный диапазон

Полный список опций

ОпцияТипПо умолчаниюОписание
strokeWidthлинии1толщина линии аннотации
fillOpacityrange0.12прозрачность заливки диапазона
label.textstringподпись линии (horizontal/vertical-line)
label.fontSizePixels11шрифт подписи
label.colorColorValueцвет линиицвет подписи

Координаты задаются значениями данных: категории/даты для X, числа для Y.

horizontal-line и vertical-line можно перетаскивать мышью — значение обновляется по шкале (категориальные линии прилипают к ближайшей категории).