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

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (102) hide show
  1. package/binding-directives/flat-binding.directive.d.ts +16 -4
  2. package/binding-directives/hierarchy-binding.directive.d.ts +16 -3
  3. package/columns/cell-template.directive.d.ts +20 -12
  4. package/columns/column-base.component.d.ts +2 -1
  5. package/columns/column-group.component.d.ts +14 -0
  6. package/columns/column-menu-template.directive.d.ts +14 -7
  7. package/columns/column.component.d.ts +12 -2
  8. package/columns/edit-template.directive.d.ts +15 -6
  9. package/columns/filter-menu-template.directive.d.ts +14 -4
  10. package/columns/footer-template.directive.d.ts +14 -5
  11. package/columns/header-template.directive.d.ts +15 -5
  12. package/columns/span-column.component.d.ts +16 -0
  13. package/directives.d.ts +1 -1
  14. package/dragging/dependency-drag-create.directive.d.ts +9 -2
  15. package/dragging/task-drag.directive.d.ts +17 -4
  16. package/editing/add-task.component.d.ts +7 -7
  17. package/esm2022/binding-directives/flat-binding.directive.mjs +16 -4
  18. package/esm2022/binding-directives/hierarchy-binding.directive.mjs +16 -3
  19. package/esm2022/columns/cell-template.directive.mjs +20 -12
  20. package/esm2022/columns/column-base.component.mjs +2 -1
  21. package/esm2022/columns/column-group.component.mjs +14 -0
  22. package/esm2022/columns/column-menu-template.directive.mjs +14 -7
  23. package/esm2022/columns/column.component.mjs +12 -2
  24. package/esm2022/columns/edit-template.directive.mjs +15 -6
  25. package/esm2022/columns/filter-menu-template.directive.mjs +14 -4
  26. package/esm2022/columns/footer-template.directive.mjs +14 -5
  27. package/esm2022/columns/header-template.directive.mjs +15 -5
  28. package/esm2022/columns/span-column.component.mjs +16 -0
  29. package/esm2022/directives.mjs +1 -1
  30. package/esm2022/dragging/dependency-drag-create.directive.mjs +9 -18
  31. package/esm2022/dragging/task-drag.directive.mjs +17 -4
  32. package/esm2022/editing/add-task.component.mjs +7 -7
  33. package/esm2022/expanded-state/expand-event.mjs +3 -2
  34. package/esm2022/expanded-state/expandable.directive.mjs +11 -5
  35. package/esm2022/gantt.component.mjs +163 -211
  36. package/esm2022/gantt.module.mjs +9 -20
  37. package/esm2022/localization/custom-messages.component.mjs +10 -2
  38. package/esm2022/models/dependency-type.enum.mjs +14 -2
  39. package/esm2022/models/events/cell-close-event.interface.mjs +9 -10
  40. package/esm2022/package-metadata.mjs +2 -2
  41. package/esm2022/selection/selectable.directive.mjs +13 -5
  42. package/esm2022/template-directives/summary-task-template.directive.mjs +14 -23
  43. package/esm2022/template-directives/task-content-template.directive.mjs +3 -4
  44. package/esm2022/template-directives/task-template.directive.mjs +12 -21
  45. package/esm2022/template-directives/task-tooltip-template.directive.mjs +3 -4
  46. package/esm2022/timeline/timeline-day-view.component.mjs +7 -2
  47. package/esm2022/timeline/timeline-month-view.component.mjs +7 -2
  48. package/esm2022/timeline/timeline-week-view.component.mjs +7 -2
  49. package/esm2022/timeline/timeline-year-view.component.mjs +7 -2
  50. package/esm2022/timeline/view-base.mjs +10 -4
  51. package/esm2022/toolbar/toolbar-template.directive.mjs +13 -86
  52. package/esm2022/toolbar/view-selector.component.mjs +4 -4
  53. package/expanded-state/expand-event.d.ts +3 -2
  54. package/expanded-state/expandable.directive.d.ts +11 -5
  55. package/fesm2022/progress-kendo-angular-gantt.mjs +520 -490
  56. package/gantt.component.d.ts +159 -207
  57. package/gantt.module.d.ts +9 -20
  58. package/localization/custom-messages.component.d.ts +10 -2
  59. package/models/cell-content-type.interface.d.ts +4 -3
  60. package/models/class-callbacks.d.ts +20 -20
  61. package/models/column-menu-settings.interface.d.ts +7 -8
  62. package/models/column-reorder-config.d.ts +4 -1
  63. package/models/current-time-settings.interface.d.ts +8 -5
  64. package/models/dependency-type.enum.d.ts +13 -1
  65. package/models/events/cell-click-event.interface.d.ts +9 -9
  66. package/models/events/cell-close-event.interface.d.ts +9 -10
  67. package/models/events/column-reorder-event.interface.d.ts +1 -1
  68. package/models/events/column-resize-event.interface.d.ts +1 -1
  69. package/models/events/column-visibility-change-event.interface.d.ts +2 -2
  70. package/models/events/data-state-change-event.interface.d.ts +1 -1
  71. package/models/events/dependency-add-event.interface.d.ts +5 -5
  72. package/models/events/task-add-event.interface.d.ts +6 -6
  73. package/models/events/task-click-event.interface.d.ts +6 -6
  74. package/models/events/task-delete-event.interface.d.ts +4 -5
  75. package/models/events/task-drag-event.interface.d.ts +13 -15
  76. package/models/events/task-edit-event.interface.d.ts +13 -15
  77. package/models/gantt-dependency-model-fields.interface.d.ts +11 -10
  78. package/models/gantt-dependency.interface.d.ts +8 -5
  79. package/models/gantt-task-model-fields.interface.d.ts +22 -13
  80. package/models/gantt-task.interface.d.ts +11 -10
  81. package/models/sort-settings.d.ts +6 -6
  82. package/models/splitter-pane-options.interface.d.ts +8 -8
  83. package/models/timeline-header-date-format.d.ts +4 -3
  84. package/models/timeline-view.d.ts +1 -1
  85. package/models/toolbar-settings.d.ts +5 -6
  86. package/models/tooltip-options.interface.d.ts +4 -4
  87. package/package.json +17 -17
  88. package/schematics/ngAdd/index.js +7 -7
  89. package/scrolling/drag-scroll-settings.d.ts +4 -4
  90. package/selection/selectable.directive.d.ts +13 -5
  91. package/selection/selection-change-event.d.ts +6 -7
  92. package/template-directives/summary-task-template.directive.d.ts +14 -23
  93. package/template-directives/task-content-template.directive.d.ts +3 -4
  94. package/template-directives/task-template.directive.d.ts +12 -21
  95. package/template-directives/task-tooltip-template.directive.d.ts +3 -4
  96. package/timeline/timeline-day-view.component.d.ts +7 -2
  97. package/timeline/timeline-month-view.component.d.ts +7 -2
  98. package/timeline/timeline-week-view.component.d.ts +7 -2
  99. package/timeline/timeline-year-view.component.d.ts +7 -2
  100. package/timeline/view-base.d.ts +11 -5
  101. package/toolbar/toolbar-template.directive.d.ts +13 -86
  102. package/toolbar/view-selector.component.d.ts +4 -4
@@ -44,8 +44,8 @@ const packageMetadata = {
44
44
  productName: 'Kendo UI for Angular',
45
45
  productCode: 'KENDOUIANGULAR',
46
46
  productCodes: ['KENDOUIANGULAR'],
47
- publishDate: 1750157264,
48
- version: '19.1.2-develop.4',
47
+ publishDate: 1750431176,
48
+ version: '19.1.2-develop.5',
49
49
  licensingDocsUrl: 'https://www.telerik.com/kendo-angular-ui/my-license/?utm_medium=product&utm_source=kendoangular&utm_campaign=kendo-ui-angular-purchase-license-keys-warning'
50
50
  };
51
51
 
@@ -213,7 +213,7 @@ const DEFAULT_TASK_MODEL_FIELDS = Object.freeze({
213
213
  });
214
214
 
215
215
  /**
216
- * The dependency type when two tasks are connected.
216
+ * Represents the dependency type when you connect two tasks.
217
217
  *
218
218
  * The supported values are:
219
219
  * * `FF`—from 'finish' to 'finish'
@@ -223,10 +223,22 @@ const DEFAULT_TASK_MODEL_FIELDS = Object.freeze({
223
223
  */
224
224
  var DependencyType;
225
225
  (function (DependencyType) {
226
+ /**
227
+ * Specifies that task B can't finish before task A finishes.
228
+ */
226
229
  DependencyType[DependencyType["FF"] = 0] = "FF";
230
+ /**
231
+ * Specifies that task B can't start before task A finishes.
232
+ */
227
233
  DependencyType[DependencyType["FS"] = 1] = "FS";
234
+ /**
235
+ * Specifies that task A can't finish before task B starts.
236
+ */
228
237
  DependencyType[DependencyType["SF"] = 2] = "SF";
229
- DependencyType[DependencyType["SS"] = 3] = "SS"; // task B can't start before task A starts
238
+ /**
239
+ * Specifies that task B can't start before task A starts.
240
+ */
241
+ DependencyType[DependencyType["SS"] = 3] = "SS";
230
242
  })(DependencyType || (DependencyType = {}));
231
243
 
232
244
  /**
@@ -3103,11 +3115,10 @@ i0.ɵɵngDeclareClassMetadata({ minVersion: "12.0.0", version: "16.2.12", ngImpo
3103
3115
  }] } });
3104
3116
 
3105
3117
  /**
3106
- * Represents a template that defines the whole content of the Task tooltip.
3107
- * To define the template, nest an `<ng-template>` tag
3108
- * with the `kendoGanttTaskTooltipTemplate` directive inside the `<kendo-gantt>` tag.
3118
+ * Defines a template for the entire Task tooltip.
3119
+ * Place an `<ng-template>` tag with the `kendoGanttTaskTooltipTemplate` directive inside the `<kendo-gantt>` tag to set the template.
3109
3120
  *
3110
- * The template context is set to the respective data item.
3121
+ * The template context uses the related data item.
3111
3122
  *
3112
3123
  * @example
3113
3124
  * ```ts-preview
@@ -3731,7 +3742,8 @@ i0.ɵɵngDeclareClassMetadata({ minVersion: "12.0.0", version: "16.2.12", ngImpo
3731
3742
  }] } });
3732
3743
 
3733
3744
  /**
3734
- * The base class for the column components of the Gantt.
3745
+ * Serves as the base class for Gantt column components.
3746
+ *
3735
3747
  */
3736
3748
  class GanttColumnBase extends ColumnBase {
3737
3749
  static ɵfac = i0.ɵɵngDeclareFactory({ minVersion: "12.0.0", version: "16.2.12", ngImport: i0, type: GanttColumnBase, deps: null, target: i0.ɵɵFactoryTarget.Component });
@@ -3746,20 +3758,28 @@ i0.ɵɵngDeclareClassMetadata({ minVersion: "12.0.0", version: "16.2.12", ngImpo
3746
3758
  }] });
3747
3759
 
3748
3760
  /**
3749
- * Represents the column cell template of the Gantt.
3750
- * Helps to customize the content of the cells. To define the cell template, nest an `<ng-template>` tag
3751
- * with the `kendoGanttCellTemplate` directive inside the respective column tag.
3761
+ * Customizes the content of Gantt column cells. Place an `<ng-template>` tag
3762
+ * with the `kendoGanttCellTemplate` directive inside a `<kendo-gantt-column>` tag to define the cell template.
3752
3763
  *
3753
- * The template context is set to the current data item and the following additional fields are passed:
3754
- * - `dataItem`&mdash;The current data item. Represents the default context that will be assigned to any template variable which utilizes the `let-x` syntax&mdash;for example, `let-dataItem`.
3755
- * - `columnIndex`&mdash;The current column index. Use it as an alias for a template variable by utilizing the `let-columnIndex="columnIndex"` syntax.
3756
- * - `column`&mdash;The current column instance. Use it as an alias for a template variable by utilizing the `let-column="column"` syntax.
3757
- * - `cellContext`&mdash;An object used to pass context information to built-in directives.
3758
- * - `hasChildren`&mdash;Specifies if the item has children.
3759
- * - `isExpanded`&mdash;Specifies if the item is expanded.
3764
+ * The template context provides these fields:
3765
+ * - `dataItem`&mdash;The current data item. Represents the default context that will be assigned to any template variable using the `let-x` syntax, for example, `let-dataItem`.
3766
+ * - `columnIndex`&mdash;The current column index. Use it as a template variable with the `let-columnIndex="columnIndex"` syntax.
3767
+ * - `column`&mdash;The current column instance. Use it as a template variable with the `let-column="column"` syntax.
3768
+ * - `cellContext`&mdash;An object for passing context information to built-in directives.
3769
+ * - `hasChildren`&mdash;Indicates if the item has children.
3770
+ * - `isExpanded`&mdash;Indicates if the item is expanded.
3760
3771
  * - `level`&mdash;The hierarchy level of the item.
3761
- * - `loading`&mdash;Specifies if the item children are currently loading.
3762
- * - `rowIndex`&mdash;The current row index. Use it as an alias for a template variable by utilizing the `let-rowIndex="rowIndex"` syntax.
3772
+ * - `loading`&mdash;Indicates if the item children are loading.
3773
+ * - `rowIndex`&mdash;The current row index. Use it as a template variable with the `let-rowIndex="rowIndex"` syntax.
3774
+ *
3775
+ * @example
3776
+ * ```html
3777
+ * <kendo-gantt-column field="title">
3778
+ * <ng-template kendoGanttCellTemplate let-dataItem>
3779
+ * <strong>{{ dataItem.title }}</strong>
3780
+ * </ng-template>
3781
+ * </kendo-gantt-column>
3782
+ * ```
3763
3783
  */
3764
3784
  class CellTemplateDirective {
3765
3785
  templateRef;
@@ -3780,14 +3800,21 @@ i0.ɵɵngDeclareClassMetadata({ minVersion: "12.0.0", version: "16.2.12", ngImpo
3780
3800
  }] }]; } });
3781
3801
 
3782
3802
  /**
3783
- * Represents the template for the column menu in the Gantt. Provides an option for
3784
- * customizing the content of the column menu for all or for specific columns.
3785
- * To define the content template, nest an `<ng-template>` tag with the
3786
- * `kendoGanttColumnMenuTemplate` directive inside the `<kendo-gantt-column>` component.
3803
+ * Customizes the column menu content in the Gantt. Place an `<ng-template>` tag with the
3804
+ * `kendoGanttColumnMenuTemplate` directive inside a `<kendo-gantt-column>` component to define the template.
3805
+ *
3806
+ * The template context provides the following fields:
3807
+ * - `service`&mdash;The `ColumnMenuService` instance.
3808
+ * - `column`&mdash;The Gantt column instance.
3787
3809
  *
3788
- * The column menu service and the current column are available as context variables:
3789
- * - `service`&mdash;Represents the ColumnMenuService.
3790
- * - `column`&mdash;Represents the Gantt column.
3810
+ * @example
3811
+ * ```html
3812
+ * <kendo-gantt-column>
3813
+ * <ng-template kendoGanttColumnMenuTemplate let-service="service" let-column="column">
3814
+ * <button (click)="service.close()">Close Menu</button>
3815
+ * </ng-template>
3816
+ * </kendo-gantt-column>
3817
+ * ```
3791
3818
  */
3792
3819
  class ColumnMenuTemplateDirective {
3793
3820
  templateRef;
@@ -3835,12 +3862,22 @@ i0.ɵɵngDeclareClassMetadata({ minVersion: "12.0.0", version: "16.2.12", ngImpo
3835
3862
  }] }]; } });
3836
3863
 
3837
3864
  /**
3838
- * Represents the filter-menu template.
3865
+ * Represents the filter-menu template for the Gantt column.
3839
3866
  *
3840
- * The column, current filter and the filter service are available as context variables:
3841
- * - `column`&mdash;The current column instance. Use it as an alias for a template variable by utilizing the `let-column="column"` syntax.
3867
+ * Use this directive to customize the filter menu for a column.
3868
+ * The template context provides:
3869
+ * - `column`&mdash;The current column instance. Use as an alias for a template variable with the `let-column="column"` syntax.
3842
3870
  * - `filter`&mdash;The filter descriptor.
3843
- * - `cellContext`&mdash;An object used to pass context information to built-in directives.
3871
+ * - `cellContext`&mdash;An object for passing context information to built-in directives.
3872
+ *
3873
+ * @example
3874
+ * ```html
3875
+ * <kendo-gantt-column>
3876
+ * <ng-template kendoGanttFilterMenuTemplate let-column let-filter="filter">
3877
+ * Custom filter for {{ column.field }}
3878
+ * </ng-template>
3879
+ * </kendo-gantt-column>
3880
+ * ```
3844
3881
  */
3845
3882
  class FilterMenuTemplateDirective {
3846
3883
  templateRef;
@@ -3861,16 +3898,25 @@ i0.ɵɵngDeclareClassMetadata({ minVersion: "12.0.0", version: "16.2.12", ngImpo
3861
3898
  }] }]; } });
3862
3899
 
3863
3900
  /**
3864
- * Represents the column footer cell template of the Gantt.
3901
+ * Represents the footer cell template of the Gantt columns.
3865
3902
  *
3866
- * Helps to customize the table footer cell for the column.
3903
+ * Use this directive to customize the table footer cell for a column.
3867
3904
  * To define a footer template, nest an `<ng-template>` tag with the
3868
3905
  * [`kendoGanttFooterTemplate`]({% slug api_gantt_footertemplatedirective %}) directive inside the `<kendo-gantt-column>` tag.
3869
3906
  *
3870
- * The current column, column index and field are available as context variables:
3871
- * * `column`&mdash;Points to the instance of the current [`ColumnComponent`]({% slug api_gantt_ganttcolumncomponent %}).
3872
- * * `columnIndex`&mdash;Defines the current column index.
3907
+ * The template context provides:
3908
+ * * `column`&mdash;The current [`ColumnComponent`]({% slug api_gantt_ganttcolumncomponent %}).
3909
+ * * `columnIndex`&mdash;The current column index.
3873
3910
  * * `field`&mdash;The name of the column field, if set.
3911
+ *
3912
+ * @example
3913
+ * ```html
3914
+ * <kendo-gantt-column>
3915
+ * <ng-template kendoGanttFooterTemplate let-column let-columnIndex="columnIndex" let-field="field">
3916
+ * Footer for {{ field }}
3917
+ * </ng-template>
3918
+ * </kendo-gantt-column>
3919
+ * ```
3874
3920
  */
3875
3921
  class FooterTemplateDirective {
3876
3922
  templateRef;
@@ -3891,14 +3937,24 @@ i0.ɵɵngDeclareClassMetadata({ minVersion: "12.0.0", version: "16.2.12", ngImpo
3891
3937
  }] }]; } });
3892
3938
 
3893
3939
  /**
3894
- * Represents the column header cell template of the Gantt.
3895
- * Helps to customize the table header cell for the column.
3940
+ * Represents the header cell template of the Gantt columns.
3941
+ *
3942
+ * Use this directive to customize the table header cell for a column.
3896
3943
  * To define a header template, nest an `<ng-template>` tag with the
3897
3944
  * [`kendoGanttHeaderTemplate`]({% slug api_gantt_headertemplatedirective %}) directive inside the `<kendo-gantt-column>` tag.
3898
3945
  *
3899
- * The current column and column index are available as context variables:
3900
- * * `column`&mdash;Points to the instance of the current [`ColumnComponent`]({% slug api_gantt_ganttcolumncomponent %}).
3901
- * * `columnIndex`&mdash;Defines the current column index.
3946
+ * The template context provides:
3947
+ * * `column`&mdash;The current [`ColumnComponent`]({% slug api_gantt_ganttcolumncomponent %}).
3948
+ * * `columnIndex`&mdash;The current column index.
3949
+ *
3950
+ * @example
3951
+ * ```html
3952
+ * <kendo-gantt-column>
3953
+ * <ng-template kendoGanttHeaderTemplate let-column let-columnIndex="columnIndex">
3954
+ * Custom Header for {{ column.field }} ({{ columnIndex }})
3955
+ * </ng-template>
3956
+ * </kendo-gantt-column>
3957
+ * ```
3902
3958
  */
3903
3959
  class HeaderTemplateDirective {
3904
3960
  templateRef;
@@ -3919,18 +3975,27 @@ i0.ɵɵngDeclareClassMetadata({ minVersion: "12.0.0", version: "16.2.12", ngImpo
3919
3975
  }] }]; } });
3920
3976
 
3921
3977
  /**
3922
- * Represents the column edit-cell template of the Gantt.
3923
- * Helps to customize the content of the edited cells. To define the cell template, nest an `<ng-template>`
3978
+ * Represents the column template for edited cells in the Gantt.
3979
+ *
3980
+ * Use this directive to customize the content of edited cells. To define the cell template, nest an `<ng-template>`
3924
3981
  * tag with the `kendoGanttEditTemplate` directive inside a `<kendo-gantt-column>` tag.
3925
3982
  *
3926
- * The template context contains the following fields:
3983
+ * The template context provides the following fields:
3927
3984
  * - `column`&mdash;The current column instance.
3928
3985
  * - `dataItem`&mdash;The current data item.
3929
- * - `cellContext`&mdash;An object used to pass context information to built-in directives.
3930
- * - `formGroup`&mdash;The current [`FormGroup`](link:site.data.urls.angular['formgroupapi']).
3931
- * If you use the Gantt inside [Template-Driven Forms](link:site.data.urls.angular['forms']), it will be `undefined`.
3986
+ * - `cellContext`&mdash;An object for passing context information to built-in directives.
3987
+ * - `formGroup`&mdash;The current [`FormGroup`](link:site.data.urls.angular['formgroupapi']). If you use the Gantt inside [Template-Driven Forms](link:site.data.urls.angular['forms']), it is `undefined`.
3932
3988
  * - `isNew`&mdash;The state of the current item.
3933
3989
  * - `rowIndex`&mdash;The current row index. If inside a new item row, `rowIndex` is `-1`.
3990
+ *
3991
+ * @example
3992
+ * ```html
3993
+ * <kendo-gantt-column>
3994
+ * <ng-template kendoGanttEditTemplate let-dataItem="dataItem" let-formGroup="formGroup">
3995
+ * <input [formControl]="formGroup.get('field')" />
3996
+ * </ng-template>
3997
+ * </kendo-gantt-column>
3998
+ * ```
3934
3999
  */
3935
4000
  class EditTemplateDirective {
3936
4001
  templateRef;
@@ -3950,6 +4015,14 @@ i0.ɵɵngDeclareClassMetadata({ minVersion: "12.0.0", version: "16.2.12", ngImpo
3950
4015
  type: Optional
3951
4016
  }] }]; } });
3952
4017
 
4018
+ /**
4019
+ * Represents a column in the Gantt. Use this component to define columns and customize their behavior and appearance.
4020
+ *
4021
+ * @example
4022
+ * ```html
4023
+ * <kendo-gantt-column field="title" title="Task"></kendo-gantt-column>
4024
+ * ```
4025
+ */
3953
4026
  class GanttColumnComponent extends ColumnComponent {
3954
4027
  options;
3955
4028
  headerTemplates = new QueryList();
@@ -3960,11 +4033,13 @@ class GanttColumnComponent extends ColumnComponent {
3960
4033
  filterCellTemplate;
3961
4034
  filterMenuTemplate;
3962
4035
  /**
3963
- * Defines the filter type that is displayed inside the filter row. The default value is `text`.
4036
+ * Sets the filter type for the filter row. The default value is `text`.
4037
+ * @default 'text'
3964
4038
  */
3965
4039
  filter = 'text';
3966
4040
  /**
3967
- * Defines if a filter UI will be displayed for this column. The default value is `true`.
4041
+ * Shows or hides the filter UI for this column. The default value is `true`.
4042
+ * @default true
3968
4043
  */
3969
4044
  filterable = true;
3970
4045
  /**
@@ -4045,6 +4120,20 @@ i0.ɵɵngDeclareClassMetadata({ minVersion: "12.0.0", version: "16.2.12", ngImpo
4045
4120
  type: Input
4046
4121
  }] } });
4047
4122
 
4123
+ /**
4124
+ * Represents a group of columns in the Gantt. Use this component to organize columns under a common header.
4125
+ *
4126
+ * @example
4127
+ * ```html
4128
+ * <kendo-gantt-column-group title="Details">
4129
+ * <kendo-gantt-column field="start"></kendo-gantt-column>
4130
+ * <kendo-gantt-column field="end"></kendo-gantt-column>
4131
+ * </kendo-gantt-column-group>
4132
+ * ```
4133
+ *
4134
+ * @remarks
4135
+ * Supported children components are: {@link GanttColumnComponent}, {@link GanttSpanColumnComponent}.
4136
+ */
4048
4137
  class GanttColumnGroupComponent extends ColumnGroupComponent {
4049
4138
  options;
4050
4139
  /**
@@ -4100,6 +4189,22 @@ i0.ɵɵngDeclareClassMetadata({ minVersion: "12.0.0", version: "16.2.12", ngImpo
4100
4189
  args: [HeaderTemplateDirective]
4101
4190
  }] } });
4102
4191
 
4192
+ /**
4193
+ * Represents the Gantt span column.
4194
+ *
4195
+ * Use this component to span row content over multiple column cells.
4196
+ *
4197
+ * @example
4198
+ * ```html
4199
+ * <kendo-gantt-span-column>
4200
+ * <kendo-gantt-column field="id"></kendo-gantt-column>
4201
+ * <kendo-gantt-column field="name"></kendo-gantt-column>
4202
+ * </kendo-gantt-span-column>
4203
+ * ```
4204
+ *
4205
+ * @remarks
4206
+ * Supported children components are: {@link GanttColumnComponent}.
4207
+ */
4103
4208
  class GanttSpanColumnComponent extends SpanColumnComponent {
4104
4209
  options;
4105
4210
  /**
@@ -4175,11 +4280,11 @@ const taskClassCallback = () => null;
4175
4280
  const isSelected = () => false;
4176
4281
 
4177
4282
  /**
4178
- * Called every time a user leaves an edited cell.
4283
+ * Represents the arguments for the `cellClose` event of the Gantt.
4179
4284
  */
4180
4285
  class CellCloseEvent extends PreventableEvent {
4181
4286
  /**
4182
- * The data item.
4287
+ * Holds the data item.
4183
4288
  */
4184
4289
  dataItem;
4185
4290
  /**
@@ -4187,26 +4292,25 @@ class CellCloseEvent extends PreventableEvent {
4187
4292
  */
4188
4293
  isNew;
4189
4294
  /**
4190
- * The Gantt column that will be closed.
4295
+ * Contains the Gantt column associated with the closed cell.
4191
4296
  */
4192
4297
  column;
4193
4298
  /**
4194
- * The [`FormGroup`](link:site.data.urls.angular['formgroupapi']) that is used to edit the cell which will be closed.
4299
+ * Contains the [`FormGroup`](link:site.data.urls.angular['formgroupapi']) used to edit the cell that will be closed.
4195
4300
  */
4196
4301
  formGroup;
4197
4302
  /**
4198
- * The DOM event that caused the `cellClose` event.
4199
- * May not be present if `cellClose` was caused by an API call.
4303
+ * Contains the DOM event that triggered the `cellClose` event.
4304
+ * This property may be missing if `cellClose` is triggered by an API call.
4200
4305
  */
4201
4306
  originalEvent;
4202
4307
  /**
4203
- * The `GanttComponent` instance.
4308
+ * Holds the `GanttComponent` instance.
4204
4309
  */
4205
4310
  sender;
4206
4311
  /**
4207
- * The `TaskEditItem` associated with the edited task.
4208
- * The parent item is accessible through the `parent` property,
4209
- * and allows traversing all ancestors that need to be updated.
4312
+ * Contains the `TaskEditItem` for the edited task.
4313
+ * Access the parent item through the `parent` property to traverse all ancestors that need updates.
4210
4314
  */
4211
4315
  item;
4212
4316
  constructor(options) {
@@ -4233,30 +4337,21 @@ const DEFAULT_TIMELINE_PANE_SETTINGS = Object.freeze({
4233
4337
  });
4234
4338
 
4235
4339
  /**
4236
- * Represents a template that defines the whole content of the task component.
4237
- * To define the template, nest an `<ng-template>` tag
4238
- * with the `kendoGanttTaskTemplate` directive inside the `<kendo-gantt>` tag.
4340
+ * Defines a template for the entire task component.
4341
+ * Place an `<ng-template>` tag with the `kendoGanttTaskTemplate` directive inside the `<kendo-gantt>` tag to set the template.
4239
4342
  *
4240
- * The template context is set to the current data item. The following additional field is passed:
4241
- * - `elementWidth`&mdash;The current task wrapper element's calculated width in pixels based on its start and end date.
4242
- * Use it as an alias for a template variable by utilizing the `let-elementWidth="elementWidth"` syntax.
4243
- * Useful for calculations related to rendering custom elements representing the task progress.
4343
+ * The template context uses the current data item. The following field is also available:
4344
+ * - `elementWidth`&mdash;The calculated width in pixels of the current task wrapper element, based on its start and end date.
4345
+ * Use `let-elementWidth="elementWidth"` to access it in the template.
4346
+ * This helps you render custom elements for task progress.
4244
4347
  *
4245
4348
  * @example
4246
- * ```ts-preview
4247
- * _@Component({
4248
- * selector: 'my-app',
4249
- * template: `
4250
- * <kendo-gantt [kendoGanttHierarchyBinding]="data">
4251
- * <ng-template kendoGanttTaskTemplate let-dataItem let-elementWidth="elementWidth">
4252
- * {{ dataItem.title }} - {{ dataItem.completionRatio * 100 }}% complete
4253
- * </ng-template>
4254
- * </kendo-gantt>
4255
- * `
4256
- * })
4257
- * class AppComponent {
4258
- * public data: any[] = sampleTasks;
4259
- * }
4349
+ * ```html
4350
+ * <kendo-gantt [kendoGanttHierarchyBinding]="data">
4351
+ * <ng-template kendoGanttTaskTemplate let-dataItem let-elementWidth="elementWidth">
4352
+ * {{ dataItem.title }} - {{ dataItem.completionRatio * 100 }}% complete
4353
+ * </ng-template>
4354
+ * </kendo-gantt>
4260
4355
  * ```
4261
4356
  */
4262
4357
  class GanttTaskTemplateDirective {
@@ -4278,32 +4373,23 @@ i0.ɵɵngDeclareClassMetadata({ minVersion: "12.0.0", version: "16.2.12", ngImpo
4278
4373
  }] }]; } });
4279
4374
 
4280
4375
  /**
4281
- * Represents a template that defines the whole content of the summary task component.
4282
- * To define the template, nest an `<ng-template>` tag
4283
- * with the `kendoGanttSummaryTaskTemplate` directive inside the `<kendo-gantt>` tag.
4376
+ * Defines a template for the entire summary task component.
4377
+ * Place an `<ng-template>` tag with the `kendoGanttSummaryTaskTemplate` directive inside the `<kendo-gantt>` tag to set the template.
4284
4378
  *
4285
- * The template context is set to the current data item. The following additional field is passed:
4286
- * - `elementWidth`&mdash;The current summary task wrapper element's calculated width in pixels based on its start and end date.
4287
- * Use it as an alias for a template variable by utilizing the `let-elementWidth="elementWidth"` syntax.
4288
- * Useful for calculations related to rendering custom elements representing the task progress.
4379
+ * The template context uses the current data item. The following field is also available:
4380
+ * - `elementWidth`&mdash;The calculated width in pixels of the current summary task wrapper element, based on its start and end date.
4381
+ * Use `let-elementWidth="elementWidth"` to access it in the template.
4382
+ * This helps you render custom elements for summary task progress.
4289
4383
  *
4290
4384
  * @example
4291
- * ```ts-preview
4292
- * _@Component({
4293
- * selector: 'my-app',
4294
- * template: `
4295
- * <kendo-gantt [kendoGanttHierarchyBinding]="data">
4296
- * <ng-template kendoGanttSummaryTaskTemplate let-dataItem let-elementWidth="elementWidth">
4297
- * <div [style]="'color: white; font-size: 8px;'">
4298
- * {{ dataItem.title }} - {{ dataItem.completionRatio * 100 }}% complete; width: {{ elementWidth }}
4299
- * </div>
4300
- * </ng-template>
4301
- * </kendo-gantt>
4302
- * `
4303
- * })
4304
- * class AppComponent {
4305
- * public data: any[] = sampleTasks;
4306
- * }
4385
+ * ```html
4386
+ * <kendo-gantt [kendoGanttHierarchyBinding]="data">
4387
+ * <ng-template kendoGanttSummaryTaskTemplate let-dataItem let-elementWidth="elementWidth">
4388
+ * <div [style]="'color: white; font-size: 8px;'">
4389
+ * {{ dataItem.title }} - {{ dataItem.completionRatio * 100 }}% complete; width: {{ elementWidth }}
4390
+ * </div>
4391
+ * </ng-template>
4392
+ * </kendo-gantt>
4307
4393
  * ```
4308
4394
  */
4309
4395
  class GanttSummaryTaskTemplateDirective {
@@ -4325,11 +4411,10 @@ i0.ɵɵngDeclareClassMetadata({ minVersion: "12.0.0", version: "16.2.12", ngImpo
4325
4411
  }] }]; } });
4326
4412
 
4327
4413
  /**
4328
- * Represents a template that defines the text content section of the task component.
4329
- * To define the template, nest an `<ng-template>` tag
4330
- * with the `kendoGanttTaskContentTemplate` directive inside the `<kendo-gantt>` tag.
4414
+ * Defines a template for the text content section of the task component.
4415
+ * Place an `<ng-template>` tag with the `kendoGanttTaskContentTemplate` directive inside the `<kendo-gantt>` tag to set the template.
4331
4416
  *
4332
- * The template context is set to the current data item.
4417
+ * The template context uses the current data item.
4333
4418
  *
4334
4419
  * @example
4335
4420
  * ```ts-preview
@@ -4369,101 +4454,28 @@ i0.ɵɵngDeclareClassMetadata({ minVersion: "12.0.0", version: "16.2.12", ngImpo
4369
4454
  /**
4370
4455
  * Represents the toolbar template of the Gantt.
4371
4456
  *
4372
- * The template context has the following field:
4373
- * - `position`&mdash;The position at which the toolbar template is rendered. The possible values are `'top'` and `'bottom'`.
4457
+ * The template context includes:
4458
+ * - `position`&mdash;The position where the toolbar template renders. Possible values are `'top'` and `'bottom'`.
4374
4459
  *
4375
4460
  * @example
4376
- * ```ts-preview
4377
- *
4378
- * _@Component({
4379
- * selector: 'my-app',
4380
- * template: `
4381
- * <div class="example-config">
4382
- * <input type="radio" kendoRadioButton id="top" name="position" value="top" checked (click)="positionChange($event)"/>
4383
- * <kendo-label class="k-radio-label" for="top">Top</kendo-label><br/>
4384
- * <input type="radio" kendoRadioButton id="bottom" name="position" value="bottom" (click)="positionChange($event)"/>
4385
- * <kendo-label class="k-radio-label" for="bottom">Bottom</kendo-label><br/>
4386
- * <input type="radio" kendoRadioButton id="both" name="position" value="both" (click)="positionChange($event)"/>
4387
- * <kendo-label class="k-radio-label" for="both">Both</kendo-label><br/>
4388
- * </div>
4389
- * <kendo-gantt [[kendoGanttHierarchyBinding]="data"]="data" [style.height.px]="400">
4390
- * <ng-template kendoGanttToolbarTemplate [position]="position" let-position="position">
4391
- * <button kendoButton (click)="onClick()">Custom action</button>
4392
- * </ng-template>
4393
- * </kendo-gantt>
4394
- * `
4395
- * })
4396
- *
4397
- * class AppComponent {
4398
- * public position: 'top' | 'bottom' | 'both' = 'top';
4399
- *
4400
- * public data = [{
4401
- * id: 7,
4402
- * title: "Software validation, research and implementation",
4403
- * orderId: 0,
4404
- * start: new Date("2014-06-02T00:00:00.000Z"),
4405
- * end: new Date("2014-07-12T00:00:00.000Z"),
4406
- * completionRatio: 0.45708333333333334,
4407
- * isExpanded: true,
4408
- * children: [{
4409
- * id: 11,
4410
- * title: "Research",
4411
- * orderId: 1,
4412
- * start: new Date("2014-06-02T00:00:00.000Z"),
4413
- * end: new Date("2014-06-07T00:00:00.000Z"),
4414
- * completionRatio: 0.5766666666666667,
4415
- * isExpanded: true,
4416
- * children: [{
4417
- * id: 19,
4418
- * title: "Validation with Customers",
4419
- * orderId: 0,
4420
- * start: new Date("2014-06-02T00:00:00.000Z"),
4421
- * end: new Date("2014-06-04T00:00:00.000Z"),
4422
- * completionRatio: 0.25,
4423
- * isExpanded: true
4424
- * },
4425
- * {
4426
- * id: 20,
4427
- * title: "Market Research",
4428
- * orderId: 1,
4429
- * start: new Date("2014-06-02T00:00:00.000Z"),
4430
- * end: new Date("2014-06-03T02:00:00.000Z"),
4431
- * completionRatio: 0.82,
4432
- * isExpanded: true
4433
- * },
4434
- * {
4435
- * id: 39,
4436
- * title: "Functional and Technical Specification",
4437
- * orderId: 2,
4438
- * start: new Date("2014-06-04T00:00:00.000Z"),
4439
- * end: new Date("2014-06-07T00:00:00.000Z"),
4440
- * completionRatio: 0.66,
4441
- * isExpanded: true
4442
- * }]
4443
- * }]
4444
- * };
4445
- *
4446
- * public positionChange(event: MouseEvent): void {
4447
- * this.position = event.target['defaultValue'];
4448
- * }
4449
- *
4450
- * public onClick(): void {
4451
- * console.log("button was clicked");
4452
- * }
4453
- * }
4454
- *
4461
+ * ```html
4462
+ * <kendo-gantt [kendoGanttHierarchyBinding]="data" [style.height.px]="400">
4463
+ * <ng-template kendoGanttToolbarTemplate [position]="position" let-position="position">
4464
+ * <button kendoButton (click)="onClick()">Custom action</button>
4465
+ * </ng-template>
4466
+ * </kendo-gantt>
4455
4467
  * ```
4456
4468
  */
4457
4469
  class ToolbarTemplateDirective {
4458
4470
  templateRef;
4459
4471
  _position = "top";
4460
4472
  /**
4461
- * Defines the Gantt Toolbar that will use this template.
4473
+ * Sets the Gantt Toolbar that uses this template.
4462
4474
  *
4463
- * The possible values are:
4464
- * - `top`&mdash;The template will be rendered in the top toolbar (if present) only.
4465
- * - `bottom`&mdash;The template will be rendered in the bottom toolbar (if present) only.
4466
- * - `both`&mdash;The template will be rendered in both toolbars (if present).
4475
+ * Possible values:
4476
+ * - `top`&mdash;Renders the template in the top toolbar (if present) only.
4477
+ * - `bottom`&mdash;Renders the template in the bottom toolbar (if present) only.
4478
+ * - `both`&mdash;Renders the template in both toolbars (if present).
4467
4479
  */
4468
4480
  set position(position) {
4469
4481
  this._position = position;
@@ -4491,13 +4503,20 @@ i0.ɵɵngDeclareClassMetadata({ minVersion: "12.0.0", version: "16.2.12", ngImpo
4491
4503
  }] } });
4492
4504
 
4493
4505
  /**
4494
- * The base class for the timeline view components of the Gantt.
4506
+ * Serves as the base class for the timeline view components of the Gantt.
4507
+ *
4508
+ * @example
4509
+ * ```typescript
4510
+ * export class CustomTimelineViewComponent extends ViewBase {
4511
+ * public readonly type: TimelineViewType = 'custom';
4512
+ * }
4513
+ * ```
4495
4514
  */
4496
4515
  class ViewBase {
4497
4516
  optionChangesService;
4498
4517
  dependencyDomService;
4499
4518
  /**
4500
- * The width of the time slot headers. Values are treated as pixels.
4519
+ * Sets the width of the time slot headers in pixels.
4501
4520
  *
4502
4521
  * @default 100
4503
4522
  */
@@ -4508,9 +4527,8 @@ class ViewBase {
4508
4527
  timelineHeadersDateFormat;
4509
4528
  /**
4510
4529
  * Specifies the current time marker settings.
4511
- * If not set, the value is taken from the Gantt component
4530
+ * If you do not set a value, the component uses the value from the Gantt component
4512
4531
  * [`currentTimeMarker`]({% slug api_gantt_ganttcomponent %}#toc-currentTimeMarker) property.
4513
- *
4514
4532
  */
4515
4533
  currentTimeMarker;
4516
4534
  /**
@@ -5098,22 +5116,22 @@ i0.ɵɵngDeclareClassMetadata({ minVersion: "12.0.0", version: "16.2.12", ngImpo
5098
5116
  }], ctorParameters: function () { return [{ type: i0.Renderer2 }]; } });
5099
5117
 
5100
5118
  /**
5101
- * The Gantt ViewSelector component. Shows the currently active view type, and allows switching to another view type.
5119
+ * The Gantt ViewSelector component. Shows the current view type and lets you switch to another view type.
5102
5120
  */
5103
5121
  class ViewSelectorComponent {
5104
5122
  localizationService;
5105
5123
  hostClass = true;
5106
5124
  /**
5107
- * The collection of the timeline view types in the current Gantt configuration.
5125
+ * Lists the timeline view types in the current Gantt configuration.
5108
5126
  */
5109
5127
  views;
5110
5128
  /**
5111
- * The currently active view type.
5129
+ * Sets the current view type.
5112
5130
  * @default 'week'
5113
5131
  */
5114
5132
  activeView = 'week';
5115
5133
  /**
5116
- * Fires each time the user selects a different view type. The event data contains the type of the newly selected view.
5134
+ * Fires when the user selects a different view type. The event data contains the type of the new view.
5117
5135
  */
5118
5136
  activeViewChange = new EventEmitter();
5119
5137
  constructor(localizationService) {
@@ -5192,26 +5210,26 @@ i0.ɵɵngDeclareClassMetadata({ minVersion: "12.0.0", version: "16.2.12", ngImpo
5192
5210
  }] } });
5193
5211
 
5194
5212
  /**
5195
- * The UI for adding new items to the Gantt.
5196
- * Use it within a toolbar template to provide a custom icon or list of options.
5213
+ * Displays the UI for adding new items to the Gantt.
5214
+ * Use this in a toolbar template to show a custom icon or a list of options.
5197
5215
  */
5198
5216
  class GanttAddTaskComponent {
5199
5217
  localizationService;
5200
5218
  editService;
5201
5219
  ngZone;
5202
5220
  /**
5203
- * Sets the data of the DropDownButton.
5204
- * > The data has to be provided in an array-like list.
5221
+ * Sets the data for the DropDownButton.
5222
+ * Provide the data as an array-like list.
5205
5223
  */
5206
5224
  data;
5207
5225
  /**
5208
- * Defines the name of an existing icon in a Kendo UI theme.
5226
+ * Sets the name of an existing icon in a Kendo UI theme.
5209
5227
  * @default 'plus'
5210
5228
  */
5211
5229
  icon = 'plus';
5212
5230
  /**
5213
- * Defines an [`SVGIcon`](slug:api_icons_svgicon) icon to be rendered inside the `GanttAddTaskComponent` using
5214
- * a [`KendoSVGIcon`](slug:api_icons_svgiconcomponent) component.
5231
+ * Sets an [`SVGIcon`](slug:api_icons_svgicon) to render inside the `GanttAddTaskComponent` using
5232
+ * an [`SVGIconComponent`](slug:api_icons_svgiconcomponent).
5215
5233
  */
5216
5234
  svgIcon = plusIcon;
5217
5235
  constructor(localizationService, editService, ngZone) {
@@ -5960,75 +5978,58 @@ const DEFAULT_DRAG_SCROLL_SETTINGS = {
5960
5978
  threshold: 10
5961
5979
  };
5962
5980
  /**
5963
- * Represents the Kendo UI Gantt component for Angular.
5981
+ * Represents the [Kendo UI Gantt component for Angular](slug:overview_gantt).
5982
+ *
5983
+ * Use the Gantt component to display and manage project tasks and dependencies in a timeline view.
5964
5984
  *
5965
5985
  * @example
5966
- * ```ts-preview
5967
- * _@Component({
5968
- * selector: 'my-app',
5969
- * template: `
5970
- * <kendo-gantt
5971
- * [style.height.px]="500"
5972
- * [kendoGanttHierarchyBinding]="data"
5973
- * childrenField="subtasks"
5974
- * [dependencies]="dependencies">
5975
- * <kendo-gantt-column
5976
- * field="title"
5977
- * title="Task"
5978
- * [width]="200"
5979
- * [expandable]="true"></kendo-gantt-column>
5980
- * <kendo-gantt-column
5981
- * field="start"
5982
- * title="Start"
5983
- * format="dd-MMM-yyyy"
5984
- * [width]="120"></kendo-gantt-column>
5985
- * <kendo-gantt-column
5986
- * field="end"
5987
- * title="End"
5988
- * format="dd-MMM-yyyy"
5989
- * [width]="120"></kendo-gantt-column>
5990
- * <kendo-gantt-timeline-day-view></kendo-gantt-timeline-day-view>
5991
- * <kendo-gantt-timeline-week-view></kendo-gantt-timeline-week-view>
5992
- * <kendo-gantt-timeline-month-view></kendo-gantt-timeline-month-view>
5993
- * </kendo-gantt>
5994
- * `
5995
- * })
5996
- * class AppComponent {
5997
- * public data: Task[] = [{
5998
- * id: 7, title: 'Validation and R&D', start: new Date('2014-06-02T00:00:00.000Z'),
5999
- * end: new Date('2014-06-19T00:00:00.000Z'), completionRatio: 0.45708333333333334,
6000
- * subtasks: [
6001
- * { id: 18, title: 'Project Kickoff', start: new Date('2014-06-02T00:00:00.000Z'),
6002
- * end: new Date('2014-06-02T00:00:00.000Z'), completionRatio: 0.23 },
6003
- * { id: 11, title: 'Research', start: new Date('2014-06-02T00:00:00.000Z'),
6004
- * end: new Date('2014-06-07T00:00:00.000Z'), completionRatio: 0.5766666666666667,
6005
- * subtasks: [
6006
- * { id: 19, title: 'Validation', start: new Date('2014-06-02T00:00:00.000Z'),
6007
- * end: new Date('2014-06-04T00:00:00.000Z'), completionRatio: 0.25 },
6008
- * { id: 39, title: 'Specification', start: new Date('2014-06-04T00:00:00.000Z'),
6009
- * end: new Date('2014-06-07T00:00:00.000Z'), completionRatio: 0.66 }]
6010
- * }, { id: 13, title: 'Implementation', start: new Date('2014-06-08T00:00:00.000Z'),
6011
- * end: new Date('2014-06-19T00:00:00.000Z'), completionRatio: 0.77,
6012
- * subtasks: [
6013
- * { id: 24, title: 'Prototype', start: new Date('2014-06-08T00:00:00.000Z'),
6014
- * end: new Date('2014-06-14T00:00:00.000Z'), completionRatio: 0.77 },
6015
- * { id: 29, title: 'UI and Interaction', start: new Date('2014-06-14T00:00:00.000Z'),
6016
- * end: new Date('2014-06-19T00:00:00.000Z'), completionRatio: 0.6 }]
6017
- * }, { id: 17, title: 'Release', start: new Date('2014-06-19T00:00:00.000Z'),
6018
- * end: new Date('2014-06-19T00:00:00.000Z'), completionRatio: 0 }]
6019
- * }];
5986
+ * ```ts
5987
+ * import { Component } from '@angular/core';
5988
+ * import { GanttComponent, DependencyType } from '@progress/kendo-angular-gantt';
6020
5989
  *
6021
- * public dependencies: GanttDependency[] = [
6022
- * { id: 528, fromId: 18, toId: 19, type: DependencyType.FS },
6023
- * { id: 529, fromId: 19, toId: 39, type: DependencyType.FS },
6024
- * { id: 535, fromId: 24, toId: 29, type: DependencyType.FS },
6025
- * { id: 551, fromId: 13, toId: 29, type: DependencyType.FF },
6026
- * { id: 777, fromId: 7, toId: 11, type: DependencyType.SF },
6027
- * { id: 556, fromId: 39, toId: 24, type: DependencyType.FS },
6028
- * { id: 546, fromId: 29, toId: 17, type: DependencyType.FS },
6029
- * ];
5990
+ * @Component({
5991
+ * selector: 'my-app',
5992
+ * template: `
5993
+ * <kendo-gantt
5994
+ * [style.height.px]="500"
5995
+ * [kendoGanttHierarchyBinding]="data"
5996
+ * childrenField="subtasks"
5997
+ * [dependencies]="dependencies">
5998
+ * <kendo-gantt-column field="title" title="Task" [width]="200" [expandable]="true"></kendo-gantt-column>
5999
+ * <kendo-gantt-column field="start" title="Start" format="dd-MMM-yyyy" [width]="120"></kendo-gantt-column>
6000
+ * <kendo-gantt-column field="end" title="End" format="dd-MMM-yyyy" [width]="120"></kendo-gantt-column>
6001
+ * <kendo-gantt-timeline-day-view></kendo-gantt-timeline-day-view>
6002
+ * <kendo-gantt-timeline-week-view></kendo-gantt-timeline-week-view>
6003
+ * <kendo-gantt-timeline-month-view></kendo-gantt-timeline-month-view>
6004
+ * </kendo-gantt>
6005
+ * `
6006
+ * })
6007
+ * export class AppComponent {
6008
+ * public data: Task[] = [
6009
+ * {
6010
+ * id: 1,
6011
+ * title: 'Planning',
6012
+ * start: new Date('2024-01-01'),
6013
+ * end: new Date('2024-01-05'),
6014
+ * subtasks: []
6015
+ * }
6016
+ * ];
6017
+ * public dependencies = [
6018
+ * { id: 1, fromId: 1, toId: 2, type: DependencyType.FS }
6019
+ * ];
6030
6020
  * }
6031
6021
  * ```
6022
+ *
6023
+ * @remarks
6024
+ * Supported children components are:
6025
+ * {@link GanttColumnComponent},
6026
+ * {@link GanttSpanColumnComponent},
6027
+ * {@link GanttColumnGroupComponent},
6028
+ * {@link TimelineDayViewComponent},
6029
+ * {@link TimelineWeekViewComponent},
6030
+ * {@link TimelineMonthViewComponent},
6031
+ * {@link TimelineYearViewComponent},
6032
+ * {@link CustomMessagesComponent}.
6032
6033
  */
6033
6034
  class GanttComponent {
6034
6035
  timelineViewService;
@@ -6118,18 +6119,16 @@ class GanttComponent {
6118
6119
  return this._columns;
6119
6120
  }
6120
6121
  /**
6121
- * Sets the fields which will be used to extract the task data from the provided `data` array items.
6122
- * The `id` field is also used as a TreeList data item unique identifier (defaults to `'id'`).
6123
- *
6124
- * > If no object is provided, the Gantt task data items will have to conform to the [`GanttTask`]({% slug api_gantt_gantttask %}) interface.
6122
+ * Sets the fields used to extract task data from the `data` array items.
6123
+ * The `id` field is also used as a unique identifier for TreeList data items.
6124
+ * If not set, task data items must match the [`GanttTask`](slug:api_gantt_gantttask) interface.
6125
6125
  */
6126
6126
  set taskModelFields(fields) {
6127
6127
  this.mapper.taskFields = fields;
6128
6128
  }
6129
6129
  /**
6130
- * Sets the fields which will be used to extract the dependency data from the provided `dependencies` array items.
6131
- *
6132
- * > If no object is provided, the Gantt dependency data items will have to conform to the [`GanttDependency`]({% slug api_gantt_ganttdependency %}) interface.
6130
+ * Sets the fields used to extract dependency data from the `dependencies` array items.
6131
+ * If not set, dependency data items must match the [`GanttDependency`](slug:api_gantt_ganttdependency) interface.
6133
6132
  */
6134
6133
  set dependencyModelFields(fields) {
6135
6134
  this.mapper.dependencyFields = fields;
@@ -6139,7 +6138,7 @@ class GanttComponent {
6139
6138
  */
6140
6139
  views;
6141
6140
  /**
6142
- * The active timeline view.
6141
+ * Sets the active timeline view.
6143
6142
  * @default 'week'
6144
6143
  */
6145
6144
  set activeView(view) {
@@ -6168,9 +6167,8 @@ class GanttComponent {
6168
6167
  return activeViewCurrentTimeMarker || this.currentTimeMarker;
6169
6168
  }
6170
6169
  /**
6171
- * Gets or sets the data of the Gantt.
6172
- *
6173
- * > 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.
6170
+ * Gets or sets the Gantt data.
6171
+ * The task data items must match the [`GanttTask`]({% slug api_gantt_gantttask %}) interface or use [`taskModelFields`]({% slug api_gantt_ganttcomponent %}#toc-taskmodelfields).
6174
6172
  */
6175
6173
  set data(data) {
6176
6174
  this._data = normalizeGanttData(data);
@@ -6180,49 +6178,31 @@ class GanttComponent {
6180
6178
  return this._data;
6181
6179
  }
6182
6180
  /**
6183
- * Specifies a callback that determines if the given task is selected ([see example]({% slug selection_gantt %}#toc-custom-selection)).
6184
- *
6185
- * > The [`selectable`]({% slug api_gantt_ganttcomponent %}#toc-selectable) prop has to be set to `true` in order for this callback to be executed.
6181
+ * Specifies a callback to determine if a task is selected ([see example]({% slug selection_gantt %}#toc-custom-selection)).
6182
+ * Set [`selectable`]({% slug api_gantt_ganttcomponent %}#toc-selectable) to `true` to use this callback.
6186
6183
  */
6187
6184
  isSelected = isSelected;
6188
6185
  /**
6189
- * Specifies a callback that determines if a new dependency is valid.
6190
- * Used when evaluating if an attempt to create a new dependency will result in a valid link between the two tasks
6191
- * [see example]({% slug editing_drag_create_dependencies_gantt %}#toc-validation).
6192
- *
6193
- * By defalut, dependencies are deemed invalid when:
6194
- * - The two tasks are in a parent-child relationship.
6195
- * - The two tasks are already dependent on one another. Only one dependency is allowed per pair.
6196
- * - The start or end times of the two tasks are incompatible with the attempted dependency type.
6186
+ * Specifies a callback to validate new dependencies.
6187
+ * Use this callback to control the valid dependencies that users can create ([see example]({% slug editing_drag_create_dependencies_gantt %}#toc-validation)).
6197
6188
  */
6198
6189
  validateNewDependency = this.defaultValidateNewDependencyCallback.bind(this);
6199
6190
  /**
6200
- * Fires when the Gantt selection is changed through user interaction.
6201
- *
6202
- * Holds data about the affected [`items`]({% slug api_gantt_selectionchangeevent %}#toc-items) and the attempted [`action`]({% slug api_gantt_selectionchangeevent %}#toc-action):
6203
- * - `select` - Triggered on `click` or `ctrl + click` on deselected items.
6204
- * - `remove` - Triggered on `ctrl + click` on selected items.
6191
+ * Fires when the Gantt selection changes through user interaction.
6192
+ * The event data contains the affected items and the action type.
6205
6193
  */
6206
6194
  selectionChange = new EventEmitter();
6207
6195
  /**
6208
- * Enables or disables the Gantt selection mechanism ([see example]({% slug selection_gantt %}#toc-custom-selection)).
6209
- *
6196
+ * Enables or disables selection in the Gantt ([see example]({% slug selection_gantt %}#toc-custom-selection)).
6197
+ * Set to `true` to allow selection.
6210
6198
  * > When set to `true`, the [`isSelected`]({% slug api_gantt_ganttcomponent %}#toc-isselected) callback has to be provided.
6211
6199
  * > When applied, the [`SelectableDirective`]({% slug api_gantt_selectabledirective %}) sets `selectable` to `true` internally.
6200
+ * @default false
6212
6201
  */
6213
6202
  selectable = false;
6214
6203
  /**
6215
- * The toolbar configuration. Defines the position and content of the toolbar(s).
6216
- * The available properties are `position`, `addTaskTool`, and `viewSelectorTool`.
6217
- * All are optional and default to `top`.
6218
- *
6219
- * The possible values for each option are:
6220
- * - `top`&mdash;Positions the toolbar above the Gantt panes. Renders the respective tool in the top toolbar.
6221
- * - `bottom`&mdash;Positions the toolbar below the Gantt panes. Renders the respective tool in the bottom toolbar.
6222
- * - `both`&mdash;Displays two toolbar instances. Positions the first one above,
6223
- * and the second one - below the Gantt panes. Renders the respective tool in the both toolbars.
6224
- * - `none`&mdash;No toolbar is rendered when used for setting `position`.
6225
- * No add task or view selector tool is rendered when used for setting `addTaskTool` or `viewSelectorTool`.
6204
+ * Configures the toolbar position and content.
6205
+ * Set `position`, `addTaskTool`, and `viewSelectorTool` as needed.
6226
6206
  */
6227
6207
  set toolbarSettings(value) {
6228
6208
  this._toolbarSettings = {
@@ -6235,12 +6215,13 @@ class GanttComponent {
6235
6215
  return this._toolbarSettings;
6236
6216
  }
6237
6217
  /**
6238
- * Allows setting the toolbar(s) `aria-label` attribute value as necessary to comply with accessibility requirements.
6239
- * Typically, toolbars need an `aria-label` when there is more than one toolbar in the application.
6218
+ * Sets the `aria-label` attribute value for the toolbar.
6219
+ * Use this to improve accessibility.
6220
+ * @default "Toolbar"
6240
6221
  */
6241
6222
  toolbarAriaLabel = 'Toolbar';
6242
6223
  /**
6243
- * Gets or sets the callback function that retrieves the child items for a particular item.
6224
+ * Sets the callback function to retrieve child items for a data item.
6244
6225
  */
6245
6226
  set fetchChildren(fn) {
6246
6227
  this._fetchChildren = fn;
@@ -6250,7 +6231,7 @@ class GanttComponent {
6250
6231
  return this._fetchChildren;
6251
6232
  }
6252
6233
  /**
6253
- * Gets or sets the callback function that indicates if a particular item has child items.
6234
+ * Sets the callback function to indicate if a data item has child items.
6254
6235
  */
6255
6236
  set hasChildren(fn) {
6256
6237
  this._hasChildren = fn;
@@ -6260,58 +6241,56 @@ class GanttComponent {
6260
6241
  return this._hasChildren;
6261
6242
  }
6262
6243
  /**
6263
- * Defines the dependencies that will be drawn between the rendered tasks.
6264
- *
6265
- * > 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.
6244
+ * Sets the dependencies to display between tasks.
6245
+ * Dependency data items must match the [`GanttDependency`]({% slug api_gantt_ganttdependency %}) interface or use [`dependencyModelFields`]({% slug api_gantt_ganttcomponent %}#toc-dependencymodelfields).
6266
6246
  */
6267
6247
  dependencies = [];
6268
6248
  /**
6269
- * Enables the sorting of the Gantt columns that have their `field` option set.
6249
+ * Enables sorting for columns with a `field` option.
6270
6250
  */
6271
6251
  sortable = false;
6272
6252
  /**
6273
- * The descriptors by which the data will be sorted.
6253
+ * Sets the descriptors for sorting the data.
6274
6254
  */
6275
6255
  sort = [];
6276
6256
  /**
6277
- * Enables the filtering of the Gantt columns that have their `field` option set.
6278
- *
6257
+ * Enables filtering for columns with a `field` option.
6279
6258
  * @default false
6280
6259
  */
6281
6260
  filterable = false;
6282
6261
  /**
6283
- * The descriptor by which the data will be filtered.
6262
+ * Sets the descriptor for filtering the data.
6284
6263
  */
6285
6264
  filter;
6286
6265
  /**
6287
- * The start time of the work day.
6288
- * Accepts string values in the `HH:mm` format.
6266
+ * Sets the start time of the work day in `HH:mm` format.
6267
+ * @default "08:00"
6289
6268
  */
6290
6269
  workDayStart = '08:00';
6291
6270
  /**
6292
- * The end time of the work day.
6293
- * Accepts string values in the `HH:mm` format.
6271
+ * Sets the end time of the work day in `HH:mm` format.
6272
+ * @default "17:00"
6294
6273
  */
6295
6274
  workDayEnd = '17:00';
6296
6275
  /**
6297
- * The start of the work week (index based).
6276
+ * Sets the start day of the work week (index based).
6277
+ * @default 1
6298
6278
  */
6299
6279
  workWeekStart = 1;
6300
6280
  /**
6301
- * The end of the work week (index based).
6281
+ * Sets the end day of the work week (index based).
6282
+ * @default 5
6302
6283
  */
6303
6284
  workWeekEnd = 5;
6304
6285
  /**
6305
- * When `true`, the user can use dedicated shortcuts to interact with the Gantt.
6306
- * By default, navigation is enabled for the TreeList and Timeline parts of the component,
6307
- * ([see example]({% slug keyboard_navigation_gantt %})).
6308
- *
6286
+ * Enables keyboard navigation for the Gantt.
6287
+ * By default, navigation is enabled for the TreeList and Timeline parts of the component ([see example]({% slug keyboard_navigation_gantt %})).
6309
6288
  * @default true
6310
6289
  */
6311
6290
  navigable = true;
6312
6291
  /**
6313
- * The options of the timeline splitter pane. By default the pane is `collapsible`,
6314
- * `resizable`, not `collapsed`, and its `size` is `'50%'`.
6292
+ * Sets the options for the timeline splitter pane.
6293
+ * By default, the pane is collapsible, resizable, not collapsed, and its size is `'50%'`.
6315
6294
  */
6316
6295
  set timelinePaneOptions(value) {
6317
6296
  if (this._timelinePaneOptions.collapsed && !value.collapsed) {
@@ -6323,8 +6302,8 @@ class GanttComponent {
6323
6302
  return { ...this._timelinePaneOptions, size: this.treeListPaneOptions.collapsed ? '100%' : this._timelinePaneOptions.size };
6324
6303
  }
6325
6304
  /**
6326
- * The options of the treelist splitter pane.
6327
- * By default the pane is `collapsible` and not `collapsed`.
6305
+ * Sets the options for the treelist splitter pane.
6306
+ * By default the pane is collapsible and not collapsed.
6328
6307
  */
6329
6308
  set treeListPaneOptions(value) {
6330
6309
  this._treeListPaneOptions = { ...DEFAULT_TREELIST_PANE_SETTINGS, ...value };
@@ -6333,8 +6312,8 @@ class GanttComponent {
6333
6312
  return this._treeListPaneOptions;
6334
6313
  }
6335
6314
  /**
6336
- * Defines a function that is executed for every task in the component.
6337
- * The classes returned from the function are applied to the task wrapper element.
6315
+ * Sets a function to apply custom CSS classes to each task.
6316
+ * The function receives the task data item.
6338
6317
  */
6339
6318
  set taskClass(fn) {
6340
6319
  if (isDevMode() && typeof fn !== 'function') {
@@ -6346,7 +6325,8 @@ class GanttComponent {
6346
6325
  return this._taskClass;
6347
6326
  }
6348
6327
  /**
6349
- * Defines a function that is executed for every data row in the component.
6328
+ * Sets a function to apply custom CSS classes to each data row.
6329
+ * The function receives the row data item.
6350
6330
  */
6351
6331
  set rowClass(fn) {
6352
6332
  if (isDevMode() && typeof fn !== 'function') {
@@ -6358,54 +6338,45 @@ class GanttComponent {
6358
6338
  return this._rowClass;
6359
6339
  }
6360
6340
  /**
6361
- * The name of the field which contains the unique identifier of the task data item.
6362
- * Defaults to 'id'.
6341
+ * Gets the name of the field that contains the unique identifier for task data items.
6342
+ * @default "id"
6363
6343
  */
6364
6344
  get taskIdField() {
6365
6345
  return this.mapper.taskFields.id;
6366
6346
  }
6367
6347
  /**
6368
- * Sets the callback function that indicates if a particular item is expanded.
6369
- * If no callback is set, all items will be expanded and no expand icons will be rendered.
6348
+ * Sets a callback function to indicate if a data item is expanded.
6349
+ * If not set, all items are expanded and no expand icons are shown.
6370
6350
  */
6371
6351
  isExpanded;
6372
6352
  /**
6373
- * Indicates whether the Gantt columns will be resized during initialization so that they fit their headers and row content.
6374
- * Columns with autoSize set to false are excluded.
6375
- *
6353
+ * Enables automatic resizing of columns to fit their content.
6376
6354
  * @default false
6377
6355
  */
6378
6356
  columnsAutoSize = false;
6379
6357
  /**
6380
- * Specifies the Gantt current time marker settings.
6381
- * The settings will be applied for all views.
6382
- * If the `currentTimeMarker` is set for a view then it takes precedence.
6383
- *
6358
+ * Sets the current time marker settings for the Gantt.
6359
+ * Applies to all views unless overridden by the settings of a particular view.
6384
6360
  * @default true
6385
6361
  */
6386
6362
  currentTimeMarker = true;
6387
6363
  /**
6388
- * Specifies if the column menu of the columns will be displayed.
6389
- *
6364
+ * Enables the column menu for all columns.
6390
6365
  * @default false
6391
6366
  */
6392
6367
  columnMenu = false;
6393
6368
  /**
6394
- * If set to true, the user can reorder columns by dragging their header cells.
6395
- *
6369
+ * Enables reordering of the columns by dragging their header cells.
6396
6370
  * @default false
6397
6371
  */
6398
6372
  columnsReorderable = false;
6399
6373
  /**
6400
- * If set to true, the user can resize columns by dragging the edges (resize handles) of their header cells.
6401
- *
6374
+ * Enables resizing of the columns by dragging the header cell edges (resize handles).
6402
6375
  * @default false
6403
6376
  */
6404
6377
  columnsResizable = false;
6405
6378
  /**
6406
- * Specifies the settings for auto-scrolling during dragging
6407
- * when the pointer moves outside of the container bounderies
6408
- * [see example]({% slug editing_drag_create_dependencies_gantt %}#toc-auto-scrolling).
6379
+ * 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)).
6409
6380
  */
6410
6381
  set dragScrollSettings(settings) {
6411
6382
  this._dragScrollSettings = { ...DEFAULT_DRAG_SCROLL_SETTINGS, ...settings };
@@ -6414,8 +6385,7 @@ class GanttComponent {
6414
6385
  return this._dragScrollSettings;
6415
6386
  }
6416
6387
  /**
6417
- * Allows setting the task tooltip `position`, `callout`, and `showAfter` options.
6418
- *
6388
+ * Sets the options for the task tooltip, such as `position`, `callout`, and `showAfter`.
6419
6389
  * @default { position: 'top', callout: true, showAfter: 100 }
6420
6390
  */
6421
6391
  taskTooltipOptions = {
@@ -6424,30 +6394,30 @@ class GanttComponent {
6424
6394
  showAfter: 100
6425
6395
  };
6426
6396
  /**
6427
- * Fires when an item is expanded.
6397
+ * Fires when a row is expanded.
6428
6398
  */
6429
6399
  rowExpand = new EventEmitter();
6430
6400
  /**
6431
- * Fires when a Gantt task in the timeline pane is double-clicked. The data item, associated with the clicked task,
6432
- * is available in the event data. Use the event handler to open a task editing dialog as necessary.
6401
+ * Fires when a Gantt task in the timeline pane is double-clicked.
6402
+ * The event data contains the clicked task. Use this event to open a task editing dialog if needed.
6433
6403
  */
6434
6404
  taskDblClick = new EventEmitter();
6435
6405
  /**
6436
- * Fires when the user double clicks a cell.
6406
+ * Fires when a cell is double-clicked.
6437
6407
  */
6438
6408
  cellDblClick = new EventEmitter();
6439
6409
  /**
6440
- * Fires when the user leaves an edited cell.
6410
+ * Fires when an edited cell is closed.
6441
6411
  */
6442
6412
  cellClose = new EventEmitter();
6443
6413
  /**
6444
- * Fires when the end user clicks the `Delete` button in the task editing dialog,
6445
- * the task delete icon, or presses the `Delete` key on the keyboard when a task in the timeline is focused.
6446
- * Use the event handler to open a confirmation dialog when necessary.
6414
+ * Fires when the user clicks the `Delete` button in the task editing dialog,
6415
+ * the task delete icon, or presses the `Delete` key on a focused task.
6416
+ * Use this event to open a confirmation dialog if needed.
6447
6417
  */
6448
6418
  taskDelete = new EventEmitter();
6449
6419
  /**
6450
- * Fires when an item is collapsed.
6420
+ * Fires when a row is collapsed.
6451
6421
  */
6452
6422
  rowCollapse = new EventEmitter();
6453
6423
  /**
@@ -6467,50 +6437,50 @@ class GanttComponent {
6467
6437
  */
6468
6438
  taskAdd = new EventEmitter();
6469
6439
  /**
6470
- * Fires when the user adds a dependency via dragging
6471
- * [see example]({% slug editing_drag_create_dependencies_gantt %}#toc-basic-concepts).
6440
+ * Fires when the user adds a dependency by dragging [see example]({% slug editing_drag_create_dependencies_gantt %}#toc-basic-concepts).
6472
6441
  */
6473
6442
  dependencyAdd = new EventEmitter();
6474
6443
  /**
6475
- * Fires when the sorting of the Gantt is changed.
6476
- * You have to handle the event yourself and sort the data.
6444
+ * Fires when there are changes in the Gantt sorting.
6445
+ * Handle this event to sort the data.
6477
6446
  */
6478
6447
  sortChange = new EventEmitter();
6479
6448
  /**
6480
- * Fires when the Gantt filter is modified.
6481
- * You have to handle the event yourself and filter the data.
6449
+ * Fires when there are changes in the Gantt filtering.
6450
+ * Handle this event to filter the data.
6482
6451
  */
6483
6452
  filterChange = new EventEmitter();
6484
6453
  /**
6485
- * Fires when the filter or sort state of the Gantt is changed.
6454
+ * Fires when the filter or sort state changes.
6486
6455
  */
6487
6456
  dataStateChange = new EventEmitter();
6488
6457
  /**
6489
- * Fires when the collapsed state of the treelist pane is changed.
6458
+ * Fires when the collapsed state of the treelist pane changes.
6490
6459
  */
6491
6460
  treeListPaneCollapsedChange = new EventEmitter();
6492
6461
  /**
6493
- * Fires when the collapsed state of the timeline pane is changed.
6462
+ * Fires when the collapsed state of the timeline pane changes.
6494
6463
  */
6495
6464
  timelinePaneCollapsedChange = new EventEmitter();
6496
6465
  /**
6497
- * Fires each time the user resizes the timeline pane.
6466
+ * Fires when the user resizes the timeline pane.
6498
6467
  */
6499
6468
  timelinePaneSizeChange = new EventEmitter();
6500
6469
  /**
6501
- * Fires each time the user selects a different view type. The event data contains the type of the newly selected view.
6470
+ * Fires when the user selects a different view type.
6471
+ * The event data contains the type of the new view.
6502
6472
  */
6503
6473
  activeViewChange = new EventEmitter();
6504
6474
  /**
6505
- * Fires when the user completes the resizing of the column.
6475
+ * Fires when the user completes resizing a column.
6506
6476
  */
6507
6477
  columnResize = new EventEmitter();
6508
6478
  /**
6509
- * Fires when the user completes the reordering of the column.
6479
+ * Fires when the user completes reordering a column.
6510
6480
  */
6511
6481
  columnReorder = new EventEmitter();
6512
6482
  /**
6513
- * Fires when the user changes the visibility of the columns from the column menu or column chooser.
6483
+ * Fires when the user changes column visibility from the column menu or chooser.
6514
6484
  */
6515
6485
  columnVisibilityChange = new EventEmitter();
6516
6486
  /**
@@ -6770,8 +6740,7 @@ class GanttComponent {
6770
6740
  }
6771
6741
  /**
6772
6742
  * Focuses the last active cell or task in the Gantt.
6773
- * If no item has previously been focused, the first cell of the TreeList part will receive focus,
6774
- * ([see example]({% slug keyboard_navigation_gantt %}#toc-controlling-the-focus)).
6743
+ * If no item was previously focused, focuses the first TreeList cell ([see example]({% slug keyboard_navigation_gantt %}#toc-controlling-the-focus)).
6775
6744
  */
6776
6745
  focus() {
6777
6746
  if (this.navigable) {
@@ -6779,8 +6748,9 @@ class GanttComponent {
6779
6748
  }
6780
6749
  }
6781
6750
  /**
6782
- * Focuses the targeted cell in the TreeList part of the component,
6783
- * ([see example]({% slug keyboard_navigation_gantt %}#toc-controlling-the-focus)).
6751
+ * Focuses the specified cell in the TreeList ([see example]({% slug keyboard_navigation_gantt %}#toc-controlling-the-focus)).
6752
+ * @param rowIndex The row index.
6753
+ * @param colIndex The column index.
6784
6754
  */
6785
6755
  focusCell(rowIndex, colIndex) {
6786
6756
  if (this.navigable) {
@@ -6788,8 +6758,8 @@ class GanttComponent {
6788
6758
  }
6789
6759
  }
6790
6760
  /**
6791
- * Focuses the targeted task in the Timeline part of the component,
6792
- * ([see example]({% slug keyboard_navigation_gantt %}#toc-controlling-the-focus)).
6761
+ * Focuses the specified task in the Timeline ([see example]({% slug keyboard_navigation_gantt %}#toc-controlling-the-focus)).
6762
+ * @param taskIndex The index of the task.
6793
6763
  */
6794
6764
  focusTask(taskIndex) {
6795
6765
  if (this.navigable) {
@@ -6797,10 +6767,9 @@ class GanttComponent {
6797
6767
  }
6798
6768
  }
6799
6769
  /**
6800
- * Applies the minimum possible width for the specified column,
6801
- * so that the whole text fits without wrapping. This method expects the Gantt
6802
- * to be resizable (set `resizable` to `true`).
6803
- * Makes sense to execute this method only after the Gantt is already populated with data.
6770
+ * Sets the minimum width for the specified column so that its content fits.
6771
+ * The Gantt must be resizable.
6772
+ * @param column The column to auto-fit.
6804
6773
  */
6805
6774
  autoFitColumn(column) {
6806
6775
  if (isPresent(this.treeList)) {
@@ -6808,10 +6777,10 @@ class GanttComponent {
6808
6777
  }
6809
6778
  }
6810
6779
  /**
6811
- * Adjusts the width of the specified columns to fit the entire content, including headers, without wrapping.
6812
- * If no columns are specified, `autoFitColumns` is applied to all columns.
6813
- *
6814
- * This method requires the Gantt to be resizable (set `resizable` to `true`).
6780
+ * Adjusts the width of the specified columns to fit their content.
6781
+ * If no columns are specified, fits all columns.
6782
+ * The Gantt must be resizable to use this method.
6783
+ * @param columns The columns to auto-fit.
6815
6784
  */
6816
6785
  autoFitColumns(columns = this.columns) {
6817
6786
  if (isPresent(this.treeList)) {
@@ -6819,7 +6788,9 @@ class GanttComponent {
6819
6788
  }
6820
6789
  }
6821
6790
  /**
6822
- * Clears the already loaded children for the dataItem so that the Gantt will fetch them again the next time it is rendered.
6791
+ * Clears loaded children for the data item so the Gantt fetches them again.
6792
+ * @param dataItem The data item to reload.
6793
+ * @param reloadChildren Whether to reload children.
6823
6794
  */
6824
6795
  reload(dataItem, reloadChildren) {
6825
6796
  if (isPresent(this.treeList)) {
@@ -6828,14 +6799,10 @@ class GanttComponent {
6828
6799
  }
6829
6800
  /**
6830
6801
  * Changes the position of the specified column.
6831
- * The reordering of columns operates only on the level
6832
- * which is inferred by the source column.
6833
- * For the `reorderColumn` method to work properly,
6834
- * the `source` column has to be visible.
6835
- *
6836
- * @param {ColumnBase} source - The column whose position will be changed.
6837
- * @param {number} destIndex - The new position of the column.
6838
- * @param {ColumnReorderConfig} options - Additional options.
6802
+ * The source column must be visible.
6803
+ * @param source The column to move.
6804
+ * @param destIndex The new position index.
6805
+ * @param options Additional options.
6839
6806
  */
6840
6807
  reorderColumn(source, destIndex, options = { before: false }) {
6841
6808
  if (isPresent(this.treeList)) {
@@ -6843,10 +6810,8 @@ class GanttComponent {
6843
6810
  }
6844
6811
  }
6845
6812
  /**
6846
- * Forces the TreeList to evaluate if some data items have changed and re-renders the rows information, if needed.
6847
- * Recalculates and re-renders the Timeline period, if needed.
6848
- * Redraws changed dependencies, if needed.
6849
- * Executes all row-related callbacks anew.
6813
+ * Forces the Gantt to re-evaluate data items and re-render the rows and Timeline period, if needed.
6814
+ * Also redraws dependencies and executes row-related callbacks.
6850
6815
  */
6851
6816
  updateView() {
6852
6817
  if (isPresent(this.treeList)) {
@@ -6856,7 +6821,9 @@ class GanttComponent {
6856
6821
  this.dependencyDomService.notifyChanges();
6857
6822
  }
6858
6823
  /**
6859
- * Opens the task editing dialog.
6824
+ * Opens the task editing dialog for the specified data item.
6825
+ * @param dataItem The task data item.
6826
+ * @param formGroup The form group for editing.
6860
6827
  */
6861
6828
  editTask(dataItem, formGroup) {
6862
6829
  if (!this.showEditingDialog) {
@@ -6891,12 +6858,15 @@ class GanttComponent {
6891
6858
  }
6892
6859
  /**
6893
6860
  * Opens a cell for editing.
6861
+ * @param dataItem The data item.
6862
+ * @param column The column index, name, or object.
6863
+ * @param formGroup The form group for editing.
6894
6864
  */
6895
6865
  editCell(dataItem, column, formGroup) {
6896
6866
  this.treeList.editCell(dataItem, column, formGroup);
6897
6867
  }
6898
6868
  /**
6899
- * Closes an edited cell.
6869
+ * Closes the currently edited cell.
6900
6870
  */
6901
6871
  closeCell() {
6902
6872
  this.treeList.closeCell();
@@ -7552,10 +7522,10 @@ class GanttComponent {
7552
7522
 
7553
7523
  i18n-columnsReset="kendo.gantt.columnsReset|The text shown in the column menu or column chooser for the columns reset button"
7554
7524
  columnsReset="Reset"
7555
-
7525
+
7556
7526
  i18n-tooltipStartDateText="kendo.gantt.tooltipStartDateText|The text shown in the task tooltip before the task start date"
7557
7527
  tooltipStartDateText="Start"
7558
-
7528
+
7559
7529
  i18n-tooltipEndDateText="kendo.gantt.tooltipEndDateText|The text shown in the task tooltip before the task end date"
7560
7530
  tooltipEndDateText="End"></ng-container>
7561
7531
  <kendo-gantt-toolbar
@@ -7968,10 +7938,10 @@ i0.ɵɵngDeclareClassMetadata({ minVersion: "12.0.0", version: "16.2.12", ngImpo
7968
7938
 
7969
7939
  i18n-columnsReset="kendo.gantt.columnsReset|The text shown in the column menu or column chooser for the columns reset button"
7970
7940
  columnsReset="Reset"
7971
-
7941
+
7972
7942
  i18n-tooltipStartDateText="kendo.gantt.tooltipStartDateText|The text shown in the task tooltip before the task start date"
7973
7943
  tooltipStartDateText="Start"
7974
-
7944
+
7975
7945
  i18n-tooltipEndDateText="kendo.gantt.tooltipEndDateText|The text shown in the task tooltip before the task end date"
7976
7946
  tooltipEndDateText="End"></ng-container>
7977
7947
  <kendo-gantt-toolbar
@@ -8320,14 +8290,26 @@ i0.ɵɵngDeclareClassMetadata({ minVersion: "12.0.0", version: "16.2.12", ngImpo
8320
8290
  }] } });
8321
8291
 
8322
8292
  /**
8323
- * A directive which binds the Gantt to an array of objects by using
8324
- * an ID and parent ID field to define the hierarchy.
8293
+ * Binds the Gantt to an array of objects by using an ID and parent ID field to define the hierarchy.
8294
+ *
8295
+ * Use this directive to handle in-memory data operations such as sorting and filtering. [See example](slug:directives_databinding_gantt#binding-to-flat-data).
8296
+ *
8297
+ * @example
8298
+ * ```html
8299
+ * <kendo-gantt
8300
+ * [kendoGanttFlatBinding]="data"
8301
+ * parentIdField="parentTaskId"
8302
+ * idField="id"
8303
+ * [dependencies]="dependencies">
8304
+ * </kendo-gantt>
8305
+ * ```
8325
8306
  *
8326
- * The directive encapsulates the in-memory handling of data operations such as sorting and filtering.
8307
+ * @remarks
8308
+ * Applied to: {@link GanttComponent}
8327
8309
  */
8328
8310
  class GanttFlatBindingDirective extends FlatBindingDirective {
8329
8311
  /**
8330
- * The array of data which will be used to populate the Gantt.
8312
+ * Sets the array of data to populate the Gantt.
8331
8313
  */
8332
8314
  data;
8333
8315
  /**
@@ -8352,12 +8334,25 @@ i0.ɵɵngDeclareClassMetadata({ minVersion: "12.0.0", version: "16.2.12", ngImpo
8352
8334
  }] } });
8353
8335
 
8354
8336
  /**
8355
- * A directive which binds the Gantt to a tree of objects,
8356
- * which encapsulates the in-memory handling of data operations such as sorting and filtering.
8337
+ * Binds the Gantt to a tree of objects.
8338
+ *
8339
+ * Use this directive to handle in-memory data operations such as sorting and filtering. [See example](slug:directives_databinding_gantt#binding-to-hierarchical-data).
8340
+ *
8341
+ * @example
8342
+ * ```html
8343
+ * <kendo-gantt
8344
+ * [kendoGanttHierarchyBinding]="data"
8345
+ * childrenField="subtasks"
8346
+ * [dependencies]="dependencies">
8347
+ * </kendo-gantt>
8348
+ * ```
8349
+ *
8350
+ * @remarks
8351
+ * Applied to: {@link GanttComponent}
8357
8352
  */
8358
8353
  class GanttHierarchyBindingDirective extends HierarchyBindingDirective {
8359
8354
  /**
8360
- * The array of data which will be used to populate the Gantt.
8355
+ * Sets the array of data to populate the Gantt.
8361
8356
  */
8362
8357
  data;
8363
8358
  /**
@@ -8382,14 +8377,20 @@ i0.ɵɵngDeclareClassMetadata({ minVersion: "12.0.0", version: "16.2.12", ngImpo
8382
8377
  }] } });
8383
8378
 
8384
8379
  /**
8385
- * A directive which controls the expanded state of the items.
8380
+ * Represents a directive that controls the expanded state of Gantt items.
8381
+ *
8382
+ * @example
8383
+ * ```html
8384
+ * <kendo-gantt kendoGanttExpandable [expandedKeys]="expandedKeys"></kendo-gantt>
8385
+ * ```
8386
+ *
8387
+ * @remarks
8388
+ * Applied to: {@link GanttComponent}
8386
8389
  */
8387
8390
  class GanttExpandableDirective extends ExpandableDirective {
8388
8391
  /**
8389
- * Defines the item key that will be stored in the expandedKeys collection.
8390
- * Defaults to the task data item ID field,
8391
- * which is specified in the [`taskModelFields`]({% slug api_gantt_ganttcomponent %}#toc-taskmodelfields) object.
8392
- *
8392
+ * Sets the item key stored in the `expandedKeys` collection.
8393
+ * The default value is the task data item ID field, specified in the `taskModelFields` object.
8393
8394
  */
8394
8395
  set expandBy(value) {
8395
8396
  super.expandBy = value;
@@ -8473,28 +8474,19 @@ i0.ɵɵngDeclareClassMetadata({ minVersion: "12.0.0", version: "16.2.12", ngImpo
8473
8474
  }]
8474
8475
  }] });
8475
8476
 
8476
- /**
8477
- * When added to the .k-task-dot, the element will be kept with hover styles.
8478
- * Used for the drag clue from which the dragging has started.
8479
- */
8480
8477
  const DRAG_CLUE_HOVER_CLASS = 'k-hover';
8481
- /**
8482
- * Add the selection disabling class to the enitre container.
8483
- * Otherwise existing selection on a given task text prevents dragging the clue even if the clue has `user-select: none` styles.
8484
- */
8485
8478
  const USER_SELECT_NONE_CLASS = 'k-user-select-none';
8486
- /**
8487
- * When added to the .k-task-wrap, the containing .k-task-dot elements will be kept visible even when not hovered.
8488
- * Used for the drag clue from which the dragging has started.
8489
- */
8490
8479
  const TASK_WRAPPER_DRAG_CLASS = 'k-origin';
8491
- /**
8492
- * Use 20px margin between the pointer and the popup.
8493
- * Could be made user-configurable if there's demand.
8494
- */
8495
8480
  const DEFAULT_POPUP_VERTICAL_MARGIN = 20;
8496
8481
  /**
8497
- * A directive which enables the creation of new dependencies via dragging.
8482
+ * Enables creating new dependencies by dragging.
8483
+ *
8484
+ * ```html
8485
+ * <kendo-gantt kendoGanttDependencyDragCreate></kendo-gantt>
8486
+ * ```
8487
+ *
8488
+ * @remarks
8489
+ * Applied to: {@link GanttComponent}
8498
8490
  */
8499
8491
  class DependencyDragCreateDirective {
8500
8492
  gantt;
@@ -8504,7 +8496,7 @@ class DependencyDragCreateDirective {
8504
8496
  popupService;
8505
8497
  timelineScrollService;
8506
8498
  /**
8507
- * Specifies whether the validation tooltip will be displayed during drag operations.
8499
+ * Shows the validation tooltip during drag operations.
8508
8500
  *
8509
8501
  * @default true
8510
8502
  */
@@ -8802,11 +8794,16 @@ i0.ɵɵngDeclareClassMetadata({ minVersion: "12.0.0", version: "16.2.12", ngImpo
8802
8794
  }] } });
8803
8795
 
8804
8796
  /**
8805
- * The Gantt timeline day view component.
8797
+ * Represents the Gantt timeline day view component.
8798
+ *
8799
+ * @example
8800
+ * ```html
8801
+ * <kendo-gantt-timeline-day-view></kendo-gantt-timeline-day-view>
8802
+ * ```
8806
8803
  */
8807
8804
  class TimelineDayViewComponent extends ViewBase {
8808
8805
  /**
8809
- * The type for this view (`day`).
8806
+ * Specifies the type for this view (`day`).
8810
8807
  */
8811
8808
  type = 'day';
8812
8809
  constructor(optionChangesService, dependencyDomService) {
@@ -8836,11 +8833,16 @@ i0.ɵɵngDeclareClassMetadata({ minVersion: "12.0.0", version: "16.2.12", ngImpo
8836
8833
  }], ctorParameters: function () { return [{ type: OptionChangesService }, { type: DependencyDomService }]; } });
8837
8834
 
8838
8835
  /**
8839
- * The Gantt timeline week view component.
8836
+ * Represents the Gantt timeline week view component.
8837
+ *
8838
+ * @example
8839
+ * ```html
8840
+ * <kendo-gantt-timeline-week-view></kendo-gantt-timeline-week-view>
8841
+ * ```
8840
8842
  */
8841
8843
  class TimelineWeekViewComponent extends ViewBase {
8842
8844
  /**
8843
- * The type for this view (`week`).
8845
+ * Specifies the type for this view (`week`).
8844
8846
  */
8845
8847
  type = 'week';
8846
8848
  constructor(optionChangesService, dependencyDomService) {
@@ -8870,11 +8872,16 @@ i0.ɵɵngDeclareClassMetadata({ minVersion: "12.0.0", version: "16.2.12", ngImpo
8870
8872
  }], ctorParameters: function () { return [{ type: OptionChangesService }, { type: DependencyDomService }]; } });
8871
8873
 
8872
8874
  /**
8873
- * The Gantt timeline month view component.
8875
+ * Represents the Gantt timeline month view component.
8876
+ *
8877
+ * @example
8878
+ * ```html
8879
+ * <kendo-gantt-timeline-month-view></kendo-gantt-timeline-month-view>
8880
+ * ```
8874
8881
  */
8875
8882
  class TimelineMonthViewComponent extends ViewBase {
8876
8883
  /**
8877
- * The type for this view (`month`).
8884
+ * Specifies the type for this view (`month`).
8878
8885
  */
8879
8886
  type = 'month';
8880
8887
  constructor(optionChangesService, dependencyDomService) {
@@ -8904,11 +8911,16 @@ i0.ɵɵngDeclareClassMetadata({ minVersion: "12.0.0", version: "16.2.12", ngImpo
8904
8911
  }], ctorParameters: function () { return [{ type: OptionChangesService }, { type: DependencyDomService }]; } });
8905
8912
 
8906
8913
  /**
8907
- * The Gantt timeline year view component.
8914
+ * Represents the Gantt timeline year view component.
8915
+ *
8916
+ * @example
8917
+ * ```html
8918
+ * <kendo-gantt-timeline-year-view></kendo-gantt-timeline-year-view>
8919
+ * ```
8908
8920
  */
8909
8921
  class TimelineYearViewComponent extends ViewBase {
8910
8922
  /**
8911
- * The type for this view (`year`).
8923
+ * Specifies the type for this view (`year`).
8912
8924
  */
8913
8925
  type = 'year';
8914
8926
  constructor(optionChangesService, dependencyDomService) {
@@ -8938,8 +8950,16 @@ i0.ɵɵngDeclareClassMetadata({ minVersion: "12.0.0", version: "16.2.12", ngImpo
8938
8950
  }], ctorParameters: function () { return [{ type: OptionChangesService }, { type: DependencyDomService }]; } });
8939
8951
 
8940
8952
  /**
8941
- * A directive which handles the [`selectionChange`]({% slug api_gantt_ganttcomponent %}#toc-selectionchange) event of the Gantt
8942
- * ([see example]({% slug selection_gantt %}#toc-built-in-directive))
8953
+ * Handles the [`selectionChange`]({% slug api_gantt_ganttcomponent %}#toc-selectionchange) event of the Gantt component.
8954
+ * ([See example]({% slug selection_gantt %}#toc-built-in-directive)).
8955
+ *
8956
+ * @example
8957
+ * ```html
8958
+ * <kendo-gantt kendoGanttSelectable [(selectedKeys)]="selectedKeys"></kendo-gantt>
8959
+ * ```
8960
+ *
8961
+ * @remarks
8962
+ * Applied to: {@link GanttComponent}
8943
8963
  */
8944
8964
  class SelectableDirective {
8945
8965
  gantt;
@@ -8971,12 +8991,12 @@ class SelectableDirective {
8971
8991
  this.gantt.updateView();
8972
8992
  }
8973
8993
  /**
8974
- * Fires when the selected keys are changed.
8994
+ * Emits when the selected keys change.
8975
8995
  */
8976
8996
  selectedKeysChange = new EventEmitter();
8977
8997
  /**
8978
- * The field name or a function that specifies the data item unique key identifier.
8979
- * By default, the string field `id` is used.
8998
+ * Sets the field name or function that identifies the unique key for a data item.
8999
+ * Uses the string field `id` by default.
8980
9000
  */
8981
9001
  set itemKey(value) {
8982
9002
  if (isString(value)) {
@@ -9047,8 +9067,16 @@ i0.ɵɵngDeclareClassMetadata({ minVersion: "12.0.0", version: "16.2.12", ngImpo
9047
9067
  }] } });
9048
9068
 
9049
9069
  /**
9050
- * Custom component messages override default component messages
9051
- * ([see example](slug:globalization_treelist#toc-custom-messages)).
9070
+ * Represents the custom messages component for the Kendo UI for Angular Gantt.
9071
+ * Use this component to override default messages.
9072
+ *
9073
+ * @example
9074
+ * ```html
9075
+ * <kendo-gantt-messages
9076
+ * addTaskText="Add Task"
9077
+ * cancelButtonText="Cancel">
9078
+ * </kendo-gantt-messages>
9079
+ * ```
9052
9080
  */
9053
9081
  class CustomMessagesComponent extends Messages {
9054
9082
  service;
@@ -9082,15 +9110,28 @@ i0.ɵɵngDeclareClassMetadata({ minVersion: "12.0.0", version: "16.2.12", ngImpo
9082
9110
  }]
9083
9111
  }], ctorParameters: function () { return [{ type: i1$1.LocalizationService }]; } });
9084
9112
 
9113
+ /**
9114
+ * Represents the Gantt task drag directive.
9115
+ *
9116
+ * Use this directive to enable dragging of tasks in the Gantt. The directive listens and emits events with information about the dragged task.
9117
+ *
9118
+ * @example
9119
+ * ```html
9120
+ * <kendo-gantt [data]="tasks" kendoGanttTaskDrag (taskDrag)="onTaskDrag($event)" (taskDragEnd)="onTaskDragEnd($event)">
9121
+ * </kendo-gantt>
9122
+ * ```
9123
+ *
9124
+ * @remarks
9125
+ * Applied to: {@link GanttComponent}
9126
+ */
9085
9127
  class TaskDragDirective {
9086
9128
  /**
9087
- * Emitted while the end user is resizing or moving a task through dragging.
9129
+ * Emits while the user resizes or moves a task by dragging.
9088
9130
  */
9089
9131
  taskDrag = new EventEmitter();
9090
9132
  /**
9091
- * Triggered when the dragging action associated with resizing or moving an event is finished.
9092
- * The event data contains all necessary information to update the task and all related tasks
9093
- * accordingly.
9133
+ * Fires when the user finishes dragging to resize or move a task.
9134
+ * The event data gives you all information needed to update the task and related tasks.
9094
9135
  */
9095
9136
  taskDragEnd = new EventEmitter();
9096
9137
  subs = new Subscription();
@@ -9148,7 +9189,7 @@ i0.ɵɵngDeclareClassMetadata({ minVersion: "12.0.0", version: "16.2.12", ngImpo
9148
9189
  }] } });
9149
9190
 
9150
9191
  /**
9151
- * Utility array that contains all `@progress/kendo-angular-gantt` related components and directives
9192
+ * Use the `KENDO_GANTT` utility array to import all Kendo UI for Angular Gantt components and directives to a standalone Angular component.
9152
9193
  */
9153
9194
  const KENDO_GANTT = [
9154
9195
  GanttComponent,
@@ -9184,34 +9225,23 @@ const KENDO_GANTT = [
9184
9225
 
9185
9226
  // IMPORTANT: NgModule export kept for backwards compatibility
9186
9227
  /**
9187
- * Represents the [NgModule](link:site.data.urls.angular['ngmoduleapi'])
9188
- * definition for the Gantt component.
9228
+ * Represents the [`NgModule`](link:site.data.urls.angular['ngmoduleapi']) definition for the Gantt component.
9189
9229
  *
9190
- * @example
9230
+ * Use this module to include the Gantt component in your NgModule-based application.
9191
9231
  *
9192
- * ```ts-no-run
9193
- * // Import the Gantt module
9232
+ * @example
9233
+ * ```typescript
9194
9234
  * import { GanttModule } from '@progress/kendo-angular-gantt';
9195
- *
9196
- * // The browser platform with a compiler
9197
- * import { platformBrowserDynamic } from '@angular/platform-browser-dynamic';
9198
- *
9199
9235
  * import { NgModule } from '@angular/core';
9200
- *
9201
- * // Import the app component
9236
+ * import { BrowserModule } from '@angular/platform-browser';
9202
9237
  * import { AppComponent } from './app.component';
9203
9238
  *
9204
- * // Define the app module
9205
- * _@NgModule({
9206
- * declarations: [AppComponent], // declare app component
9207
- * imports: [BrowserModule, GanttModule], // import Gantt module
9208
- * bootstrap: [AppComponent]
9239
+ * @NgModule({
9240
+ * declarations: [AppComponent],
9241
+ * imports: [BrowserModule, GanttModule],
9242
+ * bootstrap: [AppComponent]
9209
9243
  * })
9210
9244
  * export class AppModule {}
9211
- *
9212
- * // Compile and launch the module
9213
- * platformBrowserDynamic().bootstrapModule(AppModule);
9214
- *
9215
9245
  * ```
9216
9246
  */
9217
9247
  class GanttModule {