文档更新为v18开发版

zlq4863947 · Jan 2, 2021 · 24f3ea2 · 24f3ea2
1 parent c7f805a
commit 24f3ea2
Show file tree

Hide file tree

Showing 14 changed files with 472 additions and 163 deletions.
diff --git a/CHANGE-LOG.md b/CHANGE-LOG.md
@@ -4,8 +4,14 @@
 
 - [版本变更点](book/Breaking-changes.md)
 
-## 1.16 开发版 -- 20200826
+## 18.031 开发版 -- 20210102
 
+- 文档更新为18版
+- 增加图表基本组成说明
+
+## 16 开发版 -- 20200826
+
+- 从1.16版本开始，tv版本号改为16.xxx(类似Java将1.16版本改成 Java 6)
 - 增加快捷键说明
 - 修改商品信息、存储/加载、JSAPI文章说明
 

diff --git a/README.md b/README.md
@@ -1,6 +1,6 @@
-# TradingView 中文开发文档 V1.16 开发版
+# TradingView 中文开发文档 V18.031 开发版
 
-#### 最新修订时间: 2020-08-26
+#### 最新修订时间: 2021-01-02
 
 本书翻译自官方 wiki：[https://github.com/tradingview/charting_library/wiki](https://github.com/tradingview/charting_library/wiki)
 

diff --git a/SUMMARY.md b/SUMMARY.md
@@ -48,12 +48,13 @@
 
 - [6、储存和载入图表](book/Saving-and-Loading-Charts.md)
 - [7、创建自定义指标](book/Creating-Custom-Studies.md)
-- [7、最佳做法](book/Best-practices.md)
+- [8、最佳实践](book/Best-practices.md)
 - [9、经常被问到的问题](book/Frequently-Asked-Questions.md)
 - [10、版本变更点](book/Breaking-changes.md)
 
 ## 附录
 
+- [图表的主要组成](book/Basic-Compose.md)
 - [周期](book/Resolution.md)
 - [时间范围](book/Time-Frames.md)
 - [本地化](book/Localization.md)

diff --git a/book/Basic-Compose.md b/book/Basic-Compose.md
@@ -0,0 +1,13 @@
+## 图表的主要组成
+一般情况下，图表库包含：
+- **图例**（Legend）
+- **价格刻度**（PriceSeries）
+- **时间刻度**（TimeScale）
+- **头部工具**（Header Tools）
+- **绘图工具**（Drawing Tools）
+- **版权**（Credits）
+- 等等...
+
+###基本组成部分如下图所示
+
+<img src="..//images/tv_chart.png" />
diff --git a/book/Best-practices.md b/book/Best-practices.md
@@ -1,20 +1,20 @@
-#最佳做法
+#最佳实践
 
 ---
 
-## 创造最好的用户体验
+## 创造最佳的用户体验
 
-我们喜欢我们的图表。 我们希望它们成为整个HTML5世界中最好，最美丽，响应最快，功能最强大的图表。 我们正在努力实现这些目标。
+我们热爱我们的图表。并希望它们成为整个HTML5世界中最好，最漂亮，响应最快和功能最强大的图表。我们正在努力实现这些目标。
 
-我们了解所有关于我们的图表以及使用它们创建最佳用户体验，我们很乐意与您分享我们的知识。 本文档介绍了将图表库集成到您的网站/应用程序中的几种最佳实践。 重点是始终考虑您的用户和他们的体验。
+我们了解所有关于我们的图表以及使用它们创建最佳用户体验，我们很乐意与您分享我们的知识。本文档介绍了将图表库集成到您的网站/应用程序中的几种最佳实践。重点是始终考虑您的用户和他们的体验。
 
 ### 1. 了解图表库是什么，不是什么
 
-图表库是一个能够显示价格，形状和技术分析工具的图表组件。 我们的图表库使图表变得神奇，仅此而已。 如果您想要一些额外的功能（如聊天，特殊的商品列表，最热门交易栏，广告等），最好的方法是在图表之外实现它们。 但是，如果要将外部功能与图表库链接，可以使用图表库的API链接它们。
+图表库是一个能够显示价格，形状和技术分析工具的图表组件。我们的图表库使图表变得神奇，仅此而已。如果您想要一些额外的功能（如聊天，特殊的商品列表，最热门交易栏，广告等），最好的方法是在图表之外实现它们。但是，如果要将外部功能与图表库链接，可以使用图表库的API链接它们。
 
 ### 2. 返回与库请求一样多的K线
 
-图表库将向您的后端询问数据，并为提供每个请求所需的数据范围界限。 请遵守这些边界并尽可能完整地返回填充此范围的数据。 不要返回范围外的数据。 如果要扩展库请求的默认数据范围，请使用我们的JS API（请参阅calculateHistoryDepth）。
+图表库将向您的后端询问数据，并在每次请求时提供所需的数据范围界限。请遵守这些范围界限并尽可能完整地返回填充此范围的数据。不要返回范围外的数据。如果要扩展库请求的默认数据范围，请使用我们的JS API（请参阅calculateHistoryDepth）。
 
 ### 3. 返回与库请求一样多的标记
 
@@ -38,16 +38,16 @@
 
 ### 8. 如果您遇到问题
 
-我们总是渴望帮助你。 但是，不幸的是，我们真的很忙，所以我们没有太多时间。 请帮助我们有效地度过时间，并始终将您的图表库的版本更新为最新的`unstable`版本，以检查问题是否仍然发生。 如果有，请与我们联系。
+我们一直渴望为您提供帮助。但不幸的是，我们真的很忙，所以我们没有太多时间。 请帮助我们有效地利用时间，并始终将您的图表库的版本更新为最新的`unstable`版本，以检查问题是否仍然发生。如果有，请与我们联系。
 
-另外，检查您传递给图表库的数据，并确保它符合我们的要求，如文档中所述。 要特别注意SymbolInfo的内容，因为它是最常见的发生错误的地方（根据我们的统计）。
+另外，检查您传递给图表库的数据，并确保它符合我们的要求，如文档中所述。要特别注意SymbolInfo的内容，因为它是最常见的发生错误的地方（根据我们的统计）。
 
-您可以看我们的输出[demo data service](https://demo_feed.tradingview.com/quotes?symbols=AAPL) 并将其与您的对比，以确保您的后端特性是正确的。
+您可以观察我们的[演示数据服务](https://demo_feed.tradingview.com/quotes?symbols=AAPL) 的输出，并将其与您的对比，以确保您的后端数据是正确的。
 
 在开发过程中始终在Widget构造函数选项中使用`debug：true`，并在生产环境中将其删除，以使代码更快地工作。
 
 ### 9. 阅读文档
-我们花了很多时间为您创建这些文档，使您的生活更轻松。 请试一试。
+我们花了很多时间为您创建这些文档，使您的生活更轻松。请试一试。
 
 ### 10. 为您的解决方案选择适当的数据传输
 
@@ -63,17 +63,17 @@
 
 这个数据源只是一个演示，不适合实际使用。它可能不稳定，不能承受过大的负载。
 
-### 13. 使用API进行自定义。 避免编辑CSS。
+### 13. 使用API进行自定义。避免编辑CSS。
 
 我们不保证CSS选择器的向后兼容性。
 
 ### 14. 发送到客户端时，将服务器设置为gzip文件
 
-这是静态HTML内容的常见最佳做法。 加载图标库的HTML文件会减少用户的等待时间。
+这是静态HTML内容的常见最佳做法。加载图标库的HTML文件会减少用户的等待时间。
 
-### 15.设置charting_library.min.js的最短到期时间
+### 15.设置charting_library.js的最小到期时间
 
-除了添加到HTML文件的`charting_library.min.js`之外，图表库中的所有文件名中都包含哈希值。
+除了添加到HTML文件的`charting_library.js`之外，图表库中的所有文件名中都包含哈希值。
 将图表库更新为较新版本时，所有文件的名称也会更改。
-如果浏览器从缓存中加载`charting_library.min.js`，则该文件中的所有链接都将被破坏。
+如果浏览器从缓存中加载`charting_library.js`，则该文件中的所有链接都将被破坏。
 应将此文件的到期时间设置为最小值，以确保浏览器不缓存该文件。
diff --git a/book/Breaking-changes.md b/book/Breaking-changes.md
@@ -6,7 +6,36 @@ _注意：您可以通过在浏览器控制台中执行 `TradingView.version()`
 
 以下是重大变更列表：
 
-## Version 1.16
+## Version 18
+
+**交易终端**
+
+- `accountsList` 和 `account` 已从 Account Manager 信息中删除。他们已替换为方法： `currentAccount`, `setCurrentAccount` 和 `accountsMetainfo` 在 broker's API.
+
+- 方法 `fullUpdate` 在Trading Host中已重命名为 `currentAccountUpdate`.
+
+- 方法 `showClosePositionDialog` 已被删除。
+
+- [Trading Host](Trading-Host.md) 方法 `floatingTradingPanelVisibility` 被重命名为 `sellBuyButtonsVisibility`.
+
+- [Trading Host](Trading-Host.md) `defaultDropdownMenuActions` 选项已更改。选项 `showFloatingToolbar` 已重命名为 `showSellBuyButtons`。
+
+- 方法 [setPoints](Shape-Api.md#setpointspoints) 的作用与 [createMultipointShape](Chart-Methods.md#createmultipointshapepoints-options) 方法相同。 以前，它可以更改其他一些属性，例如width，而不是将点移动到新位置。
+
+## Version 17
+
+- 订单返回值已区分为 [orders](Broker-API.md#orders-promiseorder) 和 [ordersHistory](Broker-API.md#ordershistory-promiseorder)。
+- [Widget方法](Widget-Methods.md) `setLanguage(locale)` 已被删除。
+- `onIntervalChanged` 事件的参数已被修改: `timeframe` 字段的类型已更改为 [TimeFrameValue](Chart-Methods.md#onIntervalChanged)。
+- 功能集 `same_data_requery` 已被删除, 请使用 [resetData() 方法](Chart-Methods.md#resetdata) 刷新数据。
+- `charting_library/charting_library.min.js` 和 `charting_library/charting_library.min.d.ts` 重命名为 `charting_library/charting_library.js` 和 `charting_library/charting_library.d.ts`。
+- 现在，默认情况下，用户可以撤消图表方法 [removeEntity](Chart-Methods.md#removeentityentityid-options) 要禁用此功能，请在`options`使用 `disableUndo` 字段。
+
+**交易终端**
+
+- `supportBottomWidget` 标记已从Broker配置 `configFlags` 对象中删除。要删除 Account Manager 请使用功能集 `trading_account_manager`。
+
+## Version 16（更改版本）
 
 - 动作 `tmzProperties` 从 [executeActionById](Chart-Methods.md#executeactionbyidactionid) 和 [getCheckableActionState](Chart-Methods.md#getcheckableactionstateactionid) 方法中被删除。
 - 图表方法 `createStudy` 的 `options`参数中的 `priceScale` 发生变化。 `left` 和 `right` 重命名为 `new-left` 和 `new-right`。 `options`参数中增加 `entityId`, 它将指标和具有相应 `id` 的指标锁定在同一价格轴上。

diff --git a/book/Chart-Methods.md b/book/Chart-Methods.md
@@ -75,6 +75,10 @@
   - [selection()](#selection)
   - [setZoomEnabled(enabled)](#setzoomenabledenabled)
   - [setScrollEnabled(enabled)](#setscrollenabledenabled)
+  * [getTimeScale()](#gettimescale)
+  * [isSelectBarRequested()](#isselectbarrequested)
+  * [requestSelectBar()](#requestselectbar)
+  * [cancelSelectBar()](#cancelselectbar)
 
 # 图表订阅事件
 
@@ -1084,6 +1088,54 @@ widget.activeChart().setZoomEnabled(false);
 widget.activeChart().setScrollEnabled(false);
 ```
 
+### getTimeScale()
+
+*从版本18开始。*
+
+返回带有与时间轴关联的方法的[TimeScaleApi](Time-Scale-Api) 实例。
+
+```javascript
+var time = widget.activeChart().getTimeScale().coordinateToTime(100);
+```
+
+### isSelectBarRequested()
+
+*从版本18开始。*
+
+返回k先的选择模式是否处于活动状态。
+
+```javascript
+var isRequested = widget.activeChart().isSelectBarRequested();
+```
+
+### requestSelectBar()
+
+*从版本18开始。*
+
+图表状态切换到K线选择模式。例如，用于开启K线回放。
+
+返回一个Promise对象，该对象为resolved时，将返回用户选择的K线的时间（unix时间戳），或者如果已经请求或取消了K线选择（通过用户操作或[`cancelSelectBar()`](#cancelselectbar)方法），则为rejected。
+
+```javascript
+widget.activeChart().requestSelectBar()
+    .then(function(time) {
+        console.log('user selects bar with time', time);
+    })
+    .catch(function() {
+        console.log('bar selection was rejected');
+    });
+```
+
+### cancelSelectBar()
+
+*从版本18开始。*
+
+取消活动的选择K线请求（如果存在），否则不执行任何操作。
+
+```javascript
+widget.activeChart().cancelSelectBar();
+```
+
 # 也可以看看
 
 - [Widget 方法](Widget-Methods.md)