Files
playbook/docs/tsl/codegen/builtin/graphics.md
T

595 lines
11 KiB
Markdown

# Builtin - 图形函数
## 函数
### `encodeGraph(type, name, data, prop)`
编码图形对象。
| 参数 | 类型 | 说明 |
| ------ | ------ | -------- |
| `type` | any | 图形类型 |
| `name` | string | 图形名称 |
| `data` | array | 图形数据 |
| `prop` | array | 图形选项 |
返回:any
### `graphGroup(arg1, arg2, arg3, arg4)`
作图函数相关函数。
| 参数 | 类型 | 说明 |
| ------ | ---- | ---- |
| `arg1` | any | |
| `arg2` | any | |
| `arg3` | any | |
| `arg4` | any | |
返回:any
## 图形字段函数
### `gfColor()`
图形字段函数相关函数。
返回:any
### `gfFill()`
图形字段函数相关函数。
返回:any
### `gfFlag()`
图形字段函数相关函数。
返回:any
### `gfZero()`
图形字段函数相关函数。
返回:any
### `gfMaxValue()`
图形字段函数相关函数。
返回:any
### `gfMinValue()`
图形字段函数相关函数。
返回:any
### `gfLtp()`
图形字段函数相关函数。
返回:any
### `gfTitleCaption()`
图形字段函数相关函数。
返回:any
### `gfLeftTitleCaption()`
图形字段函数相关函数。
返回:any
### `gfCoordinate()`
图形字段函数相关函数。
返回:any
### `gfValue()`
返回图形字段常量。
返回:any
### `gfClose()`
返回图形字段常量。
返回:any
### `gfOpen()`
返回图形字段常量。
返回:any
### `gfHigh()`
返回图形字段常量。
返回:any
### `gfLow()`
返回图形字段常量。
返回:any
### `gfTowerLow()`
返回图形字段常量。
返回:any
### `gfTowerHigh()`
返回图形字段常量。
返回:any
### `gfTowerMid()`
返回图形字段常量。
返回:any
### `gfVol()`
返回图形字段常量。
返回:any
### `gfAmount()`
返回图形字段常量。
返回:any
### `gfTime()`
返回图形字段常量。
返回:any
### `gfRateFlag()`
返回图形字段常量。
返回:any
## 图形填充设置函数
### `flSolid()`
图形填充设置函数相关函数。
返回:any
### `flClear()`
图形填充设置函数相关函数。
返回:any
### `flHorizontal()`
图形填充设置函数相关函数。
返回:any
### `flVertical()`
图形填充设置函数相关函数。
返回:any
### `flFDiagonal()`
图形填充设置函数相关函数。
返回:any
### `flBDiagonal()`
图形填充设置函数相关函数。
返回:any
### `flCross()`
图形填充设置函数相关函数。
返回:any
### `flDiagCross()`
图形填充设置函数相关函数。
返回:any
## 图形类型函数
### `gtLine()`
返回图形类型常量。
返回:any
### `gtKLine()`
返回图形类型常量。
返回:any
### `gtTower()`
返回图形类型常量。
返回:any
### `gtAmerican()`
返回图形类型常量。
返回:any
### `gtBar()`
返回图形类型常量。
返回:any
### `gtSingleBar()`
返回图形类型常量。
返回:any
### `gtCircle()`
返回图形类型常量。
返回:any
## 图形标示函数
### `fgNone()`
返回图形标示常量。
返回:any
### `fgUp()`
返回图形标示常量。
返回:any
### `fgDown()`
返回图形标示常量。
返回:any
### `fgLeft()`
返回图形标示常量。
返回:any
### `fgRight()`
返回图形标示常量。
返回:any
### `fgLeftUp()`
返回图形标示常量。
返回:any
### `fgLeftDown()`
返回图形标示常量。
返回:any
### `fgRightUp()`
返回图形标示常量。
返回:any
### `fgRightDown()`
返回图形标示常量。
返回:any
## 颜色函数
### `clBlack()`
返回颜色常量。
返回:any
### `clMaroon()`
返回颜色常量。
返回:any
### `clGreen()`
返回颜色常量。
返回:any
### `clOlive()`
返回颜色常量。
返回:any
### `clNavy()`
返回颜色常量。
返回:any
### `clPurple()`
返回颜色常量。
返回:any
### `clTeal()`
返回颜色常量。
返回:any
### `clGray()`
返回颜色常量。
返回:any
### `clSilver()`
返回颜色常量。
返回:any
### `clRed()`
返回颜色常量。
返回:any
### `clLime()`
返回颜色常量。
返回:any
### `clYellow()`
返回颜色常量。
返回:any
### `clBlue()`
返回颜色常量。
返回:any
### `clFuchsia()`
返回颜色常量。
返回:any
### `clAqua()`
返回颜色常量。
返回:any
### `clLtGray()`
返回颜色常量。
返回:any
### `clDkGray()`
返回颜色常量。
返回:any
### `clWhite()`
返回颜色常量。
返回:any
### `clMoneyGreen()`
返回颜色常量。
返回:any
### `clSkyBlue()`
返回颜色常量。
返回:any
### `clCream()`
返回颜色常量。
返回:any
### `clMedGray()`
返回颜色常量。
返回:any
## 颜色变换函数
### `getCValue(color)`
从颜色值中取 C 分量。
| 参数 | 类型 | 说明 |
| ------- | ---- | ------ |
| `color` | any | 颜色值 |
返回:any
### `getMValue(color)`
从颜色值中取 M 分量。
| 参数 | 类型 | 说明 |
| ------- | ---- | ------ |
| `color` | any | 颜色值 |
返回:any
### `getYValue(color)`
从颜色值中取 Y 分量。
| 参数 | 类型 | 说明 |
| ------- | ---- | ------ |
| `color` | any | 颜色值 |
返回:any
### `getKValue(color)`
从颜色值中取 K 分量。
| 参数 | 类型 | 说明 |
| ------- | ---- | ------ |
| `color` | any | 颜色值 |
返回:any
### `cmyk(c, m, y, k)`
按 C、M、Y、K 分量生成颜色值。
| 参数 | 类型 | 说明 |
| ---- | ---- | ------ |
| `c` | any | C 分量 |
| `m` | any | M 分量 |
| `y` | any | Y 分量 |
| `k` | any | K 分量 |
返回:any
### `rgb(r, g, b)`
按 R、G、B 分量生成颜色值。
| 参数 | 类型 | 说明 |
| ---- | ---- | ------ |
| `r` | any | R 分量 |
| `g` | any | G 分量 |
| `b` | any | B 分量 |
返回:any
### `rgbbgr(color)`
转换 RGB/BGR 颜色值。
| 参数 | 类型 | 说明 |
| ------- | ---- | ------ |
| `color` | any | 颜色值 |
返回:any
### `paletteRgb(r, g, b)`
按 R、G、B 分量生成调色板颜色值。
| 参数 | 类型 | 说明 |
| ---- | ---- | ------ |
| `r` | any | R 分量 |
| `g` | any | G 分量 |
| `b` | any | B 分量 |
返回:any
### `paletteIndex(index)`
按调色板索引生成颜色值。
| 参数 | 类型 | 说明 |
| ------- | ---- | ---------- |
| `index` | any | 调色板索引 |
返回:any
### `getRValue(color)`
从颜色值中取 R 分量。
| 参数 | 类型 | 说明 |
| ------- | ---- | ------ |
| `color` | any | 颜色值 |
返回:any
### `getGValue(color)`
从颜色值中取 G 分量。
| 参数 | 类型 | 说明 |
| ------- | ---- | ------ |
| `color` | any | 颜色值 |
返回:any
### `getBValue(color)`
从颜色值中取 B 分量。
| 参数 | 类型 | 说明 |
| ------- | ---- | ------ |
| `color` | any | 颜色值 |
返回:any
## 作图函数
### `graph(type, graph_name, data, prop_n, prop_n_value)`
用于生成单个图形。单个图形的含义是一条折线、K线或成交量柱壮图。函数的具体的功能是:用指定的数据Data生成一个类型为Type的图形,并且用后面指定的属性参数PropN和PropNValue为图形指定修饰属性。注意,如果横坐标要显示出数据,需要把横坐标设置列名为'time' 先得到一个用于作图的二维数组GData,然后用graph函数作图,参数gtLine()表示要做折线,”MA5”是图线的名称,Gdata是作图数据,gfColor()和clBlue()是一对属性值,gfColor()指明是颜色属性,那么对应的值就是clBlue()蓝色。 在Gdata中并没有gfValue字段以及其他标准属性字段,因此将第一个数据字段'MA5'作为gfValue来作图。
| 参数 | 类型 | 说明 |
| -------------- | ------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
| `type` | any | 整数,图形类型。为了便于使用理解,提供相应的图形类型函数,函数见图形类型函数; |
| `graph_name` | string | 字符串,函数图线名称。 |
| `data` | array | 二维数组,用来作图的数据。往往是由Nday2函数得到,其系统默认的数据字段名见图形字段函数。如gftime、gfclose、gfopen、gfhigh、gflow、gfvol、gfAmount。 |
| `prop_n` | string | 指出是对哪个属性做修饰,必须和PropNValue配对出现的参数。PropN的系统默认数据字段见图形字段函数:在某种图形类别下,如果没有指定系统默认的数据字段的时候,系统会使用第一个存在的数据字段当成默认的来显示。如果存在多个系统默认的数据字段,则系统根据如下优先级别处理:例如,对于gtLine图形,由Nday函数或其他方式得到了一个二维数组GDATA,首先选择用GDATA中gfValue字段下的值作图,如果二维数组中没有gfValue字段,则选择gfClose字段下的值做图,依次类推 |
| `prop_n_value` | any | 给出了这个属性的值。属性的定义也可以用一个一维的以字符串作下标的数组完成,如果是一维数组,则下标就是PropName,对应的值就是PropValue。Nday函数也可以指定属性,这里指定的属性与Nday指定的属性区别是Nday函数可以指定每个点的属性,这里指定的属性是整个图形的属性,每个点都相同,可以较少的占用系统资源。 |
返回:array
## 未细分函数