Table of Contents

Class ClusterSearch

Namespace
ATAS.Indicators.Technical
Assembly
ATAS.Indicators.Technical.dll
[Display(ResourceType = typeof(Strings), Description = "ClusterSearchDescription")]
[HelpLink("https://help.atas.net/support/solutions/articles/72000602240")]
public class ClusterSearch : Indicator, INotifyPanelPropertyChanged, IPropertiesEditorOwner, IMarketTimeProvider
Inheritance
object
ClusterSearch
Implements
Inherited Members
Extension Methods

Constructors

ClusterSearch() 

public ClusterSearch()

Properties

AlertColor 

[Display(ResourceType = typeof(Strings), GroupName = "Alerts", Name = "BackGround", Order = 740, Description = "AlertBackgroundDescription")]
[Tab(TabName = "Alerts", TabOrder = 2, ResourceType = typeof(Strings))]
public Color AlertColor { get; set; }

Property Value

Color

AlertFile 

[Display(ResourceType = typeof(Strings), GroupName = "Alerts", Name = "AlertFile", Order = 720, Description = "AlertFileDescription")]
[Tab(TabName = "Alerts", TabOrder = 2, ResourceType = typeof(Strings))]
public string AlertFile { get; set; }

Property Value

string

AutoFilter 

[Display(ResourceType = typeof(Strings), GroupName = "Filters", Name = "AutoFilter", Description = "ClusterSearchAutofilterDescription", Order = 215)]
[Tab(TabName = "Data", TabOrder = 0, ResourceType = typeof(Strings))]
public bool AutoFilter { get; set; }

Property Value

bool

BarsRange 

[Display(ResourceType = typeof(Strings), GroupName = "LocationFilters", Name = "BarsRange", Order = 410, Description = "BarsRangeDescription")]
[Tab(TabName = "Data", TabOrder = 0, ResourceType = typeof(Strings))]
[Range(1, 10000)]
public int BarsRange { get; set; }

Property Value

int

CalcType 

[Display(ResourceType = typeof(Strings), GroupName = "Filters", Name = "CalculationMode", Description = "CalculationModeDescription", Order = 200)]
[Tab(TabName = "Data", TabOrder = 0, ResourceType = typeof(Strings))]
public ClusterSearch.CalcMode CalcType { get; set; }

Property Value

ClusterSearch.CalcMode

CandleDir 

[Display(ResourceType = typeof(Strings), GroupName = "LocationFilters", Name = "CandleDirection", Description = "CandleDirectionDescription", Order = 400)]
[Tab(TabName = "Data", TabOrder = 0, ResourceType = typeof(Strings))]
public ClusterSearch.CandleDirection CandleDir { get; set; }

Property Value

ClusterSearch.CandleDirection

ClusterColor 

[Display(ResourceType = typeof(Strings), GroupName = "Visualization", Name = "ObjectsColor", Order = 605, Description = "VisualObjectsDescription")]
[Tab(TabName = "Visualization", TabOrder = 1, ResourceType = typeof(Strings))]
public Color ClusterColor { get; set; }

Property Value

Color

Days 

[Range(0, 2147483647)]
[Display(ResourceType = typeof(Strings), GroupName = "Calculation", Name = "DaysLookBack", Order = 2147483647, Description = "DaysLookBackDescription")]
[Tab(TabName = "Data", TabOrder = 0, ResourceType = typeof(Strings))]
public int Days { get; set; }

Property Value

int

DeltaFilter 

[Browsable(false)]
public decimal DeltaFilter { get; set; }

Property Value

decimal

DeltaFilterMoney 

[Browsable(false)]
public string? DeltaFilterMoney { get; set; }

Property Value

string

DeltaImbalance 

[Display(ResourceType = typeof(Strings), GroupName = "DeltaFilters", Name = "DeltaImbalance", Order = 300, Description = "DeltaImbalanceDescription")]
[Tab(TabName = "Data", TabOrder = 0, ResourceType = typeof(Strings))]
[Range(-100, 100)]
public decimal DeltaImbalance { get; set; }

Property Value

decimal

DeltaVolumeFilter

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

[Display(ResourceType = typeof(Strings), GroupName = "DeltaFilters", Name = "DeltaFilter", Order = 310, Description = "DeltaFilterDescription")]
[Tab(TabName = "Data", TabOrder = 0, ResourceType = typeof(Strings))]
public VolumeFilter DeltaVolumeFilter { get; set; }

Property Value

VolumeFilter

FixedSizes 

[Display(ResourceType = typeof(Strings), GroupName = "Visualization", Name = "FixedSizes", Order = 640, Description = "FixedSizesDescription")]
[Tab(TabName = "Visualization", TabOrder = 1, ResourceType = typeof(Strings))]
public bool FixedSizes { get; set; }

Property Value

bool

MaxAverageTrade 

[Browsable(false)]
[Range(0, 10000000)]
public decimal MaxAverageTrade { get; set; }

Property Value

decimal

MaxAverageTradeFilter 

[Display(ResourceType = typeof(Strings), GroupName = "Filters", Name = "MaximumAverageTrade", Order = 480, Description = "MaxAvgTradeDescription")]
[Tab(TabName = "Data", TabOrder = 0, ResourceType = typeof(Strings))]
public VolumeFilter MaxAverageTradeFilter { get; set; }

Property Value

VolumeFilter

MaxAverageTradeMoney 

[Browsable(false)]
public string? MaxAverageTradeMoney { get; set; }

Property Value

string

MaxCandleBodyHeight 

[Range(1, 2147483647)]
[Display(ResourceType = typeof(Strings), Name = "MaximumCandleBodyHeight", GroupName = "CandleHeight", Order = 471, Description = "MaxCandleBodyHeightDescription")]
[Tab(TabName = "Data", TabOrder = 0, ResourceType = typeof(Strings))]
public FilterInt MaxCandleBodyHeight { get; set; }

Property Value

FilterInt

MaxCandleHeight 

[Range(1, 2147483647)]
[Display(ResourceType = typeof(Strings), Name = "MaximumCandleHeight", GroupName = "CandleHeight", Order = 461, Description = "MaxCandleHeightDescription")]
[Tab(TabName = "Data", TabOrder = 0, ResourceType = typeof(Strings))]
public FilterInt MaxCandleHeight { get; set; }

Property Value

FilterInt

MaxPercent 

[Display(ResourceType = typeof(Strings), GroupName = "Filters", Name = "MaxVolumePercent", Order = 492, Description = "MaxPercentDescription")]
[Tab(TabName = "Data", TabOrder = 0, ResourceType = typeof(Strings))]
[Range(0, 100)]
public decimal MaxPercent { get; set; }

Property Value

decimal

MaxSize 

[Range(1, 2147483647)]
[Display(ResourceType = typeof(Strings), GroupName = "Visualization", Name = "MaximumSize", Order = 670, Description = "MaximumSizeDescription")]
[Tab(TabName = "Visualization", TabOrder = 1, ResourceType = typeof(Strings))]
public int MaxSize { get; set; }

Property Value

int

MaximumFilter 

[Display(ResourceType = typeof(Strings), GroupName = "Filters", Description = "MaximumFilterDescription", Name = "MaxValue", Order = 230)]
[Tab(TabName = "Data", TabOrder = 0, ResourceType = typeof(Strings))]
public VolumeFilter MaximumFilter { get; set; }

Property Value

VolumeFilter

MinAverageTrade 

[Browsable(false)]
[Range(0, 10000000)]
public decimal MinAverageTrade { get; set; }

Property Value

decimal

MinAverageTradeFilter

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

[Display(ResourceType = typeof(Strings), GroupName = "Filters", Name = "MinimumAverageTrade", Order = 470, Description = "MinAvgTradeDescription")]
[Tab(TabName = "Data", TabOrder = 0, ResourceType = typeof(Strings))]
public VolumeFilter MinAverageTradeFilter { get; set; }

Property Value

VolumeFilter

MinAverageTradeMoney

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

[Browsable(false)]
public string? MinAverageTradeMoney { get; set; }

Property Value

string

MinCandleBodyHeight 

[Range(1, 2147483647)]
[Display(ResourceType = typeof(Strings), Name = "MinimumCandleBodyHeight", GroupName = "CandleHeight", Order = 470, Description = "MinCandleBodyHeightDescription")]
[Tab(TabName = "Data", TabOrder = 0, ResourceType = typeof(Strings))]
public FilterInt MinCandleBodyHeight { get; set; }

Property Value

FilterInt

MinCandleHeight 

[Range(1, 2147483647)]
[Display(ResourceType = typeof(Strings), Name = "MinimumCandleHeight", GroupName = "CandleHeight", Order = 460, Description = "MinCandleHeightDescription")]
[Tab(TabName = "Data", TabOrder = 0, ResourceType = typeof(Strings))]
public FilterInt MinCandleHeight { get; set; }

Property Value

FilterInt

MinPercent 

[Display(ResourceType = typeof(Strings), GroupName = "Filters", Name = "MinVolumePercent", Order = 490, Description = "MinPercentDescription")]
[Tab(TabName = "Data", TabOrder = 0, ResourceType = typeof(Strings))]
[Range(0, 100)]
public decimal MinPercent { get; set; }

Property Value

decimal

MinSize 

[Range(1, 2147483647)]
[Display(ResourceType = typeof(Strings), GroupName = "Visualization", Name = "MinimumSize", Order = 660, Description = "MinimumSizeDescription")]
[Tab(TabName = "Visualization", TabOrder = 1, ResourceType = typeof(Strings))]
public int MinSize { get; set; }

Property Value

int

MinimumFilter 

[Display(ResourceType = typeof(Strings), GroupName = "Filters", Description = "MinimumFilterDescription", Name = "MinValue", Order = 220)]
[Tab(TabName = "Data", TabOrder = 0, ResourceType = typeof(Strings))]
public VolumeFilter MinimumFilter { get; set; }

Property Value

VolumeFilter

OnlyOneSelectionPerBar 

[Display(ResourceType = typeof(Strings), GroupName = "Visualization", Name = "OnlyOneSelectionPerBar", Order = 590, Description = "OneSelectionPerBarDescription")]
[Tab(TabName = "Visualization", TabOrder = 1, ResourceType = typeof(Strings))]
public bool OnlyOneSelectionPerBar { get; set; }

Property Value

bool

PipsFromHigh 

[Range(1, 2147483647)]
[Display(ResourceType = typeof(Strings), GroupName = "LocationFilters", Name = "PipsFromHigh", Order = 430, Description = "PipsFromHighDescription")]
[Tab(TabName = "Data", TabOrder = 0, ResourceType = typeof(Strings))]
public Filter PipsFromHigh { get; set; }

Property Value

Filter

PipsFromLow 

[Range(1, 2147483647)]
[Display(ResourceType = typeof(Strings), GroupName = "LocationFilters", Name = "PipsFromLow", Order = 440, Description = "PipsFromLowDescription")]
[Tab(TabName = "Data", TabOrder = 0, ResourceType = typeof(Strings))]
public Filter PipsFromLow { get; set; }

Property Value

Filter

PriceLoc 

[Display(ResourceType = typeof(Strings), GroupName = "LocationFilters", Name = "PriceLocation", Order = 450, Description = "PriceLocationDescription")]
[Tab(TabName = "Data", TabOrder = 0, ResourceType = typeof(Strings))]
public ClusterSearch.PriceLocation PriceLoc { get; set; }

Property Value

ClusterSearch.PriceLocation

PriceRange 

[Display(ResourceType = typeof(Strings), GroupName = "LocationFilters", Name = "PriceRange", Order = 420, Description = "PriceRangeDescription")]
[Tab(TabName = "Data", TabOrder = 0, ResourceType = typeof(Strings))]
[Range(1, 100000)]
public int PriceRange { get; set; }

Property Value

int

PriceSelectionColor 

[Display(ResourceType = typeof(Strings), GroupName = "Visualization", Name = "PriceSelectionColor", Order = 620, Description = "PriceSelectionColorDescription")]
[Tab(TabName = "Visualization", TabOrder = 1, ResourceType = typeof(Strings))]
public Color PriceSelectionColor { get; set; }

Property Value

Color

ShowPriceSelection 

[Display(ResourceType = typeof(Strings), GroupName = "Visualization", Name = "ShowPriceSelection", Order = 615, Description = "ShowPriceSelectionDescription")]
[Tab(TabName = "Visualization", TabOrder = 1, ResourceType = typeof(Strings))]
public bool ShowPriceSelection { get; set; }

Property Value

bool

Size 

[Range(1, 2147483647)]
[Display(ResourceType = typeof(Strings), GroupName = "Visualization", Name = "Size", Order = 650, Description = "SizeDescription")]
[Tab(TabName = "Visualization", TabOrder = 1, ResourceType = typeof(Strings))]
public int Size { get; set; }

Property Value

int

TimeFrom 

[Display(ResourceType = typeof(Strings), GroupName = "TimeFiltration", Name = "TimeFrom", Order = 510, Description = "TimeFromDescription")]
[Tab(TabName = "Data", TabOrder = 0, ResourceType = typeof(Strings))]
public TimeSpan TimeFrom { get; set; }

Property Value

TimeSpan

TimeTo 

[Display(ResourceType = typeof(Strings), GroupName = "TimeFiltration", Name = "TimeTo", Order = 520, Description = "TimeToDescription")]
[Tab(TabName = "Data", TabOrder = 0, ResourceType = typeof(Strings))]
public TimeSpan TimeTo { get; set; }

Property Value

TimeSpan

Transparency 

[Browsable(false)]
[Display(ResourceType = typeof(Strings), GroupName = "Visualization", Name = "ClusterSelectionTransparency", Order = 625, Description = "PriceSelectionTransparencyDescription")]
[Range(0, 100)]
public int Transparency { get; set; }

Property Value

int

Type 

[Browsable(false)]
[Obsolete]
public DynamicLevels.MiddleClusterType Type { get; set; }

Property Value

DynamicLevels.MiddleClusterType

UseAlerts 

[Display(ResourceType = typeof(Strings), GroupName = "Alerts", Name = "UseAlerts", Order = 700, Description = "UseAlertDescription")]
[Tab(TabName = "Alerts", TabOrder = 2, ResourceType = typeof(Strings))]
public bool UseAlerts { get; set; }

Property Value

bool

UsePrevClose 

[Display(ResourceType = typeof(Strings), GroupName = "Calculation", Name = "UsePreviousClose", Order = 800, Description = "CalculateOnBarCloseDescription")]
[Tab(TabName = "Data", TabOrder = 0, ResourceType = typeof(Strings))]
public bool UsePrevClose { get; set; }

Property Value

bool

UseTimeFilter 

[Display(ResourceType = typeof(Strings), GroupName = "TimeFiltration", Name = "UseTimeFilter", Order = 500, Description = "UseTimeFilterDescription")]
[Tab(TabName = "Data", TabOrder = 0, ResourceType = typeof(Strings))]
public bool UseTimeFilter { get; set; }

Property Value

bool

VisualObjectsTransparency 

[Display(ResourceType = typeof(Strings), GroupName = "Visualization", Name = "VisualObjectsTransparency", Order = 610, Description = "VisualObjectsTransparencyDescription")]
[Tab(TabName = "Visualization", TabOrder = 1, ResourceType = typeof(Strings))]
[Range(0, 100)]
public int VisualObjectsTransparency { get; set; }

Property Value

int

VisualType 

[Display(ResourceType = typeof(Strings), GroupName = "Visualization", Name = "VisualMode", Order = 600, Description = "VisualModeDescription")]
[Tab(TabName = "Visualization", TabOrder = 1, ResourceType = typeof(Strings))]
public ObjectType VisualType { get; set; }

Property Value

ObjectType

Methods

OnCalculate(int, decimal)

The main indicator calculation method is called for each bar on the history, then it is called on each tick.

protected override void OnCalculate(int bar, decimal value)

Parameters

bar int

Bar number.

value decimal

Input data series value.

OnFinishRecalculate()

The method is executed after the end of the calculation.

protected override void OnFinishRecalculate()

OnInitialize()

The method is executed before the first calculation.

protected override void OnInitialize()

OnNewTrades(IEnumerable<MarketDataArg>)

Handles a collection of new trade data represented by MarketDataArg objects.

protected override void OnNewTrades(IEnumerable<MarketDataArg> trades)

Parameters

trades IEnumerable<MarketDataArg>

An IEnumerable of MarketDataArg representing the new trade data.

OnRecalculate()

The method is executed before a new calculation.

protected override void OnRecalculate()

OnValuationChanged()

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

protected override void OnValuationChanged()