Skip to content

OutputAttribute.Description

property · OutputAttribute · cAlgo.API Since 5.4

DesktopCLICloud

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

Definition

public string Description {get; set;}

outputAttribute.Description: str

Returns string

Examples

public partial class OutputSample : Indicator
{
    public override void Calculate(int index)
    {
        Result[index] = Bars.ClosePrices[index];
    }
}

def calculate(self, index):
    api.Result[index] = api.Bars.ClosePrices[index]

{
  "AccessRights": "None",
  "IsOverlay": true,
  "LineOutputs": [
    {
      "Name": "Result",
      "DisplayName": "Main",
      "Description": "Close price of each bar"
    }
  ]
}