scichart/Builder/buildAnnotations.d.ts

Fast WebGL JavaScript Charting Library and Framework

import { IAxisMarkerAnnotationOptions } from "../Charting/Visuals/Annotations/AxisMarkerAnnotation";
import { IBoxAnnotationOptions } from "../Charting/Visuals/Annotations/BoxAnnotation";
import { ICustomAnnotationOptions } from "../Charting/Visuals/Annotations/CustomAnnotation";
import { IHtmlCustomAnnotationOptions } from "../Charting/Visuals/Annotations/HtmlCustomAnnotation";
import { IHtmlTextAnnotationOptions } from "../Charting/Visuals/Annotations/HtmlTextAnnotation";
import { EAnnotationType, IAnnotation } from "../Charting/Visuals/Annotations/IAnnotation";
import { ILineAnnotationOptions } from "../Charting/Visuals/Annotations/LineAnnotation";
import { ILineArrowAnnotationOptions } from "../Charting/Visuals/Annotations/LineArrowAnnotation";
import { INativeTextAnnotationOptions } from "../Charting/Visuals/Annotations/NativeTextAnnotation";
import { IPolarPointerAnnotationOptions } from "../Charting/Visuals/Annotations/PolarPointerAnnotation";
import { ITextAnnotationOptions } from "../Charting/Visuals/Annotations/TextAnnotation";
import { ISvgLineAnnotationOptions } from "../Charting/Visuals/Annotations/SvgLineAnnotation";
/** Definition of an annotation, comprising a {@link EAnnotationType} and the relevant options  */
export declare type TAnnotationDefinition = {
    type: EAnnotationType.RenderContextAxisMarkerAnnotation;
    options?: IAxisMarkerAnnotationOptions;
} | {
    type: EAnnotationType.RenderContextBoxAnnotation;
    options?: IBoxAnnotationOptions;
} | {
    type: EAnnotationType.RenderContextHorizontalLineAnnotation;
    options?: ILineAnnotationOptions;
} | {
    type: EAnnotationType.RenderContextLineAnnotation;
    options?: ILineAnnotationOptions;
} | {
    type: EAnnotationType.RenderContextVerticalLineAnnotation;
    options?: ILineAnnotationOptions;
} | {
    type: EAnnotationType.SVGTextAnnotation;
    options?: ITextAnnotationOptions;
} | {
    type: EAnnotationType.SVGCustomAnnotation;
    options?: ICustomAnnotationOptions;
} | {
    type: EAnnotationType.SVGPolarPointerAnnotation;
    options?: IPolarPointerAnnotationOptions;
} | {
    type: EAnnotationType.HtmlCustomAnnotation;
    options?: IHtmlCustomAnnotationOptions;
} | {
    type: EAnnotationType.HtmlTextAnnotation;
    options?: IHtmlTextAnnotationOptions;
} | {
    type: EAnnotationType.RenderContextLineArrowAnnotation;
    options?: ILineArrowAnnotationOptions;
} | {
    type: EAnnotationType.RenderContextNativeTextAnnotation;
    options?: INativeTextAnnotationOptions;
} | {
    type: EAnnotationType.RenderContextArcAnnotation;
    options?: ILineAnnotationOptions;
} | {
    type: EAnnotationType.RenderContextPolarArcAnnotation;
    options?: ILineAnnotationOptions;
} | {
    type: EAnnotationType.SvgLineAnnotation;
    options?: ISvgLineAnnotationOptions;
};
/**
 * Build one or more annotations from a definition that can be pure data.
 * @param definition One or an array of {@link TAnnotationDefinition}
 * @returns An array of annotations
 */
export declare const buildAnnotations: (definition: TAnnotationDefinition | TAnnotationDefinition[]) => IAnnotation[];