✨ feat(tsl-api-reference): update API catalog and data dictionary
This commit is contained in:
@@ -6,6 +6,8 @@
|
||||
|
||||
断言。若Check为假,返回出错信息
|
||||
|
||||
<!-- tags: 客户端函数 -->
|
||||
|
||||
| 参数 | 类型 | 说明 |
|
||||
| ------- | ------ | ---------- |
|
||||
| `error` | string | 字符串类型 |
|
||||
@@ -23,7 +25,9 @@ return assert(0, '无效的语段');
|
||||
|
||||
声明:function
|
||||
|
||||
检查是否存在可展开的数据。
|
||||
检查是否存在可展开的数据
|
||||
|
||||
<!-- tags: 客户端函数 判断 检查 -->
|
||||
|
||||
| 参数 | 类型 | 说明 |
|
||||
| ------ | ----- | -------------- |
|
||||
@@ -35,7 +39,9 @@ return assert(0, '无效的语段');
|
||||
|
||||
声明:function
|
||||
|
||||
将第一列的8位标准代码转为6位标准代码。注意,该函数主要用于客户端结果处理,不提供给用户程序编辑。
|
||||
将第一列的8位标准代码转为6位标准代码。注意,该函数主要用于客户端结果处理,不提供给用户程序编辑
|
||||
|
||||
<!-- tags: 客户端函数 -->
|
||||
|
||||
返回:array,tablearray
|
||||
|
||||
@@ -43,7 +49,9 @@ return assert(0, '无效的语段');
|
||||
|
||||
声明:function
|
||||
|
||||
去除证券代码前面的“SH”、“SZ”、“OF”、“BK”标识
|
||||
去除证券代码前面的"SH"、"SZ"、"OF"、"BK"标识
|
||||
|
||||
<!-- tags: 客户端函数 SH SZ OF BK -->
|
||||
|
||||
| 参数 | 类型 | 说明 |
|
||||
| ---- | ------ | ------ |
|
||||
@@ -62,7 +70,9 @@ return delPrecodeCallBack('SH600000');
|
||||
|
||||
声明:function
|
||||
|
||||
展开表格;系统使用,用于客户端展开表格。扩展填充模式为‘扩展部分保留为空’。该函数的功能即结果页面工具栏中的按钮的功能。
|
||||
展开表格;系统使用,用于客户端展开表格。扩展填充模式为'扩展部分保留为空'。该函数的功能即结果页面工具栏中的按钮的功能
|
||||
|
||||
<!-- tags: 客户端函数 -->
|
||||
|
||||
| 参数 | 类型 | 说明 |
|
||||
| ------- | ----------------- | ------------------------ |
|
||||
@@ -86,7 +96,9 @@ return extractData(r, 1, 0);
|
||||
|
||||
声明:function
|
||||
|
||||
展开表格,系统使用,用于客户端展开表格。
|
||||
展开表格,系统使用,用于客户端展开表格
|
||||
|
||||
<!-- tags: 客户端函数 -->
|
||||
|
||||
| 参数 | 类型 | 说明 |
|
||||
| ------------- | ------- | ------------------------------ |
|
||||
@@ -115,6 +127,8 @@ return extractDataEx(r, 1, 0, 1);
|
||||
|
||||
展开表格
|
||||
|
||||
<!-- tags: 客户端函数 -->
|
||||
|
||||
| 参数 | 类型 | 说明 |
|
||||
| -------------- | ------- | ---------------------------------- |
|
||||
| `data` | array | 数组类型,数据 |
|
||||
@@ -141,7 +155,9 @@ return extractDataEx2(r, 1, 0, 1, 1);
|
||||
|
||||
声明:function
|
||||
|
||||
展开表格;用于客户端展开表格,扩展会产生一些空的内容;如果需要把空内容补上,例如需要补上其股票代码、名称等信息,则可以选择扩充字段;扩充了的信息往往在对字段进行排序之后非常有用。
|
||||
展开表格;用于客户端展开表格,扩展会产生一些空的内容;如果需要把空内容补上,例如需要补上其股票代码、名称等信息,则可以选择扩充字段;扩充了的信息往往在对字段进行排序之后非常有用
|
||||
|
||||
<!-- tags: 客户端函数 排序 sort -->
|
||||
|
||||
| 参数 | 类型 | 说明 |
|
||||
| ------------- | ------- | ------------ |
|
||||
@@ -155,6 +171,8 @@ return extractDataEx2(r, 1, 0, 1, 1);
|
||||
|
||||
展开表格(考虑笛卡尔)
|
||||
|
||||
<!-- tags: 客户端函数 -->
|
||||
|
||||
| 参数 | 类型 | 说明 |
|
||||
| -------------- | ------- | ---------------------------- |
|
||||
| `fill_method` | integer | 整数,扩展填充模式 |
|
||||
@@ -179,7 +197,9 @@ return extractDataLocalRun2(0, 1);
|
||||
|
||||
声明:function
|
||||
|
||||
默认函数名,对于不同类型的证券代码,返回的默认函数名称不一致;
|
||||
默认函数名,对于不同类型的证券代码,返回的默认函数名称不一致
|
||||
|
||||
<!-- tags: 客户端函数 获取 查询 -->
|
||||
|
||||
| 参数 | 类型 | 说明 |
|
||||
| ---------- | ------ | -------- |
|
||||
@@ -191,7 +211,9 @@ return extractDataLocalRun2(0, 1);
|
||||
|
||||
声明:function
|
||||
|
||||
证券品种
|
||||
获取证券品种
|
||||
|
||||
<!-- tags: 客户端函数 获取 查询 -->
|
||||
|
||||
| 参数 | 类型 | 说明 |
|
||||
| ---------- | ------ | -------- |
|
||||
@@ -210,7 +232,9 @@ return getTypeOfStock('OF000001');
|
||||
|
||||
声明:function
|
||||
|
||||
穿透展示数组,用于展示<量化分析>结果专用嵌套数组结构的分析结果,结构为「键名:数组值」的键值对格式,支持一维/二维数组嵌套 注意:该函数主要用于客户端结果处理,不提供给用户程序编辑
|
||||
穿透展示数组,用于展示<量化分析>结果专用嵌套数组结构的分析结果,结构为「键名:数组值」的键值对格式,支持一维/二维数组嵌套 注意:该函数主要用于客户端结果处理,不提供给用户程序编辑
|
||||
|
||||
<!-- tags: 客户端函数 -->
|
||||
|
||||
返回:array
|
||||
|
||||
@@ -220,12 +244,14 @@ return getTypeOfStock('OF000001');
|
||||
|
||||
时序数据简单处理变形,譬如:累加、累乘、单期转多期。基于列名(含截止日、日期、date),跳过日期列 注意:该函数主要用于客户端结果处理,不提供给用户程序编辑
|
||||
|
||||
<!-- tags: 客户端函数 -->
|
||||
|
||||
| 参数 | 类型 | 说明 |
|
||||
| ----------- | ----------- | ----------------------------- |
|
||||
| `mtype` | user_define | 用户自定义,处理方式 |
|
||||
| `nodatecol` | boolean | 真假,跳过疑似日期列(基于列名) |
|
||||
|
||||
### mtype 取值
|
||||
mtype 取值
|
||||
|
||||
- `累加`:1
|
||||
- `单期收益累乘(源单位%)`:11
|
||||
@@ -243,13 +269,17 @@ return getTypeOfStock('OF000001');
|
||||
|
||||
6位代码->8位代码;注意,该函数主要用于客户端结果处理,不提供给用户程序编辑
|
||||
|
||||
<!-- tags: 客户端函数 -->
|
||||
|
||||
返回:array,tablearray
|
||||
|
||||
## `incPrecodeCallBack(s)`
|
||||
|
||||
声明:function
|
||||
|
||||
将“000002.SZ”的代码转化为“SZ000002”
|
||||
将"000002.SZ"的代码转化为"SZ000002"
|
||||
|
||||
<!-- tags: 客户端函数 SZ SZ000002 -->
|
||||
|
||||
| 参数 | 类型 | 说明 |
|
||||
| ---- | ------ | ------ |
|
||||
@@ -268,7 +298,9 @@ return incPrecodeCallBack('000002.SZ');
|
||||
|
||||
声明:function
|
||||
|
||||
是否为二维表。注意,该函数主要用于客户端结果处理,不提供给用户程序编辑。
|
||||
判断是否为二维表。注意,该函数主要用于客户端结果处理,不提供给用户程序编辑
|
||||
|
||||
<!-- tags: 客户端函数 判断 检查 -->
|
||||
|
||||
| 参数 | 类型 | 说明 |
|
||||
| ---- | ----- | -------------- |
|
||||
@@ -280,7 +312,9 @@ return incPrecodeCallBack('000002.SZ');
|
||||
|
||||
声明:function
|
||||
|
||||
对相应的数据进行处理,注意,该函数主要用于客户端结果处理,不提供给用户程序编辑。
|
||||
对相应的数据进行处理,注意,该函数主要用于客户端结果处理,不提供给用户程序编辑
|
||||
|
||||
<!-- tags: 客户端函数 -->
|
||||
|
||||
| 参数 | 类型 | 说明 |
|
||||
| ------------ | ------ | ---------------- |
|
||||
@@ -293,7 +327,9 @@ return incPrecodeCallBack('000002.SZ');
|
||||
|
||||
声明:function
|
||||
|
||||
对相应数据进行处理。注意,该函数主要用于客户端结果处理,不提供给用户程序编辑。
|
||||
对相应数据进行处理。注意,该函数主要用于客户端结果处理,不提供给用户程序编辑
|
||||
|
||||
<!-- tags: 客户端函数 -->
|
||||
|
||||
| 参数 | 类型 | 说明 |
|
||||
| ----------- | ------ | ---------------- |
|
||||
@@ -307,6 +343,8 @@ return incPrecodeCallBack('000002.SZ');
|
||||
|
||||
显示调试出错信息
|
||||
|
||||
<!-- tags: 客户端函数 -->
|
||||
|
||||
| 参数 | 类型 | 说明 |
|
||||
| ----------- | ------ | -------------------------- |
|
||||
| `func_name` | string | 字符串类型,出错的函数名称 |
|
||||
@@ -320,10 +358,12 @@ return incPrecodeCallBack('000002.SZ');
|
||||
|
||||
向运行结果窗口发送数据,省略 `nwdow` 时发送到当前窗口,指定 `nwdow` 时发送到名称对应的窗口,函数发送结果后,脚本仍可继续执行
|
||||
|
||||
| 参数 | 类型 | 说明 |
|
||||
| ------- | ------ | ---------------------------- |
|
||||
| `data` | any | 要发送到运行结果窗口的数据 |
|
||||
| `nwdow` | string | 可选,结果窗口名称 |
|
||||
<!-- tags: 客户端函数 发送 提交 -->
|
||||
|
||||
| 参数 | 类型 | 说明 |
|
||||
| ------- | ------ | -------------------------- |
|
||||
| `data` | any | 要发送到运行结果窗口的数据 |
|
||||
| `nwdow` | string | 可选,结果窗口名称 |
|
||||
|
||||
返回:any
|
||||
|
||||
@@ -337,7 +377,9 @@ echo sendRunningData(1), "\n";
|
||||
|
||||
声明:function
|
||||
|
||||
简单统计;对数据进行简单统计,得到最小值,最大值,和,平均值,样本标准差,总体标准差,样本偏差,整体偏差,总体偏差;
|
||||
简单统计;对数据进行简单统计,得到最小值,最大值,和,平均值,样本标准差,总体标准差,样本偏差,整体偏差,总体偏差
|
||||
|
||||
<!-- tags: 客户端函数 -->
|
||||
|
||||
| 参数 | 类型 | 说明 |
|
||||
| ------ | ----- | ------------------------ |
|
||||
@@ -357,7 +399,9 @@ return simpleStat(data);
|
||||
|
||||
声明:function
|
||||
|
||||
简单统计;对数据进行简单统计,得到最小值,最大值,和,平均值,样本标准差,总体标准差,样本偏差,整体偏差,总体偏差,平方和,NORM,偏度,峰度;
|
||||
简单统计;对数据进行简单统计,得到最小值,最大值,和,平均值,样本标准差,总体标准差,样本偏差,整体偏差,总体偏差,平方和,NORM,偏度,峰度
|
||||
|
||||
<!-- tags: 客户端函数 NORM -->
|
||||
|
||||
返回:统计之后的数据值,数据表结构类型的数据
|
||||
|
||||
@@ -367,6 +411,8 @@ return simpleStat(data);
|
||||
|
||||
返回'本模型只适用于债券!'字符串
|
||||
|
||||
<!-- tags: 客户端函数 返回 获取 -->
|
||||
|
||||
返回:string
|
||||
|
||||
## `thisFuncOnlyForFund()`
|
||||
@@ -375,6 +421,8 @@ return simpleStat(data);
|
||||
|
||||
返回'本模型只适用于基金!'字符串
|
||||
|
||||
<!-- tags: 客户端函数 返回 获取 -->
|
||||
|
||||
返回:string
|
||||
|
||||
## `thisFuncOnlyForStock()`
|
||||
@@ -383,6 +431,8 @@ return simpleStat(data);
|
||||
|
||||
返回'本模型只适用于股票!'字符串
|
||||
|
||||
<!-- tags: 客户端函数 返回 获取 -->
|
||||
|
||||
返回:string
|
||||
|
||||
## `thisFuncUnderConstruction()`
|
||||
@@ -391,6 +441,8 @@ return simpleStat(data);
|
||||
|
||||
返回"本模型正在维护中.....请稍候再使用"出错信息
|
||||
|
||||
<!-- tags: 客户端函数 返回 获取 -->
|
||||
|
||||
返回:string
|
||||
|
||||
## `thisFunOnlyForIndex()`
|
||||
@@ -399,13 +451,17 @@ return simpleStat(data);
|
||||
|
||||
返回'本模型只适用于指数!'字符串
|
||||
|
||||
<!-- tags: 客户端函数 返回 获取 -->
|
||||
|
||||
返回:string
|
||||
|
||||
## `threeDimFormat2()`
|
||||
|
||||
声明:function
|
||||
|
||||
公司为主,指标为辅格式。注意,该函数主要用于客户端结果处理,不提供给用户程序编辑。
|
||||
公司为主,指标为辅格式。注意,该函数主要用于客户端结果处理,不提供给用户程序编辑
|
||||
|
||||
<!-- tags: 客户端函数 -->
|
||||
|
||||
返回:any
|
||||
|
||||
@@ -413,7 +469,9 @@ return simpleStat(data);
|
||||
|
||||
声明:function
|
||||
|
||||
指标为主,年份为辅格式。注意,该函数主要用于客户端结果处理,不提供给用户程序编辑。
|
||||
指标为主,年份为辅格式。注意,该函数主要用于客户端结果处理,不提供给用户程序编辑
|
||||
|
||||
<!-- tags: 客户端函数 -->
|
||||
|
||||
返回:array,table_array
|
||||
|
||||
@@ -421,7 +479,9 @@ return simpleStat(data);
|
||||
|
||||
声明:function
|
||||
|
||||
指标为主,公司为辅格式。注意,该函数主要用于客户端结果处理,不提供给用户程序编辑。
|
||||
指标为主,公司为辅格式。注意,该函数主要用于客户端结果处理,不提供给用户程序编辑
|
||||
|
||||
<!-- tags: 客户端函数 -->
|
||||
|
||||
返回:array,table_array
|
||||
|
||||
@@ -429,7 +489,9 @@ return simpleStat(data);
|
||||
|
||||
声明:function
|
||||
|
||||
年份为主,公司为辅格式。注意,该函数主要用于客户端结果处理,不提供给用户程序编辑。
|
||||
年份为主,公司为辅格式。注意,该函数主要用于客户端结果处理,不提供给用户程序编辑
|
||||
|
||||
<!-- tags: 客户端函数 -->
|
||||
|
||||
返回:any
|
||||
|
||||
@@ -437,7 +499,9 @@ return simpleStat(data);
|
||||
|
||||
声明:function
|
||||
|
||||
年份为主,指标为辅格式。注意,该函数主要用于客户端结果处理,不提供给用户程序编辑。
|
||||
年份为主,指标为辅格式。注意,该函数主要用于客户端结果处理,不提供给用户程序编辑
|
||||
|
||||
<!-- tags: 客户端函数 -->
|
||||
|
||||
返回:array,table_array
|
||||
|
||||
@@ -445,7 +509,9 @@ return simpleStat(data);
|
||||
|
||||
声明:function
|
||||
|
||||
时间序列数据处理;将时间序列数据:时间、数据、(股票)处理成为(时间股票数据)的格式。注意,该函数主要用于客户端结果处理,不提供给用户程序编辑。
|
||||
时间序列数据处理;将时间序列数据:时间、数据、(股票)处理成为(时间股票数据)的格式。注意,该函数主要用于客户端结果处理,不提供给用户程序编辑
|
||||
|
||||
<!-- tags: 客户端函数 -->
|
||||
|
||||
返回:array
|
||||
|
||||
@@ -453,7 +519,9 @@ return simpleStat(data);
|
||||
|
||||
声明:function
|
||||
|
||||
空(NIL)数据标准化。注意,该函数主要用于客户端结果处理,不提供给用户程序编辑。
|
||||
空(NIL)数据标准化。注意,该函数主要用于客户端结果处理,不提供给用户程序编辑
|
||||
|
||||
<!-- tags: 客户端函数 NIL -->
|
||||
|
||||
| 参数 | 类型 | 说明 |
|
||||
| ------- | ------- | ------------------------- |
|
||||
@@ -465,7 +533,9 @@ return simpleStat(data);
|
||||
|
||||
声明:function
|
||||
|
||||
数组转置。注意,该函数主要用于客户端结果处理,不提供给用户程序编辑。
|
||||
数组转置。注意,该函数主要用于客户端结果处理,不提供给用户程序编辑
|
||||
|
||||
<!-- tags: 客户端函数 -->
|
||||
|
||||
| 参数 | 类型 | 说明 |
|
||||
| ------ | ----- | -------------- |
|
||||
@@ -477,7 +547,9 @@ return simpleStat(data);
|
||||
|
||||
声明:function
|
||||
|
||||
数组转置。注意,该函数主要用于客户端结果处理,不提供给用户程序编辑。
|
||||
数组转置。注意,该函数主要用于客户端结果处理,不提供给用户程序编辑
|
||||
|
||||
<!-- tags: 客户端函数 -->
|
||||
|
||||
| 参数 | 类型 | 说明 |
|
||||
| ------ | ----- | ----------------------------------------------------- |
|
||||
@@ -489,7 +561,9 @@ return simpleStat(data);
|
||||
|
||||
声明:function
|
||||
|
||||
表格转置。注意,该函数主要用于客户端结果处理,不提供给用户程序编辑。
|
||||
表格转置。注意,该函数主要用于客户端结果处理,不提供给用户程序编辑
|
||||
|
||||
<!-- tags: 客户端函数 -->
|
||||
|
||||
| 参数 | 类型 | 说明 |
|
||||
| ------ | ----- | ---------- |
|
||||
@@ -501,7 +575,9 @@ return simpleStat(data);
|
||||
|
||||
声明:function
|
||||
|
||||
表格转置。注意,该函数主要用于客户端结果处理,不提供给用户程序编辑。
|
||||
表格转置。注意,该函数主要用于客户端结果处理,不提供给用户程序编辑
|
||||
|
||||
<!-- tags: 客户端函数 -->
|
||||
|
||||
返回:array
|
||||
|
||||
@@ -509,7 +585,9 @@ return simpleStat(data);
|
||||
|
||||
声明:function
|
||||
|
||||
表格转置。注意,该函数主要用于客户端结果处理,不提供给用户程序编辑。
|
||||
表格转置。注意,该函数主要用于客户端结果处理,不提供给用户程序编辑
|
||||
|
||||
<!-- tags: 客户端函数 -->
|
||||
|
||||
返回:array
|
||||
|
||||
@@ -517,6 +595,8 @@ return simpleStat(data);
|
||||
|
||||
声明:function
|
||||
|
||||
指标为主(二维表)。注意,该函数主要用于客户端结果处理,不提供给用户程序编辑。
|
||||
指标为主(二维表)。注意,该函数主要用于客户端结果处理,不提供给用户程序编辑
|
||||
|
||||
<!-- tags: 客户端函数 -->
|
||||
|
||||
返回:array,tablearray
|
||||
|
||||
Reference in New Issue
Block a user