Skip to content

ChartManager.GetChartFrame

method · ChartManager · cAlgo.API

DesktopCLICloud

Gets a chart frame by it is Id.

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

ChartFrame GetChartFrame(string frameId)
api.ChartManager.GetChartFrame(frameId: str) -> ChartFrame

Parameters

Name C# type Python type Description
frameId string str Frame Id

Returns ChartFrame — Returns matching chart frame.

Examples

var addedFrame = ChartManager.AddChartFrame("EURUSD", TimeFrame.Hour);
var chartFrame = ChartManager.GetChartFrame(addedFrame.Id);
if (chartFrame != null)
    Print("Found chart frame for {0}", chartFrame.Symbol.Name);
addedFrame = api.ChartManager.AddChartFrame("EURUSD", TimeFrame.Hour)
chartFrame = api.ChartManager.GetChartFrame(addedFrame.Id)
if chartFrame is not None:
    api.Print(f"Found chart frame for {chartFrame.Symbol.Name}")