@agions/taroviz 1.6.0 → 1.9.0

package/src/core/types/index.ts

@@ -10,14 +10,12 @@ export * from './chart';
 import type { EChartsType } from 'echarts';
 
 import { ChartOptions } from './chart';
+import { ChartEventParams } from './common';
 
 /**
  * TaroViz核心类型定义
  */
 
-/**
- * ECharts类型定义
- */
 export { EChartsType };
 
 // 导出动画相关类型
@@ -72,7 +70,7 @@ export type RendererType = 'canvas' | 'svg';
 /**
  * 图表事件回调类型
  */
-export type ChartEventCallback = (params: any) => void;
+export type ChartEventCallback = (params: ChartEventParams) => void;
 
 /**
  * 图表事件处理器映射
@@ -122,160 +120,31 @@ export interface ThemeType {
       fontSize?: number;
     };
   };
-  [key: string]: any;
+  [key: string]: unknown;
 }
 
 /**
  * 渲染性能优化配置
  */
 export interface RenderOptimizationConfig {
-  /**
-   * 是否开启渐进式渲染
-   */
   progressive?: boolean;
-
-  /**
-   * 渐进式渲染的阈值
-   */
   progressiveThreshold?: number;
-
-  /**
-   * 是否启用懒更新
-   */
   lazyUpdate?: boolean;
-
-  /**
-   * 是否启用动画
-   */
   animation?: boolean;
-
-  /**
-   * 是否启用硬件加速
-   */
   hardwareAcceleration?: boolean;
-
-  /**
-   * 帧率限制
-   */
   frameRate?: number;
 }
 
-/**
- * 适配器接口定义
- */
-export interface Adapter {
-  /**
-   * 初始化图表
-   */
-  init(options?: any): EChartsType;
-
-  /**
-   * 设置图表配置
-   */
-  setOption(option: any, notMerge?: boolean): void;
-
-  /**
-   * 获取图表实例
-   */
-  getInstance(): EChartsType | null;
-
-  /**
-   * 设置组件实例
-   */
-  setComponent?(component: any): void;
-
-  /**
-   * 绑定事件
-   */
-  on(eventName: string, handler: (params: any) => void): void;
-
-  /**
-   * 解绑事件
-   */
-  off(eventName: string, handler?: (params: any) => void): void;
-
-  /**
-   * 调整图表大小
-   */
-  resize(): void;
-
-  /**
-   * 显示加载中
-   */
-  showLoading(options?: any): void;
-
-  /**
-   * 隐藏加载中
-   */
-  hideLoading(): void;
-
-  /**
-   * 清空图表
-   */
-  clear(): void;
-
-  /**
-   * 销毁图表
-   */
-  dispose(): void;
-
-  /**
-   * 获取DataURL
-   */
-  getDataURL?(opts?: any): string | undefined;
-
-  /**
-   * 转换为DataURL
-   */
-  convertToDataURL?(opts?: any): string | undefined;
-
-  /**
-   * 渲染图表（仅 H5 环境需要，小程序适配器不需要）
-   */
-  render?(): JSX.Element | null;
-}
-
 /**
  * 适配器配置选项
  */
 export interface AdapterConfig {
-  /**
-   * 平台类型
-   */
   platformType?: string;
-
-  /**
-   * 目标canvas元素ID
-   */
   canvasId?: string;
-
-  /**
-   * 图表主题
-   */
   theme?: string;
-
-  /**
-   * 渲染器类型
-   */
   renderer?: 'canvas' | 'svg';
-
-  /**
-   * 设备像素比
-   */
   devicePixelRatio?: number;
-
-  /**
-   * 宽度
-   */
   width?: number;
-
-  /**
-   * 高度
-   */
   height?: number;
-
-  /**
-   * 额外选项
-   */
-  [key: string]: any;
+  [key: string]: unknown;
 }

package/src/core/types/platform.ts

@@ -1,96 +1,49 @@
 /**
  * 支持的平台类型
  */
+import type {
+  EChartsType,
+  EChartsOption,
+} from 'echarts';
+import type { CSSProperties } from 'react';
+import type { ChartEventParams } from './common';
+
 export enum PlatformType {
   H5 = 'h5',
-  WEAPP = 'weapp', // 微信小程序
-  ALIPAY = 'alipay', // 支付宝小程序
-  SWAN = 'swan', // 百度小程序
-  TT = 'tt', // 字节跳动小程序
-  QQ = 'qq', // QQ小程序
-  JD = 'jd', // 京东小程序
-  HARMONY = 'harmony', // 鸿蒙OS
-  DD = 'dd', // 钉钉小程序
-  QYWX = 'qywx', // 企业微信小程序
-  LARK = 'lark', // 飞书小程序
-  KWAI = 'kwai', // 快手小程序
+  WEAPP = 'weapp',
+  ALIPAY = 'alipay',
+  SWAN = 'swan',
+  TT = 'tt',
+  QQ = 'qq',
+  JD = 'jd',
+  HARMONY = 'harmony',
+  DD = 'dd',
+  QYWX = 'qywx',
+  LARK = 'lark',
+  KWAI = 'kwai',
 }
 
-// 导出平台类型字符串联合类型
 export type Platform = `${PlatformType}` | 'web' | 'ks';
 
-/**
- * 事件处理器类型
- */
-export type EventHandler = (params: any) => void;
+/** 图表事件处理器 */
+export type EventHandler = (params: ChartEventParams) => void;
 
 /**
  * 适配器通用选项
  */
 export interface AdapterOptions {
-  /**
-   * 平台类型
-   */
   platform?: Platform;
-
-  /**
-   * 画布ID
-   */
   canvasId?: string;
-
-  /**
-   * 宽度
-   */
   width?: number | string;
-
-  /**
-   * 高度
-   */
   height?: number | string;
-
-  /**
-   * 主题
-   */
   theme?: string | object;
-
-  /**
-   * 是否自动调整大小
-   */
   autoResize?: boolean;
-
-  /**
-   * 设备像素比
-   */
   devicePixelRatio?: number;
-
-  /**
-   * 初始化回调
-   */
-  onInit?: (instance: any) => void;
-
-  /**
-   * 容器引用
-   */
-  containerRef?: any;
-
-  /**
-   * 图表选项
-   */
-  option?: any;
-
-  /**
-   * 渲染器类型
-   */
+  onInit?: (instance: EChartsType) => void;
+  containerRef?: HTMLElement | { current: HTMLElement | null };
+  option?: EChartsOption;
   renderer?: 'canvas' | 'svg';
-
-  /**
-   * 样式对象
-   */
-  style?: any;
-
-  /**
-   * CSS类名
-   */
+  style?: CSSProperties;
   className?: string;
 }
 
@@ -98,39 +51,12 @@ export interface AdapterOptions {
  * H5环境适配器选项
  */
 export interface H5AdapterOptions extends AdapterOptions {
-  /**
-   * 容器引用
-   */
-  containerRef?: React.RefObject<HTMLDivElement>;
-
-  /**
-   * 图表选项
-   */
-  option?: any;
-
-  /**
-   * 是否不合并选项
-   */
+  containerRef?: HTMLElement | { current: HTMLElement | null };
+  option?: EChartsOption;
   notMerge?: boolean;
-
-  /**
-   * 是否延迟更新
-   */
   lazyUpdate?: boolean;
-
-  /**
-   * 样式
-   */
-  style?: React.CSSProperties;
-
-  /**
-   * 类名
-   */
+  style?: CSSProperties;
   className?: string;
-
-  /**
-   * 渲染器类型
-   */
   renderer?: 'canvas' | 'svg';
 }
 
@@ -138,48 +64,19 @@ export interface H5AdapterOptions extends AdapterOptions {
  * 小程序适配器基础选项
  */
 export interface MiniAppAdapterOptions extends AdapterOptions {
-  /**
-   * 小程序组件实例
-   */
-  componentInstance?: any;
-
-  /**
-   * 是否禁用touch事件
-   */
+  componentInstance?: object;
   disableTouch?: boolean;
-
-  /**
-   * 渲染模式
-   */
   renderMode?: '2d' | 'webgl';
-
-  /**
-   * 图表配置选项
-   */
-  option?: any;
-
-  /**
-   * 样式属性
-   */
-  style?: React.CSSProperties;
+  option?: EChartsOption;
+  style?: CSSProperties;
 }
 
 /**
  * 微信小程序适配器选项
  */
 export interface WeappAdapterOptions extends MiniAppAdapterOptions {
-  /**
-   * 微信特有选项
-   */
   weappOptions?: {
-    /**
-     * 是否启用右侧菜单
-     */
     enableContextMenu?: boolean;
-
-    /**
-     * 是否启用跨端同层渲染
-     */
     enableCrossPageTransfer?: boolean;
   };
 }
@@ -188,13 +85,7 @@ export interface WeappAdapterOptions extends MiniAppAdapterOptions {
  * 支付宝小程序适配器选项
  */
 export interface AlipayAdapterOptions extends MiniAppAdapterOptions {
-  /**
-   * 支付宝特有选项
-   */
   alipayOptions?: {
-    /**
-     * 是否启用离屏渲染
-     */
     enableOffscreenRendering?: boolean;
   };
 }
@@ -203,18 +94,8 @@ export interface AlipayAdapterOptions extends MiniAppAdapterOptions {
  * 百度小程序适配器选项
  */
 export interface SwanAdapterOptions extends MiniAppAdapterOptions {
-  /**
-   * 百度智能小程序特有选项
-   */
   swanOptions?: {
-    /**
-     * 是否启用复杂交互
-     */
     enableComplexInteraction?: boolean;
-
-    /**
-     * 是否启用性能优化
-     */
     enablePerformanceOptimization?: boolean;
   };
 }
@@ -223,13 +104,7 @@ export interface SwanAdapterOptions extends MiniAppAdapterOptions {
  * 鸿蒙OS适配器选项
  */
 export interface HarmonyAdapterOptions extends AdapterOptions {
-  /**
-   * 鸿蒙特有选项
-   */
   harmonyOptions?: {
-    /**
-     * 是否启用硬件加速
-     */
     enableHardwareAcceleration?: boolean;
   };
 }
@@ -238,88 +113,21 @@ export interface HarmonyAdapterOptions extends AdapterOptions {
  * 适配器接口
  */
 export interface Adapter {
-  /**
-   * 初始化图表
-   */
-  init(): any;
-
-  /**
-   * 获取图表实例
-   */
-  getInstance(): any;
-
-  /**
-   * 设置图表配置项
-   */
-  setOption(option: any, opts?: any): void;
-
-  /**
-   * 获取图表宽度
-   */
+  init(options?: object): EChartsType;
+  getInstance(): EChartsType | null;
+  setOption(option: EChartsOption, opts?: object): void;
   getWidth(): number;
-
-  /**
-   * 获取图表高度
-   */
   getHeight(): number;
-
-  /**
-   * 获取DOM元素
-   */
   getDom(): HTMLElement | null;
-
-  /**
-   * 调整图表大小
-   */
-  resize(opts?: any): void;
-
-  /**
-   * 触发图表行为
-   */
-  dispatchAction(payload: any): void;
-
-  /**
-   * 转换为DataURL
-   */
-  convertToDataURL(opts?: any): string | undefined;
-
-  /**
-   * 清空图表
-   */
+  resize(opts?: object): void;
+  dispatchAction(payload: object): void;
+  convertToDataURL(opts?: object): string | undefined;
   clear(): void;
-
-  /**
-   * 获取DataURL
-   */
-  getDataURL(opts?: any): string | undefined;
-
-  /**
-   * 绑定事件
-   */
+  getDataURL(opts?: object): string | undefined;
   on(eventName: string, handler: EventHandler, context?: object): void;
-
-  /**
-   * 解绑事件
-   */
   off(eventName: string, handler?: EventHandler): void;
-
-  /**
-   * 显示加载动画
-   */
   showLoading(opts?: object): void;
-
-  /**
-   * 隐藏加载动画
-   */
   hideLoading(): void;
-
-  /**
-   * 销毁图表实例
-   */
   dispose(): void;
-
-  /**
-   * 渲染图表
-   */
-  render(): JSX.Element;
+  render?(): JSX.Element | null;
 }