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

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@xpyjs/gantt-core",
   "private": false,
-  "version": "0.0.1-rc.4",
+  "version": "0.0.1",
   "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

@@ -13,6 +13,7 @@ export declare class XGanttContext implements IContext {
     private renderer;
     constructor(container: HTMLElement, events: Map<keyof EventMap, Function[]>, options?: IOptions);
     getScrollbar(): import("./rendering/scrollbar").Scrollbar;
+    getRootElement(): HTMLElement;
     getOptions(): import("./types/options").IGanttOptions;
     private setOptions;
     render(): void;

package/types/event/index.d.ts

@@ -67,6 +67,9 @@ export declare enum EventName {
     BASELINE_MOUSEENTER = "baseline-mouseenter",
     BASELINE_MOUSEMOVE = "baseline-mousemove",
     BASELINE_MOUSEOUT = "baseline-mouseout",
+    ROW_DRAG_START = "row-drag-start",
+    ROW_DRAGGING = "row-dragging",
+    ROW_DRAG_END = "row-drag-end",
     ERROR = "error"
 }
 export declare enum ErrorType {

package/types/models/Task.d.ts

@@ -75,4 +75,5 @@ export declare class Task {
     getAllChildren(): Task[];
     isMilestone(): boolean;
     isSummary(): boolean;
+    isSomeoneChildren(parent: Task | undefined): boolean;
 }

package/types/rendering/Renderer.d.ts

@@ -15,7 +15,9 @@ export declare class Renderer {
     private width;
     private height;
     private isInitialized;
+    private resizeObserver?;
     getScrollbar(): Scrollbar;
+    getRootElement(): HTMLElement;
     constructor(context: IContext, // 渲染器上下文
     container: HTMLElement);
     /**

package/types/rendering/chart/ChartBody.d.ts

@@ -68,6 +68,10 @@ export declare class BodyGroup {
      * 按照位置获取任务
      */
     private getTaskByPosition;
+    /**
+     * 按照位置获取时间
+     */
+    private getTimeByPosition;
     /**
      * 高亮指定行
      */

package/types/rendering/table/DragHandler.d.ts

@@ -0,0 +1,50 @@
+import { IContext } from "@/types/render";
+import type { Task } from "@/models/Task";
+export declare class DragHandler {
+    private context;
+    private container?;
+    private task?;
+    private element;
+    private isDragging;
+    private dragStartY;
+    private dragStartIndex;
+    private currentIndex;
+    private dragType;
+    private canDrop;
+    private ghostElement;
+    private placeholderElement;
+    private animationFrameId;
+    private rowElement;
+    constructor(context: IContext, container?: HTMLDivElement | undefined, task?: Task | undefined);
+    private createElement;
+    private bindEvents;
+    private handleMouseDown;
+    private handleMouseMove;
+    private handleMouseUp;
+    /**
+    * 创建拖拽跟随影像
+    */
+    private createGhostElement;
+    /**
+     * 更新 ghost 元素位置
+     */
+    private updateGhostPosition;
+    /**
+     * 创建插入占位符元素
+     */
+    private createPlaceholderElement;
+    /**
+     * 更新占位符的位置
+     */
+    private updatePlaceholderPosition;
+    /**
+     * 清理拖拽状态
+     */
+    private cleanup;
+    /** 获取元素 */
+    getElement(): HTMLDivElement;
+    /**
+     * 销毁组件
+     */
+    destroy(): void;
+}

package/types/store/DataManager.d.ts

@@ -71,6 +71,7 @@ export declare class DataManager {
     /**
      * 移动任务位置
      */
+    moveTask(type: "before" | "after" | "inside", task: Task | undefined, targetIndex: number): void;
     /**
      * 展开任务
      */
@@ -101,6 +102,7 @@ export declare class DataManager {
     /**
      * 更新子任务的层级
      */
+    private updateChildrenLevel;
     /**
      * 使缓存失效，标记需要重新生成扁平化任务列表
      */

package/types/types/chart.d.ts

@@ -33,6 +33,8 @@ export interface IChartOptions {
    * @description small | normal | large 会根据当前展示单位，自动计算宽度。或者直接给对象，指定具体每一个单位下 cell 的宽度值
    *
    * @description 如果同时给定了起止时间，则图表则只会渲染给定的时间区间，并且指定宽度将失效。（失效是指：如果给定时间区间范围小于可视范围，则会自动撑满宽度，此时每一格 cell 的宽度则会变为自动；如果时间区间范围大于可视范围，则继续按照当前设定宽度展示，超出部分可通过滚动条移动展示）
+   *
+   * @description 对于 cell 的定义，它表示一个最小单位的宽度。当为 unit 单位为 hour 时，cell 的最小单位是 hour，当 unit 单位大于 day 时，cell 的最小单位永远为 day。例如：当前 unit 单位为 month，那么在3月份中就会有对应天数 cell 31个。
    */
   cellWidth:
     | number

package/types/types/event.d.ts

@@ -1,3 +1,4 @@
+import { Dayjs } from "../utils/time";
 import { ErrorType } from "../event";
 import { ILink } from "./link";
 
@@ -24,11 +25,13 @@ export interface EventMap {
   /** 任务被选中（checkbox）事件，支持多个选中 */
   select: (data: any[], checked: boolean, all: any[]) => void;
   /** 行点击事件 */
-  "click:row": (e: MouseEvent, data: any) => void;
+  "click:row": (e: MouseEvent, data: any, time?: Dayjs) => void;
   /** 行双击事件 */
-  "dblclick:row": (e: MouseEvent, data: any) => void;
+  "dblclick:row": (e: MouseEvent, data: any, time?: Dayjs) => void;
   /** 行右键点击事件 */
-  "contextmenu:row": (e: MouseEvent, data: any) => void;
+  "contextmenu:row": (e: MouseEvent, data: any, time?: Dayjs) => void;
+  /** 行拖拽事件。当且仅当行拖拽结束时被触发。仅当 启用 drag 配置项后生效 */
+  "drag:row": (target: any, source: any) => void;
   /** 任务条点击事件 */
   "click:slider": (e: MouseEvent, data: any) => void;
   /** 任务条双击事件 */

package/types/types/options.d.ts

@@ -8,9 +8,15 @@ export type XGanttUnit = "hour" | "day" | "week" | "month" | "quarter";
 export type TaskType = "task" | "milestone" | "summary";
 
 export interface IGanttOptions {
-  /** 日志 level。 默认 info */
+  /** 日志 level。 默认 warn */
   logLevel?: "debug" | "info" | "warn" | "error" | "none";
 
+  /** 配置 resize 规则 */
+  resize?: {
+    /** 是否启用自适应 */
+    enabled: boolean;
+  };
+
   /** 源数据 */
   data: any[];
 
@@ -287,7 +293,7 @@ export interface IGanttOptions {
       /** 差异显示模式 */
       mode: 'highlight' | 'indicator' | 'both';
       /** 以何种基准展示对比。基线高亮只会以一种（起始/结束）基线进行对比。默认以结束时间为基准（'end'） */
-      target: 'start' | 'end'
+      target: 'start' | 'end';
 
       /** 超期任务的高亮配置 */
       delayed: {
@@ -487,6 +493,34 @@ export interface IGanttOptions {
     includeSelf: boolean;
   };
 
+  /** 配置任务间的拖拽 */
+  drag: {
+    /** 是否启用任务拖拽功能 */
+    enabled: boolean | ((row: EmitData) => boolean);
+    /** 图标颜色。默认 #999 */
+    color?: string;
+    /** 可放置区域的背景色。默认主色 */
+    targetBackgroundColor?: string;
+    /** 可放置区域的透明度。默认 0.2 */
+    targetOpacity?: number;
+    /** 放置的相关配置 */
+    drop?: {
+      /**
+       * 允许放置的回调函数，如果不配置，则表示可被放置的内容均允许放置。
+       *
+       * @description 该方法的优先级最低，结合其他参数配置使用
+       * @description 需要注意的是，无论如何配置，都不能将一个任务放置到其子项中的任意内容
+       */
+      allowed?: ((target: EmitData, source: EmitData) => boolean);
+      /**
+       * 允许跨层级放置。默认情况下只允许在当前父级下进行拖拽
+       *
+       * @description 主要注意的是，同层级、不同父级的内容，也属于跨层级放置
+       */
+      crossLevel?: boolean;
+    }
+  };
+
   /**
    * 时间刻度
    *

package/types/types/render.d.ts

@@ -19,6 +19,11 @@ export interface IContext {
    */
   getScrollbar: () => Scrollbar;
 
+  /**
+   * 获取根元素
+   */
+  getRootElement: () => HTMLElement;
+
   /**
    * 获取选项
    */

package/types/types/table.d.ts

@@ -21,7 +21,7 @@ export interface ITableColumnStandard {
   /**
    * 当前列对齐方式
    *
-   * @default center
+   * @default left
    */
   align?: "left" | "center" | "right";
   /**
@@ -102,7 +102,7 @@ export interface ITableOptions {
   /**
    * 统一设置列对齐方式。每列的对齐方式可以单独设置
    *
-   * @default center
+   * @default left
    */
   align: "left" | "center" | "right";
 

package/types/utils/helpers.d.ts

@@ -12,9 +12,10 @@ export declare function parseNumberWithPercent(value: number | string, target: n
  * 获取距离当前值最近的基准值或其倍数
  * @param value 当前值
  * @param target 基准值
+ * @param type 取值方式，默认为 round，可选 floor 或 ceil
  * @returns 最近的基准值或其倍数
  */
-export declare function getStandardValue(value: number, target: number): number;
+export declare function getStandardValue(value: number, target: number, type?: 'round' | 'floor' | 'ceil'): number;
 /**
  * 计算两个数的最大公约数
  */