Skip to main content

Interface: StudyStylesInfo

Charting Library.StudyStylesInfo

Study styles description.

Properties​

char​

• Optional Readonly char: string

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

forceOverlay​

• Optional Readonly forceOverlay: boolean

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

format​

• Optional Readonly format: Partial<StudyPlotValuePrecisionFormat>

Info about the Price Scale formatting

histogramBase​

• Optional Readonly histogramBase: number

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

isHidden​

• Optional Readonly isHidden: boolean

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

joinPoints​

• Optional Readonly joinPoints: boolean

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

maxHeight​

• Optional Readonly maxHeight: number

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

minHeight​

• Optional Readonly minHeight: number

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

showLast​

• Optional Readonly showLast: number

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

size​

• Optional Readonly size: number | PlotSymbolSize

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

text​

• Optional Readonly text: string

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

title​

• Readonly title: string

Title used in the study dialog styles tab.

zorder​

• Optional Readonly zorder: number

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