CustomSymbol.BarsUnloaded

event · CustomSymbol · cAlgo.API Since 5.3

DesktopCLICloud

Occurs when a custom bars is unloaded and not being used anymore.

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

event Action<CustomSymbolBarsUnloadedEventArgs> BarsUnloaded;

customSymbol.BarsUnloaded += handler  # handler(obj: CustomSymbolBarsUnloadedEventArgs)

Examples

C#Python

protected override void OnStart()
{
    var customSymbol = CustomSymbols.Add("MYEURUSD", Symbols.GetSymbol("EURUSD"));
    customSymbol.BarsUnloaded += OnBarsUnloaded;
}

private void OnBarsUnloaded(CustomSymbolBarsUnloadedEventArgs args)
{
    var isRemoved = args.CustomSymbol.RemoveBars(args.CustomBars.TimeFrame);
    Print("Unloaded {0} bars removed: {1}", args.CustomBars.TimeFrame, isRemoved);
}

def on_start(self):
    customSymbol = api.CustomSymbols.Add("MYEURUSD", api.Symbols.GetSymbol("EURUSD"))
    customSymbol.BarsUnloaded += self.on_bars_unloaded

def on_bars_unloaded(self, args):
    isRemoved = args.CustomSymbol.RemoveBars(args.CustomBars.TimeFrame)
    api.Print(f"Unloaded {args.CustomBars.TimeFrame} bars removed: {isRemoved}")