ChartManager.RemoveFrame

method · ChartManager · cAlgo.API

DesktopCLICloud

Removes a 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

C#Python

bool RemoveFrame(string frameId)

api.ChartManager.RemoveFrame(frameId: str) -> bool

Parameters

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

Returns bool — True if successful otherwise false.

Examples

C#Python

var customFrame = ChartManager.AddCustomFrame("Temporary Frame");
Print("Frame removed: {0}", ChartManager.RemoveFrame(customFrame.Id));

customFrame = api.ChartManager.AddCustomFrame("Temporary Frame")
api.Print(f"Frame removed: {api.ChartManager.RemoveFrame(customFrame.Id)}")