zzz-pc-view 0.0.97 → 0.0.99

package/src/webUtils/ECharts/useLegendSelectCtrl.d.ts

@@ -12,12 +12,12 @@ export declare enum LegendChangeType {
 }
 /**
  * 用于管理 ECharts 图例选择状态的组合式函数。
- * 该函数提供了一系列方法来处理图例的选择、反选、清空等操作，并在状态改变时触发回调。
+ * 该函数提供了一系列方法来处理图例的选择、反选、清空等操作，并在选择状态改变时触发回调。
  *
  * @param param - 包含配置选项的对象。
- * @param param.dimensions - 趋势图数值维度数组，用于提供图例项的数据。
- * @param param.callback - 当图例选择状态改变时触发的回调函数，接收一个 `LegendChangeType` 类型的参数。
- * @param param.defaultSelected - 图例的初始选择状态，可选参数。
+ * @param param.dimensions - 趋势图数值维度数组，用于提供图例项的数据，每个元素需包含 `id` 属性。
+ * @param param.callback - 当图例选择状态改变时触发的回调函数，接收一个 `LegendChangeType` 类型的参数，用于标识改变类型。
+ * @param param.defaultSelected - 图例的初始选择状态，可选参数，类型与 ECharts 图例配置中的 `selected` 一致。
  * @returns 包含图例选择状态和相关操作方法的对象。
  */
 export declare const useLegendSelectCtrl: (param: {
@@ -33,11 +33,18 @@ export declare const useLegendSelectCtrl: (param: {
     /**
      * 获取当前图例的选择状态。
      *
-     * @returns 当前图例的选择状态。
+     * @returns 当前图例的选择状态，是一个键值对对象，键为维度 ID，值为布尔类型表示是否选中。
      */
     legendSelected: {
         [key: string]: boolean;
     };
+    /**
+     * 设置图例选择状态，考虑旧的选择状态。
+     * 根据传入的新选择状态和当前的选择状态重新生成最终的选择状态。
+     *
+     * @param legendSelected - 要设置的新图例选择状态，可选参数。
+     */
+    setLegendSelected(legendSelected?: Required<LegendComponentOption>["selected"]): void;
     onLegendSelectChanged: (event: any) => void;
     onSelectByAllBtnClick: () => void;
     onSelectByInvertBtnClick: () => void;