Skip to main content

Interface: ChartPropertiesOverrides

Charting Library.ChartPropertiesOverrides

Property overrides that can be used with IChartingLibraryWidget.applyOverrides.

Indexable​

▪ [key: string]: string | number | boolean

Override values.

Properties​

crossHairProperties.color​

• crossHairProperties.color: string

Crosshair color.

Default

'#9598A1'

crossHairProperties.style​

• crossHairProperties.style: OverrideLineStyle

Crosshair style.

Default

LineStyle.Dashed

crossHairProperties.transparency​

• crossHairProperties.transparency: number

Crosshair transparency.

Default

0

crossHairProperties.width​

• crossHairProperties.width: number

Crosshair width.

Default

1

mainSeriesProperties.areaStyle.color1​

• mainSeriesProperties.areaStyle.color1: string

Main series area style color1.

Default

"rgba(41, 98, 255, 0.28)"

mainSeriesProperties.areaStyle.color2​

• mainSeriesProperties.areaStyle.color2: string

Main series area style color2.

Default

"#2962FF"

mainSeriesProperties.areaStyle.linecolor​

• mainSeriesProperties.areaStyle.linecolor: string

Main series area style line color.

Default

"#2962FF"

mainSeriesProperties.areaStyle.linestyle​

• mainSeriesProperties.areaStyle.linestyle: OverrideLineStyle

Main series area style line style.

Default

LineStyle.Solid

mainSeriesProperties.areaStyle.linewidth​

• mainSeriesProperties.areaStyle.linewidth: number

Main series area style line width.

Default

2

mainSeriesProperties.areaStyle.priceSource​

• mainSeriesProperties.areaStyle.priceSource: PriceSource

Main series area style price source.

Default

"close"

mainSeriesProperties.areaStyle.transparency​

• mainSeriesProperties.areaStyle.transparency: number

Main series area style transparency.

Default

100

mainSeriesProperties.barStyle.barColorsOnPrevClose​

• mainSeriesProperties.barStyle.barColorsOnPrevClose: boolean

Main series bar style color on previous close behaviour.

Default

false

mainSeriesProperties.barStyle.dontDrawOpen​

• mainSeriesProperties.barStyle.dontDrawOpen: boolean

Main series bar style don't draw open behaviour.

Default

false

mainSeriesProperties.barStyle.downColor​

• mainSeriesProperties.barStyle.downColor: string

Main series bar style down color.

Default

"#F23645"

mainSeriesProperties.barStyle.thinBars​

• mainSeriesProperties.barStyle.thinBars: boolean

Main series bar style thin bars behaviour.

Default

true

mainSeriesProperties.barStyle.upColor​

• mainSeriesProperties.barStyle.upColor: string

Main series bar style up color.

Default

"#089981"

mainSeriesProperties.baselineStyle.baseLevelPercentage​

• mainSeriesProperties.baselineStyle.baseLevelPercentage: number

Main series Baseline style base level percentage.

Default

50

mainSeriesProperties.baselineStyle.baselineColor​

• mainSeriesProperties.baselineStyle.baselineColor: string

Main series Baseline style baseline color.

Default

"#758696"

mainSeriesProperties.baselineStyle.bottomFillColor1​

• mainSeriesProperties.baselineStyle.bottomFillColor1: string

Main series Baseline style bottom fill color1.

Default

"rgba(242, 54, 69, 0.05)"

mainSeriesProperties.baselineStyle.bottomFillColor2​

• mainSeriesProperties.baselineStyle.bottomFillColor2: string

Main series Baseline style bottom fill color2.

Default

"rgba(242, 54, 69, 0.28)"

mainSeriesProperties.baselineStyle.bottomLineColor​

• mainSeriesProperties.baselineStyle.bottomLineColor: string

Main series Baseline style bottom line color.

Default

"#F23645"

mainSeriesProperties.baselineStyle.bottomLineWidth​

• mainSeriesProperties.baselineStyle.bottomLineWidth: number

Main series Baseline style bottom line width.

Default

2

mainSeriesProperties.baselineStyle.priceSource​

• mainSeriesProperties.baselineStyle.priceSource: PriceSource

Main series Baseline style price source.

Default

"close"

mainSeriesProperties.baselineStyle.topFillColor1​

• mainSeriesProperties.baselineStyle.topFillColor1: string

Main series Baseline style top fill color1.

Default

"rgba(8, 153, 129, 0.28)"

mainSeriesProperties.baselineStyle.topFillColor2​

• mainSeriesProperties.baselineStyle.topFillColor2: string

Main series Baseline style top fill color2.

Default

"rgba(8, 153, 129, 0.05)"

mainSeriesProperties.baselineStyle.topLineColor​

• mainSeriesProperties.baselineStyle.topLineColor: string

Main series Baseline style top line color.

Default

"#089981"

mainSeriesProperties.baselineStyle.topLineWidth​

• mainSeriesProperties.baselineStyle.topLineWidth: number

Main series Baseline style top line width.

Default

2

mainSeriesProperties.baselineStyle.transparency​

• mainSeriesProperties.baselineStyle.transparency: number

Main series Baseline style transparency.

Default

50

mainSeriesProperties.bidAsk.askLineColor​

• mainSeriesProperties.bidAsk.askLineColor: string

Color line for the ask

Default

'#F7525F'

mainSeriesProperties.bidAsk.bidLineColor​

• mainSeriesProperties.bidAsk.bidLineColor: string

Color line for the bid

Default

'#2962FF'

mainSeriesProperties.bidAsk.lineStyle​

• mainSeriesProperties.bidAsk.lineStyle: OverrideLineStyle

Style of the line for bid & ask

Default

LineStyle.Dotted

mainSeriesProperties.bidAsk.lineWidth​

• mainSeriesProperties.bidAsk.lineWidth: number

Width of the line for bid & ask

Default

1

mainSeriesProperties.bidAsk.visible​

• mainSeriesProperties.bidAsk.visible: boolean

Main series bid & ask visibility

Default

false

mainSeriesProperties.candleStyle.barColorsOnPrevClose​

• mainSeriesProperties.candleStyle.barColorsOnPrevClose: boolean

Main series candle style color on previous close behaviour.

Default

false

mainSeriesProperties.candleStyle.borderColor​

• mainSeriesProperties.candleStyle.borderColor: string

Main series candle style border color.

Default

"#378658"

mainSeriesProperties.candleStyle.borderDownColor​

• mainSeriesProperties.candleStyle.borderDownColor: string

Main series candle style border down color.

Default

"#F23645"

mainSeriesProperties.candleStyle.borderUpColor​

• mainSeriesProperties.candleStyle.borderUpColor: string

Main series candle style border up color.

Default

"#089981"

mainSeriesProperties.candleStyle.downColor​

• mainSeriesProperties.candleStyle.downColor: string

Main series candle style down color.

Default

"#F23645"

mainSeriesProperties.candleStyle.drawBody​

• mainSeriesProperties.candleStyle.drawBody: boolean

Main series candle style body visibility.

Default

true

mainSeriesProperties.candleStyle.drawBorder​

• mainSeriesProperties.candleStyle.drawBorder: boolean

Main series candle style border visibility.

Default

true

mainSeriesProperties.candleStyle.drawWick​

• mainSeriesProperties.candleStyle.drawWick: boolean

Main series candle style wick visibility.

Default

true

mainSeriesProperties.candleStyle.upColor​

• mainSeriesProperties.candleStyle.upColor: string

Main series candle style up color.

Default

"#089981"

mainSeriesProperties.candleStyle.wickColor​

• mainSeriesProperties.candleStyle.wickColor: string

Main series candle style wick color.

Default

"#737375"

mainSeriesProperties.candleStyle.wickDownColor​

• mainSeriesProperties.candleStyle.wickDownColor: string

Main series candle style wick down color.

Default

"#F23645"

mainSeriesProperties.candleStyle.wickUpColor​

• mainSeriesProperties.candleStyle.wickUpColor: string

Main series candle style wick up color.

Default

"#089981"

mainSeriesProperties.columnStyle.barColorsOnPrevClose​

• mainSeriesProperties.columnStyle.barColorsOnPrevClose: boolean

Main series column style color on previous close behaviour.

Default

true

mainSeriesProperties.columnStyle.downColor​

• mainSeriesProperties.columnStyle.downColor: string

Main series column style down color.

Default

"rgba(242, 54, 69, 0.5)"

mainSeriesProperties.columnStyle.priceSource​

• mainSeriesProperties.columnStyle.priceSource: PriceSource

Main series column style price source.

Default

"close"

mainSeriesProperties.columnStyle.upColor​

• mainSeriesProperties.columnStyle.upColor: string

Main series column style up color.

Default

"rgba(8, 153, 129, 0.5)"

mainSeriesProperties.haStyle.barColorsOnPrevClose​

• mainSeriesProperties.haStyle.barColorsOnPrevClose: boolean

Main series Heikin Ashi style color on previous close behaviour.

Default

false

mainSeriesProperties.haStyle.borderColor​

• mainSeriesProperties.haStyle.borderColor: string

Main series Heikin Ashi style border color.

Default

"#378658"

mainSeriesProperties.haStyle.borderDownColor​

• mainSeriesProperties.haStyle.borderDownColor: string

Main series Heikin Ashi style border down color.

Default

"#F23645"

mainSeriesProperties.haStyle.borderUpColor​

• mainSeriesProperties.haStyle.borderUpColor: string

Main series Heikin Ashi style border up color.

Default

"#089981"

mainSeriesProperties.haStyle.downColor​

• mainSeriesProperties.haStyle.downColor: string

Main series Heikin Ashi style down color.

Default

"#F23645"

mainSeriesProperties.haStyle.drawBody​

• mainSeriesProperties.haStyle.drawBody: boolean

Main series Heikin Ashi style body visibility.

Default

true

mainSeriesProperties.haStyle.drawBorder​

• mainSeriesProperties.haStyle.drawBorder: boolean

Main series Heikin Ashi style border visibility.

Default

true

mainSeriesProperties.haStyle.drawWick​

• mainSeriesProperties.haStyle.drawWick: boolean

Main series Heikin Ashi style wick visibility.

Default

true

mainSeriesProperties.haStyle.upColor​

• mainSeriesProperties.haStyle.upColor: string

Main series Heikin Ashi style up color.

Default

"#089981"

mainSeriesProperties.haStyle.wickColor​

• mainSeriesProperties.haStyle.wickColor: string

Main series Heikin Ashi style wick color.

Default

"#737375"

mainSeriesProperties.haStyle.wickDownColor​

• mainSeriesProperties.haStyle.wickDownColor: string

Main series Heikin Ashi style wick down color.

Default

"#F23645"

mainSeriesProperties.haStyle.wickUpColor​

• mainSeriesProperties.haStyle.wickUpColor: string

Main series Heikin Ashi style wick up color.

Default

"#089981"

mainSeriesProperties.highLowAvgPrice.averageClosePriceLabelVisible​

• mainSeriesProperties.highLowAvgPrice.averageClosePriceLabelVisible: boolean

Average close price lines label visibility.

Default

false

mainSeriesProperties.highLowAvgPrice.averageClosePriceLineVisible​

• mainSeriesProperties.highLowAvgPrice.averageClosePriceLineVisible: boolean

Average close price lines visibility.

Default

false

mainSeriesProperties.highLowAvgPrice.averagePriceLineColor​

• mainSeriesProperties.highLowAvgPrice.averagePriceLineColor: string

Average close price lines color.

Default

""

mainSeriesProperties.highLowAvgPrice.averagePriceLineWidth​

• mainSeriesProperties.highLowAvgPrice.averagePriceLineWidth: number

Average close price lines width.

Default

1

mainSeriesProperties.highLowAvgPrice.highLowPriceLabelsVisible​

• mainSeriesProperties.highLowAvgPrice.highLowPriceLabelsVisible: boolean

High/low price lines label visibility.

Default

false

mainSeriesProperties.highLowAvgPrice.highLowPriceLinesColor​

• mainSeriesProperties.highLowAvgPrice.highLowPriceLinesColor: string

High/low price lines color.

Default

""

mainSeriesProperties.highLowAvgPrice.highLowPriceLinesVisible​

• mainSeriesProperties.highLowAvgPrice.highLowPriceLinesVisible: boolean

High/low price lines visibility.

Default

false

mainSeriesProperties.highLowAvgPrice.highLowPriceLinesWidth​

• mainSeriesProperties.highLowAvgPrice.highLowPriceLinesWidth: number

High/low price lines width.

Default

1

mainSeriesProperties.hiloStyle.borderColor​

• mainSeriesProperties.hiloStyle.borderColor: string

Main series High-low style border color.

Default

"#2962FF"

mainSeriesProperties.hiloStyle.color​

• mainSeriesProperties.hiloStyle.color: string

Main series High-low style color.

Default

"#2962FF"

mainSeriesProperties.hiloStyle.labelColor​

• mainSeriesProperties.hiloStyle.labelColor: string

Main series High-low style label color.

Default

"#2962FF"

mainSeriesProperties.hiloStyle.showBorders​

• mainSeriesProperties.hiloStyle.showBorders: boolean

Main series High-low style border visibility.

Default

true

mainSeriesProperties.hiloStyle.showLabels​

• mainSeriesProperties.hiloStyle.showLabels: boolean

Main series High-low style label visibility.

Default

true

mainSeriesProperties.hlcAreaStyle.closeLineColor​

• mainSeriesProperties.hlcAreaStyle.closeLineColor: string

Main series hlc area style close line color.

Default

"#868993"

mainSeriesProperties.hlcAreaStyle.closeLineStyle​

• mainSeriesProperties.hlcAreaStyle.closeLineStyle: OverrideLineStyle

Main series hlc area style close line style.

Default

LineStyle.Solid

mainSeriesProperties.hlcAreaStyle.closeLineWidth​

• mainSeriesProperties.hlcAreaStyle.closeLineWidth: number

Main series hlc area style close line width.

Default

2

mainSeriesProperties.hlcAreaStyle.closeLowFillColor​

• mainSeriesProperties.hlcAreaStyle.closeLowFillColor: string

Main series hlc area style close low fill color.

Default

"rgba(242, 54, 69, 0.2)"

mainSeriesProperties.hlcAreaStyle.highCloseFillColor​

• mainSeriesProperties.hlcAreaStyle.highCloseFillColor: string

Main series hlc area style high close fill color.

Default

"rgba(8, 153, 129, 0.2)"

mainSeriesProperties.hlcAreaStyle.highLineColor​

• mainSeriesProperties.hlcAreaStyle.highLineColor: string

Main series hlc area style high line color.

Default

"#089981"

mainSeriesProperties.hlcAreaStyle.highLineStyle​

• mainSeriesProperties.hlcAreaStyle.highLineStyle: OverrideLineStyle

Main series hlc area style high line style.

Default

LineStyle.Solid

mainSeriesProperties.hlcAreaStyle.highLineWidth​

• mainSeriesProperties.hlcAreaStyle.highLineWidth: number

Main series hlc area style high line width.

Default

2

mainSeriesProperties.hlcAreaStyle.lowLineColor​

• mainSeriesProperties.hlcAreaStyle.lowLineColor: string

Main series hlc area style low line color.

Default

"#F23645"

mainSeriesProperties.hlcAreaStyle.lowLineStyle​

• mainSeriesProperties.hlcAreaStyle.lowLineStyle: OverrideLineStyle

Main series hlc area style low line style.

Default

LineStyle.Solid

mainSeriesProperties.hlcAreaStyle.lowLineWidth​

• mainSeriesProperties.hlcAreaStyle.lowLineWidth: number

Main series hlc area style low line width.

Default

2

mainSeriesProperties.hollowCandleStyle.borderColor​

• mainSeriesProperties.hollowCandleStyle.borderColor: string

Main series hollow candle style border color.

Default

"#378658"

mainSeriesProperties.hollowCandleStyle.borderDownColor​

• mainSeriesProperties.hollowCandleStyle.borderDownColor: string

Main series hollow candle style down color.

Default

"#F23645"

mainSeriesProperties.hollowCandleStyle.borderUpColor​

• mainSeriesProperties.hollowCandleStyle.borderUpColor: string

Main series hollow candle style border up color.

Default

"#089981"

mainSeriesProperties.hollowCandleStyle.downColor​

• mainSeriesProperties.hollowCandleStyle.downColor: string

Main series hollow candle style down color.

Default

"#F23645"

mainSeriesProperties.hollowCandleStyle.drawBody​

• mainSeriesProperties.hollowCandleStyle.drawBody: boolean

Main series hollow candle style body visibility.

Default

true

mainSeriesProperties.hollowCandleStyle.drawBorder​

• mainSeriesProperties.hollowCandleStyle.drawBorder: boolean

Main series hollow candle style border visibility.

Default

true

mainSeriesProperties.hollowCandleStyle.drawWick​

• mainSeriesProperties.hollowCandleStyle.drawWick: boolean

Main series hollow candle style wick visibility.

Default

true

mainSeriesProperties.hollowCandleStyle.upColor​

• mainSeriesProperties.hollowCandleStyle.upColor: string

Main series hollow candle style up color.

Default

"#089981"

mainSeriesProperties.hollowCandleStyle.wickColor​

• mainSeriesProperties.hollowCandleStyle.wickColor: string

Main series hollow candle style wick color.

Default

"#737375"

mainSeriesProperties.hollowCandleStyle.wickDownColor​

• mainSeriesProperties.hollowCandleStyle.wickDownColor: string

Main series hollow candle style wick down color.

Default

"#F23645"

mainSeriesProperties.hollowCandleStyle.wickUpColor​

• mainSeriesProperties.hollowCandleStyle.wickUpColor: string

Main series hollow candle style wick up color.

Default

"#089981"

mainSeriesProperties.kagiStyle.downColor​

• mainSeriesProperties.kagiStyle.downColor: string

Main series Kagi style down color.

Default

"#F23645"

mainSeriesProperties.kagiStyle.downColorProjection​

• mainSeriesProperties.kagiStyle.downColorProjection: string

Main series Kagi style down projection color.

Default

"#f5a6ae"

mainSeriesProperties.kagiStyle.upColor​

• mainSeriesProperties.kagiStyle.upColor: string

Main series Kagi style up color.

Default

"#089981"

mainSeriesProperties.kagiStyle.upColorProjection​

• mainSeriesProperties.kagiStyle.upColorProjection: string

Main series Kagi style up projection color.

Default

"#a9dcc3"

mainSeriesProperties.lineStyle.color​

• mainSeriesProperties.lineStyle.color: string

Main series line style color.

Default

"#2962FF"

mainSeriesProperties.lineStyle.linestyle​

• mainSeriesProperties.lineStyle.linestyle: OverrideLineStyle

Main series line style line style.

Default

LineStyle.Solid

mainSeriesProperties.lineStyle.linewidth​

• mainSeriesProperties.lineStyle.linewidth: number

Main series line style line width.

Default

2

mainSeriesProperties.lineStyle.priceSource​

• mainSeriesProperties.lineStyle.priceSource: PriceSource

Main series line style price source.

Default

"close"

mainSeriesProperties.lineWithMarkersStyle.color​

• mainSeriesProperties.lineWithMarkersStyle.color: string

Main series Line With Markers style Line Color.

Default

'#2962FF'

mainSeriesProperties.lineWithMarkersStyle.linestyle​

• mainSeriesProperties.lineWithMarkersStyle.linestyle: OverrideLineStyle

Main series Line With Markers style Line style.

Default

LineStyle.Solid

mainSeriesProperties.lineWithMarkersStyle.linewidth​

• mainSeriesProperties.lineWithMarkersStyle.linewidth: number

Main series Line With Markers style Line width.

Default

2

mainSeriesProperties.lineWithMarkersStyle.priceSource​

• mainSeriesProperties.lineWithMarkersStyle.priceSource: string

Main series Line With Markers style Price Source.

Default

'close'

mainSeriesProperties.minTick​

• mainSeriesProperties.minTick: string

Main series minimum tick behaviour.

Default

"default"

Example

// reset minTick to default
tvWidget.applyOverrides({ 'mainSeriesProperties.minTick': 'default' });

// Set main series minTick to { priceScale: 10000, minMove: 1, frac: false }
tvWidget.applyOverrides({ 'mainSeriesProperties.minTick': '10000,1,false' });

// Set default minTick for overlay studies to { priceScale: 10000, minMove: 1, frac: false }
tvWidget.applyStudiesOverrides({ 'overlay.minTick': '10000,1,false' });

mainSeriesProperties.pbStyle.borderDownColor​

• mainSeriesProperties.pbStyle.borderDownColor: string

Main series Line Break style border down color.

Default

"#F23645"

mainSeriesProperties.pbStyle.borderDownColorProjection​

• mainSeriesProperties.pbStyle.borderDownColorProjection: string

Main series Line Break style down projection color.

Default

"#f5a6ae"

mainSeriesProperties.pbStyle.borderUpColor​

• mainSeriesProperties.pbStyle.borderUpColor: string

Main series Line Break style border up color.

Default

"#089981"

mainSeriesProperties.pbStyle.borderUpColorProjection​

• mainSeriesProperties.pbStyle.borderUpColorProjection: string

Main series Line Break style up projection color.

Default

"#a9dcc3"

mainSeriesProperties.pbStyle.downColor​

• mainSeriesProperties.pbStyle.downColor: string

Main series Line Break style down color.

Default

"#F23645"

mainSeriesProperties.pbStyle.downColorProjection​

• mainSeriesProperties.pbStyle.downColorProjection: string

Main series Line Break style down projection color.

Default

"#f5a6ae"

mainSeriesProperties.pbStyle.upColor​

• mainSeriesProperties.pbStyle.upColor: string

Main series Line Break style up color.

Default

"#089981"

mainSeriesProperties.pbStyle.upColorProjection​

• mainSeriesProperties.pbStyle.upColorProjection: string

Main series Line Break style up projection color.

Default

"#a9dcc3"

mainSeriesProperties.pnfStyle.downColor​

• mainSeriesProperties.pnfStyle.downColor: string

Main series Point & Figure style down color.

Default

"#F23645"

mainSeriesProperties.pnfStyle.downColorProjection​

• mainSeriesProperties.pnfStyle.downColorProjection: string

Main series Point & Figure style down projection color.

Default

"#f5a6ae"

mainSeriesProperties.pnfStyle.upColor​

• mainSeriesProperties.pnfStyle.upColor: string

Main series Point & Figure style up color.

Default

"#089981"

mainSeriesProperties.pnfStyle.upColorProjection​

• mainSeriesProperties.pnfStyle.upColorProjection: string

Main series Point & Figure style up projection color.

Default

"#a9dcc3"

mainSeriesProperties.prevClosePriceLineColor​

• mainSeriesProperties.prevClosePriceLineColor: string

Main series previous close price line color.

Default

"#555555"

mainSeriesProperties.prevClosePriceLineWidth​

• mainSeriesProperties.prevClosePriceLineWidth: number

Main series previous close price line width.

Default

1

mainSeriesProperties.priceAxisProperties.alignLabels​

• mainSeriesProperties.priceAxisProperties.alignLabels: boolean

Main series price axis label alignment behaviour.

Default

true

mainSeriesProperties.priceAxisProperties.indexedTo100​

• mainSeriesProperties.priceAxisProperties.indexedTo100: boolean

Main series price axis indexed to 100 mode.

Default

false

mainSeriesProperties.priceAxisProperties.isInverted​

• mainSeriesProperties.priceAxisProperties.isInverted: boolean

Main series price axis inverted mode.

Default

false

mainSeriesProperties.priceAxisProperties.log​

• mainSeriesProperties.priceAxisProperties.log: boolean

Main series price axis log mode.

Default

false

mainSeriesProperties.priceAxisProperties.percentage​

• mainSeriesProperties.priceAxisProperties.percentage: boolean

Main series price axis percentage mode.

Default

false

mainSeriesProperties.priceLineColor​

• mainSeriesProperties.priceLineColor: string

Main series price line color.

Default

""

mainSeriesProperties.priceLineWidth​

• mainSeriesProperties.priceLineWidth: number

Main series price line width.

Default

1

mainSeriesProperties.renkoStyle.borderDownColor​

• mainSeriesProperties.renkoStyle.borderDownColor: string

Main series Renko style border down color.

Default

"#F23645"

mainSeriesProperties.renkoStyle.borderDownColorProjection​

• mainSeriesProperties.renkoStyle.borderDownColorProjection: string

Main series Renko style down projection border color.

Default

"#f5a6ae"

mainSeriesProperties.renkoStyle.borderUpColor​

• mainSeriesProperties.renkoStyle.borderUpColor: string

Main series Renko style border up color.

Default

"#089981"

mainSeriesProperties.renkoStyle.borderUpColorProjection​

• mainSeriesProperties.renkoStyle.borderUpColorProjection: string

Main series Renko style up projection border color.

Default

"#a9dcc3"

mainSeriesProperties.renkoStyle.downColor​

• mainSeriesProperties.renkoStyle.downColor: string

Main series Renko style down color.

Default

"#F23645"

mainSeriesProperties.renkoStyle.downColorProjection​

• mainSeriesProperties.renkoStyle.downColorProjection: string

Main series Renko style down projection color.

Default

"#f5a6ae"

mainSeriesProperties.renkoStyle.upColor​

• mainSeriesProperties.renkoStyle.upColor: string

Main series Renko style up color.

Default

"#089981"

mainSeriesProperties.renkoStyle.upColorProjection​

• mainSeriesProperties.renkoStyle.upColorProjection: string

Main series Renko style up projection color.

Default

"#a9dcc3"

mainSeriesProperties.renkoStyle.wickDownColor​

• mainSeriesProperties.renkoStyle.wickDownColor: string

Main series Renko style wick down color.

Default

"#F23645"

mainSeriesProperties.renkoStyle.wickUpColor​

• mainSeriesProperties.renkoStyle.wickUpColor: string

Main series Renko style wick up color.

Default

"#089981"

mainSeriesProperties.sessionId​

• mainSeriesProperties.sessionId: "regular" | "extended"

Sessions to display on the chart. Use 'extended' to include pre- and post-market subsessions. See the Extended Sessions guide for more info.

Default

'regular'

mainSeriesProperties.showCountdown​

• mainSeriesProperties.showCountdown: boolean

Displays the countdown to the bar closing on the price scale. Available only for intraday resolutions.

Default

false

mainSeriesProperties.showPrevClosePriceLine​

• mainSeriesProperties.showPrevClosePriceLine: boolean

Main series previous close price line visibility.

Default

false

mainSeriesProperties.showPriceLine​

• mainSeriesProperties.showPriceLine: boolean

Main series price line visibility.

Default

true

mainSeriesProperties.statusViewStyle.showExchange​

• mainSeriesProperties.statusViewStyle.showExchange: boolean

Main series legend exchange visibility.

Default

true

mainSeriesProperties.statusViewStyle.showInterval​

• mainSeriesProperties.statusViewStyle.showInterval: boolean

Main series legend interval visibility.

Default

true

mainSeriesProperties.statusViewStyle.symbolTextSource​

• mainSeriesProperties.statusViewStyle.symbolTextSource: SeriesStatusViewSymbolTextSource

Main series legend text style.

Default

"description"

mainSeriesProperties.style​

• mainSeriesProperties.style: ChartStyle

Main series chart style.

Default

ChartStyle.Candle

mainSeriesProperties.visible​

• mainSeriesProperties.visible: boolean

Main series visibility.

Default

true

paneProperties.background​

• paneProperties.background: string

Pane background color.

Default

'#ffffff'

paneProperties.backgroundGradientEndColor​

• paneProperties.backgroundGradientEndColor: string

Pane background gradient end color.

Default

'#ffffff'

paneProperties.backgroundGradientStartColor​

• paneProperties.backgroundGradientStartColor: string

Pane background gradient start color.

Default

'#ffffff'

paneProperties.backgroundType​

• paneProperties.backgroundType: ColorTypes

Pane background type. In the dark theme, the default value is 'gradient'.

Default

'solid'

paneProperties.bottomMargin​

• paneProperties.bottomMargin: number

Pane auto scaling bottom margin percentage.

Default

8

paneProperties.horzGridProperties.color​

• paneProperties.horzGridProperties.color: string

Pane horizontal grid color.

Default

'rgba(42, 46, 57, 0.06)'

paneProperties.horzGridProperties.style​

• paneProperties.horzGridProperties.style: OverrideLineStyle

Pane horizontal grid line style.

Default

LineStyle.Solid

paneProperties.legendProperties.backgroundTransparency​

• paneProperties.legendProperties.backgroundTransparency: number

Legend background transparency percentage.

Default

50

paneProperties.legendProperties.showBackground​

• paneProperties.legendProperties.showBackground: boolean

Legend background visibility.

Default

true

paneProperties.legendProperties.showBarChange​

• paneProperties.legendProperties.showBarChange: boolean

Series legend change value visibility.

Default

true

paneProperties.legendProperties.showSeriesOHLC​

• paneProperties.legendProperties.showSeriesOHLC: boolean

Study legend OHLC values visibility.

Default

true

paneProperties.legendProperties.showSeriesTitle​

• paneProperties.legendProperties.showSeriesTitle: boolean

Series legend title visibility.

Default

true

paneProperties.legendProperties.showStudyArguments​

• paneProperties.legendProperties.showStudyArguments: boolean

Study legend input values visibility.

Default

true

paneProperties.legendProperties.showStudyTitles​

• paneProperties.legendProperties.showStudyTitles: boolean

Study legend title visibility.

Default

true

paneProperties.legendProperties.showStudyValues​

• paneProperties.legendProperties.showStudyValues: boolean

Toggle the visibility for all studies legend values.

Default

true

paneProperties.legendProperties.showVolume​

• paneProperties.legendProperties.showVolume: boolean

Series legend volume value visibility.

Default

false

paneProperties.separatorColor​

• paneProperties.separatorColor: string

Pane separator color.

Default

'#E0E3EB'

paneProperties.topMargin​

• paneProperties.topMargin: number

Pane auto scaling top margin percentage.

Default

10

paneProperties.vertGridProperties.color​

• paneProperties.vertGridProperties.color: string

Pane vertical grid color.

Default

'rgba(42, 46, 57, 0.06)'

paneProperties.vertGridProperties.style​

• paneProperties.vertGridProperties.style: OverrideLineStyle

Pane vertical grid line style.

Default

LineStyle.Solid

priceScaleSelectionStrategyName​

• priceScaleSelectionStrategyName: "auto" | "left" | "right"

A price scale selection strategy. Determines where price scales should be placed: on the left, on the right, or spread evenly (auto).

Default

'auto'

scalesProperties.axisHighlightColor​

• scalesProperties.axisHighlightColor: string

Sets the highlight color of the scales when adding a drawing.

Default

'rgba(41, 98, 255, 0.25)'

scalesProperties.axisLineToolLabelBackgroundColorActive​

• scalesProperties.axisLineToolLabelBackgroundColorActive: string

Dynamically changes the background color of all labels on the price scale when a drawing is in motion.

Default

'#143EB3'

scalesProperties.axisLineToolLabelBackgroundColorCommon​

• scalesProperties.axisLineToolLabelBackgroundColorCommon: string

Configures the background color of a label shown on an axis scale when a drawing is selected.

Default

'#2962FF'

scalesProperties.crosshairLabelBgColorDark​

• scalesProperties.crosshairLabelBgColorDark: string

Crosshair label dark theme background color.

Default

'#363A45'

scalesProperties.crosshairLabelBgColorLight​

• scalesProperties.crosshairLabelBgColorLight: string

Crosshair label light theme background color.

Default

'#131722'

scalesProperties.fontSize​

• scalesProperties.fontSize: number

Scales (axis) font size.

Default

12

scalesProperties.lineColor​

• scalesProperties.lineColor: string

Scales (axis) border line color.

Default

'rgba(42, 46, 57, 0)'

scalesProperties.seriesLastValueMode​

• scalesProperties.seriesLastValueMode: OverridePriceAxisLastValueMode

Series last value label display mode.

Default

PriceAxisLastValueMode.LastValueAccordingToScale

scalesProperties.showBidAskLabels​

• scalesProperties.showBidAskLabels: boolean

Bid/ask labels visibility.

Default

false

scalesProperties.showPrePostMarketPriceLabel​

• scalesProperties.showPrePostMarketPriceLabel: boolean

Pre/post market price labels visibility.

Default

true

scalesProperties.showPriceScaleCrosshairLabel​

• scalesProperties.showPriceScaleCrosshairLabel: boolean

Price scale crosshair label visibility.

Default

true

scalesProperties.showSeriesLastValue​

• scalesProperties.showSeriesLastValue: boolean

Series last value label visibility.

Default

true

scalesProperties.showStudyLastValue​

• scalesProperties.showStudyLastValue: boolean

Study label value label visibility.

Default

true

scalesProperties.showStudyPlotLabels​

• scalesProperties.showStudyPlotLabels: boolean

Study plot labels visibility.

Default

false

scalesProperties.showSymbolLabels​

• scalesProperties.showSymbolLabels: boolean

Symbol name label visibility.

Default

false

scalesProperties.showTimeScaleCrosshairLabel​

• scalesProperties.showTimeScaleCrosshairLabel: boolean

Time scale crosshair label visibility.

Default

true

scalesProperties.textColor​

• scalesProperties.textColor: string

Scales (axis) text color.

Default

'#131722'

timezone​

• timezone: TimezoneId

A timezone ID. The default value depends on the locale.