UI map
A map of the library interface. Each element links to the featuresets, overrides, CSS variables, widget options, and API methods that customize it.
Hover over the interface
All elements
Browse every customization option for the product selected above, grouped by the chart, its context menus, and its dialogs.
Pick an element on the map to open its row here, or select Show on map in a row to find the element on the map.
Chart
Top toolbar24
Show or hide5
Appearance11
- Set toolbar background colorOption
toolbar_bg - Recolor with custom themesGuide
custom_themes - Use full-size or icon-only buttonsOption
header_widget_buttons_mode - Set button text/icon colorCSS
--tv-color-toolbar-button-text - Change toolbar styleGuide
- Set toolbar background (CSS)CSS
--tv-color-pane-background - Set button text color on hoverCSS
--tv-color-toolbar-button-text-hover - Set button hover backgroundCSS
--tv-color-toolbar-button-background-hover - Set divider colorCSS
--tv-color-toolbar-divider-background - Set the page background around panelsCSS
--tv-color-platform-background - Color the dropdown menusCSS
--tv-color-popup-background
Behavior5
Symbol Search24
Show or hide6
- Hide the buttonFeatureset
header_symbol_search - Show symbol logosFeatureset
show_symbol_logos - Show spread operatorsFeatureset
show_spread_operators - Show exchange logosFeatureset
show_exchange_logos - Hide the ^ operatorFeatureset
hide_exponentiation_spread_operator - Hide the 1/x operatorFeatureset
hide_reciprocal_spread_operator
Appearance4
Behavior10
- Set the default symbolOption
symbol - Return search resultsAPI
searchSymbols - Add type and exchange filtersGuide
symbols_types - Throttle search requestsOption
symbol_search_request_delay - Allow case-sensitive inputFeatureset
uppercase_instrument_names - Disable type-to-searchFeatureset
symbol_search_hot_key - Rewrite entered symbol namesOption
symbol_search_complete - Group symbols by rootGuide
symbols_grouping - Paginate search resultsAPI
searchSymbolsPaginated - Allow arbitrary input on EnterFeatureset
allow_arbitrary_symbol_search_input
Compare13
Show or hide4
Appearance3
Behavior4
Resolution16
Show or hide5
Behavior6
- Set the default intervalOption
interval - Define the interval listGuide
supported_resolutions - Preset favorite intervalsOption
favorites - Configure resolutions in datafeedGuide
- Disable type-to-change intervalFeatureset
show_interval_dialog_on_key_press - Show bar times as providedFeatureset
disable_resolution_rebuild
Chart type14
Show or hide3
Appearance4
Indicators21
Show or hide5
Appearance3
Behavior5
API and events8
- Add an indicatorAPI
createStudy - Restyle new indicators on the flyAPI
applyStudiesOverrides - Listen for added indicatorsAPI
study - Get indicator inputsAPI
getStudyInputs - Open the dialogAPI
executeActionById("insertIndicator") - List available indicatorsAPI
getStudiesList - Save/apply indicator templatesAPI
createStudyTemplate - Listen for dialog openingAPI
indicators_dialog
Troubleshooting
Undo and redo8
Show or hide1
Save and load layout19
Show or hide1
Behavior9
- Pick a storage approachGuide
- Store layouts via REST APIOption
charts_storage_url - Use custom save/load handlersOption
save_load_adapter - Restore the last layout on startOption
load_last_chart - Autosave layoutsOption
auto_save_delay - Preload a saved layoutOption
saved_data - Store drawings separatelyFeatureset
saveload_separate_drawings_storage - Confirm overwriting same-name layoutsFeatureset
confirm_overwrite_if_chart_layout_with_name_exists - Disable the Ctrl+S shortcutFeatureset
save_shortcut
API and events9
- Save layout to an objectAPI
save - Load layout from an objectAPI
load - Save to serverAPI
saveChartToServer - Listen for autosave requestsAPI
onAutoSaveNeeded - Open the Load dialogAPI
showLoadChartDialog - Load from serverAPI
loadChartFromServer - List saved layoutsAPI
getSavedCharts - Open the Copy (Save as) dialogAPI
showSaveAsChartDialog - Get the layout nameAPI
layoutName
Quick search2
Chart settings25
Show or hide11
- Hide the gear buttonFeatureset
header_settings - Disable the Settings dialogFeatureset
show_chart_property_page - Hide all Settings pagesFeatureset
property_pages - Hide the Right margin fieldFeatureset
chart_property_page_right_margin_editor - Hide the Date format selectorFeatureset
scales_date_format - Hide the Time hours format selectorFeatureset
scales_time_hours_format - Show the Currency menuFeatureset
pricescale_currency - Show the Unit menuFeatureset
pricescale_unit - Allow right margin in %Featureset
show_percent_option_for_right_margin - Show average close price optionsFeatureset
show_average_close_price_line_and_label - Show the Inactivity gaps checkboxFeatureset
inactivity_gaps
Appearance5
Behavior5
- Understand which setting winsGuide
- Store user settings yourselfOption
settings_adapter - Don't store settings in localStorageFeatureset
use_localstorage_for_settings - Don't store chart properties locallyFeatureset
save_chart_properties_to_local_storage - Allow price scale overridesFeatureset
chart_property_page_scales
API and events4
Troubleshooting
Fullscreen6
Show or hide3
Snapshot8
Show or hide3
Drawing toolbar31
Show or hide6
- Hide the toolbarFeatureset
left_toolbar - Restrict available toolsOption
drawings_access - Collapse it on first launchFeatureset
hide_left_toolbar_by_default - Hide Add to favoritesFeatureset
items_favoriting - Keep it in fullscreenFeatureset
side_toolbar_in_fullscreen_mode - Hide the Object tree buttonFeatureset
show_object_tree
Appearance9
- Set default drawing stylesOverride
linetoolhorzline.linecolor - Recolor with custom themesGuide
custom_themes - Set toolbar background colorOption
toolbar_bg - Set button icon colorCSS
--tv-color-toolbar-button-text - Color active toggles (magnet, lock)CSS
--tv-color-toolbar-toggle-button-background-active - Override saved drawing defaultsOption
settings_overrides - Customize icons, stickers, emojisGuide
- Set active toggle text colorCSS
--tv-color-item-active-text - Color the hide/show arrowCSS
--tv-color-toolbar-hider-icon
Behavior4
API and events12
- Create a drawingAPI
createShape - Show/hide the toolbarAPI
executeActionById("drawingToolbarAction") - Select a toolAPI
selectLineTool - Hide all drawingsAPI
hideAllDrawingTools - Listen for drawing eventsGuide
- Restyle new drawings on the flyAPI
applyOverrides - Lock all drawingsAPI
lockAllDrawingTools - Toggle the magnetAPI
magnetEnabled - Set the magnet modeAPI
magnetMode - Get the selected toolAPI
selectedLineTool - Listen for tool changesAPI
onSelectedLineToolChanged - Listen for toolbar show/hideAPI
toggle_sidebar
Chart pane66
Show or hide14
- Hide vertical grid linesOverride
paneProperties.vertGridProperties.visible - Hide horizontal grid linesOverride
paneProperties.horzGridProperties.visible - Disable the pane context menuFeatureset
pane_context_menu - Hide zoom/scroll buttonsFeatureset
control_bar - Hide the main seriesOverride
mainSeriesProperties.visible - Disable all context menusFeatureset
context_menus - Show inactivity gapsFeatureset
inactivity_gaps - Hide selection markersFeatureset
source_selection_markers - Hide pop-up hintsFeatureset
popup_hints - Keep the logo on the main paneFeatureset
move_logo_to_main_pane - Show pre/post-market price linesFeatureset
pre_post_market_price_line - Show zoom/move buttons on touchFeatureset
show_zoom_and_move_buttons_on_touch - Hide the invalid-symbol imageFeatureset
hide_image_invalid_symbol - Hide logo text on small screensFeatureset
adaptive_logo
Appearance24
- Set background colorOverride
paneProperties.background - Set candle colorsOverride
mainSeriesProperties.candleStyle - Set grid colorOverride
paneProperties.vertGridProperties.color - Set crosshair colorOverride
paneProperties.crossHairProperties.color - Recolor with custom themesGuide
custom_themes - Use solid or gradient backgroundOverride
paneProperties.backgroundType - Set gradient colorsOverride
paneProperties.backgroundGradientStartColor - Set the series styleOverride
mainSeriesProperties.style - Set light or dark themeOption
theme - Change the fontOption
custom_font_family - Set grid line styleOverride
paneProperties.horzGridProperties.style - Set crosshair styleOverride
paneProperties.crossHairProperties.style - Set crosshair widthOverride
paneProperties.crossHairProperties.width - Set pane separator colorOverride
paneProperties.separatorColor - Set top/bottom autoscale marginsOverride
paneProperties.topMargin - Show bid/ask linesOverride
mainSeriesProperties.bidAsk.visible - Show high/low linesOverride
mainSeriesProperties.highLowAvgPrice.highLowPriceLinesVisible - Show previous close lineOverride
mainSeriesProperties.showPrevClosePriceLine - Color pre/post-market sessionsOverride
backgrounds.preMarket.color - Show session breaksOverride
vertlines.sessBreaks.visible - Color the loading spinnerOption
loading_screen - Remove chart paddingFeatureset
border_around_the_chart - Allow two-letter bar marksFeatureset
two_character_bar_marks_labels - Set bar mark tooltip backgroundCSS
--tv-color-bar-mark-background-color
Behavior13
- Disable scrollingFeatureset
chart_scroll - Disable zoomingFeatureset
chart_zoom - Customize the context menuOption
context_menu - Disable wheel scrollingFeatureset
mouse_wheel_scroll - Disable wheel scalingFeatureset
mouse_wheel_scale - Disable drag scrollingFeatureset
pressed_mouse_move_scroll - Disable pinch zoomFeatureset
pinch_scale - Let page scroll on horizontal swipeFeatureset
horz_touch_drag_scroll - Let page scroll on vertical swipeFeatureset
vert_touch_drag_scroll - Disable long-press tooltipFeatureset
long_press_floating_tooltip - Allow zooming to one barFeatureset
low_density_bars - Open mark tooltips on clickFeatureset
pin_bar_mark_tooltips_on_click - Enable drag-to-exportFeatureset
chart_drag_export
API and events15
- Change one chart's propertiesAPI
applyOverrides - Set watermark color and partsAPI
watermark - Switch theme at runtimeAPI
changeTheme - Listen for crosshair movesAPI
crossHairMoved - Add context menu itemsAPI
onContextMenu - Restyle the series on the flyAPI
setChartStyleProperties - Show/hide the seriesAPI
setVisible - Use custom watermark textAPI
setContentProvider - Listen for data loadsAPI
onDataLoaded - Show marks on barsGuide
supports_marks - Listen for mark clicksAPI
onMarkClick - Toggle inactivity gapsAPI
inactivityGaps - Toggle scrollingAPI
setScrollEnabled - Toggle zoomingAPI
setZoomEnabled - Turn on drag-to-exportAPI
setDragExportEnabled
Legend48
Show or hide22
- Hide the legendFeatureset
legend_widget - Hide all legend buttonsFeatureset
edit_buttons_in_legend - Hide the intervalFeatureset
hide_resolution_in_legend - Hide the market statusFeatureset
display_market_status - Show the symbol logoFeatureset
show_symbol_logo_in_legend - Hide the legend on one chartOverride
paneProperties.legendProperties.showLegend - Disable the context menuFeatureset
legend_context_menu - Hide the Hide/Show buttonFeatureset
show_hide_button_in_legend - Hide the Settings buttonFeatureset
format_button_in_legend - Hide the Remove buttonFeatureset
delete_button_in_legend - Hide Symbol InfoFeatureset
symbol_info - Show the Data is delayed noticeFeatureset
display_data_mode - Show logos for compared symbolsFeatureset
show_symbol_logo_for_compare_studies - Show long descriptionsFeatureset
symbol_info_long_description - Show the price sourceFeatureset
symbol_info_price_source - Hide the Object tree buttonFeatureset
object_tree_legend_mode - Hide unresolved symbolsFeatureset
hide_unresolved_symbols_in_legend - Show main symbol in indicator inputsFeatureset
hide_main_series_symbol_from_indicator_legend - Hide boolean indicator inputsFeatureset
dont_show_boolean_study_arguments - Hide last N/A indicator valuesFeatureset
hide_last_na_study_output - Keep symbol inputs visibleFeatureset
always_show_study_symbol_input_values_in_legend - Always show values on mobileFeatureset
always_show_legend_values_on_mobile
Appearance19
- Choose ticker, name, or descriptionOverride
mainSeriesProperties.statusViewStyle.symbolTextSource - Hide OHLC valuesOverride
paneProperties.legendProperties.showSeriesOHLC - Hide volumeOverride
paneProperties.legendProperties.showVolume - Hide indicator inputsOverride
paneProperties.legendProperties.showStudyArguments - Toggle the backgroundOverride
paneProperties.legendProperties.showBackground - Hide bar changeOverride
paneProperties.legendProperties.showBarChange - Hide indicator valuesOverride
paneProperties.legendProperties.showStudyValues - Hide indicator titlesOverride
paneProperties.legendProperties.showStudyTitles - Hide the series titleOverride
paneProperties.legendProperties.showSeriesTitle - Hide the exchangeOverride
mainSeriesProperties.statusViewStyle.showExchange - Hide the interval (override)Override
mainSeriesProperties.statusViewStyle.showInterval - Set background transparencyOverride
paneProperties.legendProperties.backgroundTransparency - Hide close value on mobileOverride
paneProperties.legendProperties.showSeriesLegendCloseOnMobile - Provide symbol logosGuide
logo_urls - Change the decimal signOption
numeric_formatting - Color change by signFeatureset
legend_bar_change_colors_based_on_value - Show N/A instead of ∅Featureset
use_na_string_for_not_available_values - Apply ticker/description mode to indicator inputsFeatureset
study_symbol_ticker_description - Apply ticker/description mode to compareFeatureset
study_overlay_compare_legend_option
Behavior5
- Disable in-place editingFeatureset
legend_inplace_edit - Disable in-place symbol changeFeatureset
disable_legend_inplace_symbol_change - Disable in-place interval changeFeatureset
disable_legend_inplace_resolution_change - Show values of last visible barFeatureset
use_last_visible_bar_value_in_legend - Customize the market status pop-upGuide
Market status5
Appearance2
API and events1
Volume6
Appearance3
Price scale43
Show or hide10
- Hide the scale settings buttonFeatureset
main_series_scale_menu - Disable the context menuFeatureset
scales_context_menu - Hide when all its sources are hiddenFeatureset
hide_price_scale_if_all_sources_hidden - Hide Countdown to bar close optionFeatureset
countdown - Show the currencyFeatureset
pricescale_currency - Show the unitFeatureset
pricescale_unit - Hide off-screen last price labelFeatureset
hide_price_scale_global_last_bar_value - Hide the exchange labelFeatureset
hide_object_tree_and_price_scale_exchange_label - Hide partially visible labelsFeatureset
cropped_tick_marks - Keep the scale on errorsFeatureset
clear_price_scale_on_error_or_empty_bars
Appearance22
- Set text colorOverride
scalesProperties.textColor - Set font sizeOverride
scalesProperties.fontSize - Move the scale left/rightOverride
priceScaleSelectionStrategyName - Set the price formatGuide
pricescale - Set border line colorOverride
scalesProperties.lineColor - Show symbol name labelOverride
scalesProperties.showSymbolLabels - Format prices yourselfOption
custom_formatters - Change the decimal signOption
numeric_formatting - Change price precisionOverride
mainSeriesProperties.minTick - Toggle indicator value labelsOverride
scalesProperties.showStudyLastValue - Show indicator plot labelsOverride
scalesProperties.showStudyPlotLabels - Show bid/ask labelsOverride
scalesProperties.showBidAskLabels - Show high/low labelsOverride
mainSeriesProperties.highLowAvgPrice.highLowPriceLabelsVisible - Toggle crosshair labelOverride
scalesProperties.showPriceScaleCrosshairLabel - Set crosshair label colorOverride
scalesProperties.crosshairLabelBgColorLight - Align labelsOverride
mainSeriesProperties.priceAxisProperties.alignLabels - Show pre/post-market labelOverride
scalesProperties.showPrePostMarketPriceLabel - Show average close labelOverride
mainSeriesProperties.highLowAvgPrice.averageClosePriceLabelVisible - Color drawing labelsOverride
scalesProperties.axisLineToolLabelBackgroundColorCommon - Set drawing highlight colorOverride
scalesProperties.axisHighlightColor - Set hover highlight colorOverride
scalesProperties.axisHoverHighlightColor - Change the fontOption
custom_font_family
Behavior5
Last price label6
Show or hide2
Appearance3
Time scale28
Show or hide3
Appearance6
Behavior10
- Set minimum bar spacingOption
time_scale - Stop scrolling past first barFeatureset
fix_left_edge - Don't scroll on new barsFeatureset
shift_visible_range_on_new_bar - Keep range on resizeFeatureset
lock_visible_time_range_on_resize - Change the zoom anchorFeatureset
right_bar_stays_on_scroll - Disable drag-to-scaleFeatureset
axis_pressed_mouse_move_scale - Let indicators extend the scaleFeatureset
studies_extend_time_scale - Let added series extend the scaleFeatureset
secondary_series_extend_time_scale - Keep range when changing % marginFeatureset
lock_visible_time_range_when_adjusting_percentage_right_margin - Show extended sessionsGuide
API and events9
- Set the visible rangeAPI
setVisibleRange - Listen for range changesAPI
onVisibleRangeChanged - Get the visible rangeAPI
getVisibleRange - Get the time scale APIAPI
getTimeScale - Set bar spacingAPI
setBarSpacing - Set the right offsetAPI
setRightOffset - Set the default right marginAPI
defaultRightOffset - Reset the time scaleAPI
executeActionById("timeScaleReset") - Listen for time scale mark clicksAPI
onTimescaleMarkClick
Troubleshooting
Price scale settings button2
Bottom toolbar14
Show or hide4
Appearance8
- Set toolbar background colorOption
toolbar_bg - Recolor with custom themesGuide
custom_themes - Change toolbar styleGuide
- Set toolbar backgroundCSS
--tv-color-pane-background - Set button text/icon colorCSS
--tv-color-toolbar-button-text - Set button text color on hoverCSS
--tv-color-toolbar-button-text-hover - Set button hover backgroundCSS
--tv-color-toolbar-button-background-hover - Set divider colorCSS
--tv-color-toolbar-divider-background
Time frames8
Show or hide2
Appearance1
Time zone7
Show or hide1
Behavior3
Scale modes10
Show or hide1
Behavior4
Context menu · Chart pane
Pane context menu10
Show or hide2
Behavior4
Copy price1
Paste3
Show or hide1
Behavior1
Lock vertical cursor line by time1
Table view1
API and events1
Object tree4
Remove indicators3
Hide marks on bars4
Context menu · Price scale
Price scale context menu11
Show or hide2
Behavior5
Auto (fits data to screen)3
Lock price to bar ratio3
Scale price chart only3
Invert scale5
Regular3
Percent4
Indexed to 1004
Logarithmic4
Move scale to left4
Labels12
Appearance7
- Symbol last value labelOverride
scalesProperties.showSeriesLastValue - Symbol name labelOverride
scalesProperties.showSymbolLabels - Indicator value labelsOverride
scalesProperties.showStudyLastValue - Indicator name labelsOverride
scalesProperties.showStudyPlotLabels - Bid/ask labelsOverride
scalesProperties.showBidAskLabels - High/low labelsOverride
mainSeriesProperties.highLowAvgPrice.highLowPriceLabelsVisible - No overlapping labelsOverride
mainSeriesProperties.priceAxisProperties.alignLabels
API and events5
- Toggle last value labelAPI
executeActionById("showSeriesLastValue") - Toggle symbol name labelAPI
executeActionById("showSymbolLabelsAction") - Toggle indicator value labelsAPI
executeActionById("showStudyLastValue") - Toggle indicator name labelsAPI
executeActionById("showStudyPlotNamesAction") - Match it in items_processorAPI
ActionId.ChartPriceScaleLabels
Lines6
Appearance5
- Last price lineOverride
mainSeriesProperties.showPriceLine - Bid/ask linesOverride
mainSeriesProperties.bidAsk.visible - High/low linesOverride
mainSeriesProperties.highLowAvgPrice.highLowPriceLinesVisible - Previous close lineOverride
mainSeriesProperties.showPrevClosePriceLine - Enable pre/post-market linesFeatureset
pre_post_market_price_line
API and events1
Plus button4
Context menu · Legend
Legend context menu12
Show or hide3
Behavior5
Symbol title4
Open market status3
Chart values3
Bar change values4
Volume3
Indicator titles3
Indicator inputs4
Indicator values4
Symbol Search
Symbol Search dialog11
Appearance2
Behavior6
Search field8
Show or hide3
Behavior5
- Allow case-sensitive inputFeatureset
uppercase_instrument_names - Throttle search requestsOption
symbol_search_request_delay - Rewrite entered symbol namesOption
symbol_search_complete - Allow arbitrary input on EnterFeatureset
allow_arbitrary_symbol_search_input - Disable type-to-searchFeatureset
symbol_search_hot_key
Symbol type filter5
Sources filter7
Search result13
Show or hide2
Appearance8
- Set the symbol nameAPI
symbol - Set the descriptionAPI
description - Set the exchangeAPI
exchange - Set the symbol typeAPI
type - Provide symbol logo URLsAPI
logo_urls - Provide the exchange logo URLAPI
exchange_logo - Set result item backgroundCSS
--tv-color-symbol-search-background - Set matched-text colorCSS
--tv-color-symbol-search-highlighted-text
Type-to-search hint2
Indicators
Indicators dialog12
Show or hide3
Appearance2
Behavior4
Indicators list8
Show or hide2
Appearance2
Behavior3
API and events1
Indicator search3
Indicator item8
Show or hide1
Appearance3
Settings · Symbol
Template1
Color bars based on previous close3
Body5
Borders5
Appearance4
API and events1
Wick5
Appearance4
API and events1
Precision3
Settings · Status line
Template1
Title3
Open market status3
Chart values3
Bar change values3
Volume2
Titles2
Inputs4
Values3
Settings · Scales and lines
Template1
Scale modes (A and L)2
Lock price to bar ratio4
Scales placement2
No overlapping labels2
Plus button3
Countdown to bar close4
Symbol8
Appearance6
- Show the value labelOverride
scalesProperties.showSeriesLastValue - Show the price lineOverride
mainSeriesProperties.showPriceLine - Set the line colorOverride
mainSeriesProperties.priceLineColor - Set the value modeOverride
scalesProperties.seriesLastValueMode - Set the line widthOverride
mainSeriesProperties.priceLineWidth - Show the symbol name labelOverride
scalesProperties.showSymbolLabels
Indicators and financials4
High and low5
Appearance4
- Show the linesOverride
mainSeriesProperties.highLowAvgPrice.highLowPriceLinesVisible - Show the labelsOverride
mainSeriesProperties.highLowAvgPrice.highLowPriceLabelsVisible - Set the colorOverride
mainSeriesProperties.highLowAvgPrice.highLowPriceLinesColor - Set the widthOverride
mainSeriesProperties.highLowAvgPrice.highLowPriceLinesWidth