Skip to main content

types.RuntimeOutput#

Return type of compute() and the implicit shape produced by onBar() after all plot() / entity.* emissions are flushed.

SYNTAX#

interface RuntimeOutput { name: string; pane: 'overlay' | 'sub'; lines?: RuntimeLine[]; fills?: RuntimeFill[]; histograms?: RuntimeHistogram[]; markerSeries?: RuntimeMarkerSeries[]; candleSeries?: RuntimeCandleSeries[]; tables?: RuntimeTable[]; entities?: Entity[]; }

ARGUMENTS#

  • name (string) — Display name shown in the chart legend.
  • pane ('overlay' | 'sub') — overlay paints on the price chart; sub allocates a separate pane below.
  • lines (RuntimeLine[]) — Optional. One entry per line series; values[i] aligns 1:1 with candles[i].
  • fills (RuntimeFill[]) — Optional. Shaded regions between two named lines.
  • histograms (RuntimeHistogram[]) — Optional. Histogram series; populated by plot.histogram(...).
  • markerSeries (RuntimeMarkerSeries[]) — Optional. Sparse marker series; populated by plot.marker(...).
  • candleSeries (RuntimeCandleSeries[]) — Optional. Overlay candle series (Heikin-Ashi etc.); populated by plot.candle(...).
  • tables (RuntimeTable[]) — Optional. Screen-space dashboard tables (corner-anchored).
  • entities (Entity[]) — Optional. Keyed persistent visual objects (lines, markers, boxes, labels, arrows).

RETURNS#

Type definition — see params for the field-by-field shape.

EXAMPLE#

return {
  name: 'My Indicator', pane: 'sub',
  lines: [
    { name: 'main',   values: mainValues,   color: '#26a69a', width: 2 },
    { name: 'signal', values: signalValues, color: '#fbbf24', width: 1, style: 'dashed' }
  ],
  fills: [
    { name: 'zone', topLine: 'main', bottomLine: 'signal', color: '#26a69a', opacity: 0.15 }
  ]
};

SEE ALSO#

types.RuntimeLine, types.RuntimeFill, types.RuntimeHistogram