feat(tsl-api-reference): index class and unit APIs

Migrate reference pages to declaration-line storage and rebuild the
13-column index.

Add qualified member lookup plus regression and end-to-end coverage.
This commit is contained in:
csh
2026-07-29 15:47:46 +08:00
parent 9edc8fc868
commit 13be5ea0aa
239 changed files with 39157 additions and 12846 deletions
@@ -2,6 +2,8 @@
## `paletteIndex(i)`
声明:function
调色板中的颜色。
| 参数 | 类型 | 说明 |
@@ -12,138 +14,184 @@
## `clBlack()`
声明:function
黑色
返回:integer
## `clMaroon()`
声明:function
栗色
返回:integer
## `clGreen()`
声明:function
绿色
返回:integer
## `clOlive()`
声明:function
橄榄色
返回:integer
## `clNavy()`
声明:function
海蓝色
返回:integer
## `clPurple()`
声明:function
紫色
返回:integer
## `clTeal()`
声明:function
水鸭色
返回:integer
## `clGray()`
声明:function
灰色
返回:integer
## `clSilver()`
声明:function
银白色
返回:integer
## `clRed()`
声明:function
红色
返回:integer
## `clLime()`
声明:function
橙色
返回:integer
## `clYellow()`
声明:function
黄色
返回:integer
## `clBlue()`
声明:function
蓝色
返回:integer
## `clFuchsia()`
声明:function
紫红色
返回:integer
## `clAqua()`
声明:function
特殊色
返回:integer
## `clLtGray()`
声明:function
淡灰色
返回:integer
## `clDkGray()`
声明:function
亮灰色
返回:integer
## `clWhite()`
声明:function
白色
返回:integer
## `clMoneyGreen()`
声明:function
钱绿色
返回:integer
## `clSkyBlue()`
声明:function
天蓝色
返回:integer
## `clCream()`
声明:function
奶油色
返回:integer
## `clMedGray()`
声明:function
中灰色
返回:integer
## `getCValue(cmyk)`
声明:function
得到颜色的cmyk模式的C值。
| 参数 | 类型 | 说明 |
@@ -154,6 +202,8 @@
## `getMValue(cmyk)`
声明:function
得到颜色的cmyk模式的M值。
| 参数 | 类型 | 说明 |
@@ -164,6 +214,8 @@
## `getYValue(cmyk)`
声明:function
得到颜色的cmyk模式的Y值。
| 参数 | 类型 | 说明 |
@@ -174,6 +226,8 @@
## `getKValue(cmyk)`
声明:function
得到颜色的cmyk模式的K值。
| 参数 | 类型 | 说明 |
@@ -184,6 +238,8 @@
## `cmyk(c, m, y, k)`
声明:function
将C、M、Y、K值合成颜色。
| 参数 | 类型 | 说明 |
@@ -197,6 +253,8 @@
## `rgb(r, g, b)`
声明:function
将R、G、B值合成颜色。
| 参数 | 类型 | 说明 |
@@ -209,12 +267,16 @@
## `rgbbgr()`
声明:function
颜色转换,对RGB和BGR两种颜色规范进行转换。
返回:any
## `paletteRgb(r, g, b)`
声明:function
将R、G、B值合成调色板的颜色。
| 参数 | 类型 | 说明 |
@@ -227,6 +289,8 @@
## `getRValue(rgb)`
声明:function
得到颜色的R值。
| 参数 | 类型 | 说明 |
@@ -237,6 +301,8 @@
## `getGValue(rgb)`
声明:function
得到颜色的G值。
| 参数 | 类型 | 说明 |
@@ -247,6 +313,8 @@
## `getBValue(rgb)`
声明:function
得到颜色的B值。
| 参数 | 类型 | 说明 |
@@ -257,6 +325,8 @@
## `class(ts_optimizer)`
声明:function
TSPortfolioOptimizer组合优化框架类,主要封装了常见的组合优化目标和组合约束条件。 优化目标:跟踪误差最小、超额收益最大、信息比率最大、组合风险最小、组合你和指数残差平方和最小、组合收益最大等; 约束条件:包括线性约束和非线性约束。线性约束包括个股权重、行业权重等约束;非线性约束包括超额收益、跟踪误差、信息比率等约束; 用户也可以自己重写自己的优化目标和约束条件。 详细说明及范例见组合优化专题,如下链接。
| 参数 | 类型 | 说明 |
@@ -2,6 +2,8 @@
## `graphGroup(graph1, graph_n, prop_m, value_m)`
声明:function
用于生成图形组合,可以指定任意多个单个图形作为参数生成一个图形组合,在其后面还可以指定图形组合的共有属性。
| 参数 | 类型 | 说明 |
@@ -32,6 +34,8 @@ gfMinValue():设定最小值。一般的,图形会用查找视图内最小
## `encodeGraph(_type, name, data, prop)`
声明:function
返回根据指定的类型、名称、数据以及属性数组生成的图形。
| 参数 | 类型 | 说明 |
@@ -71,282 +75,376 @@ return encodeGraph(gtKLine(), 'KLine', t1, array());
## `gfColor()`
声明:function
颜色(数据字段或TGraph的属性),可以修饰单个数据点或者整个图形的颜色。
返回:string
## `gfFill()`
声明:function
填充状况(数据字段),用于设定柱线、K线、圆圈图等填充情况。
返回:string
## `gfFlag()`
声明:function
标示(数据字段),标示内容见图形标示函数
返回:string
## `gfZero()`
声明:function
零轴(TGraphgroup的属性字段)TGraphGroup的属性,用于标示中间值,特别用于MACD类的图形
返回:string
## `gfMaxValue()`
声明:function
设定显示的最大值(TGraphGroup的属性字段)TGraphGroup的属性。一般的,图形会用查找视图内最小最小值用于显示,同时,为了特殊显示,也可以指定其显示的最大最小值,例如成交量的图是用0作为最小值的。
返回:string
## `gfMinValue()`
声明:function
设定显示的最小值(TGraphGroup的属性字段)TGraphGroup的属性。一般的,图形会用查找视图内最小最小值用于显示,同时,为了特殊显示,也可以指定其显示的最大最小值,例如成交量的图是用0作为最小值的。
返回:string
## `gfLtp()`
声明:function
流通盘(TGraphGroup的属性字段)TGraphGroup的属性,用于换手率的计算,暂时未使用,将来扩展用。
返回:string
## `gfTitleCaption()`
声明:function
图形的标题文字,TGraphGroup的属性。
返回:string
## `gfLeftTitleCaption()`
声明:function
图形辅助标题文字。
返回:string
## `gfCoordinate()`
声明:function
图形的坐标系模式。设置为0为普通坐标,1为对数坐标,2为百分比坐标。
返回:string
## `gfValue()`
声明:function
值(数据字段),可指定折线,柱线,细柱线,圆圈图的值
返回:string
## `gfClose()`
声明:function
收盘(数据字段),一般用于K线,美国线,宝塔线
返回:string
## `gfOpen()`
声明:function
开盘(数据字段),用于K线,宝塔线,美国线
返回:string
## `gfHigh()`
声明:function
最高(数据字段),用于K线,宝塔线,美国线
返回:string
## `gfLow()`
声明:function
最低(数据字段),用于K线,宝塔线,美国线
返回:string
## `gfTowerLow()`
声明:function
宝塔线中的低值(数据字段),宝塔线也可以不需要使用此三个字段,该三个字段的内容可以被自动根据gfClose,gfOpen,gfHigh,gfLow计算出来
返回:string
## `gfTowerHigh()`
声明:function
宝塔线中的高值(数据字段),宝塔线也可以不需要使用此三个字段,该三个字段的内容可以被自动根据gfClose,gfOpen,gfHigh,gfLow计算出来
返回:string
## `gfTowerMid()`
声明:function
宝塔线中的中值(数据字段),宝塔线也可以不需要使用此三个字段,该三个字段的内容可以被自动根据gfClose,gfOpen,gfHigh,gfLow计算出来
返回:string
## `gfVol()`
声明:function
成交量(数据字段),也可用于指定柱线,细柱线的值
返回:string
## `gfAmount()`
声明:function
成交金额(数据字段),也可用于指定柱线,细柱线的值
返回:string
## `gfTime()`
声明:function
时间坐标(数据字段),用于X坐标轴的显示
返回:string
## `gfRateFlag()`
声明:function
除权标示(数据字段),指示是否为除权日
返回:string
## `flSolid()`
声明:function
实心填充。
返回:integer
## `flClear()`
声明:function
空心体。
返回:integer
## `flHorizontal()`
声明:function
横线填充
返回:integer
## `flVertical()`
声明:function
竖线填充
返回:integer
## `flFDiagonal()`
声明:function
正斜线填充
返回:integer
## `flBDiagonal()`
声明:function
反斜线填充
返回:integer
## `flCross()`
声明:function
交叉线填充
返回:integer
## `flDiagCross()`
声明:function
交叉斜线填充
返回:integer
## `gtLine()`
声明:function
折线类型
返回:integer
## `gtKLine()`
声明:function
K线类型
返回:integer
## `gtTower()`
声明:function
宝塔线类型
返回:integer
## `gtAmerican()`
声明:function
美国线类型
返回:integer
## `gtBar()`
声明:function
柱线类型
返回:integer
## `gtSingleBar()`
声明:function
细柱线类型
返回:integer
## `gtCircle()`
声明:function
圆圈图类型
返回:integer
## `fgNone()`
声明:function
无标识
返回:integer
## `fgUp()`
声明:function
返回:integer
## `fgDown()`
声明:function
返回:integer
## `fgLeft()`
声明:function
返回:integer
## `fgRight()`
声明:function
返回:integer
## `fgLeftUp()`
声明:function
左上
返回:integer
## `fgLeftDown()`
声明:function
左下
返回:integer
## `fgRightUp()`
声明:function
右上
返回:integer
## `fgRightDown()`
声明:function
右下
返回:integer
## `graph(_type, graph_name, data, prop1, prop1_value, prop2, prop2_value, ..., prop_n, prop_n_value)`
声明:function
用于生成单个图形。单个图形的含义是一条折线、K线或成交量柱壮图。函数的具体的功能是:用指定的数据Data生成一个类型为Type的图形,并且用后面指定的属性参数PropN和PropNValue为图形指定修饰属性。注意,如果横坐标要显示出数据,需要把横坐标设置列名为'time'
| 参数 | 类型 | 说明 |