@progress/kendo-angular-gantt 19.1.2-develop.4 → 19.1.2-develop.6

package/gantt.module.d.ts

@@ -33,34 +33,23 @@ import * as i27 from "./editing/add-task.component";
 import * as i28 from "./dragging/task-drag.directive";
 import * as i29 from "./template-directives/task-tooltip-template.directive";
 /**
- * Represents the [NgModule](link:site.data.urls.angular['ngmoduleapi'])
- * definition for the Gantt component.
+ * Represents the [`NgModule`](link:site.data.urls.angular['ngmoduleapi']) definition for the Gantt component.
  *
- * @example
+ * Use this module to include the Gantt component in your NgModule-based application.
  *
- * ```ts-no-run
- * // Import the Gantt module
+ * @example
+ * ```typescript
  * import { GanttModule } from '@progress/kendo-angular-gantt';
- *
- * // The browser platform with a compiler
- * import { platformBrowserDynamic } from '@angular/platform-browser-dynamic';
- *
  * import { NgModule } from '@angular/core';
- *
- * // Import the app component
+ * import { BrowserModule } from '@angular/platform-browser';
  * import { AppComponent } from './app.component';
  *
- * // Define the app module
- * _@NgModule({
- *     declarations: [AppComponent], // declare app component
- *     imports:      [BrowserModule, GanttModule], // import Gantt module
- *     bootstrap:    [AppComponent]
+ * @NgModule({
+ *   declarations: [AppComponent],
+ *   imports: [BrowserModule, GanttModule],
+ *   bootstrap: [AppComponent]
  * })
  * export class AppModule {}
- *
- * // Compile and launch the module
- * platformBrowserDynamic().bootstrapModule(AppModule);
- *
  * ```
  */
 export declare class GanttModule {

package/localization/custom-messages.component.d.ts

@@ -6,8 +6,16 @@ import { LocalizationService } from '@progress/kendo-angular-l10n';
 import { Messages } from './messages';
 import * as i0 from "@angular/core";
 /**
- * Custom component messages override default component messages
- * ([see example](slug:globalization_treelist#toc-custom-messages)).
+ * Represents the custom messages component for the Kendo UI for Angular Gantt.
+ * Use this component to override default messages.
+ *
+ * @example
+ * ```html
+ * <kendo-gantt-messages
+ *   addTaskText="Add Task"
+ *   cancelButtonText="Cancel">
+ * </kendo-gantt-messages>
+ * ```
  */
 export declare class CustomMessagesComponent extends Messages {
     protected service: LocalizationService;

package/models/cell-content-type.interface.d.ts

@@ -3,8 +3,9 @@
 * Licensed under commercial license. See LICENSE.md in the project root for more information
 *-------------------------------------------------------------------------------------------*/
 /**
- * Specifies the cell content type.
- * Used to define which filter component will be rendered for the targeted column,
- * or which built-in editor, when the row is in edit mode.
+ * Defines the cell content type.
+ * Use this type to specify which filter component appears for a column,
+ * or which built-in editor displays when a row enters edit mode.
+ *
  */
 export type CellContentType = 'text' | 'numeric' | 'boolean' | 'date';

package/models/class-callbacks.d.ts

@@ -3,17 +3,17 @@
 * Licensed under commercial license. See LICENSE.md in the project root for more information
 *-------------------------------------------------------------------------------------------*/
 /**
- * Represents the callback that is used by the
- * [rowClass]({% slug api_gantt_ganttcomponent %}#toc-rowclass) property.
+ * Represents the callback that is used by the [`rowClass`]({% slug api_gantt_ganttcomponent %}#toc-rowclass) property.
  *
- * ```ts-no-run
- *  public rowCallback({ dataItem, index }: any): any {
- *    const isEven = index % 2 == 0;
- *    return {
- *      even: isEven,
- *      odd: !isEven
- *    };
- *  }
+ * @example
+ * ```typescript
+ * public rowCallback({ dataItem, index }: any): any {
+ *   const isEven = index % 2 == 0;
+ *   return {
+ *     even: isEven,
+ *     odd: !isEven
+ *   };
+ * }
  * ```
  *
  */
@@ -24,17 +24,17 @@ export type RowClassFn = (args: {
     [key: string]: any;
 };
 /**
- * Represents the callback that is used by the
- * [taskClass]({% slug api_gantt_ganttcomponent %}#toc-taskclass) property.
+ * Represents the callback that is used by the [`taskClass`]({% slug api_gantt_ganttcomponent %}#toc-taskclass) property.
  *
- * ```ts-no-run
- *  public taskCallback(dataItem: any): any {
- *    const moreThanHalfCompleted = dataItem.completionRatio > 0.5;
- *    return {
- *      'more-than-half': moreThanHalfCompleted,
- *      'less-than-half': !moreThanHalfCompleted
- *    };
- *  }
+ * @example
+ * ```typescript
+ * public taskCallback(dataItem: any): any {
+ *   const moreThanHalfCompleted = dataItem.completionRatio > 0.5;
+ *   return {
+ *     'more-than-half': moreThanHalfCompleted,
+ *     'less-than-half': !moreThanHalfCompleted
+ *   };
+ * }
  * ```
  *
  */

package/models/column-menu-settings.interface.d.ts

@@ -4,23 +4,22 @@
 *-------------------------------------------------------------------------------------------*/
 import { ExpandableColumnMenuItem } from "@progress/kendo-angular-treelist";
 /**
- * The settings of the column menu in the Gantt component.
+ * Configures the column menu settings in the Gantt component.
  */
 export interface ColumnMenuSettings {
     /**
-     * Specifies if the columns can be sorted in the column menu.
-     * If [sorting]({% slug api_gantt_ganttcomponent %}#toc-sortable) is enabled, defaults to `true`.
-     * @default true
+     * Lets you sort columns in the column menu.
+     * If you enable [sorting]({% slug api_gantt_ganttcomponent %}#toc-sortable), this option defaults to `true`.
      */
     sort?: boolean;
     /**
-     * Specifies if the columns can be filtered in the column menu.
-     * If [filtering]({% slug api_gantt_ganttcomponent %}#toc-filterable) is enabled, defaults to `true`.
-     * @default true
+     * Enables filtering columns in the column menu.
+     * If you enable [filtering]({% slug api_gantt_ganttcomponent %}#toc-filterable), this option defaults to `true`.
+     * Enables sorting columns in the column menu.
      */
     filter?: boolean | ExpandableColumnMenuItem;
     /**
-     * Specifies if the item for column selection will be displayed in the column menu.
+     * Shows the column selection item in the column menu.
      * @default true
      */
     columnChooser?: boolean | ExpandableColumnMenuItem;

package/models/column-reorder-config.d.ts

@@ -4,7 +4,10 @@
 *-------------------------------------------------------------------------------------------*/
 import { ColumnReorderConfig as TreeListColumnReorderConfig } from '@progress/kendo-angular-treelist';
 /**
- * Additional configuration for the `reorderColumn` method.
+ * Extends the configuration for the `reorderColumn` method.
+ *
+ * Use this interface to provide additional options when you reorder columns.
+ *
  */
 export interface ColumnReorderConfig extends TreeListColumnReorderConfig {
 }

package/models/current-time-settings.interface.d.ts

@@ -3,17 +3,20 @@
 * Licensed under commercial license. See LICENSE.md in the project root for more information
 *-------------------------------------------------------------------------------------------*/
 /**
- * The settings for the current time marker.
+ * Represents the settings for the current time marker in the Gantt component.
+ *
  */
 export interface CurrentTimeSettings {
     /**
-     * The update interval (in milliseconds) of the current time marker.
-     * Defaults to `60000` (a minute).
+     * Sets the update interval in milliseconds for the current time marker.
+     * Use this property to control how often the marker updates.
+     * @default 60000
      */
     updateInterval?: number;
     /**
-     * Specifies if the current time marker will be displayed.
-     * Defaults to `true`.
+     * Shows or hides the current time marker.
+     * Set to `true` to display the marker.
+     * @default true
      */
     enabled?: boolean;
 }

package/models/dependency-type.enum.d.ts

@@ -3,7 +3,7 @@
 * Licensed under commercial license. See LICENSE.md in the project root for more information
 *-------------------------------------------------------------------------------------------*/
 /**
- * The dependency type when two tasks are connected.
+ * Represents the dependency type when you connect two tasks.
  *
  * The supported values are:
  * * `FF`—from 'finish' to 'finish'
@@ -12,8 +12,20 @@
  * * `SF`—from 'start' to 'finish'
  */
 export declare enum DependencyType {
+    /**
+     * Specifies that task B can't finish before task A finishes.
+     */
     FF = 0,
+    /**
+     * Specifies that task B can't start before task A finishes.
+     */
     FS = 1,
+    /**
+     * Specifies that task A can't finish before task B starts.
+     */
     SF = 2,
+    /**
+     * Specifies that task B can't start before task A starts.
+     */
     SS = 3
 }

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

@@ -5,39 +5,39 @@
 import type { GanttComponent } from '../../gantt.component';
 import { GanttColumnComponent, GanttSpanColumnComponent } from '../../columns/columns';
 /**
- * Triggered every time a cell is clicked.
+ * Represents the arguments for the `cellClick` event of the Gantt.
  */
 export interface CellClickEvent {
     /**
-     * The column component associated with the clicked cell.
+     * Contains the column component associated with the clicked cell.
      */
     column: GanttColumnComponent | GanttSpanColumnComponent;
     /**
-     * The column index of the clicked cell.
+     * Holds the column index of the clicked cell.
      */
     columnIndex: number;
     /**
-     * The data item associated with the clicked cell.
+     * Contains the data item for the clicked cell.
      */
     dataItem: any;
     /**
-     * Indicates whether the cell is in edit mode.
+     * Indicates if the cell is in edit mode.
      */
     isEdited: boolean;
     /**
-     * The DOM event that triggered the `cellClick` event.
+     * Contains the DOM event that triggered the `cellClick` event.
      */
     originalEvent: PointerEvent;
     /**
-     * The row index for the clicked cell.
+     * Holds the row index for the clicked cell.
      */
     rowIndex: number;
     /**
-     * The Gantt component instance.
+     * Contains the Gantt component instance.
      */
     sender: GanttComponent;
     /**
-     * The type of the event that triggered the `cellClick` event.
+     * Specifies the type of event that triggered the `cellClick` event.
      */
     type: 'click' | 'contextmenu' | 'dblclick';
 }

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

@@ -6,11 +6,11 @@ import type { GanttComponent } from '../../gantt.component';
 import { PreventableEvent } from '@progress/kendo-angular-common';
 import { TaskEditItem } from './task-edit-event.interface';
 /**
- * Called every time a user leaves an edited cell.
+ * Represents the arguments for the `cellClose` event of the Gantt.
  */
 export declare class CellCloseEvent extends PreventableEvent {
     /**
-     * The data item.
+     * Holds the data item.
      */
     dataItem: any;
     /**
@@ -18,26 +18,25 @@ export declare class CellCloseEvent extends PreventableEvent {
      */
     isNew: boolean;
     /**
-     * The Gantt column that will be closed.
+     * Contains the Gantt column associated with the closed cell.
      */
     column: any;
     /**
-     * The [`FormGroup`](link:site.data.urls.angular['formgroupapi']) that is used to edit the cell which will be closed.
+     * Contains the [`FormGroup`](link:site.data.urls.angular['formgroupapi']) used to edit the cell that 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.
+     * Contains the DOM event that triggered the `cellClose` event.
+     * This property may be missing if `cellClose` is triggered by an API call.
      */
     originalEvent: any;
     /**
-     * The `GanttComponent` instance.
+     * Holds 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.
+     * Contains the `TaskEditItem` for the edited task.
+     * Access the parent item through the `parent` property to traverse all ancestors that need updates.
      */
     item: TaskEditItem;
     constructor(options: any);

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

@@ -4,7 +4,7 @@
 *-------------------------------------------------------------------------------------------*/
 import { ColumnReorderEvent as TreeListColumnReorderEvent } from '@progress/kendo-angular-treelist';
 /**
- * Arguments for the `columnReorder` event.
+ * Provides the arguments for the `columnReorder` event.
  */
 export interface ColumnReorderEvent extends TreeListColumnReorderEvent {
 }

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

@@ -4,7 +4,7 @@
 *-------------------------------------------------------------------------------------------*/
 import { ColumnResizeArgs } from '@progress/kendo-angular-treelist';
 /**
- * Arguments for the `columnResize` event.
+ * Provides the arguments for the `columnResize` event.
  */
 export interface ColumnResizeEvent extends ColumnResizeArgs {
 }

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

@@ -4,11 +4,11 @@
 *-------------------------------------------------------------------------------------------*/
 import { GanttColumnBase } from '../../columns/column-base.component';
 /**
- * Arguments for the `columnVisibilityChange` event.
+ * Provides the arguments for the `columnVisibilityChange` event.
  */
 export interface ColumnVisibilityChangeEvent {
     /**
-     * The columns whose visibility is changed.
+     * Contains the columns whose visibility changes.
      */
     columns: GanttColumnBase[];
 }

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

@@ -4,7 +4,7 @@
 *-------------------------------------------------------------------------------------------*/
 import { DataStateChangeEvent as TreeListDataStateChangeEvent } from "@progress/kendo-angular-treelist";
 /**
- * Arguments for the `dataStateChange` event
+ * Provides the arguments for the `dataStateChange` event.
  */
 export interface DataStateChangeEvent extends TreeListDataStateChangeEvent {
 }

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

@@ -4,23 +4,23 @@
 *-------------------------------------------------------------------------------------------*/
 import { DependencyType } from '../dependency-type.enum';
 /**
- * The event data of the [`dependencyAdd`]({% slug api_gantt_ganttcomponent %}#toc-dependencyadd) event.
+ * Provides the event data for the [`dependencyAdd`]({% slug api_gantt_ganttcomponent %}#toc-dependencyadd) event.
  */
 export interface DependencyAddEvent {
     /**
-     * The task from which the dependency starts (predecessor).
+     * Represents the task where the dependency starts (predecessor).
      */
     fromTask: any;
     /**
-     * The task where the dependency ends (successor).
+     * Represents the task where the dependency ends (successor).
      */
     toTask: any;
     /**
-     * The dependency type of the linked tasks.
+     * Specifies the dependency type for the linked tasks.
      */
     type: DependencyType;
     /**
-     * Specifies whether the dependency creation attempt is a valid link between the two targeted tasks.
+     * Indicates if the dependency creation is a valid link between the two tasks.
      */
     isValid: boolean;
 }

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

@@ -4,28 +4,28 @@
 *-------------------------------------------------------------------------------------------*/
 import { TaskEditItem } from "./task-edit-event.interface";
 /**
- * The event data of the [`taskAdd`]({% slug api_gantt_ganttcomponent %}#toc-taskadd) event.
+ * Contains the event data for the [`taskAdd`]({% slug api_gantt_ganttcomponent %}#toc-taskadd) event.
  */
 export interface TaskAddEvent {
     /**
-     * The currently selected Gantt task.
+     * Holds the currently selected Gantt task.
      */
     selectedItem: TaskEditItem | null;
     /**
-     * The type of the add action. The built-in types are `addTask`, `addChild`, `addAbove`, and `addBelow`.
+     * Holds the type of add action. The built-in types are `addTask`, `addChild`, `addAbove`, and `addBelow`.
      */
     actionType: string;
 }
 /**
- * The interface of the AddTask DropDownButton options.
+ * Describes the AddTask DropDownButton options.
  */
 export interface GanttAddTaskActionItem {
     /**
-     * The text of the respective DropDownButton option.
+     * Holds the text for the DropDownButton option.
      */
     text: string;
     /**
-     * The type of action associated with selecting the respective DropDownButton option.
+     * Holds the type of action for the DropDownButton option.
      */
     type: string;
 }

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

@@ -4,27 +4,27 @@
 *-------------------------------------------------------------------------------------------*/
 import type { GanttComponent } from '../../gantt.component';
 /**
- * Triggered every time a task is clicked.
+ * Provides the arguments for the `taskClick` event of the Gantt.
  */
 export interface TaskClickEvent {
     /**
-     * The DOM event that triggered the `taskClick` event.
+     * Holds the DOM event that triggered the `taskClick` event.
      */
     originalEvent: PointerEvent | KeyboardEvent;
     /**
-     * The data item associated with the clicked task.
+     * Holds the data item for the clicked task.
      */
     dataItem: any;
     /**
-     * The Gantt component instance.
+     * Holds the Gantt component instance.
      */
     sender: GanttComponent;
     /**
-     * The order index of the clicked task, defined by the number of rendered tasks in the Timeline.
+     * Holds the order index of the clicked task, based on the number of rendered tasks in the Timeline.
      */
     index: number;
     /**
-     * The type of the event that triggered the `taskClick` event.
+     * Holds the type of event that triggered the `taskClick` event.
      */
     type: 'click' | 'contextmenu' | 'dblclick';
 }

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

@@ -5,17 +5,16 @@
 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.
+ * Contains the event data for 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.
+     * Holds the item for the delete request.
+     * You can access the parent item through the `parent` property to update all ancestors.
      */
     item: TaskEditItem;
     /**
-     * The GanttComponent instance.
+     * Holds the `GanttComponent` instance.
      */
     sender: GanttComponent;
 }

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

@@ -5,28 +5,27 @@
 import { DragTargetDragEndEvent, DragTargetDragEvent } from "@progress/kendo-angular-utils";
 import { TaskEditItem } from "./task-edit-event.interface";
 /**
- * The event data of the Gantt `TaskDragEvent`. The event is triggered when the end user resizes or moves a Task.
+ * Contains the event data for the Gantt `TaskDragEvent`. This event triggers when the user resizes or moves a task.
  */
 export interface TaskDragEvent {
     /**
-     * The calculated new start date of the task.
+     * Holds the new start date for the task.
      */
     start: Date;
     /**
-     * The calculated new end date of the task.
+     * Holds the new end date for the task.
      */
     end: Date;
     /**
-     * The calculated new completion ratio.
+     * Holds the new completion ratio.
      */
     completionRatio: number;
     /**
-     * The drag event, triggered from the end user dragging action.
+     * Holds the drag event triggered by the user's action.
      */
     dragEvent: DragTargetDragEvent | DragTargetDragEndEvent;
     /**
-     * The item object, associated with the dragged event. Contains the original data item, and its parent, allowing to access
-     * and update all affected ancestor tasks in the data hierarchy as necessary.
+     * Holds the item object for the dragged event. Contains the original data item and its parent. Use this to update all affected ancestor tasks in the data hierarchy.
      */
     item: TaskEditItem;
 }
@@ -36,32 +35,31 @@ export interface TaskDragEvent {
  */
 export interface InternalTaskDragEvent {
     /**
-     * The calculated new start date of the task.
+     * Holds the new start date for the task.
      */
     start: Date;
     /**
-     * The calculated new end date of the task.
+     * Holds the new end date for the task.
      */
     end: Date;
     /**
-     * The calculated new completion ratio.
+     * Holds the new completion ratio.
      */
     completionRatio: number;
     /**
-     * The offset of the task DOM element, relative to the view start.
+     * Holds the offset of the task DOM element, relative to the view start.
      */
     offset: number;
     /**
-     * The new width of the task DOM element in pixels.
+     * Holds the new width of the task DOM element in pixels.
      */
     width: number;
     /**
-     * The drag event, triggered from the end user dragging action.
+     * Holds the drag event triggered by the user's action.
      */
     dragEvent: DragTargetDragEvent | DragTargetDragEndEvent;
     /**
-     * The item object, associated with the dragged event. Contains the original data item, and its parent, allowing to access
-     * and update all affected ancestor tasks in the data hierarchy as necessary.
+     * Holds the item object for the dragged event. Contains the original data item and its parent. Use this to update all affected ancestor tasks in the data hierarchy.
      */
     item: any;
 }

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

@@ -5,47 +5,45 @@
 import { FormGroup } from "@angular/forms";
 import type { GanttComponent } from "../../gantt.component";
 /**
- * The event data for the task editing events.
+ * Contains the event data for 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.
+     * Holds the `TaskEditItem` for the edited task.
+     * Access the parent item through the `parent` property to update all ancestors.
      */
     item: TaskEditItem;
     /**
-     * The FormGroup instance associated with the edited task.
+     * Holds the `FormGroup` instance for the edited task.
      */
     taskFormGroup?: FormGroup;
     /**
-     * The dependencies associated with the edited task.
+     * Holds the dependencies for the edited task.
      */
     dependencies: EditEventDependencies;
     /**
-     * The GanttComponent instance.
+     * Holds 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.
+ * Represents the `TaskEditItem` associated with the edited task.
+ * Access the parent item through the `parent` property to update all ancestors.
  */
 export interface TaskEditItem {
     /**
-     * The original data item for this entry.
+     * Holds 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`.
+     * Holds the parent data item and its parent data.
+     * If the current data item is at root level, this property is `null`.
      */
     parent?: TaskEditItem;
 }
 /**
- * The `EditEventDependencies` object associated with the edited task.
- * The created, updated and deleted items are accessible through their respective properties.
+ * Provides the `EditEventDependencies` object associated with the edited task.
+ * You can access the created, updated, and deleted items through the respective properties.
  */
 export interface EditEventDependencies {
     /**