@dhtmlx/trial-vue-gantt 1.1.2 → 9.1.4

package/dist/dhtmlxgantt.vue.es.d.ts

@@ -0,0 +1,352 @@
+import * as vue from 'vue';
+import { VNode, Component, Ref, MaybeRef } from 'vue';
+import { Task, Link, GanttStatic, RouterFunction, Baseline, CalendarConfig, GanttConfigOptions, GanttPlugins, GanttTemplates } from '@dhx/gantt';
+export * from '@dhx/gantt';
+
+interface VueKnownGanttEvents {
+    onBeforeLightbox?: (taskId: string | number) => boolean | void;
+    onTaskCreated?: (task: Task) => boolean | void;
+    onAfterTaskAdd?: (id: string | number, task: Task) => void;
+    onAfterTaskUpdate?: (id: string | number, task: Task) => void;
+    onAfterTaskDelete?: (id: string | number, task: Task) => void;
+    onAfterLinkAdd?: (id: string | number, link: Link) => void;
+    onAfterLinkUpdate?: (id: string | number, link: Link) => void;
+    onAfterLinkDelete?: (id: string | number, link: Link) => void;
+}
+type VueGanttEvents = VueKnownGanttEvents & Record<string, (...args: any[]) => any>;
+interface VueGanttExpose {
+    instance: GanttStatic | null;
+}
+interface VueGanttRef {
+    instance: GanttStatic | null;
+}
+interface VueGanttEmits {
+    ready: (instance: GanttStatic) => void;
+}
+interface DataCallbackChange {
+    entity: string;
+    action: string;
+    data: any;
+    id: number | string;
+}
+interface BatchChanges {
+    tasks?: DataCallbackChange[];
+    links?: DataCallbackChange[];
+    resources?: DataCallbackChange[];
+    resourceAssignments?: DataCallbackChange[];
+}
+interface DataSet {
+    tasks?: Array<Task | SerializedTask>;
+    links?: Array<Link | SerializedLink>;
+    resources?: any[];
+    resourceAssignments?: any[];
+    baselines?: any[];
+}
+interface VueGanttDataConfig {
+    load?: string | ((gantt: GanttStatic) => DataSet | Promise<DataSet>);
+    save?: string | RouterFunction;
+    batchSave?: (changes: BatchChanges) => void;
+}
+interface OnBeforeTaskDeleteConfirmArgs {
+    task: Task;
+    callback: () => void;
+    message: string;
+    title: string;
+    ganttInstance: GanttStatic;
+}
+interface OnBeforeLinkDeleteConfirmArgs {
+    link: Link;
+    callback: () => void;
+    message: string;
+    title: string;
+    ganttInstance: GanttStatic;
+}
+interface GanttModals {
+    onBeforeTaskDelete?: (args: OnBeforeTaskDeleteConfirmArgs) => void;
+    onBeforeLinkDelete?: (args: OnBeforeLinkDeleteConfirmArgs) => void;
+}
+interface Marker {
+    id?: string | number;
+    start_date: Date;
+    end_date?: Date;
+    css?: string;
+    text?: string | number | VNode | (() => VNode);
+    title?: string | number;
+}
+interface SerializedTask {
+    /** Task id, auto-generated if not set */
+    id: string | number;
+    /** Scheduled start. Accepts Date or a date string matching date_format. */
+    start_date?: Date | string;
+    /** Scheduled end. Accepts Date or a date string matching date_format. */
+    end_date?: Date | string;
+    /** Task duration (working-time units). */
+    duration?: number;
+    /** Task display name. */
+    text?: any;
+    /** "task" | "project" | "milestone" */
+    type?: string;
+    /** Parent task id. */
+    parent?: number | string;
+    /** Progress 0-1. */
+    progress?: number;
+    /** Whether the branch is initially open. */
+    open?: boolean;
+    auto_scheduling?: boolean;
+    unscheduled?: boolean;
+    constraint_date?: Date | string;
+    constraint_type?: string;
+    deadline?: Date | string;
+    color?: string;
+    textColor?: string;
+    progressColor?: string;
+    bar_height?: number;
+    row_height?: number;
+    hide_bar?: boolean;
+    baselines?: Baseline[];
+    calendar_id?: number | string;
+    editable?: boolean;
+    readonly?: boolean;
+    render?: string;
+    split_placement?: "inline" | "subrow" | "auto" | null | undefined;
+    resource?: Array<string>;
+    rollup?: boolean;
+    group_id?: string | number;
+    key?: string | number;
+    label?: string;
+    target?: string;
+    [customProperty: string]: any;
+}
+interface SerializedLink {
+    /** Link id. */
+    id: string | number;
+    /** Source (predecessor) task id. */
+    source: string | number;
+    /** Target (successor) task id. */
+    target: string | number;
+    /**
+     * Dependency type.
+     * "0" = finish-to-start, "1" = start-to-start,
+     * "2" = finish-to-finish, "3" = start-to-finish
+     */
+    type: string;
+    /** Lag (in duration units). */
+    lag?: number;
+    editable?: boolean;
+    readonly?: boolean;
+    [customProperty: string]: any;
+}
+interface WrapperCalendar {
+    id: string;
+    hours?: string[];
+    days?: {
+        weekdays?: Partial<Record<0 | 1 | 2 | 3 | 4 | 5 | 6, string[] | boolean>>;
+        dates?: Record<string, string[] | boolean>;
+    };
+    customWeeks?: Record<string, {
+        from: Date;
+        to: Date;
+        hours?: string[];
+        days?: {
+            weekdays?: Partial<Record<0 | 1 | 2 | 3 | 4 | 5 | 6, string[] | boolean>>;
+            dates?: Record<string, string[] | boolean>;
+        };
+    }>;
+}
+type TaskFilter = ((task: Task) => boolean) | null;
+type ResourceFilter = ((resource: any) => boolean) | null;
+interface WrapperInlineEditorMethods {
+    focus?: () => void;
+    save?: () => void;
+    setValue?: (value: any) => void;
+    getValue?: () => any;
+    isChanged?: (value: any) => boolean;
+    isValid?: () => boolean;
+}
+interface InlineEditorComponentProps {
+    initialValue: any;
+    task: Task;
+    save: () => void;
+    cancel: () => void;
+    ganttInstance: GanttStatic;
+}
+interface ActiveInlineEditor {
+    id: string;
+    placeholder: HTMLElement;
+    editorType: string;
+    initialValue: any;
+    task: Task;
+    onMount?: () => void;
+}
+interface CustomLightboxProps {
+    data: any;
+    onSave: (updatedTask: any) => void;
+    onCancel: () => void;
+    onDelete: () => void;
+    ganttInstance: GanttStatic;
+}
+type TemplateWrapper = (node: VNode) => VNode;
+type GroupTasks = any;
+interface VueGanttProps {
+    tasks?: Array<Task | SerializedTask>;
+    links?: Array<Link | SerializedLink>;
+    resources?: any[] | null;
+    resourceAssignments?: any[] | null;
+    baselines?: any[] | null;
+    markers?: Marker[] | null;
+    calendars?: (WrapperCalendar | CalendarConfig)[] | null;
+    data?: VueGanttDataConfig | null;
+    config?: Partial<GanttConfigOptions>;
+    plugins?: GanttPlugins;
+    templates?: Partial<GanttTemplates>;
+    locale?: string | Record<string, any>;
+    theme?: string;
+    filter?: TaskFilter;
+    resourceFilter?: ResourceFilter;
+    modals?: GanttModals | null;
+    groupTasks?: GroupTasks;
+    inlineEditors?: Record<string, Component>;
+    customLightbox?: Component | null;
+    templateWrapper?: TemplateWrapper | null;
+    events?: VueGanttEvents;
+    [key: string]: any;
+}
+
+declare const VueGantt: vue.DefineComponent<{
+    [x: string]: /*elided*/ any;
+    tasks?: Array<Task | SerializedTask>;
+    links?: Array<Link | SerializedLink>;
+    resources?: any[] | null;
+    resourceAssignments?: any[] | null;
+    baselines?: any[] | null;
+    markers?: Marker[] | null;
+    calendars?: (WrapperCalendar | CalendarConfig)[] | null;
+    data?: VueGanttDataConfig | null;
+    config?: Partial<GanttConfigOptions>;
+    plugins?: GanttPlugins;
+    templates?: Partial<GanttTemplates>;
+    locale?: string | Record<string, any>;
+    theme?: string;
+    filter?: TaskFilter;
+    resourceFilter?: ResourceFilter;
+    modals?: GanttModals | null;
+    groupTasks?: GroupTasks;
+    inlineEditors?: Record<string, Component>;
+    customLightbox?: Component | null;
+    templateWrapper?: TemplateWrapper | null;
+    events?: VueKnownGanttEvents & Record<string, (...args: any[]) => any>;
+}, () => vue.VNode<vue.RendererNode, vue.RendererElement, {
+    [key: string]: any;
+}>, {}, {}, {}, vue.ComponentOptionsMixin, vue.ComponentOptionsMixin, {
+    ready: (instance: GanttStatic) => boolean;
+}, string, vue.PublicProps, Readonly<{
+    [x: string]: /*elided*/ any;
+    tasks?: Array<Task | SerializedTask>;
+    links?: Array<Link | SerializedLink>;
+    resources?: any[] | null;
+    resourceAssignments?: any[] | null;
+    baselines?: any[] | null;
+    markers?: Marker[] | null;
+    calendars?: (WrapperCalendar | CalendarConfig)[] | null;
+    data?: VueGanttDataConfig | null;
+    config?: Partial<GanttConfigOptions>;
+    plugins?: GanttPlugins;
+    templates?: Partial<GanttTemplates>;
+    locale?: string | Record<string, any>;
+    theme?: string;
+    filter?: TaskFilter;
+    resourceFilter?: ResourceFilter;
+    modals?: GanttModals | null;
+    groupTasks?: GroupTasks;
+    inlineEditors?: Record<string, Component>;
+    customLightbox?: Component | null;
+    templateWrapper?: TemplateWrapper | null;
+    events?: VueKnownGanttEvents & Record<string, (...args: any[]) => any>;
+}> & Readonly<{
+    onReady?: (instance: GanttStatic) => any;
+}>, {
+    baselines: any[];
+    tasks: (Task | SerializedTask)[];
+    links: (Link | SerializedLink)[];
+    resources: any[];
+    resourceAssignments: any[];
+    markers: Marker[];
+    calendars: any[];
+    data: VueGanttDataConfig;
+    config: Partial<GanttConfigOptions>;
+    plugins: GanttPlugins;
+    templates: Partial<GanttTemplates>;
+    locale: string | Record<string, any>;
+    theme: string;
+    filter: (task: Task) => boolean;
+    resourceFilter: (resource: any) => boolean;
+    modals: GanttModals;
+    groupTasks: any;
+    inlineEditors: Record<string, Component>;
+    customLightbox: any;
+    templateWrapper: TemplateWrapper;
+    events: VueGanttEvents;
+}, {}, {}, {}, string, vue.ComponentProvideOptions, true, {}, any>;
+
+declare function useWorkTime(ganttRef: Ref<VueGanttRef | null>): vue.ComputedRef<{
+    isWorkTime: ({ date, task, unit }: {
+        date: Date;
+        task?: Task | null;
+        unit?: string;
+    }) => boolean;
+    calculateEndDate: ({ start, duration, unit, task }: {
+        start: Date;
+        duration: number;
+        unit?: string;
+        task?: Task;
+    }) => Date;
+    calculateDuration: ({ start, end, task }: {
+        start: Date;
+        end: Date;
+        task?: Task;
+    }) => number;
+    getClosestWorkTime: ({ date, task, unit, dir }: {
+        date: Date;
+        task?: Task | null;
+        unit: string;
+        dir?: string;
+    }) => Date;
+}>;
+
+declare function useResourceAssignments(ganttRef: Ref<VueGanttRef | null>): vue.ComputedRef<{
+    getResourceAssignments(resourceId: string | number, taskId?: string | number): any;
+    getTaskResources(taskId: string | number): any;
+}>;
+
+declare function useGanttDatastore<T>(ganttRef: Ref<VueGanttRef | null>, storeName: string): vue.ComputedRef<{
+    getItem(id: string | number): T | null;
+    getItems(): T[];
+    hasChild(id: string | number): boolean;
+    getChildren(id: string | number): (string | number)[];
+}>;
+
+interface ExportToExcelConfig {
+    [key: string]: any;
+}
+declare function useGanttActions(ganttRef: Ref<VueGanttRef | null | undefined>): {
+    undo(): void;
+    redo(): void;
+    render(): void;
+    exportToPDF(): void;
+    exportToPNG(): void;
+    exportToExcel(config?: ExportToExcelConfig): void;
+    exportToMSProject(): void;
+};
+
+type EventHandler = (...args: any[]) => any;
+declare function useGanttEvent(ganttRef: Ref<VueGanttRef | null | undefined>, eventName: MaybeRef<string>, handler: MaybeRef<EventHandler | null | undefined>): {
+    detach: () => void;
+};
+
+declare function defineGanttConfig<T extends Partial<GanttConfigOptions>>(config: T): T;
+declare function defineGanttTemplates<T extends Partial<GanttTemplates>>(templates: T): T;
+declare function defineGanttEvents<T extends VueGanttEvents>(events: T): T;
+declare function defineInlineEditors<T extends Record<string, Component>>(inlineEditors: T): T;
+
+export { VueGantt, VueGantt as default, defineGanttConfig, defineGanttEvents, defineGanttTemplates, defineInlineEditors, useGanttActions, useGanttDatastore, useGanttEvent, useResourceAssignments, useWorkTime };
+export type { ActiveInlineEditor, BatchChanges, CustomLightboxProps, DataCallbackChange, DataSet, GanttModals, GroupTasks, InlineEditorComponentProps, Marker, OnBeforeLinkDeleteConfirmArgs, OnBeforeTaskDeleteConfirmArgs, ResourceFilter, SerializedLink, SerializedTask, TaskFilter, TemplateWrapper, VueGanttDataConfig, VueGanttEmits, VueGanttEvents, VueGanttExpose, VueGanttProps, VueGanttRef, VueKnownGanttEvents, WrapperCalendar, WrapperInlineEditorMethods };