@progress/kendo-angular-gantt 2.0.0-next.202204010911 → 2.0.0-next.202204121022

package/models/events/cell-click-event.interface.d.ts

@@ -0,0 +1,43 @@
+/**-----------------------------------------------------------------------------------------
+* Copyright © 2021 Progress Software Corporation. All rights reserved.
+* Licensed under commercial license. See LICENSE.md in the project root for more information
+*-------------------------------------------------------------------------------------------*/
+import type { GanttComponent } from '../../gantt.component';
+import { GanttColumnComponent, GanttSpanColumnComponent } from '../../columns/columns';
+/**
+ * Triggered every time a cell is clicked.
+ */
+export interface CellClickEvent {
+    /**
+     * The column component associated with the clicked cell.
+     */
+    column: GanttColumnComponent | GanttSpanColumnComponent;
+    /**
+     * The column index of the clicked cell.
+     */
+    columnIndex: number;
+    /**
+     * The data item associated with the clicked cell.
+     */
+    dataItem: any;
+    /**
+     * Indicates whether the cell is in edit mode.
+     */
+    isEdited: boolean;
+    /**
+     * The DOM event that triggered the `cellClick` event.
+     */
+    originalEvent: PointerEvent;
+    /**
+     * The row index for the clicked cell.
+     */
+    rowIndex: number;
+    /**
+     * The Gantt component instance.
+     */
+    sender: GanttComponent;
+    /**
+     * The type of the event that triggered the `cellClick` event.
+     */
+    type: 'click' | 'contextmenu' | 'dblclick';
+}

package/models/events/cell-close-event.interface.d.ts

@@ -0,0 +1,48 @@
+/**-----------------------------------------------------------------------------------------
+* Copyright © 2021 Progress Software Corporation. All rights reserved.
+* Licensed under commercial license. See LICENSE.md in the project root for more information
+*-------------------------------------------------------------------------------------------*/
+import type { GanttComponent } from '../../gantt.component';
+import { PreventableEvent } from '@progress/kendo-angular-treelist';
+import { TaskEditItem } from './task-edit-event.interface';
+/**
+ * Called every time a user leaves an edited cell.
+ */
+export declare class CellCloseEvent extends PreventableEvent {
+    /**
+     * The data item.
+     */
+    dataItem: any;
+    /**
+     * Indicates if the data item is new or existing.
+     */
+    isNew: boolean;
+    /**
+     * The data row index for the operation.
+     */
+    rowIndex: number;
+    /**
+     * The Gantt column that will be closed.
+     */
+    column: any;
+    /**
+     * The [`FormGroup`]({{ site.data.urls.angular['formgroupapi'] }}) that is used to edit the cell which will be closed.
+     */
+    formGroup: any;
+    /**
+     * The DOM event that caused the `cellClose` event.
+     * May not be present if `cellClose` was caused by an API call.
+     */
+    originalEvent: any;
+    /**
+     * The `GanttComponent` instance.
+     */
+    sender: GanttComponent;
+    /**
+     * The `TaskEditItem` associated with the edited task.
+     * The parent item is accessible through the `parent` property,
+     * and allows traversing all ancestors that need to be updated.
+     */
+    item: TaskEditItem;
+    constructor(options: any);
+}

package/models/events/click-event.interface.d.ts

@@ -0,0 +1,23 @@
+/**-----------------------------------------------------------------------------------------
+* Copyright © 2021 Progress Software Corporation. All rights reserved.
+* Licensed under commercial license. See LICENSE.md in the project root for more information
+*-------------------------------------------------------------------------------------------*/
+/**
+ * @hidden
+ *
+ * Arguments for the `remove` event.
+ */
+export interface ClickEvent {
+    /**
+     * The event type.
+     */
+    dataItem: any;
+    /**
+     * The row index for the operation.
+     */
+    rowIndex: number;
+    /**
+     * The original DOM event.
+     */
+    originalEvent: any;
+}

package/models/events/column-locked-change-event.interface.d.ts

@@ -0,0 +1,16 @@
+/**-----------------------------------------------------------------------------------------
+* Copyright © 2021 Progress Software Corporation. All rights reserved.
+* Licensed under commercial license. See LICENSE.md in the project root for more information
+*-------------------------------------------------------------------------------------------*/
+import { GanttColumnBase } from '../../columns/column-base';
+/**
+ * @hidden
+ *
+ * Arguments for the `columnLockedChange` event.
+ */
+export interface ColumnLockedChangeEvent {
+    /**
+     * The columns whose locked state is changed.
+     */
+    columns: GanttColumnBase[];
+}

package/models/events/column-reorder-event.interface.d.ts

@@ -0,0 +1,10 @@
+/**-----------------------------------------------------------------------------------------
+* Copyright © 2021 Progress Software Corporation. All rights reserved.
+* Licensed under commercial license. See LICENSE.md in the project root for more information
+*-------------------------------------------------------------------------------------------*/
+import { ColumnReorderEvent as TreeListColumnReorderEvent } from '@progress/kendo-angular-treelist';
+/**
+ * Arguments for the `columnReorder` event.
+ */
+export interface ColumnReorderEvent extends TreeListColumnReorderEvent {
+}

package/models/events/column-resize-event.interface.d.ts

@@ -0,0 +1,10 @@
+/**-----------------------------------------------------------------------------------------
+* Copyright © 2021 Progress Software Corporation. All rights reserved.
+* Licensed under commercial license. See LICENSE.md in the project root for more information
+*-------------------------------------------------------------------------------------------*/
+import { ColumnResizeArgs } from '@progress/kendo-angular-treelist';
+/**
+ * Arguments for the `columnResize` event.
+ */
+export interface ColumnResizeEvent extends ColumnResizeArgs {
+}

package/models/events/column-visibility-change-event.interface.d.ts

@@ -0,0 +1,14 @@
+/**-----------------------------------------------------------------------------------------
+* Copyright © 2021 Progress Software Corporation. All rights reserved.
+* Licensed under commercial license. See LICENSE.md in the project root for more information
+*-------------------------------------------------------------------------------------------*/
+import { GanttColumnBase } from '../../columns/column-base';
+/**
+ * Arguments for the `columnVisibilityChange` event.
+ */
+export interface ColumnVisibilityChangeEvent {
+    /**
+     * The columns whose visibility is changed.
+     */
+    columns: GanttColumnBase[];
+}

package/models/events/data-state-change-event.interface.d.ts

@@ -0,0 +1,10 @@
+/**-----------------------------------------------------------------------------------------
+* Copyright © 2021 Progress Software Corporation. All rights reserved.
+* Licensed under commercial license. See LICENSE.md in the project root for more information
+*-------------------------------------------------------------------------------------------*/
+import { DataStateChangeEvent as TreeListDataStateChangeEvent } from "@progress/kendo-angular-treelist";
+/**
+ * Arguments for the `dataStateChange` event
+ */
+export interface DataStateChangeEvent extends TreeListDataStateChangeEvent {
+}

package/models/events/dependency-add-event.interface.d.ts

@@ -0,0 +1,26 @@
+/**-----------------------------------------------------------------------------------------
+* Copyright © 2021 Progress Software Corporation. All rights reserved.
+* Licensed under commercial license. See LICENSE.md in the project root for more information
+*-------------------------------------------------------------------------------------------*/
+import { DependencyType } from '../dependency-type.enum';
+/**
+ * The event data of the [`dependencyAdd`]({% slug api_gantt_ganttcomponent %}#toc-dependencyadd) event.
+ */
+export interface DependencyAddEvent {
+    /**
+     * The task from which the dependency starts (predecessor).
+     */
+    fromTask: any;
+    /**
+     * The task where the dependency ends (successor).
+     */
+    toTask: any;
+    /**
+     * The dependency type of the linked tasks.
+     */
+    type: DependencyType;
+    /**
+     * Specifies whether the dependency creation attempt is a valid link between the two targeted tasks.
+     */
+    isValid: boolean;
+}

package/models/events/selected-view-change-event.interface.d.ts

@@ -0,0 +1,19 @@
+/**-----------------------------------------------------------------------------------------
+* Copyright © 2021 Progress Software Corporation. All rights reserved.
+* Licensed under commercial license. See LICENSE.md in the project root for more information
+*-------------------------------------------------------------------------------------------*/
+/**
+ * @hidden
+ *
+ * Called every time the active view is changed.
+ */
+export interface SelectedViewChangeEvent {
+    /**
+     * The selected view.
+     */
+    value: string;
+    /**
+     * The original DOM event.
+     */
+    originalEvent: any;
+}

package/models/events/task-add-event.interface.d.ts

@@ -0,0 +1,31 @@
+/**-----------------------------------------------------------------------------------------
+* Copyright © 2021 Progress Software Corporation. All rights reserved.
+* Licensed under commercial license. See LICENSE.md in the project root for more information
+*-------------------------------------------------------------------------------------------*/
+import { TaskEditItem } from "./task-edit-event.interface";
+/**
+ * The event data of the [`taskAdd`]({% slug api_gantt_ganttcomponent %}#toc-taskadd) event.
+ */
+export interface TaskAddEvent {
+    /**
+     * The currently selected Gantt task.
+     */
+    selectedItem: TaskEditItem | null;
+    /**
+     * The type of the add action. The built-in types are `addTask`, `addChild`, `addAbove`, and `addBelow`.
+     */
+    actionType: string;
+}
+/**
+ * The interface of the AddTask DropDownButton options.
+ */
+export interface GanttAddTaskActionItem {
+    /**
+     * The text of the respective DropDownButton option.
+     */
+    text: string;
+    /**
+     * The type of action associated with selecting the respective DropDownButton option.
+     */
+    type: string;
+}

package/models/events/task-click-event.interface.d.ts

@@ -0,0 +1,30 @@
+/**-----------------------------------------------------------------------------------------
+* Copyright © 2021 Progress Software Corporation. All rights reserved.
+* Licensed under commercial license. See LICENSE.md in the project root for more information
+*-------------------------------------------------------------------------------------------*/
+import type { GanttComponent } from '../../gantt.component';
+/**
+ * Triggered every time a task is clicked.
+ */
+export interface TaskClickEvent {
+    /**
+     * The DOM event that triggered the `taskClick` event.
+     */
+    originalEvent: PointerEvent | KeyboardEvent;
+    /**
+     * The data item associated with the clicked task.
+     */
+    dataItem: any;
+    /**
+     * The Gantt component instance.
+     */
+    sender: GanttComponent;
+    /**
+     * The order index of the clicked task, defined by the number of rendered tasks in the Timeline.
+     */
+    index: number;
+    /**
+     * The type of the event that triggered the `taskClick` event.
+     */
+    type: 'click' | 'contextmenu' | 'dblclick';
+}

package/models/events/task-delete-event.interface.d.ts

@@ -0,0 +1,21 @@
+/**-----------------------------------------------------------------------------------------
+* Copyright © 2021 Progress Software Corporation. All rights reserved.
+* Licensed under commercial license. See LICENSE.md in the project root for more information
+*-------------------------------------------------------------------------------------------*/
+import type { GanttComponent } from '../../gantt.component';
+import { TaskEditItem } from './task-edit-event.interface';
+/**
+ * The event data of the [`taskDelete`]({% slug api_gantt_ganttcomponent %}#toc-taskdelete) event.
+ */
+export interface TaskDeleteEvent {
+    /**
+     * The item associated with the delete request.
+     * The parent item is accessible through the `parent` property,
+     * and allows traversing all ancestors that need to be updated.
+     */
+    item: TaskEditItem;
+    /**
+     * The GanttComponent instance.
+     */
+    sender: GanttComponent;
+}

package/models/events/task-edit-event.interface.d.ts

@@ -0,0 +1,76 @@
+/**-----------------------------------------------------------------------------------------
+* Copyright © 2021 Progress Software Corporation. All rights reserved.
+* Licensed under commercial license. See LICENSE.md in the project root for more information
+*-------------------------------------------------------------------------------------------*/
+import { FormGroup } from "@angular/forms";
+import type { GanttComponent } from "../../gantt.component";
+/**
+ * The event data for the task editing events.
+ */
+export interface TaskEditEvent {
+    /**
+     * The `TaskEditItem` associated with the edited task.
+     * The parent item is accessible through the `parent` property,
+     * and allows traversing all ancestors that need to be updated.
+     */
+    item: TaskEditItem;
+    /**
+     * The FormGroup instance associated with the edited task.
+     */
+    taskFormGroup?: FormGroup;
+    /**
+     * The dependencies associated with the edited task.
+     */
+    dependencies: EditEventDependencies;
+    /**
+     * The GanttComponent instance.
+     */
+    sender: GanttComponent;
+}
+/**
+ * The `TaskEditItem` associated with the edited task.
+ * The parent item is accessible through the `parent` property,
+ * and allows traversing all ancestors that need to be updated.
+ */
+export interface TaskEditItem {
+    /**
+     * The original data item for this entry.
+     */
+    dataItem: any;
+    /**
+     * Holds the parent data item and data about its parent.
+     * If the current data item is at root level, this prop will be set to `null`.
+     */
+    parent?: TaskEditItem;
+}
+/**
+ * The `EditEventDependencies` object associated with the edited task.
+ * The created, updated and deleted items are accessible through their respective properties.
+ */
+export interface EditEventDependencies {
+    /**
+     * Lists the newly created dependencies.
+     */
+    createdItems: any[];
+    /**
+     * Lists the updated dependencies.
+     */
+    updatedItems: any[];
+    /**
+     * Lists the deleted dependencies.
+     */
+    deletedItems: any[];
+}
+/**
+ * @hidden
+ */
+export declare type EditResultType = 'save' | 'remove' | 'cancel';
+/**
+ * @hidden
+ */
+export interface EditEvent {
+    taskFormGroup: FormGroup;
+    dataItem: any;
+    dependencies: EditEventDependencies;
+    editResultType: EditResultType;
+}

package/models/events/task-move-end-event.interface.d.ts

@@ -0,0 +1,12 @@
+/**-----------------------------------------------------------------------------------------
+* Copyright © 2021 Progress Software Corporation. All rights reserved.
+* Licensed under commercial license. See LICENSE.md in the project root for more information
+*-------------------------------------------------------------------------------------------*/
+import { TaskMoveEvent } from "./task-move-event.interface";
+/**
+ * @hidden
+ *
+ * Fired when the user stops moving a task.
+ */
+export interface TaskMoveEndEvent extends TaskMoveEvent {
+}

package/models/events/task-move-event.interface.d.ts

@@ -0,0 +1,23 @@
+/**-----------------------------------------------------------------------------------------
+* Copyright © 2021 Progress Software Corporation. All rights reserved.
+* Licensed under commercial license. See LICENSE.md in the project root for more information
+*-------------------------------------------------------------------------------------------*/
+/**
+ * @hidden
+ *
+ * Fired when the user is moving a task.
+ */
+export interface TaskMoveEvent {
+    /**
+     * The task which is being moved.
+     */
+    dataItem: any;
+    /**
+     * The current task start date.
+     */
+    start: Date;
+    /**
+     * The current task end date.
+     */
+    end: Date;
+}

package/models/events/task-move-start-event.interface.d.ts

@@ -0,0 +1,15 @@
+/**-----------------------------------------------------------------------------------------
+* Copyright © 2021 Progress Software Corporation. All rights reserved.
+* Licensed under commercial license. See LICENSE.md in the project root for more information
+*-------------------------------------------------------------------------------------------*/
+/**
+ * @hidden
+ *
+ * Fired when the user starts to drag a task.
+ */
+export interface TaskMoveStartEvent {
+    /**
+     * The task which is being moved.
+     */
+    dataItem: any;
+}

package/models/events/task-resize-end-event.interface.d.ts

@@ -0,0 +1,12 @@
+/**-----------------------------------------------------------------------------------------
+* Copyright © 2021 Progress Software Corporation. All rights reserved.
+* Licensed under commercial license. See LICENSE.md in the project root for more information
+*-------------------------------------------------------------------------------------------*/
+import { TaskResizeEvent } from "./task-resize-event.interface";
+/**
+ * @hidden
+ *
+ * Fired when the user stops resizing a task.
+ */
+export interface TaskResizeEndEvent extends TaskResizeEvent {
+}

package/models/events/task-resize-event.interface.d.ts

@@ -0,0 +1,23 @@
+/**-----------------------------------------------------------------------------------------
+* Copyright © 2021 Progress Software Corporation. All rights reserved.
+* Licensed under commercial license. See LICENSE.md in the project root for more information
+*-------------------------------------------------------------------------------------------*/
+/**
+ * @hidden
+ *
+ * Fired when the user is resizing a task.
+ */
+export interface TaskResizeEvent {
+    /**
+     * The task which is being resized.
+     */
+    dataItem: any;
+    /**
+     * The current task start date.
+     */
+    start: Date;
+    /**
+     * The current task end date.
+     */
+    end: Date;
+}

package/models/events/task-resize-start-event.interface.d.ts

@@ -0,0 +1,15 @@
+/**-----------------------------------------------------------------------------------------
+* Copyright © 2021 Progress Software Corporation. All rights reserved.
+* Licensed under commercial license. See LICENSE.md in the project root for more information
+*-------------------------------------------------------------------------------------------*/
+/**
+ * @hidden
+ *
+ * Fired when the user starts to resize a task.
+ */
+export interface TaskResizeStartEvent {
+    /**
+     * The task which is being resized.
+     */
+    dataItem: any;
+}

package/models/filterable-settings.d.ts

@@ -0,0 +1,10 @@
+/**-----------------------------------------------------------------------------------------
+* Copyright © 2021 Progress Software Corporation. All rights reserved.
+* Licensed under commercial license. See LICENSE.md in the project root for more information
+*-------------------------------------------------------------------------------------------*/
+import { FilterableSettings as TreeListFilterableSettings } from '@progress/kendo-angular-treelist';
+/**
+ * Represents the options for the `filterable` setting of the Gantt.
+ * @hidden
+ */
+export declare type FilterableSettings = TreeListFilterableSettings;

package/models/gantt-dependency-model-fields.interface.d.ts

@@ -0,0 +1,35 @@
+/**-----------------------------------------------------------------------------------------
+* Copyright © 2021 Progress Software Corporation. All rights reserved.
+* Licensed under commercial license. See LICENSE.md in the project root for more information
+*-------------------------------------------------------------------------------------------*/
+/**
+ * Defines the model fields that will be used for creating GanttDependency instances.
+ *
+ * > All dependency fields can be set to point to nested property values - e.g. `'category.id'`.
+ */
+export interface GanttDependencyModelFields {
+    /**
+     * The name of the from task id model field.
+     * Defaults to `"fromId"`.
+     */
+    fromId?: string;
+    /**
+     * The name of the `ID` model field of the dependency item.
+     * Defaults to `"id"`.
+     */
+    id?: string;
+    /**
+     * The name of the to task id model field.
+     * Defaults to `"toId"`.
+     */
+    toId?: string;
+    /**
+     * The name of the type model field.
+     * Defaults to `"type"`.
+     */
+    type?: string;
+}
+/**
+ * @hidden
+ */
+export declare const DEFAULT_DEPENDENCY_MODEL_FIELDS: GanttDependencyModelFields;

package/models/gantt-dependency.interface.d.ts

@@ -0,0 +1,26 @@
+/**-----------------------------------------------------------------------------------------
+* Copyright © 2021 Progress Software Corporation. All rights reserved.
+* Licensed under commercial license. See LICENSE.md in the project root for more information
+*-------------------------------------------------------------------------------------------*/
+import { DependencyType } from './dependency-type.enum';
+/**
+ * Represents an instance of a Gantt dependency.
+ */
+export interface GanttDependency {
+    /**
+     * The `id` of the origin task of this dependency.
+     */
+    fromId: string | number;
+    /**
+     * The unique identifier of the dependency.
+     */
+    id: string | number;
+    /**
+     * The `id` of the destination task of this dependency.
+     */
+    toId: string | number;
+    /**
+     * The type of the dependency.
+     */
+    type: DependencyType;
+}

package/models/gantt-task-model-fields.interface.d.ts

@@ -0,0 +1,42 @@
+/**-----------------------------------------------------------------------------------------
+* Copyright © 2021 Progress Software Corporation. All rights reserved.
+* Licensed under commercial license. See LICENSE.md in the project root for more information
+*-------------------------------------------------------------------------------------------*/
+/**
+ * Defines the model fields that will be used for creating `GanttTask` instances.
+ *
+ * > All task fields can be set to point to nested property values - e.g. `'category.id'`.
+ */
+export interface GanttTaskModelFields {
+    /**
+     * The name of the end date model field.
+     * Defaults to `"end"`.
+     */
+    end?: string;
+    /**
+     * The name of the `ID` model field.
+     * Defaults to `"id"`.
+     */
+    id?: string;
+    /**
+     * The name of the percent complete model field.
+     * Defaults to `"completionRatio"`.
+     */
+    completionRatio?: string;
+    /**
+     * The name of the start date model field.
+     * Defaults to `"start"`.
+     */
+    start?: string;
+    /**
+     * The name of the title model field.
+     * Used as text in the task content area.
+     * Defaults to `"title"`.
+     */
+    title?: string;
+    children?: string;
+}
+/**
+ * @hidden
+ */
+export declare const DEFAULT_TASK_MODEL_FIELDS: GanttTaskModelFields;

package/models/gantt-task.interface.d.ts

@@ -0,0 +1,31 @@
+/**-----------------------------------------------------------------------------------------
+* Copyright © 2021 Progress Software Corporation. All rights reserved.
+* Licensed under commercial license. See LICENSE.md in the project root for more information
+*-------------------------------------------------------------------------------------------*/
+/**
+ * Represents an instance of a Gantt task.
+ */
+export interface GanttTask {
+    /**
+     * The date at which the Gantt task ends.
+     */
+    end: Date;
+    /**
+     * The unique identifier of the task.
+     */
+    id: string | number;
+    /**
+     * The completion ratio of the task. A value between 0 and 1 representing the completed portion of the task.
+     * Defaults to `0`.
+     */
+    completionRatio?: number;
+    /**
+     * The date at which the Gantt task starts.
+     */
+    start: Date;
+    /**
+     * The title of the task which is displayed by the Gantt component.
+     * Defaults to `""`.
+     */
+    title?: string;
+}