Class HeatmapIndicatorVisualDescriptor

Namespace

OFT.Rendering.Heatmap

Assembly

OFT.Rendering.dll

The static description of one visual of a heatmap indicator: what kind of drawing it is and which series feed it.

Added in ATAS 8.0.15.

public sealed record HeatmapIndicatorVisualDescriptor

Inheritance

object

HeatmapIndicatorVisualDescriptor

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

HeatmapIndicatorVisualDescriptor(string, HeatmapIndicatorVisualKind, string?, IReadOnlyList<HeatmapIndicatorSeriesDescriptor>, HeatmapIndicatorVisualStyle?, HeatmapIndicatorVisualPresentation?, string?)

The static description of one visual of a heatmap indicator: what kind of drawing it is and which series feed it.

public HeatmapIndicatorVisualDescriptor(string VisualId, HeatmapIndicatorVisualKind Kind, string? Label, IReadOnlyList<HeatmapIndicatorSeriesDescriptor> Series, HeatmapIndicatorVisualStyle? DefaultStyle = null, HeatmapIndicatorVisualPresentation? DefaultPresentation = null, string? RendererId = null)

Parameters

VisualId string

The identifier of the visual, unique within the descriptor.

Kind HeatmapIndicatorVisualKind

The kind of the visual, which selects the built-in drawing.

Label string

The display label of the visual, used in its price badges, tooltips and sub-panel header; Label overrides it, and the renderer uses a default text when neither is set.

Series IReadOnlyList<HeatmapIndicatorSeriesDescriptor>

The series of the visual.

DefaultStyle HeatmapIndicatorVisualStyle

The style the visual has until the indicator sets another one under a lease; null leaves the renderer defaults.

DefaultPresentation HeatmapIndicatorVisualPresentation

The renderer hints the visual has until the indicator sets other ones under a lease; null leaves the renderer defaults.

RendererId string

The identifier of a custom renderer that draws the visual instead of the built-in drawing of its Kind; null for the built-in drawing. Custom renderers are registered by the platform: a visual whose identifier names no registered renderer is not drawn. A Histogram visual is drawn only by a custom renderer.

Properties

DefaultPresentation

The renderer hints the visual has until the indicator sets other ones under a lease; null leaves the renderer defaults.

public HeatmapIndicatorVisualPresentation? DefaultPresentation { get; init; }

Property Value

HeatmapIndicatorVisualPresentation

DefaultStyle

The style the visual has until the indicator sets another one under a lease; null leaves the renderer defaults.

public HeatmapIndicatorVisualStyle? DefaultStyle { get; init; }

Property Value

HeatmapIndicatorVisualStyle

Kind

The kind of the visual, which selects the built-in drawing.

public HeatmapIndicatorVisualKind Kind { get; init; }

Property Value

HeatmapIndicatorVisualKind

Label

The display label of the visual, used in its price badges, tooltips and sub-panel header; Label overrides it, and the renderer uses a default text when neither is set.

public string? Label { get; init; }

Property Value

string

RendererId

The identifier of a custom renderer that draws the visual instead of the built-in drawing of its Kind; null for the built-in drawing. Custom renderers are registered by the platform: a visual whose identifier names no registered renderer is not drawn. A Histogram visual is drawn only by a custom renderer.

public string? RendererId { get; init; }

Property Value

string

Series

The series of the visual.

public IReadOnlyList<HeatmapIndicatorSeriesDescriptor> Series { get; init; }

Property Value

IReadOnlyList<HeatmapIndicatorSeriesDescriptor>

VisualId

The identifier of the visual, unique within the descriptor.

public string VisualId { get; init; }

Property Value

string

Methods

Deconstruct(out string, out HeatmapIndicatorVisualKind, out string?, out IReadOnlyList<HeatmapIndicatorSeriesDescriptor>, out HeatmapIndicatorVisualStyle?, out HeatmapIndicatorVisualPresentation?, out string?)

public void Deconstruct(out string VisualId, out HeatmapIndicatorVisualKind Kind, out string? Label, out IReadOnlyList<HeatmapIndicatorSeriesDescriptor> Series, out HeatmapIndicatorVisualStyle? DefaultStyle, out HeatmapIndicatorVisualPresentation? DefaultPresentation, out string? RendererId)

Parameters

VisualId string

Kind HeatmapIndicatorVisualKind

Label string

Series IReadOnlyList<HeatmapIndicatorSeriesDescriptor>

DefaultStyle HeatmapIndicatorVisualStyle

DefaultPresentation HeatmapIndicatorVisualPresentation

RendererId string

Equals(HeatmapIndicatorVisualDescriptor?)

public bool Equals(HeatmapIndicatorVisualDescriptor? other)

Parameters

other HeatmapIndicatorVisualDescriptor

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

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

Parameters

left HeatmapIndicatorVisualDescriptor

right HeatmapIndicatorVisualDescriptor

Returns

bool

operator !=(HeatmapIndicatorVisualDescriptor?, HeatmapIndicatorVisualDescriptor?)

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

Parameters

left HeatmapIndicatorVisualDescriptor

right HeatmapIndicatorVisualDescriptor

Returns

bool