RangeBarsOptions

Documentation

Documentation / @elitechart/core / RangeBarsOptions

Defined in: series/range-bars.ts:45

Range Bars configuration. Pass to chart.setRangeBarsOptions(...) or to computeRangeBars directly.

Example

import { suggestRangeBarsRangeSize } from '@elitechart/core';
const rangeSize = suggestRangeBarsRangeSize(bars, { tickSize: 0.01 });
const opts: RangeBarsOptions = { rangeSize };
chart.setRangeBarsOptions(opts);

Properties

rangeSize?

readonly optional rangeSize?: number;

Defined in: series/range-bars.ts:51

The price range each emitted bar covers. Must be > 0. Default 1. For real-money use, derive from ATR or a tickSize multiple via suggestRangeBarsRangeSize.