Here is a list of supported chart's methods.

Before 1.4 version. You can call these methods using widget object returned to you by widget's constructor.

Since 1.5 version. You can call these methods using chart object returned to you by widget's methods chart(index) or activeChart().

• Subscribing To Chart Events
  • onDataLoaded()
  • onSymbolChanged()
  • dataReady(callback)
  • crossHairMoved(callback)
• Chart Actions
  • setVisibleRange(range, callback)
  • setSymbol(symbol, callback)
  • setResolution(resolution, callback)
  • executeAction(action)
  • executeActionById(action)
  • refreshMarks()
  • clearMarks()
  • setChartType(type)
• Studies And Shapes
  • createStudy(name, forceOverlay, lock, inputs, callback, overrides)
  • createShape(point, options, callback)
  • createMultipointShape(points, options, callback)
  • removeEntity(entityId)
  • createVerticalLine(point, options)
  • removeAllShapes()
  • removeAllStudies()
• Study Templates
  • createStudyTemplate(options, callback)
  • applyStudyTemplate(template)
• Trading Primitives
  • createOrderLine()
  • createPositionLine()
  • createExecutionShape()
• Getters
  • symbol()
  • resolution()
  • getVisibleRange()
  • priceFormatter()

You can subscribe using Subscription object returned by this function to be notified when new history bars are loaded and unsubscribe from the event.

You can subscribe using Subscription object returned by this function to be notified when the symbol is changed and unsubscribe from the event.

1. callback: function(interval)

The Charting Library will call the callback provided immediately if bars are already loaded or when the bars are received. The function returns true if bars are already loaded and false otherwise.

Since 1.5 version.

1. callback: function({time, price})

The Charting Library will call the callback every time the crosshair position is changed.

1. range: object, {from to}
2. from, to: unix timestamps, UTC
3. callback: function(). The Library will call it after it's done with the viewport setup.

Forces the chart to adjust its parameters (scroll, scale) to make the selected time period fit the view port. Neither from, nor to must not be in future. This method was introduced in version 1.2.

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

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

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

Makes the chart to change its resolution. Callback is called after new data arrived.

deprecated, use executeActionById instead

1. action: string

Executes any action from chart's context menu (the menu which is popped up when one right-clicks the empty space on a main pane) by its name. Use names as you see them in English localization. Examples:

// < ... >
widget.chart().executeAction("Insert Indicator..."); // calling this will show `Insert Study` dialog
// < ... >
widget.chart().executeAction("Hide All Drawing Tools"); // this will toggle all shapes visibility
// < ... >

since version 1.3

1. actionId: string

Executes an action by its id.

Showing a dialog

chartProperties 
compareOrAdd
scalesProperties
tmzProperties 
paneObjectTree
insertIndicator 
symbolSearch
changeInterval

Other actions

timeScaleReset
chartReset
seriesHide
studyHide 
lineToggleLock
lineHide 
showLeftAxis
showRightAxis
scaleSeriesOnly
drawingToolbarAction
magnetAction
stayInDrawingModeAction
lockDrawingsAction
hideAllDrawingsAction 
hideAllMarks 
showCountdown 
showSeriesLastValue
showSymbolLabelsAction
showStudyLastValue
showStudyPlotNamesAction
undo
redo
takeScreenshot
paneRemoveAllStudiesDrawingTools

Examples:

// < ... >
widget.chart().executeActionById("undo");
// < ... >
widget.chart().executeActionById("drawingToolbarAction"); // hides or shows the drawing toolbar
// < ... >

Calling this method makes the Library to request visible marks once again.

Calling this method makes the Library to remove all visible marks.

1. type: TradingView.BARS | TradingView.CANDLES | TradingView.AREA | TradingView.LINE | TradingView.HEIKEN_ASHI | TradingView.HOLLOW_CANDLES

Sets the main series style.

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

1. name: string, a name of an indicator as you can see it in Indicators widget
2. forceOverlay: forces the Charting Library to place the created study on main pane
3. lock: boolean, shows whether a user will be able to remove/change/hide your study or not
4. inputs: (since version 1.2) an array of study inputs. This array is expected to contain just inputs values in the same order they are printed in study's properties page.
5. callback: function(entityId)
6. overrides: (since version 1.2) an object containing properties you'd like to set for your new study. Note: you should not specify study name: start a property path with a plot name.

Creates the study on a main symbol. Examples:

• createStudy('MACD', false, false, [14, 30, 9])
• createStudy('Moving Average Exponential', false, false, [26])
• createStudy('Stochastic', false, false, [26], null, {"%d.color" : "#FF0000"})

Remark: Compare study has 2 inputs: [dataSource, symbol]. Supported dataSource values: ["close", "high", "low", "open"].

Remark 2: You actually use Overlay study when choose to Add a series on the chart. This study has the single input -- symbol. Here is an example how to add a symbol:

    widget.chart().createStudy('Overlay', false, false, ['AAPL']);

Remark 3: You actually also use Compare study when choose to compare a series. This study has two inputs -- source and symbol. Here is an example how to add a compare series:

    widget.chart().createStudy('Compare', false, false, ["open", 'AAPL']);

1. point: object {time, [price], [channel]}
2. time: unix time. The only mandatory argument.
3. price: If you specify price, then your icon will be placed on its level. If you do not, then the icon sticks to bar at respective time.
4. channel: The price level to stick to is specified by channel argument (open, high, low, close). If no channel is specified, 'open' is a default.
5. options: object {shape, [text], [lock], [overrides]}
6. shape may be one of the ['arrow_up', 'arrow_down', 'flag', 'vertical_line', 'horizontal_line']. 'flag' is the default value.
7. text is an optional argument. It's the text that will be assigned to shape if it can contain a text.
8. lock shows whether a user will be able to remove/change/hide your shape or not.
9. disableSelection (since 1.3) prevents selecting of the shape
10. disableSave (since 1.3) prevents saving the shape with a chart
11. disableUndo (since 1.4) prevents adding of the action to the undo stack
12. overrides (since 1.2). It is an object containing properties you'd like to set for your new shape.
13. zOrder (since 1.3) may be one of the [top, bottom]. top puts the line tool on top of all other sources, bottom puts the line tool below all other sources. If it is not specified the line tool is placed above all existing line tools.
14. callback: function(entityId)

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

This call creates a shape at specified point on main series.

1. points: an array of objects [{time, [price], [channel]},...]
2. time: unix time. The only mandatory argument.
3. price: If you specify price, then your icon will be placed on its level. If you do not, then the icon sticks to bar at respective time.
4. channel: The price level to stick to is specified by channel argument (open, high, low, close). If no channel is specified, 'open' is a default.
5. options: object {shape, [text], [lock], [overrides]}
6. shape may be one of the identifiers
7. text is an optional argument. It's the text that will be assigned to shape if it can contain a text.
8. lock shows whether a user will be able to remove/change/hide your shape or not.
9. disableSelection (since 1.3) prevents selecting of the shape
10. disableSave (since 1.3) prevents saving the shape with a chart
11. disableUndo (since 1.4) prevents adding of the action to the undo stack
12. overrides. It is an object containing properties you'd like to set for your new shape.
13. zOrder (since 1.3) may be one of the [top, bottom]. top puts the line tool on top of all other sources, bottom puts the line tool below all other sources. If it is not specified the line tool is placed above all existing line tools.
14. callback: function(entityId)

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

Look Shapes and Overrides for more information.

This call creates a shape with specified points on main series.

1. entityId: object. Value which was passed to your callback after the entity (shape of study) was created.

Removes the specified entity.

1. point: object {time}
2. options: obejct {lock}

This function is a synonym for createShape with shape = 'vertical_line'. It is treated as obsolete.

Removes all shapes (drawings) from the chart.

Removed all studies from the chart.

1. options: object {saveInterval}
2. saveInterval: boolean
3. callback: function(data)

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

Saves the study template 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. template: object

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

Creates a new order on the chart and returns an API-object which you can use to control the order properties and behavior. It's strongly recommended to read this article before using this call.

Arguments (since 1.4): options is an object with one possible key: disableUndo which can be true or false. For compatability reasons the default value is false.

API object methods:

• remove(): Removes the position from the chart. You can’t use API-object after this call.
• onModify(callback) / onModify(data, callback)
• onMove(callback) / onMove(data, callback)

API object has a set of properties listed below. Each property should be used through respective accessors. I.e., if you want to work with Extend Left property, use getExtendLeft() of setExtendLeft() methods.

General properties:

Connection line properties:

Fonts:

Colors:

Example:

widget.chart().createOrderLine()
    .onMove(function() {
        this.setText("onMove called");
    })
    .onModify("onModify called", function(text) {
        this.setText(text);
    })
    .onCancel("onCancel called", function(text) {
        this.setText(text);
    })
    .setText("STOP: 73.5 (5,64%)")
    .setQuantity("2");

Creates a new position on the chart and returns an API-object which you can use to control the position properties and behavior. It's strongly recommended to read this article before using this call.

Arguments (since 1.4): options is an object with one possible key: disableUndo which can be true or false. For compatability reasons the default value is false.

API object methods:

• remove(): Removes the position from the chart. You can’t use API-object after this call.
• onClose(callback) / onClose(data, callback)
• onModify(callback) / onModify(data, callback)
• onReverse(callback) / onReverse(data, callback)

API object has a set of properties listed below. Each property should be used through respective accessors. I.e., if you want to work with Extend Left property, use getExtendLeft() of setExtendLeft() methods.

General properties:

Connection line properties:

Fonts:

Colors:

Example:

widget.chart().createPositionLine()
    .onModify(function() {
        this.setText("onModify called");
    })
    .onReverse("onReverse called", function(text) {
        this.setText(text);
    })
    .onClose("onClose called", function(text) {
        this.setText(text);
    })
    .setText("PROFIT: 71.1 (3.31%)")
    .setQuantity("8.235")
    .setPrice(15.5)
    .setExtendLeft(false)
.setLineStyle(0)
.setLineLength(25);

Creates a new execution on the chart and returns an API-object which you can use to control the execution properties. It's strongly recommended to read this article before using this call.

Arguments (since 1.4): options is an object with one possible key: disableUndo which can be true or false. For compatability reasons the default value is false.

API object has a set of properties listed below. Each property should be used through respective accessors. I.e., if you want to work with Extend Left property, use getExtendLeft() of setExtendLeft() methods.

API object methods:

• remove(): Removes the execution shape from the chart. You can’t use API-object after this call.

General properties:

Fonts:

Colors:

Example:

widget.chart().createExecutionShape()
    .setText("@1,320.75 Limit Buy 1")
    .setTooltip("@1,320.75 Limit Buy 1")
    .setTextColor("rgba(0,255,0,0.5)")
    .setArrowColor("#0F0")
    .setDirection("buy")
    .setTime(1413559061758)
    .setPrice(15.5);

Returns chart's symbol.

Returns chart's resolution.

Returns object {from, to}. from and to are Unit timestamps in the timezone of chart.

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

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