Class HeatmapIndicatorSeriesDescriptor

Namespace

OFT.Rendering.Heatmap

Assembly

OFT.Rendering.dll

Static description of a single series within an indicator visual.

Added in ATAS 8.0.15.

public sealed record HeatmapIndicatorSeriesDescriptor

Inheritance

object

HeatmapIndicatorSeriesDescriptor

Extension Methods

Extensions.ConvertToMyTrade<T>(T, Portfolio, Security, Action<MyTrade, T>)

LoggerHelper.DisposeLogger(object)

LoggerHelper.LogDebug(object, string, params object?[])

LoggerHelper.LogError(object, string, Exception, bool)

LoggerHelper.LogError(object, string, params object?[])

LoggerHelper.LogFatal(object, string, Exception, bool)

LoggerHelper.LogInfo(object, string, params object?[])

LoggerHelper.LogWarn(object, string, params object?[])

Constructors

HeatmapIndicatorSeriesDescriptor(string, HeatmapIndicatorSeriesRole, HeatmapIndicatorValueKind, HeatmapIndicatorVisualStyle?, string?, string?)

Static description of a single series within an indicator visual.

public HeatmapIndicatorSeriesDescriptor(string SeriesId, HeatmapIndicatorSeriesRole Role, HeatmapIndicatorValueKind ValueKind, HeatmapIndicatorVisualStyle? DefaultStyle = null, string? MetricId = null, string? Unit = null)

Parameters

SeriesId string

Stable identifier within the visual (e.g. "vwap.price").

Role HeatmapIndicatorSeriesRole

Coarse semantic role used by renderers (Buy/Sell/Scalar/Price/...).

ValueKind HeatmapIndicatorValueKind

Domain of Value.

DefaultStyle HeatmapIndicatorVisualStyle

Default visual style; can be overridden per snapshot.

MetricId string

Optional unique semantic identifier of the metric (e.g. cvd.value). Role only categorises generically; MetricId is the unique handle to a specific metric.

Unit string

Optional human-readable unit displayed in tooltips.

Properties

DefaultStyle

Default visual style; can be overridden per snapshot.

public HeatmapIndicatorVisualStyle? DefaultStyle { get; init; }

Property Value

HeatmapIndicatorVisualStyle

MetricId

Optional unique semantic identifier of the metric (e.g. cvd.value). Role only categorises generically; MetricId is the unique handle to a specific metric.

public string? MetricId { get; init; }

Property Value

string

Role

Coarse semantic role used by renderers (Buy/Sell/Scalar/Price/...).

public HeatmapIndicatorSeriesRole Role { get; init; }

Property Value

HeatmapIndicatorSeriesRole

SeriesId

Stable identifier within the visual (e.g. "vwap.price").

public string SeriesId { get; init; }

Property Value

string

Unit

Optional human-readable unit displayed in tooltips.

public string? Unit { get; init; }

Property Value

string

ValueKind

Domain of Value.

public HeatmapIndicatorValueKind ValueKind { get; init; }

Property Value

HeatmapIndicatorValueKind

Methods

Deconstruct(out string, out HeatmapIndicatorSeriesRole, out HeatmapIndicatorValueKind, out HeatmapIndicatorVisualStyle?, out string?, out string?)

public void Deconstruct(out string SeriesId, out HeatmapIndicatorSeriesRole Role, out HeatmapIndicatorValueKind ValueKind, out HeatmapIndicatorVisualStyle? DefaultStyle, out string? MetricId, out string? Unit)

Parameters

SeriesId string

Role HeatmapIndicatorSeriesRole

ValueKind HeatmapIndicatorValueKind

DefaultStyle HeatmapIndicatorVisualStyle

MetricId string

Unit string

Equals(HeatmapIndicatorSeriesDescriptor?)

public bool Equals(HeatmapIndicatorSeriesDescriptor? other)

Parameters

other HeatmapIndicatorSeriesDescriptor

Returns

bool

Equals(object?)

public override bool Equals(object? obj)

Parameters

obj object

Returns

bool

GetHashCode()

public override int GetHashCode()

Returns

int

ToString()

public override string ToString()

Returns

string

Operators

operator ==(HeatmapIndicatorSeriesDescriptor?, HeatmapIndicatorSeriesDescriptor?)

public static bool operator ==(HeatmapIndicatorSeriesDescriptor? left, HeatmapIndicatorSeriesDescriptor? right)

Parameters

left HeatmapIndicatorSeriesDescriptor

right HeatmapIndicatorSeriesDescriptor

Returns

bool

operator !=(HeatmapIndicatorSeriesDescriptor?, HeatmapIndicatorSeriesDescriptor?)

public static bool operator !=(HeatmapIndicatorSeriesDescriptor? left, HeatmapIndicatorSeriesDescriptor? right)

Parameters

left HeatmapIndicatorSeriesDescriptor

right HeatmapIndicatorSeriesDescriptor

Returns

bool