Skip to content

OutputAttribute

Summary

This attribute is used for marking an indicator IndicatorDataSeries property as a line Output.

Remarks

Marks a IndicatorDataSeries property as output to be displayed on the chart or panel below. To make it effective please apply this attribute in front of the declaration of the IndicatorDataSeries to be displayed.

Signature 

1
public sealed class OutputAttribute : Attribute

Namespace

cAlgo.API

Examples

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
 using cAlgo.API;
 namespace cAlgo
 {
     // This sample shows how to use indicators OutputAttribute
     [Indicator(IsOverlay = false, TimeZone = TimeZones.UTC, AccessRights = AccessRights.None)]
     public class OutputAttributeSample : Indicator
     {
         [Output("Open", LineColor = "Red", LineStyle = LineStyle.Dots, PlotType = PlotType.Line, Thickness = 2)]
         public IndicatorDataSeries OpenOutput { get; set; }
         [Output("High", LineColor = "Blue", LineStyle = LineStyle.Solid, PlotType = PlotType.Line, Thickness = 2)]
         public IndicatorDataSeries HighOutput { get; set; }
         [Output("Low", LineColor = "Yellow", LineStyle = LineStyle.Lines, PlotType = PlotType.Line, Thickness = 2)]
         public IndicatorDataSeries LowOutput { get; set; }
         [Output("Close", LineColor = "Green", LineStyle = LineStyle.DotsRare, PlotType = PlotType.Line, Thickness = 2)]
         public IndicatorDataSeries CloseOutput { get; set; }
         protected override void Initialize()
         {
         }
         public override void Calculate(int index)
         {
             OpenOutput[index] = Bars.OpenPrices[index];
             HighOutput[index] = Bars.HighPrices[index];
             LowOutput[index] = Bars.LowPrices[index];
             CloseOutput[index] = Bars.ClosePrices[index];
         }
     }
 }

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
 import clr
 clr.AddReference("cAlgo.API")
 from cAlgo.API import *
 # OpenOutput, HighOutput, LowOutput, and CloseOutput are outputs defined in C# file of indicator
 class Test():
     def calculate(self, index):
         api.OpenOutput[index] = api.Bars.OpenPrices[index]
         api.HighOutput[index] = api.Bars.HighPrices[index]
         api.LowOutput[index] = api.Bars.LowPrices[index]
         api.CloseOutput[index] = api.Bars.ClosePrices[index]

Properties

LineStyle

Summary

Gets or sets the Line Style for given Output property. By default it is set to Solid

Remarks

If PlotType = PlotType.Line (default) the LineStyle can be added.Supported line styles are:DotsDotsRareDotsVeryRareLinesLinesDotsSolid

Signature 

1
public LineStyle LineStyle {get; set;}

Return Value

LineStyle

Examples

1
2
3
4
5
 //...
 //Simple moving average will be now plotted as Lines.
 [Output("Simple Moving Average", LineStyle = LineStyle.Lines)]
 public IndicatorDataSeries SMA { get; set; }
 //...

Name

Summary

The plot name

Remarks

Displayed in the User Interface when adding an new instance of the Indicator.

Signature 

1
public string Name {get;}

Return Value

string

Examples

1
2
3
4
5
 //...
 //The plotted indicator name is Simple Moving Average.
 [Output("Simple Moving Average")]
 public IndicatorDataSeries SMA { get; set; }
 //...

LineColor

Summary

Gets or sets the Color of the Output property. This Color will be used when the line for this Output is plotted.

Signature 

1
public string LineColor {get; set;}

Return Value

string

Examples

1
2
3
4
5
6
7
8
 //...
 //The result is plotted in Turquoise.
 [Output("Main", LineColor = "#008000")]
 public IndicatorDataSeries SMA { get; set; }
 public override void Calculate(int index)
 {
    //...
 }

Thickness

Summary

Sets the Width of the Output property.

Remarks

This Width will be used when the line for this Output is plotted.

Signature 

1
public float Thickness {get; set;}

Return Value

float

Examples

1
2
3
4
5
6
7
8
 //...
 //The result is plotted as a line with thickness level five
 [Output("Simple Moving Average", Thickness = 5)]
 public IndicatorDataSeries SMA { get; set; }
 public override void Calculate(int index)
 {
     //...
 }

Related Tutorials

PlotType

Summary

Plot type.

Remarks

The type of the output plotted on the output panel. Default = LineSupported types are:LinePointsHistogram

Signature 

1
public PlotType PlotType {get; set;}

Return Value

PlotType

Examples

1
2
3
4
5
6
7
8
 //...
 //The result is plotted as a Histogram.
 [Output("Commodity Channel Index", PlotType = PlotType.Histogram)]
 public IndicatorDataSeries SMA { get; set; }
 public override void Calculate(int index)
 {
     //...
 }

1
2
3
4
5
 //...
 //Plot the result as a set of yellow points.
 [Output("Main", LineColor = "Yellow", PlotType = PlotType.Points)]
 public IndicatorDataSeries Result { get; set; }
 //...

IsColorCustomizable

Summary

Gets or sets if Output line color is customizable or not.

Remarks

This property is useful when you are setting color manually with code via SetLineAppearance method.

Signature 

1
public bool IsColorCustomizable {get; set;}

Return Value

bool

IsLastValueVisibleInTitle

Summary

Gets or sets if output last value should be visible or not in instance title (default: true).

Signature 

1
public bool IsLastValueVisibleInTitle {get; set;}

Return Value

bool

Description

Summary

Gets or sets description for output that will be shown in UI.

Signature 

1
public string Description {get; set;}

Return Value

string