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​

backgrounds.postMarket.color​

backgrounds.postMarket.color: string

Post-market session highlight color. Only applies to symbols that declare a post-market subsession. See the Extended Sessions guide for more info.

Default

"#2962FF"

backgrounds.postMarket.transparency​

backgrounds.postMarket.transparency: number

Post-market session highlight transparency, a number between 0 (opaque) and 100 (fully transparent).

Default

92

backgrounds.postMarket.visible​

backgrounds.postMarket.visible: boolean

Post-market session highlight visibility.

Default

true

backgrounds.preMarket.color​

backgrounds.preMarket.color: string

Pre-market session highlight color. Only applies to symbols that declare a pre-market subsession. See the Extended Sessions guide for more info.

Default

"#FF9800"

backgrounds.preMarket.transparency​

backgrounds.preMarket.transparency: number

Pre-market session highlight transparency, a number between 0 (opaque) and 100 (fully transparent).

Default

92

backgrounds.preMarket.visible​

backgrounds.preMarket.visible: boolean

Pre-market session highlight visibility.

Default

true

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.

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.steplineStyle.color​

mainSeriesProperties.steplineStyle.color: string

Main series step line style color.

Default

"#2962FF"

mainSeriesProperties.steplineStyle.linestyle​

mainSeriesProperties.steplineStyle.linestyle: OverrideLineStyle

Main series step line style line style.

Default

LineStyle.Solid

mainSeriesProperties.steplineStyle.linewidth​

mainSeriesProperties.steplineStyle.linewidth: number

Main series step line style line width.

Default

2

mainSeriesProperties.steplineStyle.priceSource​

mainSeriesProperties.steplineStyle.priceSource: PriceSource

Main series step line style price source.

Default

"close"

mainSeriesProperties.style​

mainSeriesProperties.style: ChartStyle

Main series chart style.

Default

ChartStyle.Candle

mainSeriesProperties.svpStyle.developingPoc.color​

mainSeriesProperties.svpStyle.developingPoc.color: string

Session Volume Profile — Developing Point of Control line color. Default is theme-dependent.

mainSeriesProperties.svpStyle.developingPoc.linestyle​

mainSeriesProperties.svpStyle.developingPoc.linestyle: OverrideLineStyle

Session Volume Profile — Developing Point of Control line style.

Default

LineStyle.Solid

mainSeriesProperties.svpStyle.developingPoc.linewidth​

mainSeriesProperties.svpStyle.developingPoc.linewidth: number

Session Volume Profile — Developing Point of Control line width.

Default

1

mainSeriesProperties.svpStyle.developingPoc.visible​

mainSeriesProperties.svpStyle.developingPoc.visible: boolean

Session Volume Profile — whether the Developing Point of Control line is visible.

Default

false

mainSeriesProperties.svpStyle.developingVA.color​

mainSeriesProperties.svpStyle.developingVA.color: string

Session Volume Profile — Developing Value Area line color. Default is theme-dependent.

mainSeriesProperties.svpStyle.developingVA.linestyle​

mainSeriesProperties.svpStyle.developingVA.linestyle: OverrideLineStyle

Session Volume Profile — Developing Value Area line style.

Default

LineStyle.Solid

mainSeriesProperties.svpStyle.developingVA.linewidth​

mainSeriesProperties.svpStyle.developingVA.linewidth: number

Session Volume Profile — Developing Value Area line width.

Default

1

mainSeriesProperties.svpStyle.developingVA.visible​

mainSeriesProperties.svpStyle.developingVA.visible: boolean

Session Volume Profile — whether the Developing Value Area line is visible.

Default

false

mainSeriesProperties.svpStyle.inputs.customSession​

mainSeriesProperties.svpStyle.inputs.customSession: string

Session Volume Profile — custom session in HHMM-HHMM or HHMM-HHMM:days format.

Default

"0930-1600"

mainSeriesProperties.svpStyle.inputs.extendPocRight​

mainSeriesProperties.svpStyle.inputs.extendPocRight: boolean

Session Volume Profile — extend the Point of Control line to the right.

Default

false

mainSeriesProperties.svpStyle.inputs.extendVAHRight​

mainSeriesProperties.svpStyle.inputs.extendVAHRight: boolean

Session Volume Profile — extend the Value Area High line to the right.

Default

false

mainSeriesProperties.svpStyle.inputs.extendVALRight​

mainSeriesProperties.svpStyle.inputs.extendVALRight: boolean

Session Volume Profile — extend the Value Area Low line to the right.

Default

false

mainSeriesProperties.svpStyle.inputs.profilesSessions​

mainSeriesProperties.svpStyle.inputs.profilesSessions: "All" | "Each (pre-market, market, post-market)" | "Pre-market only" | "Market only" | "Post-market only" | "Custom"

Session Volume Profile — the sessions or session phases used to build profiles.

Default

"All"

mainSeriesProperties.svpStyle.inputs.rows​

mainSeriesProperties.svpStyle.inputs.rows: number

Session Volume Profile — row count or ticks per row, depending on rowsLayout.

Default

24

mainSeriesProperties.svpStyle.inputs.rowsLayout​

mainSeriesProperties.svpStyle.inputs.rowsLayout: "Number Of Rows" | "Ticks Per Row"

Session Volume Profile — whether rows is a row count or a number of ticks per row.

Default

"Number Of Rows"

mainSeriesProperties.svpStyle.inputs.vaVolume​

mainSeriesProperties.svpStyle.inputs.vaVolume: number

Session Volume Profile — percentage of total volume included in the Value Area.

Default

70

mainSeriesProperties.svpStyle.inputs.volume​

mainSeriesProperties.svpStyle.inputs.volume: "Up/Down" | "Total" | "Delta"

Session Volume Profile — volume display mode.

Default

"Up/Down"

mainSeriesProperties.svpStyle.poc.color​

mainSeriesProperties.svpStyle.poc.color: string

Session Volume Profile — Point of Control (POC) line color. Default is theme-dependent.

mainSeriesProperties.svpStyle.poc.linestyle​

mainSeriesProperties.svpStyle.poc.linestyle: OverrideLineStyle

Session Volume Profile — Point of Control (POC) line style.

Default

LineStyle.Solid

mainSeriesProperties.svpStyle.poc.linewidth​

mainSeriesProperties.svpStyle.poc.linewidth: number

Session Volume Profile — Point of Control (POC) line width.

Default

2

mainSeriesProperties.svpStyle.poc.visible​

mainSeriesProperties.svpStyle.poc.visible: boolean

Session Volume Profile — whether the Point of Control (POC) line is visible.

Default

true

mainSeriesProperties.svpStyle.vah.color​

mainSeriesProperties.svpStyle.vah.color: string

Session Volume Profile — Value Area High (VAH) line color. Default is theme-dependent.

mainSeriesProperties.svpStyle.vah.linestyle​

mainSeriesProperties.svpStyle.vah.linestyle: OverrideLineStyle

Session Volume Profile — Value Area High (VAH) line style.

Default

LineStyle.Dashed

mainSeriesProperties.svpStyle.vah.linewidth​

mainSeriesProperties.svpStyle.vah.linewidth: number

Session Volume Profile — Value Area High (VAH) line width.

Default

2

mainSeriesProperties.svpStyle.vah.visible​

mainSeriesProperties.svpStyle.vah.visible: boolean

Session Volume Profile — whether the Value Area High (VAH) line is visible.

Default

false

mainSeriesProperties.svpStyle.val.color​

mainSeriesProperties.svpStyle.val.color: string

Session Volume Profile — Value Area Low (VAL) line color. Default is theme-dependent.

mainSeriesProperties.svpStyle.val.linestyle​

mainSeriesProperties.svpStyle.val.linestyle: OverrideLineStyle

Session Volume Profile — Value Area Low (VAL) line style.

Default

LineStyle.Dashed

mainSeriesProperties.svpStyle.val.linewidth​

mainSeriesProperties.svpStyle.val.linewidth: number

Session Volume Profile — Value Area Low (VAL) line width.

Default

2

mainSeriesProperties.svpStyle.val.visible​

mainSeriesProperties.svpStyle.val.visible: boolean

Session Volume Profile — whether the Value Area Low (VAL) line is visible.

Default

false

mainSeriesProperties.svpStyle.volumeProfile.histogramBoxColor​

mainSeriesProperties.svpStyle.volumeProfile.histogramBoxColor: string

Session Volume Profile — background color of the session box. Default is theme-dependent.

mainSeriesProperties.svpStyle.volumeProfile.percentWidth​

mainSeriesProperties.svpStyle.volumeProfile.percentWidth: number

Session Volume Profile — width of the widest histogram bar, as a percentage of the available width.

Default

100

mainSeriesProperties.svpStyle.volumeProfile.placement​

mainSeriesProperties.svpStyle.volumeProfile.placement: "left_to_right" | "right_to_left"

Session Volume Profile — the side the histogram grows from.

Default

"left_to_right"

mainSeriesProperties.svpStyle.volumeProfile.showValues​

mainSeriesProperties.svpStyle.volumeProfile.showValues: boolean

Session Volume Profile — show the volume value label next to each histogram bar.

Default

false

mainSeriesProperties.svpStyle.volumeProfile.valueAreaColorDown​

mainSeriesProperties.svpStyle.volumeProfile.valueAreaColorDown: string

Session Volume Profile — down (sell) volume color within the Value Area. Default is theme-dependent.

mainSeriesProperties.svpStyle.volumeProfile.valueAreaColorUp​

mainSeriesProperties.svpStyle.volumeProfile.valueAreaColorUp: string

Session Volume Profile — up (buy) volume color within the Value Area. Default is theme-dependent.

mainSeriesProperties.svpStyle.volumeProfile.valuesColor​

mainSeriesProperties.svpStyle.volumeProfile.valuesColor: string

Session Volume Profile — color of the volume value labels. Default is theme-dependent.

mainSeriesProperties.svpStyle.volumeProfile.visible​

mainSeriesProperties.svpStyle.volumeProfile.visible: boolean

Session Volume Profile — whether the volume histogram is drawn.

Default

true

mainSeriesProperties.svpStyle.volumeProfile.volumeColorDown​

mainSeriesProperties.svpStyle.volumeProfile.volumeColorDown: string

Session Volume Profile — down (sell) volume histogram color. Default is theme-dependent.

mainSeriesProperties.svpStyle.volumeProfile.volumeColorUp​

mainSeriesProperties.svpStyle.volumeProfile.volumeColorUp: string

Session Volume Profile — up (buy) volume histogram color. Default is theme-dependent.

mainSeriesProperties.visible​

mainSeriesProperties.visible: boolean

Main series visibility.

Default

true

mainSeriesProperties.volCandlesStyle.barColorsOnPrevClose​

mainSeriesProperties.volCandlesStyle.barColorsOnPrevClose: boolean

Main series volume candle style color on previous close behaviour.

Default

false

mainSeriesProperties.volCandlesStyle.borderColor​

mainSeriesProperties.volCandlesStyle.borderColor: string

Main series volume candle style border color.

Default

"#378658"

mainSeriesProperties.volCandlesStyle.borderDownColor​

mainSeriesProperties.volCandlesStyle.borderDownColor: string

Main series volume candle style border down color.

Default

"#F23645"

mainSeriesProperties.volCandlesStyle.borderUpColor​

mainSeriesProperties.volCandlesStyle.borderUpColor: string

Main series volume candle style border up color.

Default

"#089981"

mainSeriesProperties.volCandlesStyle.downColor​

mainSeriesProperties.volCandlesStyle.downColor: string

Main series volume candle style down color.

Default

"#F23645"

mainSeriesProperties.volCandlesStyle.drawBody​

mainSeriesProperties.volCandlesStyle.drawBody: boolean

Main series volume candle style body visibility.

Default

true

mainSeriesProperties.volCandlesStyle.drawBorder​

mainSeriesProperties.volCandlesStyle.drawBorder: boolean

Main series volume candle style border visibility.

Default

true

mainSeriesProperties.volCandlesStyle.drawWick​

mainSeriesProperties.volCandlesStyle.drawWick: boolean

Main series volume candle style wick visibility.

Default

true

mainSeriesProperties.volCandlesStyle.upColor​

mainSeriesProperties.volCandlesStyle.upColor: string

Main series volume candle style up color.

Default

"#089981"

mainSeriesProperties.volCandlesStyle.wickColor​

mainSeriesProperties.volCandlesStyle.wickColor: string

Main series volume candle style wick color.

Default

"#737375"

mainSeriesProperties.volCandlesStyle.wickDownColor​

mainSeriesProperties.volCandlesStyle.wickDownColor: string

Main series volume candle style wick down color.

Default

"#F23645"

mainSeriesProperties.volCandlesStyle.wickUpColor​

mainSeriesProperties.volCandlesStyle.wickUpColor: string

Main series volume candle style wick up color.

Default

"#089981"

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.crossHairProperties.color​

paneProperties.crossHairProperties.color: string

Crosshair color.

Default

'#9598A1'

paneProperties.crossHairProperties.style​

paneProperties.crossHairProperties.style: OverrideLineStyle

Crosshair style.

Default

LineStyle.Dashed

paneProperties.crossHairProperties.transparency​

paneProperties.crossHairProperties.transparency: number

Crosshair transparency. To use this property, specify paneProperties.crossHairProperties.color with a hexadecimal value such as #ff0000. Otherwise, transparency is not applied.

Default

0

paneProperties.crossHairProperties.width​

paneProperties.crossHairProperties.width: number

Crosshair width.

Default

1

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.horzGridProperties.visible​

paneProperties.horzGridProperties.visible: boolean

Horizontal grid lines visibility.

Default

true

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.showLastDayChange​

paneProperties.legendProperties.showLastDayChange: boolean

Adds the ability to show daily changes in the chart legend.

Default

false

paneProperties.legendProperties.showSeriesLegendCloseOnMobile​

paneProperties.legendProperties.showSeriesLegendCloseOnMobile: boolean

Series series legend close value visibility when on mobile.

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

'#EBEBEB'

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

paneProperties.vertGridProperties.visible​

paneProperties.vertGridProperties.visible: boolean

Vertical grid lines visibility.

Default

true

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.axisHoverHighlightColor​

scalesProperties.axisHoverHighlightColor: string

Sets the color used to highlight a price scale when hovering over its label. The time scale has no hover highlight and is not affected.

The color is applied as given. Hex, rgb(), rgba(), and named colors are supported. To keep the default highlight (which follows the current theme), set this property to an empty string ''. If an unsupported color value is provided, it will also fall back to the default highlight.

Default

''

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.scaleSeriesOnly​

scalesProperties.scaleSeriesOnly: boolean

When enabled, autoscaling considers only the main series prices and ignores other series added with the Compare button.

Default

false

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.

tradingProperties.bracketsPL.display​

tradingProperties.bracketsPL.display: PlDisplay

Displayed unit for profit & loss for brackets.

Trading Platform only

tradingProperties.bracketsPL.visibility​

tradingProperties.bracketsPL.visibility: boolean

Show profit & loss for brackets.

Trading Platform only

tradingProperties.extendLeft​

tradingProperties.extendLeft: boolean

Extend lines to the left for positions and orders.

Trading Platform only

tradingProperties.horizontalAlignment​

tradingProperties.horizontalAlignment: TradedGroupHorizontalAlignment

Horizontal alignment of labels on position and order lines.

Trading Platform only

tradingProperties.lineLength​

tradingProperties.lineLength: number

Displayed lines length for positions and orders.

Trading Platform only

tradingProperties.lineWidth​

tradingProperties.lineWidth: number

Width of line for position and order lines.

Trading Platform only

tradingProperties.positionAndBracketsPL​

tradingProperties.positionAndBracketsPL: boolean

Show profit & loss for brackets and positions.

Trading Platform only

tradingProperties.positionPL.display​

tradingProperties.positionPL.display: PlDisplay

Displayed unit for profit & loss for positions.

Trading Platform only

tradingProperties.positionPL.visibility​

tradingProperties.positionPL.visibility: boolean

Show profit & loss for positions.

Trading Platform only

tradingProperties.showExecutions​

tradingProperties.showExecutions: boolean

Show executions.

Trading Platform only

tradingProperties.showExecutionsLabels​

tradingProperties.showExecutionsLabels: boolean

Show execution shapes.

Trading Platform only

tradingProperties.showOrders​

tradingProperties.showOrders: boolean

Show orders.

Trading Platform only

tradingProperties.showPositions​

tradingProperties.showPositions: boolean

Show positions.

Trading Platform only

tradingProperties.showReverse​

tradingProperties.showReverse: boolean

Show reverse position.

Trading Platform only

vertlines.sessBreaks.color​

vertlines.sessBreaks.color: string

Session breaks line color.

Default

"#4985e7"

vertlines.sessBreaks.style​

vertlines.sessBreaks.style: OverrideLineStyle

Session breaks line style.

Default

LineStyle.Dashed

vertlines.sessBreaks.visible​

vertlines.sessBreaks.visible: boolean

Session breaks line visibility.

Default

false

vertlines.sessBreaks.width​

vertlines.sessBreaks.width: number

Session breaks line width.

Default

1

volumePaneSize​

volumePaneSize: PaneSize

Size of the volume panel. Only works when volume_force_overlay featureset is disabled.

Default

PaneSize.Large