Skip to content

CustomTimeFrame.Description

property · CustomTimeFrame · cAlgo.API Since 5.3

DesktopCLICloud

Gets / sets custom time frame description.

Environment behaviour

CLI — not supported. Available to plugins only, and plugins cannot run in the CLI.

Cloud — not supported. Available to plugins only, and plugins cannot run in the cloud.

Definition

string Description {get; set;}

customTimeFrame.Description: str

Returns string

Examples

var customTimeFrame = TimeFrameManager.Custom.Add("My Custom TF");
customTimeFrame.Description = "Bars built from my data feed";
Print("Description: {0}", customTimeFrame.Description);

customTimeFrame = api.TimeFrameManager.Custom.Add("My Custom TF")
customTimeFrame.Description = "Bars built from my data feed"
api.Print(f"Description: {customTimeFrame.Description}")