@@ -10,324 +10,4 @@ Excel 是一款功能强大的电子表格软件,它支持数据的录入、
1010
1111![ 标题] ( ./images/readme_cn.png )
1212
13- ## 1. 安装说明
14-
15- 用户可以在微软 Excel 的 Add-In 加载项中添加该插件。具体安装步骤如下:
16-
17- (1)根据当前使用的 Excel 版本,在本地下载文件 DolphinDBExcel-AddIn-packed.xll(Windows 32位) 或者 DolphinDBExcel-AddIn64-packed.xll(Window 64位) 。
18-
19- 图 1-1 下载包示例
20-
21- ![ 标题] ( ./images/readme_cn_1-1.png )
22-
23- 注意:Excel 的 32/64 位版本信息可以在 Excel 的“文件”->“账户”->“关于Excel”里找到。
24-
25- 图 1-2 Excel 的版本信息界面
26-
27- ![ 标题] ( ./images/readme_cn_1-2.png )
28-
29- (2)在 Excel 中依次单击“文件”->”选项“->”加载项”。
30-
31- 图 1-3 加载项界面
32-
33- ![ 标题] ( ./images/readme_cn_1-3.png )
34-
35- (3)在”管理”栏中选择“Excel 加载项”,然后单击“转到”。
36-
37- 图 1-4 选中“Excel 加载项”,单击“转到”
38-
39- ![ 标题] ( ./images/readme_cn_1-4.png )
40-
41- (4)单击”浏览”。在安装路径中找到 * DolphinDBExcel-AddIn64-packed.xll* 文件(32 位的 Office 需要选择* DolphinDBExcel-AddIn-packed.xll* 文件)。
42-
43- 图 1-5 单击“浏览”
44-
45- ![ 标题] ( ./images/readme_cn_1-5.png )
46-
47- 图 1-6 导入“DolphinDBExcel Add-In”
48-
49- ![ 标题] ( ./images/readme_cn_1-6.png )
50-
51- (5)系统自动返回加载项界面,选中刚刚导入的“DolphinDBExcel Add-In”。
52-
53- 图 1-7 选中“DolphinDBExcel Add-In”
54-
55- ![ 标题] ( ./images/readme_cn_1-7.png )
56-
57- (6)成功安装后,会在 Excel 的主菜单栏看到 “DolphinDB” 菜单栏。
58-
59- 图 1-8 成功安装
60-
61- ![ 标题] ( ./images/readme_cn_1-8.png )
62-
63- (7)更新插件时,在 Excel 中依次单击“文件”->”选项“->”加载项”->”转到”,取消勾选原加载项,点击确定,并关闭选项框。
64-
65- 图1-9 取消勾选“DolphinDBExcel Add-In”
66-
67- ![ 标题] ( ./images/readme_cn_1-9.png )
68-
69- 再次打开该选项框,按安装步骤,选择新的加载项。
70-
71- ## 2. 配置说明
72-
73- 本节讲解如何配置 DolphinDB server 连接和其他事项。
74-
75- ### 2.1 配置连接
76-
77- 单击“Server”,可以添加新的连接节点、或者修改已配置节点的连接信息。
78-
79- 图 2-1 单击“Server”
80-
81- ![ 标题] ( ./images/readme_cn_2-1.png )
82-
83- #### 2.1.1 添加新节点
84-
85- 单击“Add Server”以添加新节点。
86-
87- 图 2-2 单击“Add Server”
88-
89- ![ 标题] ( ./images/readme_cn_2-2.png )
90-
91- 在页面中需要输入 Name(标识名)、Host(节点信息)、Port(端口信息)、User Name(用户名)和 Password(密码)。
92-
93- 图 2-3 添加界面
94-
95- ![ 标题] ( ./images/readme_cn_2-3.png )
96-
97- ** 参数说明:**
98-
99- - ** Name** 字符串,表示标识名,必填参数。
100- - ** Host** 字符串,表示节点信息,必填参数。
101- - ** Port** 整型,表示端口信息,必填参数。
102- - ** User Name** 字符串,表示账号用户名。
103- - ** Password** 字符串,表示账号密码。
104-
105- 图 2-4 添加新节点
106-
107- ![ 标题] ( ./images/readme_cn_2-4.png )
108-
109- 确认上述信息无误后,点击“Add”确认添加。此外,也可先点击“Test”以测试是否与目标节点连接成功。
110-
111- 完成添加后,新节点会自动出现在切换节点的下拉菜单中。
112-
113- 图 2-5 新节点添加成功
114-
115- ![ 标题] ( ./images/readme_cn_2-5.png )
116-
117- #### 2.1.2 修改节点信息
118-
119- 单击“Edit Server”以修改已配置的节点信息。
120-
121- 图 2-6 单击“Edit Server”
122-
123- ![ 标题] ( ./images/readme_cn_2-6.png )
124-
125- 图 2-7 修改界面
126-
127- ![ 标题] ( ./images/readme_cn_2-7.png )
128-
129- 单击想要修改的信息,进行对应修改。修改后单击右下角的“OK”以保存。若要取消修改,则单击右下角的“Cancle”。
130-
131- 图 2-8 修改节点信息
132-
133- ![ 标题] ( ./images/readme_cn_2-8.png )
134-
135- 单击想要删除节点所在行的第一列,可以看到该行被选中,单击“Delete”键,将会看到该行节点信息被删除。点击“OK”已保存修改。
136-
137- 图 2-9 单击“Settings”
138-
139- ![ 标题] ( ./images/readme_cn_2-9.png )
140-
141- ### 2.2 配置面板
142-
143- 单击“Settings”以打开配置面板。
144-
145- 图2-10 单击“Settings”
146-
147- ![ 标题] ( ./images/readme_cn_2-10.png )
148-
149- 在该面板中,可以设置 SQL 查询面板的字体类型、字体大小,以及导出数据的最大行数限制。
150-
151- 同时可以看到,该面板中会显示当前 DolphinDB Excel Add-In 的版本信息。图 2-11 中显示信息为“Version: V1.0.0 2024.07.19”。
152-
153- 图 2-11 配置面板
154-
155- ![ 标题] ( ./images/readme_cn_2-11.png )
156-
157- ** 配置项说明:**
158-
159- Editor Font:
160-
161- - ** Font** 表示 SQL 面板中的字体类型。选择下拉框中的类型。
162- - ** Size** 正整数,表示 SQL 面板中的字体大小。
163-
164- Import Options:
165-
166- - ** The maximum number of rows imported** 如果勾选了该功能,则会限定每次导入 Excel 数据的行数。并且可在末尾的框中输入具体的行数上限。
167-
168- 确认修改后,点击“OK”以确认。
169-
170- 若要取消修改,可点击“Cancel”。
171-
172- 若要恢复默认配置,请点击“Reset”。
173-
174- ## 3. 使用说明
175-
176- 用户可在 Excel 中进行切换节点、数据查询、数据订阅和调用 DolphinDB 函数等操作。
177-
178- ### 3.1 切换节点
179-
180- 单击节点下拉框以切换节点。
181-
182- 图 3-1 切换节点
183-
184- ![ 标题] ( ./images/readme_cn_3-1.png )
185-
186- ### 3.2 数据查询
187-
188- 有 2 种将数据导入到 Excel 表格的方法。操作如下,先单击“Query”,进入查询面板。
189-
190- 图 3-2 单击“Query”
191-
192- ![ 标题] ( ./images/readme_cn_3-2.png )
193-
194- 查询面板主要由菜单栏、项目导航栏、脚本编辑器和日志浏览器组成。其中菜单栏以图标的形式展示,鼠标放置时会弹出文本解释,从左到右依次为“Refresh”“Expand/Collapse”“Excute”“Excute & Import”。
195-
196- 图 3-3 查询面板
197-
198- ![ 标题] ( ./images/readme_cn_3-3.png )
199-
200- #### 方法一:直接导入
201-
202- 如果需要把某一个表的数据直接导入到 Excel 中,可进行如下操作。
203-
204- (1)在 Excel 表格中选定需要导入数据的位置。
205-
206- 图 3-4 选中导入位置
207-
208- ![ 标题] ( ./images/readme_cn_3-4.png )
209-
210- (2)在变量列中右键单击对应的变量。
211-
212- 图 3-5 选中导入变量
213-
214- ![ 标题] ( ./images/readme_cn_3-5.png )
215-
216- (3)选择“Import”。
217-
218- 图 3-6 单击“Import”
219-
220- ![ 标题] ( ./images/readme_cn_3-6.png )
221-
222- (4)成功导入数据。
223-
224- 图 3-7 导入成功
225-
226- ![ 标题] ( ./images/readme_cn_3-7.png )
227-
228- #### 方法二:使用 SQL 语句导入
229-
230- 支持将一个查询语句的返回值直接导入到 Excel 表格中。操作示例如下:
231-
232- (1)在 Excel 表格中选定需要导入数据的位置。
233-
234- (2)编写需要运行的脚本。
235-
236- 图 3-8 编写 SQL 脚本
237-
238- ![ 标题] ( ./images/readme_cn_3-8.png )
239-
240- (3)点击“Execute & Import”。
241-
242- 图 3-9 单击“Execute & Import”及其响应日志
243-
244- ![ 标题] ( ./images/readme_cn_3-9.png )
245-
246- (4)成功导入数据。
247-
248- 图 3-10 导入成功
249-
250- ![ 标题] ( ./images/readme_cn_3-10.png )
251-
252- ### 3.3 数据订阅
253-
254- 支持订阅 DolphinDB 中流表的数据。操作示例如下:
255-
256- (1)在 Excel 表格中选定需要导入数据的位置。
257-
258- 图 3-11 选定需要导入数据的位置
259-
260- ![ 标题] ( ./images/readme_cn_3-11.png )
261-
262- (2)在变量列中右键单击对应的变量。
263-
264- (3)选择“Subscribe”。
265-
266- 图 3-12 选择“Subscribe”
267-
268- ![ 标题] ( ./images/readme_cn_3-12.png )
269-
270- (4)指定刷新主键。每当有新的数据进来时,主键相同的数据则会刷新,主键不存在时则会添加一行数据。此处输入“id”。
271-
272- 图 3-13 指定刷新主键
273-
274- ![ 标题] ( ./images/readme_cn_3-13.png )
275-
276- (5)如果所连 server 的版本小于或等于 200.8,则需要填入客户端的流订阅端口。
277-
278- 图 3-14 输入端口(仅限 2.00.8 及以前版本)
279-
280- ![ 标题] ( ./images/readme_cn_3-14.png )
281-
282- (6)订阅成功后会显示表结构。
283-
284- 图 3-15 成功订阅
285-
286- ![ 标题] ( ./images/readme_cn_3-15.png )
287-
288- (7)当订阅的流表有新增数据时,会在表格里刷新数据。
289-
290- 图 3-16 刷新数据
291-
292- ![ 标题] ( ./images/readme_cn_3-16.png )
293-
294- (8)点击“Unsubscribe”以关闭数据订阅。
295-
296- 图 3-17 取消订阅
297-
298- ![ 标题] ( ./images/readme_cn_3-17.png )
299-
300- ### 3.4 函数调用
301-
302- 支持在 Excel 中调用 DolphinDB 的函数。主要通过 ` RUNFUNCTION(values1, values2,...) ` 实现。该函数能够在 Excel 表格中远程执行 DolphinDB 上的函数或函数视图,并且可以填入参数,执行结果会返回到 Excel 指定的表格中。
303-
304- ** 参数介绍:**
305-
306- 在 Excel 中,` RUNFUNCTION ` 的参数为 * values1, values2,……* 其中,
307-
308- - ** values1** 必填参数,表示 functionName,即 DolphinDB server 中的函数。函数可参考 [ DolphinDB 函数文档说明] ( https://docs.dolphindb.cn/zh/2.00.13/funcs/funcs_intro.html ) 。
309- - ** values2,……** 表示被调用函数对应的参数。其数量没有限制,可以是 0。
310-
311- 注意:Excel 中 INT 的数据底层使用 DOUBLE 类型数据来存储。故填入 INT 类型的参数会转换成 DOUBLE 类型的数据,如 ` =RUNFUNCTION("funcTest", 2) ` ,这时会在 DolphinDB 中执行 ` funcTest(2.0$DOUBLE) ` 。
312-
313- ** 使用示例:**
314-
315- 在 DolphinDB 数据库中有 ` getTableData ` 这一函数视图。
316-
317- ```
318- def getTableData(dataType){
319- if(dataType == "type1"){
320- return table(1..10 as id, 1..10 as value)
321- }else{
322- return table(1..10 as id, 11..20 as value)
323- }
324- }
325-
326- addFunctionView(getTableData)
327- ```
328-
329- 在 Excel 中选择一块表格区域,然后调用函数 ` =RUNFUNCTION("getTableData", "type1") ` ,最后按下回车键以执行函数。如下为示例截图。
330-
331- 图 3-18 函数调用示例
332-
333- ![ 标题] ( ./images/readme_cn_3-18.png )
13+ 编译、安装以及使用说明参见[ DolphinDB官网文档] ( https://docs.dolphindb.cn/zh/plugins/excel_add_in.html ) 。
0 commit comments