MagnetResult

Result of a snapToOhlc call. snappedToBar / snappedField are populated only when a snap actually occurred.

Example

code

const r: MagnetResult = snapToOhlc(bars, t, p, 'weak', pxDist);
if (r.snappedField === 'high') console.log('snapped to high');

code

readonly price: Price;

The (possibly-snapped) price.

code

readonly optional snappedField?: "open" | "high" | "low" | "close";

Which OHLC field was used ('open' | 'high' | 'low' | 'close').

code

readonly optional snappedToBar?: Bar;

The bar whose OHLC contributed the snap value, when snapping happened.