@progress/kendo-angular-gantt 19.1.2-develop.3 → 19.1.2-develop.5

package/esm2022/gantt.component.mjs

@@ -67,75 +67,58 @@ const DEFAULT_DRAG_SCROLL_SETTINGS = {
     threshold: 10
 };
 /**
- * Represents the Kendo UI Gantt component for Angular.
+ * Represents the [Kendo UI Gantt component for Angular](slug:overview_gantt).
+ *
+ * Use the Gantt component to display and manage project tasks and dependencies in a timeline view.
  *
  * @example
- * ```ts-preview
- * _@Component({
- *    selector: 'my-app',
- *    template: `
- *        <kendo-gantt
- *            [style.height.px]="500"
- *            [kendoGanttHierarchyBinding]="data"
- *            childrenField="subtasks"
- *            [dependencies]="dependencies">
- *            <kendo-gantt-column
- *                field="title"
- *                title="Task"
- *                [width]="200"
- *                [expandable]="true"></kendo-gantt-column>
- *            <kendo-gantt-column
- *                field="start"
- *                title="Start"
- *                format="dd-MMM-yyyy"
- *                [width]="120"></kendo-gantt-column>
- *            <kendo-gantt-column
- *                field="end"
- *                title="End"
- *                format="dd-MMM-yyyy"
- *                [width]="120"></kendo-gantt-column>
- *            <kendo-gantt-timeline-day-view></kendo-gantt-timeline-day-view>
- *            <kendo-gantt-timeline-week-view></kendo-gantt-timeline-week-view>
- *            <kendo-gantt-timeline-month-view></kendo-gantt-timeline-month-view>
- *        </kendo-gantt>
- *    `
- * })
- * class AppComponent {
- *     public data: Task[] = [{
- *         id: 7, title: 'Validation and R&D', start: new Date('2014-06-02T00:00:00.000Z'),
- *         end: new Date('2014-06-19T00:00:00.000Z'), completionRatio: 0.45708333333333334,
- *         subtasks: [
- *             { id: 18, title: 'Project Kickoff', start: new Date('2014-06-02T00:00:00.000Z'),
- *                 end: new Date('2014-06-02T00:00:00.000Z'), completionRatio: 0.23 },
- *             { id: 11, title: 'Research', start: new Date('2014-06-02T00:00:00.000Z'),
- *                 end: new Date('2014-06-07T00:00:00.000Z'), completionRatio: 0.5766666666666667,
- *                 subtasks: [
- *                     { id: 19, title: 'Validation', start: new Date('2014-06-02T00:00:00.000Z'),
- *                         end: new Date('2014-06-04T00:00:00.000Z'), completionRatio: 0.25 },
- *                     { id: 39, title: 'Specification', start: new Date('2014-06-04T00:00:00.000Z'),
- *                         end: new Date('2014-06-07T00:00:00.000Z'), completionRatio: 0.66 }]
- *             }, { id: 13, title: 'Implementation', start: new Date('2014-06-08T00:00:00.000Z'),
- *                 end: new Date('2014-06-19T00:00:00.000Z'), completionRatio: 0.77,
- *                 subtasks: [
- *                     { id: 24, title: 'Prototype', start: new Date('2014-06-08T00:00:00.000Z'),
- *                         end: new Date('2014-06-14T00:00:00.000Z'), completionRatio: 0.77 },
- *                     { id: 29, title: 'UI and Interaction', start: new Date('2014-06-14T00:00:00.000Z'),
- *                         end: new Date('2014-06-19T00:00:00.000Z'), completionRatio: 0.6 }]
- *             }, { id: 17, title: 'Release', start: new Date('2014-06-19T00:00:00.000Z'),
- *                 end: new Date('2014-06-19T00:00:00.000Z'), completionRatio: 0 }]
- *     }];
+ * ```ts
+ * import { Component } from '@angular/core';
+ * import { GanttComponent, DependencyType } from '@progress/kendo-angular-gantt';
  *
- *     public dependencies: GanttDependency[] = [
- *         { id: 528, fromId: 18, toId: 19, type: DependencyType.FS },
- *         { id: 529, fromId: 19, toId: 39, type: DependencyType.FS },
- *         { id: 535, fromId: 24, toId: 29, type: DependencyType.FS },
- *         { id: 551, fromId: 13, toId: 29, type: DependencyType.FF },
- *         { id: 777, fromId: 7, toId: 11, type: DependencyType.SF },
- *         { id: 556, fromId: 39, toId: 24, type: DependencyType.FS },
- *         { id: 546, fromId: 29, toId: 17, type: DependencyType.FS },
- *     ];
+ * @Component({
+ *   selector: 'my-app',
+ *   template: `
+ *     <kendo-gantt
+ *       [style.height.px]="500"
+ *       [kendoGanttHierarchyBinding]="data"
+ *       childrenField="subtasks"
+ *       [dependencies]="dependencies">
+ *       <kendo-gantt-column field="title" title="Task" [width]="200" [expandable]="true"></kendo-gantt-column>
+ *       <kendo-gantt-column field="start" title="Start" format="dd-MMM-yyyy" [width]="120"></kendo-gantt-column>
+ *       <kendo-gantt-column field="end" title="End" format="dd-MMM-yyyy" [width]="120"></kendo-gantt-column>
+ *       <kendo-gantt-timeline-day-view></kendo-gantt-timeline-day-view>
+ *       <kendo-gantt-timeline-week-view></kendo-gantt-timeline-week-view>
+ *       <kendo-gantt-timeline-month-view></kendo-gantt-timeline-month-view>
+ *     </kendo-gantt>
+ *   `
+ * })
+ * export class AppComponent {
+ *   public data: Task[] = [
+ *     {
+ *       id: 1,
+ *       title: 'Planning',
+ *       start: new Date('2024-01-01'),
+ *       end: new Date('2024-01-05'),
+ *       subtasks: []
+ *     }
+ *   ];
+ *   public dependencies = [
+ *     { id: 1, fromId: 1, toId: 2, type: DependencyType.FS }
+ *   ];
  * }
  * ```
+ *
+ * @remarks
+ * Supported children components are:
+ * {@link GanttColumnComponent},
+ * {@link GanttSpanColumnComponent},
+ * {@link GanttColumnGroupComponent},
+ * {@link TimelineDayViewComponent},
+ * {@link TimelineWeekViewComponent},
+ * {@link TimelineMonthViewComponent},
+ * {@link TimelineYearViewComponent},
+ * {@link CustomMessagesComponent}.
  */
 export class GanttComponent {
     timelineViewService;
@@ -225,18 +208,16 @@ export class GanttComponent {
         return this._columns;
     }
     /**
-     * Sets the fields which will be used to extract the task data from the provided `data` array items.
-     * The `id` field is also used as a TreeList data item unique identifier (defaults to `'id'`).
-     *
-     * > If no object is provided, the Gantt task data items will have to conform to the [`GanttTask`]({% slug api_gantt_gantttask %}) interface.
+     * Sets the fields used to extract task data from the `data` array items.
+     * The `id` field is also used as a unique identifier for TreeList data items.
+     * If not set, task data items must match the [`GanttTask`](slug:api_gantt_gantttask) interface.
      */
     set taskModelFields(fields) {
         this.mapper.taskFields = fields;
     }
     /**
-     * Sets the fields which will be used to extract the dependency data from the provided `dependencies` array items.
-     *
-     * > If no object is provided, the Gantt dependency data items will have to conform to the [`GanttDependency`]({% slug api_gantt_ganttdependency %}) interface.
+     * Sets the fields used to extract dependency data from the `dependencies` array items.
+     * If not set, dependency data items must match the [`GanttDependency`](slug:api_gantt_ganttdependency) interface.
      */
     set dependencyModelFields(fields) {
         this.mapper.dependencyFields = fields;
@@ -246,7 +227,7 @@ export class GanttComponent {
      */
     views;
     /**
-     * The active timeline view.
+     * Sets the active timeline view.
      * @default 'week'
      */
     set activeView(view) {
@@ -275,9 +256,8 @@ export class GanttComponent {
         return activeViewCurrentTimeMarker || this.currentTimeMarker;
     }
     /**
-     * Gets or sets the data of the Gantt.
-     *
-     * > The task data items should either conform to the [`GanttTask`]({% slug api_gantt_gantttask %}) interface, or a [`taskModelFields`]({% slug api_gantt_ganttcomponent %}#toc-taskmodelfields) object has to be provided.
+     * Gets or sets the Gantt data.
+     * The task data items must match the [`GanttTask`]({% slug api_gantt_gantttask %}) interface or use [`taskModelFields`]({% slug api_gantt_ganttcomponent %}#toc-taskmodelfields).
      */
     set data(data) {
         this._data = normalizeGanttData(data);
@@ -287,49 +267,31 @@ export class GanttComponent {
         return this._data;
     }
     /**
-     * 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.
+     * Specifies a callback to determine if a task is selected ([see example]({% slug selection_gantt %}#toc-custom-selection)).
+     * Set [`selectable`]({% slug api_gantt_ganttcomponent %}#toc-selectable) to `true` to use this callback.
      */
     isSelected = isSelected;
     /**
-     * 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.
+     * Specifies a callback to validate new dependencies.
+     * Use this callback to control the valid dependencies that users can create ([see example]({% slug editing_drag_create_dependencies_gantt %}#toc-validation)).
      */
     validateNewDependency = this.defaultValidateNewDependencyCallback.bind(this);
     /**
-     * Fires when the Gantt selection is changed through user interaction.
-     *
-     * Holds data about the affected [`items`]({% slug api_gantt_selectionchangeevent %}#toc-items) and the attempted [`action`]({% slug api_gantt_selectionchangeevent %}#toc-action):
-     * - `select` - Triggered on `click` or `ctrl + click` on deselected items.
-     * - `remove` - Triggered on `ctrl + click` on selected items.
+     * Fires when the Gantt selection changes through user interaction.
+     * The event data contains the affected items and the action type.
      */
     selectionChange = new EventEmitter();
     /**
-     * Enables or disables the Gantt selection mechanism ([see example]({% slug selection_gantt %}#toc-custom-selection)).
-     *
+     * Enables or disables selection in the Gantt ([see example]({% slug selection_gantt %}#toc-custom-selection)).
+     * Set to `true` to allow selection.
      * > When set to `true`, the [`isSelected`]({% slug api_gantt_ganttcomponent %}#toc-isselected) callback has to be provided.
      * > When applied, the [`SelectableDirective`]({% slug api_gantt_selectabledirective %}) sets `selectable` to `true` internally.
+     * @default false
      */
     selectable = false;
     /**
-     * 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 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. 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`.
+     * Configures the toolbar position and content.
+     * Set `position`, `addTaskTool`, and `viewSelectorTool` as needed.
      */
     set toolbarSettings(value) {
         this._toolbarSettings = {
@@ -342,12 +304,13 @@ export class GanttComponent {
         return this._toolbarSettings;
     }
     /**
-     * Allows setting the toolbar(s) `aria-label` attribute value as necessary to comply with accessibility requirements.
-     * Typically, toolbars need an `aria-label` when there is more than one toolbar in the application.
+     * Sets the `aria-label` attribute value for the toolbar.
+     * Use this to improve accessibility.
+     * @default "Toolbar"
      */
     toolbarAriaLabel = 'Toolbar';
     /**
-     * Gets or sets the callback function that retrieves the child items for a particular item.
+     * Sets the callback function to retrieve child items for a data item.
      */
     set fetchChildren(fn) {
         this._fetchChildren = fn;
@@ -357,7 +320,7 @@ export class GanttComponent {
         return this._fetchChildren;
     }
     /**
-     * Gets or sets the callback function that indicates if a particular item has child items.
+     * Sets the callback function to indicate if a data item has child items.
      */
     set hasChildren(fn) {
         this._hasChildren = fn;
@@ -367,58 +330,56 @@ export class GanttComponent {
         return this._hasChildren;
     }
     /**
-     * Defines the dependencies that will be drawn between the rendered tasks.
-     *
-     * > The dependency data items should either conform to the [`GanttDependency`]({% slug api_gantt_ganttdependency %}) interface, or a [`dependencyModelFields`]({% slug api_gantt_ganttcomponent %}#toc-dependencymodelfields) object has to be provided.
+     * Sets the dependencies to display between tasks.
+     * Dependency data items must match the [`GanttDependency`]({% slug api_gantt_ganttdependency %}) interface or use [`dependencyModelFields`]({% slug api_gantt_ganttcomponent %}#toc-dependencymodelfields).
      */
     dependencies = [];
     /**
-     * Enables the sorting of the Gantt columns that have their `field` option set.
+     * Enables sorting for columns with a `field` option.
      */
     sortable = false;
     /**
-     * The descriptors by which the data will be sorted.
+     * Sets the descriptors for sorting the data.
      */
     sort = [];
     /**
-     * Enables the filtering of the Gantt columns that have their `field` option set.
-     *
+     * Enables filtering for columns with a `field` option.
      * @default false
      */
     filterable = false;
     /**
-     * The descriptor by which the data will be filtered.
+     * Sets the descriptor for filtering the data.
      */
     filter;
     /**
-     * The start time of the work day.
-     * Accepts string values in the `HH:mm` format.
+     * Sets the start time of the work day in `HH:mm` format.
+     * @default "08:00"
      */
     workDayStart = '08:00';
     /**
-     * The end time of the work day.
-     * Accepts string values in the `HH:mm` format.
+     * Sets the end time of the work day in `HH:mm` format.
+     * @default "17:00"
      */
     workDayEnd = '17:00';
     /**
-     * The start of the work week (index based).
+     * Sets the start day of the work week (index based).
+     * @default 1
      */
     workWeekStart = 1;
     /**
-     * The end of the work week (index based).
+     * Sets the end day of the work week (index based).
+     * @default 5
      */
     workWeekEnd = 5;
     /**
-     * When `true`, the user can use dedicated shortcuts to interact with the Gantt.
-     * By default, navigation is enabled for the TreeList and Timeline parts of the component,
-     * ([see example]({% slug keyboard_navigation_gantt %})).
-     *
+     * Enables keyboard navigation for the Gantt.
+     * By default, navigation is enabled for the TreeList and Timeline parts of the component ([see example]({% slug keyboard_navigation_gantt %})).
      * @default true
      */
     navigable = true;
     /**
-     * The options of the timeline splitter pane. By default the pane is `collapsible`,
-     * `resizable`, not `collapsed`, and its `size` is `'50%'`.
+     * Sets the options for the timeline splitter pane.
+     * By default, the pane is collapsible, resizable, not collapsed, and its size is `'50%'`.
      */
     set timelinePaneOptions(value) {
         if (this._timelinePaneOptions.collapsed && !value.collapsed) {
@@ -430,8 +391,8 @@ export class GanttComponent {
         return { ...this._timelinePaneOptions, size: this.treeListPaneOptions.collapsed ? '100%' : this._timelinePaneOptions.size };
     }
     /**
-     * The options of the treelist splitter pane.
-     * By default the pane is `collapsible` and not `collapsed`.
+     * Sets the options for the treelist splitter pane.
+     * By default the pane is collapsible and not collapsed.
      */
     set treeListPaneOptions(value) {
         this._treeListPaneOptions = { ...DEFAULT_TREELIST_PANE_SETTINGS, ...value };
@@ -440,8 +401,8 @@ export class GanttComponent {
         return this._treeListPaneOptions;
     }
     /**
-     * Defines a function that is executed for every task in the component.
-     * The classes returned from the function are applied to the task wrapper element.
+     * Sets a function to apply custom CSS classes to each task.
+     * The function receives the task data item.
      */
     set taskClass(fn) {
         if (isDevMode() && typeof fn !== 'function') {
@@ -453,7 +414,8 @@ export class GanttComponent {
         return this._taskClass;
     }
     /**
-     * Defines a function that is executed for every data row in the component.
+     * Sets a function to apply custom CSS classes to each data row.
+     * The function receives the row data item.
      */
     set rowClass(fn) {
         if (isDevMode() && typeof fn !== 'function') {
@@ -465,54 +427,45 @@ export class GanttComponent {
         return this._rowClass;
     }
     /**
-     * The name of the field which contains the unique identifier of the task data item.
-     * Defaults to 'id'.
+     * Gets the name of the field that contains the unique identifier for task data items.
+     * @default "id"
      */
     get taskIdField() {
         return this.mapper.taskFields.id;
     }
     /**
-     * Sets the callback function that indicates if a particular item is expanded.
-     * If no callback is set, all items will be expanded and no expand icons will be rendered.
+     * Sets a callback function to indicate if a data item is expanded.
+     * If not set, all items are expanded and no expand icons are shown.
      */
     isExpanded;
     /**
-     * Indicates whether the Gantt columns will be resized during initialization so that they fit their headers and row content.
-     * Columns with autoSize set to false are excluded.
-     *
+     * Enables automatic resizing of columns to fit their content.
      * @default false
      */
     columnsAutoSize = false;
     /**
-     * Specifies the Gantt current time marker settings.
-     * The settings will be applied for all views.
-     * If the `currentTimeMarker` is set for a view then it takes precedence.
-     *
+     * Sets the current time marker settings for the Gantt.
+     * Applies to all views unless overridden by the settings of a particular view.
      * @default true
      */
     currentTimeMarker = true;
     /**
-     * Specifies if the column menu of the columns will be displayed.
-     *
+     * Enables the column menu for all columns.
      * @default false
      */
     columnMenu = false;
     /**
-     * If set to true, the user can reorder columns by dragging their header cells.
-     *
+     * Enables reordering of the columns by dragging their header cells.
      * @default false
      */
     columnsReorderable = false;
     /**
-     * If set to true, the user can resize columns by dragging the edges (resize handles) of their header cells.
-     *
+     * Enables resizing of the columns by dragging the header cell edges (resize handles).
      * @default false
      */
     columnsResizable = false;
     /**
-     * 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).
+     * Defines the settings for auto-scrolling during dragging when the pointer moves outside the container ([see example](slug:editing_drag_create_dependencies_gantt#auto-scrolling)).
      */
     set dragScrollSettings(settings) {
         this._dragScrollSettings = { ...DEFAULT_DRAG_SCROLL_SETTINGS, ...settings };
@@ -521,8 +474,7 @@ export class GanttComponent {
         return this._dragScrollSettings;
     }
     /**
-     * Allows setting the task tooltip `position`, `callout`, and `showAfter` options.
-     *
+     * Sets the options for the task tooltip, such as `position`, `callout`, and `showAfter`.
      * @default { position: 'top', callout: true, showAfter: 100 }
      */
     taskTooltipOptions = {
@@ -531,30 +483,30 @@ export class GanttComponent {
         showAfter: 100
     };
     /**
-     * Fires when an item is expanded.
+     * Fires when a row is expanded.
      */
     rowExpand = new EventEmitter();
     /**
-     * Fires when a Gantt task in the timeline pane is double-clicked. The data item, associated with the clicked task,
-     * is available in the event data. Use the event handler to open a task editing dialog as necessary.
+     * Fires when a Gantt task in the timeline pane is double-clicked.
+     * The event data contains the clicked task. Use this event to open a task editing dialog if needed.
      */
     taskDblClick = new EventEmitter();
     /**
-     * Fires when the user double clicks a cell.
+     * Fires when a cell is double-clicked.
      */
     cellDblClick = new EventEmitter();
     /**
-     * Fires when the user leaves an edited cell.
+     * Fires when an edited cell is closed.
      */
     cellClose = new EventEmitter();
     /**
-     * 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.
+     * Fires when the user clicks the `Delete` button in the task editing dialog,
+     * the task delete icon, or presses the `Delete` key on a focused task.
+     * Use this event to open a confirmation dialog if needed.
      */
     taskDelete = new EventEmitter();
     /**
-     * Fires when an item is collapsed.
+     * Fires when a row is collapsed.
      */
     rowCollapse = new EventEmitter();
     /**
@@ -574,50 +526,50 @@ export class GanttComponent {
      */
     taskAdd = new EventEmitter();
     /**
-     * Fires when the user adds a dependency via dragging
-     * [see example]({% slug editing_drag_create_dependencies_gantt %}#toc-basic-concepts).
+     * Fires when the user adds a dependency by dragging [see example]({% slug editing_drag_create_dependencies_gantt %}#toc-basic-concepts).
      */
     dependencyAdd = new EventEmitter();
     /**
-     * Fires when the sorting of the Gantt is changed.
-     * You have to handle the event yourself and sort the data.
+     * Fires when there are changes in the Gantt sorting.
+     * Handle this event to sort the data.
      */
     sortChange = new EventEmitter();
     /**
-     * Fires when the Gantt filter is modified.
-     * You have to handle the event yourself and filter the data.
+     * Fires when there are changes in the Gantt filtering.
+     * Handle this event to filter the data.
      */
     filterChange = new EventEmitter();
     /**
-     * Fires when the filter or sort state of the Gantt is changed.
+     * Fires when the filter or sort state changes.
      */
     dataStateChange = new EventEmitter();
     /**
-     * Fires when the collapsed state of the treelist pane is changed.
+     * Fires when the collapsed state of the treelist pane changes.
      */
     treeListPaneCollapsedChange = new EventEmitter();
     /**
-     * Fires when the collapsed state of the timeline pane is changed.
+     * Fires when the collapsed state of the timeline pane changes.
      */
     timelinePaneCollapsedChange = new EventEmitter();
     /**
-     * Fires each time the user resizes the timeline pane.
+     * Fires when the user resizes the timeline pane.
      */
     timelinePaneSizeChange = new EventEmitter();
     /**
-     * Fires each time the user selects a different view type. The event data contains the type of the newly selected view.
+     * Fires when the user selects a different view type.
+     * The event data contains the type of the new view.
      */
     activeViewChange = new EventEmitter();
     /**
-     * Fires when the user completes the resizing of the column.
+     * Fires when the user completes resizing a column.
      */
     columnResize = new EventEmitter();
     /**
-     * Fires when the user completes the reordering of the column.
+     * Fires when the user completes reordering a column.
      */
     columnReorder = new EventEmitter();
     /**
-     * Fires when the user changes the visibility of the columns from the column menu or column chooser.
+     * Fires when the user changes column visibility from the column menu or chooser.
      */
     columnVisibilityChange = new EventEmitter();
     /**
@@ -877,8 +829,7 @@ export class GanttComponent {
     }
     /**
      * 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)).
+     * If no item was previously focused, focuses the first TreeList cell ([see example]({% slug keyboard_navigation_gantt %}#toc-controlling-the-focus)).
      */
     focus() {
         if (this.navigable) {
@@ -886,8 +837,9 @@ export class GanttComponent {
         }
     }
     /**
-     * Focuses the targeted cell in the TreeList part of the component,
-     * ([see example]({% slug keyboard_navigation_gantt %}#toc-controlling-the-focus)).
+     * Focuses the specified cell in the TreeList ([see example]({% slug keyboard_navigation_gantt %}#toc-controlling-the-focus)).
+     * @param rowIndex The row index.
+     * @param colIndex The column index.
      */
     focusCell(rowIndex, colIndex) {
         if (this.navigable) {
@@ -895,8 +847,8 @@ export class GanttComponent {
         }
     }
     /**
-     * Focuses the targeted task in the Timeline part of the component,
-     * ([see example]({% slug keyboard_navigation_gantt %}#toc-controlling-the-focus)).
+     * Focuses the specified task in the Timeline ([see example]({% slug keyboard_navigation_gantt %}#toc-controlling-the-focus)).
+     * @param taskIndex The index of the task.
      */
     focusTask(taskIndex) {
         if (this.navigable) {
@@ -904,10 +856,9 @@ export class GanttComponent {
         }
     }
     /**
-     * Applies the minimum possible width for the specified column,
-     * so that the whole text fits without wrapping. This method expects the Gantt
-     * to be resizable (set `resizable` to `true`).
-     * Makes sense to execute this method only after the Gantt is already populated with data.
+     * Sets the minimum width for the specified column so that its content fits.
+     * The Gantt must be resizable.
+     * @param column The column to auto-fit.
      */
     autoFitColumn(column) {
         if (isPresent(this.treeList)) {
@@ -915,10 +866,10 @@ export class GanttComponent {
         }
     }
     /**
-     * Adjusts the width of the specified columns to fit the entire content, including headers, without wrapping.
-     * If no columns are specified, `autoFitColumns` is applied to all columns.
-     *
-     * This method requires the Gantt to be resizable (set `resizable` to `true`).
+     * Adjusts the width of the specified columns to fit their content.
+     * If no columns are specified, fits all columns.
+     * The Gantt must be resizable to use this method.
+     * @param columns The columns to auto-fit.
      */
     autoFitColumns(columns = this.columns) {
         if (isPresent(this.treeList)) {
@@ -926,7 +877,9 @@ export class GanttComponent {
         }
     }
     /**
-     * Clears the already loaded children for the dataItem so that the Gantt will fetch them again the next time it is rendered.
+     * Clears loaded children for the data item so the Gantt fetches them again.
+     * @param dataItem The data item to reload.
+     * @param reloadChildren Whether to reload children.
      */
     reload(dataItem, reloadChildren) {
         if (isPresent(this.treeList)) {
@@ -935,14 +888,10 @@ export class GanttComponent {
     }
     /**
      * Changes the position of the specified column.
-     * The reordering of columns operates only on the level
-     * which is inferred by the source column.
-     * For the `reorderColumn` method to work properly,
-     * the `source` column has to be visible.
-     *
-     * @param {ColumnBase} source - The column whose position will be changed.
-     * @param {number} destIndex - The new position of the column.
-     * @param {ColumnReorderConfig} options - Additional options.
+     * The source column must be visible.
+     * @param source The column to move.
+     * @param destIndex The new position index.
+     * @param options Additional options.
      */
     reorderColumn(source, destIndex, options = { before: false }) {
         if (isPresent(this.treeList)) {
@@ -950,10 +899,8 @@ export class GanttComponent {
         }
     }
     /**
-     * Forces the TreeList to evaluate if some data items have changed and re-renders the rows information, if needed.
-     * Recalculates and re-renders the Timeline period, if needed.
-     * Redraws changed dependencies, if needed.
-     * Executes all row-related callbacks anew.
+     * Forces the Gantt to re-evaluate data items and re-render the rows and Timeline period, if needed.
+     * Also redraws dependencies and executes row-related callbacks.
      */
     updateView() {
         if (isPresent(this.treeList)) {
@@ -963,7 +910,9 @@ export class GanttComponent {
         this.dependencyDomService.notifyChanges();
     }
     /**
-     * Opens the task editing dialog.
+     * Opens the task editing dialog for the specified data item.
+     * @param dataItem The task data item.
+     * @param formGroup The form group for editing.
      */
     editTask(dataItem, formGroup) {
         if (!this.showEditingDialog) {
@@ -998,12 +947,15 @@ export class GanttComponent {
     }
     /**
      * Opens a cell for editing.
+     * @param dataItem The data item.
+     * @param column The column index, name, or object.
+     * @param formGroup The form group for editing.
      */
     editCell(dataItem, column, formGroup) {
         this.treeList.editCell(dataItem, column, formGroup);
     }
     /**
-     * Closes an edited cell.
+     * Closes the currently edited cell.
      */
     closeCell() {
         this.treeList.closeCell();
@@ -1659,10 +1611,10 @@ export class GanttComponent {
 
             i18n-columnsReset="kendo.gantt.columnsReset|The text shown in the column menu or column chooser for the columns reset button"
             columnsReset="Reset"
-            
+
             i18n-tooltipStartDateText="kendo.gantt.tooltipStartDateText|The text shown in the task tooltip before the task start date"
             tooltipStartDateText="Start"
-            
+
             i18n-tooltipEndDateText="kendo.gantt.tooltipEndDateText|The text shown in the task tooltip before the task end date"
             tooltipEndDateText="End"></ng-container>
         <kendo-gantt-toolbar
@@ -2075,10 +2027,10 @@ i0.ɵɵngDeclareClassMetadata({ minVersion: "12.0.0", version: "16.2.12", ngImpo
 
             i18n-columnsReset="kendo.gantt.columnsReset|The text shown in the column menu or column chooser for the columns reset button"
             columnsReset="Reset"
-            
+
             i18n-tooltipStartDateText="kendo.gantt.tooltipStartDateText|The text shown in the task tooltip before the task start date"
             tooltipStartDateText="Start"
-            
+
             i18n-tooltipEndDateText="kendo.gantt.tooltipEndDateText|The text shown in the task tooltip before the task end date"
             tooltipEndDateText="End"></ng-container>
         <kendo-gantt-toolbar