Class HeatmapIndicatorDescriptor

Namespace

OFT.Rendering.Heatmap

Assembly

OFT.Rendering.dll

The static description of a heatmap indicator: its identifier, label and visuals. Built once per indicator type, usually with HeatmapIndicatorDescriptorBuilder (ATAS.Indicators), and shared by all its instances.

Added in ATAS 8.0.15.

public sealed record HeatmapIndicatorDescriptor

Inheritance

object

HeatmapIndicatorDescriptor

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

HeatmapIndicatorDescriptor(string, string?, IReadOnlyList<HeatmapIndicatorVisualDescriptor>)

The static description of a heatmap indicator: its identifier, label and visuals. Built once per indicator type, usually with HeatmapIndicatorDescriptorBuilder (ATAS.Indicators), and shared by all its instances.

public HeatmapIndicatorDescriptor(string IndicatorId, string? Label, IReadOnlyList<HeatmapIndicatorVisualDescriptor> Visuals)

Parameters

IndicatorId string

The identifier of the indicator type; Describe<TSelf>() takes it from the TypeId of the [HeatmapIndicator] attribute.

Label string

The display name of the indicator, shown in the list of active indicators over the heatmap; the type identifier is shown when it is null or blank.

Visuals IReadOnlyList<HeatmapIndicatorVisualDescriptor>

The visuals of the indicator, each with a VisualId unique within the descriptor.

Properties

Identity

Builder-issued identity. Set when the descriptor was built via the fluent HeatmapIndicatorDescriptorBuilder; the state builder uses this to cross-check supplied visual / series handles. Default value (no token) for descriptors built via the record literal — those descriptors do not get the cross-check, but they also cannot mint handles, so misuse is impossible.

public HeatmapIndicatorDescriptorIdentity Identity { get; init; }

Property Value

HeatmapIndicatorDescriptorIdentity

IndicatorId

The identifier of the indicator type; Describe<TSelf>() takes it from the TypeId of the [HeatmapIndicator] attribute.

public string IndicatorId { get; init; }

Property Value

string

Label

The display name of the indicator, shown in the list of active indicators over the heatmap; the type identifier is shown when it is null or blank.

public string? Label { get; init; }

Property Value

string

Visuals

The visuals of the indicator, each with a VisualId unique within the descriptor.

public IReadOnlyList<HeatmapIndicatorVisualDescriptor> Visuals { get; init; }

Property Value

IReadOnlyList<HeatmapIndicatorVisualDescriptor>

Methods

Deconstruct(out string, out string?, out IReadOnlyList<HeatmapIndicatorVisualDescriptor>)

public void Deconstruct(out string IndicatorId, out string? Label, out IReadOnlyList<HeatmapIndicatorVisualDescriptor> Visuals)

Parameters

IndicatorId string

Label string

Visuals IReadOnlyList<HeatmapIndicatorVisualDescriptor>

Equals(HeatmapIndicatorDescriptor?)

public bool Equals(HeatmapIndicatorDescriptor? other)

Parameters

other HeatmapIndicatorDescriptor

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 ==(HeatmapIndicatorDescriptor?, HeatmapIndicatorDescriptor?)

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

Parameters

left HeatmapIndicatorDescriptor

right HeatmapIndicatorDescriptor

Returns

bool

operator !=(HeatmapIndicatorDescriptor?, HeatmapIndicatorDescriptor?)

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

Parameters

left HeatmapIndicatorDescriptor

right HeatmapIndicatorDescriptor

Returns

bool