Skip to content

ChartDisplaySettings

interface cAlgo.API

DesktopCLICloud

Represents the chart display settings.

Definition

public interface ChartDisplaySettings

Namespace: cAlgo.API · Group: Chart

Examples

using cAlgo.API;

namespace cAlgo
{
    // You can use this sample indicator to change some of the chart display settings via chart controls
    public partial class ChartDisplaySettingsSample : Indicator
    {
        protected override void Initialize()
        {
            var stackPanel = new StackPanel
            {
                HorizontalAlignment = HorizontalAlignment.Left,
                VerticalAlignment = VerticalAlignment.Bottom,
                BackgroundColor = Color.Gold,
                Opacity = 0.7,
                Margin = 5,
                Orientation = Orientation.Vertical
            };

            var askPriceLineCheckBox = new CheckBox
            {
                Text = "Ask Price Line",
                Margin = 5,
                IsChecked = Chart.DisplaySettings.AskPriceLine
            };

            askPriceLineCheckBox.Click += args => Chart.DisplaySettings.AskPriceLine = args.CheckBox.IsChecked.Value;

            stackPanel.AddChild(askPriceLineCheckBox);

            var bidPriceLineCheckBox = new CheckBox
            {
                Text = "Bid Price Line",
                Margin = 5,
                IsChecked = Chart.DisplaySettings.BidPriceLine
            };

            bidPriceLineCheckBox.Click += args => Chart.DisplaySettings.BidPriceLine = args.CheckBox.IsChecked.Value;

            stackPanel.AddChild(bidPriceLineCheckBox);

            var chartScaleCheckBox = new CheckBox
            {
                Text = "Chart Scale",
                Margin = 5,
                IsChecked = Chart.DisplaySettings.ChartScale
            };

            chartScaleCheckBox.Click += args => Chart.DisplaySettings.ChartScale = args.CheckBox.IsChecked.Value;

            stackPanel.AddChild(chartScaleCheckBox);

            var dealMapCheckBox = new CheckBox
            {
                Text = "Deal Map",
                Margin = 5,
                IsChecked = Chart.DisplaySettings.DealMap
            };

            dealMapCheckBox.Click += args => Chart.DisplaySettings.DealMap = args.CheckBox.IsChecked.Value;

            stackPanel.AddChild(dealMapCheckBox);

            var gridCheckBox = new CheckBox
            {
                Text = "Grid",
                Margin = 5,
                IsChecked = Chart.DisplaySettings.Grid
            };

            gridCheckBox.Click += args => Chart.DisplaySettings.Grid = args.CheckBox.IsChecked.Value;

            stackPanel.AddChild(gridCheckBox);

            var volumeCheckBox = new CheckBox
            {
                Text = "Volume",
                Margin = 5,
                IsChecked = Chart.DisplaySettings.TickVolume
            };

            volumeCheckBox.Click += args => Chart.DisplaySettings.TickVolume = args.CheckBox.IsChecked.Value;

            stackPanel.AddChild(volumeCheckBox);

            Chart.AddControl(stackPanel);
        }

        public override void Calculate(int index)
        {
        }
    }
}
import clr
clr.AddReference("cAlgo.API")

from cAlgo.API import *

class Test():
    def on_ask_price_line_check_box_clicked(self, args):
        api.Chart.DisplaySettings.AskPriceLine = args.CheckBox.IsChecked

    def on_bid_price_line_check_box_clicked(self, args):
        api.Chart.DisplaySettings.BidPriceLine = args.CheckBox.IsChecked

    def on_chart_scale_check_box_clicked(self, args):
        api.Chart.DisplaySettings.ChartScale = args.CheckBox.IsChecked

    def on_deal_map_check_box_clicked(self, args):
        api.Chart.DisplaySettings.DealMap = args.CheckBox.IsChecked

    def on_grid_check_box_clicked(self, args):
        api.Chart.DisplaySettings.Grid = args.CheckBox.IsChecked

    def on_volume_check_box_clicked(self, args):
        api.Chart.DisplaySettings.TickVolume = args.CheckBox.IsChecked

    def initialize(self):
        stackPanel = StackPanel()
        stackPanel.HorizontalAlignment = HorizontalAlignment.Left
        stackPanel.VerticalAlignment = VerticalAlignment.Bottom
        stackPanel.BackgroundColor = Color.Gold
        stackPanel.Opacity = 0.7
        stackPanel.Margin = Thickness(5)
        stackPanel.Orientation = Orientation.Vertical

        askPriceLineCheckBox = CheckBox()
        askPriceLineCheckBox.Text = "Ask Price Line"
        askPriceLineCheckBox.Margin = Thickness(5)
        askPriceLineCheckBox.IsChecked = api.Chart.DisplaySettings.AskPriceLine
        askPriceLineCheckBox.Click += self.on_ask_price_line_check_box_clicked

        stackPanel.AddChild(askPriceLineCheckBox)

        bidPriceLineCheckBox = CheckBox()
        bidPriceLineCheckBox.Text = "Bid Price Line"
        bidPriceLineCheckBox.Margin = Thickness(5)
        bidPriceLineCheckBox.IsChecked = api.Chart.DisplaySettings.BidPriceLine
        bidPriceLineCheckBox.Click += self.on_bid_price_line_check_box_clicked

        stackPanel.AddChild(bidPriceLineCheckBox)

        chartScaleCheckBox = CheckBox()
        chartScaleCheckBox.Text = "Chart Scale"
        chartScaleCheckBox.Margin = Thickness(5)
        chartScaleCheckBox.IsChecked = api.Chart.DisplaySettings.ChartScale
        chartScaleCheckBox.Click += self.on_chart_scale_check_box_clicked

        stackPanel.AddChild(chartScaleCheckBox)

        dealMapCheckBox = CheckBox()
        dealMapCheckBox.Text = "Deal Map"
        dealMapCheckBox.Margin = Thickness(5)
        dealMapCheckBox.IsChecked = api.Chart.DisplaySettings.DealMap
        dealMapCheckBox.Click += self.on_deal_map_check_box_clicked

        stackPanel.AddChild(dealMapCheckBox)

        gridCheckBox = CheckBox()
        gridCheckBox.Text = "Grid"
        gridCheckBox.Margin = Thickness(5)
        gridCheckBox.IsChecked = api.Chart.DisplaySettings.Grid
        gridCheckBox.Click += self.on_grid_check_box_clicked

        stackPanel.AddChild(gridCheckBox)

        volumeCheckBox = CheckBox()
        volumeCheckBox.Text = "Volume"
        volumeCheckBox.Margin = Thickness(5)
        volumeCheckBox.IsChecked = api.Chart.DisplaySettings.TickVolume
        volumeCheckBox.Click += self.on_volume_check_box_clicked

        stackPanel.AddChild(volumeCheckBox)

        api.Chart.AddControl(stackPanel)
{
  "AccessRights": "None",
  "TimeZone": "UTC",
  "IsOverlay": true
}

Properties

Name Description
AddRobotButtonDesktopCLICloudbool Defines if the Add cBot button is displayed on the chart.
AskPriceLineDesktopCLICloudbool Defines if the Ask Price Line is displayed on the chart.
BarsDesktopCLICloudbool Defines if the Bars is displayed on the chart.
BidPriceLineDesktopCLICloudbool Defines if the Bid Price Line is displayed on the chart.
ChartScaleDesktopCLICloudbool Defines if the Chart Scale is displayed on the chart.
DealMapDesktopCLICloudbool Defines if the Deal Map is displayed on the chart.
GridDesktopCLICloudbool Defines if the Grid is displayed on the chart background.
IndicatorTitlesDesktopCLICloudbool Defines if the Indicator Titles are displayed on the chart.
MarketSentimentDesktopCLICloudbool Defines if the Market Sentiment is visible on the chart.
OrdersDesktopCLICloudbool Defines if the Orders are displayed on the chart.
PeriodSeparatorsDesktopCLICloudbool Defines if the Period Separators are displayed on the chart.
PositionsDesktopCLICloudbool Defines if the Positions are displayed on the chart.
PriceAlertsDesktopCLICloudbool Defines if the Price Alerts are visible on the chart.
PriceAxisOverlayButtonsDesktopCLICloudbool Defines if the price axis overlays buttons are visible on the chart.
QuickTradeButtonsDesktopCLICloudbool Defines if the QuickTrade buttons are visible on the chart.
TargetsDesktopCLICloudbool Defines if the Target is visible on the chart.
TickVolumeDesktopCLICloudbool Defines if the Tick Volume is displayed on the chart.