Skip to content

ChartTemplateDisplaySettings.PriceToBarRatio

property · ChartTemplateDisplaySettings · cAlgo.API Since 5.10

DesktopCLICloud

Gets or sets the price to bar ratio for chart template. Values that are not greater than zero, NaN or infinite are ignored.

Environment behaviour

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

Definition

double PriceToBarRatio {get; set;}

chartTemplateDisplaySettings.PriceToBarRatio: float

Returns double

Examples

var template = ChartTemplates.Get("Template Name");

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

template.DisplaySettings.PriceToBarRatio = Symbol.PipSize * 10;
template.DisplaySettings.IsPriceToBarRatioLocked = true;

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

template = api.ChartTemplates.Get("Template Name")

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

template.DisplaySettings.PriceToBarRatio = api.Symbol.PipSize * 10
template.DisplaySettings.IsPriceToBarRatioLocked = True

print(f"Template price to bar ratio: {template.DisplaySettings.PriceToBarRatio}")