Skip to content

Commit a6942ce

Browse files
shinny-xuyidashinny-tianqin
authored andcommitted
docs:增加web_gui文档说明
1 parent 31d1912 commit a6942ce

File tree

3 files changed

+8
-6
lines changed

3 files changed

+8
-6
lines changed

doc/quickstart.rst

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -107,9 +107,9 @@ klines是一个pandas.DataFrame对象. 跟 api.get_quote() 一样, api.get_kline
107107

108108
.. _quickstart_2_web_gui:
109109

110-
生成k线图形化界面
110+
生成图形化界面
111111
-------------------------------------------------
112-
如果想要将你订阅的K线或策略可视化显示, 只需在 :py:meth:`~tqsdk.api.TqApi` 中传入参数 web_gui = True即可::
112+
如果想要将你订阅的K线或策略图形化显示, 只需在 :py:meth:`~tqsdk.api.TqApi` 中传入参数 web_gui = True即可::
113113

114114
# 引入TqSdk模块
115115
from tqsdk import TqApi

doc/usage/web_gui.rst

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
.. _web_gui:
22

3-
策略程序可视化
3+
策略程序图形化界面
44
====================================================
55

66
要在 TqSdk 中实现图形化界面非常简单,在 :py:meth:`~tqsdk.api.TqApi` 中传入参数 web_gui = True即可,一套方案满足实盘/回测需求
@@ -60,10 +60,10 @@
6060

6161
如何在 TqSdk 中进行回测可以参见 :ref:`backtest`
6262

63-
在使用web_gui图形化界面时需要注意以下几点:
63+
**在使用web_gui图形化界面时需要注意以下几点:**
6464

6565
1.推荐打开图形化界面的浏览器为Google Chrome 或 Firefox
6666

67-
2.为了保证图形化界面能够接收到程序传输的数据并且刷新,在程序中,需要使用循环 api.wait_update的形式去更新和获取数据,并且不能使用api.close()
67+
2.为了保证图形化界面能够接收到程序传输的数据并且刷新,在程序中,需要循环调用 api.wait_update的形式去更新和获取数据
6868

6969
3.回测指标数据会在本次回测完成之后才会显示

tqsdk/api.py

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -83,7 +83,9 @@ def __init__(self, account: Union['TqAccount', TqSim, 'TqApi', None] = None, url
8383
8484
loop(asyncio.AbstractEventLoop): [可选]使用指定的 IOLoop, 默认创建一个新的.
8585
86-
web_gui(bool): [可选]是否启用 web_gui 功能, 默认不启用.
86+
web_gui(bool): [可选]是否启用 图形化界面 功能, 默认不启用.
87+
* 为了图形化界面能够接收到程序传输的数据并且刷新,在程序中,需要循环调用 api.wait_update的形式去更新和获取数据
88+
* 推荐打开图形化界面的浏览器为Google Chrome 或 Firefox
8789
8890
Example::
8991

0 commit comments

Comments
 (0)