@progress/kendo-angular-gantt 0.2.1-dev.202112101349 → 0.3.0-dev.202201190830

package/dist/es2015/gantt.component.d.ts

@@ -8,8 +8,10 @@ import { TreeListComponent, DataBoundTreeComponent, ExpandableTreeComponent, Sel
 import { CompositeFilterDescriptor, SortDescriptor } from '@progress/kendo-data-query';
 import { Day } from '@progress/kendo-date-math';
 import { Observable } from 'rxjs';
+import { GanttTimelineComponent } from './timeline/gantt-timeline.component';
 import { GanttColumnBase } from './columns/columns';
-import { DataStateChangeEvent, ColumnMenuSettings, RowClassFn, TaskClassFn, ColumnVisibilityChangeEvent, ColumnResizeEvent, ColumnLockedChangeEvent, ColumnReorderEvent, ColumnReorderConfig, GanttTaskModelFields, GanttDependencyModelFields, SortSettings, CellClickEvent, TaskClickEvent } from './models/models';
+import { DataStateChangeEvent, ColumnMenuSettings, RowClassFn, TaskClassFn, ColumnVisibilityChangeEvent, ColumnResizeEvent, ColumnLockedChangeEvent, ColumnReorderEvent, ColumnReorderConfig, GanttTaskModelFields, GanttDependencyModelFields, SortSettings, CellClickEvent, TaskClickEvent, DependencyAddEvent, TaskDeleteEvent } from './models/models';
+import { LocalizationService } from '@progress/kendo-angular-l10n';
 import { TimelineViewService } from './timeline/timeline-view.service';
 import { TimelineViewType } from './models/timeline-view';
 import { TimelineBaseViewService } from './timeline/timeline-base-view.service';
@@ -18,18 +20,21 @@ import { DependencyDomService } from './dependencies/dependency-dom.service';
 import { MappingService } from './common/mapping.service';
 import { OptionChangesService } from './common/option-changes.service';
 import { EditService } from './editing/edit.service';
-import { LocalizationService } from '@progress/kendo-angular-l10n';
+import { NavigationService } from './navigation/navigation.service';
 import { TimelinePaneOptions, TreeListPaneOptions } from './models/splitter-pane-options.interface';
 import { GanttTaskTemplateDirective } from './template-directives/task-template.directive';
 import { GanttSummaryTaskTemplateDirective } from './template-directives/summary-task-template.directive';
 import { GanttTaskContentTemplateDirective } from './template-directives/task-content-template.directive';
 import { ToolbarTemplateDirective } from './toolbar/toolbar-template.directive';
-import { ToolbarPosition } from './models/toolbar-position';
+import { ToolbarSettings } from './models/toolbar-settings';
 import { ExpandEvent } from './expanded-state/expand-event';
 import { ViewBase } from './timeline/view-base';
 import { SelectionChangeEvent } from './selection/selection-change-event';
 import { TaskEditEvent } from './models/events/task-edit-event.interface';
 import { CellCloseEvent } from './models/events/cell-close-event.interface';
+import { TaskAddEvent } from './models/events/task-add-event.interface';
+import { ViewItem } from './models/view-item.interface';
+import { DragScrollSettings } from './scrolling/drag-scroll-settings';
 /**
  * Represents the Kendo UI Gantt component for Angular.
  *
@@ -112,21 +117,24 @@ export declare class GanttComponent implements AfterContentInit, OnChanges, OnDe
     private localizationService;
     private hostElement;
     private zone;
+    private navigationService;
     treeList: TreeListComponent;
-    /**
-     * @hidden
-     */
+    timeline: GanttTimelineComponent;
     taskContentTemplate: GanttTaskContentTemplateDirective;
+    taskTemplate: GanttTaskTemplateDirective;
+    summaryTaskTemplate: GanttSummaryTaskTemplateDirective;
+    toolbarTemplateChildren: QueryList<ToolbarTemplateDirective>;
+    toolbarTemplate: ToolbarTemplateDirective;
     /**
      * @hidden
      */
-    taskTemplate: GanttTaskTemplateDirective;
+    roleDescription: string;
+    readonly hostRoleDescriptionAttr: string;
     /**
      * @hidden
      */
-    summaryTaskTemplate: GanttSummaryTaskTemplateDirective;
-    toolbarTemplateChildren: QueryList<ToolbarTemplateDirective>;
-    toolbarTemplate: ToolbarTemplateDirective;
+    role: string;
+    readonly hostRoleAttr: string;
     hostClasses: boolean;
     readonly dir: string;
     /**
@@ -162,11 +170,22 @@ export declare class GanttComponent implements AfterContentInit, OnChanges, OnDe
      */
     data: any[];
     /**
-     * Provides a callback that determines if the given task is selected ([see example]({% slug selection_gantt %}#toc-custom-selection))
+     * Specifies a callback that determines if the given task is selected ([see example]({% slug selection_gantt %}#toc-custom-selection)).
      *
      * > The [`selectable`]({% slug api_gantt_ganttcomponent %}#toc-selectable) prop has to be set to `true` in order for this callback to be executed.
      */
     isSelected: (dataItem: object) => boolean;
+    /**
+     * Specifies a callback that determines if a new dependency is valid.
+     * Used when evaluating if an attempt to create a new dependency will result in a valid link between the two tasks
+     * [see example]({% slug editing_drag_create_dependencies_gantt %}#toc-validation).
+     *
+     * By defalut, dependencies are deemed invalid when:
+     *  - The two tasks are in a parent-child relationship.
+     *  - The two tasks are already dependent on one another. Only one dependency is allowed per pair.
+     *  - The start or end times of the two tasks are incompatible with the attempted dependency type.
+     */
+    validateNewDependency: (dependency: object) => boolean;
     /**
      * Fires when the Gantt selection is changed through user interaction.
      *
@@ -183,24 +202,27 @@ export declare class GanttComponent implements AfterContentInit, OnChanges, OnDe
      */
     selectable: boolean;
     /**
-     * The position of the toolbar.
+     * The toolbar configuration. Defines the position and content of the toolbar(s).
+     * The available properties are `position`, `addTaskTool`, and `viewSelectorTool`.
+     * All are optional and default to `top`.
      *
-     * The possible values are:
-     * - `top`&mdash;Positions the toolbar above the Gantt panes.
-     * - `bottom`&mdash;Positions the toolbar below the Gantt panes.
+     * The possible values for each option are:
+     * - `top`&mdash;Positions the toolbar above the Gantt panes. Renders the respective tool in the top toolbar.
+     * - `bottom`&mdash;Positions the toolbar below the Gantt panes. Renders the respective tool in the bottom toolbar.
      * - `both`&mdash;Displays two toolbar instances. Positions the first one above,
-     * and the second one - below the Gantt panes.
-     * - `none`&mdash;No toolbar is rendered.
+     * and the second one - below the Gantt panes. Renders the respective tool in the both toolbars.
+     * - `none`&mdash;No toolbar is rendered when used for setting `position`.
+     * No add task or view selector tool is rendered when used for setting `addTaskTool` or `viewSelectorTool`.
      */
-    toolbarPosition: ToolbarPosition;
+    toolbarSettings: ToolbarSettings;
     /**
      * Gets or sets the callback function that retrieves the child items for a particular item.
      */
-    fetchChildren: (item: object) => Observable<object[]>;
+    fetchChildren: (dataItem: any) => Observable<object[]>;
     /**
      * Gets or sets the callback function that indicates if a particular item has child items.
      */
-    hasChildren: (item: object) => boolean;
+    hasChildren: (dataItem: any) => boolean;
     /**
      * Defines the dependencies that will be drawn between the rendered tasks.
      *
@@ -243,6 +265,12 @@ export declare class GanttComponent implements AfterContentInit, OnChanges, OnDe
      * The end of the work week (index based).
      */
     workWeekEnd: Day;
+    /**
+     * If set to `true`, the user can use dedicated shortcuts to interact with the Gantt.
+     * By default, navigation is disabled for the TreeList and Timeline parts of the component,
+     * ([see example]({% slug keyboard_navigation_gantt %})).
+     */
+    navigable: boolean;
     /**
      * The options of the timeline splitter pane. By default the pane is `collapsible`,
      * `resizable`, not `collapsed`, and its `size` is `'50%'`.
@@ -297,6 +325,12 @@ export declare class GanttComponent implements AfterContentInit, OnChanges, OnDe
      * @default false
      */
     columnsResizable: boolean;
+    /**
+     * Specifies the settings for auto-scrolling during dragging
+     * when the pointer moves outside of the container bounderies
+     * [see example]({% slug editing_drag_create_dependencies_gantt %}#toc-auto-scrolling).
+     */
+    dragScrollSettings: DragScrollSettings;
     /**
      * Fires when an item is expanded.
      */
@@ -315,10 +349,11 @@ export declare class GanttComponent implements AfterContentInit, OnChanges, OnDe
      */
     cellClose: EventEmitter<CellCloseEvent>;
     /**
-     * Fires when the end user clicks the `Delete` button in the task editing dialog or the task delete icon.
+     * Fires when the end user clicks the `Delete` button in the task editing dialog,
+     * the task delete icon, or presses the `Delete` key on the keyboard when a task in the timeline is focused.
      * Use the event handler to open a confirmation dialog when necessary.
      */
-    taskDelete: EventEmitter<any>;
+    taskDelete: EventEmitter<TaskDeleteEvent>;
     /**
      * Fires when an item is collapsed.
      */
@@ -335,6 +370,15 @@ export declare class GanttComponent implements AfterContentInit, OnChanges, OnDe
      * Fires when the user saves an edited task.
      */
     save: EventEmitter<TaskEditEvent>;
+    /**
+     * Fires when the user adds a task.
+     */
+    taskAdd: EventEmitter<TaskAddEvent>;
+    /**
+     * Fires when the user adds a dependency via dragging
+     * [see example]({% slug editing_drag_create_dependencies_gantt %}#toc-basic-concepts).
+     */
+    dependencyAdd: EventEmitter<DependencyAddEvent>;
     /**
      * Fires when the sorting of the Gantt is changed.
      * You have to handle the event yourself and sort the data.
@@ -395,10 +439,23 @@ export declare class GanttComponent implements AfterContentInit, OnChanges, OnDe
      * @hidden
      */
     readonly renderedTreeListItems: any[];
+    /**
+     * @hidden
+     */
+    readonly viewItems: ViewItem[];
     /**
      * @hidden
      */
     readonly filterMenu: string | boolean;
+    /**
+     * @hidden
+     *
+     * Specifies whether the dependency drag clues will be rendered.
+     * Set internally by the dependency-drag-create directive.
+     *
+     * @default false
+     */
+    renderDependencyDragClues: boolean;
     /**
      * @hidden
      */
@@ -434,10 +491,6 @@ export declare class GanttComponent implements AfterContentInit, OnChanges, OnDe
      * Used by the views selector.
      */
     readonly viewTypes: string[];
-    /**
-     * @hidden
-     */
-    readonly editDialogFormGroup: FormGroup;
     /**
      * @hidden
      *
@@ -452,14 +505,22 @@ export declare class GanttComponent implements AfterContentInit, OnChanges, OnDe
      * @hidden
      */
     showConfirmationDialog: boolean;
+    /**
+     * @hidden
+     */
+    readonly isInEditMode: boolean;
     private _columns;
     private _data;
+    private _dragScrollSettings;
     private _timelinePaneOptions;
     private _treeListPaneOptions;
     private _customToolbarTemplate;
     private _rowClass;
     private _taskClass;
     private _activeView;
+    private _toolbarSettings;
+    private _fetchChildren;
+    private _hasChildren;
     private lastTreeListCellClick;
     private direction;
     private rtl;
@@ -467,11 +528,27 @@ export declare class GanttComponent implements AfterContentInit, OnChanges, OnDe
     private optionChangesSubscriptions;
     private editServiceSubscription;
     private localizationSubscription;
-    constructor(timelineViewService: TimelineViewService, scrollSyncService: ScrollSyncService, renderer: Renderer2, mapper: MappingService, optionChangesService: OptionChangesService, dependencyDomService: DependencyDomService, editService: EditService, localizationService: LocalizationService, hostElement: ElementRef<HTMLElement>, zone: NgZone);
+    constructor(timelineViewService: TimelineViewService, scrollSyncService: ScrollSyncService, renderer: Renderer2, mapper: MappingService, optionChangesService: OptionChangesService, dependencyDomService: DependencyDomService, editService: EditService, localizationService: LocalizationService, hostElement: ElementRef<HTMLElement>, zone: NgZone, navigationService: NavigationService);
     ngOnChanges(changes: SimpleChanges): void;
     ngAfterViewInit(): void;
     ngAfterContentInit(): void;
     ngOnDestroy(): void;
+    /**
+     * Focuses the last active cell or task in the Gantt.
+     * If no item has previously been focused, the first cell of the TreeList part will receive focus,
+     * ([see example]({% slug keyboard_navigation_gantt %}#toc-controlling-the-focus)).
+     */
+    focus(): void;
+    /**
+     * Focuses the targeted cell in the TreeList part of the component,
+     * ([see example]({% slug keyboard_navigation_gantt %}#toc-controlling-the-focus)).
+     */
+    focusCell(rowIndex: number, colIndex: number): void;
+    /**
+     * Focuses the targeted task in the Timeline part of the component,
+     * ([see example]({% slug keyboard_navigation_gantt %}#toc-controlling-the-focus)).
+     */
+    focusTask(taskIndex: number): void;
     /**
      * Applies the minimum possible width for the specified column,
      * so that the whole text fits without wrapping. This method expects the Gantt
@@ -521,6 +598,10 @@ export declare class GanttComponent implements AfterContentInit, OnChanges, OnDe
      * Opens the delete task confirmation dialog.
      */
     openConfirmationDialog(): void;
+    /**
+     * @hidden
+     */
+    handleConfirmationDialogClose(): void;
     /**
      * Opens a cell for editing.
      */
@@ -593,14 +674,36 @@ export declare class GanttComponent implements AfterContentInit, OnChanges, OnDe
      * @hidden
      */
     getText(token: string): string;
-    private emitTaskClick;
-    private emitSelectionChange;
+    /**
+     * @hidden
+     */
+    changeActiveView(view: TimelineViewType): void;
+    /**
+     * @hidden
+     */
+    notifyTaskClick(event: PointerEvent | KeyboardEvent, dataItem: any, itemIndex: number): void;
+    /**
+     * @hidden
+     */
+    notifySelectionChange(dataItem: any, action: 'select' | 'remove'): void;
+    /**
+     * @hidden
+     */
+    notifyTaskDelete(task: any): void;
+    /**
+     * @hidden
+     */
+    isSameSelection(action: 'select' | 'remove', dataItem: any): boolean;
+    /**
+     * @hidden
+     */
+    getSelectionAction({ ctrlKey, metaKey }: PointerEvent | KeyboardEvent, dataItem: any): 'select' | 'remove';
     private updateTreeListGroupClass;
     /**
      * Used to hide the vertical scrollbar
      */
     private updateTreeListMargin;
     private getActiveViewOptions;
-    private isSameSelection;
-    private getSelectionAction;
+    private getFirstSelectedItem;
+    private defaultValidateNewDependencyCallback;
 }