@xpyjs/gantt-core 0.0.1-alpha.2 → 0.0.1-alpha.4

package/types/store/index.d.ts

@@ -0,0 +1,21 @@
+import { OptionManager } from "./OptionManager";
+import { DataManager } from "./DataManager";
+import { ColumnManager } from "./ColumnManager";
+import { TimeAxis } from "./TimeAxis";
+import { Dayjs } from "dayjs";
+import { IContext } from "@/types/render";
+import { IOptionConfig, IOptions } from "@/types";
+export declare class Store {
+    private context;
+    private optionManager;
+    private dataManager;
+    private columnManager;
+    private timeAxis;
+    constructor(context: IContext, options?: IOptions);
+    getOptionManager(): OptionManager;
+    getDataManager(): DataManager;
+    getColumnManager(): ColumnManager;
+    getTimeAxis(): TimeAxis;
+    setOption(options: IOptions, config?: IOptionConfig): void;
+    updateTime(start?: Dayjs, end?: Dayjs): void;
+}

package/types/types/baseline.d.ts

@@ -0,0 +1,16 @@
+export type BaselineDiffStatus = 'ahead' | 'ontime' | 'delayed';
+
+export interface BaselineDiff {
+    /** 开始时间差异 */
+    startDiff: number;
+    /** 开始状态 */
+    startStatus?: BaselineDiffStatus;
+    /** 结束时间差异 */
+    endDiff: number;
+    /** 结束状态 */
+    endStatus?: BaselineDiffStatus;
+    /** 差异单位 */
+    unit: string;
+    /** 进度偏差 */
+    progressDiff?: number;
+}

package/types/types/chart.d.ts

@@ -0,0 +1,59 @@
+import { XGanttUnit } from "./options";
+
+export interface IChartOptions {
+  /**
+   * 开始时间。强制设置开始时间，覆盖数据中的开始时间。
+   *
+   * @description 给定开始时间后，图表将使用该日期作为起始，而不是数据的起始时间
+   */
+  startTime?: Date | string;
+
+  /**
+   * 结束时间。强制设置结束时间，覆盖数据中的结束时间
+   *
+   * @description 给定结束时间后，图表将使用该日期作为结束，而不是数据的结束时间
+   */
+  endTime?: Date | string;
+
+  /**
+   * 自适应 cell 宽度。允许右侧部分基于当前宽度，自适应自定义的起止时间。
+   *
+   * 当起止日期区间过短，会自动撑满整个区域。当日期区间过长，会以 cellWidth 的值作为最小值，绘制整个区域
+   *
+   * @requires startTime 此功能需要自定义起止时间
+   * @requires endTime 此功能需要自定义起止时间
+   *
+   * @description 此功能会导致 cellWidth 失效。所有 cell 会自动计算宽度
+   */
+  autoCellWidth: boolean;
+
+  /**
+   * 时间单元格宽度
+   *
+   * @description small | normal | large 会根据当前展示单位，自动计算宽度。或者直接给对象，指定具体每一个单位下 cell 的宽度值
+   *
+   * @description 如果同时给定了起止时间，则图表则只会渲染给定的时间区间，并且指定宽度将失效。（失效是指：如果给定时间区间范围小于可视范围，则会自动撑满宽度，此时每一格 cell 的宽度则会变为自动；如果时间区间范围大于可视范围，则继续按照当前设定宽度展示，超出部分可通过滚动条移动展示）
+   */
+  cellWidth:
+    | number
+    | "small"
+    | "normal"
+    | "large"
+    | Partial<Record<XGanttUnit, number>>;
+
+  /**
+   * 表头组（上层）格式化
+   *
+   * @description 字符串：使用 dayjs 的格式化功能参数。支持 {@link https://day.js.org/docs/en/display/format|默认占位符}，以及所有 {@link https://day.js.org/docs/en/plugin/advanced-format|AdvancedFormat} 的占位符
+   * @description 函数：可以根据当前日期和单位，返回自定义的格式化字符串。如果函数返回为空，则回退到默认格式化
+   */
+  headerGroupFormat?: string | ((date: Date, unit: XGanttUnit) => string);
+
+  /**
+   * 表头单元格格式化
+   *
+   * @description 字符串：使用 dayjs 的格式化功能参数。支持 {@link https://day.js.org/docs/en/display/format|默认占位符}，以及所有 {@link https://day.js.org/docs/en/plugin/advanced-format|AdvancedFormat} 的占位符
+   * @description 函数：可以根据当前日期和单位，返回自定义的格式化字符串。如果函数返回为空，则回退到默认格式化
+   */
+  headerCellFormat?: string | ((date: Date, unit: XGanttUnit) => string);
+}

package/types/types/event.d.ts

@@ -0,0 +1,29 @@
+import { ErrorType } from "../event";
+import { ILink } from "./link";
+
+export interface EventMap {
+  loaded: () => void;
+  error: (error: ErrorType) => 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;
+  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;
+  "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;
+  "hover:baseline": (e: MouseEvent, data: any, baseline: any) => void;
+  "leave:baseline": (e: MouseEvent, data: any, baseline: any) => void;
+}

package/types/types/global.d.ts

@@ -0,0 +1,9 @@
+// 全局类型声明
+declare const __VERSION__: string;
+
+// 导出到全局命名空间
+declare global {
+  const __VERSION__: string;
+}
+
+export {};

package/types/types/index.d.ts

@@ -0,0 +1,26 @@
+import { IGanttOptions } from "./options";
+
+type DeepPartial<T> = {
+  [P in keyof T]?: T[P] extends object ? DeepPartial<T[P]> : T[P];
+};
+
+export type IOptions = DeepPartial<IGanttOptions>;
+
+export type IOptionConfig = {
+  /** 是否合并选项 */
+  merge?: boolean;
+};
+
+export interface EmitData {
+  /** 原始数据 */
+  data: any;
+  /** 当前数据的索引 */
+  $index: number;
+  /** 当前数据的层级。 1 开始 */
+  level: number;
+}
+
+export interface EmitBaseline extends EmitData {
+  /** 基线数据 */
+  baseline: any;
+}

package/types/types/link.d.ts

@@ -0,0 +1,23 @@
+export interface ILink {
+  /** 起始任务 id */
+  from: any;
+  /** 截止任务 id */
+  to: any;
+  /** 自定义颜色 */
+  color?: string;
+  /**
+   * 连线类型。它允许用户配置连线的具体类型。具体讨论参考 {@link https://github.com/xpyjs/gantt/issues/119|关于前置后置任务的连线}
+   *
+   * 当前针对已知的四种类型进行了补充：
+   * - `FS` - Finish to Start
+   * - `FF` - Finish to Finish
+   * - `SS` - Start to Start
+   * - `SF` - Start to Finish
+   *
+   * 默认情况下使用 `FS`，即 Finish to Start。
+   *
+   * 无论如何配置，连线始终是 from - to 的方向，type 定义了连线在 from / to 任务中出现的位置，左侧定义为 Start，右侧定义为 Finish。
+   */
+  type?: "FS" | "FF" | "SS" | "SF";
+  [key: string]: any;
+}