Skip to main content
Version: v27

ChartPropertiesOverrides

Interface

Property overrides that can be used with IChartingLibraryWidget.applyOverrides.

Indexable

[key: string]: string | number | boolean

Override values.

Properties

crossHairProperties.color

Crosshair color.

Default

'#9598A1'

Type

string


crossHairProperties.style

Crosshair style.

Default

LineStyle.Dashed

Type

OverrideLineStyle


crossHairProperties.transparency

Crosshair transparency.

Default

0

Type

number


crossHairProperties.width

Crosshair width.

Default

1

Type

number


mainSeriesProperties.areaStyle.color1

Main series area style color1.

Default

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

Type

string


mainSeriesProperties.areaStyle.color2

Main series area style color2.

Default

"#2962FF"

Type

string


mainSeriesProperties.areaStyle.linecolor

Main series area style line color.

Default

"#2962FF"

Type

string


mainSeriesProperties.areaStyle.linestyle

Main series area style line style.

Default

LineStyle.Solid

Type

OverrideLineStyle


mainSeriesProperties.areaStyle.linewidth

Main series area style line width.

Default

2

Type

number


mainSeriesProperties.areaStyle.priceSource

Main series area style price source.

Default

"close"

Type

PriceSource


mainSeriesProperties.areaStyle.transparency

Main series area style transparency.

Default

100

Type

number


mainSeriesProperties.barStyle.barColorsOnPrevClose

Main series bar style color on previous close behaviour.

Default

false

Type

boolean


mainSeriesProperties.barStyle.dontDrawOpen

Main series bar style don't draw open behaviour.

Default

false

Type

boolean


mainSeriesProperties.barStyle.downColor

Main series bar style down color.

Default

"#F23645"

Type

string


mainSeriesProperties.barStyle.thinBars

Main series bar style thin bars behaviour.

Default

true

Type

boolean


mainSeriesProperties.barStyle.upColor

Main series bar style up color.

Default

"#089981"

Type

string


mainSeriesProperties.baselineStyle.baseLevelPercentage

Main series Baseline style base level percentage.

Default

50

Type

number


mainSeriesProperties.baselineStyle.baselineColor

Main series Baseline style baseline color.

Default

"#758696"

Type

string


mainSeriesProperties.baselineStyle.bottomFillColor1

Main series Baseline style bottom fill color1.

Default

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

Type

string


mainSeriesProperties.baselineStyle.bottomFillColor2

Main series Baseline style bottom fill color2.

Default

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

Type

string


mainSeriesProperties.baselineStyle.bottomLineColor

Main series Baseline style bottom line color.

Default

"#F23645"

Type

string


mainSeriesProperties.baselineStyle.bottomLineWidth

Main series Baseline style bottom line width.

Default

2

Type

number


mainSeriesProperties.baselineStyle.priceSource

Main series Baseline style price source.

Default

"close"

Type

PriceSource


mainSeriesProperties.baselineStyle.topFillColor1

Main series Baseline style top fill color1.

Default

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

Type

string


mainSeriesProperties.baselineStyle.topFillColor2

Main series Baseline style top fill color2.

Default

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

Type

string


mainSeriesProperties.baselineStyle.topLineColor

Main series Baseline style top line color.

Default

"#089981"

Type

string


mainSeriesProperties.baselineStyle.topLineWidth

Main series Baseline style top line width.

Default

2

Type

number


mainSeriesProperties.baselineStyle.transparency

Main series Baseline style transparency.

Default

50

Type

number


mainSeriesProperties.bidAsk.askLineColor

Color line for the ask

Default

'#F7525F'

Type

string


mainSeriesProperties.bidAsk.bidLineColor

Color line for the bid

Default

'#2962FF'

Type

string


mainSeriesProperties.bidAsk.lineStyle

Style of the line for bid & ask

Default

LineStyle.Dotted

Type

OverrideLineStyle


mainSeriesProperties.bidAsk.lineWidth

Width of the line for bid & ask

Default

1

Type

number


mainSeriesProperties.bidAsk.visible

Main series bid & ask visibility

Default

false

Type

boolean


mainSeriesProperties.candleStyle.barColorsOnPrevClose

Main series candle style color on previous close behaviour.

Default

false

Type

boolean


mainSeriesProperties.candleStyle.borderColor

Main series candle style border color.

Default

"#378658"

Type

string


mainSeriesProperties.candleStyle.borderDownColor

Main series candle style border down color.

Default

"#F23645"

Type

string


mainSeriesProperties.candleStyle.borderUpColor

Main series candle style border up color.

Default

"#089981"

Type

string


mainSeriesProperties.candleStyle.downColor

Main series candle style down color.

Default

"#F23645"

Type

string


mainSeriesProperties.candleStyle.drawBody

Main series candle style body visibility.

Default

true

Type

boolean


mainSeriesProperties.candleStyle.drawBorder

Main series candle style border visibility.

Default

true

Type

boolean


mainSeriesProperties.candleStyle.drawWick

Main series candle style wick visibility.

Default

true

Type

boolean


mainSeriesProperties.candleStyle.upColor

Main series candle style up color.

Default

"#089981"

Type

string


mainSeriesProperties.candleStyle.wickColor

Main series candle style wick color.

Default

"#737375"

Type

string


mainSeriesProperties.candleStyle.wickDownColor

Main series candle style wick down color.

Default

"#F23645"

Type

string


mainSeriesProperties.candleStyle.wickUpColor

Main series candle style wick up color.

Default

"#089981"

Type

string


mainSeriesProperties.columnStyle.barColorsOnPrevClose

Main series column style color on previous close behaviour.

Default

true

Type

boolean


mainSeriesProperties.columnStyle.downColor

Main series column style down color.

Default

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

Type

string


mainSeriesProperties.columnStyle.priceSource

Main series column style price source.

Default

"close"

Type

PriceSource


mainSeriesProperties.columnStyle.upColor

Main series column style up color.

Default

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

Type

string


mainSeriesProperties.haStyle.barColorsOnPrevClose

Main series Heikin Ashi style color on previous close behaviour.

Default

false

Type

boolean


mainSeriesProperties.haStyle.borderColor

Main series Heikin Ashi style border color.

Default

"#378658"

Type

string


mainSeriesProperties.haStyle.borderDownColor

Main series Heikin Ashi style border down color.

Default

"#F23645"

Type

string


mainSeriesProperties.haStyle.borderUpColor

Main series Heikin Ashi style border up color.

Default

"#089981"

Type

string


mainSeriesProperties.haStyle.downColor

Main series Heikin Ashi style down color.

Default

"#F23645"

Type

string


mainSeriesProperties.haStyle.drawBody

Main series Heikin Ashi style body visibility.

Default

true

Type

boolean


mainSeriesProperties.haStyle.drawBorder

Main series Heikin Ashi style border visibility.

Default

true

Type

boolean


mainSeriesProperties.haStyle.drawWick

Main series Heikin Ashi style wick visibility.

Default

true

Type

boolean


mainSeriesProperties.haStyle.upColor

Main series Heikin Ashi style up color.

Default

"#089981"

Type

string


mainSeriesProperties.haStyle.wickColor

Main series Heikin Ashi style wick color.

Default

"#737375"

Type

string


mainSeriesProperties.haStyle.wickDownColor

Main series Heikin Ashi style wick down color.

Default

"#F23645"

Type

string


mainSeriesProperties.haStyle.wickUpColor

Main series Heikin Ashi style wick up color.

Default

"#089981"

Type

string


mainSeriesProperties.highLowAvgPrice.averageClosePriceLabelVisible

Average close price lines label visibility.

Default

false

Type

boolean


mainSeriesProperties.highLowAvgPrice.averageClosePriceLineVisible

Average close price lines visibility.

Default

false

Type

boolean


mainSeriesProperties.highLowAvgPrice.averagePriceLineColor

Average close price lines color.

Default

""

Type

string


mainSeriesProperties.highLowAvgPrice.averagePriceLineWidth

Average close price lines width.

Default

1

Type

number


mainSeriesProperties.highLowAvgPrice.highLowPriceLabelsVisible

High/low price lines label visibility.

Default

false

Type

boolean


mainSeriesProperties.highLowAvgPrice.highLowPriceLinesColor

High/low price lines color.

Default

""

Type

string


mainSeriesProperties.highLowAvgPrice.highLowPriceLinesVisible

High/low price lines visibility.

Default

false

Type

boolean


mainSeriesProperties.highLowAvgPrice.highLowPriceLinesWidth

High/low price lines width.

Default

1

Type

number


mainSeriesProperties.hiloStyle.borderColor

Main series High-low style border color.

Default

"#2962FF"

Type

string


mainSeriesProperties.hiloStyle.color

Main series High-low style color.

Default

"#2962FF"

Type

string


mainSeriesProperties.hiloStyle.labelColor

Main series High-low style label color.

Default

"#2962FF"

Type

string


mainSeriesProperties.hiloStyle.showBorders

Main series High-low style border visibility.

Default

true

Type

boolean


mainSeriesProperties.hiloStyle.showLabels

Main series High-low style label visibility.

Default

true

Type

boolean


mainSeriesProperties.hlcAreaStyle.closeLineColor

Main series hlc area style close line color.

Default

"#868993"

Type

string


mainSeriesProperties.hlcAreaStyle.closeLineStyle

Main series hlc area style close line style.

Default

LineStyle.Solid

Type

OverrideLineStyle


mainSeriesProperties.hlcAreaStyle.closeLineWidth

Main series hlc area style close line width.

Default

2

Type

number


mainSeriesProperties.hlcAreaStyle.closeLowFillColor

Main series hlc area style close low fill color.

Default

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

Type

string


mainSeriesProperties.hlcAreaStyle.highCloseFillColor

Main series hlc area style high close fill color.

Default

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

Type

string


mainSeriesProperties.hlcAreaStyle.highLineColor

Main series hlc area style high line color.

Default

"#089981"

Type

string


mainSeriesProperties.hlcAreaStyle.highLineStyle

Main series hlc area style high line style.

Default

LineStyle.Solid

Type

OverrideLineStyle


mainSeriesProperties.hlcAreaStyle.highLineWidth

Main series hlc area style high line width.

Default

2

Type

number


mainSeriesProperties.hlcAreaStyle.lowLineColor

Main series hlc area style low line color.

Default

"#F23645"

Type

string


mainSeriesProperties.hlcAreaStyle.lowLineStyle

Main series hlc area style low line style.

Default

LineStyle.Solid

Type

OverrideLineStyle


mainSeriesProperties.hlcAreaStyle.lowLineWidth

Main series hlc area style low line width.

Default

2

Type

number


mainSeriesProperties.hollowCandleStyle.borderColor

Main series hollow candle style border color.

Default

"#378658"

Type

string


mainSeriesProperties.hollowCandleStyle.borderDownColor

Main series hollow candle style down color.

Default

"#F23645"

Type

string


mainSeriesProperties.hollowCandleStyle.borderUpColor

Main series hollow candle style border up color.

Default

"#089981"

Type

string


mainSeriesProperties.hollowCandleStyle.downColor

Main series hollow candle style down color.

Default

"#F23645"

Type

string


mainSeriesProperties.hollowCandleStyle.drawBody

Main series hollow candle style body visibility.

Default

true

Type

boolean


mainSeriesProperties.hollowCandleStyle.drawBorder

Main series hollow candle style border visibility.

Default

true

Type

boolean


mainSeriesProperties.hollowCandleStyle.drawWick

Main series hollow candle style wick visibility.

Default

true

Type

boolean


mainSeriesProperties.hollowCandleStyle.upColor

Main series hollow candle style up color.

Default

"#089981"

Type

string


mainSeriesProperties.hollowCandleStyle.wickColor

Main series hollow candle style wick color.

Default

"#737375"

Type

string


mainSeriesProperties.hollowCandleStyle.wickDownColor

Main series hollow candle style wick down color.

Default

"#F23645"

Type

string


mainSeriesProperties.hollowCandleStyle.wickUpColor

Main series hollow candle style wick up color.

Default

"#089981"

Type

string


mainSeriesProperties.kagiStyle.downColor

Main series Kagi style down color.

Default

"#F23645"

Type

string


mainSeriesProperties.kagiStyle.downColorProjection

Main series Kagi style down projection color.

Default

"#f5a6ae"

Type

string


mainSeriesProperties.kagiStyle.upColor

Main series Kagi style up color.

Default

"#089981"

Type

string


mainSeriesProperties.kagiStyle.upColorProjection

Main series Kagi style up projection color.

Default

"#a9dcc3"

Type

string


mainSeriesProperties.lineStyle.color

Main series line style color.

Default

"#2962FF"

Type

string


mainSeriesProperties.lineStyle.linestyle

Main series line style line style.

Default

LineStyle.Solid

Type

OverrideLineStyle


mainSeriesProperties.lineStyle.linewidth

Main series line style line width.

Default

2

Type

number


mainSeriesProperties.lineStyle.priceSource

Main series line style price source.

Default

"close"

Type

PriceSource


mainSeriesProperties.lineWithMarkersStyle.color

Main series Line With Markers style Line Color.

Default

'#2962FF'

Type

string


mainSeriesProperties.lineWithMarkersStyle.linestyle

Main series Line With Markers style Line style.

Default

LineStyle.Solid

Type

OverrideLineStyle


mainSeriesProperties.lineWithMarkersStyle.linewidth

Main series Line With Markers style Line width.

Default

2

Type

number


mainSeriesProperties.lineWithMarkersStyle.priceSource

Main series Line With Markers style Price Source.

Default

'close'

Type

string


mainSeriesProperties.minTick

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' });

Type

string


mainSeriesProperties.pbStyle.borderDownColor

Main series Line Break style border down color.

Default

"#F23645"

Type

string


mainSeriesProperties.pbStyle.borderDownColorProjection

Main series Line Break style down projection color.

Default

"#f5a6ae"

Type

string


mainSeriesProperties.pbStyle.borderUpColor

Main series Line Break style border up color.

Default

"#089981"

Type

string


mainSeriesProperties.pbStyle.borderUpColorProjection

Main series Line Break style up projection color.

Default

"#a9dcc3"

Type

string


mainSeriesProperties.pbStyle.downColor

Main series Line Break style down color.

Default

"#F23645"

Type

string


mainSeriesProperties.pbStyle.downColorProjection

Main series Line Break style down projection color.

Default

"#f5a6ae"

Type

string


mainSeriesProperties.pbStyle.upColor

Main series Line Break style up color.

Default

"#089981"

Type

string


mainSeriesProperties.pbStyle.upColorProjection

Main series Line Break style up projection color.

Default

"#a9dcc3"

Type

string


mainSeriesProperties.pnfStyle.downColor

Main series Point & Figure style down color.

Default

"#F23645"

Type

string


mainSeriesProperties.pnfStyle.downColorProjection

Main series Point & Figure style down projection color.

Default

"#f5a6ae"

Type

string


mainSeriesProperties.pnfStyle.upColor

Main series Point & Figure style up color.

Default

"#089981"

Type

string


mainSeriesProperties.pnfStyle.upColorProjection

Main series Point & Figure style up projection color.

Default

"#a9dcc3"

Type

string


mainSeriesProperties.prevClosePriceLineColor

Main series previous close price line color.

Default

"#555555"

Type

string


mainSeriesProperties.prevClosePriceLineWidth

Main series previous close price line width.

Default

1

Type

number


mainSeriesProperties.priceAxisProperties.alignLabels

Main series price axis label alignment behaviour.

Default

true

Type

boolean


mainSeriesProperties.priceAxisProperties.indexedTo100

Main series price axis indexed to 100 mode.

Default

false

Type

boolean


mainSeriesProperties.priceAxisProperties.isInverted

Main series price axis inverted mode.

Default

false

Type

boolean


mainSeriesProperties.priceAxisProperties.log

Main series price axis log mode.

Default

false

Type

boolean


mainSeriesProperties.priceAxisProperties.percentage

Main series price axis percentage mode.

Default

false

Type

boolean


mainSeriesProperties.priceLineColor

Main series price line color.

Default

""

Type

string


mainSeriesProperties.priceLineWidth

Main series price line width.

Default

1

Type

number


mainSeriesProperties.renkoStyle.borderDownColor

Main series Renko style border down color.

Default

"#F23645"

Type

string


mainSeriesProperties.renkoStyle.borderDownColorProjection

Main series Renko style down projection border color.

Default

"#f5a6ae"

Type

string


mainSeriesProperties.renkoStyle.borderUpColor

Main series Renko style border up color.

Default

"#089981"

Type

string


mainSeriesProperties.renkoStyle.borderUpColorProjection

Main series Renko style up projection border color.

Default

"#a9dcc3"

Type

string


mainSeriesProperties.renkoStyle.downColor

Main series Renko style down color.

Default

"#F23645"

Type

string


mainSeriesProperties.renkoStyle.downColorProjection

Main series Renko style down projection color.

Default

"#f5a6ae"

Type

string


mainSeriesProperties.renkoStyle.upColor

Main series Renko style up color.

Default

"#089981"

Type

string


mainSeriesProperties.renkoStyle.upColorProjection

Main series Renko style up projection color.

Default

"#a9dcc3"

Type

string


mainSeriesProperties.renkoStyle.wickDownColor

Main series Renko style wick down color.

Default

"#F23645"

Type

string


mainSeriesProperties.renkoStyle.wickUpColor

Main series Renko style wick up color.

Default

"#089981"

Type

string


mainSeriesProperties.sessionId

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'

Type

"regular" | "extended"


mainSeriesProperties.showCountdown

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

Default

false

Type

boolean


mainSeriesProperties.showPrevClosePriceLine

Main series previous close price line visibility.

Default

false

Type

boolean


mainSeriesProperties.showPriceLine

Main series price line visibility.

Default

true

Type

boolean


mainSeriesProperties.statusViewStyle.showExchange

Main series legend exchange visibility.

Default

true

Type

boolean


mainSeriesProperties.statusViewStyle.showInterval

Main series legend interval visibility.

Default

true

Type

boolean


mainSeriesProperties.statusViewStyle.symbolTextSource

Main series legend text style.

Default

"description"

Type

SeriesStatusViewSymbolTextSource


mainSeriesProperties.style

Main series chart style.

Default

ChartStyle.Candle

Type

ChartStyle


mainSeriesProperties.visible

Main series visibility.

Default

true

Type

boolean


paneProperties.background

Pane background color.

Default

'#ffffff'

Type

string


paneProperties.backgroundGradientEndColor

Pane background gradient end color.

Default

'#ffffff'

Type

string


paneProperties.backgroundGradientStartColor

Pane background gradient start color.

Default

'#ffffff'

Type

string


paneProperties.backgroundType

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

Default

'solid'

Type

ColorTypes


paneProperties.bottomMargin

Pane auto scaling bottom margin percentage.

Default

8

Type

number


paneProperties.horzGridProperties.color

Pane horizontal grid color.

Default

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

Type

string


paneProperties.horzGridProperties.style

Pane horizontal grid line style.

Default

LineStyle.Solid

Type

OverrideLineStyle


paneProperties.legendProperties.backgroundTransparency

Legend background transparency percentage.

Default

50

Type

number


paneProperties.legendProperties.showBackground

Legend background visibility.

Default

true

Type

boolean


paneProperties.legendProperties.showBarChange

Series legend change value visibility.

Default

true

Type

boolean


paneProperties.legendProperties.showSeriesOHLC

Study legend OHLC values visibility.

Default

true

Type

boolean


paneProperties.legendProperties.showSeriesTitle

Series legend title visibility.

Default

true

Type

boolean


paneProperties.legendProperties.showStudyArguments

Study legend input values visibility.

Default

true

Type

boolean


paneProperties.legendProperties.showStudyTitles

Study legend title visibility.

Default

true

Type

boolean


paneProperties.legendProperties.showStudyValues

Toggle the visibility for all studies legend values.

Default

true

Type

boolean


paneProperties.legendProperties.showVolume

Series legend volume value visibility.

Default

false

Type

boolean


paneProperties.separatorColor

Pane separator color.

Default

'#E0E3EB'

Type

string


paneProperties.topMargin

Pane auto scaling top margin percentage.

Default

10

Type

number


paneProperties.vertGridProperties.color

Pane vertical grid color.

Default

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

Type

string


paneProperties.vertGridProperties.style

Pane vertical grid line style.

Default

LineStyle.Solid

Type

OverrideLineStyle


priceScaleSelectionStrategyName

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

Default

'auto'

Type

"auto" | "left" | "right"


scalesProperties.axisHighlightColor

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

Default

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

Type

string


scalesProperties.axisLineToolLabelBackgroundColorActive

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

Default

'#143EB3'

Type

string


scalesProperties.axisLineToolLabelBackgroundColorCommon

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

Default

'#2962FF'

Type

string


scalesProperties.crosshairLabelBgColorDark

Crosshair label dark theme background color.

Default

'#363A45'

Type

string


scalesProperties.crosshairLabelBgColorLight

Crosshair label light theme background color.

Default

'#131722'

Type

string


scalesProperties.fontSize

Scales (axis) font size.

Default

12

Type

number


scalesProperties.lineColor

Scales (axis) border line color.

Default

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

Type

string


scalesProperties.seriesLastValueMode

Series last value label display mode.

Default

PriceAxisLastValueMode.LastValueAccordingToScale

Type

OverridePriceAxisLastValueMode


scalesProperties.showBidAskLabels

Bid/ask labels visibility.

Default

false

Type

boolean


scalesProperties.showPrePostMarketPriceLabel

Pre/post market price labels visibility.

Default

true

Type

boolean


scalesProperties.showPriceScaleCrosshairLabel

Price scale crosshair label visibility.

Default

true

Type

boolean


scalesProperties.showSeriesLastValue

Series last value label visibility.

Default

true

Type

boolean


scalesProperties.showStudyLastValue

Study label value label visibility.

Default

true

Type

boolean


scalesProperties.showStudyPlotLabels

Study plot labels visibility.

Default

false

Type

boolean


scalesProperties.showSymbolLabels

Symbol name label visibility.

Default

false

Type

boolean


scalesProperties.showTimeScaleCrosshairLabel

Time scale crosshair label visibility.

Default

true

Type

boolean


scalesProperties.textColor

Scales (axis) text color.

Default

'#131722'

Type

string


timezone

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

Type

TimezoneId