candlestick — 6.0.0

type CandlestickSpec = Readonly<{
  /** Unique-X OHLC tuples satisfying `low <= open/close <= high`. */
  data: readonly CandlestickDatum[];
  /** Plot width in terminal columns. */
  width?: number;
  /** Plot height in terminal rows. */
  height?: number;
  /** Title rendered above the chart. */
  title?: string;
  /** Numeric X-axis configuration. */
  xAxis?: XAxis<number>;
  /** Numeric Y-axis configuration. */
  yAxis?: YAxis;
  /** Per-direction body colors and glyphs plus a wick glyph. */
  style?: CandlestickStyle;
  /** Named horizontal or vertical reference lines. */
  thresholds?: readonly ChartThreshold<number>[];
  /** Shared symbol overrides. `style` glyphs take precedence. */
  symbols?: Symbols;
  /** Logs out-of-bounds drawing attempts for diagnostics. */
  debugMode?: boolean;
}>;

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

type CandlestickMarkStyle = Readonly<{
  /** One-column body glyph. */
  symbol?: string;
  /** ANSI color applied to the body and wick. */
  color?: Color;
}>;

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 XAxis = {
  /** Scale kind. Defaults to the kind inferred from X values. */
  scale?: XScale;
  /** Explicit category order or continuous scale extent. */
  domain?: XAxisDomain<X>;
  /** Exact native tick values or an exact tick count of at least two. */
  ticks?: number | readonly X[];
  /** Axis label rendered outside tick labels. */
  label?: string;
  /** Formatter called with native X values. */
  formatter?: AxisFormatter<X>;
  /** Hides the axis line, ticks, labels, and axis label. */
  hidden?: boolean;
  /** Hides tick markers and labels while retaining the axis line. */
  hideTicks?: boolean;
  /** Handling for labels that do not fit the available width. */
  labelCollision?: LabelCollisionPolicy;
  /** ANSI color applied to the axis line, ticks, tick labels, and label. */
  color?: Color;
};

type YAxis = {
  /** Explicit numeric extent as `[minimum, maximum]`. */
  domain?: readonly [number, number];
  /** Exact numeric tick values or an exact tick count of at least two. */
  ticks?: number | readonly number[];
  /** Axis label rendered outside tick labels. */
  label?: string;
  /** Formatter called for each numeric Y-axis tick. */
  formatter?: Formatter;
  /** Hides the axis line, ticks, labels, and axis label. */
  hidden?: boolean;
  /** Hides tick markers and labels while retaining the axis line. */
  hideTicks?: boolean;
  /** Reserves enough width for complete Y-axis tick labels. */
  showTickLabel?: boolean;
  /** ANSI color applied to the axis line, ticks, tick labels, and label. */
  color?: Color;
};