Skip to content

FavoriteTimeFrames

interface cAlgo.API Since 5.3

DesktopCLICloud

Provides access to favorite TimeFrames API for plugins.

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

public interface FavoriteTimeFrames

Namespace: cAlgo.API · Group: TimeFrame

Examples

using cAlgo.API;
using System.Linq;

namespace cAlgo.Plugins;

public partial class Test : Plugin
{
    protected override void OnStart()
    {
        TimeFrameManager.Favorite.Added += args => Print($"Favorite TimeFrames added: {string.Join(", ", args.TimeFrames.Select(timeFrame => timeFrame.Name))}");
        TimeFrameManager.Favorite.Removed += args => Print($"Favorite TimeFrames removed: {string.Join(", ", args.TimeFrames.Select(timeFrame => timeFrame.Name))}");

        TimeFrameManager.Favorite.Add(TimeFrame.Daily);
        TimeFrameManager.Favorite.Add(TimeFrame.Range1);
        TimeFrameManager.Favorite.Add(TimeFrame.Range100);

        Print($"Is Range100 on Favorite TimeFrames: {TimeFrameManager.Favorite.Contains(TimeFrame.Range100)}");

        TimeFrameManager.Favorite.Remove(TimeFrame.Range100);
    }
}

import clr
clr.AddReference("cAlgo.API")

from cAlgo.API import *

class Test():
    def on_start(self):
        api.TimeFrameManager.Favorite.Added += lambda args: print(f"Favorite TimeFrames added: {', '.join([t.Name for t in args.TimeFrames])}")
        api.TimeFrameManager.Favorite.Removed += lambda args: print(f"Favorite TimeFrames removed: {', '.join([t.Name for t in args.TimeFrames])}")

        api.TimeFrameManager.Favorite.Add(TimeFrame.Daily)
        api.TimeFrameManager.Favorite.Add(TimeFrame.Range1)
        api.TimeFrameManager.Favorite.Add(TimeFrame.Range100)

        print(f"Is Range100 on Favorite TimeFrames: {api.TimeFrameManager.Favorite.Contains(TimeFrame.Range100)}")

        api.TimeFrameManager.Favorite.Remove(TimeFrame.Range100)

{
  "AccessRights": "None"
}

Methods

Name Description
AddDesktopCLICloudvoid Adds a time frame to favorite TimeFrames.
ContainsDesktopCLICloudbool Returns True if passed TimeFrame is in favorite TimeFrames otherwise False.
RemoveDesktopCLICloudbool Removes a time frame from favorite TimeFrames.

Events

Name Description
AddedDesktopCLICloudAction<FavoriteTimeFramesAddedEventArgs> Occurs when new TimeFrames are added to favorite TimeFrames.
RemovedDesktopCLICloudAction<FavoriteTimeFramesRemovedEventArgs> Occurs when TimeFrames are removed from favorite TimeFrames.

See also