Here is a list of supported widget's methods. You can call them using widget object returned to you by widget's constructor.

Remark: Please note that it's safe to call any method only after onChartReady callback is fired. So the common practice is to do smth like

widget.onChartReady(function() {
    // now it's safe to call any other widget's methods
});

Before 1.5 Chart Methods belonged to the Widget. Please see the full list of actions here

• Subscribing To Chart Events
  • onChartReady(callback)
  • onSymbolChange(callback)
  • onIntervalChange(callback)
  • onAutoSaveNeeded(callback)
  • onBarMarkClicked(callback)
  • onTimescaleMarkClicked(callback)
  • onGrayedObjectClicked(callback)
  • onScreenshotReady(callback)
  • onTick(callback)
  • onShortcut(shortcut, callback)
  • subscribe(event, callback)
• Chart Actions
  • chart()
  • setLanguage(locale)
  • setSymbol(symbol, interval, callback)
  • remove()
  • closePopupsAndDialogs()
• Saving/Loading Charts
  • save(callback)
  • load(state)
• Custom UI Controls
  • onContextMenu(callback)
  • createButton(options)
• Getters
  • symbolInterval(callback)
  • mainSeriesPriceFormatter()
• Customization
  • addCustomCSSFile(url)
  • applyOverrides(overrides)
• 💹 Trading Platform specific
  • isFloatingTradingPanelVisible()
  • toggleFloatingTradingPanel()
  • isBottomTradingPanelVisible()
  • toggleBottomTradingPanel()
  • showSampleOrderDialog(order)
  • showSampleClosePositionDialog(position)
  • showSampleReversePositionDialog(position)
• 💹 Multiple Charts Layout
  • chart(index)
  • activeChart()
  • chartsCount()
  • layout()
  • setLayout(layout)

1. callback: function()

The Charting Library will call the callback provided once when chart is initialized and ready. You can safely call all other methods from this moment.

1. callback: function(symbolData)
2. symbolData: object {name, exchange, description, type, interval}

The Charting Library will call the callback provided every time the main series symbol changes. New symbol info will be passed as argument.

1. callback: function(interval)
2. interval: string

The Charting Library will call the callback provided every time the main series interval changes. New interval will be passed as argument.

1. callback: function()

The Library will call the callback provided every time when user changes the chart. Chart change means any user action that can be undone. The callback will not be called more than once in five seconds. See also auto_save_delay.

1. callback: function(markId)

The Library will call the callback provided every time when user clicks a mark on bar. Mark ID will be passed as an argument.

1. callback: function(markId)

The Library will call the callback provided every time when user clicks a timescale mark. Mark ID will be passed as an argument.

1. callback: function(subject)
2. subject: object {type, name} 1. type: drawing | study 2. name: string, name of a subject which was clicked

The Library will call the callback provided every time when user clicks on grayed out object. Example:

new TradingView.widget({
    drawings_access: {
        type: "black",
        tools: [
            { name: "Regression Trend" },
            { name: "Trend Angle", grayed: true },
        ]
    },
    studies_access: {
        type: "black",
        tools: [
            { name: "Aroon" },
            { name: "Balance of Power", grayed: true },
        ]
    },
    <...> // other widget settings
});

widget.onChartReady(function() {
    widget.onGrayedObjectClicked(function(data) {
        // this function will be called when one tries to
        // create Balance Of Power study or Trend Angle shape

        alert(data.name + " is grayed out!");
    })
});

1. callback: function(imageName)

The Library will call the callback provided every time when user creates a screenshot and server returns the created image name.

1. callback: function(data)

The Library will call the callback provided every time when recent bar updates.

1. shortcut
2. callback: function(data)

The Library will call the callback provided every time when shortcut is pressed.

Example:

widget.onShortcut("alt+s", function() {
  widget.executeActionById("symbolSearch");
});

1. event: can be

• toggle_sidebar - drawing toolbar is shown/hidden
• indicators_dialog - Indicators dialog is shown
• toggle_header - chart header is shown/hidden
• edit_object_dialog - Chart/Study Properties dialog is shown
• chart_load_requested - new chart about to be loaded
• chart_loaded
• 💹 layout_about_to_be_changed - amount or placement of charts about to be changed
• 💹 layout_changed - amount or placement of charts is changed
• 💹 activeChartChanged - active chart is changed

2. callback: function(arguments)

The library will call callback when GUI event is happened. Every event can have different set of arguments.

Returns a chart object that you can use to call Chart-Methods

1. locale: language code

Sets the Widget's language. For now, this call reloads the chart. Please avoid using it.

1. symbol: string
2. interval: string
3. callback: function()

Makes the chart to change its symbol and resolution. Callback is called after new symbol's data arrived.

Removes chart widget from your page.

Calling this method closes a context menu or a dialog if it is shown.

1. callback: function(object)

Saves the chart state to JS object. Charting Library will call your callback and pass the state object as argument. This call is a part of low-level save/load API.

1. state: object

Loads the chart from state object. This call is a part of low-level save/load API.

1. callback: function(unixtime, price). This callback is expected to return a value (see below).

The Library will call the callback provided every time when user opens context menu on the chart. Unix time and price of context menu point will be provided as arguments. To customize context menu items you have to return array of items descriptors. Item descriptor has following structure:

{
    position: 'top' | 'bottom',
    text: 'Menu item text',
    click: <onItemClicked callback>
}

• position: position of item in context menu
• text: text of menu item
• click: callback which will be called when user select your menu item

To add a separator use minus sign. Example: { text: "-", position: "top" }.

To remove an existing item from a menu use minus sign in front of the item text. Example: { text: "-Objects Tree..." }

Example:

widget.onChartReady(function() {
    widget.onContextMenu(function(unixtime, price) {
        return [{
            position: "top",
            text: "First top menu item, time: " + unixtime + ", price: " + price,
            click: function() { alert("First clicked."); }
        }, 
        { text: "-", position: "top" },
        { text: "-Objects Tree..." },
        {
            position: "top",
            text: "Second top menu item 2",
            click: function() { alert("Second clicked."); }
        }, {
            position: "bottom",
            text: "Bottom menu item",
            click: function() { alert("Third clicked."); }
        }];
    });

1. options: object { align: "left" }
2. align: "right" | "left". default: "left"

Creates a new DOM element in chart top toolbar and returns jQuery object for this button. You can use it to append custom controls right on the chart. Example:

widget.onChartReady(function() {
    widget.createButton()
        .attr('title', "My custom button tooltip")
        .on('click', function (e) { alert("My custom button pressed!"); })
        .append($('<span>My custom button caption</span>'));
});

1. callback: function(result)
2. result: object {symbol, interval}

Since 1.4 the function returns the result immediately. Callback is kept for compatability.

Charting Library will call your callback with an object containing chart's symbol and interval.

Returns object with method format that you can use to format prices. Introduced in 1.5.

1. url should be absolute or relative path to 'static` folder

This method was introduced in version 1.3. Starting from 1.4 use custom_css_url instead.

Introduced in Charting Library 1.5

1. overrides is an object. It is the same as overrides in Widget Constructor.

This method applies overrides to properties without reloading the chart.

The following methods are available in Trading Platform only.

This method returns true if the Floating Trading Panel is visible and false otherwise.

This method hides the Floating Trading Panel if it is visible and shows otherwise.

This method returns true if the Bottom Trading Panel is visible and false otherwise.

This method hides the Bottom Trading Panel if it is visible and shows otherwise.

1. order or 'position': object

Displays a sample order/position dialog. These dialogs look like Trading View Paper Trading ones. Usually you don't need to use sample dialogs. These methods are used in the trading sample.

1. index: index of a chart starting from 0. index is 0 by default.

Returns a chart object that you can use to call Chart-Methods

Returns current active chart object that you can use to call Chart-Methods

Returns amount of charts in the current layout

Returns current layout mode. Possible values: 4, 6, 8, s, 2h, 2-1, 2v, 3h, 3v, 3s.

1. layout: Possible values: 4, 6, 8, s, 2h, 2-1, 2v, 3h, 3v, 3s.

Changes current chart layout.

• Chart-Methods
• Charts Customization 101
• Widget Constructor
• Saving and Loading Charts
• Overriding Studies' Defaults
• Overriding Chart's Defaults