Shared API reference — 6.0.0

type Symbols = {
  /** Axis line, tick, boundary, and intersection glyph overrides. */
  axis?: Partial<typeof AXIS>;
  /** Line and filled-area glyph overrides. */
  chart?: Partial<typeof CHART>;
  /** One-column glyph for unoccupied plot cells. */
  empty?: string;
  /** One-column glyph painted behind plot data. */
  background?: string;
  /** One-column glyph used for the plot border. */
  border?: string;
  /** Horizontal and vertical threshold glyph overrides. */
  thresholds?: Partial<typeof THRESHOLDS>;
  /** One-column point glyph. */
  point?: string;
  /** Shared candlestick glyph overrides. */
  candlestick?: CandlestickSymbols;
  /** Shared annotation glyph overrides. */
  annotations?: AnnotationSymbols;
  /** One-column glyph used when labels are truncated. */
  ellipsis?: string;
};

type SparklineSymbols = Readonly<{
  /** Exactly eight one-column glyphs ordered from lowest to highest. */
  levels?: readonly [string, string, string, string, string, string, string, string];
  /** One-column glyph used for `null`. */
  empty?: string;
}>;

type HeatmapSymbols = Readonly<{
  /** Default one-column categorical cell glyph. */
  cell?: string;
  /** Default one-column glyph for values below a threshold. */
  belowThreshold?: string;
  /** Default one-column glyph for values at or above a threshold. */
  aboveThreshold?: string;
  /** One-column glyph used for `null`. */
  empty?: string;
  /** Display-safe text inserted between cells. */
  gap?: string;
}>;

type CandlestickSymbols = Readonly<{
  /** One-column wick glyph. */
  wick?: string;
  /** One-column glyph used when close is greater than open. */
  rising?: string;
  /** One-column glyph used when close is less than open. */
  falling?: string;
  /** One-column glyph used when close equals open. */
  unchanged?: string;
}>;

type AnnotationSymbols = Readonly<{
  /** One-column reference-span fill glyph. */
  span?: string;
  /** One-column arrow-line glyph. */
  arrowLine?: string;
  /** Direction-specific arrowhead glyphs. */
  arrowHeads?: ArrowHeadSymbols;
  /** Error-bar glyphs. */
  errorBar?: ErrorBarSymbols;
}>;

type ArrowHeadSymbols = Readonly<{
  /** Left-facing arrowhead. */
  left?: string;
  /** Right-facing arrowhead. */
  right?: string;
  /** Up-facing arrowhead. */
  up?: string;
  /** Down-facing arrowhead. */
  down?: string;
  /** Up-left arrowhead. */
  upLeft?: string;
  /** Up-right arrowhead. */
  upRight?: string;
  /** Down-left arrowhead. */
  downLeft?: string;
  /** Down-right arrowhead. */
  downRight?: string;
}>;

type ErrorBarSymbols = Readonly<{
  /** Horizontal whisker glyph. */
  horizontal?: string;
  /** Vertical whisker glyph. */
  vertical?: string;
  /** Left cap glyph. */
  leftCap?: string;
  /** Right cap glyph. */
  rightCap?: string;
  /** Top cap glyph. */
  topCap?: string;
  /** Bottom cap glyph. */
  bottomCap?: string;
  /** Error-bar center glyph. */
  center?: string;
}>;

type ColorContext = {
  /** Zero-based source-series index. */
  series: number;
  /** Rendering mode used by the occupied cell. */
  mode: GraphMode;
  /** Numeric data-space X coordinate. */
  x: number;
  /** Numeric data-space Y coordinate. */
  y: number;
  /** Zero-based plot-column coordinate. */
  plotX: number;
  /** Zero-based plot-row coordinate. */
  plotY: number;
};

type FormatterHelpers = {
  /** Axis currently being formatted. */
  axis: 'x' | 'y';
  /** Resolved numeric X extent. */
  xRange: number[];
  /** Resolved numeric Y extent. */
  yRange: number[];
};

type LineFormatterArgs = {
  /** Numeric data-space X coordinate. */
  x: number;
  /** Numeric data-space Y coordinate. */
  y: number;
  /** Zero-based plot-column coordinate. */
  plotX: number;
  /** Zero-based plot-row coordinate. */
  plotY: number;
  /** Complete source series. */
  input: SingleLine;
  /** Zero-based datum index in the source series. */
  index: number;
  /** Resolved minimum Y value. */
  minY: number;
  /** Resolved minimum X value. */
  minX: number;
  /** Expanded numeric X coordinates used by the renderer. */
  expansionX: number[];
  /** Expanded numeric Y coordinates used by the renderer. */
  expansionY: number[];
  /** Converts data coordinates into plot coordinates. */
  toPlotCoordinates: (x: number, y: number) => Point;
};

type ValueLabelContext = Readonly<{
  /** Zero-based source-series index. */
  seriesIndex: number;
  /** Structured-series identifier when available. */
  seriesId?: string;
  /** Structured-series or legend name when available. */
  seriesName?: string;
  /** Zero-based index in the source series. */
  datumIndex: number;
  /** Native source X value. */
  x: X;
  /** Raw source Y value. */
  y: number;
  /** Bar orientation. */
  mode: 'bar' | 'horizontalBar';
  /** Resolved multi-series bar layout. */
  layout: BarLayout;
}>;