Class HeatmapIndicatorAttribute

Namespace

ATAS.Indicators.Heatmap

Assembly

ATAS.Indicators.dll

Marks a class as a heatmap indicator type and supplies discovery metadata. Apply to a concrete class that derives from HeatmapIndicator<TSettings> (or implements IHeatmapIndicator directly).

Added in ATAS 8.0.15.

[AttributeUsage(AttributeTargets.Class, Inherited = false, AllowMultiple = false)]
public sealed class HeatmapIndicatorAttribute : Attribute

Inheritance

object

Attribute

HeatmapIndicatorAttribute

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

HeatmapIndicatorAttribute(string, string?)

Marks the class as a heatmap indicator with the given type identifier and optional display name.

public HeatmapIndicatorAttribute(string id, string? displayName = null)

Parameters

id string

Stable type identifier (TypeId) under which the platform saves the indicator in heatmap templates and workspaces, in the form <vendor>.<indicator-name>, for example mycompany.vwap-icebergs. The vendors heatmap and atas are reserved for the built-in indicators. Never change it for a released indicator.

displayName string

Display name of the indicator. In the indicator list a name resolved through ResourceType and DisplayNameKey takes precedence; when no such name resolves and this is null or empty, the class name is shown.

Properties

DescriptionKey

Localisation key for Description.

public string? DescriptionKey { get; init; }

Property Value

string

DisplayName

Localisable display name. If omitted, the class name is used.

public string? DisplayName { get; init; }

Property Value

string

DisplayNameKey

Localisation key for DisplayName when ResourceType is set.

public string? DisplayNameKey { get; init; }

Property Value

string

HelpLink

Optional documentation URL shown in the editor.

public string? HelpLink { get; init; }

Property Value

string

Id

Stable type identifier, e.g. "heatmap.ohlc-plus". Convention: "<vendor>.<indicator-name>" using lowercase-with-dots. Must be unique within all assemblies scanned by discovery.

public string Id { get; }

Property Value

string

ResourceType

Localisation resource type for DisplayName / Description.

public Type? ResourceType { get; init; }

Property Value

Type