✨ 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,130 @@
+# 事件套利 / 指数调整效应
+
+## `TSIndexEffect`
+
+声明：class
+
+指数调整效应框架
+
+<!-- tags: 基准指数 指数产品 指数调整 调入调出 事件研究 -->
+
+### `fAdjustIndexID`
+
+声明：field
+
+所调指数代码 SH000300
+
+可见性：`public`
+
+类型：string
+
+### `fBegt`
+
+声明：field
+
+开始日 从当前系统时间往前推 1 年
+
+可见性：`public`
+
+类型：date
+
+### `fEndt`
+
+声明：field
+
+截止日 当前系统时间
+
+可见性：`public`
+
+类型：date
+
+### `fEventDay`
+
+声明：field
+
+事件日类型 0：实施日
+
+可见性：`public`
+
+类型：integer
+
+### `fInout`
+
+声明：field
+
+调入调出类型 0：调入
+
+可见性：`public`
+
+类型：integer
+
+### `getRegularAdjustData()`
+
+声明：function
+
+获取指定指数与区间内定期调整的调入或调出样本
+
+<!-- tags: 查询 指数定期调整 调入调出 成分股 -->
+
+可见性：`public`
+
+返回：array
+
+### `getRegularAdjustmentDate()`
+
+声明：function
+
+获取指定指数与区间内定期调整的发生日期列表
+
+<!-- tags: 查询 指数定期调整 实施日期 事件时间 -->
+
+可见性：`public`
+
+返回：array
+
+### `getImpleDate(indexid, begt, endt)`
+
+声明：function
+
+此接口可重写，可以按对应指数定期调整规则获取指数定期调整实施日，默认沪深300 指数
+
+<!-- tags: 查询 基准指数 指数产品 交易日期 日期时间 -->
+
+可见性：`public`
+
+| 参数      | 类型     | 说明             |
+| --------- | -------- | ---------------- |
+| `indexid` | string   | String，所调指数 |
+| `begt`    | datetime | Date，开始日     |
+| `endt`    | datetime | Date，截止日     |
+
+返回：array
+
+### `getInspecLastDate(indexid, imple_date)`
+
+声明：function
+
+此接口可重写，可以按对应指数定期调整规则获取指数定期调整考察期结束日，默认沪深 300
+
+<!-- tags: 查询 基准指数 指数产品 交易日期 日期时间 -->
+
+可见性：`public`
+
+| 参数         | 类型   | 说明             |
+| ------------ | ------ | ---------------- |
+| `indexid`    | string | String，所调指数 |
+| `imple_date` | date   | Date，实施日     |
+
+返回：date
+
+### `getSampleData()`
+
+声明：function
+
+此接口为重写父类事件套利框架接口，获取指数定调事件的事件样本数据
+
+<!-- tags: 查询 事件驱动 事件研究 基准指数 指数产品 -->
+
+可见性：`public`
+
+返回：array