ATAS.Indicators.Heatmap.HeatmapIndicatorDescriptorBuilder Class Reference

Fluent builder that produces an immutable HeatmapIndicatorDescriptor alongside the typed visual / series handles required by the state builder. Single-shot: each builder yields exactly one descriptor via Done; further mutation throws. More...

Public Member Functions
HeatmapIndicatorVisualHandle	Visual (string visualId, HeatmapIndicatorVisualKind kind, string? label=null, HeatmapIndicatorVisualStyle? defaultStyle=null, HeatmapIndicatorVisualPresentation? defaultPresentation=null)
	Add a visual of any kind. The kind-specific helpers (PriceLine, SubPanelScalar, …) are usually clearer; reach for this one when the kind is computed at runtime.
HeatmapIndicatorVisualHandle	PriceLine (string visualId, string? label=null, HeatmapIndicatorVisualStyle? defaultStyle=null)
HeatmapIndicatorVisualHandle	ValueArea (string visualId, string? label=null, HeatmapIndicatorVisualStyle? defaultStyle=null)
HeatmapIndicatorVisualHandle	LevelLine (string visualId, string? label=null, HeatmapIndicatorVisualStyle? defaultStyle=null)
HeatmapIndicatorVisualHandle	SubPanelScalar (string visualId, string? label=null, HeatmapIndicatorVisualStyle? defaultStyle=null, HeatmapIndicatorVisualPresentation? defaultPresentation=null)
HeatmapIndicatorVisualHandle	SubPanelPair (string visualId, string? label=null, HeatmapIndicatorVisualStyle? defaultStyle=null, HeatmapIndicatorVisualPresentation? defaultPresentation=null)
HeatmapIndicatorVisualHandle	Histogram (string visualId, string? label=null, HeatmapIndicatorVisualStyle? defaultStyle=null, HeatmapIndicatorVisualPresentation? defaultPresentation=null)
HeatmapIndicatorDescriptor	Done ()
	Seal the builder and produce the immutable descriptor. The visual / series handles minted by this builder remain usable as state-builder inputs after Done; what becomes invalid is mutation (no more Visual calls, no more HeatmapIndicatorVisualHandle.Series<TValue> calls). Single-shot: a second Done throws.

Detailed Description

Fluent builder that produces an immutable HeatmapIndicatorDescriptor alongside the typed visual / series handles required by the state builder. Single-shot: each builder yields exactly one descriptor via Done; further mutation throws.

private static readonly HeatmapIndicatorDescriptor _descriptor;
private static readonly HeatmapIndicatorVisualHandle _panel;
private static readonly HeatmapIndicatorSeriesHandle<long> _value;
 
static MyIndicator()
{
    var build = HeatmapIndicator.Describe("vendor.my-indicator", "My Indicator");
    _panel = build.SubPanelScalar("my.panel", "My Panel");
    _value = _panel.Series<long>(
        "my.value",
        HeatmapIndicatorSeriesRole.Scalar,
        HeatmapIndicatorValueKind.Integer,
        metricId: "my.value");
    _descriptor = build.Done();
}

Member Function Documentation

Done()

HeatmapIndicatorDescriptor ATAS.Indicators.Heatmap.HeatmapIndicatorDescriptorBuilder.Done

(

)

Seal the builder and produce the immutable descriptor. The visual / series handles minted by this builder remain usable as state-builder inputs after Done; what becomes invalid is mutation (no more Visual calls, no more HeatmapIndicatorVisualHandle.Series<TValue> calls). Single-shot: a second Done throws.

Histogram()

HeatmapIndicatorVisualHandle ATAS.Indicators.Heatmap.HeatmapIndicatorDescriptorBuilder.Histogram	(	string	visualId,
		string?	label = null,
		HeatmapIndicatorVisualStyle?	defaultStyle = null,
		HeatmapIndicatorVisualPresentation?	defaultPresentation = null
	)

LevelLine()

HeatmapIndicatorVisualHandle ATAS.Indicators.Heatmap.HeatmapIndicatorDescriptorBuilder.LevelLine	(	string	visualId,
		string?	label = null,
		HeatmapIndicatorVisualStyle?	defaultStyle = null
	)

PriceLine()

HeatmapIndicatorVisualHandle ATAS.Indicators.Heatmap.HeatmapIndicatorDescriptorBuilder.PriceLine	(	string	visualId,
		string?	label = null,
		HeatmapIndicatorVisualStyle?	defaultStyle = null
	)

SubPanelPair()

HeatmapIndicatorVisualHandle ATAS.Indicators.Heatmap.HeatmapIndicatorDescriptorBuilder.SubPanelPair	(	string	visualId,
		string?	label = null,
		HeatmapIndicatorVisualStyle?	defaultStyle = null,
		HeatmapIndicatorVisualPresentation?	defaultPresentation = null
	)

SubPanelScalar()

HeatmapIndicatorVisualHandle ATAS.Indicators.Heatmap.HeatmapIndicatorDescriptorBuilder.SubPanelScalar	(	string	visualId,
		string?	label = null,
		HeatmapIndicatorVisualStyle?	defaultStyle = null,
		HeatmapIndicatorVisualPresentation?	defaultPresentation = null
	)

ValueArea()

HeatmapIndicatorVisualHandle ATAS.Indicators.Heatmap.HeatmapIndicatorDescriptorBuilder.ValueArea	(	string	visualId,
		string?	label = null,
		HeatmapIndicatorVisualStyle?	defaultStyle = null
	)

Visual()

HeatmapIndicatorVisualHandle ATAS.Indicators.Heatmap.HeatmapIndicatorDescriptorBuilder.Visual	(	string	visualId,
		HeatmapIndicatorVisualKind	kind,
		string?	label = null,
		HeatmapIndicatorVisualStyle?	defaultStyle = null,
		HeatmapIndicatorVisualPresentation?	defaultPresentation = null
	)

Add a visual of any kind. The kind-specific helpers (PriceLine, SubPanelScalar, …) are usually clearer; reach for this one when the kind is computed at runtime.

---

The documentation for this class was generated from the following file:

• HeatmapIndicatorDescriptorBuilder.cs