✨ feat(tsl-api-reference): update API catalog and data dictionary
This commit is contained in:
@@ -6,7 +6,9 @@
|
||||
|
||||
声明:function
|
||||
|
||||
分解单个图形,将图形类型、名称、数据和属性分别写入输出参数。
|
||||
分解单个图形,将图形类型、名称、数据和属性分别写入输出参数
|
||||
|
||||
<!-- tags: 图形对象 解析 parse 图形 图表 graph 对象 实例 object -->
|
||||
|
||||
| 参数 | 类型 | 说明 |
|
||||
| ------- | ------- | ------------ |
|
||||
@@ -32,7 +34,9 @@ echo graph_type, ",", graph_name, ",", length(graph_data), ",", length(graph_pro
|
||||
|
||||
声明:function
|
||||
|
||||
分解图形组合,将其中的图形和组合属性分别写入输出参数。
|
||||
分解图形组合,将其中的图形和组合属性分别写入输出参数
|
||||
|
||||
<!-- tags: 图形对象 解析 parse 图形 图表 graph 对象 实例 object -->
|
||||
|
||||
| 参数 | 类型 | 说明 |
|
||||
| ------------------ | ----------- | ---------------- |
|
||||
@@ -57,7 +61,9 @@ echo length(graph_array), ",", length(graph_group_prop);
|
||||
|
||||
声明:function
|
||||
|
||||
返回根据指定的类型、名称、数据以及属性数组生成的图形。
|
||||
根据指定的类型、名称、数据和属性数组生成图形并返回
|
||||
|
||||
<!-- tags: 图形对象 转换 编码 图形 图表 graph 对象 实例 object -->
|
||||
|
||||
| 参数 | 类型 | 说明 |
|
||||
| ------- | ------- | ---- |
|
||||
@@ -82,7 +88,9 @@ return encodeGraph(gtKLine(), 'KLine', t1, array());
|
||||
|
||||
声明:function
|
||||
|
||||
根据 TGraph 数组和组合属性生成图形组合。
|
||||
根据 TGraph 数组和组合属性生成图形组合
|
||||
|
||||
<!-- tags: 图形对象 转换 编码 图形 图表 graph 对象 实例 object -->
|
||||
|
||||
| 参数 | 类型 | 说明 |
|
||||
| ------------------ | ----- | ------------ |
|
||||
@@ -108,6 +116,8 @@ echo length(graph_array), ",", length(graph_group_prop);
|
||||
|
||||
下
|
||||
|
||||
<!-- tags: 图形对象 图形 图表 graph 对象 实例 object -->
|
||||
|
||||
返回:integer
|
||||
|
||||
## `fgLeft()`
|
||||
@@ -116,6 +126,8 @@ echo length(graph_array), ",", length(graph_group_prop);
|
||||
|
||||
左
|
||||
|
||||
<!-- tags: 图形对象 图形 图表 graph 对象 实例 object -->
|
||||
|
||||
返回:integer
|
||||
|
||||
## `fgLeftDown()`
|
||||
@@ -124,6 +136,8 @@ echo length(graph_array), ",", length(graph_group_prop);
|
||||
|
||||
左下
|
||||
|
||||
<!-- tags: 图形对象 图形 图表 graph 对象 实例 object -->
|
||||
|
||||
返回:integer
|
||||
|
||||
## `fgLeftUp()`
|
||||
@@ -132,6 +146,8 @@ echo length(graph_array), ",", length(graph_group_prop);
|
||||
|
||||
左上
|
||||
|
||||
<!-- tags: 图形对象 图形 图表 graph 对象 实例 object -->
|
||||
|
||||
返回:integer
|
||||
|
||||
## `fgNone()`
|
||||
@@ -140,6 +156,8 @@ echo length(graph_array), ",", length(graph_group_prop);
|
||||
|
||||
无标识
|
||||
|
||||
<!-- tags: 图形对象 图形 图表 graph 对象 实例 object -->
|
||||
|
||||
返回:integer
|
||||
|
||||
## `fgRight()`
|
||||
@@ -148,6 +166,8 @@ echo length(graph_array), ",", length(graph_group_prop);
|
||||
|
||||
右
|
||||
|
||||
<!-- tags: 图形对象 图形 图表 graph 对象 实例 object -->
|
||||
|
||||
返回:integer
|
||||
|
||||
## `fgRightDown()`
|
||||
@@ -156,6 +176,8 @@ echo length(graph_array), ",", length(graph_group_prop);
|
||||
|
||||
右下
|
||||
|
||||
<!-- tags: 图形对象 图形 图表 graph 对象 实例 object -->
|
||||
|
||||
返回:integer
|
||||
|
||||
## `fgRightUp()`
|
||||
@@ -164,6 +186,8 @@ echo length(graph_array), ",", length(graph_group_prop);
|
||||
|
||||
右上
|
||||
|
||||
<!-- tags: 图形对象 图形 图表 graph 对象 实例 object -->
|
||||
|
||||
返回:integer
|
||||
|
||||
## `fgUp()`
|
||||
@@ -172,6 +196,8 @@ echo length(graph_array), ",", length(graph_group_prop);
|
||||
|
||||
上
|
||||
|
||||
<!-- tags: 图形对象 图形 图表 graph 对象 实例 object -->
|
||||
|
||||
返回:integer
|
||||
|
||||
## `flBDiagonal()`
|
||||
@@ -180,13 +206,17 @@ echo length(graph_array), ",", length(graph_group_prop);
|
||||
|
||||
反斜线填充
|
||||
|
||||
<!-- tags: 图形对象 图形 图表 graph 对象 实例 object -->
|
||||
|
||||
返回:integer
|
||||
|
||||
## `flClear()`
|
||||
|
||||
声明:function
|
||||
|
||||
空心体。
|
||||
空心体
|
||||
|
||||
<!-- tags: 图形对象 图形 图表 graph 对象 实例 object -->
|
||||
|
||||
返回:integer
|
||||
|
||||
@@ -196,6 +226,8 @@ echo length(graph_array), ",", length(graph_group_prop);
|
||||
|
||||
交叉线填充
|
||||
|
||||
<!-- tags: 图形对象 图形 图表 graph 对象 实例 object -->
|
||||
|
||||
返回:integer
|
||||
|
||||
## `flDiagCross()`
|
||||
@@ -204,6 +236,8 @@ echo length(graph_array), ",", length(graph_group_prop);
|
||||
|
||||
交叉斜线填充
|
||||
|
||||
<!-- tags: 图形对象 图形 图表 graph 对象 实例 object -->
|
||||
|
||||
返回:integer
|
||||
|
||||
## `flFDiagonal()`
|
||||
@@ -212,6 +246,8 @@ echo length(graph_array), ",", length(graph_group_prop);
|
||||
|
||||
正斜线填充
|
||||
|
||||
<!-- tags: 图形对象 图形 图表 graph 对象 实例 object -->
|
||||
|
||||
返回:integer
|
||||
|
||||
## `flHorizontal()`
|
||||
@@ -220,13 +256,17 @@ echo length(graph_array), ",", length(graph_group_prop);
|
||||
|
||||
横线填充
|
||||
|
||||
<!-- tags: 图形对象 图形 图表 graph 对象 实例 object -->
|
||||
|
||||
返回:integer
|
||||
|
||||
## `flSolid()`
|
||||
|
||||
声明:function
|
||||
|
||||
实心填充。
|
||||
实心填充
|
||||
|
||||
<!-- tags: 图形对象 图形 图表 graph 对象 实例 object -->
|
||||
|
||||
返回:integer
|
||||
|
||||
@@ -236,6 +276,8 @@ echo length(graph_array), ",", length(graph_group_prop);
|
||||
|
||||
竖线填充
|
||||
|
||||
<!-- tags: 图形对象 图形 图表 graph 对象 实例 object -->
|
||||
|
||||
返回:integer
|
||||
|
||||
## `gfAmount()`
|
||||
@@ -244,6 +286,8 @@ echo length(graph_array), ",", length(graph_group_prop);
|
||||
|
||||
成交金额(数据字段),也可用于指定柱线,细柱线的值
|
||||
|
||||
<!-- tags: 图形对象 图形 图表 graph 对象 实例 object -->
|
||||
|
||||
返回:string
|
||||
|
||||
## `gfClose()`
|
||||
@@ -252,13 +296,17 @@ echo length(graph_array), ",", length(graph_group_prop);
|
||||
|
||||
收盘(数据字段),一般用于K线,美国线,宝塔线
|
||||
|
||||
<!-- tags: 图形对象 图形 图表 graph 对象 实例 object -->
|
||||
|
||||
返回:string
|
||||
|
||||
## `gfColor()`
|
||||
|
||||
声明:function
|
||||
|
||||
颜色(数据字段或TGraph的属性),可以修饰单个数据点或者整个图形的颜色。
|
||||
颜色(数据字段或TGraph的属性),可以修饰单个数据点或者整个图形的颜色
|
||||
|
||||
<!-- tags: 图形对象 图形 图表 graph 对象 实例 object -->
|
||||
|
||||
返回:string
|
||||
|
||||
@@ -266,7 +314,9 @@ echo length(graph_array), ",", length(graph_group_prop);
|
||||
|
||||
声明:function
|
||||
|
||||
图形的坐标系模式。设置为0为普通坐标,1为对数坐标,2为百分比坐标。
|
||||
图形的坐标系模式。设置为0为普通坐标,1为对数坐标,2为百分比坐标
|
||||
|
||||
<!-- tags: 图形对象 图形 图表 graph 对象 实例 object -->
|
||||
|
||||
返回:string
|
||||
|
||||
@@ -274,7 +324,9 @@ echo length(graph_array), ",", length(graph_group_prop);
|
||||
|
||||
声明:function
|
||||
|
||||
填充状况(数据字段),用于设定柱线、K线、圆圈图等填充情况。
|
||||
填充状况(数据字段),用于设定柱线、K线、圆圈图等填充情况
|
||||
|
||||
<!-- tags: 图形对象 图形 图表 graph 对象 实例 object -->
|
||||
|
||||
返回:string
|
||||
|
||||
@@ -284,6 +336,8 @@ echo length(graph_array), ",", length(graph_group_prop);
|
||||
|
||||
标示(数据字段),标示内容见图形标示函数
|
||||
|
||||
<!-- tags: 图形对象 图形 图表 graph 对象 实例 object -->
|
||||
|
||||
返回:string
|
||||
|
||||
## `gfHigh()`
|
||||
@@ -292,13 +346,17 @@ echo length(graph_array), ",", length(graph_group_prop);
|
||||
|
||||
最高(数据字段),用于K线,宝塔线,美国线
|
||||
|
||||
<!-- tags: 图形对象 图形 图表 graph 对象 实例 object -->
|
||||
|
||||
返回:string
|
||||
|
||||
## `gfLeftTitleCaption()`
|
||||
|
||||
声明:function
|
||||
|
||||
图形辅助标题文字。
|
||||
图形辅助标题文字
|
||||
|
||||
<!-- tags: 图形对象 图形 图表 graph 对象 实例 object -->
|
||||
|
||||
返回:string
|
||||
|
||||
@@ -308,13 +366,17 @@ echo length(graph_array), ",", length(graph_group_prop);
|
||||
|
||||
最低(数据字段),用于K线,宝塔线,美国线
|
||||
|
||||
<!-- tags: 图形对象 图形 图表 graph 对象 实例 object -->
|
||||
|
||||
返回:string
|
||||
|
||||
## `gfLtp()`
|
||||
|
||||
声明:function
|
||||
|
||||
流通盘(TGraphGroup的属性字段),TGraphGroup的属性,用于换手率的计算,暂时未使用,将来扩展用。
|
||||
流通盘(TGraphGroup的属性字段),TGraphGroup的属性,用于换手率的计算,暂时未使用,将来扩展用
|
||||
|
||||
<!-- tags: 图形对象 图形 图表 graph 对象 实例 object -->
|
||||
|
||||
返回:string
|
||||
|
||||
@@ -322,7 +384,9 @@ echo length(graph_array), ",", length(graph_group_prop);
|
||||
|
||||
声明:function
|
||||
|
||||
设定显示的最大值(TGraphGroup的属性字段),TGraphGroup的属性。一般的,图形会用查找视图内最小最小值用于显示,同时,为了特殊显示,也可以指定其显示的最大最小值,例如成交量的图是用0作为最小值的。
|
||||
设定显示的最大值(TGraphGroup的属性字段),TGraphGroup的属性。一般的,图形会用查找视图内最小最小值用于显示,同时,为了特殊显示,也可以指定其显示的最大最小值,例如成交量的图是用0作为最小值的
|
||||
|
||||
<!-- tags: 图形对象 查找 搜索 lookup 图形 图表 graph 对象 实例 object -->
|
||||
|
||||
返回:string
|
||||
|
||||
@@ -330,7 +394,9 @@ echo length(graph_array), ",", length(graph_group_prop);
|
||||
|
||||
声明:function
|
||||
|
||||
设定显示的最小值(TGraphGroup的属性字段),TGraphGroup的属性。一般的,图形会用查找视图内最小最小值用于显示,同时,为了特殊显示,也可以指定其显示的最大最小值,例如成交量的图是用0作为最小值的。
|
||||
设定显示的最小值(TGraphGroup的属性字段),TGraphGroup的属性。一般的,图形会用查找视图内最小最小值用于显示,同时,为了特殊显示,也可以指定其显示的最大最小值,例如成交量的图是用0作为最小值的
|
||||
|
||||
<!-- tags: 图形对象 查找 搜索 lookup 图形 图表 graph 对象 实例 object -->
|
||||
|
||||
返回:string
|
||||
|
||||
@@ -340,6 +406,8 @@ echo length(graph_array), ",", length(graph_group_prop);
|
||||
|
||||
开盘(数据字段),用于K线,宝塔线,美国线
|
||||
|
||||
<!-- tags: 图形对象 图形 图表 graph 对象 实例 object -->
|
||||
|
||||
返回:string
|
||||
|
||||
## `gfRateFlag()`
|
||||
@@ -348,6 +416,8 @@ echo length(graph_array), ",", length(graph_group_prop);
|
||||
|
||||
除权标示(数据字段),指示是否为除权日
|
||||
|
||||
<!-- tags: 图形对象 图形 图表 graph 对象 实例 object -->
|
||||
|
||||
返回:string
|
||||
|
||||
## `gfTime()`
|
||||
@@ -356,13 +426,17 @@ echo length(graph_array), ",", length(graph_group_prop);
|
||||
|
||||
时间坐标(数据字段),用于X坐标轴的显示
|
||||
|
||||
<!-- tags: 图形对象 图形 图表 graph 对象 实例 object -->
|
||||
|
||||
返回:string
|
||||
|
||||
## `gfTitleCaption()`
|
||||
|
||||
声明:function
|
||||
|
||||
图形的标题文字,TGraphGroup的属性。
|
||||
图形的标题文字,TGraphGroup的属性
|
||||
|
||||
<!-- tags: 图形对象 图形 图表 graph 对象 实例 object -->
|
||||
|
||||
返回:string
|
||||
|
||||
@@ -372,6 +446,8 @@ echo length(graph_array), ",", length(graph_group_prop);
|
||||
|
||||
宝塔线中的高值(数据字段),宝塔线也可以不需要使用此三个字段,该三个字段的内容可以被自动根据gfClose,gfOpen,gfHigh,gfLow计算出来
|
||||
|
||||
<!-- tags: 图形对象 图形 图表 graph 对象 实例 object -->
|
||||
|
||||
返回:string
|
||||
|
||||
## `gfTowerLow()`
|
||||
@@ -380,6 +456,8 @@ echo length(graph_array), ",", length(graph_group_prop);
|
||||
|
||||
宝塔线中的低值(数据字段),宝塔线也可以不需要使用此三个字段,该三个字段的内容可以被自动根据gfClose,gfOpen,gfHigh,gfLow计算出来
|
||||
|
||||
<!-- tags: 图形对象 图形 图表 graph 对象 实例 object -->
|
||||
|
||||
返回:string
|
||||
|
||||
## `gfTowerMid()`
|
||||
@@ -388,6 +466,8 @@ echo length(graph_array), ",", length(graph_group_prop);
|
||||
|
||||
宝塔线中的中值(数据字段),宝塔线也可以不需要使用此三个字段,该三个字段的内容可以被自动根据gfClose,gfOpen,gfHigh,gfLow计算出来
|
||||
|
||||
<!-- tags: 图形对象 图形 图表 graph 对象 实例 object -->
|
||||
|
||||
返回:string
|
||||
|
||||
## `gfValue()`
|
||||
@@ -396,6 +476,8 @@ echo length(graph_array), ",", length(graph_group_prop);
|
||||
|
||||
值(数据字段),可指定折线,柱线,细柱线,圆圈图的值
|
||||
|
||||
<!-- tags: 图形对象 图形 图表 graph 对象 实例 object -->
|
||||
|
||||
返回:string
|
||||
|
||||
## `gfVol()`
|
||||
@@ -404,6 +486,8 @@ echo length(graph_array), ",", length(graph_group_prop);
|
||||
|
||||
成交量(数据字段),也可用于指定柱线,细柱线的值
|
||||
|
||||
<!-- tags: 图形对象 图形 图表 graph 对象 实例 object -->
|
||||
|
||||
返回:string
|
||||
|
||||
## `gfZero()`
|
||||
@@ -412,6 +496,8 @@ echo length(graph_array), ",", length(graph_group_prop);
|
||||
|
||||
零轴(TGraphgroup的属性字段),TGraphGroup的属性,用于标示中间值,特别用于MACD类的图形
|
||||
|
||||
<!-- tags: 图形对象 图形 图表 graph 对象 实例 object MACD -->
|
||||
|
||||
返回:string
|
||||
|
||||
## `graph(_type, graph_name, data, prop1, prop1_value, prop2, prop2_value, ..., prop_n, prop_n_value)`
|
||||
@@ -420,6 +506,8 @@ echo length(graph_array), ",", length(graph_group_prop);
|
||||
|
||||
用于生成单个图形。单个图形的含义是一条折线、K线或成交量柱壮图。函数的具体的功能是:用指定的数据Data生成一个类型为Type的图形,并且用后面指定的属性参数PropN和PropNValue为图形指定修饰属性。注意,如果横坐标要显示出数据,需要把横坐标设置列名为'time'
|
||||
|
||||
<!-- tags: 图形对象 图形 图表 graph 对象 实例 object -->
|
||||
|
||||
| 参数 | 类型 | 说明 |
|
||||
| -------------- | ---------- | ---- |
|
||||
| `_type` | integer | |
|
||||
@@ -500,7 +588,9 @@ return graphGroup(g1, g2, g3);
|
||||
|
||||
声明:function
|
||||
|
||||
用于生成图形组合,可以指定任意多个单个图形作为参数生成一个图形组合,在其后面还可以指定图形组合的共有属性。
|
||||
用于生成图形组合,可以指定任意多个单个图形作为参数生成一个图形组合,在其后面还可以指定图形组合的共有属性
|
||||
|
||||
<!-- tags: 图形对象 图形 图表 graph 对象 实例 object -->
|
||||
|
||||
| 参数 | 类型 | 说明 |
|
||||
| --------- | ------ | -------------------------- |
|
||||
@@ -539,6 +629,8 @@ return graphGroup(vol_graph, mavol_graph, gfMinValue(), 0);
|
||||
|
||||
美国线类型
|
||||
|
||||
<!-- tags: 图形对象 图形 图表 graph 对象 实例 object -->
|
||||
|
||||
返回:integer
|
||||
|
||||
## `gtBar()`
|
||||
@@ -547,6 +639,8 @@ return graphGroup(vol_graph, mavol_graph, gfMinValue(), 0);
|
||||
|
||||
柱线类型
|
||||
|
||||
<!-- tags: 图形对象 图形 图表 graph 对象 实例 object -->
|
||||
|
||||
返回:integer
|
||||
|
||||
## `gtCircle()`
|
||||
@@ -555,6 +649,8 @@ return graphGroup(vol_graph, mavol_graph, gfMinValue(), 0);
|
||||
|
||||
圆圈图类型
|
||||
|
||||
<!-- tags: 图形对象 图形 图表 graph 对象 实例 object -->
|
||||
|
||||
返回:integer
|
||||
|
||||
## `gtKLine()`
|
||||
@@ -563,6 +659,8 @@ return graphGroup(vol_graph, mavol_graph, gfMinValue(), 0);
|
||||
|
||||
K线类型
|
||||
|
||||
<!-- tags: 图形对象 图形 图表 graph 对象 实例 object -->
|
||||
|
||||
返回:integer
|
||||
|
||||
## `gtLine()`
|
||||
@@ -571,6 +669,8 @@ K线类型
|
||||
|
||||
折线类型
|
||||
|
||||
<!-- tags: 图形对象 图形 图表 graph 对象 实例 object -->
|
||||
|
||||
返回:integer
|
||||
|
||||
## `gtSingleBar()`
|
||||
@@ -579,6 +679,8 @@ K线类型
|
||||
|
||||
细柱线类型
|
||||
|
||||
<!-- tags: 图形对象 图形 图表 graph 对象 实例 object -->
|
||||
|
||||
返回:integer
|
||||
|
||||
## `gtTower()`
|
||||
@@ -587,4 +689,6 @@ K线类型
|
||||
|
||||
宝塔线类型
|
||||
|
||||
<!-- tags: 图形对象 图形 图表 graph 对象 实例 object -->
|
||||
|
||||
返回:integer
|
||||
|
||||
Reference in New Issue
Block a user