Features

Annotations and plugins

Markers, price lines, tooltips, watermarks, session highlighting, and custom primitives.

Markers

Series markers

candles.set_markers([
  { time: 1735689600, position: "belowBar", shape: "arrowUp", color: "#26a69a", text: "Buy" },
  { time: 1735862400, position: "aboveBar", shape: "arrowDown", color: "#ef5350", text: "Sell" },
]);

candles.set_markers([]); // clear

Price lines

const stop = candles.create_price_line({
  price: 98.5,
  color: "#ef5350",
  line_width: 1,
  title: "Stop",
  axis_label_visible: true,
});

stop.remove();

The series option price_line_extent sets how far the last-price line reaches: "partial" (the default) or "full".

Feature helpers

Feature helpers
Helper	Adds
`create_tooltip(chart, options?)`	A hover tooltip.
`create_delta_tooltip`	A delta tooltip for line, area, and bar series. Not available on candlesticks.
`create_series_markers`	A marker layer managed as a plugin.
`create_text_watermark, create_image_watermark`	Text or image watermarks.
`create_session_highlighting`	Shaded trading sessions.
`create_highlight_bar_crosshair`	A crosshair that highlights the whole bar slot.
`create_user_price_line`	A user-placed price line.
`create_bands_indicator`	Price bands, such as ±10% around the price.
`create_overlay_price_scale, use_overlay_price_scale`	An overlay price scale for a series.
`create_volume_profile`	A time-anchored volume profile from bins you supply.
`create_anchored_text, create_trend_line, create_vertical_line, create_rectangle_drawing`	Programmatic annotations.
`enable_brushable_area_interaction`	Range brushing on an area series.

Volume profile

import { create_volume_profile } from "@aeristerminal/aeris-charts";

const profile = create_volume_profile(candles, {
  time: 1735689600,
  profile: [{ price: 100, vol: 12 }, { price: 101, vol: 28 }],
  width: 10, // bar slots
});

profile.detach();

Every helper handle with detach() releases its engine and page state.

Primitives

Primitives are the lowest-level extension point. A pane or series primitive records the same draw commands as a custom series (rectangles, lines, polylines, area fills, circles, triangles, and text) and can add axis labels and hit testing. Attach them with pane.attach_primitive, pane.attach_canvas_primitive, or series.attach_primitive.

Experimental

Primitives, feature helpers, and plugin helpers are experimental APIs.