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

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
@@ -5,14 +5,26 @@
5
5
  import { FlatBindingDirective } from '@progress/kendo-angular-treelist';
6
6
  import * as i0 from "@angular/core";
7
7
  /**
8
- * A directive which binds the Gantt to an array of objects by using
9
- * an ID and parent ID field to define the hierarchy.
8
+ * Binds the Gantt to an array of objects by using an ID and parent ID field to define the hierarchy.
10
9
  *
11
- * The directive encapsulates the in-memory handling of data operations such as sorting and filtering.
10
+ * Use this directive to handle in-memory data operations such as sorting and filtering. [See example](slug:directives_databinding_gantt#binding-to-flat-data).
11
+ *
12
+ * @example
13
+ * ```html
14
+ * <kendo-gantt
15
+ * [kendoGanttFlatBinding]="data"
16
+ * parentIdField="parentTaskId"
17
+ * idField="id"
18
+ * [dependencies]="dependencies">
19
+ * </kendo-gantt>
20
+ * ```
21
+ *
22
+ * @remarks
23
+ * Applied to: {@link GanttComponent}
12
24
  */
13
25
  export declare class GanttFlatBindingDirective extends FlatBindingDirective {
14
26
  /**
15
- * The array of data which will be used to populate the Gantt.
27
+ * Sets the array of data to populate the Gantt.
16
28
  */
17
29
  data: any[];
18
30
  /**
@@ -5,12 +5,25 @@
5
5
  import { HierarchyBindingDirective } from '@progress/kendo-angular-treelist';
6
6
  import * as i0 from "@angular/core";
7
7
  /**
8
- * A directive which binds the Gantt to a tree of objects,
9
- * which encapsulates the in-memory handling of data operations such as sorting and filtering.
8
+ * Binds the Gantt to a tree of objects.
9
+ *
10
+ * Use this directive to handle in-memory data operations such as sorting and filtering. [See example](slug:directives_databinding_gantt#binding-to-hierarchical-data).
11
+ *
12
+ * @example
13
+ * ```html
14
+ * <kendo-gantt
15
+ * [kendoGanttHierarchyBinding]="data"
16
+ * childrenField="subtasks"
17
+ * [dependencies]="dependencies">
18
+ * </kendo-gantt>
19
+ * ```
20
+ *
21
+ * @remarks
22
+ * Applied to: {@link GanttComponent}
10
23
  */
11
24
  export declare class GanttHierarchyBindingDirective extends HierarchyBindingDirective {
12
25
  /**
13
- * The array of data which will be used to populate the Gantt.
26
+ * Sets the array of data to populate the Gantt.
14
27
  */
15
28
  data: any[];
16
29
  /**
@@ -5,20 +5,28 @@
5
5
  import { TemplateRef } from '@angular/core';
6
6
  import * as i0 from "@angular/core";
7
7
  /**
8
- * Represents the column cell template of the Gantt.
9
- * Helps to customize the content of the cells. To define the cell template, nest an `<ng-template>` tag
10
- * with the `kendoGanttCellTemplate` directive inside the respective column tag.
8
+ * Customizes the content of Gantt column cells. Place an `<ng-template>` tag
9
+ * with the `kendoGanttCellTemplate` directive inside a `<kendo-gantt-column>` tag to define the cell template.
11
10
  *
12
- * The template context is set to the current data item and the following additional fields are passed:
13
- * - `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`.
14
- * - `columnIndex`&mdash;The current column index. Use it as an alias for a template variable by utilizing the `let-columnIndex="columnIndex"` syntax.
15
- * - `column`&mdash;The current column instance. Use it as an alias for a template variable by utilizing the `let-column="column"` syntax.
16
- * - `cellContext`&mdash;An object used to pass context information to built-in directives.
17
- * - `hasChildren`&mdash;Specifies if the item has children.
18
- * - `isExpanded`&mdash;Specifies if the item is expanded.
11
+ * The template context provides these fields:
12
+ * - `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`.
13
+ * - `columnIndex`&mdash;The current column index. Use it as a template variable with the `let-columnIndex="columnIndex"` syntax.
14
+ * - `column`&mdash;The current column instance. Use it as a template variable with the `let-column="column"` syntax.
15
+ * - `cellContext`&mdash;An object for passing context information to built-in directives.
16
+ * - `hasChildren`&mdash;Indicates if the item has children.
17
+ * - `isExpanded`&mdash;Indicates if the item is expanded.
19
18
  * - `level`&mdash;The hierarchy level of the item.
20
- * - `loading`&mdash;Specifies if the item children are currently loading.
21
- * - `rowIndex`&mdash;The current row index. Use it as an alias for a template variable by utilizing the `let-rowIndex="rowIndex"` syntax.
19
+ * - `loading`&mdash;Indicates if the item children are loading.
20
+ * - `rowIndex`&mdash;The current row index. Use it as a template variable with the `let-rowIndex="rowIndex"` syntax.
21
+ *
22
+ * @example
23
+ * ```html
24
+ * <kendo-gantt-column field="title">
25
+ * <ng-template kendoGanttCellTemplate let-dataItem>
26
+ * <strong>{{ dataItem.title }}</strong>
27
+ * </ng-template>
28
+ * </kendo-gantt-column>
29
+ * ```
22
30
  */
23
31
  export declare class CellTemplateDirective {
24
32
  templateRef: TemplateRef<any>;
@@ -5,7 +5,8 @@
5
5
  import { ColumnBase } from '@progress/kendo-angular-treelist';
6
6
  import * as i0 from "@angular/core";
7
7
  /**
8
- * The base class for the column components of the Gantt.
8
+ * Serves as the base class for Gantt column components.
9
+ *
9
10
  */
10
11
  export declare class GanttColumnBase extends ColumnBase {
11
12
  static ɵfac: i0.ɵɵFactoryDeclaration<GanttColumnBase, never>;
@@ -8,6 +8,20 @@ import { OptionChangesService } from '../common/option-changes.service';
8
8
  import { GanttColumnBase } from './column-base.component';
9
9
  import { HeaderTemplateDirective } from './header-template.directive';
10
10
  import * as i0 from "@angular/core";
11
+ /**
12
+ * Represents a group of columns in the Gantt. Use this component to organize columns under a common header.
13
+ *
14
+ * @example
15
+ * ```html
16
+ * <kendo-gantt-column-group title="Details">
17
+ * <kendo-gantt-column field="start"></kendo-gantt-column>
18
+ * <kendo-gantt-column field="end"></kendo-gantt-column>
19
+ * </kendo-gantt-column-group>
20
+ * ```
21
+ *
22
+ * @remarks
23
+ * Supported children components are: {@link GanttColumnComponent}, {@link GanttSpanColumnComponent}.
24
+ */
11
25
  export declare class GanttColumnGroupComponent extends ColumnGroupComponent {
12
26
  private options;
13
27
  /**
@@ -5,14 +5,21 @@
5
5
  import { TemplateRef } from '@angular/core';
6
6
  import * as i0 from "@angular/core";
7
7
  /**
8
- * Represents the template for the column menu in the Gantt. Provides an option for
9
- * customizing the content of the column menu for all or for specific columns.
10
- * To define the content template, nest an `<ng-template>` tag with the
11
- * `kendoGanttColumnMenuTemplate` directive inside the `<kendo-gantt-column>` component.
8
+ * Customizes the column menu content in the Gantt. Place an `<ng-template>` tag with the
9
+ * `kendoGanttColumnMenuTemplate` directive inside a `<kendo-gantt-column>` component to define the template.
12
10
  *
13
- * The column menu service and the current column are available as context variables:
14
- * - `service`&mdash;Represents the ColumnMenuService.
15
- * - `column`&mdash;Represents the Gantt column.
11
+ * The template context provides the following fields:
12
+ * - `service`&mdash;The `ColumnMenuService` instance.
13
+ * - `column`&mdash;The Gantt column instance.
14
+ *
15
+ * @example
16
+ * ```html
17
+ * <kendo-gantt-column>
18
+ * <ng-template kendoGanttColumnMenuTemplate let-service="service" let-column="column">
19
+ * <button (click)="service.close()">Close Menu</button>
20
+ * </ng-template>
21
+ * </kendo-gantt-column>
22
+ * ```
16
23
  */
17
24
  export declare class ColumnMenuTemplateDirective {
18
25
  templateRef: TemplateRef<any>;
@@ -15,6 +15,14 @@ import { HeaderTemplateDirective } from './header-template.directive';
15
15
  import { CellContentType } from '../models/cell-content-type.interface';
16
16
  import { EditTemplateDirective } from './edit-template.directive';
17
17
  import * as i0 from "@angular/core";
18
+ /**
19
+ * Represents a column in the Gantt. Use this component to define columns and customize their behavior and appearance.
20
+ *
21
+ * @example
22
+ * ```html
23
+ * <kendo-gantt-column field="title" title="Task"></kendo-gantt-column>
24
+ * ```
25
+ */
18
26
  export declare class GanttColumnComponent extends ColumnComponent {
19
27
  private options;
20
28
  headerTemplates: QueryList<HeaderTemplateDirective>;
@@ -25,11 +33,13 @@ export declare class GanttColumnComponent extends ColumnComponent {
25
33
  filterCellTemplate: FilterCellTemplateDirective;
26
34
  filterMenuTemplate: FilterMenuTemplateDirective;
27
35
  /**
28
- * Defines the filter type that is displayed inside the filter row. The default value is `text`.
36
+ * Sets the filter type for the filter row. The default value is `text`.
37
+ * @default 'text'
29
38
  */
30
39
  filter: CellContentType;
31
40
  /**
32
- * Defines if a filter UI will be displayed for this column. The default value is `true`.
41
+ * Shows or hides the filter UI for this column. The default value is `true`.
42
+ * @default true
33
43
  */
34
44
  filterable: boolean;
35
45
  /**
@@ -5,18 +5,27 @@
5
5
  import { TemplateRef } from '@angular/core';
6
6
  import * as i0 from "@angular/core";
7
7
  /**
8
- * Represents the column edit-cell template of the Gantt.
9
- * Helps to customize the content of the edited cells. To define the cell template, nest an `<ng-template>`
8
+ * Represents the column template for edited cells in the Gantt.
9
+ *
10
+ * Use this directive to customize the content of edited cells. To define the cell template, nest an `<ng-template>`
10
11
  * tag with the `kendoGanttEditTemplate` directive inside a `<kendo-gantt-column>` tag.
11
12
  *
12
- * The template context contains the following fields:
13
+ * The template context provides the following fields:
13
14
  * - `column`&mdash;The current column instance.
14
15
  * - `dataItem`&mdash;The current data item.
15
- * - `cellContext`&mdash;An object used to pass context information to built-in directives.
16
- * - `formGroup`&mdash;The current [`FormGroup`](link:site.data.urls.angular['formgroupapi']).
17
- * If you use the Gantt inside [Template-Driven Forms](link:site.data.urls.angular['forms']), it will be `undefined`.
16
+ * - `cellContext`&mdash;An object for passing context information to built-in directives.
17
+ * - `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`.
18
18
  * - `isNew`&mdash;The state of the current item.
19
19
  * - `rowIndex`&mdash;The current row index. If inside a new item row, `rowIndex` is `-1`.
20
+ *
21
+ * @example
22
+ * ```html
23
+ * <kendo-gantt-column>
24
+ * <ng-template kendoGanttEditTemplate let-dataItem="dataItem" let-formGroup="formGroup">
25
+ * <input [formControl]="formGroup.get('field')" />
26
+ * </ng-template>
27
+ * </kendo-gantt-column>
28
+ * ```
20
29
  */
21
30
  export declare class EditTemplateDirective {
22
31
  templateRef: TemplateRef<any>;
@@ -5,12 +5,22 @@
5
5
  import { TemplateRef } from '@angular/core';
6
6
  import * as i0 from "@angular/core";
7
7
  /**
8
- * Represents the filter-menu template.
8
+ * Represents the filter-menu template for the Gantt column.
9
9
  *
10
- * The column, current filter and the filter service are available as context variables:
11
- * - `column`&mdash;The current column instance. Use it as an alias for a template variable by utilizing the `let-column="column"` syntax.
10
+ * Use this directive to customize the filter menu for a column.
11
+ * The template context provides:
12
+ * - `column`&mdash;The current column instance. Use as an alias for a template variable with the `let-column="column"` syntax.
12
13
  * - `filter`&mdash;The filter descriptor.
13
- * - `cellContext`&mdash;An object used to pass context information to built-in directives.
14
+ * - `cellContext`&mdash;An object for passing context information to built-in directives.
15
+ *
16
+ * @example
17
+ * ```html
18
+ * <kendo-gantt-column>
19
+ * <ng-template kendoGanttFilterMenuTemplate let-column let-filter="filter">
20
+ * Custom filter for {{ column.field }}
21
+ * </ng-template>
22
+ * </kendo-gantt-column>
23
+ * ```
14
24
  */
15
25
  export declare class FilterMenuTemplateDirective {
16
26
  templateRef: TemplateRef<any>;
@@ -5,16 +5,25 @@
5
5
  import { TemplateRef } from '@angular/core';
6
6
  import * as i0 from "@angular/core";
7
7
  /**
8
- * Represents the column footer cell template of the Gantt.
8
+ * Represents the footer cell template of the Gantt columns.
9
9
  *
10
- * Helps to customize the table footer cell for the column.
10
+ * Use this directive to customize the table footer cell for a column.
11
11
  * To define a footer template, nest an `<ng-template>` tag with the
12
12
  * [`kendoGanttFooterTemplate`]({% slug api_gantt_footertemplatedirective %}) directive inside the `<kendo-gantt-column>` tag.
13
13
  *
14
- * The current column, column index and field are available as context variables:
15
- * * `column`&mdash;Points to the instance of the current [`ColumnComponent`]({% slug api_gantt_ganttcolumncomponent %}).
16
- * * `columnIndex`&mdash;Defines the current column index.
14
+ * The template context provides:
15
+ * * `column`&mdash;The current [`ColumnComponent`]({% slug api_gantt_ganttcolumncomponent %}).
16
+ * * `columnIndex`&mdash;The current column index.
17
17
  * * `field`&mdash;The name of the column field, if set.
18
+ *
19
+ * @example
20
+ * ```html
21
+ * <kendo-gantt-column>
22
+ * <ng-template kendoGanttFooterTemplate let-column let-columnIndex="columnIndex" let-field="field">
23
+ * Footer for {{ field }}
24
+ * </ng-template>
25
+ * </kendo-gantt-column>
26
+ * ```
18
27
  */
19
28
  export declare class FooterTemplateDirective {
20
29
  templateRef: TemplateRef<any>;
@@ -5,14 +5,24 @@
5
5
  import { TemplateRef } from '@angular/core';
6
6
  import * as i0 from "@angular/core";
7
7
  /**
8
- * Represents the column header cell template of the Gantt.
9
- * Helps to customize the table header cell for the column.
8
+ * Represents the header cell template of the Gantt columns.
9
+ *
10
+ * Use this directive to customize the table header cell for a column.
10
11
  * To define a header template, nest an `<ng-template>` tag with the
11
12
  * [`kendoGanttHeaderTemplate`]({% slug api_gantt_headertemplatedirective %}) directive inside the `<kendo-gantt-column>` tag.
12
13
  *
13
- * The current column and column index are available as context variables:
14
- * * `column`&mdash;Points to the instance of the current [`ColumnComponent`]({% slug api_gantt_ganttcolumncomponent %}).
15
- * * `columnIndex`&mdash;Defines the current column index.
14
+ * The template context provides:
15
+ * * `column`&mdash;The current [`ColumnComponent`]({% slug api_gantt_ganttcolumncomponent %}).
16
+ * * `columnIndex`&mdash;The current column index.
17
+ *
18
+ * @example
19
+ * ```html
20
+ * <kendo-gantt-column>
21
+ * <ng-template kendoGanttHeaderTemplate let-column let-columnIndex="columnIndex">
22
+ * Custom Header for {{ column.field }} ({{ columnIndex }})
23
+ * </ng-template>
24
+ * </kendo-gantt-column>
25
+ * ```
16
26
  */
17
27
  export declare class HeaderTemplateDirective {
18
28
  templateRef: TemplateRef<any>;
@@ -10,6 +10,22 @@ import { GanttColumnBase } from './column-base.component';
10
10
  import { GanttColumnComponent } from './column.component';
11
11
  import { EditTemplateDirective } from './edit-template.directive';
12
12
  import * as i0 from "@angular/core";
13
+ /**
14
+ * Represents the Gantt span column.
15
+ *
16
+ * Use this component to span row content over multiple column cells.
17
+ *
18
+ * @example
19
+ * ```html
20
+ * <kendo-gantt-span-column>
21
+ * <kendo-gantt-column field="id"></kendo-gantt-column>
22
+ * <kendo-gantt-column field="name"></kendo-gantt-column>
23
+ * </kendo-gantt-span-column>
24
+ * ```
25
+ *
26
+ * @remarks
27
+ * Supported children components are: {@link GanttColumnComponent}.
28
+ */
13
29
  export declare class GanttSpanColumnComponent extends SpanColumnComponent {
14
30
  private options;
15
31
  /**
package/directives.d.ts CHANGED
@@ -26,6 +26,6 @@ import { ToolbarTemplateDirective } from "./toolbar/toolbar-template.directive";
26
26
  import { TaskDragDirective } from "./dragging/task-drag.directive";
27
27
  import { GanttTaskTooltipTemplateDirective } from "./template-directives/task-tooltip-template.directive";
28
28
  /**
29
- * Utility array that contains all `@progress/kendo-angular-gantt` related components and directives
29
+ * Use the `KENDO_GANTT` utility array to import all Kendo UI for Angular Gantt components and directives to a standalone Angular component.
30
30
  */
31
31
  export declare const KENDO_GANTT: readonly [typeof GanttComponent, typeof GanttFlatBindingDirective, typeof GanttHierarchyBindingDirective, typeof GanttTaskContentTemplateDirective, typeof GanttTaskTemplateDirective, typeof GanttSummaryTaskTemplateDirective, typeof ToolbarTemplateDirective, typeof ViewSelectorComponent, typeof GanttColumnComponent, typeof GanttColumnGroupComponent, typeof GanttSpanColumnComponent, typeof FilterCellTemplateDirective, typeof FilterMenuTemplateDirective, typeof CellTemplateDirective, typeof EditTemplateDirective, typeof ColumnMenuTemplateDirective, typeof HeaderTemplateDirective, typeof FooterTemplateDirective, typeof GanttExpandableDirective, typeof DependencyDragCreateDirective, typeof TimelineDayViewComponent, typeof TimelineWeekViewComponent, typeof TimelineMonthViewComponent, typeof TimelineYearViewComponent, typeof SelectableDirective, typeof CustomMessagesComponent, typeof GanttAddTaskComponent, typeof TaskDragDirective, typeof GanttTaskTooltipTemplateDirective];
@@ -9,7 +9,14 @@ import { MappingService } from '../common/mapping.service';
9
9
  import { TimelineScrollService } from '../scrolling/timeline-scroll.service';
10
10
  import * as i0 from "@angular/core";
11
11
  /**
12
- * A directive which enables the creation of new dependencies via dragging.
12
+ * Enables creating new dependencies by dragging.
13
+ *
14
+ * ```html
15
+ * <kendo-gantt kendoGanttDependencyDragCreate></kendo-gantt>
16
+ * ```
17
+ *
18
+ * @remarks
19
+ * Applied to: {@link GanttComponent}
13
20
  */
14
21
  export declare class DependencyDragCreateDirective implements AfterViewInit, OnDestroy {
15
22
  private gantt;
@@ -19,7 +26,7 @@ export declare class DependencyDragCreateDirective implements AfterViewInit, OnD
19
26
  private popupService;
20
27
  private timelineScrollService;
21
28
  /**
22
- * Specifies whether the validation tooltip will be displayed during drag operations.
29
+ * Shows the validation tooltip during drag operations.
23
30
  *
24
31
  * @default true
25
32
  */
@@ -10,15 +10,28 @@ import { TaskDragEvent } from '../models/events';
10
10
  import { MappingService } from '../common/mapping.service';
11
11
  import * as i0 from "@angular/core";
12
12
  import * as i1 from "@progress/kendo-angular-utils";
13
+ /**
14
+ * Represents the Gantt task drag directive.
15
+ *
16
+ * Use this directive to enable dragging of tasks in the Gantt. The directive listens and emits events with information about the dragged task.
17
+ *
18
+ * @example
19
+ * ```html
20
+ * <kendo-gantt [data]="tasks" kendoGanttTaskDrag (taskDrag)="onTaskDrag($event)" (taskDragEnd)="onTaskDragEnd($event)">
21
+ * </kendo-gantt>
22
+ * ```
23
+ *
24
+ * @remarks
25
+ * Applied to: {@link GanttComponent}
26
+ */
13
27
  export declare class TaskDragDirective {
14
28
  /**
15
- * Emitted while the end user is resizing or moving a task through dragging.
29
+ * Emits while the user resizes or moves a task by dragging.
16
30
  */
17
31
  taskDrag: EventEmitter<TaskDragEvent>;
18
32
  /**
19
- * Triggered when the dragging action associated with resizing or moving an event is finished.
20
- * The event data contains all necessary information to update the task and all related tasks
21
- * accordingly.
33
+ * Fires when the user finishes dragging to resize or move a task.
34
+ * The event data gives you all information needed to update the task and related tasks.
22
35
  */
23
36
  taskDragEnd: EventEmitter<TaskDragEvent>;
24
37
  private subs;
@@ -9,26 +9,26 @@ import { EditService } from './edit.service';
9
9
  import { SVGIcon } from '@progress/kendo-svg-icons';
10
10
  import * as i0 from "@angular/core";
11
11
  /**
12
- * The UI for adding new items to the Gantt.
13
- * Use it within a toolbar template to provide a custom icon or list of options.
12
+ * Displays the UI for adding new items to the Gantt.
13
+ * Use this in a toolbar template to show a custom icon or a list of options.
14
14
  */
15
15
  export declare class GanttAddTaskComponent {
16
16
  private localizationService;
17
17
  private editService;
18
18
  private ngZone;
19
19
  /**
20
- * Sets the data of the DropDownButton.
21
- * > The data has to be provided in an array-like list.
20
+ * Sets the data for the DropDownButton.
21
+ * Provide the data as an array-like list.
22
22
  */
23
23
  data: GanttAddTaskActionItem[];
24
24
  /**
25
- * Defines the name of an existing icon in a Kendo UI theme.
25
+ * Sets the name of an existing icon in a Kendo UI theme.
26
26
  * @default 'plus'
27
27
  */
28
28
  icon: string;
29
29
  /**
30
- * Defines an [`SVGIcon`](slug:api_icons_svgicon) icon to be rendered inside the `GanttAddTaskComponent` using
31
- * a [`KendoSVGIcon`](slug:api_icons_svgiconcomponent) component.
30
+ * Sets an [`SVGIcon`](slug:api_icons_svgicon) to render inside the `GanttAddTaskComponent` using
31
+ * an [`SVGIconComponent`](slug:api_icons_svgiconcomponent).
32
32
  */
33
33
  svgIcon: SVGIcon;
34
34
  constructor(localizationService: LocalizationService, editService: EditService, ngZone: NgZone);
@@ -6,14 +6,26 @@ import { Directive, Input } from '@angular/core';
6
6
  import { FlatBindingDirective } from '@progress/kendo-angular-treelist';
7
7
  import * as i0 from "@angular/core";
8
8
  /**
9
- * A directive which binds the Gantt to an array of objects by using
10
- * an ID and parent ID field to define the hierarchy.
9
+ * Binds the Gantt to an array of objects by using an ID and parent ID field to define the hierarchy.
11
10
  *
12
- * The directive encapsulates the in-memory handling of data operations such as sorting and filtering.
11
+ * Use this directive to handle in-memory data operations such as sorting and filtering. [See example](slug:directives_databinding_gantt#binding-to-flat-data).
12
+ *
13
+ * @example
14
+ * ```html
15
+ * <kendo-gantt
16
+ * [kendoGanttFlatBinding]="data"
17
+ * parentIdField="parentTaskId"
18
+ * idField="id"
19
+ * [dependencies]="dependencies">
20
+ * </kendo-gantt>
21
+ * ```
22
+ *
23
+ * @remarks
24
+ * Applied to: {@link GanttComponent}
13
25
  */
14
26
  export class GanttFlatBindingDirective extends FlatBindingDirective {
15
27
  /**
16
- * The array of data which will be used to populate the Gantt.
28
+ * Sets the array of data to populate the Gantt.
17
29
  */
18
30
  data;
19
31
  /**
@@ -6,12 +6,25 @@ import { Directive, Input } from '@angular/core';
6
6
  import { HierarchyBindingDirective } from '@progress/kendo-angular-treelist';
7
7
  import * as i0 from "@angular/core";
8
8
  /**
9
- * A directive which binds the Gantt to a tree of objects,
10
- * which encapsulates the in-memory handling of data operations such as sorting and filtering.
9
+ * Binds the Gantt to a tree of objects.
10
+ *
11
+ * Use this directive to handle in-memory data operations such as sorting and filtering. [See example](slug:directives_databinding_gantt#binding-to-hierarchical-data).
12
+ *
13
+ * @example
14
+ * ```html
15
+ * <kendo-gantt
16
+ * [kendoGanttHierarchyBinding]="data"
17
+ * childrenField="subtasks"
18
+ * [dependencies]="dependencies">
19
+ * </kendo-gantt>
20
+ * ```
21
+ *
22
+ * @remarks
23
+ * Applied to: {@link GanttComponent}
11
24
  */
12
25
  export class GanttHierarchyBindingDirective extends HierarchyBindingDirective {
13
26
  /**
14
- * The array of data which will be used to populate the Gantt.
27
+ * Sets the array of data to populate the Gantt.
15
28
  */
16
29
  data;
17
30
  /**
@@ -5,20 +5,28 @@
5
5
  import { Directive, TemplateRef, Optional } from '@angular/core';
6
6
  import * as i0 from "@angular/core";
7
7
  /**
8
- * Represents the column cell template of the Gantt.
9
- * Helps to customize the content of the cells. To define the cell template, nest an `<ng-template>` tag
10
- * with the `kendoGanttCellTemplate` directive inside the respective column tag.
8
+ * Customizes the content of Gantt column cells. Place an `<ng-template>` tag
9
+ * with the `kendoGanttCellTemplate` directive inside a `<kendo-gantt-column>` tag to define the cell template.
11
10
  *
12
- * The template context is set to the current data item and the following additional fields are passed:
13
- * - `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`.
14
- * - `columnIndex`&mdash;The current column index. Use it as an alias for a template variable by utilizing the `let-columnIndex="columnIndex"` syntax.
15
- * - `column`&mdash;The current column instance. Use it as an alias for a template variable by utilizing the `let-column="column"` syntax.
16
- * - `cellContext`&mdash;An object used to pass context information to built-in directives.
17
- * - `hasChildren`&mdash;Specifies if the item has children.
18
- * - `isExpanded`&mdash;Specifies if the item is expanded.
11
+ * The template context provides these fields:
12
+ * - `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`.
13
+ * - `columnIndex`&mdash;The current column index. Use it as a template variable with the `let-columnIndex="columnIndex"` syntax.
14
+ * - `column`&mdash;The current column instance. Use it as a template variable with the `let-column="column"` syntax.
15
+ * - `cellContext`&mdash;An object for passing context information to built-in directives.
16
+ * - `hasChildren`&mdash;Indicates if the item has children.
17
+ * - `isExpanded`&mdash;Indicates if the item is expanded.
19
18
  * - `level`&mdash;The hierarchy level of the item.
20
- * - `loading`&mdash;Specifies if the item children are currently loading.
21
- * - `rowIndex`&mdash;The current row index. Use it as an alias for a template variable by utilizing the `let-rowIndex="rowIndex"` syntax.
19
+ * - `loading`&mdash;Indicates if the item children are loading.
20
+ * - `rowIndex`&mdash;The current row index. Use it as a template variable with the `let-rowIndex="rowIndex"` syntax.
21
+ *
22
+ * @example
23
+ * ```html
24
+ * <kendo-gantt-column field="title">
25
+ * <ng-template kendoGanttCellTemplate let-dataItem>
26
+ * <strong>{{ dataItem.title }}</strong>
27
+ * </ng-template>
28
+ * </kendo-gantt-column>
29
+ * ```
22
30
  */
23
31
  export class CellTemplateDirective {
24
32
  templateRef;
@@ -6,7 +6,8 @@ import { Component } from '@angular/core';
6
6
  import { ColumnBase } from '@progress/kendo-angular-treelist';
7
7
  import * as i0 from "@angular/core";
8
8
  /**
9
- * The base class for the column components of the Gantt.
9
+ * Serves as the base class for Gantt column components.
10
+ *
10
11
  */
11
12
  export class GanttColumnBase extends ColumnBase {
12
13
  static ɵfac = i0.ɵɵngDeclareFactory({ minVersion: "12.0.0", version: "16.2.12", ngImport: i0, type: GanttColumnBase, deps: null, target: i0.ɵɵFactoryTarget.Component });
@@ -10,6 +10,20 @@ import { HeaderTemplateDirective } from './header-template.directive';
10
10
  import * as i0 from "@angular/core";
11
11
  import * as i1 from "../common/option-changes.service";
12
12
  import * as i2 from "./column-base.component";
13
+ /**
14
+ * Represents a group of columns in the Gantt. Use this component to organize columns under a common header.
15
+ *
16
+ * @example
17
+ * ```html
18
+ * <kendo-gantt-column-group title="Details">
19
+ * <kendo-gantt-column field="start"></kendo-gantt-column>
20
+ * <kendo-gantt-column field="end"></kendo-gantt-column>
21
+ * </kendo-gantt-column-group>
22
+ * ```
23
+ *
24
+ * @remarks
25
+ * Supported children components are: {@link GanttColumnComponent}, {@link GanttSpanColumnComponent}.
26
+ */
13
27
  export class GanttColumnGroupComponent extends ColumnGroupComponent {
14
28
  options;
15
29
  /**
@@ -5,14 +5,21 @@
5
5
  import { Directive, Optional, TemplateRef } from '@angular/core';
6
6
  import * as i0 from "@angular/core";
7
7
  /**
8
- * Represents the template for the column menu in the Gantt. Provides an option for
9
- * customizing the content of the column menu for all or for specific columns.
10
- * To define the content template, nest an `<ng-template>` tag with the
11
- * `kendoGanttColumnMenuTemplate` directive inside the `<kendo-gantt-column>` component.
8
+ * Customizes the column menu content in the Gantt. Place an `<ng-template>` tag with the
9
+ * `kendoGanttColumnMenuTemplate` directive inside a `<kendo-gantt-column>` component to define the template.
12
10
  *
13
- * The column menu service and the current column are available as context variables:
14
- * - `service`&mdash;Represents the ColumnMenuService.
15
- * - `column`&mdash;Represents the Gantt column.
11
+ * The template context provides the following fields:
12
+ * - `service`&mdash;The `ColumnMenuService` instance.
13
+ * - `column`&mdash;The Gantt column instance.
14
+ *
15
+ * @example
16
+ * ```html
17
+ * <kendo-gantt-column>
18
+ * <ng-template kendoGanttColumnMenuTemplate let-service="service" let-column="column">
19
+ * <button (click)="service.close()">Close Menu</button>
20
+ * </ng-template>
21
+ * </kendo-gantt-column>
22
+ * ```
16
23
  */
17
24
  export class ColumnMenuTemplateDirective {
18
25
  templateRef;