Skip to main content
Version: latest

StudyStylesInfo

Interface

Study styles description.

Properties​

char​

OptionalReadonly

Char to display with the plot. Applicable only to chars plot types.

Type​

​string

forceOverlay​

OptionalReadonly

optional flag to indicate the plot should be drawn on main page

Type​

​boolean

format​

OptionalReadonly

Info about the Price Scale formatting

Type​

​Partial<StudyPlotValuePrecisionFormat>

histogramBase​

OptionalReadonly

Histogram base. A price value which will be considered as a start base point when rendering plot with histogram, columns or area style.

Type​

​number

isHidden​

OptionalReadonly

If true then the styles tab will be hidden in the study dialog.

Type​

​boolean

joinPoints​

OptionalReadonly

If true then plot points will be joined with line, applicable only to Circles and Cross type plots. Default is false.

Type​

​boolean

maxHeight​

OptionalReadonly

Maximum possible plot arrow size. Applicable only to arrow plot types.

Type​

​number

minHeight​

OptionalReadonly

Minimum possible plot arrow size. Applicable only to arrow plot types.

Type​

​number

showLast​

OptionalReadonly

If defined, defines the number of bars to plot on chart.

Type​

​number

size​

OptionalReadonly

Size of characters on the chart. Possible values are: auto, tiny, small, normal, large,huge. Applicable to chars and shapes plot types.

Type​

​PlotSymbolSize

text​

OptionalReadonly

Text to display with the plot. Applicable to chars and shapes plot types.

Type​

​string

title​

Readonly

Title used in the study dialog styles tab.

Type​

​string

zorder​

OptionalReadonly

Used to control the zorder of the plot. Control if a plot is visually behind or in front of another.

Type​

​number