插件
插件是一些独立的模块,可以给 HXKlineChart 增加新功能和扩展已有功能。
插件存放在dist/plugins/
路径下,类型声明文件放在同目录下,可按需引入。
所有插件导出的模块名统一带有前缀:HXKlineChart_Plugins_[插件名]
,如画线插件:HXKlineChart_Plugins_DrawLine
,umd 格式会自动挂载在 window 全局对象上。
WARNING
插件使用前提是已经引入 HXKlineChart 基础依赖。
加载插件
cdn 引入
html
<script type="text/javascript" src="dist/HXKlineChart.[version].js"></script>
<script type="text/javascript" src="dist/plugins/[插件名称].[version].js"></script>
javascript
window.HXKlineChart.use(window[`HXKlineChart_Plugin_${插件名称}`]);
// 例如画线插件:DrawLine
window.HXKlineChart.use(window.HXKlineChart_Plugin_DrawLine);
TIP
- 完整cdn地址需要拼接版本号,版本号参考Header顶部标题栏
- 例如:https://s.thsi.cn/cd/b2cweb-component-hxklinechart-front/index.2.0.17.js
- 海外版注意_ainvest后缀
npm 引入
javascript
import HXKlineChart from '@ths-m/HXKlineChart';
import pluginModule '@ths-m/HXKlineChart/dist/plugins/[插件名称].js';
HXKlineChart.use(pluginModule);
WARNING
- 由于使用同一份package配置,海外版使用ts类型时,ts类型仍旧需要从
@ths-m/HXKlineChart
或@ths-m/HXKline
中引入 - 例如:import { SourceModeMap } from '@ths-m/HXKline';
目前支持的插件
1.画线插件
- 插件名称:
DrawLine
; - 提供完整画线能力和画线工具栏功能,自动挂载画线覆盖物(详见画线)。
2. 麦语言指标插件
- 插件名称:
MaiIndicator
; - 支持麦语言指标公式解析与绘制。
3. PineScript指标插件
- 插件名称:
PineIndicator
; - 支持PineScript指标公式解析与绘制。
4. 公式指标插件
- 插件名称:
FuncIndicator
; - 已接入同花顺公式SDK(wasm包);
- 支持同花顺公式指标解析与绘制,后续麦语言与同花顺公式语法会统一合并成公式SDK,因此未来国内自编指标统一用此插件来解析绘制。