@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.
- package/binding-directives/flat-binding.directive.d.ts +16 -4
- package/binding-directives/hierarchy-binding.directive.d.ts +16 -3
- package/columns/cell-template.directive.d.ts +20 -12
- package/columns/column-base.component.d.ts +2 -1
- package/columns/column-group.component.d.ts +14 -0
- package/columns/column-menu-template.directive.d.ts +14 -7
- package/columns/column.component.d.ts +12 -2
- package/columns/edit-template.directive.d.ts +15 -6
- package/columns/filter-menu-template.directive.d.ts +14 -4
- package/columns/footer-template.directive.d.ts +14 -5
- package/columns/header-template.directive.d.ts +15 -5
- package/columns/span-column.component.d.ts +16 -0
- package/directives.d.ts +1 -1
- package/dragging/dependency-drag-create.directive.d.ts +9 -2
- package/dragging/task-drag.directive.d.ts +17 -4
- package/editing/add-task.component.d.ts +7 -7
- package/esm2022/binding-directives/flat-binding.directive.mjs +16 -4
- package/esm2022/binding-directives/hierarchy-binding.directive.mjs +16 -3
- package/esm2022/columns/cell-template.directive.mjs +20 -12
- package/esm2022/columns/column-base.component.mjs +2 -1
- package/esm2022/columns/column-group.component.mjs +14 -0
- package/esm2022/columns/column-menu-template.directive.mjs +14 -7
- package/esm2022/columns/column.component.mjs +12 -2
- package/esm2022/columns/edit-template.directive.mjs +15 -6
- package/esm2022/columns/filter-menu-template.directive.mjs +14 -4
- package/esm2022/columns/footer-template.directive.mjs +14 -5
- package/esm2022/columns/header-template.directive.mjs +15 -5
- package/esm2022/columns/span-column.component.mjs +16 -0
- package/esm2022/directives.mjs +1 -1
- package/esm2022/dragging/dependency-drag-create.directive.mjs +9 -18
- package/esm2022/dragging/task-drag.directive.mjs +17 -4
- package/esm2022/editing/add-task.component.mjs +7 -7
- package/esm2022/expanded-state/expand-event.mjs +3 -2
- package/esm2022/expanded-state/expandable.directive.mjs +11 -5
- package/esm2022/gantt.component.mjs +163 -211
- package/esm2022/gantt.module.mjs +9 -20
- package/esm2022/localization/custom-messages.component.mjs +10 -2
- package/esm2022/models/dependency-type.enum.mjs +14 -2
- package/esm2022/models/events/cell-close-event.interface.mjs +9 -10
- package/esm2022/package-metadata.mjs +2 -2
- package/esm2022/selection/selectable.directive.mjs +13 -5
- package/esm2022/template-directives/summary-task-template.directive.mjs +14 -23
- package/esm2022/template-directives/task-content-template.directive.mjs +3 -4
- package/esm2022/template-directives/task-template.directive.mjs +12 -21
- package/esm2022/template-directives/task-tooltip-template.directive.mjs +3 -4
- package/esm2022/timeline/timeline-day-view.component.mjs +7 -2
- package/esm2022/timeline/timeline-month-view.component.mjs +7 -2
- package/esm2022/timeline/timeline-week-view.component.mjs +7 -2
- package/esm2022/timeline/timeline-year-view.component.mjs +7 -2
- package/esm2022/timeline/view-base.mjs +10 -4
- package/esm2022/toolbar/toolbar-template.directive.mjs +13 -86
- package/esm2022/toolbar/view-selector.component.mjs +4 -4
- package/expanded-state/expand-event.d.ts +3 -2
- package/expanded-state/expandable.directive.d.ts +11 -5
- package/fesm2022/progress-kendo-angular-gantt.mjs +520 -490
- package/gantt.component.d.ts +159 -207
- package/gantt.module.d.ts +9 -20
- package/localization/custom-messages.component.d.ts +10 -2
- package/models/cell-content-type.interface.d.ts +4 -3
- package/models/class-callbacks.d.ts +20 -20
- package/models/column-menu-settings.interface.d.ts +7 -8
- package/models/column-reorder-config.d.ts +4 -1
- package/models/current-time-settings.interface.d.ts +8 -5
- package/models/dependency-type.enum.d.ts +13 -1
- package/models/events/cell-click-event.interface.d.ts +9 -9
- package/models/events/cell-close-event.interface.d.ts +9 -10
- package/models/events/column-reorder-event.interface.d.ts +1 -1
- package/models/events/column-resize-event.interface.d.ts +1 -1
- package/models/events/column-visibility-change-event.interface.d.ts +2 -2
- package/models/events/data-state-change-event.interface.d.ts +1 -1
- package/models/events/dependency-add-event.interface.d.ts +5 -5
- package/models/events/task-add-event.interface.d.ts +6 -6
- package/models/events/task-click-event.interface.d.ts +6 -6
- package/models/events/task-delete-event.interface.d.ts +4 -5
- package/models/events/task-drag-event.interface.d.ts +13 -15
- package/models/events/task-edit-event.interface.d.ts +13 -15
- package/models/gantt-dependency-model-fields.interface.d.ts +11 -10
- package/models/gantt-dependency.interface.d.ts +8 -5
- package/models/gantt-task-model-fields.interface.d.ts +22 -13
- package/models/gantt-task.interface.d.ts +11 -10
- package/models/sort-settings.d.ts +6 -6
- package/models/splitter-pane-options.interface.d.ts +8 -8
- package/models/timeline-header-date-format.d.ts +4 -3
- package/models/timeline-view.d.ts +1 -1
- package/models/toolbar-settings.d.ts +5 -6
- package/models/tooltip-options.interface.d.ts +4 -4
- package/package.json +17 -17
- package/schematics/ngAdd/index.js +7 -7
- package/scrolling/drag-scroll-settings.d.ts +4 -4
- package/selection/selectable.directive.d.ts +13 -5
- package/selection/selection-change-event.d.ts +6 -7
- package/template-directives/summary-task-template.directive.d.ts +14 -23
- package/template-directives/task-content-template.directive.d.ts +3 -4
- package/template-directives/task-template.directive.d.ts +12 -21
- package/template-directives/task-tooltip-template.directive.d.ts +3 -4
- package/timeline/timeline-day-view.component.d.ts +7 -2
- package/timeline/timeline-month-view.component.d.ts +7 -2
- package/timeline/timeline-week-view.component.d.ts +7 -2
- package/timeline/timeline-year-view.component.d.ts +7 -2
- package/timeline/view-base.d.ts +11 -5
- package/toolbar/toolbar-template.directive.d.ts +13 -86
- package/toolbar/view-selector.component.d.ts +4 -4
package/gantt.component.d.ts
CHANGED
|
@@ -44,75 +44,58 @@ import { TaskTooltipOptions } from './models/tooltip-options.interface';
|
|
|
44
44
|
import { IntlService } from '@progress/kendo-angular-intl';
|
|
45
45
|
import * as i0 from "@angular/core";
|
|
46
46
|
/**
|
|
47
|
-
* Represents the Kendo UI Gantt component for Angular.
|
|
47
|
+
* Represents the [Kendo UI Gantt component for Angular](slug:overview_gantt).
|
|
48
|
+
*
|
|
49
|
+
* Use the Gantt component to display and manage project tasks and dependencies in a timeline view.
|
|
48
50
|
*
|
|
49
51
|
* @example
|
|
50
|
-
* ```ts
|
|
51
|
-
*
|
|
52
|
-
*
|
|
53
|
-
* template: `
|
|
54
|
-
* <kendo-gantt
|
|
55
|
-
* [style.height.px]="500"
|
|
56
|
-
* [kendoGanttHierarchyBinding]="data"
|
|
57
|
-
* childrenField="subtasks"
|
|
58
|
-
* [dependencies]="dependencies">
|
|
59
|
-
* <kendo-gantt-column
|
|
60
|
-
* field="title"
|
|
61
|
-
* title="Task"
|
|
62
|
-
* [width]="200"
|
|
63
|
-
* [expandable]="true"></kendo-gantt-column>
|
|
64
|
-
* <kendo-gantt-column
|
|
65
|
-
* field="start"
|
|
66
|
-
* title="Start"
|
|
67
|
-
* format="dd-MMM-yyyy"
|
|
68
|
-
* [width]="120"></kendo-gantt-column>
|
|
69
|
-
* <kendo-gantt-column
|
|
70
|
-
* field="end"
|
|
71
|
-
* title="End"
|
|
72
|
-
* format="dd-MMM-yyyy"
|
|
73
|
-
* [width]="120"></kendo-gantt-column>
|
|
74
|
-
* <kendo-gantt-timeline-day-view></kendo-gantt-timeline-day-view>
|
|
75
|
-
* <kendo-gantt-timeline-week-view></kendo-gantt-timeline-week-view>
|
|
76
|
-
* <kendo-gantt-timeline-month-view></kendo-gantt-timeline-month-view>
|
|
77
|
-
* </kendo-gantt>
|
|
78
|
-
* `
|
|
79
|
-
* })
|
|
80
|
-
* class AppComponent {
|
|
81
|
-
* public data: Task[] = [{
|
|
82
|
-
* id: 7, title: 'Validation and R&D', start: new Date('2014-06-02T00:00:00.000Z'),
|
|
83
|
-
* end: new Date('2014-06-19T00:00:00.000Z'), completionRatio: 0.45708333333333334,
|
|
84
|
-
* subtasks: [
|
|
85
|
-
* { id: 18, title: 'Project Kickoff', start: new Date('2014-06-02T00:00:00.000Z'),
|
|
86
|
-
* end: new Date('2014-06-02T00:00:00.000Z'), completionRatio: 0.23 },
|
|
87
|
-
* { id: 11, title: 'Research', start: new Date('2014-06-02T00:00:00.000Z'),
|
|
88
|
-
* end: new Date('2014-06-07T00:00:00.000Z'), completionRatio: 0.5766666666666667,
|
|
89
|
-
* subtasks: [
|
|
90
|
-
* { id: 19, title: 'Validation', start: new Date('2014-06-02T00:00:00.000Z'),
|
|
91
|
-
* end: new Date('2014-06-04T00:00:00.000Z'), completionRatio: 0.25 },
|
|
92
|
-
* { id: 39, title: 'Specification', start: new Date('2014-06-04T00:00:00.000Z'),
|
|
93
|
-
* end: new Date('2014-06-07T00:00:00.000Z'), completionRatio: 0.66 }]
|
|
94
|
-
* }, { id: 13, title: 'Implementation', start: new Date('2014-06-08T00:00:00.000Z'),
|
|
95
|
-
* end: new Date('2014-06-19T00:00:00.000Z'), completionRatio: 0.77,
|
|
96
|
-
* subtasks: [
|
|
97
|
-
* { id: 24, title: 'Prototype', start: new Date('2014-06-08T00:00:00.000Z'),
|
|
98
|
-
* end: new Date('2014-06-14T00:00:00.000Z'), completionRatio: 0.77 },
|
|
99
|
-
* { id: 29, title: 'UI and Interaction', start: new Date('2014-06-14T00:00:00.000Z'),
|
|
100
|
-
* end: new Date('2014-06-19T00:00:00.000Z'), completionRatio: 0.6 }]
|
|
101
|
-
* }, { id: 17, title: 'Release', start: new Date('2014-06-19T00:00:00.000Z'),
|
|
102
|
-
* end: new Date('2014-06-19T00:00:00.000Z'), completionRatio: 0 }]
|
|
103
|
-
* }];
|
|
52
|
+
* ```ts
|
|
53
|
+
* import { Component } from '@angular/core';
|
|
54
|
+
* import { GanttComponent, DependencyType } from '@progress/kendo-angular-gantt';
|
|
104
55
|
*
|
|
105
|
-
*
|
|
106
|
-
*
|
|
107
|
-
*
|
|
108
|
-
*
|
|
109
|
-
*
|
|
110
|
-
*
|
|
111
|
-
*
|
|
112
|
-
*
|
|
113
|
-
*
|
|
56
|
+
* @Component({
|
|
57
|
+
* selector: 'my-app',
|
|
58
|
+
* template: `
|
|
59
|
+
* <kendo-gantt
|
|
60
|
+
* [style.height.px]="500"
|
|
61
|
+
* [kendoGanttHierarchyBinding]="data"
|
|
62
|
+
* childrenField="subtasks"
|
|
63
|
+
* [dependencies]="dependencies">
|
|
64
|
+
* <kendo-gantt-column field="title" title="Task" [width]="200" [expandable]="true"></kendo-gantt-column>
|
|
65
|
+
* <kendo-gantt-column field="start" title="Start" format="dd-MMM-yyyy" [width]="120"></kendo-gantt-column>
|
|
66
|
+
* <kendo-gantt-column field="end" title="End" format="dd-MMM-yyyy" [width]="120"></kendo-gantt-column>
|
|
67
|
+
* <kendo-gantt-timeline-day-view></kendo-gantt-timeline-day-view>
|
|
68
|
+
* <kendo-gantt-timeline-week-view></kendo-gantt-timeline-week-view>
|
|
69
|
+
* <kendo-gantt-timeline-month-view></kendo-gantt-timeline-month-view>
|
|
70
|
+
* </kendo-gantt>
|
|
71
|
+
* `
|
|
72
|
+
* })
|
|
73
|
+
* export class AppComponent {
|
|
74
|
+
* public data: Task[] = [
|
|
75
|
+
* {
|
|
76
|
+
* id: 1,
|
|
77
|
+
* title: 'Planning',
|
|
78
|
+
* start: new Date('2024-01-01'),
|
|
79
|
+
* end: new Date('2024-01-05'),
|
|
80
|
+
* subtasks: []
|
|
81
|
+
* }
|
|
82
|
+
* ];
|
|
83
|
+
* public dependencies = [
|
|
84
|
+
* { id: 1, fromId: 1, toId: 2, type: DependencyType.FS }
|
|
85
|
+
* ];
|
|
114
86
|
* }
|
|
115
87
|
* ```
|
|
88
|
+
*
|
|
89
|
+
* @remarks
|
|
90
|
+
* Supported children components are:
|
|
91
|
+
* {@link GanttColumnComponent},
|
|
92
|
+
* {@link GanttSpanColumnComponent},
|
|
93
|
+
* {@link GanttColumnGroupComponent},
|
|
94
|
+
* {@link TimelineDayViewComponent},
|
|
95
|
+
* {@link TimelineWeekViewComponent},
|
|
96
|
+
* {@link TimelineMonthViewComponent},
|
|
97
|
+
* {@link TimelineYearViewComponent},
|
|
98
|
+
* {@link CustomMessagesComponent}.
|
|
116
99
|
*/
|
|
117
100
|
export declare class GanttComponent implements AfterContentInit, OnChanges, OnDestroy, DataBoundTreeComponent, ExpandableTreeComponent {
|
|
118
101
|
private timelineViewService;
|
|
@@ -184,16 +167,14 @@ export declare class GanttComponent implements AfterContentInit, OnChanges, OnDe
|
|
|
184
167
|
set columns(columns: QueryList<GanttColumnBase>);
|
|
185
168
|
get columns(): QueryList<GanttColumnBase>;
|
|
186
169
|
/**
|
|
187
|
-
* Sets the fields
|
|
188
|
-
* The `id` field is also used as a
|
|
189
|
-
*
|
|
190
|
-
* > If no object is provided, the Gantt task data items will have to conform to the [`GanttTask`]({% slug api_gantt_gantttask %}) interface.
|
|
170
|
+
* Sets the fields used to extract task data from the `data` array items.
|
|
171
|
+
* The `id` field is also used as a unique identifier for TreeList data items.
|
|
172
|
+
* If not set, task data items must match the [`GanttTask`](slug:api_gantt_gantttask) interface.
|
|
191
173
|
*/
|
|
192
174
|
set taskModelFields(fields: GanttTaskModelFields);
|
|
193
175
|
/**
|
|
194
|
-
* Sets the fields
|
|
195
|
-
*
|
|
196
|
-
* > If no object is provided, the Gantt dependency data items will have to conform to the [`GanttDependency`]({% slug api_gantt_ganttdependency %}) interface.
|
|
176
|
+
* Sets the fields used to extract dependency data from the `dependencies` array items.
|
|
177
|
+
* If not set, dependency data items must match the [`GanttDependency`](slug:api_gantt_ganttdependency) interface.
|
|
197
178
|
*/
|
|
198
179
|
set dependencyModelFields(fields: GanttDependencyModelFields);
|
|
199
180
|
/**
|
|
@@ -201,7 +182,7 @@ export declare class GanttComponent implements AfterContentInit, OnChanges, OnDe
|
|
|
201
182
|
*/
|
|
202
183
|
views: QueryList<ViewBase>;
|
|
203
184
|
/**
|
|
204
|
-
*
|
|
185
|
+
* Sets the active timeline view.
|
|
205
186
|
* @default 'week'
|
|
206
187
|
*/
|
|
207
188
|
set activeView(view: TimelineViewType);
|
|
@@ -212,228 +193,199 @@ export declare class GanttComponent implements AfterContentInit, OnChanges, OnDe
|
|
|
212
193
|
*/
|
|
213
194
|
get activeViewCurrentTimeMarker(): boolean | CurrentTimeSettings;
|
|
214
195
|
/**
|
|
215
|
-
* Gets or sets the data
|
|
216
|
-
*
|
|
217
|
-
* > 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.
|
|
196
|
+
* Gets or sets the Gantt data.
|
|
197
|
+
* The task data items must match the [`GanttTask`]({% slug api_gantt_gantttask %}) interface or use [`taskModelFields`]({% slug api_gantt_ganttcomponent %}#toc-taskmodelfields).
|
|
218
198
|
*/
|
|
219
199
|
set data(data: any[]);
|
|
220
200
|
get data(): any[];
|
|
221
201
|
/**
|
|
222
|
-
* Specifies a callback
|
|
223
|
-
*
|
|
224
|
-
* > The [`selectable`]({% slug api_gantt_ganttcomponent %}#toc-selectable) prop has to be set to `true` in order for this callback to be executed.
|
|
202
|
+
* Specifies a callback to determine if a task is selected ([see example]({% slug selection_gantt %}#toc-custom-selection)).
|
|
203
|
+
* Set [`selectable`]({% slug api_gantt_ganttcomponent %}#toc-selectable) to `true` to use this callback.
|
|
225
204
|
*/
|
|
226
205
|
isSelected: (dataItem: object) => boolean;
|
|
227
206
|
/**
|
|
228
|
-
* Specifies a callback
|
|
229
|
-
*
|
|
230
|
-
* [see example]({% slug editing_drag_create_dependencies_gantt %}#toc-validation).
|
|
231
|
-
*
|
|
232
|
-
* By defalut, dependencies are deemed invalid when:
|
|
233
|
-
* - The two tasks are in a parent-child relationship.
|
|
234
|
-
* - The two tasks are already dependent on one another. Only one dependency is allowed per pair.
|
|
235
|
-
* - The start or end times of the two tasks are incompatible with the attempted dependency type.
|
|
207
|
+
* Specifies a callback to validate new dependencies.
|
|
208
|
+
* Use this callback to control the valid dependencies that users can create ([see example]({% slug editing_drag_create_dependencies_gantt %}#toc-validation)).
|
|
236
209
|
*/
|
|
237
210
|
validateNewDependency: (dependency: object) => boolean;
|
|
238
211
|
/**
|
|
239
|
-
* Fires when the Gantt selection
|
|
240
|
-
*
|
|
241
|
-
* Holds data about the affected [`items`]({% slug api_gantt_selectionchangeevent %}#toc-items) and the attempted [`action`]({% slug api_gantt_selectionchangeevent %}#toc-action):
|
|
242
|
-
* - `select` - Triggered on `click` or `ctrl + click` on deselected items.
|
|
243
|
-
* - `remove` - Triggered on `ctrl + click` on selected items.
|
|
212
|
+
* Fires when the Gantt selection changes through user interaction.
|
|
213
|
+
* The event data contains the affected items and the action type.
|
|
244
214
|
*/
|
|
245
215
|
selectionChange: EventEmitter<SelectionChangeEvent>;
|
|
246
216
|
/**
|
|
247
|
-
* Enables or disables the Gantt
|
|
248
|
-
*
|
|
217
|
+
* Enables or disables selection in the Gantt ([see example]({% slug selection_gantt %}#toc-custom-selection)).
|
|
218
|
+
* Set to `true` to allow selection.
|
|
249
219
|
* > When set to `true`, the [`isSelected`]({% slug api_gantt_ganttcomponent %}#toc-isselected) callback has to be provided.
|
|
250
220
|
* > When applied, the [`SelectableDirective`]({% slug api_gantt_selectabledirective %}) sets `selectable` to `true` internally.
|
|
221
|
+
* @default false
|
|
251
222
|
*/
|
|
252
223
|
selectable: boolean;
|
|
253
224
|
/**
|
|
254
|
-
*
|
|
255
|
-
*
|
|
256
|
-
* All are optional and default to `top`.
|
|
257
|
-
*
|
|
258
|
-
* The possible values for each option are:
|
|
259
|
-
* - `top`—Positions the toolbar above the Gantt panes. Renders the respective tool in the top toolbar.
|
|
260
|
-
* - `bottom`—Positions the toolbar below the Gantt panes. Renders the respective tool in the bottom toolbar.
|
|
261
|
-
* - `both`—Displays two toolbar instances. Positions the first one above,
|
|
262
|
-
* and the second one - below the Gantt panes. Renders the respective tool in the both toolbars.
|
|
263
|
-
* - `none`—No toolbar is rendered when used for setting `position`.
|
|
264
|
-
* No add task or view selector tool is rendered when used for setting `addTaskTool` or `viewSelectorTool`.
|
|
225
|
+
* Configures the toolbar position and content.
|
|
226
|
+
* Set `position`, `addTaskTool`, and `viewSelectorTool` as needed.
|
|
265
227
|
*/
|
|
266
228
|
set toolbarSettings(value: ToolbarSettings);
|
|
267
229
|
get toolbarSettings(): ToolbarSettings;
|
|
268
230
|
/**
|
|
269
|
-
*
|
|
270
|
-
*
|
|
231
|
+
* Sets the `aria-label` attribute value for the toolbar.
|
|
232
|
+
* Use this to improve accessibility.
|
|
233
|
+
* @default "Toolbar"
|
|
271
234
|
*/
|
|
272
235
|
toolbarAriaLabel: string;
|
|
273
236
|
/**
|
|
274
|
-
*
|
|
237
|
+
* Sets the callback function to retrieve child items for a data item.
|
|
275
238
|
*/
|
|
276
239
|
set fetchChildren(fn: (dataItem: any) => Observable<object[]> | object[]);
|
|
277
240
|
get fetchChildren(): (dataItem: any) => Observable<object[]> | object[];
|
|
278
241
|
/**
|
|
279
|
-
*
|
|
242
|
+
* Sets the callback function to indicate if a data item has child items.
|
|
280
243
|
*/
|
|
281
244
|
set hasChildren(fn: (dataItem: any) => boolean);
|
|
282
245
|
get hasChildren(): (dataItem: any) => boolean;
|
|
283
246
|
/**
|
|
284
|
-
*
|
|
285
|
-
*
|
|
286
|
-
* > 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.
|
|
247
|
+
* Sets the dependencies to display between tasks.
|
|
248
|
+
* Dependency data items must match the [`GanttDependency`]({% slug api_gantt_ganttdependency %}) interface or use [`dependencyModelFields`]({% slug api_gantt_ganttcomponent %}#toc-dependencymodelfields).
|
|
287
249
|
*/
|
|
288
250
|
dependencies: any[];
|
|
289
251
|
/**
|
|
290
|
-
* Enables
|
|
252
|
+
* Enables sorting for columns with a `field` option.
|
|
291
253
|
*/
|
|
292
254
|
sortable: SortSettings;
|
|
293
255
|
/**
|
|
294
|
-
*
|
|
256
|
+
* Sets the descriptors for sorting the data.
|
|
295
257
|
*/
|
|
296
258
|
sort: SortDescriptor[];
|
|
297
259
|
/**
|
|
298
|
-
* Enables
|
|
299
|
-
*
|
|
260
|
+
* Enables filtering for columns with a `field` option.
|
|
300
261
|
* @default false
|
|
301
262
|
*/
|
|
302
263
|
filterable: boolean;
|
|
303
264
|
/**
|
|
304
|
-
*
|
|
265
|
+
* Sets the descriptor for filtering the data.
|
|
305
266
|
*/
|
|
306
267
|
filter: CompositeFilterDescriptor;
|
|
307
268
|
/**
|
|
308
|
-
*
|
|
309
|
-
*
|
|
269
|
+
* Sets the start time of the work day in `HH:mm` format.
|
|
270
|
+
* @default "08:00"
|
|
310
271
|
*/
|
|
311
272
|
workDayStart: string;
|
|
312
273
|
/**
|
|
313
|
-
*
|
|
314
|
-
*
|
|
274
|
+
* Sets the end time of the work day in `HH:mm` format.
|
|
275
|
+
* @default "17:00"
|
|
315
276
|
*/
|
|
316
277
|
workDayEnd: string;
|
|
317
278
|
/**
|
|
318
|
-
*
|
|
279
|
+
* Sets the start day of the work week (index based).
|
|
280
|
+
* @default 1
|
|
319
281
|
*/
|
|
320
282
|
workWeekStart: Day;
|
|
321
283
|
/**
|
|
322
|
-
*
|
|
284
|
+
* Sets the end day of the work week (index based).
|
|
285
|
+
* @default 5
|
|
323
286
|
*/
|
|
324
287
|
workWeekEnd: Day;
|
|
325
288
|
/**
|
|
326
|
-
*
|
|
327
|
-
* By default, navigation is enabled for the TreeList and Timeline parts of the component
|
|
328
|
-
* ([see example]({% slug keyboard_navigation_gantt %})).
|
|
329
|
-
*
|
|
289
|
+
* Enables keyboard navigation for the Gantt.
|
|
290
|
+
* By default, navigation is enabled for the TreeList and Timeline parts of the component ([see example]({% slug keyboard_navigation_gantt %})).
|
|
330
291
|
* @default true
|
|
331
292
|
*/
|
|
332
293
|
navigable: boolean;
|
|
333
294
|
/**
|
|
334
|
-
*
|
|
335
|
-
*
|
|
295
|
+
* Sets the options for the timeline splitter pane.
|
|
296
|
+
* By default, the pane is collapsible, resizable, not collapsed, and its size is `'50%'`.
|
|
336
297
|
*/
|
|
337
298
|
set timelinePaneOptions(value: TimelinePaneOptions);
|
|
338
299
|
get timelinePaneOptions(): TimelinePaneOptions;
|
|
339
300
|
/**
|
|
340
|
-
*
|
|
341
|
-
* By default the pane is
|
|
301
|
+
* Sets the options for the treelist splitter pane.
|
|
302
|
+
* By default the pane is collapsible and not collapsed.
|
|
342
303
|
*/
|
|
343
304
|
set treeListPaneOptions(value: TreeListPaneOptions);
|
|
344
305
|
get treeListPaneOptions(): TreeListPaneOptions;
|
|
345
306
|
/**
|
|
346
|
-
*
|
|
347
|
-
* The
|
|
307
|
+
* Sets a function to apply custom CSS classes to each task.
|
|
308
|
+
* The function receives the task data item.
|
|
348
309
|
*/
|
|
349
310
|
set taskClass(fn: TaskClassFn);
|
|
350
311
|
get taskClass(): TaskClassFn;
|
|
351
312
|
/**
|
|
352
|
-
*
|
|
313
|
+
* Sets a function to apply custom CSS classes to each data row.
|
|
314
|
+
* The function receives the row data item.
|
|
353
315
|
*/
|
|
354
316
|
set rowClass(fn: RowClassFn);
|
|
355
317
|
get rowClass(): RowClassFn;
|
|
356
318
|
/**
|
|
357
|
-
*
|
|
358
|
-
*
|
|
319
|
+
* Gets the name of the field that contains the unique identifier for task data items.
|
|
320
|
+
* @default "id"
|
|
359
321
|
*/
|
|
360
322
|
get taskIdField(): any;
|
|
361
323
|
/**
|
|
362
|
-
* Sets
|
|
363
|
-
* If
|
|
324
|
+
* Sets a callback function to indicate if a data item is expanded.
|
|
325
|
+
* If not set, all items are expanded and no expand icons are shown.
|
|
364
326
|
*/
|
|
365
327
|
isExpanded: (item: object) => boolean;
|
|
366
328
|
/**
|
|
367
|
-
*
|
|
368
|
-
* Columns with autoSize set to false are excluded.
|
|
369
|
-
*
|
|
329
|
+
* Enables automatic resizing of columns to fit their content.
|
|
370
330
|
* @default false
|
|
371
331
|
*/
|
|
372
332
|
columnsAutoSize: boolean;
|
|
373
333
|
/**
|
|
374
|
-
*
|
|
375
|
-
*
|
|
376
|
-
* If the `currentTimeMarker` is set for a view then it takes precedence.
|
|
377
|
-
*
|
|
334
|
+
* Sets the current time marker settings for the Gantt.
|
|
335
|
+
* Applies to all views unless overridden by the settings of a particular view.
|
|
378
336
|
* @default true
|
|
379
337
|
*/
|
|
380
338
|
currentTimeMarker: boolean | CurrentTimeSettings;
|
|
381
339
|
/**
|
|
382
|
-
*
|
|
383
|
-
*
|
|
340
|
+
* Enables the column menu for all columns.
|
|
384
341
|
* @default false
|
|
385
342
|
*/
|
|
386
343
|
columnMenu: boolean | ColumnMenuSettings;
|
|
387
344
|
/**
|
|
388
|
-
*
|
|
389
|
-
*
|
|
345
|
+
* Enables reordering of the columns by dragging their header cells.
|
|
390
346
|
* @default false
|
|
391
347
|
*/
|
|
392
348
|
columnsReorderable: boolean;
|
|
393
349
|
/**
|
|
394
|
-
*
|
|
395
|
-
*
|
|
350
|
+
* Enables resizing of the columns by dragging the header cell edges (resize handles).
|
|
396
351
|
* @default false
|
|
397
352
|
*/
|
|
398
353
|
columnsResizable: boolean;
|
|
399
354
|
/**
|
|
400
|
-
*
|
|
401
|
-
* when the pointer moves outside of the container bounderies
|
|
402
|
-
* [see example]({% slug editing_drag_create_dependencies_gantt %}#toc-auto-scrolling).
|
|
355
|
+
* 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)).
|
|
403
356
|
*/
|
|
404
357
|
set dragScrollSettings(settings: DragScrollSettings);
|
|
405
358
|
get dragScrollSettings(): DragScrollSettings;
|
|
406
359
|
/**
|
|
407
|
-
*
|
|
408
|
-
*
|
|
360
|
+
* Sets the options for the task tooltip, such as `position`, `callout`, and `showAfter`.
|
|
409
361
|
* @default { position: 'top', callout: true, showAfter: 100 }
|
|
410
362
|
*/
|
|
411
363
|
taskTooltipOptions: TaskTooltipOptions;
|
|
412
364
|
/**
|
|
413
|
-
* Fires when
|
|
365
|
+
* Fires when a row is expanded.
|
|
414
366
|
*/
|
|
415
367
|
rowExpand: EventEmitter<ExpandEvent>;
|
|
416
368
|
/**
|
|
417
|
-
* Fires when a Gantt task in the timeline pane is double-clicked.
|
|
418
|
-
*
|
|
369
|
+
* Fires when a Gantt task in the timeline pane is double-clicked.
|
|
370
|
+
* The event data contains the clicked task. Use this event to open a task editing dialog if needed.
|
|
419
371
|
*/
|
|
420
372
|
taskDblClick: EventEmitter<TaskClickEvent>;
|
|
421
373
|
/**
|
|
422
|
-
* Fires when
|
|
374
|
+
* Fires when a cell is double-clicked.
|
|
423
375
|
*/
|
|
424
376
|
cellDblClick: EventEmitter<CellClickEvent>;
|
|
425
377
|
/**
|
|
426
|
-
* Fires when
|
|
378
|
+
* Fires when an edited cell is closed.
|
|
427
379
|
*/
|
|
428
380
|
cellClose: EventEmitter<CellCloseEvent>;
|
|
429
381
|
/**
|
|
430
|
-
* Fires when the
|
|
431
|
-
* the task delete icon, or presses the `Delete` key on
|
|
432
|
-
* Use
|
|
382
|
+
* Fires when the user clicks the `Delete` button in the task editing dialog,
|
|
383
|
+
* the task delete icon, or presses the `Delete` key on a focused task.
|
|
384
|
+
* Use this event to open a confirmation dialog if needed.
|
|
433
385
|
*/
|
|
434
386
|
taskDelete: EventEmitter<TaskDeleteEvent>;
|
|
435
387
|
/**
|
|
436
|
-
* Fires when
|
|
388
|
+
* Fires when a row is collapsed.
|
|
437
389
|
*/
|
|
438
390
|
rowCollapse: EventEmitter<ExpandEvent>;
|
|
439
391
|
/**
|
|
@@ -453,50 +405,50 @@ export declare class GanttComponent implements AfterContentInit, OnChanges, OnDe
|
|
|
453
405
|
*/
|
|
454
406
|
taskAdd: EventEmitter<TaskAddEvent>;
|
|
455
407
|
/**
|
|
456
|
-
* Fires when the user adds a dependency
|
|
457
|
-
* [see example]({% slug editing_drag_create_dependencies_gantt %}#toc-basic-concepts).
|
|
408
|
+
* Fires when the user adds a dependency by dragging [see example]({% slug editing_drag_create_dependencies_gantt %}#toc-basic-concepts).
|
|
458
409
|
*/
|
|
459
410
|
dependencyAdd: EventEmitter<DependencyAddEvent>;
|
|
460
411
|
/**
|
|
461
|
-
* Fires when
|
|
462
|
-
*
|
|
412
|
+
* Fires when there are changes in the Gantt sorting.
|
|
413
|
+
* Handle this event to sort the data.
|
|
463
414
|
*/
|
|
464
415
|
sortChange: EventEmitter<SortDescriptor[]>;
|
|
465
416
|
/**
|
|
466
|
-
* Fires when the Gantt
|
|
467
|
-
*
|
|
417
|
+
* Fires when there are changes in the Gantt filtering.
|
|
418
|
+
* Handle this event to filter the data.
|
|
468
419
|
*/
|
|
469
420
|
filterChange: EventEmitter<CompositeFilterDescriptor>;
|
|
470
421
|
/**
|
|
471
|
-
* Fires when the filter or sort state
|
|
422
|
+
* Fires when the filter or sort state changes.
|
|
472
423
|
*/
|
|
473
424
|
dataStateChange: EventEmitter<DataStateChangeEvent>;
|
|
474
425
|
/**
|
|
475
|
-
* Fires when the collapsed state of the treelist pane
|
|
426
|
+
* Fires when the collapsed state of the treelist pane changes.
|
|
476
427
|
*/
|
|
477
428
|
treeListPaneCollapsedChange: EventEmitter<boolean>;
|
|
478
429
|
/**
|
|
479
|
-
* Fires when the collapsed state of the timeline pane
|
|
430
|
+
* Fires when the collapsed state of the timeline pane changes.
|
|
480
431
|
*/
|
|
481
432
|
timelinePaneCollapsedChange: EventEmitter<boolean>;
|
|
482
433
|
/**
|
|
483
|
-
* Fires
|
|
434
|
+
* Fires when the user resizes the timeline pane.
|
|
484
435
|
*/
|
|
485
436
|
timelinePaneSizeChange: EventEmitter<string>;
|
|
486
437
|
/**
|
|
487
|
-
* Fires
|
|
438
|
+
* Fires when the user selects a different view type.
|
|
439
|
+
* The event data contains the type of the new view.
|
|
488
440
|
*/
|
|
489
441
|
activeViewChange: EventEmitter<TimelineViewType>;
|
|
490
442
|
/**
|
|
491
|
-
* Fires when the user completes
|
|
443
|
+
* Fires when the user completes resizing a column.
|
|
492
444
|
*/
|
|
493
445
|
columnResize: EventEmitter<ColumnResizeEvent[]>;
|
|
494
446
|
/**
|
|
495
|
-
* Fires when the user completes
|
|
447
|
+
* Fires when the user completes reordering a column.
|
|
496
448
|
*/
|
|
497
449
|
columnReorder: EventEmitter<ColumnReorderEvent>;
|
|
498
450
|
/**
|
|
499
|
-
* Fires when the user changes
|
|
451
|
+
* Fires when the user changes column visibility from the column menu or chooser.
|
|
500
452
|
*/
|
|
501
453
|
columnVisibilityChange: EventEmitter<ColumnVisibilityChangeEvent>;
|
|
502
454
|
/**
|
|
@@ -619,59 +571,56 @@ export declare class GanttComponent implements AfterContentInit, OnChanges, OnDe
|
|
|
619
571
|
ngOnDestroy(): void;
|
|
620
572
|
/**
|
|
621
573
|
* Focuses the last active cell or task in the Gantt.
|
|
622
|
-
* If no item
|
|
623
|
-
* ([see example]({% slug keyboard_navigation_gantt %}#toc-controlling-the-focus)).
|
|
574
|
+
* If no item was previously focused, focuses the first TreeList cell ([see example]({% slug keyboard_navigation_gantt %}#toc-controlling-the-focus)).
|
|
624
575
|
*/
|
|
625
576
|
focus(): void;
|
|
626
577
|
/**
|
|
627
|
-
* Focuses the
|
|
628
|
-
*
|
|
578
|
+
* Focuses the specified cell in the TreeList ([see example]({% slug keyboard_navigation_gantt %}#toc-controlling-the-focus)).
|
|
579
|
+
* @param rowIndex The row index.
|
|
580
|
+
* @param colIndex The column index.
|
|
629
581
|
*/
|
|
630
582
|
focusCell(rowIndex: number, colIndex: number): void;
|
|
631
583
|
/**
|
|
632
|
-
* Focuses the
|
|
633
|
-
*
|
|
584
|
+
* Focuses the specified task in the Timeline ([see example]({% slug keyboard_navigation_gantt %}#toc-controlling-the-focus)).
|
|
585
|
+
* @param taskIndex The index of the task.
|
|
634
586
|
*/
|
|
635
587
|
focusTask(taskIndex: number): void;
|
|
636
588
|
/**
|
|
637
|
-
*
|
|
638
|
-
*
|
|
639
|
-
*
|
|
640
|
-
* Makes sense to execute this method only after the Gantt is already populated with data.
|
|
589
|
+
* Sets the minimum width for the specified column so that its content fits.
|
|
590
|
+
* The Gantt must be resizable.
|
|
591
|
+
* @param column The column to auto-fit.
|
|
641
592
|
*/
|
|
642
593
|
autoFitColumn(column: GanttColumnBase): void;
|
|
643
594
|
/**
|
|
644
|
-
* Adjusts the width of the specified columns to fit
|
|
645
|
-
* If no columns are specified,
|
|
646
|
-
*
|
|
647
|
-
*
|
|
595
|
+
* Adjusts the width of the specified columns to fit their content.
|
|
596
|
+
* If no columns are specified, fits all columns.
|
|
597
|
+
* The Gantt must be resizable to use this method.
|
|
598
|
+
* @param columns The columns to auto-fit.
|
|
648
599
|
*/
|
|
649
600
|
autoFitColumns(columns?: Array<GanttColumnBase> | QueryList<GanttColumnBase>): void;
|
|
650
601
|
/**
|
|
651
|
-
* Clears
|
|
602
|
+
* Clears loaded children for the data item so the Gantt fetches them again.
|
|
603
|
+
* @param dataItem The data item to reload.
|
|
604
|
+
* @param reloadChildren Whether to reload children.
|
|
652
605
|
*/
|
|
653
606
|
reload(dataItem: any, reloadChildren?: boolean): void;
|
|
654
607
|
/**
|
|
655
608
|
* Changes the position of the specified column.
|
|
656
|
-
* The
|
|
657
|
-
*
|
|
658
|
-
*
|
|
659
|
-
*
|
|
660
|
-
*
|
|
661
|
-
* @param {ColumnBase} source - The column whose position will be changed.
|
|
662
|
-
* @param {number} destIndex - The new position of the column.
|
|
663
|
-
* @param {ColumnReorderConfig} options - Additional options.
|
|
609
|
+
* The source column must be visible.
|
|
610
|
+
* @param source The column to move.
|
|
611
|
+
* @param destIndex The new position index.
|
|
612
|
+
* @param options Additional options.
|
|
664
613
|
*/
|
|
665
614
|
reorderColumn(source: GanttColumnBase, destIndex: number, options?: ColumnReorderConfig): void;
|
|
666
615
|
/**
|
|
667
|
-
* Forces the
|
|
668
|
-
*
|
|
669
|
-
* Redraws changed dependencies, if needed.
|
|
670
|
-
* Executes all row-related callbacks anew.
|
|
616
|
+
* Forces the Gantt to re-evaluate data items and re-render the rows and Timeline period, if needed.
|
|
617
|
+
* Also redraws dependencies and executes row-related callbacks.
|
|
671
618
|
*/
|
|
672
619
|
updateView(): void;
|
|
673
620
|
/**
|
|
674
|
-
* Opens the task editing dialog.
|
|
621
|
+
* Opens the task editing dialog for the specified data item.
|
|
622
|
+
* @param dataItem The task data item.
|
|
623
|
+
* @param formGroup The form group for editing.
|
|
675
624
|
*/
|
|
676
625
|
editTask(dataItem: any, formGroup: FormGroup): void;
|
|
677
626
|
/**
|
|
@@ -688,10 +637,13 @@ export declare class GanttComponent implements AfterContentInit, OnChanges, OnDe
|
|
|
688
637
|
handleConfirmationDialogClose(): void;
|
|
689
638
|
/**
|
|
690
639
|
* Opens a cell for editing.
|
|
640
|
+
* @param dataItem The data item.
|
|
641
|
+
* @param column The column index, name, or object.
|
|
642
|
+
* @param formGroup The form group for editing.
|
|
691
643
|
*/
|
|
692
644
|
editCell(dataItem: any, column: number | string | any, formGroup?: FormGroup): void;
|
|
693
645
|
/**
|
|
694
|
-
* Closes
|
|
646
|
+
* Closes the currently edited cell.
|
|
695
647
|
*/
|
|
696
648
|
closeCell(): void;
|
|
697
649
|
/**
|