st-comp 0.0.148 → 0.0.150

package/packages/Kline/type.d.ts

@@ -0,0 +1,219 @@
+import type { ElementEvent, ECElementEvent } from 'echarts'
+
+/**
+ * @description: K线单条数据类型
+ * [时间,开,高,低,收,成交量,成交额]
+ */
+export type KlineDataItem = [string, number, number, number, number, number, number]
+
+/**
+ * @description: K线数据类型
+ * [[时间,开,高,低,收,成交量,成交额], ...]
+ */
+export type KlineDataType = KlineDataItem[]
+
+/**
+ * @description: K线组件默认配置类型
+ */
+export interface InConfig {
+  totalBarCount: number // k线总条数
+  defaultShowBarCount: number // k线默认展示条数
+  preBarCount: number // k线预加载条数，用于计算指标线
+  maxValueSpan: number // k线一屏最大数量
+  gridLeft: number // k线组件 grid.left
+  gridTop: number // k线组件 grid.top
+  gridRight: number // k线组件 grid.right
+  gridBottom: number // k线组件 grid.bottom
+  warningConfig: any // 预警线配置
+  positionConfig: any // 持仓线配置
+  conditionConfig: any // 条件单配置
+  tipsConfig: any // Tips展示配置
+  dynamicLoadConfig: any // 动态加载历史/后续K线配置
+  zoomLock: boolean // 是否禁用滚轮缩放K线
+  isOpenDS: boolean // 是否开启收盘价分布统计功能
+}
+
+//----------------额外画线数据相关TS类型---------------------
+
+/**
+ * @description: 额外画线-基础customConfig
+ * @example
+ *  draggable?: boolean 是否支持拖拽[默认值:false]
+ */
+interface LineCustomConfigType {
+  draggable?: boolean
+}
+
+/**
+ * @description: 额外画线-预警线customConfig
+ * @example
+ *  draggable?: boolean 是否支持拖拽[默认值:false]
+ *  lineColor?: string 主线颜色
+ *  textColor?: string 主线文本颜色
+ */
+export interface WarningConfigType extends LineCustomConfigType {
+  lineColor?: string
+  textColor?: string
+}
+
+/**
+ * @description: 额外画线-持仓线customConfig
+ * @example
+ *  draggable?: boolean 是否支持拖拽[默认值:false]
+ *  lineColor?: string 主线颜色
+ *  textColor?: string 主线文本颜色
+ */
+export interface PositionConfigType extends LineCustomConfigType {
+  lineColor?: string
+  textColor?: string
+}
+
+/**
+ * @description: 额外画线-条件单customConfig
+ * @example
+ *  draggable?: boolean 是否支持拖拽[默认值:false]
+ *  lineColor?: string 主线颜色
+ *  textColor?: string 主线文本颜色
+ *  profitLineColor?: string 止盈线颜色
+ *  profitTextColor?: string 止盈线文本颜色
+ *  lossLineColor?: string 止损线颜色
+ *  lossTextColor?: string 止损线文本颜色
+ */
+export interface ConditionConfigType extends LineCustomConfigType {
+  lineColor?: string
+  textColor?: string
+  profitLineColor?: string
+  profitTextColor?: string
+  lossLineColor?: string
+  lossTextColor?: string
+}
+
+/**
+ * @description: 预警线数据类型data
+ * @example
+ *   value: number 主线Y值,
+ *   text: string 主线文本,
+ *   info: any 自定义数据信息,
+ *   config: WarningConfigType 自定义配置
+ */
+export interface WarningDataItem {
+  value: number
+  text: string
+  info: any
+  config: WarningConfigType
+}
+
+/**
+ * @description: 持仓线数据类型data
+ * @example
+ *   value: number 主线Y值,
+ *   text: string 主线文本,
+ *   info: any 自定义数据信息,
+ *   config: PositionConfigType 自定义配置
+ */
+export interface PositionDataItem {
+  value: number
+  text: string
+  info: any
+  config: PositionConfigType
+}
+
+/**
+ * @description: 条件单数据类型data
+ * @example
+ *   value: number 主线Y值,
+ *   text: string 主线文本,
+ *   profitValue: number 盈利线Y值,
+ *   profitText: string 盈利线文本,
+ *   lossValue: number 亏损线Y值,
+ *   lossText: string 亏损线文本,
+ *   info: any 自定义数据信息,
+ *   config: ConditionConfigType 自定义配置
+ */
+export interface ConditionDataItem {
+  value: number
+  text: string
+  profitValue: number
+  profitText: string
+  lossValue: number
+  lossText: string
+  info: any
+  config: ConditionConfigType
+}
+
+/**
+ * @description: 额外画线-graphic事件
+ * @example
+ *  onmouseover?: (params: ElementEvent) => void
+ *  onmouseout?: (params: ElementEvent) => void
+ *  ondragstart?: (params: ElementEvent) => void
+ *  ondragend?: (params: ElementEvent, yAxisValue: number) => void
+ *  ononcontextmenu?: (params: ECElementEvent, menuData: MenuDataType) => void
+ */
+export interface GraphicEvent {
+  onmouseover?: (params: ElementEvent, info: any) => void
+  onmouseout?: (params: ElementEvent, info: any) => void
+  ondragstart?: (params: ElementEvent, info: any) => void
+  ondragend?: (params: ElementEvent, info: any, yAxisValue: number) => void
+  ononcontextmenu?: (params: ECElementEvent, info: any, menuData: MenuDataType) => void
+}
+
+// 额外画线-单条数据
+interface LineDataItem extends GraphicEvent {
+  key: 'warning' | 'position' | 'condition'
+  data: WarningDataItem[] | PositionDataItem[] | ConditionDataItem[]
+}
+
+// 额外画线
+export type LineDataType = LineDataItem[]
+
+//----------------指标线计算相关TS类型-----------------------
+
+/**
+ * @description: 指标线配置类型
+ * @example
+ *  config: Array 内含哪些指标
+ *  label: 指标名称
+ *  mergeFreq: 需要合并的K线周期
+ *  showFreq: 哪些周期里展示
+ *  value: 指标名称
+ */
+export interface IndicatorConfigType {
+  config: Array<{
+    key: string
+    color: string
+    calculationFn: Function
+  }>
+  label: string
+  mergeFreq: undefined | string
+  showFreq: undefined | string[]
+  value: string
+}
+
+/**
+ * @description: 指标线计算-指标数据
+ */
+export interface InFormatKlinendicatorData {
+  key: string
+  color: string
+  data: number[]
+}
+
+/**
+ * @description: 指标线计算-返回的格式化数据
+ */
+export interface InFormatKlineData {
+  originData: KlineDataType
+  kLine: [number, number, number, number][]
+  time: string[]
+  indicator: InFormatKlinendicatorData[]
+}
+
+//----------------右键悬浮菜单相关TS类型----------------------
+
+export interface MenuDataItem {
+  label: string
+  callBack?: Function
+}
+
+export type MenuDataType = MenuDataItem[]