@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
@@ -43,34 +43,23 @@ import * as i28 from "./dragging/task-drag.directive";
43
43
  import * as i29 from "./template-directives/task-tooltip-template.directive";
44
44
  // IMPORTANT: NgModule export kept for backwards compatibility
45
45
  /**
46
- * Represents the [NgModule](link:site.data.urls.angular['ngmoduleapi'])
47
- * definition for the Gantt component.
46
+ * Represents the [`NgModule`](link:site.data.urls.angular['ngmoduleapi']) definition for the Gantt component.
48
47
  *
49
- * @example
48
+ * Use this module to include the Gantt component in your NgModule-based application.
50
49
  *
51
- * ```ts-no-run
52
- * // Import the Gantt module
50
+ * @example
51
+ * ```typescript
53
52
  * import { GanttModule } from '@progress/kendo-angular-gantt';
54
- *
55
- * // The browser platform with a compiler
56
- * import { platformBrowserDynamic } from '@angular/platform-browser-dynamic';
57
- *
58
53
  * import { NgModule } from '@angular/core';
59
- *
60
- * // Import the app component
54
+ * import { BrowserModule } from '@angular/platform-browser';
61
55
  * import { AppComponent } from './app.component';
62
56
  *
63
- * // Define the app module
64
- * _@NgModule({
65
- * declarations: [AppComponent], // declare app component
66
- * imports: [BrowserModule, GanttModule], // import Gantt module
67
- * bootstrap: [AppComponent]
57
+ * @NgModule({
58
+ * declarations: [AppComponent],
59
+ * imports: [BrowserModule, GanttModule],
60
+ * bootstrap: [AppComponent]
68
61
  * })
69
62
  * export class AppModule {}
70
- *
71
- * // Compile and launch the module
72
- * platformBrowserDynamic().bootstrapModule(AppModule);
73
- *
74
63
  * ```
75
64
  */
76
65
  export class GanttModule {
@@ -8,8 +8,16 @@ import { Messages } from './messages';
8
8
  import * as i0 from "@angular/core";
9
9
  import * as i1 from "@progress/kendo-angular-l10n";
10
10
  /**
11
- * Custom component messages override default component messages
12
- * ([see example](slug:globalization_treelist#toc-custom-messages)).
11
+ * Represents the custom messages component for the Kendo UI for Angular Gantt.
12
+ * Use this component to override default messages.
13
+ *
14
+ * @example
15
+ * ```html
16
+ * <kendo-gantt-messages
17
+ * addTaskText="Add Task"
18
+ * cancelButtonText="Cancel">
19
+ * </kendo-gantt-messages>
20
+ * ```
13
21
  */
14
22
  export class CustomMessagesComponent extends Messages {
15
23
  service;
@@ -3,7 +3,7 @@
3
3
  * Licensed under commercial license. See LICENSE.md in the project root for more information
4
4
  *-------------------------------------------------------------------------------------------*/
5
5
  /**
6
- * The dependency type when two tasks are connected.
6
+ * Represents the dependency type when you connect two tasks.
7
7
  *
8
8
  * The supported values are:
9
9
  * * `FF`&mdash;from 'finish' to 'finish'
@@ -13,8 +13,20 @@
13
13
  */
14
14
  export var DependencyType;
15
15
  (function (DependencyType) {
16
+ /**
17
+ * Specifies that task B can't finish before task A finishes.
18
+ */
16
19
  DependencyType[DependencyType["FF"] = 0] = "FF";
20
+ /**
21
+ * Specifies that task B can't start before task A finishes.
22
+ */
17
23
  DependencyType[DependencyType["FS"] = 1] = "FS";
24
+ /**
25
+ * Specifies that task A can't finish before task B starts.
26
+ */
18
27
  DependencyType[DependencyType["SF"] = 2] = "SF";
19
- DependencyType[DependencyType["SS"] = 3] = "SS"; // task B can't start before task A starts
28
+ /**
29
+ * Specifies that task B can't start before task A starts.
30
+ */
31
+ DependencyType[DependencyType["SS"] = 3] = "SS";
20
32
  })(DependencyType || (DependencyType = {}));
@@ -4,11 +4,11 @@
4
4
  *-------------------------------------------------------------------------------------------*/
5
5
  import { PreventableEvent } from '@progress/kendo-angular-common';
6
6
  /**
7
- * Called every time a user leaves an edited cell.
7
+ * Represents the arguments for the `cellClose` event of the Gantt.
8
8
  */
9
9
  export class CellCloseEvent extends PreventableEvent {
10
10
  /**
11
- * The data item.
11
+ * Holds the data item.
12
12
  */
13
13
  dataItem;
14
14
  /**
@@ -16,26 +16,25 @@ export class CellCloseEvent extends PreventableEvent {
16
16
  */
17
17
  isNew;
18
18
  /**
19
- * The Gantt column that will be closed.
19
+ * Contains the Gantt column associated with the closed cell.
20
20
  */
21
21
  column;
22
22
  /**
23
- * The [`FormGroup`](link:site.data.urls.angular['formgroupapi']) that is used to edit the cell which will be closed.
23
+ * Contains the [`FormGroup`](link:site.data.urls.angular['formgroupapi']) used to edit the cell that will be closed.
24
24
  */
25
25
  formGroup;
26
26
  /**
27
- * The DOM event that caused the `cellClose` event.
28
- * May not be present if `cellClose` was caused by an API call.
27
+ * Contains the DOM event that triggered the `cellClose` event.
28
+ * This property may be missing if `cellClose` is triggered by an API call.
29
29
  */
30
30
  originalEvent;
31
31
  /**
32
- * The `GanttComponent` instance.
32
+ * Holds the `GanttComponent` instance.
33
33
  */
34
34
  sender;
35
35
  /**
36
- * The `TaskEditItem` associated with the edited task.
37
- * The parent item is accessible through the `parent` property,
38
- * and allows traversing all ancestors that need to be updated.
36
+ * Contains the `TaskEditItem` for the edited task.
37
+ * Access the parent item through the `parent` property to traverse all ancestors that need updates.
39
38
  */
40
39
  item;
41
40
  constructor(options) {
@@ -10,7 +10,7 @@ export const packageMetadata = {
10
10
  productName: 'Kendo UI for Angular',
11
11
  productCode: 'KENDOUIANGULAR',
12
12
  productCodes: ['KENDOUIANGULAR'],
13
- publishDate: 1750157264,
14
- version: '19.1.2-develop.4',
13
+ publishDate: 1750434001,
14
+ version: '19.1.2-develop.6',
15
15
  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'
16
16
  };
@@ -9,8 +9,16 @@ import { isPresent, isString } from '../utils';
9
9
  import * as i0 from "@angular/core";
10
10
  import * as i1 from "../gantt.component";
11
11
  /**
12
- * A directive which handles the [`selectionChange`]({% slug api_gantt_ganttcomponent %}#toc-selectionchange) event of the Gantt
13
- * ([see example]({% slug selection_gantt %}#toc-built-in-directive))
12
+ * Handles the [`selectionChange`]({% slug api_gantt_ganttcomponent %}#toc-selectionchange) event of the Gantt component.
13
+ * ([See example]({% slug selection_gantt %}#toc-built-in-directive)).
14
+ *
15
+ * @example
16
+ * ```html
17
+ * <kendo-gantt kendoGanttSelectable [(selectedKeys)]="selectedKeys"></kendo-gantt>
18
+ * ```
19
+ *
20
+ * @remarks
21
+ * Applied to: {@link GanttComponent}
14
22
  */
15
23
  export class SelectableDirective {
16
24
  gantt;
@@ -42,12 +50,12 @@ export class SelectableDirective {
42
50
  this.gantt.updateView();
43
51
  }
44
52
  /**
45
- * Fires when the selected keys are changed.
53
+ * Emits when the selected keys change.
46
54
  */
47
55
  selectedKeysChange = new EventEmitter();
48
56
  /**
49
- * The field name or a function that specifies the data item unique key identifier.
50
- * By default, the string field `id` is used.
57
+ * Sets the field name or function that identifies the unique key for a data item.
58
+ * Uses the string field `id` by default.
51
59
  */
52
60
  set itemKey(value) {
53
61
  if (isString(value)) {
@@ -5,32 +5,23 @@
5
5
  import { Directive, Optional, TemplateRef } from '@angular/core';
6
6
  import * as i0 from "@angular/core";
7
7
  /**
8
- * Represents a template that defines the whole content of the summary task component.
9
- * To define the template, nest an `<ng-template>` tag
10
- * with the `kendoGanttSummaryTaskTemplate` directive inside the `<kendo-gantt>` tag.
8
+ * Defines a template for the entire summary task component.
9
+ * Place an `<ng-template>` tag with the `kendoGanttSummaryTaskTemplate` directive inside the `<kendo-gantt>` tag to set the template.
11
10
  *
12
- * The template context is set to the current data item. The following additional field is passed:
13
- * - `elementWidth`&mdash;The current summary task wrapper element's calculated width in pixels based on its start and end date.
14
- * Use it as an alias for a template variable by utilizing the `let-elementWidth="elementWidth"` syntax.
15
- * Useful for calculations related to rendering custom elements representing the task progress.
11
+ * The template context uses the current data item. The following field is also available:
12
+ * - `elementWidth`&mdash;The calculated width in pixels of the current summary task wrapper element, based on its start and end date.
13
+ * Use `let-elementWidth="elementWidth"` to access it in the template.
14
+ * This helps you render custom elements for summary task progress.
16
15
  *
17
16
  * @example
18
- * ```ts-preview
19
- * _@Component({
20
- * selector: 'my-app',
21
- * template: `
22
- * <kendo-gantt [kendoGanttHierarchyBinding]="data">
23
- * <ng-template kendoGanttSummaryTaskTemplate let-dataItem let-elementWidth="elementWidth">
24
- * <div [style]="'color: white; font-size: 8px;'">
25
- * {{ dataItem.title }} - {{ dataItem.completionRatio * 100 }}% complete; width: {{ elementWidth }}
26
- * </div>
27
- * </ng-template>
28
- * </kendo-gantt>
29
- * `
30
- * })
31
- * class AppComponent {
32
- * public data: any[] = sampleTasks;
33
- * }
17
+ * ```html
18
+ * <kendo-gantt [kendoGanttHierarchyBinding]="data">
19
+ * <ng-template kendoGanttSummaryTaskTemplate let-dataItem let-elementWidth="elementWidth">
20
+ * <div [style]="'color: white; font-size: 8px;'">
21
+ * {{ dataItem.title }} - {{ dataItem.completionRatio * 100 }}% complete; width: {{ elementWidth }}
22
+ * </div>
23
+ * </ng-template>
24
+ * </kendo-gantt>
34
25
  * ```
35
26
  */
36
27
  export class GanttSummaryTaskTemplateDirective {
@@ -5,11 +5,10 @@
5
5
  import { Directive, Optional, TemplateRef } from '@angular/core';
6
6
  import * as i0 from "@angular/core";
7
7
  /**
8
- * Represents a template that defines the text content section of the task component.
9
- * To define the template, nest an `<ng-template>` tag
10
- * with the `kendoGanttTaskContentTemplate` directive inside the `<kendo-gantt>` tag.
8
+ * Defines a template for the text content section of the task component.
9
+ * Place an `<ng-template>` tag with the `kendoGanttTaskContentTemplate` directive inside the `<kendo-gantt>` tag to set the template.
11
10
  *
12
- * The template context is set to the current data item.
11
+ * The template context uses the current data item.
13
12
  *
14
13
  * @example
15
14
  * ```ts-preview
@@ -5,30 +5,21 @@
5
5
  import { Directive, Optional, TemplateRef } from '@angular/core';
6
6
  import * as i0 from "@angular/core";
7
7
  /**
8
- * Represents a template that defines the whole content of the task component.
9
- * To define the template, nest an `<ng-template>` tag
10
- * with the `kendoGanttTaskTemplate` directive inside the `<kendo-gantt>` tag.
8
+ * Defines a template for the entire task component.
9
+ * Place an `<ng-template>` tag with the `kendoGanttTaskTemplate` directive inside the `<kendo-gantt>` tag to set the template.
11
10
  *
12
- * The template context is set to the current data item. The following additional field is passed:
13
- * - `elementWidth`&mdash;The current task wrapper element's calculated width in pixels based on its start and end date.
14
- * Use it as an alias for a template variable by utilizing the `let-elementWidth="elementWidth"` syntax.
15
- * Useful for calculations related to rendering custom elements representing the task progress.
11
+ * The template context uses the current data item. The following field is also available:
12
+ * - `elementWidth`&mdash;The calculated width in pixels of the current task wrapper element, based on its start and end date.
13
+ * Use `let-elementWidth="elementWidth"` to access it in the template.
14
+ * This helps you render custom elements for task progress.
16
15
  *
17
16
  * @example
18
- * ```ts-preview
19
- * _@Component({
20
- * selector: 'my-app',
21
- * template: `
22
- * <kendo-gantt [kendoGanttHierarchyBinding]="data">
23
- * <ng-template kendoGanttTaskTemplate let-dataItem let-elementWidth="elementWidth">
24
- * {{ dataItem.title }} - {{ dataItem.completionRatio * 100 }}% complete
25
- * </ng-template>
26
- * </kendo-gantt>
27
- * `
28
- * })
29
- * class AppComponent {
30
- * public data: any[] = sampleTasks;
31
- * }
17
+ * ```html
18
+ * <kendo-gantt [kendoGanttHierarchyBinding]="data">
19
+ * <ng-template kendoGanttTaskTemplate let-dataItem let-elementWidth="elementWidth">
20
+ * {{ dataItem.title }} - {{ dataItem.completionRatio * 100 }}% complete
21
+ * </ng-template>
22
+ * </kendo-gantt>
32
23
  * ```
33
24
  */
34
25
  export class GanttTaskTemplateDirective {
@@ -5,11 +5,10 @@
5
5
  import { Directive, Optional, TemplateRef } from '@angular/core';
6
6
  import * as i0 from "@angular/core";
7
7
  /**
8
- * Represents a template that defines the whole content of the Task tooltip.
9
- * To define the template, nest an `<ng-template>` tag
10
- * with the `kendoGanttTaskTooltipTemplate` directive inside the `<kendo-gantt>` tag.
8
+ * Defines a template for the entire Task tooltip.
9
+ * Place an `<ng-template>` tag with the `kendoGanttTaskTooltipTemplate` directive inside the `<kendo-gantt>` tag to set the template.
11
10
  *
12
- * The template context is set to the respective data item.
11
+ * The template context uses the related data item.
13
12
  *
14
13
  * @example
15
14
  * ```ts-preview
@@ -10,11 +10,16 @@ import * as i0 from "@angular/core";
10
10
  import * as i1 from "../common/option-changes.service";
11
11
  import * as i2 from "../dependencies/dependency-dom.service";
12
12
  /**
13
- * The Gantt timeline day view component.
13
+ * Represents the Gantt timeline day view component.
14
+ *
15
+ * @example
16
+ * ```html
17
+ * <kendo-gantt-timeline-day-view></kendo-gantt-timeline-day-view>
18
+ * ```
14
19
  */
15
20
  export class TimelineDayViewComponent extends ViewBase {
16
21
  /**
17
- * The type for this view (`day`).
22
+ * Specifies the type for this view (`day`).
18
23
  */
19
24
  type = 'day';
20
25
  constructor(optionChangesService, dependencyDomService) {
@@ -10,11 +10,16 @@ import * as i0 from "@angular/core";
10
10
  import * as i1 from "../common/option-changes.service";
11
11
  import * as i2 from "../dependencies/dependency-dom.service";
12
12
  /**
13
- * The Gantt timeline month view component.
13
+ * Represents the Gantt timeline month view component.
14
+ *
15
+ * @example
16
+ * ```html
17
+ * <kendo-gantt-timeline-month-view></kendo-gantt-timeline-month-view>
18
+ * ```
14
19
  */
15
20
  export class TimelineMonthViewComponent extends ViewBase {
16
21
  /**
17
- * The type for this view (`month`).
22
+ * Specifies the type for this view (`month`).
18
23
  */
19
24
  type = 'month';
20
25
  constructor(optionChangesService, dependencyDomService) {
@@ -10,11 +10,16 @@ import * as i0 from "@angular/core";
10
10
  import * as i1 from "../common/option-changes.service";
11
11
  import * as i2 from "../dependencies/dependency-dom.service";
12
12
  /**
13
- * The Gantt timeline week view component.
13
+ * Represents the Gantt timeline week view component.
14
+ *
15
+ * @example
16
+ * ```html
17
+ * <kendo-gantt-timeline-week-view></kendo-gantt-timeline-week-view>
18
+ * ```
14
19
  */
15
20
  export class TimelineWeekViewComponent extends ViewBase {
16
21
  /**
17
- * The type for this view (`week`).
22
+ * Specifies the type for this view (`week`).
18
23
  */
19
24
  type = 'week';
20
25
  constructor(optionChangesService, dependencyDomService) {
@@ -10,11 +10,16 @@ import * as i0 from "@angular/core";
10
10
  import * as i1 from "../common/option-changes.service";
11
11
  import * as i2 from "../dependencies/dependency-dom.service";
12
12
  /**
13
- * The Gantt timeline year view component.
13
+ * Represents the Gantt timeline year view component.
14
+ *
15
+ * @example
16
+ * ```html
17
+ * <kendo-gantt-timeline-year-view></kendo-gantt-timeline-year-view>
18
+ * ```
14
19
  */
15
20
  export class TimelineYearViewComponent extends ViewBase {
16
21
  /**
17
- * The type for this view (`year`).
22
+ * Specifies the type for this view (`year`).
18
23
  */
19
24
  type = 'year';
20
25
  constructor(optionChangesService, dependencyDomService) {
@@ -10,13 +10,20 @@ import * as i0 from "@angular/core";
10
10
  import * as i1 from "../common/option-changes.service";
11
11
  import * as i2 from "../dependencies/dependency-dom.service";
12
12
  /**
13
- * The base class for the timeline view components of the Gantt.
13
+ * Serves as the base class for the timeline view components of the Gantt.
14
+ *
15
+ * @example
16
+ * ```typescript
17
+ * export class CustomTimelineViewComponent extends ViewBase {
18
+ * public readonly type: TimelineViewType = 'custom';
19
+ * }
20
+ * ```
14
21
  */
15
22
  export class ViewBase {
16
23
  optionChangesService;
17
24
  dependencyDomService;
18
25
  /**
19
- * The width of the time slot headers. Values are treated as pixels.
26
+ * Sets the width of the time slot headers in pixels.
20
27
  *
21
28
  * @default 100
22
29
  */
@@ -27,9 +34,8 @@ export class ViewBase {
27
34
  timelineHeadersDateFormat;
28
35
  /**
29
36
  * Specifies the current time marker settings.
30
- * If not set, the value is taken from the Gantt component
37
+ * If you do not set a value, the component uses the value from the Gantt component
31
38
  * [`currentTimeMarker`]({% slug api_gantt_ganttcomponent %}#toc-currentTimeMarker) property.
32
- *
33
39
  */
34
40
  currentTimeMarker;
35
41
  /**
@@ -7,101 +7,28 @@ import * as i0 from "@angular/core";
7
7
  /**
8
8
  * Represents the toolbar template of the Gantt.
9
9
  *
10
- * The template context has the following field:
11
- * - `position`&mdash;The position at which the toolbar template is rendered. The possible values are `'top'` and `'bottom'`.
10
+ * The template context includes:
11
+ * - `position`&mdash;The position where the toolbar template renders. Possible values are `'top'` and `'bottom'`.
12
12
  *
13
13
  * @example
14
- * ```ts-preview
15
- *
16
- * _@Component({
17
- * selector: 'my-app',
18
- * template: `
19
- * <div class="example-config">
20
- * <input type="radio" kendoRadioButton id="top" name="position" value="top" checked (click)="positionChange($event)"/>
21
- * <kendo-label class="k-radio-label" for="top">Top</kendo-label><br/>
22
- * <input type="radio" kendoRadioButton id="bottom" name="position" value="bottom" (click)="positionChange($event)"/>
23
- * <kendo-label class="k-radio-label" for="bottom">Bottom</kendo-label><br/>
24
- * <input type="radio" kendoRadioButton id="both" name="position" value="both" (click)="positionChange($event)"/>
25
- * <kendo-label class="k-radio-label" for="both">Both</kendo-label><br/>
26
- * </div>
27
- * <kendo-gantt [[kendoGanttHierarchyBinding]="data"]="data" [style.height.px]="400">
28
- * <ng-template kendoGanttToolbarTemplate [position]="position" let-position="position">
29
- * <button kendoButton (click)="onClick()">Custom action</button>
30
- * </ng-template>
31
- * </kendo-gantt>
32
- * `
33
- * })
34
- *
35
- * class AppComponent {
36
- * public position: 'top' | 'bottom' | 'both' = 'top';
37
- *
38
- * public data = [{
39
- * id: 7,
40
- * title: "Software validation, research and implementation",
41
- * orderId: 0,
42
- * start: new Date("2014-06-02T00:00:00.000Z"),
43
- * end: new Date("2014-07-12T00:00:00.000Z"),
44
- * completionRatio: 0.45708333333333334,
45
- * isExpanded: true,
46
- * children: [{
47
- * id: 11,
48
- * title: "Research",
49
- * orderId: 1,
50
- * start: new Date("2014-06-02T00:00:00.000Z"),
51
- * end: new Date("2014-06-07T00:00:00.000Z"),
52
- * completionRatio: 0.5766666666666667,
53
- * isExpanded: true,
54
- * children: [{
55
- * id: 19,
56
- * title: "Validation with Customers",
57
- * orderId: 0,
58
- * start: new Date("2014-06-02T00:00:00.000Z"),
59
- * end: new Date("2014-06-04T00:00:00.000Z"),
60
- * completionRatio: 0.25,
61
- * isExpanded: true
62
- * },
63
- * {
64
- * id: 20,
65
- * title: "Market Research",
66
- * orderId: 1,
67
- * start: new Date("2014-06-02T00:00:00.000Z"),
68
- * end: new Date("2014-06-03T02:00:00.000Z"),
69
- * completionRatio: 0.82,
70
- * isExpanded: true
71
- * },
72
- * {
73
- * id: 39,
74
- * title: "Functional and Technical Specification",
75
- * orderId: 2,
76
- * start: new Date("2014-06-04T00:00:00.000Z"),
77
- * end: new Date("2014-06-07T00:00:00.000Z"),
78
- * completionRatio: 0.66,
79
- * isExpanded: true
80
- * }]
81
- * }]
82
- * };
83
- *
84
- * public positionChange(event: MouseEvent): void {
85
- * this.position = event.target['defaultValue'];
86
- * }
87
- *
88
- * public onClick(): void {
89
- * console.log("button was clicked");
90
- * }
91
- * }
92
- *
14
+ * ```html
15
+ * <kendo-gantt [kendoGanttHierarchyBinding]="data" [style.height.px]="400">
16
+ * <ng-template kendoGanttToolbarTemplate [position]="position" let-position="position">
17
+ * <button kendoButton (click)="onClick()">Custom action</button>
18
+ * </ng-template>
19
+ * </kendo-gantt>
93
20
  * ```
94
21
  */
95
22
  export class ToolbarTemplateDirective {
96
23
  templateRef;
97
24
  _position = "top";
98
25
  /**
99
- * Defines the Gantt Toolbar that will use this template.
26
+ * Sets the Gantt Toolbar that uses this template.
100
27
  *
101
- * The possible values are:
102
- * - `top`&mdash;The template will be rendered in the top toolbar (if present) only.
103
- * - `bottom`&mdash;The template will be rendered in the bottom toolbar (if present) only.
104
- * - `both`&mdash;The template will be rendered in both toolbars (if present).
28
+ * Possible values:
29
+ * - `top`&mdash;Renders the template in the top toolbar (if present) only.
30
+ * - `bottom`&mdash;Renders the template in the bottom toolbar (if present) only.
31
+ * - `both`&mdash;Renders the template in both toolbars (if present).
105
32
  */
106
33
  set position(position) {
107
34
  this._position = position;
@@ -11,22 +11,22 @@ import * as i0 from "@angular/core";
11
11
  import * as i1 from "@progress/kendo-angular-l10n";
12
12
  import * as i2 from "@angular/forms";
13
13
  /**
14
- * The Gantt ViewSelector component. Shows the currently active view type, and allows switching to another view type.
14
+ * The Gantt ViewSelector component. Shows the current view type and lets you switch to another view type.
15
15
  */
16
16
  export class ViewSelectorComponent {
17
17
  localizationService;
18
18
  hostClass = true;
19
19
  /**
20
- * The collection of the timeline view types in the current Gantt configuration.
20
+ * Lists the timeline view types in the current Gantt configuration.
21
21
  */
22
22
  views;
23
23
  /**
24
- * The currently active view type.
24
+ * Sets the current view type.
25
25
  * @default 'week'
26
26
  */
27
27
  activeView = 'week';
28
28
  /**
29
- * Fires each time the user selects a different view type. The event data contains the type of the newly selected view.
29
+ * Fires when the user selects a different view type. The event data contains the type of the new view.
30
30
  */
31
31
  activeViewChange = new EventEmitter();
32
32
  constructor(localizationService) {
@@ -3,13 +3,14 @@
3
3
  * Licensed under commercial license. See LICENSE.md in the project root for more information
4
4
  *-------------------------------------------------------------------------------------------*/
5
5
  /**
6
- * Arguments for the Gantt `expand` and `collapse` events.
6
+ * Represents the arguments for the Gantt `expand` and `collapse` events.
7
+ *
7
8
  */
8
9
  export declare class ExpandEvent {
9
10
  /** @hidden */
10
11
  constructor();
11
12
  /**
12
- * The expanded/collapsed data item.
13
+ * The expanded or collapsed data item.
13
14
  */
14
15
  dataItem: any;
15
16
  }
@@ -5,14 +5,20 @@
5
5
  import { ExpandableDirective } from '@progress/kendo-angular-treelist';
6
6
  import * as i0 from "@angular/core";
7
7
  /**
8
- * A directive which controls the expanded state of the items.
8
+ * Represents a directive that controls the expanded state of Gantt items.
9
+ *
10
+ * @example
11
+ * ```html
12
+ * <kendo-gantt kendoGanttExpandable [expandedKeys]="expandedKeys"></kendo-gantt>
13
+ * ```
14
+ *
15
+ * @remarks
16
+ * Applied to: {@link GanttComponent}
9
17
  */
10
18
  export declare class GanttExpandableDirective extends ExpandableDirective {
11
19
  /**
12
- * Defines the item key that will be stored in the expandedKeys collection.
13
- * Defaults to the task data item ID field,
14
- * which is specified in the [`taskModelFields`]({% slug api_gantt_ganttcomponent %}#toc-taskmodelfields) object.
15
- *
20
+ * Sets the item key stored in the `expandedKeys` collection.
21
+ * The default value is the task data item ID field, specified in the `taskModelFields` object.
16
22
  */
17
23
  set expandBy(value: string | ((dataItem: any) => any));
18
24
  static ɵfac: i0.ɵɵFactoryDeclaration<GanttExpandableDirective, never>;