---
id: "T:cAlgo.API.ChartTemplateDisplaySettings"
kind: "interface"
namespace: "cAlgo.API"
url: "https://help.ctrader.com/ctrader-algo/references/Chart/Templates/ChartTemplateDisplaySettings/"
---

> Documentation index for agents: https://help.ctrader.com/ctrader-algo/llms.txt · machine index: https://help.ctrader.com/ctrader-algo/api.json

# ChartTemplateDisplaySettings (interface)

Represents the chart template display Settings.

Environments: Desktop supported · CLI supported · Cloud not supported.

- Cloud: Never available in the cloud: it is only returned by members that do not work there (ChartTemplate.DisplaySettings).

## Definition

```csharp
public interface ChartTemplateDisplaySettings
```

Available since cAlgo.API 5.6.

## Examples

C#:

```csharp
using cAlgo.API;

namespace cAlgo.Robots;

public partial class ChartTemplate : Robot
{
    protected override void OnStart()
    {
        var template = ChartTemplates.Get("Template Name");

        if (template is null)
        {
            Print("Template not found");
            return;
        }

        template.DisplaySettings.AskPriceLine = true;
        template.DisplaySettings.Bars = true;
        template.DisplaySettings.BidPriceLine = true;
        template.DisplaySettings.ChartScale = true;
        template.DisplaySettings.DealMap = true;
        template.DisplaySettings.Grid = true;
        template.DisplaySettings.IndicatorTitles = true;
        template.DisplaySettings.MarketSentiment = true;
        template.DisplaySettings.Orders = true;
        template.DisplaySettings.PeriodSeparators = true;
        template.DisplaySettings.Positions = true;
        template.DisplaySettings.PriceAlerts = true;
        template.DisplaySettings.PriceAxisOverlayButtons = true;
        template.DisplaySettings.QuickTradeButtons = true;
        template.DisplaySettings.Targets = true;
        template.DisplaySettings.TickVolume = true;
        template.DisplaySettings.AddRobotButton = true;
        template.DisplaySettings.PriceScaleMode = ChartPriceScaleMode.Percent;
        template.DisplaySettings.IsPriceScaleInverted = true;
        template.DisplaySettings.IsPriceToBarRatioLocked = false;
        template.DisplaySettings.IsScalePriceChartOnly = true;
        template.DisplaySettings.PriceAxisPosition = ChartPriceAxisPosition.Left;

        Print("Price to bar ratio: {0}", template.DisplaySettings.PriceToBarRatio);
    }
}
```

Python:

```python
import clr

clr.AddReference("cAlgo.API")

# Import cAlgo API types
from cAlgo.API import *

# Import trading wrapper functions
from robot_wrapper import *

class Test():
    def on_start(self):
        template = api.ChartTemplates.Get("Template Name")

        if template is None:
            print("Template not found")
            return

        template.DisplaySettings.AskPriceLine = True
        template.DisplaySettings.Bars = True
        template.DisplaySettings.BidPriceLine = True
        template.DisplaySettings.ChartScale = True
        template.DisplaySettings.DealMap = True
        template.DisplaySettings.Grid = True
        template.DisplaySettings.IndicatorTitles = True
        template.DisplaySettings.MarketSentiment = True
        template.DisplaySettings.Orders = True
        template.DisplaySettings.PeriodSeparators = True
        template.DisplaySettings.Positions = True
        template.DisplaySettings.PriceAlerts = True
        template.DisplaySettings.PriceAxisOverlayButtons = True
        template.DisplaySettings.QuickTradeButtons = True
        template.DisplaySettings.Targets = True
        template.DisplaySettings.TickVolume = True
        template.DisplaySettings.AddRobotButton = True
        template.DisplaySettings.PriceScaleMode = ChartPriceScaleMode.Percent
        template.DisplaySettings.IsPriceScaleInverted = True
        template.DisplaySettings.IsPriceToBarRatioLocked = False
        template.DisplaySettings.IsScalePriceChartOnly = True
        template.DisplaySettings.PriceAxisPosition = ChartPriceAxisPosition.Left

        print(f"Price to bar ratio: {template.DisplaySettings.PriceToBarRatio}")
```

config.json:

```json
{
  "AccessRights": "None",
  "AddIndicators": true
}
```

## Properties

- `bool AddRobotButton {get; set;}` — Defines if the Add cBot button is displayed on the chart. [details](https://help.ctrader.com/ctrader-algo/references/Chart/Templates/ChartTemplateDisplaySettings/AddRobotButton/index.md)
- `bool AskPriceLine {get; set;}` — Defines if the Ask Price Line is displayed on the chart. [details](https://help.ctrader.com/ctrader-algo/references/Chart/Templates/ChartTemplateDisplaySettings/AskPriceLine/index.md)
- `bool Bars {get; set;}` — Defines if the Bars is displayed on the chart. [details](https://help.ctrader.com/ctrader-algo/references/Chart/Templates/ChartTemplateDisplaySettings/Bars/index.md)
- `bool BidPriceLine {get; set;}` — Defines if the Bid Price Line is displayed on the chart. [details](https://help.ctrader.com/ctrader-algo/references/Chart/Templates/ChartTemplateDisplaySettings/BidPriceLine/index.md)
- `bool ChartScale {get; set;}` — Defines if the Chart Scale is displayed on the chart. [details](https://help.ctrader.com/ctrader-algo/references/Chart/Templates/ChartTemplateDisplaySettings/ChartScale/index.md)
- `ChartType ChartType {get; set;}` — Gets or sets the type of the chart for chart template. [details](https://help.ctrader.com/ctrader-algo/references/Chart/Templates/ChartTemplateDisplaySettings/ChartType/index.md)
- `bool DealMap {get; set;}` — Defines if the Deal Map is displayed on the chart. [details](https://help.ctrader.com/ctrader-algo/references/Chart/Templates/ChartTemplateDisplaySettings/DealMap/index.md)
- `bool Grid {get; set;}` — Defines if the Grid is displayed on the chart background. [details](https://help.ctrader.com/ctrader-algo/references/Chart/Templates/ChartTemplateDisplaySettings/Grid/index.md)
- `bool IndicatorTitles {get; set;}` — Defines if the Indicator Titles are displayed on the chart. [details](https://help.ctrader.com/ctrader-algo/references/Chart/Templates/ChartTemplateDisplaySettings/IndicatorTitles/index.md)
- `bool IsPriceScaleInverted {get; set;}` — Defines if the price scale is inverted for chart template. [details](https://help.ctrader.com/ctrader-algo/references/Chart/Templates/ChartTemplateDisplaySettings/IsPriceScaleInverted/index.md)
- `bool IsPriceToBarRatioLocked {get; set;}` — Defines if the price to bar ratio is locked for chart template. Locking sets the price scale mode to Regular. [details](https://help.ctrader.com/ctrader-algo/references/Chart/Templates/ChartTemplateDisplaySettings/IsPriceToBarRatioLocked/index.md)
- `bool IsScalePriceChartOnly {get; set;}` — Defines if the auto scale fits only the bars for chart template. [details](https://help.ctrader.com/ctrader-algo/references/Chart/Templates/ChartTemplateDisplaySettings/IsScalePriceChartOnly/index.md)
- `bool MarketSentiment {get; set;}` — Defines if the Market Sentiment is visible on the chart. [details](https://help.ctrader.com/ctrader-algo/references/Chart/Templates/ChartTemplateDisplaySettings/MarketSentiment/index.md)
- `bool Orders {get; set;}` — Defines if the Orders are displayed on the chart. [details](https://help.ctrader.com/ctrader-algo/references/Chart/Templates/ChartTemplateDisplaySettings/Orders/index.md)
- `bool PeriodSeparators {get; set;}` — Defines if the Period Separators are displayed on the chart. [details](https://help.ctrader.com/ctrader-algo/references/Chart/Templates/ChartTemplateDisplaySettings/PeriodSeparators/index.md)
- `bool Positions {get; set;}` — Defines if the Positions are displayed on the chart. [details](https://help.ctrader.com/ctrader-algo/references/Chart/Templates/ChartTemplateDisplaySettings/Positions/index.md)
- `bool PriceAlerts {get; set;}` — Defines if the Price Alerts are visible on the chart. [details](https://help.ctrader.com/ctrader-algo/references/Chart/Templates/ChartTemplateDisplaySettings/PriceAlerts/index.md)
- `bool PriceAxisOverlayButtons {get; set;}` — Defines if the price axis overlays buttons are visible on the chart. [details](https://help.ctrader.com/ctrader-algo/references/Chart/Templates/ChartTemplateDisplaySettings/PriceAxisOverlayButtons/index.md)
- `ChartPriceAxisPosition PriceAxisPosition {get; set;}` — Gets or sets the price axis position for chart template. [details](https://help.ctrader.com/ctrader-algo/references/Chart/Templates/ChartTemplateDisplaySettings/PriceAxisPosition/index.md)
- `ChartPriceScaleMode PriceScaleMode {get; set;}` — Gets or sets the price scale mode for chart template. While the template price to bar ratio is locked only Regular can be set, and setting any other mode is ignored. [details](https://help.ctrader.com/ctrader-algo/references/Chart/Templates/ChartTemplateDisplaySettings/PriceScaleMode/index.md)
- `double PriceToBarRatio {get; set;}` — Gets or sets the price to bar ratio for chart template. Values that are not greater than zero, NaN or infinite are ignored. [details](https://help.ctrader.com/ctrader-algo/references/Chart/Templates/ChartTemplateDisplaySettings/PriceToBarRatio/index.md)
- `bool QuickTradeButtons {get; set;}` — Defines if the QuickTrade buttons are visible on the chart. [details](https://help.ctrader.com/ctrader-algo/references/Chart/Templates/ChartTemplateDisplaySettings/QuickTradeButtons/index.md)
- `bool Targets {get; set;}` — Defines if the Target is visible on the chart. [details](https://help.ctrader.com/ctrader-algo/references/Chart/Templates/ChartTemplateDisplaySettings/Targets/index.md)
- `bool TickVolume {get; set;}` — Defines if the Tick Volume is displayed on the chart. [details](https://help.ctrader.com/ctrader-algo/references/Chart/Templates/ChartTemplateDisplaySettings/TickVolume/index.md)
- `int ZoomLevel {get; set;}` — Gets or sets the chart zoom percent value for chart template. Valid values are from 5 to 500 with a step of 5, as can be seen on UI in the charts Zoom control. [details](https://help.ctrader.com/ctrader-algo/references/Chart/Templates/ChartTemplateDisplaySettings/ZoomLevel/index.md)