Table of Contents

Interface IHeatmapSeriesLease<TValue>

Namespace
ATAS.Indicators.Heatmap
Assembly
ATAS.Indicators.dll

Per-series mutation surface inside the lease. Append, replace, clear, and trim operations are buffered to the back-stage and become visible to the renderer on lease disposal.

Added in ATAS 8.0.15.

public interface IHeatmapSeriesLease<TValue>

Type Parameters

TValue

Indicator-internal sample type.

Extension Methods

Properties

Style

Per-series style override; null falls back to the descriptor default.

HeatmapIndicatorVisualStyle? Style { get; set; }

Property Value

HeatmapIndicatorVisualStyle

Methods

Append(in HeatmapIndicatorSample<TValue>)

Append a pre-built sample by reference. Equivalent to Append(long, TValue) with the sample fields, but avoids destructuring + reconstructing the struct when the indicator already holds a HeatmapIndicatorSample<TValue> (e.g. from warm-up payload or a calculation that returned the sample shape).

bool Append(in HeatmapIndicatorSample<TValue> sample)

Parameters

sample HeatmapIndicatorSample<TValue>

Returns

bool

Append(long, TValue)

Append one sample to the back-stage. Returns true when stored, false when discarded because timestampNanos is older than the latest committed-or-staged sample. Equal-timestamp appends replace the latest staged sample (or the latest committed one if no staged samples yet).

bool Append(long timestampNanos, TValue value)

Parameters

timestampNanos long
value TValue

Returns

bool

AppendRange(ReadOnlySpan<HeatmapIndicatorSample<TValue>>)

Append a span of samples; same ordering rules as Append(long, TValue). Returns the number of samples accepted.

int AppendRange(ReadOnlySpan<HeatmapIndicatorSample<TValue>> samples)

Parameters

samples ReadOnlySpan<HeatmapIndicatorSample<TValue>>

Returns

int

Clear()

Drop every sample in this series. After commit, CommittedCount reads as zero. Combined with subsequent appends in the same lease this is the canonical "rebuild" pattern for indicator-initiated recalculation (see design doc ยง5.2).

void Clear()

TrimBefore(long)

Evict every committed sample whose timestamp < timestampNanos. Returns the number of samples evicted. Useful at session boundaries to bound memory.

int TrimBefore(long timestampNanos)

Parameters

timestampNanos long

Returns

int