Class HeatmapIndicatorVisualStyle

Namespace

OFT.Rendering.Heatmap

Assembly

OFT.Rendering.dll

Per-visual / per-series renderer hints. Every nullable knob means "renderer chooses default"; specify a value only to override.

Visibility is host-owned and lives on HeatmapIndicatorInstanceSettings.IsVisible — a hidden instance is dropped by the controller before this style is ever inspected, so a per-style visibility flag would be dead weight here.

TextColor is the colour of the text drawn over the visual (the price badge at the cutoff of a level line). null means "Auto": the renderer picks black or white for contrast with the badge colour.

Added in ATAS 8.0.15.

public sealed record HeatmapIndicatorVisualStyle

Inheritance

object

HeatmapIndicatorVisualStyle

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

HeatmapIndicatorVisualStyle(string?, string?, float?, int, string?, string?, string?, string?, bool?, HeatmapIndicatorColorScheme?)

Per-visual / per-series renderer hints. Every nullable knob means "renderer chooses default"; specify a value only to override.

Visibility is host-owned and lives on HeatmapIndicatorInstanceSettings.IsVisible — a hidden instance is dropped by the controller before this style is ever inspected, so a per-style visibility flag would be dead weight here.

TextColor is the colour of the text drawn over the visual (the price badge at the cutoff of a level line). null means "Auto": the renderer picks black or white for contrast with the badge colour.

Not in ATAS 8.0.15 yet: available from the next version.

public HeatmapIndicatorVisualStyle(string? Color = null, string? TextColor = null, float? Thickness = null, int ZIndex = 0, string? Label = null, string? VisibilityGroup = null, string? LineType = null, string? LineDashStyle = null, bool? ShowPrice = null, HeatmapIndicatorColorScheme? ColorScheme = null)

Parameters

Color string

The colour of the visual as a hex string (for example #2196F3); white when not set.

TextColor string

The colour of the text drawn over the visual; null is Auto (black or white for contrast).

Thickness float?

The line width in device-independent pixels; the renderer's default when not set.

ZIndex int

The drawing order among the visuals; not used by the renderer yet.

Label string

The label of the visual in its price badge and tooltip; the visual's own label when not set.

VisibilityGroup string

A group name for visuals shown and hidden together; not used by the renderer yet.

LineType string

How far a level line extends: Full across the whole heatmap, otherwise to the cutoff.

LineDashStyle string

The dash pattern of a line: Dash, Dot, DashDot, DashDotDot; solid otherwise.

ShowPrice bool?

Whether a level line shows its price badge at the cutoff; shown unless false.

ColorScheme HeatmapIndicatorColorScheme

The colours of a multi-colour visual; single-colour visuals use Color.

Properties

Color

The colour of the visual as a hex string (for example #2196F3); white when not set.

public string? Color { get; init; }

Property Value

string

ColorScheme

The colours of a multi-colour visual; single-colour visuals use Color.

public HeatmapIndicatorColorScheme? ColorScheme { get; init; }

Property Value

HeatmapIndicatorColorScheme

Label

The label of the visual in its price badge and tooltip; the visual's own label when not set.

public string? Label { get; init; }

Property Value

string

LineDashStyle

The dash pattern of a line: Dash, Dot, DashDot, DashDotDot; solid otherwise.

public string? LineDashStyle { get; init; }

Property Value

string

LineType

How far a level line extends: Full across the whole heatmap, otherwise to the cutoff.

public string? LineType { get; init; }

Property Value

string

ShowPrice

Whether a level line shows its price badge at the cutoff; shown unless false.

public bool? ShowPrice { get; init; }

Property Value

bool?

TextColor

The colour of the text drawn over the visual; null is Auto (black or white for contrast).

        <p>Not in ATAS 8.0.15 yet: available from the next version.</p>

public string? TextColor { get; init; }

Property Value

string

Thickness

The line width in device-independent pixels; the renderer's default when not set.

public float? Thickness { get; init; }

Property Value

float?

VisibilityGroup

A group name for visuals shown and hidden together; not used by the renderer yet.

public string? VisibilityGroup { get; init; }

Property Value

string

ZIndex

The drawing order among the visuals; not used by the renderer yet.

public int ZIndex { get; init; }

Property Value

int

Methods

Deconstruct(out string?, out string?, out float?, out int, out string?, out string?, out string?, out string?, out bool?, out HeatmapIndicatorColorScheme?)

public void Deconstruct(out string? Color, out string? TextColor, out float? Thickness, out int ZIndex, out string? Label, out string? VisibilityGroup, out string? LineType, out string? LineDashStyle, out bool? ShowPrice, out HeatmapIndicatorColorScheme? ColorScheme)

Parameters

Color string

TextColor string

Thickness float?

ZIndex int

Label string

VisibilityGroup string

LineType string

LineDashStyle string

ShowPrice bool?

ColorScheme HeatmapIndicatorColorScheme

Equals(HeatmapIndicatorVisualStyle?)

public bool Equals(HeatmapIndicatorVisualStyle? other)

Parameters

other HeatmapIndicatorVisualStyle

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

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

Parameters

left HeatmapIndicatorVisualStyle

right HeatmapIndicatorVisualStyle

Returns

bool

operator !=(HeatmapIndicatorVisualStyle?, HeatmapIndicatorVisualStyle?)

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

Parameters

left HeatmapIndicatorVisualStyle

right HeatmapIndicatorVisualStyle

Returns

bool