feature

Overlay vs pane

The first decision for an indicator is where it draws: on top of price (overlay) or in its own sub-pane (pane), like RSI or MACD.

meta also sets the short name you see on the chart and optional limits such as which timeframes are allowed. Get this wrong and the series appears in the wrong place or under the wrong label.

Signature

meta({
  shortName: string;           // required
  kind: "overlay" | "pane";
  dataSource?: { type: "candles" } | { type: "volume-candles"; settings: {...} };
  category?: string;
  runOn?: string[];
  runOnReason?: string;
}): void

Field	Notes
`kind: "overlay"`	Draw on the price pane
`kind: "pane"`	Separate pane (RSI, MACD, …)
`shortName`	Chart label
`dataSource` / `runOn`	Shared — see Price and bar data and Multi-timeframe and runOn

pane()

Use pane({ ... }) when you need pane-level options (scale, height hints). Pair with kind: "pane".

meta({ shortName: "RSI", kind: "pane" });
pane({ /* PaneOpts — see IntelliSense */ });

Not definition meta

Definitions use kind: "flow" and slug for Collect — see Definition meta.

← Previous Next →