Skip to content

Latest commit

 

History

History
351 lines (210 loc) · 23.1 KB

Breaking-Changes.md

File metadata and controls

351 lines (210 loc) · 23.1 KB

We do our best to make every next version fully compatible with the previous one, but sometimes big changes require you to make minor changes in your code when upgrading to a new version.

Note: you can check the Charting Library version by executing TradingView.version() in a browser console.

Here is the list of breaking changes:

Version 22

  • Methods getTimezone and setTimezone have been deprecated and will be removed in future versions. Use getTimezoneApi instead.

  • POST request data format sent to snapshot_url has been changed. Since this version this request contains multipart/form-data with the field preparedImage that represents binary data of the snapshot image in image/png format.

  • Optional inputs arguments for createStudy has been changed from using an array of ordered values to an object with named properties. You can still use array-like inputs but it will be removed in further releases.

  • The set of inputs for Moving Average study has been changed and the first input now is a symbol. If you used createStudy to create Moving Average study you will have to modify the list of inputs by simply adding an empty string as the first element:

    tvWidget.activeChart().createStudy('Moving Average', true, false, ['', 9]);

    instead of

    tvWidget.activeChart().createStudy('Moving Average', true, false, [9]);

  • Study Ichimoku has been modified with some Inputs & Style properties renamed.

Trading Terminal

  • The watchList method now returns a promise that resolves a watchlist API object when the watchlist widget has loaded.

  • suggestedQty has been removed from the Trading Host.

Version 21

  • Featureset show_dialog_on_snapshot_ready has been removed. takeScreenshot makes a snapshot silently, so you can use the URL from onScreenshotReady callback to show your own dialog instead.

  • Field holidays from SymbolInfo has been renamed to session_holidays.

  • changeTheme from Widget Methods now returns a Promise. You can apply other style modifications after the promise is fulfilled.

  • Symbol type bitcoin has been renamed to crypto.

  • The symbol search dialog suggestions list uses the full_name instead of the exchange and symbol value. This data is provided by your implementation of searchSymbols.

Trading Terminal

  • supportModifyOrder flag has been marked deprecated and will be removed in future versions. Use supportModifyOrderPrice, supportEditAmount and supportModifyBrackets instead.

  • empty formatter has been removed.

  • Flag durationForMarketOrders has been removed from Broker Configuration configFlags object. To use duration with market orders, add appropriate order type to supportedOrderTypes array.

  • supportReducePosition flag has been removed from the Broker Configuration configFlags object.

  • supportExecutions flag has been added. If broker supports executions you need to set the flag to true.

  • The default value of asc field of the SortingParameters has been changed to true.

  • The customFormatters field has been removed from the accountManagerInfo.

  • id, modificationProperty, fixedWidth, showOnMobile and showTooltipOnCell fields have been removed from the Account Manager column description. The property field has been made mandatory, so you can use it instead of id.

  • The string id field has been made mandatory in each table row.

  • The return value of the method placeOrder in the Broker API has been changed from Promise<void> to Promise<PlaceOrderResult>.

  • contextMenuEvent type in contextMenuActions in AccountManagerInfo interface has been changed from MouseEvent to MouseEvent | TouchEvent.

  • The shape of the news_provider property in the Widget Constructor options has changed. The is_news_generic and get_news properties have been replaced with a single function.

Version 20

  • Featureset caption_buttons_text_if_possible has been removed and has been replaced by a new parameter header_widget_buttons_mode

  • Featureset high_density_bars has been removed and replaced by min_bar_spacing, a new parameter for time_scale.

  • Study Moving Average Modified has been removed. Use Smoothed Moving Average instead. Note that the default value for length input is different.

Trading Terminal

  • unixTimeAgo formatter has been removed.

  • Account Manager format function's property $container: JQuery has been replaced with container: HTMLElement. Format function returns string | HTMLElement instead of string | JQuery.

  • Options showOrderPanel, showDOM and showSellBuyButtons have been removed from the defaultDropdownMenuActions options list.

  • The return value of the method getOrderDialogOptions has been made a Promise.

  • Trading Host symbolSnapshot method has been removed.

  • cancellingBracketCancelsParentOrder and cancellingOnePositionBracketsCancelsOther flags have been removed. They can be partially replaced with the supportCancellingBothBracketsOnly flag.

Version 19

Note: container_id has been marked deprecated. It's now preferable to switch to/use container instead. Container can now be either still be an id or be an HTMLElement you'd like the widget to be attached to.

  • crossHairMoved has been changed from a callback parameter to crossHairMoved() with a Subscription model. It will still return the same object params: {time, price}.

  • force_session_rebuild field in the symbol info has been removed

  • Count and type of getBars arguments has been changed - from, to and firstDataRequest arguments have been combined into the periodParams object. To quickly switch to the new version, you need to replace the following code

        // ...

    getBars(symbolInfo, resolution, from, to, onHistoryCallback, onErrorCallback, firstDataRequest) {
        // your code here
    }

    // ...

    with the following code:

        // ...

    getBars(symbolInfo, resolution, periodParams, onHistoryCallback, onErrorCallback) {
        let { from, to, firstDataRequest } = periodParams;
        // your code here
    }

    // ...

  • The to date in getBars is not inclusive from now. The from date is still inclusive. It means that you don't need to include bars with time == to in the response.

  • Arguments of ctx.new_sym method in custom indicators have been changed and now you don't need to pass the third argument (it might break the indicator). To quickly fix this up, find all use cases for the new_sym method and make sure that only 2 arguments are passed to it (instead of three or more). For example, if you previously had ctx.new_sym(newSym, PineJS.Std.period(this._context), PineJS.Std.period(this._context)), you need to replace it with ctx.new_sym(newSym, PineJS.Std.period(this._context)).

  • calculateHistoryDepth method from JS-Api has been removed. Consider switching to usage of countBack instead.

Trading Terminal

  • The default value of the supportPLUpdate flag has been changed to true.

  • Trading Host defaultDropdownMenuActions options have been changed. Options selectAnotherBroker and disconnect have been removed.

  • The return value of the method buttonDropdownActions in the Trading Host has been changed from BindPopupMenuActionDescription[] to array of ActionMetaInfo.

  • The orderDialogOptions object has been removed from the Broker's Configuration. Please use the getOrderDialogOptions method to customize the Order dialog.

  • The className field has been removed from the Account Manager column description. Use the alignment field to control the alignment of the cell value.

Version 18

Trading Terminal

  • contextMenuEvent type in contextMenuActions in AccountManagerInfo interface has been changed from JQueryEventObject to MouseEvent.

  • accountsList and account have been removed from Account Manager Info. They have been replaced with methods currentAccount, setCurrentAccount and accountsMetainfo in broker's API.

  • Method fullUpdate in the Trading Host has been renamed to currentAccountUpdate.

  • Method showClosePositionDialog has been removed.

  • Trading Host method floatingTradingPanelVisibility has been renamed to sellBuyButtonsVisibility.

  • Trading Host defaultDropdownMenuActions options have been changed. Option showFloatingToolbar has been renamed to showSellBuyButtons.

  • Flag supportOrderPreview has been renamed to supportPlaceOrderPreview.

  • Method setPoints now behaves the same way as createMultipointShape for all tools. Previously it could change some other properties like width instead on moving points to their new places.

Version 17

  • The orders response has been split into orders and ordersHistory.
  • Widget Method setLanguage(locale) has been removed.
  • The argument of onIntervalChanged event have been modified: type of timeframe field has been changed to TimeFrameValue.
  • Featureset same_data_requery has been removed, please use resetData() method to refresh the data.
  • charting_library/charting_library.min.js and charting_library/charting_library.min.d.ts files have been renamed to charting_library/charting_library.js and charting_library/charting_library.d.ts accordingly.
  • The Chart Method removeEntity now can be undone by the user by default. To disable this, please use disableUndo field in the new argument options.

Trading Terminal

  • Flag supportBottomWidget has been removed from Broker Configuration configFlags object. To remove the Account Manager the trading_account_manager featureset should be used.

Version 16 (changed versioning)

  • Action tmzProperties from executeActionById and getCheckableActionState methods is removed.

  • Chart method createStudy options for priceScale have been changed. left and right have been renamed to new-left and new-right.

  • Series API method moveToOtherSourceScale has been renamed to changePriceScale. New argument options are added: new-left, new-right, no-scale.

  • Study API method changePriceScale argument options have been changed. left and right have been renamed to new-left and new-right. New argument option entityId has been added, it pins the study to the same price axis as a study with a corresponding entityId.

  • Method applyOverrides of ChartWidget is disabled for "mainSeriesProperties.priceAxisProperties.*".

  • Creating a study using createStudy of ChartWidgetApi can be undone by the user from now. You can disable it using disableUndo in options.

Version 1.15

  • Featureset show_logo_on_all_charts has been removed.
  • Featureset cl_feed_return_all_data has been removed.
  • Action magnetAction from executeActionById and getCheckableActionState methods is removed. Use magnetEnabled instead.
  • callback argument of createStudy has been removed.
  • createStudy returns Promise instead of entityId.
  • Pane-Api method getLeftPriceScale is removed and replaced with getLeftPriceScales that returns an array of scales instead a single element.
  • Pane-Api method getRightPriceScale is removed and replaced with getRightPriceScales that returns an array of scales instead a single element.
  • setVisibleRange method now returns a Promise object and don't accept a callback as the last argument.
  • Priority of the symbol option has been made higher than the priority of the symbol from the saved_data option. Do not assign a value to the symbol option, if you don't want to override the symbol from saved_data.
  • Override symbolWatermarkProperties is not supported anymore. You can use settings_adapter with symbolWatermark key.
  • indicators_file_name constructor option was removed. Use custom_indicators_getter instead. We made this change to speed up the loading of the library and get rid of possible vulnerabilities that may occur when loading a file. You just need to move the code of your custom indicators from the JS file to the widget constructor, wrapping them in a function and a Promise

Trading Terminal

We've changed the broker's interaction flow. Please read the following carefully to understand what changes should be made in your code to switch to the new version.

Till now the Trading Terminal called broker adapter's methods (e.g. placeOrder, modifyOrder) when user clicked on Buy/Sell/Modify buttons. When calling these methods the Trading Terminal passed a silently argument. When silently was set to true, the broker adapter could send an order without showing the dialog. When it was set to false, the broker adapter had to invoke a method from the host to show the order ticket (or the Edit Position dialog).

Starting from 1.15 the Trading Terminal shows all dialogs by itself and invokes broker adapter's methods to send an order or a position to the broker's server. The reason for this change is that we've added an order panel that can be used to place an order at any time. If you use your own Order dialog then you still need to make changes in your broker adapter's methods, but additionally you need to use metainfo to pass the dialog constructor to the Trading Terminal.

  • Argument silently was removed from placeOrder, modifyOrder, reversePosition, closePosition, closeTrade, cancelOrder, cancelOrders methods of the Broker API.

  • Arguments handler and options were removed from showOrderDailog method of the Trading Host.

  • Argument handler was removed from showPositionBracketsDailog method of the Trading Host.

  • supportCustomPlaceOrderTradableCheck flag is no longer supported.

  • We pass the parent order to modifyOrder if it exists. If child order’s details are required while modifying the order you can get back this behavior by enabling always_pass_called_order_to_modify featureset.

Version 1.14

  • createButton returns HTMLElement instead of JQuery.
  • createButton must be used after headerReady() Promise is resolved.
  • getVisibleRange returns {from, to} in the UTC timezone (it was a timezone selected on a chart before).
  • Method onready was removed. You can use window.addEventListener('DOMContentLoaded', callback, false) instead.
  • saveAsSnapshot parameter was removed from saveChartToServer

TypeScript type definitions

  • StudyInputValueType type is renamed to StudyInputValue.

Featureset

  • Starting from this version you are no longer able to use the keep_left_toolbar_visible_on_small_screens featureset. This featureset is removed and the left toolbar visibility no longer depends on the screen size.

Version 1.13

Version 1.12

Charting Library

  • charting_library/charting_library.min.js is now UMD module.

    If you only inline this script into HTML then nothing has changed for you. If you import it as a module you should import widget, version and onready functions directly from it.

  • searchSymbolsByName is removed from JS-API, use searchSymbols instead.

Study overrides:

  • Overrides for Overlay should be applied only via studies_overrides (and applyStudiesOverrides in runtime). In the previous versions you had to use overrides and applyOverrides). See Studies-Overrides page.
  • Starting from this version you are no longer able to override showStudyArguments and showLastValue using options keyword.

Trading Terminal

  • hasHistory flag is removed. Use historyColumns to display History in the Account Manager.

The following items are still supported in the Trading Terminal, but will be deprecated in future versions:

  • subscribePL and unsubscribePL. The broker should call plUpdate method of the Host every time the profit is changed.
  • supportDOM is removed. DOM widget visibility can be set using dome_widget featureset.

The Trading Controller is replaced with Broker API.

The following changes should be applied to your Trading Controller implementation to move to new Broker API:

  • Method setHost is removed. Host should be passed to the constructor of Broker API.
  • Method buttonDropdownItems is removed. Broker API should update Broker API using setButtonDropdownActions.
  • Methods configFlags and durations are removed. Use Widget Constructor fields instead.
  • All methods that returned $.Deferred should be modified to return Promise.
  • Method chartContextMenuItems is renamed to chartContextMenuActions.
  • Method isTradable changed to return a Promise instead of a Boolean value.
  • All string constants ("working", "buy" etc.) should be replaced with the appropriate number of constants.
  • Position avg_price renamed to avgPrice.
  • tradingController field in the Widget Constructor is removed. Use brokerFactory instead.

Version 1.11

Trading Terminal

The following items are still supported in Trading Terminal, but will be deprecated in future versions:

  • supportDOME renamed to supportDOM.
  • The signature of `showClosePositionDialog has been changed.
  • showEditBracketsDialog was renamed to showPositionBracketsDialog.The signature has been changed.

Version 1.10

  • Default behavior of Volume indicator was changed.

    Previous behavior: Volume indicator is added/removed when an instrument or a resolution is switched depending on volume support by the instrument. You can get back to this behavior by disabling create_volume_indicator_by_default_once featureset.

    New behavior: Volume indicator is added when an empty chart is loaded for the first time provided that it is supported by an active instrument.

Version 1.9

  • We don't compile Pine scripts anymore. You can still use scripts that were compiled earlier.

Version 1.8 of Trading Terminal

  • The chart can no longer show active orders only. Appropriate methods have been removed.
  • showOrderDialog receives an object instead of arguments list
  • showSampleOrderDialog removed, use showOrderDialog instead
  • showOrderDialog removed from Broker API, use placeOrder and modifyOrder receive silently argument instead
  • reversePosition, closePosition, cancelOrder have an additional argument silently.

Version 1.7

  • Starting from this version calling setSymbol with the same symbol is no longer enough. You should call onResetCacheNeededCallback from subscribeBars first. Then you can use setSymbol or new resetData method of the chart.
  • JSAPI protocol version 1 is not supported anymore. nextTime and noData must be provided.

Version 1.5

  • Added source argument to MACD. You should change MACD creation code to pass source also.

    chartWidget.chart().createStudy('MACD', false, false, [12, 26, "close", 9])

Version 1.4

  • Override transparency is not supported anymore. We added transparency support to every color. Use rgba form to define a color with transparency. Example:

    "symbolWatermarkProperties.color" : "rgba(60, 70, 80, 0.05)"

Version 1.3

  • Override paneProperties.gridProperties.* is not supported anymore.

    Please use paneProperties.vertGridProperties.* and paneProperties.horzGridProperties.*

  • Override mainSeriesProperties.candleStyle.wickColor is not supported anymore.

    Use mainSeriesProperties.candleStyle.wickUpColor and mainSeriesProperties.candleStyle.wickDownColor