@xpyjs/gantt-core 0.0.1-beta.4 → 0.0.1-rc.2

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@xpyjs/gantt-core",
   "private": false,
-  "version": "0.0.1-beta.4",
+  "version": "0.0.1-rc.2",
   "description": "A powerful and flexible Gantt chart component library for modern web applications with TypeScript support",
   "type": "module",
   "main": "./dist/x-gantt.umd.cjs",

package/types/GanttContext.d.ts

@@ -24,6 +24,12 @@ export declare class XGanttContext implements IContext {
      * @return {boolean} 是否成功跳转
      */
     jumpTo(date?: any): boolean;
+    /**
+     * 滚动到指定任务节点。默认为第一个任务
+     *
+     * @return {boolean} 是否成功跳转
+     */
+    scrollTo(id?: string, highlight?: boolean): boolean;
     /**
      * 获取指定任务的所有相关联的完整路径，包含所有连接线与任务节点
      */

package/types/XGantt.d.ts

@@ -174,8 +174,53 @@ export declare class XGantt {
      * ```
      */
     jumpTo(date?: any): boolean;
+    /**
+     * 滚动到指定任务
+     * @param id - 任务 ID，如果不传入则滚动到顶部
+     * @param highlight - 是否高亮任务，默认为 false
+     *
+     * @returns 是否成功滚动到指定任务
+     *   - `true`: 成功滚动，任务已在视图中可见
+     *   - `false`: 滚动失败，可能是任务 ID 无效或任务不可见
+     *
+     * @description 此方法将甘特图的视图滚动到指定任务的位置，使该任务在当前视窗中可见。并且支持跳转后高亮当前任务。
+     *
+     * @example
+     * ```typescript
+     * // 滚动到指定任务
+     * const success1 = gantt.scrollTo('task-1');
+     * const success2 = gantt.scrollTo('non-existent-id'); // 任务不存在，返回 false
+     *
+     * // 滚动到顶部
+     * const success3 = gantt.scrollTo();
+     *
+     * // 检查滚动结果
+     * if (gantt.scrollTo('task-2')) {
+     *   console.log('成功滚动到任务 task-2');
+     * } else {
+     *   console.log('滚动失败，任务 ID 可能无效');
+     * }
+     *
+     * // 滚动到任务并高亮
+     * gantt.scrollTo('task-3', true);
+     * ```
+     */
+    scrollTo(id?: string, highlight?: boolean): boolean;
     /**
      * 获取指定任务的所有相关联的完整路径，包含所有连接线与任务节点
+     *
+     * 结果集中包含前置链路信息、后置链路信息、所有节点、关联线的信息等
+     * - prev: 前置链路信息
+     *    - chain: 所有源 -> 当前任务的完整路径（每条路径末尾为当前节点）
+     *    - nodes: 前置方向所有唯一节点
+     *    - links: 前置方向所有连线
+     * - next: 后置链路信息
+     *   - chain: 当前任务 -> 所有汇的完整路径（每条路径首元素为当前节点）
+     *   - nodes: 后置方向所有唯一节点
+     *   - links: 后置方向所有连线
+     * - allNodes: 所有相关联的节点
+     * - allLinks: 所有相关联的连线
+     * - current: 当前任务
      */
     getDataChain(id: string): DataChain;
     /**
@@ -276,4 +321,22 @@ export declare class XGantt {
      * ```
      */
     off<K extends keyof EventMap>(event: K, cb?: EventMap[K]): void;
+    /**
+     * 根据任务 ID 获取对应的任务数据
+     * @param id 任务 ID
+     * @returns 任务数据
+     *
+     * @example
+     * ```typescript
+     * const data = gantt.getDataById('task-1');
+     * if (data) {
+     *   console.log('任务名称:', data.name);
+     * }
+     * ```
+     */
+    getDataById(id: string): any | undefined;
+    /**
+     * 获取当前数据量总数。该数量为所有数据展开后的数据条数
+     */
+    getDataSize(): number;
 }

package/types/event/index.d.ts

@@ -51,7 +51,8 @@ export declare enum EventName {
     SLIDER_CLICK = "slider-click",
     SLIDER_DBL_CLICK = "slider-dbl-click",
     SLIDER_CONTEXTMENU = "slider-contextmenu",
-    SLIDER_MOVING = "slider-moving",
+    SLIDER_DRAGGING = "slider-dragging",
+    SLIDER_ENTER = "slider-enter",
     SLIDER_HOVER = "slider-hover",
     SLIDER_LEAVE = "slider-leave",
     SLIDER_BLINK = "slider-blink",
@@ -63,7 +64,8 @@ export declare enum EventName {
     TASK_DRAG_END = "task-drag-end",
     BASELINE_CLICK = "baseline-click",
     BASELINE_CONTEXTMENU = "baseline-contextmenu",
-    BASELINE_MOUSEOVER = "baseline-mouseover",
+    BASELINE_MOUSEENTER = "baseline-mouseenter",
+    BASELINE_MOUSEMOVE = "baseline-mousemove",
     BASELINE_MOUSEOUT = "baseline-mouseout",
     ERROR = "error"
 }

package/types/store/DataManager.d.ts

@@ -80,6 +80,10 @@ export declare class DataManager {
      * 使用缓存提高性能，只有在必要时才会重建列表
      */
     getVisibleTasks(): Task[];
+    /**
+     * 获取一个任务是否可展示
+     */
+    isTaskVisible(task: Task): boolean;
     /**
      * 获取可展示任务数量
      */

package/types/types/event.d.ts

@@ -2,28 +2,55 @@ import { ErrorType } from "../event";
 import { ILink } from "./link";
 
 export interface EventMap {
+  /** 加载完成事件 */
   loaded: () => void;
+  /** 错误事件 */
   error: (error: ErrorType, msg?: string) => void;
+  /** 关联线更新事件 */
   "update:link": (link: ILink) => void;
+  /** 创建关联线事件 */
   "create:link": (link: ILink) => void;
+  /** 关联线被选中事件，支持多个选中 */
   "select:link": (
+    /** 当前被新选中的关连线 */
     add: ILink | null,
+    /** 当前被取消选中的关联线 */
     cancel: ILink | null,
+    /** 所有目前被选中的关联线 */
     all: ILink[]
   ) => void;
+  /** 关联线右键点击事件 */
   "contextmenu:link": (e: MouseEvent, link: ILink) => void;
+  /** 任务被选中（checkbox）事件，支持多个选中 */
   select: (data: any[], checked: boolean, all: any[]) => void;
+  /** 行点击事件 */
   "click:row": (e: MouseEvent, data: any) => void;
+  /** 行双击事件 */
   "dblclick:row": (e: MouseEvent, data: any) => void;
+  /** 行右键点击事件 */
   "contextmenu:row": (e: MouseEvent, data: any) => void;
+  /** 任务条点击事件 */
   "click:slider": (e: MouseEvent, data: any) => void;
+  /** 任务条双击事件 */
   "dblclick:slider": (e: MouseEvent, data: any) => void;
+  /** 任务条右键点击事件 */
   "contextmenu:slider": (e: MouseEvent, data: any) => void;
+  /** 任务拖拽事件。当且仅当任务条拖拽结束时被触发 */
   move: (data: { row: any; old: any }[]) => void;
+  /** 鼠标移入任务条事件 */
+  "enter:slider": (e: MouseEvent, data: any) => void;
+  /** 鼠标悬停任务条事件。当鼠标一直处于任务条上时，会持续触发 */
   "hover:slider": (e: MouseEvent, data: any) => void;
+  /** 鼠标移出任务条事件 */
   "leave:slider": (e: MouseEvent, data: any) => void;
+  /** 基线点击事件 */
   "click:baseline": (e: MouseEvent, data: any, baseline: any) => void;
+  /** 基线右键点击事件 */
   "contextmenu:baseline": (e: MouseEvent, data: any, baseline: any) => void;
+  /** 基线鼠标移入事件 */
+  "enter:baseline": (e: MouseEvent, data: any, baseline: any) => void;
+  /** 基线鼠标悬停事件。当鼠标一直处于基线上时，会持续触发 */
   "hover:baseline": (e: MouseEvent, data: any, baseline: any) => void;
+  /** 基线鼠标移出事件 */
   "leave:baseline": (e: MouseEvent, data: any, baseline: any) => void;
 }