✨ feat(tsl-api-reference): expand API and module coverage

2026-08-14 17:12:55 +08:00
parent 8f1056130d
commit 3d3036ebe1
571 changed files with 47842 additions and 14458 deletions
@@ -0,0 +1,234 @@
+# 因子研究 / 宏观风险因子
+
+## `TS_HGRiskFMP`
+
+声明：class
+
+基于多空组合的宏观风险因子框架
+
+<!-- tags: 因子分析 因子指标 风险管理 风控 多头空头 宏观经济 宏观因子 多空组合 -->
+
+### `fBegT`
+
+声明：field
+
+区间开始日 IncYear(Today(),-3)+1
+
+可见性：`public`
+
+类型：date
+
+### `fEndT`
+
+声明：field
+
+区间截止日 Today()
+
+可见性：`public`
+
+类型：date
+
+### `fFactorAssetDZ`
+
+声明：field
+
+因子资产对照
+
+可见性：`public`
+
+类型：array
+
+### `fFactorWeight`
+
+声明：field
+
+因子加权方式
+
+可见性：`public`
+
+类型：array
+
+### `getAssetReturn(index_arr, beg_t, end_t)`
+
+声明：function
+
+获取区间资产每日收益率(%)，用户可重写，缺省情况下框架会根据输入成员变量自动计算每
+
+<!-- tags: 查询 回报率 投资收益 -->
+
+可见性：`public`
+
+| 参数        | 类型  | 说明             |
+| ----------- | ----- | ---------------- |
+| `index_arr` | array | Array，资产列表  |
+| `beg_t`     | date  | Date，区间开始日 |
+| `end_t`     | date  | Date，区间截止日 |
+
+返回：array
+
+### `getRealHGDataYoY(beg_t, end_t)`
+
+声明：function
+
+获取区间真实宏观指标，主要用于与计算宏观风险因子进行比对，用户可重写，缺省情况下
+
+<!-- tags: 查询 因子分析 因子指标 风险管理 风控 宏观经济 宏观因子 -->
+
+可见性：`public`
+
+| 参数    | 类型 | 说明             |
+| ------- | ---- | ---------------- |
+| `beg_t` | date | Date，区间开始日 |
+| `end_t` | date | Date，区间截止日 |
+
+返回：array
+
+### `getHGFactorReturn(r_type)`
+
+声明：function
+
+获取样本内宏观风险因子收益(%)
+
+<!-- tags: 查询 回报率 投资收益 因子分析 因子指标 风险管理 风控 宏观经济 -->
+
+可见性：`public`
+
+| 参数     | 类型 | 说明                                                                                                                                                                                           |
+| -------- | ---- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
+| `r_type` | int  | 返回类型 取值 含义 备注 0 每日收益(%) 每日资产收益按照权重合成 1 累计收益(%) 区间开始日到当前的每日累计收益(%) 2 同比收益(%) 过去 1 年每日收益(%)的累计值，数据超过 1 年可算，影响输出数据长度 |
+
+返回：array
+
+### `getAllAssetReturn(r_type)`
+
+声明：function
+
+获取样本内所有资产收益(%)
+
+<!-- tags: 查询 回报率 投资收益 -->
+
+可见性：`public`
+
+| 参数     | 类型 | 说明                            |
+| -------- | ---- | ------------------------------- |
+| `r_type` | int  | 参考 GetHGFactorReturn 参数说明 |
+
+返回：array
+
+### `getHGFactorCorrMat()`
+
+声明：function
+
+样本内因子每日收益的相关系数矩阵
+
+<!-- tags: 查询 因子分析 因子指标 相关性 关联关系 -->
+
+可见性：`public`
+
+返回：array
+
+### `getAllAssetCorrMat()`
+
+声明：function
+
+样本内资产每日收益的相关系数矩阵
+
+<!-- tags: 查询 相关性 关联关系 -->
+
+可见性：`public`
+
+返回：array
+
+### `getRealAndHGFactorData()`
+
+声明：function
+
+样本内宏观风险因子同比收益(%)与真实宏观指标的比对
+
+<!-- tags: 查询 因子分析 因子指标 风险管理 风控 宏观经济 宏观因子 -->
+
+可见性：`public`
+
+返回：array
+
+### `getHGFactorWeight()`
+
+声明：function
+
+宏观风险因子在各个资产上的计算权重(%)，可用于合成高频宏观风险因子
+
+<!-- tags: 查询 因子分析 因子指标 风险管理 风控 组合权重 资产配置 宏观经济 -->
+
+可见性：`public`
+
+返回：array
+
+### `getHGFactorReturn_OutSample(v_beg_t, v_end_t)`
+
+声明：function
+
+样本外因子每日收益(%)，仅支持每日收益、不支持累计与同比
+
+<!-- tags: 查询 因子分析 因子指标 -->
+
+可见性：`public`
+
+| 参数      | 类型 | 说明               |
+| --------- | ---- | ------------------ |
+| `v_beg_t` | date | Date，样本外开始日 |
+| `v_end_t` | date | Date，样本外截止日 |
+
+返回：array
+
+### `getAllAssetReturn_OutSample(v_beg_t, v_end_t)`
+
+声明：function
+
+样本外资产每日收益(%)，仅支持每日收益、不支持累计与同比
+
+<!-- tags: 查询 样本外收益 资产收益率 宏观因子 -->
+
+可见性：`public`
+
+| 参数      | 类型 | 说明               |
+| --------- | ---- | ------------------ |
+| `v_beg_t` | date | Date，样本外开始日 |
+| `v_end_t` | date | Date，样本外截止日 |
+
+返回：array
+
+### `getAssetTBReturn(stocks, beg_t, end_t, cycle)`
+
+声明：function
+
+获取区间资产同比收益率(%)，同比收益率(%)=(当前收盘价-1 年前收盘价)/1 年前收盘*100
+
+<!-- tags: 查询 回报率 投资收益 -->
+
+可见性：`public`
+
+| 参数     | 类型   | 说明             |
+| -------- | ------ | ---------------- |
+| `stocks` | array  | Array，资产列表  |
+| `beg_t`  | date   | Date，区间开始日 |
+| `end_t`  | date   | Date，区间截止日 |
+| `cycle`  | string | String，周期     |
+
+返回：array
+
+### `getRealHGData_VHG01(beg_t, end_t)`
+
+声明：function
+
+获取区间真实宏观指标-VHG01 版，包含 6 个真实宏观指标，月线数据，输出参考
+
+<!-- tags: 查询 打印 宏观经济 宏观因子 -->
+
+可见性：`public`
+
+| 参数    | 类型 | 说明             |
+| ------- | ---- | ---------------- |
+| `beg_t` | date | Date，区间开始日 |
+| `end_t` | date | Date，区间截止日 |
+
+返回：array