chartjs-plugin-annotation/types/index.d.ts

Annotations for Chart.js

import { Chart, ChartType, Plugin } from 'chart.js';
import { AnnotationPluginOptions, BoxAnnotationOptions, EllipseAnnotationOptions, LabelAnnotationOptions, LineAnnotationOptions, PointAnnotationOptions, PolygonAnnotationOptions, DoughnutLabelAnnotationOptions } from './options';
import { AnnotationElement } from './element';

declare module 'chart.js' {
  // eslint-disable-next-line @typescript-eslint/no-unused-vars
  interface PluginOptionsByType<TType extends ChartType> {
    annotation: AnnotationPluginOptions;
  }

  interface ElementOptionsByType<TType extends ChartType> {
    boxAnnotation: BoxAnnotationOptions;
    doughnutLabelAnnotation: DoughnutLabelAnnotationOptions;
    ellipseAnnotation: EllipseAnnotationOptions;
    labelAnnotation: LabelAnnotationOptions;
    lineAnnotation: LineAnnotationOptions;
    pointAnnotation: PointAnnotationOptions;
    polygonAnnotation: PolygonAnnotationOptions;
  }
}

declare const Annotation: Plugin & {
  getAnnotations(chart: Chart): AnnotationElement[];
};

export default Annotation;

export * from './element';
export * from './events';
export * from './label';
export * from './options';