Types

Interfaces and type aliases exported by @reincharts/annotations.

import type { AnnotationShape, DataX, MarkerItem, ... } from "@reincharts/annotations";

AnnotationShape

type AnnotationShape =
    "arrowUp" | "arrowDown" | "circle" | "square" | "diamond" | "triangle" | "triangleDown" | "flag" | "cross";

DataX

A data x value: a Date / timestamp, a number (linear x or numeric data) or a category name.

type DataX = Date | number | string;

MarkerItem

One explicit marker placed by data x.

Prop

Type

MarkerPosition

type MarkerPosition = "above" | "below" | "inBar" | "atPrice";

ResolvedMarker

A marker resolved to pixels (passed to onClick).

Prop

Type

On this page