@bryntum/taskboard-angular 7.1.1
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/README.md +44 -0
- package/bryntum-taskboard-angular.d.ts +5 -0
- package/bundles/bryntum-taskboard-angular.umd.js +56826 -0
- package/bundles/bryntum-taskboard-angular.umd.js.map +1 -0
- package/esm2015/bryntum-taskboard-angular.js +5 -0
- package/esm2015/lib/bryntum-button-group.component.js +725 -0
- package/esm2015/lib/bryntum-button.component.js +715 -0
- package/esm2015/lib/bryntum-chat-panel.component.js +839 -0
- package/esm2015/lib/bryntum-checkbox-group.component.js +854 -0
- package/esm2015/lib/bryntum-checkbox.component.js +805 -0
- package/esm2015/lib/bryntum-chip-view.component.js +727 -0
- package/esm2015/lib/bryntum-code-editor.component.js +818 -0
- package/esm2015/lib/bryntum-color-field.component.js +794 -0
- package/esm2015/lib/bryntum-column-combo.component.js +936 -0
- package/esm2015/lib/bryntum-column-filter-field.component.js +799 -0
- package/esm2015/lib/bryntum-column-picker-button.component.js +719 -0
- package/esm2015/lib/bryntum-column-scroll-button.component.js +719 -0
- package/esm2015/lib/bryntum-combo.component.js +932 -0
- package/esm2015/lib/bryntum-container.component.js +681 -0
- package/esm2015/lib/bryntum-date-field.component.js +831 -0
- package/esm2015/lib/bryntum-date-picker.component.js +1008 -0
- package/esm2015/lib/bryntum-date-range-field.component.js +835 -0
- package/esm2015/lib/bryntum-date-time-field.component.js +752 -0
- package/esm2015/lib/bryntum-demo-code-editor.component.js +830 -0
- package/esm2015/lib/bryntum-demo-header.component.js +171 -0
- package/esm2015/lib/bryntum-display-field.component.js +772 -0
- package/esm2015/lib/bryntum-duration-field.component.js +815 -0
- package/esm2015/lib/bryntum-editor.component.js +823 -0
- package/esm2015/lib/bryntum-field-filter-picker-group.component.js +758 -0
- package/esm2015/lib/bryntum-field-filter-picker.component.js +740 -0
- package/esm2015/lib/bryntum-field-set.component.js +810 -0
- package/esm2015/lib/bryntum-file-field.component.js +776 -0
- package/esm2015/lib/bryntum-file-picker.component.js +709 -0
- package/esm2015/lib/bryntum-filter-field.component.js +803 -0
- package/esm2015/lib/bryntum-fullscreen-button.component.js +53 -0
- package/esm2015/lib/bryntum-hint.component.js +856 -0
- package/esm2015/lib/bryntum-label.component.js +584 -0
- package/esm2015/lib/bryntum-list.component.js +715 -0
- package/esm2015/lib/bryntum-menu.component.js +883 -0
- package/esm2015/lib/bryntum-month-picker.component.js +818 -0
- package/esm2015/lib/bryntum-number-field.component.js +800 -0
- package/esm2015/lib/bryntum-paging-toolbar.component.js +736 -0
- package/esm2015/lib/bryntum-panel.component.js +794 -0
- package/esm2015/lib/bryntum-password-field.component.js +768 -0
- package/esm2015/lib/bryntum-project-combo.component.js +940 -0
- package/esm2015/lib/bryntum-radio-group.component.js +826 -0
- package/esm2015/lib/bryntum-radio.component.js +805 -0
- package/esm2015/lib/bryntum-resources-combo.component.js +936 -0
- package/esm2015/lib/bryntum-scheduler-project-combo.component.js +936 -0
- package/esm2015/lib/bryntum-slide-toggle.component.js +805 -0
- package/esm2015/lib/bryntum-slider.component.js +661 -0
- package/esm2015/lib/bryntum-splitter.component.js +618 -0
- package/esm2015/lib/bryntum-swimlane-combo.component.js +936 -0
- package/esm2015/lib/bryntum-swimlane-filter-field.component.js +807 -0
- package/esm2015/lib/bryntum-swimlane-picker-button.component.js +719 -0
- package/esm2015/lib/bryntum-swimlane-scroll-button.component.js +719 -0
- package/esm2015/lib/bryntum-tab-panel.component.js +842 -0
- package/esm2015/lib/bryntum-tag-combo.component.js +940 -0
- package/esm2015/lib/bryntum-task-board-base.component.js +1678 -0
- package/esm2015/lib/bryntum-task-board-field-filter-picker-group.component.js +762 -0
- package/esm2015/lib/bryntum-task-board-field-filter-picker.component.js +732 -0
- package/esm2015/lib/bryntum-task-board-project-model.component.js +690 -0
- package/esm2015/lib/bryntum-task-board.component.js +1682 -0
- package/esm2015/lib/bryntum-task-color-combo.component.js +794 -0
- package/esm2015/lib/bryntum-task-filter-field.component.js +807 -0
- package/esm2015/lib/bryntum-text-area-field.component.js +776 -0
- package/esm2015/lib/bryntum-text-area-picker-field.component.js +798 -0
- package/esm2015/lib/bryntum-text-field.component.js +783 -0
- package/esm2015/lib/bryntum-time-field.component.js +819 -0
- package/esm2015/lib/bryntum-time-picker.component.js +709 -0
- package/esm2015/lib/bryntum-todo-list-field.component.js +780 -0
- package/esm2015/lib/bryntum-toolbar.component.js +732 -0
- package/esm2015/lib/bryntum-undo-redo.component.js +689 -0
- package/esm2015/lib/bryntum-widget.component.js +580 -0
- package/esm2015/lib/bryntum-year-picker.component.js +827 -0
- package/esm2015/lib/bryntum-zoom-slider.component.js +665 -0
- package/esm2015/lib/taskboard.module.js +374 -0
- package/esm2015/lib/wrapper.helper.js +74 -0
- package/esm2015/public-api.js +76 -0
- package/fesm2015/bryntum-taskboard-angular.js +56188 -0
- package/fesm2015/bryntum-taskboard-angular.js.map +1 -0
- package/lib/bryntum-button-group.component.d.ts +860 -0
- package/lib/bryntum-button.component.d.ts +845 -0
- package/lib/bryntum-chat-panel.component.d.ts +1060 -0
- package/lib/bryntum-checkbox-group.component.d.ts +1094 -0
- package/lib/bryntum-checkbox.component.d.ts +968 -0
- package/lib/bryntum-chip-view.component.d.ts +872 -0
- package/lib/bryntum-code-editor.component.d.ts +1045 -0
- package/lib/bryntum-color-field.component.d.ts +965 -0
- package/lib/bryntum-column-combo.component.d.ts +1208 -0
- package/lib/bryntum-column-filter-field.component.d.ts +988 -0
- package/lib/bryntum-column-picker-button.component.d.ts +853 -0
- package/lib/bryntum-column-scroll-button.component.d.ts +853 -0
- package/lib/bryntum-combo.component.d.ts +1199 -0
- package/lib/bryntum-container.component.d.ts +822 -0
- package/lib/bryntum-date-field.component.d.ts +1025 -0
- package/lib/bryntum-date-picker.component.d.ts +1338 -0
- package/lib/bryntum-date-range-field.component.d.ts +1027 -0
- package/lib/bryntum-date-time-field.component.d.ts +912 -0
- package/lib/bryntum-demo-code-editor.component.d.ts +1061 -0
- package/lib/bryntum-demo-header.component.d.ts +29 -0
- package/lib/bryntum-display-field.component.d.ts +949 -0
- package/lib/bryntum-duration-field.component.d.ts +1008 -0
- package/lib/bryntum-editor.component.d.ts +969 -0
- package/lib/bryntum-field-filter-picker-group.component.d.ts +935 -0
- package/lib/bryntum-field-filter-picker.component.d.ts +903 -0
- package/lib/bryntum-field-set.component.d.ts +1038 -0
- package/lib/bryntum-file-field.component.d.ts +952 -0
- package/lib/bryntum-file-picker.component.d.ts +847 -0
- package/lib/bryntum-filter-field.component.d.ts +993 -0
- package/lib/bryntum-fullscreen-button.component.d.ts +20 -0
- package/lib/bryntum-hint.component.d.ts +1117 -0
- package/lib/bryntum-label.component.d.ts +683 -0
- package/lib/bryntum-list.component.d.ts +849 -0
- package/lib/bryntum-menu.component.d.ts +1129 -0
- package/lib/bryntum-month-picker.component.d.ts +1034 -0
- package/lib/bryntum-number-field.component.d.ts +995 -0
- package/lib/bryntum-paging-toolbar.component.d.ts +886 -0
- package/lib/bryntum-panel.component.d.ts +1015 -0
- package/lib/bryntum-password-field.component.d.ts +939 -0
- package/lib/bryntum-project-combo.component.d.ts +1209 -0
- package/lib/bryntum-radio-group.component.d.ts +1068 -0
- package/lib/bryntum-radio.component.d.ts +968 -0
- package/lib/bryntum-resources-combo.component.d.ts +1207 -0
- package/lib/bryntum-scheduler-project-combo.component.d.ts +1201 -0
- package/lib/bryntum-slide-toggle.component.d.ts +968 -0
- package/lib/bryntum-slider.component.d.ts +776 -0
- package/lib/bryntum-splitter.component.d.ts +714 -0
- package/lib/bryntum-swimlane-combo.component.d.ts +1207 -0
- package/lib/bryntum-swimlane-filter-field.component.d.ts +1001 -0
- package/lib/bryntum-swimlane-picker-button.component.d.ts +853 -0
- package/lib/bryntum-swimlane-scroll-button.component.d.ts +853 -0
- package/lib/bryntum-tab-panel.component.d.ts +1065 -0
- package/lib/bryntum-tag-combo.component.d.ts +1212 -0
- package/lib/bryntum-task-board-base.component.d.ts +1921 -0
- package/lib/bryntum-task-board-field-filter-picker-group.component.d.ts +941 -0
- package/lib/bryntum-task-board-field-filter-picker.component.d.ts +889 -0
- package/lib/bryntum-task-board-project-model.component.d.ts +732 -0
- package/lib/bryntum-task-board.component.d.ts +1923 -0
- package/lib/bryntum-task-color-combo.component.d.ts +965 -0
- package/lib/bryntum-task-filter-field.component.d.ts +1001 -0
- package/lib/bryntum-text-area-field.component.d.ts +951 -0
- package/lib/bryntum-text-area-picker-field.component.d.ts +972 -0
- package/lib/bryntum-text-field.component.d.ts +957 -0
- package/lib/bryntum-time-field.component.d.ts +1006 -0
- package/lib/bryntum-time-picker.component.d.ts +853 -0
- package/lib/bryntum-todo-list-field.component.d.ts +955 -0
- package/lib/bryntum-toolbar.component.d.ts +879 -0
- package/lib/bryntum-undo-redo.component.d.ts +831 -0
- package/lib/bryntum-widget.component.d.ts +678 -0
- package/lib/bryntum-year-picker.component.d.ts +1049 -0
- package/lib/bryntum-zoom-slider.component.d.ts +784 -0
- package/lib/taskboard.module.d.ts +77 -0
- package/lib/wrapper.helper.d.ts +26 -0
- package/package.json +33 -0
- package/public-api.d.ts +72 -0
|
@@ -0,0 +1,1921 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* Angular wrapper for Bryntum TaskBoardBase
|
|
3
|
+
*/
|
|
4
|
+
import { ElementRef, SimpleChanges, OnDestroy, OnInit } from '@angular/core';
|
|
5
|
+
import { AlignSpec, AssignmentModel, AssignmentModelConfig, Base, BryntumScrollOptions, CardSize, ColumnDrag, ColumnDragConfig, ColumnFilter, ColumnFilterConfig, ColumnHeaderMenu, ColumnHeaderMenuConfig, ColumnLock, ColumnLockConfig, ColumnModel, ColumnModelConfig, ColumnRename, ColumnRenameConfig, ColumnResize, ColumnResizeConfig, ColumnSort, ColumnSortConfig, ColumnToolbars, ColumnToolbarsConfig, ContainerItemConfig, DomConfig, FilterBar, FilterBarConfig, KeyMapConfig, Mask, MaskConfig, Model, PagingToolbarConfig, PanelCollapserConfig, PanelCollapserOverlayConfig, PanelHeader, ProjectModel, ProjectModelConfig, Rectangle, ResourceModel, ResourceModelConfig, ScrollManagerConfig, Scroller, ScrollerConfig, SimpleTaskEdit, SimpleTaskEditConfig, StateProvider, Store, StoreConfig, SwimlaneDrag, SwimlaneDragConfig, SwimlaneModel, SwimlaneModelConfig, TabConfig, TaskBoardBase, TaskBoardBaseListeners, TaskDrag, TaskDragConfig, TaskDragSelect, TaskDragSelectConfig, TaskEdit, TaskEditConfig, TaskItemOptions, TaskMenu, TaskMenuConfig, TaskModel, TaskModelConfig, TaskTooltip, TaskTooltipConfig, Tool, ToolConfig, ToolbarConfig, ToolbarItems, Widget } from '@bryntum/taskboard';
|
|
6
|
+
import * as i0 from "@angular/core";
|
|
7
|
+
export declare type BryntumTaskBoardBaseProps = {
|
|
8
|
+
/**
|
|
9
|
+
* The name of the event that should activate a task and trigger editing (if an editing feature is active).
|
|
10
|
+
* Available options are: 'taskClick', 'taskDblClick' or null (disable)
|
|
11
|
+
*/
|
|
12
|
+
activateTaskEvent?: 'taskClick' | 'taskDblClick' | null;
|
|
13
|
+
/**
|
|
14
|
+
* Element (or element id) to adopt as this Widget's encapsulating element. The widget's
|
|
15
|
+
* content will be placed inside this element.
|
|
16
|
+
* ...
|
|
17
|
+
* [View online docs...](https://bryntum.com/products/taskboard/docs/api/TaskBoard/view/TaskBoardBase#config-adopt)
|
|
18
|
+
*/
|
|
19
|
+
adopt?: HTMLElement | string;
|
|
20
|
+
/**
|
|
21
|
+
* *Only valid if this Widget is [floating](https://bryntum.com/products/taskboard/docs/api/Core/widget/Widget#config-floating).*
|
|
22
|
+
* ...
|
|
23
|
+
* [View online docs...](https://bryntum.com/products/taskboard/docs/api/TaskBoard/view/TaskBoardBase#config-align)
|
|
24
|
+
*/
|
|
25
|
+
align?: AlignSpec | string;
|
|
26
|
+
/**
|
|
27
|
+
* When this widget is a child of a [Container](https://bryntum.com/products/taskboard/docs/api/Core/widget/Container), it will by default be participating in a
|
|
28
|
+
* flexbox layout. This config allows you to set this widget's
|
|
29
|
+
* [align-self](https://developer.mozilla.org/en-US/docs/Web/CSS/align-self) style.
|
|
30
|
+
*/
|
|
31
|
+
alignSelf?: string;
|
|
32
|
+
/**
|
|
33
|
+
* *Only valid if this Widget is [floating](https://bryntum.com/products/taskboard/docs/api/Core/widget/Widget#config-floating) and being shown through [showBy](#Core/widget/Widget#function-showBy).*
|
|
34
|
+
* `true` to show a connector arrow pointing to the align target.
|
|
35
|
+
*/
|
|
36
|
+
anchor?: boolean;
|
|
37
|
+
/**
|
|
38
|
+
* Element (or the id of an element) to append this widget's element to. Can be configured, or set once at
|
|
39
|
+
* runtime. To access the element of a rendered widget, see [element](https://bryntum.com/products/taskboard/docs/api/Core/widget/Widget#property-element).
|
|
40
|
+
*/
|
|
41
|
+
appendTo?: HTMLElement | string;
|
|
42
|
+
/**
|
|
43
|
+
* A localizable string (May contain `'L{}'` tokens which resolve in the locale file) to inject
|
|
44
|
+
* into an element which will be linked using the `aria-describedby` attribute.
|
|
45
|
+
* ...
|
|
46
|
+
* [View online docs...](https://bryntum.com/products/taskboard/docs/api/TaskBoard/view/TaskBoardBase#config-ariaDescription)
|
|
47
|
+
*/
|
|
48
|
+
ariaDescription?: string;
|
|
49
|
+
/**
|
|
50
|
+
* A localizable string (May contain `'L{}'` tokens which resolve in the locale file) to inject as
|
|
51
|
+
* the `aria-label` attribute.
|
|
52
|
+
* ...
|
|
53
|
+
* [View online docs...](https://bryntum.com/products/taskboard/docs/api/TaskBoard/view/TaskBoardBase#config-ariaLabel)
|
|
54
|
+
*/
|
|
55
|
+
ariaLabel?: string;
|
|
56
|
+
/**
|
|
57
|
+
* Inline [assignments](https://bryntum.com/products/scheduler/docs#Scheduler/model/AssignmentModel), will be loaded into an internally created
|
|
58
|
+
* [AssignmentStore](https://bryntum.com/products/scheduler/docs#Scheduler/data/AssignmentStore) as a part of a [project](https://bryntum.com/products/taskboard/docs/api/TaskBoard/model/ProjectModel).
|
|
59
|
+
*/
|
|
60
|
+
assignments?: AssignmentModel[] | object[] | AssignmentModelConfig[];
|
|
61
|
+
/**
|
|
62
|
+
* Set to `true` to auto generate columns when [columns](https://bryntum.com/products/taskboard/docs/api/TaskBoard/view/mixin/TaskBoardColumns#config-columns) is undefined.
|
|
63
|
+
* ...
|
|
64
|
+
* [View online docs...](https://bryntum.com/products/taskboard/docs/api/TaskBoard/view/TaskBoardBase#config-autoGenerateColumns)
|
|
65
|
+
*/
|
|
66
|
+
autoGenerateColumns?: boolean;
|
|
67
|
+
/**
|
|
68
|
+
* Set to `true` to auto generate swimlanes when [swimlanes](https://bryntum.com/products/taskboard/docs/api/TaskBoard/view/mixin/TaskBoardSwimlanes#config-swimlanes) is undefined.
|
|
69
|
+
* ...
|
|
70
|
+
* [View online docs...](https://bryntum.com/products/taskboard/docs/api/TaskBoard/view/TaskBoardBase#config-autoGenerateSwimlanes)
|
|
71
|
+
*/
|
|
72
|
+
autoGenerateSwimlanes?: boolean;
|
|
73
|
+
/**
|
|
74
|
+
* A Config object representing the configuration of a [Toolbar](https://bryntum.com/products/taskboard/docs/api/Core/widget/Toolbar),
|
|
75
|
+
* or array of config objects representing the child items of a Toolbar. Another way to add a bbar is to use [strips](https://bryntum.com/products/taskboard/docs/api/Core/widget/Panel#config-strips).
|
|
76
|
+
* ...
|
|
77
|
+
* [View online docs...](https://bryntum.com/products/taskboard/docs/api/TaskBoard/view/TaskBoardBase#config-bbar)
|
|
78
|
+
*/
|
|
79
|
+
bbar?: (ContainerItemConfig | string)[] | ToolbarConfig | PagingToolbarConfig | null;
|
|
80
|
+
/**
|
|
81
|
+
* Custom CSS classes to add to the panel's body element.
|
|
82
|
+
* ...
|
|
83
|
+
* [View online docs...](https://bryntum.com/products/taskboard/docs/api/TaskBoard/view/TaskBoardBase#config-bodyCls)
|
|
84
|
+
*/
|
|
85
|
+
bodyCls?: string | object;
|
|
86
|
+
/**
|
|
87
|
+
* Items to add to each card's body.
|
|
88
|
+
* ...
|
|
89
|
+
* [View online docs...](https://bryntum.com/products/taskboard/docs/api/TaskBoard/view/TaskBoardBase#config-bodyItems)
|
|
90
|
+
*/
|
|
91
|
+
bodyItems?: Record<string, TaskItemOptions>;
|
|
92
|
+
/**
|
|
93
|
+
* An object where property names with a truthy value indicate which events should bubble up the ownership
|
|
94
|
+
* hierarchy when triggered.
|
|
95
|
+
* ...
|
|
96
|
+
* [View online docs...](https://bryntum.com/products/taskboard/docs/api/TaskBoard/view/TaskBoardBase#config-bubbleEvents)
|
|
97
|
+
*/
|
|
98
|
+
bubbleEvents?: object;
|
|
99
|
+
/**
|
|
100
|
+
* Set to `false` to not call onXXX method names (e.g. `onShow`, `onClick`), as an easy way to listen for events.
|
|
101
|
+
* ...
|
|
102
|
+
* [View online docs...](https://bryntum.com/products/taskboard/docs/api/TaskBoard/view/TaskBoardBase#config-callOnFunctions)
|
|
103
|
+
*/
|
|
104
|
+
callOnFunctions?: boolean;
|
|
105
|
+
/**
|
|
106
|
+
* An array of [CardSize](https://bryntum.com/products/taskboard/docs/api/TaskBoard/view/mixin/ResponsiveCards#typedef-CardSize) objects to use as responsive levels based on card widths.
|
|
107
|
+
* ...
|
|
108
|
+
* [View online docs...](https://bryntum.com/products/taskboard/docs/api/TaskBoard/view/TaskBoardBase#config-cardSizes)
|
|
109
|
+
*/
|
|
110
|
+
cardSizes?: CardSize;
|
|
111
|
+
/**
|
|
112
|
+
* By default, if an event handler throws an exception, the error propagates up the stack and the
|
|
113
|
+
* application state is undefined. Code which follows the event handler will *not* be executed.
|
|
114
|
+
* ...
|
|
115
|
+
* [View online docs...](https://bryntum.com/products/taskboard/docs/api/TaskBoard/view/TaskBoardBase#config-catchEventHandlerExceptions)
|
|
116
|
+
*/
|
|
117
|
+
catchEventHandlerExceptions?: boolean;
|
|
118
|
+
/**
|
|
119
|
+
* *Only valid if this Widget is [floating](https://bryntum.com/products/taskboard/docs/api/Core/widget/Widget#config-floating).*
|
|
120
|
+
* Set to `true` to centre the Widget in browser viewport space.
|
|
121
|
+
*/
|
|
122
|
+
centered?: boolean;
|
|
123
|
+
/**
|
|
124
|
+
* Columns hold their tasks in stores chained off the project's task store. Filters applied to the project store
|
|
125
|
+
* are by default not applied to the column stores; they are only affected by their own filters. By configuring
|
|
126
|
+
* `chainFilters : true`, the filters from the project store will also be taken into account when filtering the
|
|
127
|
+
* columns.
|
|
128
|
+
* ...
|
|
129
|
+
* [View online docs...](https://bryntum.com/products/taskboard/docs/api/TaskBoard/view/TaskBoardBase#config-chainFilters)
|
|
130
|
+
*/
|
|
131
|
+
chainFilters?: boolean;
|
|
132
|
+
/**
|
|
133
|
+
* Custom CSS classes to add to element.
|
|
134
|
+
* May be specified as a space separated string, or as an object in which property names
|
|
135
|
+
* with truthy values are used as the class names:
|
|
136
|
+
* ...
|
|
137
|
+
* [View online docs...](https://bryntum.com/products/taskboard/docs/api/TaskBoard/view/TaskBoardBase#config-cls)
|
|
138
|
+
*/
|
|
139
|
+
cls?: string | object;
|
|
140
|
+
/**
|
|
141
|
+
* Controls whether the panel is collapsed (the body of the panel is hidden while only the header is
|
|
142
|
+
* visible). Only valid if the panel is [collapsible](https://bryntum.com/products/taskboard/docs/api/Core/widget/Panel#config-collapsible).
|
|
143
|
+
*/
|
|
144
|
+
collapsed?: boolean;
|
|
145
|
+
/**
|
|
146
|
+
* Specify `true` to hide the column title instead of rotating it on collapse.
|
|
147
|
+
* ...
|
|
148
|
+
* [View online docs...](https://bryntum.com/products/taskboard/docs/api/TaskBoard/view/TaskBoardBase#config-collapseTitle)
|
|
149
|
+
*/
|
|
150
|
+
collapseTitle?: boolean;
|
|
151
|
+
/**
|
|
152
|
+
* This config enables collapsibility for the panel. See [collapsed](https://bryntum.com/products/taskboard/docs/api/Core/widget/Panel#config-collapsed).
|
|
153
|
+
* ...
|
|
154
|
+
* [View online docs...](https://bryntum.com/products/taskboard/docs/api/TaskBoard/view/TaskBoardBase#config-collapsible)
|
|
155
|
+
*/
|
|
156
|
+
collapsible?: boolean | PanelCollapserConfig | PanelCollapserOverlayConfig;
|
|
157
|
+
/**
|
|
158
|
+
* Applies the specified color to the widget, by setting the `--b-primary` CSS variable in the widgets
|
|
159
|
+
* `style` block.
|
|
160
|
+
* ...
|
|
161
|
+
* [View online docs...](https://bryntum.com/products/taskboard/docs/api/TaskBoard/view/TaskBoardBase#config-color)
|
|
162
|
+
*/
|
|
163
|
+
color?: string;
|
|
164
|
+
/**
|
|
165
|
+
* Programmatic control over which column to start in when used in a grid layout.
|
|
166
|
+
*/
|
|
167
|
+
column?: number;
|
|
168
|
+
/**
|
|
169
|
+
* Field on a task record used to determine which column the task belongs to.
|
|
170
|
+
* ...
|
|
171
|
+
* [View online docs...](https://bryntum.com/products/taskboard/docs/api/TaskBoard/view/TaskBoardBase#config-columnField)
|
|
172
|
+
*/
|
|
173
|
+
columnField?: string;
|
|
174
|
+
/**
|
|
175
|
+
* Store containing the TaskBoard columns. A tasks [columnField](https://bryntum.com/products/taskboard/docs/api/TaskBoard/view/mixin/TaskBoardColumns#config-columnField) is matched against the `id` of a
|
|
176
|
+
* column to determine in which column it is displayed.
|
|
177
|
+
* ...
|
|
178
|
+
* [View online docs...](https://bryntum.com/products/taskboard/docs/api/TaskBoard/view/TaskBoardBase#config-columns)
|
|
179
|
+
*/
|
|
180
|
+
columns?: ColumnModel[] | ColumnModelConfig[] | string[] | Store | string | StoreConfig;
|
|
181
|
+
/**
|
|
182
|
+
* A function which renders the text, HTML, or `DomConfig` object to show as the column title. If you provide a
|
|
183
|
+
* `DomConfig` object, it will replace the title element and you are responsible for styling it + laying it out.
|
|
184
|
+
* ...
|
|
185
|
+
* [View online docs...](https://bryntum.com/products/taskboard/docs/api/TaskBoard/view/TaskBoardBase#config-columnTitleRenderer)
|
|
186
|
+
* @param {object} renderData
|
|
187
|
+
* @param {TaskBoard.model.ColumnModel} columnRecord The column instance
|
|
188
|
+
* @returns {string,DomConfig}
|
|
189
|
+
*/
|
|
190
|
+
columnTitleRenderer?: (renderData: object, columnRecord: ColumnModel) => string | DomConfig;
|
|
191
|
+
config?: object;
|
|
192
|
+
/**
|
|
193
|
+
* *Only valid if this Widget is [floating](https://bryntum.com/products/taskboard/docs/api/Core/widget/Widget#config-floating) or [positioned](#Core/widget/Widget#config-positioned).*
|
|
194
|
+
* Element, Widget or Rectangle to which this Widget is constrained.
|
|
195
|
+
*/
|
|
196
|
+
constrainTo?: HTMLElement | Widget | Rectangle;
|
|
197
|
+
/**
|
|
198
|
+
* Initial CSS variables to set.
|
|
199
|
+
* ...
|
|
200
|
+
* [View online docs...](https://bryntum.com/products/taskboard/docs/api/TaskBoard/view/TaskBoardBase#config-css)
|
|
201
|
+
*/
|
|
202
|
+
css?: Record<string, string>;
|
|
203
|
+
/**
|
|
204
|
+
* CSS variable prefix, appended to the keys used in [css](https://bryntum.com/products/taskboard/docs/api/TaskBoard/view/TaskBoardBase#config-css).
|
|
205
|
+
* ...
|
|
206
|
+
* [View online docs...](https://bryntum.com/products/taskboard/docs/api/TaskBoard/view/TaskBoardBase#config-cssVarPrefix)
|
|
207
|
+
*/
|
|
208
|
+
cssVarPrefix?: string;
|
|
209
|
+
/**
|
|
210
|
+
* When this Widget configuration is used in the Grid's RowExpander feature's `widget` config, provide the
|
|
211
|
+
* field on the expanded record to use for populating this widget's store (if applicable)
|
|
212
|
+
*/
|
|
213
|
+
dataField?: string;
|
|
214
|
+
/**
|
|
215
|
+
* Object to apply to elements dataset (each key will be used as a data-attribute on the element)
|
|
216
|
+
*/
|
|
217
|
+
dataset?: Record<string, string>;
|
|
218
|
+
/**
|
|
219
|
+
* Check for CSS compatibility issues when upgrading to v7. Performs the following checks:
|
|
220
|
+
* ...
|
|
221
|
+
* [View online docs...](https://bryntum.com/products/taskboard/docs/api/TaskBoard/view/TaskBoardBase#config-detectCSSCompatibilityIssues)
|
|
222
|
+
*/
|
|
223
|
+
detectCSSCompatibilityIssues?: boolean;
|
|
224
|
+
/**
|
|
225
|
+
* Disable or enable the widget. It is similar to [readOnly](https://bryntum.com/products/taskboard/docs/api/Core/widget/Widget#config-readOnly) except a disabled widget
|
|
226
|
+
* cannot be focused, uses a different rendition (usually greyish) and does not allow selecting its value.
|
|
227
|
+
* ...
|
|
228
|
+
* [View online docs...](https://bryntum.com/products/taskboard/docs/api/TaskBoard/view/TaskBoardBase#config-disabled)
|
|
229
|
+
*/
|
|
230
|
+
disabled?: boolean | 'inert';
|
|
231
|
+
/**
|
|
232
|
+
* Controls the placement of this widget when it is added to a [panel's ](https://bryntum.com/products/taskboard/docs/api/Core/widget/Panel)
|
|
233
|
+
* [strips collection](https://bryntum.com/products/taskboard/docs/api/Core/widget/Panel#config-strips). Typical values for this config are `'top'`,
|
|
234
|
+
* `'bottom'`, `'left'`, or `'right'`, which cause the widget to be placed on that side of the panel's
|
|
235
|
+
* body. Such widgets are called "edge strips".
|
|
236
|
+
* ...
|
|
237
|
+
* [View online docs...](https://bryntum.com/products/taskboard/docs/api/TaskBoard/view/TaskBoardBase#config-dock)
|
|
238
|
+
*/
|
|
239
|
+
dock?: 'top' | 'bottom' | 'left' | 'right' | 'start' | 'end' | 'header' | 'pre-header' | object;
|
|
240
|
+
/**
|
|
241
|
+
* *Only valid if this Widget is [floating](https://bryntum.com/products/taskboard/docs/api/Core/widget/Widget#config-floating).*
|
|
242
|
+
* Set to `true` to be able to drag a widget freely on the page. Or set to an object with a ´handleSelector´
|
|
243
|
+
* property which controls when a drag should start.
|
|
244
|
+
* ...
|
|
245
|
+
* [View online docs...](https://bryntum.com/products/taskboard/docs/api/TaskBoard/view/TaskBoardBase#config-draggable)
|
|
246
|
+
*/
|
|
247
|
+
draggable?: boolean | {
|
|
248
|
+
handleSelector?: string;
|
|
249
|
+
};
|
|
250
|
+
/**
|
|
251
|
+
* Make this Panel a docked drawer which slides out from one side of the browser viewport by default.
|
|
252
|
+
* ...
|
|
253
|
+
* [View online docs...](https://bryntum.com/products/taskboard/docs/api/TaskBoard/view/TaskBoardBase#config-drawer)
|
|
254
|
+
* @param {'start','left','end','right','top','bottom'} side The side of the viewport to dock the drawer to. * `'start'` means the `inline-start` side. * `'end'` means the `inline-end` side.
|
|
255
|
+
* @param {string,number} size The size of the drawer in its collapsible axis.
|
|
256
|
+
* @param {boolean} inline If using the [appendTo](https://bryntum.com/products/taskboard/docs/api/Core/widget/Panel#config-appendTo) config to place the drawer inside a host widget, this may be set to `true` to make the drawer inline within that host. Note that, if using this, the layout of the host element must have `flex-direction` set appropriately.
|
|
257
|
+
* @param {boolean,object} autoClose Specifies what user actions should automatically close the drawer. Defaults to closing when the user clicks outside of the drawer or when focus moves outside of the drawer.
|
|
258
|
+
* @param {boolean,string} autoClose.mousedown If the user clicks outside of the drawer, the drawer will automatically be hidden. If the value is a string, it is used as a CSS selector to filter clicks which should close the drawer.
|
|
259
|
+
* @param {boolean,string} autoClose.focusout If focus moves outside of the drawer, the drawer will automatically be hidden.
|
|
260
|
+
* @param {string} autoClose.mouseout Hides the drawer when the mouse leaves the drawer after the `autoCloseDelay` period.
|
|
261
|
+
* @param {number} autoCloseDelay When using `mouseout`, this is the delay in milliseconds
|
|
262
|
+
*/
|
|
263
|
+
drawer?: boolean | {
|
|
264
|
+
side?: 'start' | 'left' | 'end' | 'right' | 'top' | 'bottom';
|
|
265
|
+
size?: string | number;
|
|
266
|
+
inline?: boolean;
|
|
267
|
+
autoClose: {
|
|
268
|
+
mousedown?: boolean | string;
|
|
269
|
+
focusout?: boolean | string;
|
|
270
|
+
mouseout?: string;
|
|
271
|
+
};
|
|
272
|
+
autoCloseDelay?: number;
|
|
273
|
+
};
|
|
274
|
+
/**
|
|
275
|
+
* Whether to draw cards on scroll, or only when scrolling ends.
|
|
276
|
+
* ...
|
|
277
|
+
* [View online docs...](https://bryntum.com/products/taskboard/docs/api/TaskBoard/view/TaskBoardBase#config-drawOnScroll)
|
|
278
|
+
*/
|
|
279
|
+
drawOnScroll?: boolean;
|
|
280
|
+
/**
|
|
281
|
+
* An object specifying attributes to assign to the root element of this widget.
|
|
282
|
+
* Set `null` value to attribute to remove it.
|
|
283
|
+
* ...
|
|
284
|
+
* [View online docs...](https://bryntum.com/products/taskboard/docs/api/TaskBoard/view/TaskBoardBase#config-elementAttributes)
|
|
285
|
+
*/
|
|
286
|
+
elementAttributes?: Record<string, string | null>;
|
|
287
|
+
extraData?: any;
|
|
288
|
+
/**
|
|
289
|
+
* When this widget is a child of a [Container](https://bryntum.com/products/taskboard/docs/api/Core/widget/Container), it will by default be participating in a
|
|
290
|
+
* flexbox layout. This config allows you to set this widget's
|
|
291
|
+
* [flex](https://developer.mozilla.org/en-US/docs/Web/CSS/flex) style.
|
|
292
|
+
* This may be configured as a single number or a `<flex-grow> <flex-shrink> <flex-basis>` format string.
|
|
293
|
+
* numeric-only values are interpreted as the `flex-grow` value.
|
|
294
|
+
*/
|
|
295
|
+
flex?: number | string;
|
|
296
|
+
/**
|
|
297
|
+
* Set to `true` to move the widget out of the document flow and position it
|
|
298
|
+
* absolutely in browser viewport space.
|
|
299
|
+
*/
|
|
300
|
+
floating?: boolean;
|
|
301
|
+
/**
|
|
302
|
+
* Config object of a footer. May contain a `dock`, `html` and a `cls` property. A footer is not a widget,
|
|
303
|
+
* but rather plain HTML that follows the last element of the panel's body and [strips](https://bryntum.com/products/taskboard/docs/api/Core/widget/Panel#config-strips).
|
|
304
|
+
* ...
|
|
305
|
+
* [View online docs...](https://bryntum.com/products/taskboard/docs/api/TaskBoard/view/TaskBoardBase#config-footer)
|
|
306
|
+
*/
|
|
307
|
+
footer?: {
|
|
308
|
+
dock?: 'top' | 'right' | 'bottom' | 'left' | 'start' | 'end';
|
|
309
|
+
html?: string;
|
|
310
|
+
cls?: string;
|
|
311
|
+
} | string;
|
|
312
|
+
/**
|
|
313
|
+
* Items to add to each card's footer.
|
|
314
|
+
* ...
|
|
315
|
+
* [View online docs...](https://bryntum.com/products/taskboard/docs/api/TaskBoard/view/TaskBoardBase#config-footerItems)
|
|
316
|
+
*/
|
|
317
|
+
footerItems?: Record<string, TaskItemOptions>;
|
|
318
|
+
/**
|
|
319
|
+
* The function is called for each task as part of the render loop, and is expected to return the height in
|
|
320
|
+
* pixels for the task. Using this function is only recommended when using partial virtualized rendering, see
|
|
321
|
+
* the [virtualize](https://bryntum.com/products/taskboard/docs/api/TaskBoard/view/mixin/TaskBoardVirtualization#config-virtualize) setting.
|
|
322
|
+
* ...
|
|
323
|
+
* [View online docs...](https://bryntum.com/products/taskboard/docs/api/TaskBoard/view/TaskBoardBase#config-getTaskHeight)
|
|
324
|
+
* @param {TaskBoard.model.TaskModel} taskRecord The task record
|
|
325
|
+
* @returns {number} The height of the task in pixels
|
|
326
|
+
*/
|
|
327
|
+
getTaskHeight?: (taskRecord: TaskModel) => number;
|
|
328
|
+
/**
|
|
329
|
+
* A config [object](https://bryntum.com/products/taskboard/docs/api/Core/widget/Panel#typedef-PanelHeader) for the panel's header or a string in place of a `title`.
|
|
330
|
+
* ...
|
|
331
|
+
* [View online docs...](https://bryntum.com/products/taskboard/docs/api/TaskBoard/view/TaskBoardBase#config-header)
|
|
332
|
+
*/
|
|
333
|
+
header?: string | boolean | PanelHeader;
|
|
334
|
+
/**
|
|
335
|
+
* Items to add to each card's header.
|
|
336
|
+
* ...
|
|
337
|
+
* [View online docs...](https://bryntum.com/products/taskboard/docs/api/TaskBoard/view/TaskBoardBase#config-headerItems)
|
|
338
|
+
*/
|
|
339
|
+
headerItems?: Record<string, TaskItemOptions>;
|
|
340
|
+
/**
|
|
341
|
+
* Widget's height, used to set element `style.height`. Either specify a valid height string or a number,
|
|
342
|
+
* which will get 'px' appended. We recommend using CSS as the primary way to control height, but in some
|
|
343
|
+
* cases this config is convenient.
|
|
344
|
+
*/
|
|
345
|
+
height?: string | number;
|
|
346
|
+
/**
|
|
347
|
+
* Configure with true to make widget initially hidden.
|
|
348
|
+
*/
|
|
349
|
+
hidden?: boolean;
|
|
350
|
+
/**
|
|
351
|
+
* *Only valid if this Widget is [floating](https://bryntum.com/products/taskboard/docs/api/Core/widget/Widget#config-floating).*
|
|
352
|
+
* ...
|
|
353
|
+
* [View online docs...](https://bryntum.com/products/taskboard/docs/api/TaskBoard/view/TaskBoardBase#config-hideAnimation)
|
|
354
|
+
*/
|
|
355
|
+
hideAnimation?: boolean | object;
|
|
356
|
+
/**
|
|
357
|
+
* By default, the header text is HTML-encoded. Set this flag to `false` disable this and allow html
|
|
358
|
+
* elements in the column headers. Can also be specified on a single
|
|
359
|
+
* [column](https://bryntum.com/products/taskboard/docs/api/TaskBoard/model/ColumnModel#field-htmlEncodeHeaderText).
|
|
360
|
+
*/
|
|
361
|
+
htmlEncodeHeaderText?: boolean;
|
|
362
|
+
/**
|
|
363
|
+
* An icon to show before the [title](https://bryntum.com/products/taskboard/docs/api/Core/widget/Panel#config-title). Either pass a CSS class as a string, or pass a
|
|
364
|
+
* [DomConfig](https://bryntum.com/products/taskboard/docs/api/Core/helper/DomHelper#typedef-DomConfig) object describing an element to represent the icon.
|
|
365
|
+
*/
|
|
366
|
+
icon?: string | DomConfig;
|
|
367
|
+
/**
|
|
368
|
+
* Widget id, if not specified one will be generated. Also used for lookups through Widget.getById
|
|
369
|
+
*/
|
|
370
|
+
id?: string;
|
|
371
|
+
/**
|
|
372
|
+
* Determines if the widgets read-only state should be controlled by its parent.
|
|
373
|
+
* ...
|
|
374
|
+
* [View online docs...](https://bryntum.com/products/taskboard/docs/api/TaskBoard/view/TaskBoardBase#config-ignoreParentReadOnly)
|
|
375
|
+
*/
|
|
376
|
+
ignoreParentReadOnly?: boolean;
|
|
377
|
+
/**
|
|
378
|
+
* Convenience setting to align input fields of child widgets. By default, the Field input element is
|
|
379
|
+
* placed immediately following the `label`. If you prefer to have all input fields aligned to the
|
|
380
|
+
* right, set this config to `'end'`.
|
|
381
|
+
* ...
|
|
382
|
+
* [View online docs...](https://bryntum.com/products/taskboard/docs/api/TaskBoard/view/TaskBoardBase#config-inputFieldAlign)
|
|
383
|
+
*/
|
|
384
|
+
inputFieldAlign?: 'start' | 'end';
|
|
385
|
+
/**
|
|
386
|
+
* Element (or element id) to insert this widget before. If provided, [appendTo](https://bryntum.com/products/taskboard/docs/api/Core/widget/Widget#config-appendTo) config is ignored.
|
|
387
|
+
*/
|
|
388
|
+
insertBefore?: HTMLElement | string;
|
|
389
|
+
/**
|
|
390
|
+
* Element (or element id) to append this widget element to, as a first child. If provided, [appendTo](https://bryntum.com/products/taskboard/docs/api/Core/widget/Widget#config-appendTo) config is ignored.
|
|
391
|
+
*/
|
|
392
|
+
insertFirst?: HTMLElement | string;
|
|
393
|
+
/**
|
|
394
|
+
* A template method (empty by default) allowing you to control if a task can be selected or not.
|
|
395
|
+
* ...
|
|
396
|
+
* [View online docs...](https://bryntum.com/products/taskboard/docs/api/TaskBoard/view/TaskBoardBase#config-isTaskSelectable)
|
|
397
|
+
* @param {TaskBoard.model.TaskModel} taskRecord The task record
|
|
398
|
+
* @returns {boolean} `true` if the task can be selected, otherwise `false`
|
|
399
|
+
*/
|
|
400
|
+
isTaskSelectable?: (taskRecord: TaskModel) => boolean;
|
|
401
|
+
/**
|
|
402
|
+
* See [Keyboard shortcuts](https://bryntum.com/products/taskboard/docs/api/TaskBoard/view/TaskBoard#keyboard-shortcuts) for details
|
|
403
|
+
*/
|
|
404
|
+
keyMap?: Record<string, KeyMapConfig>;
|
|
405
|
+
/**
|
|
406
|
+
* Convenience setting to use same label placement on all child widgets.
|
|
407
|
+
* ...
|
|
408
|
+
* [View online docs...](https://bryntum.com/products/taskboard/docs/api/TaskBoard/view/TaskBoardBase#config-labelPosition)
|
|
409
|
+
*/
|
|
410
|
+
labelPosition?: 'before' | 'above' | 'align-before' | 'auto' | null;
|
|
411
|
+
/**
|
|
412
|
+
* The listener set for this object.
|
|
413
|
+
* ...
|
|
414
|
+
* [View online docs...](https://bryntum.com/products/taskboard/docs/api/TaskBoard/view/TaskBoardBase#config-listeners)
|
|
415
|
+
*/
|
|
416
|
+
listeners?: TaskBoardBaseListeners;
|
|
417
|
+
/**
|
|
418
|
+
* A [Mask](https://bryntum.com/products/taskboard/docs/api/Core/widget/Mask) config object, or a message to be shown when a store is performing a remote
|
|
419
|
+
* operation, or Crud Manager is loading data from the sever. Set to `null` to disable default load mask.
|
|
420
|
+
*/
|
|
421
|
+
loadMask?: string | MaskConfig | null;
|
|
422
|
+
/**
|
|
423
|
+
* A [Mask](https://bryntum.com/products/taskboard/docs/api/Core/widget/Mask) config object to adjust the [maskDefaults](#Core/widget/Widget#config-maskDefaults)
|
|
424
|
+
* when data is loading. The message and optional configuration from the
|
|
425
|
+
* [loadMask](https://bryntum.com/products/taskboard/docs/api/Core/mixin/LoadMaskable#config-loadMask) config take priority over these options, just as they do
|
|
426
|
+
* for `maskDefaults`, respectively.
|
|
427
|
+
* ...
|
|
428
|
+
* [View online docs...](https://bryntum.com/products/taskboard/docs/api/TaskBoard/view/TaskBoardBase#config-loadMaskDefaults)
|
|
429
|
+
*/
|
|
430
|
+
loadMaskDefaults?: MaskConfig;
|
|
431
|
+
/**
|
|
432
|
+
* A [Mask](https://bryntum.com/products/taskboard/docs/api/Core/widget/Mask) config object to adjust the [maskDefaults](#Core/widget/Widget#config-maskDefaults)
|
|
433
|
+
* when an error occurs loading data.
|
|
434
|
+
* ...
|
|
435
|
+
* [View online docs...](https://bryntum.com/products/taskboard/docs/api/TaskBoard/view/TaskBoardBase#config-loadMaskError)
|
|
436
|
+
*/
|
|
437
|
+
loadMaskError?: MaskConfig | Mask | boolean;
|
|
438
|
+
/**
|
|
439
|
+
* A class translations of which are used for translating this entity.
|
|
440
|
+
* This is often used when translations of an item are defined on its container class.
|
|
441
|
+
* For example:
|
|
442
|
+
* ...
|
|
443
|
+
* [View online docs...](https://bryntum.com/products/taskboard/docs/api/TaskBoard/view/TaskBoardBase#config-localeClass)
|
|
444
|
+
*/
|
|
445
|
+
localeClass?: typeof Base;
|
|
446
|
+
/**
|
|
447
|
+
* Set to `false` to disable localization of this object.
|
|
448
|
+
*/
|
|
449
|
+
localizable?: boolean;
|
|
450
|
+
/**
|
|
451
|
+
* List of properties which values should be translated automatically upon a locale applying.
|
|
452
|
+
* In case there is a need to localize not typical value (not a String value or a field with re-defined setter/getter),
|
|
453
|
+
* you could use 'localeKey' meta configuration.
|
|
454
|
+
* Example:
|
|
455
|
+
* ...
|
|
456
|
+
* [View online docs...](https://bryntum.com/products/taskboard/docs/api/TaskBoard/view/TaskBoardBase#config-localizableProperties)
|
|
457
|
+
*/
|
|
458
|
+
localizableProperties?: string[];
|
|
459
|
+
/**
|
|
460
|
+
* Widget's margin. This may be configured as a single number or a `TRBL` format string.
|
|
461
|
+
* numeric-only values are interpreted as pixels.
|
|
462
|
+
*/
|
|
463
|
+
margin?: number | string;
|
|
464
|
+
/**
|
|
465
|
+
* This config object contains the defaults for the [Mask](https://bryntum.com/products/taskboard/docs/api/Core/widget/Mask) created for the
|
|
466
|
+
* [masked](https://bryntum.com/products/taskboard/docs/api/Core/widget/Widget#config-masked) config. Any properties specified in the `masked` config will override these
|
|
467
|
+
* values.
|
|
468
|
+
*/
|
|
469
|
+
maskDefaults?: MaskConfig;
|
|
470
|
+
/**
|
|
471
|
+
* Set to `true` to apply the default mask to the widget. Alternatively, this can be the mask message or a
|
|
472
|
+
* [Mask](https://bryntum.com/products/taskboard/docs/api/Core/widget/Mask) config object.
|
|
473
|
+
*/
|
|
474
|
+
masked?: boolean | string | MaskConfig;
|
|
475
|
+
/**
|
|
476
|
+
* The element's maxHeight. Can be either a String or a Number (which will have 'px' appended). Note that
|
|
477
|
+
* like [height](https://bryntum.com/products/taskboard/docs/api/Core/widget/Widget#config-height), *reading* the value will return the numeric value in pixels.
|
|
478
|
+
*/
|
|
479
|
+
maxHeight?: string | number;
|
|
480
|
+
/**
|
|
481
|
+
* *Only valid if this Widget is [floating](https://bryntum.com/products/taskboard/docs/api/Core/widget/Widget#config-floating).*
|
|
482
|
+
* ...
|
|
483
|
+
* [View online docs...](https://bryntum.com/products/taskboard/docs/api/TaskBoard/view/TaskBoardBase#config-maximizeOnMobile)
|
|
484
|
+
*/
|
|
485
|
+
maximizeOnMobile?: number | string;
|
|
486
|
+
/**
|
|
487
|
+
* The elements maxWidth. Can be either a String or a Number (which will have 'px' appended). Note that
|
|
488
|
+
* like [width](https://bryntum.com/products/taskboard/docs/api/Core/widget/Widget#config-width), *reading* the value will return the numeric value in pixels.
|
|
489
|
+
*/
|
|
490
|
+
maxWidth?: string | number;
|
|
491
|
+
/**
|
|
492
|
+
* The element's minHeight. Can be either a String or a Number (which will have 'px' appended). Note that
|
|
493
|
+
* like [height](https://bryntum.com/products/taskboard/docs/api/Core/widget/Widget#config-height), *reading* the value will return the numeric value in pixels.
|
|
494
|
+
*/
|
|
495
|
+
minHeight?: string | number;
|
|
496
|
+
/**
|
|
497
|
+
* The elements minWidth. Can be either a String or a Number (which will have 'px' appended). Note that
|
|
498
|
+
* like [width](https://bryntum.com/products/taskboard/docs/api/Core/widget/Widget#config-width), *reading* the value will return the numeric value in pixels.
|
|
499
|
+
*/
|
|
500
|
+
minWidth?: string | number;
|
|
501
|
+
/**
|
|
502
|
+
* Default values to apply to task records created by task boards features (such as the column header menu and
|
|
503
|
+
* the column toolbar)
|
|
504
|
+
*/
|
|
505
|
+
newTaskDefaults?: TaskModelConfig;
|
|
506
|
+
/**
|
|
507
|
+
* The owning Widget of this Widget. If this Widget is directly contained (that is, it is one of the
|
|
508
|
+
* [items](https://bryntum.com/products/taskboard/docs/api/Core/widget/Container#property-items) of a Container), this config will be ignored. In this case
|
|
509
|
+
* the owner is <strong>always</strong> the encapsulating Container.
|
|
510
|
+
* ...
|
|
511
|
+
* [View online docs...](https://bryntum.com/products/taskboard/docs/api/TaskBoard/view/TaskBoardBase#config-owner)
|
|
512
|
+
*/
|
|
513
|
+
owner?: Widget | any;
|
|
514
|
+
/**
|
|
515
|
+
* Specify plugins (an array of classes) in config
|
|
516
|
+
*/
|
|
517
|
+
plugins?: Function[];
|
|
518
|
+
/**
|
|
519
|
+
* Set to `true` when a widget is rendered into another widget's [contentElement](https://bryntum.com/products/taskboard/docs/api/Core/widget/Widget#property-contentElement), but must
|
|
520
|
+
* not participate in the standard layout of that widget, and must be positioned relatively to that
|
|
521
|
+
* widget's [contentElement](https://bryntum.com/products/taskboard/docs/api/Core/widget/Widget#property-contentElement).
|
|
522
|
+
* ...
|
|
523
|
+
* [View online docs...](https://bryntum.com/products/taskboard/docs/api/TaskBoard/view/TaskBoardBase#config-positioned)
|
|
524
|
+
*/
|
|
525
|
+
positioned?: boolean;
|
|
526
|
+
/**
|
|
527
|
+
* A function called on each render before adding items to a tasks card, allowing runtime manipulation of them.
|
|
528
|
+
* ...
|
|
529
|
+
* [View online docs...](https://bryntum.com/products/taskboard/docs/api/TaskBoard/view/TaskBoardBase#config-processItems)
|
|
530
|
+
* @param {object} context
|
|
531
|
+
* @param {Record<string, TaskItemOptions>} context.headerItems Item config objects for the task header, keyed by ref
|
|
532
|
+
* @param {Record<string, TaskItemOptions>} context.bodyItems Item config objects for the task body, keyed by ref
|
|
533
|
+
* @param {Record<string, TaskItemOptions>} context.footerItems Item config objects for the task footer, keyed by ref
|
|
534
|
+
* @param {TaskBoard.model.TaskModel} context.taskRecord Record representing task to be rendered
|
|
535
|
+
* @returns {boolean,void} Returning `false` from this function prevents the menu being shown
|
|
536
|
+
*/
|
|
537
|
+
processItems?: (context: {
|
|
538
|
+
headerItems: Record<string, TaskItemOptions>;
|
|
539
|
+
bodyItems: Record<string, TaskItemOptions>;
|
|
540
|
+
footerItems: Record<string, TaskItemOptions>;
|
|
541
|
+
taskRecord: TaskModel;
|
|
542
|
+
}) => boolean | void;
|
|
543
|
+
/**
|
|
544
|
+
* A [project config object](https://bryntum.com/products/taskboard/docs/api/TaskBoard/model/ProjectModel#configs) or an instance that holds all stores and
|
|
545
|
+
* data used by the TaskBoard.
|
|
546
|
+
* ...
|
|
547
|
+
* [View online docs...](https://bryntum.com/products/taskboard/docs/api/TaskBoard/view/TaskBoardBase#config-project)
|
|
548
|
+
*/
|
|
549
|
+
project?: ProjectModel | ProjectModelConfig | object;
|
|
550
|
+
/**
|
|
551
|
+
* Whether this widget is read-only. This is only valid if the widget is an input
|
|
552
|
+
* field, <strong>or contains input fields at any depth</strong>.
|
|
553
|
+
* ...
|
|
554
|
+
* [View online docs...](https://bryntum.com/products/taskboard/docs/api/TaskBoard/view/TaskBoardBase#config-readOnly)
|
|
555
|
+
*/
|
|
556
|
+
readOnly?: boolean;
|
|
557
|
+
/**
|
|
558
|
+
* [Record](https://bryntum.com/products/taskboard/docs/api/Core/data/Model) whose values will be used to populate fields in the container.
|
|
559
|
+
* ...
|
|
560
|
+
* [View online docs...](https://bryntum.com/products/taskboard/docs/api/TaskBoard/view/TaskBoardBase#config-record)
|
|
561
|
+
*/
|
|
562
|
+
record?: Model;
|
|
563
|
+
relayStoreEvents?: boolean;
|
|
564
|
+
/**
|
|
565
|
+
* Either a default `rendition` to apply to all child widgets, or a map of renditions keyed by child widget
|
|
566
|
+
* `type`.
|
|
567
|
+
* ...
|
|
568
|
+
* [View online docs...](https://bryntum.com/products/taskboard/docs/api/TaskBoard/view/TaskBoardBase#config-rendition)
|
|
569
|
+
*/
|
|
570
|
+
rendition?: string | Record<string, string> | null;
|
|
571
|
+
/**
|
|
572
|
+
* Path to load resource images from. Used by the for example the resource picker in the task editor and by the
|
|
573
|
+
* ResourceAvatars task item. Set this to display miniature images for each resource using their `image` field.
|
|
574
|
+
* ...
|
|
575
|
+
* [View online docs...](https://bryntum.com/products/taskboard/docs/api/TaskBoard/view/TaskBoardBase#config-resourceImagePath)
|
|
576
|
+
*/
|
|
577
|
+
resourceImagePath?: string;
|
|
578
|
+
/**
|
|
579
|
+
* Inline [resources](https://bryntum.com/products/scheduler/docs#Scheduler/model/ResourceModel), will be loaded into an internally created
|
|
580
|
+
* [ResourceStore](https://bryntum.com/products/scheduler/docs#Scheduler/data/ResourceStore) as a part of a [project](https://bryntum.com/products/taskboard/docs/api/TaskBoard/model/ProjectModel).
|
|
581
|
+
*/
|
|
582
|
+
resources?: ResourceModel[] | object[] | ResourceModelConfig[];
|
|
583
|
+
/**
|
|
584
|
+
* Specifies the various responsive state objects keyed by their name. Each key (except `'*'`, see below) in
|
|
585
|
+
* this object is a state name (see [responsiveState](https://bryntum.com/products/taskboard/docs/api/Core/widget/mixin/Responsive#config-responsiveState)) and its corresponding value is the
|
|
586
|
+
* associated [ResponsiveState](https://bryntum.com/products/taskboard/docs/api/Core/widget/mixin/Responsive#typedef-ResponsiveState) object.
|
|
587
|
+
* ...
|
|
588
|
+
* [View online docs...](https://bryntum.com/products/taskboard/docs/api/TaskBoard/view/TaskBoardBase#config-responsive)
|
|
589
|
+
*/
|
|
590
|
+
responsive?: object;
|
|
591
|
+
/**
|
|
592
|
+
* Set to `true` to mark this instance as the default [responsiveTarget](https://bryntum.com/products/taskboard/docs/api/Core/widget/mixin/Responsive#config-responsiveTarget) for descendants that do
|
|
593
|
+
* not specify an explicit [responsiveTarget](https://bryntum.com/products/taskboard/docs/api/Core/widget/mixin/Responsive#config-responsiveTarget) of their own.
|
|
594
|
+
*/
|
|
595
|
+
responsiveRoot?: boolean;
|
|
596
|
+
/**
|
|
597
|
+
* The name of the active state of the [responsive](https://bryntum.com/products/taskboard/docs/api/Core/widget/mixin/Responsive#config-responsive) config. This is assigned internally
|
|
598
|
+
* and should not be assigned directly.
|
|
599
|
+
*/
|
|
600
|
+
responsiveState?: string;
|
|
601
|
+
/**
|
|
602
|
+
* The widget whose size and other properties drive this object's responsive behavior. If this config is not
|
|
603
|
+
* specified, the closest ancestor that specified [responsiveRoot=true](https://bryntum.com/products/taskboard/docs/api/Core/widget/mixin/Responsive#config-responsiveRoot) will be
|
|
604
|
+
* used. If there is no such ancestor, then the instance using this mixin is used.
|
|
605
|
+
* ...
|
|
606
|
+
* [View online docs...](https://bryntum.com/products/taskboard/docs/api/TaskBoard/view/TaskBoardBase#config-responsiveTarget)
|
|
607
|
+
*/
|
|
608
|
+
responsiveTarget?: string | Widget;
|
|
609
|
+
/**
|
|
610
|
+
* If you are rendering this widget to a shadow root inside a web component, set this config to the shadowRoot. If not inside a web component, set it to `document.body`
|
|
611
|
+
*/
|
|
612
|
+
rootElement?: ShadowRoot | HTMLElement;
|
|
613
|
+
/**
|
|
614
|
+
* This may be configured as `true` to make the widget's element use the `direction:rtl` style.
|
|
615
|
+
* ...
|
|
616
|
+
* [View online docs...](https://bryntum.com/products/taskboard/docs/api/TaskBoard/view/TaskBoardBase#config-rtl)
|
|
617
|
+
*/
|
|
618
|
+
rtl?: boolean;
|
|
619
|
+
/**
|
|
620
|
+
* Specifies whether (and optionally in which axes) a Widget may scroll. `true` means this widget may scroll
|
|
621
|
+
* in both axes. May be an object containing boolean `overflowX` and `overflowY` properties which are
|
|
622
|
+
* applied to CSS style properties `overflowX` and `overflowY`. If they are boolean, they are translated to
|
|
623
|
+
* CSS overflow properties thus:
|
|
624
|
+
* ...
|
|
625
|
+
* [View online docs...](https://bryntum.com/products/taskboard/docs/api/TaskBoard/view/TaskBoardBase#config-scrollable)
|
|
626
|
+
*/
|
|
627
|
+
scrollable?: boolean | ScrollerConfig | Scroller;
|
|
628
|
+
/**
|
|
629
|
+
* Defines what to do if document is scrolled while Widget is visible (only relevant when floating is set to `true`).
|
|
630
|
+
* Valid values: ´null´: do nothing, ´hide´: hide the widget or ´realign´: realign to the target if possible.
|
|
631
|
+
*/
|
|
632
|
+
scrollAction?: 'hide' | 'realign' | null;
|
|
633
|
+
/**
|
|
634
|
+
* Configuration values for the [ScrollManager](https://bryntum.com/products/taskboard/docs/api/Core/util/ScrollManager) class. It is used to manage column/body
|
|
635
|
+
* scrolling during task, column or swimlane drag.
|
|
636
|
+
* ...
|
|
637
|
+
* [View online docs...](https://bryntum.com/products/taskboard/docs/api/TaskBoard/view/TaskBoardBase#config-scrollManager)
|
|
638
|
+
*/
|
|
639
|
+
scrollManager?: ScrollManagerConfig;
|
|
640
|
+
/**
|
|
641
|
+
* Default scroll options, see the options for [scrollIntoView](https://bryntum.com/products/taskboard/docs/api/Core/helper/util/Scroller#function-scrollIntoView)
|
|
642
|
+
* ...
|
|
643
|
+
* [View online docs...](https://bryntum.com/products/taskboard/docs/api/TaskBoard/view/TaskBoardBase#config-scrollOptions)
|
|
644
|
+
*/
|
|
645
|
+
scrollOptions?: BryntumScrollOptions;
|
|
646
|
+
/**
|
|
647
|
+
* Selected tasks.
|
|
648
|
+
*/
|
|
649
|
+
selectedTasks?: TaskModel[];
|
|
650
|
+
/**
|
|
651
|
+
* Configure with `true` to change the default behaviour of keyboard navigation from moving focus to selecting
|
|
652
|
+
* tasks:
|
|
653
|
+
* ...
|
|
654
|
+
* [View online docs...](https://bryntum.com/products/taskboard/docs/api/TaskBoard/view/TaskBoardBase#config-selectOnNavigation)
|
|
655
|
+
*/
|
|
656
|
+
selectOnNavigation?: boolean | string;
|
|
657
|
+
/**
|
|
658
|
+
* *Only valid if this Widget is [floating](https://bryntum.com/products/taskboard/docs/api/Core/widget/Widget#config-floating).*
|
|
659
|
+
* ...
|
|
660
|
+
* [View online docs...](https://bryntum.com/products/taskboard/docs/api/TaskBoard/view/TaskBoardBase#config-showAnimation)
|
|
661
|
+
*/
|
|
662
|
+
showAnimation?: boolean | object;
|
|
663
|
+
/**
|
|
664
|
+
* Show an icon to expand/collapse columns and swimlanes in their headers.
|
|
665
|
+
* ...
|
|
666
|
+
* [View online docs...](https://bryntum.com/products/taskboard/docs/api/TaskBoard/view/TaskBoardBase#config-showCollapseInHeader)
|
|
667
|
+
*/
|
|
668
|
+
showCollapseInHeader?: boolean;
|
|
669
|
+
/**
|
|
670
|
+
* By default, a tooltip showing `Expand XX`/`Collapse XX` is shown when hovering the expand/collapse icon for
|
|
671
|
+
* a column or swimlane. To disable the tooltip, set this to `false`.
|
|
672
|
+
*/
|
|
673
|
+
showCollapseTooltip?: boolean;
|
|
674
|
+
/**
|
|
675
|
+
* Show task count for a column in its header, appended after the title
|
|
676
|
+
* ...
|
|
677
|
+
* [View online docs...](https://bryntum.com/products/taskboard/docs/api/TaskBoard/view/TaskBoardBase#config-showCountInHeader)
|
|
678
|
+
*/
|
|
679
|
+
showCountInHeader?: boolean;
|
|
680
|
+
/**
|
|
681
|
+
* Programmatic control over how many columns to span when used in a grid layout.
|
|
682
|
+
*/
|
|
683
|
+
span?: number;
|
|
684
|
+
/**
|
|
685
|
+
* This value can be one of the following:
|
|
686
|
+
* ...
|
|
687
|
+
* [View online docs...](https://bryntum.com/products/taskboard/docs/api/TaskBoard/view/TaskBoardBase#config-stateful)
|
|
688
|
+
*/
|
|
689
|
+
stateful?: boolean | object | string[];
|
|
690
|
+
/**
|
|
691
|
+
* The events that, when fired by this component, should trigger it to save its state by calling
|
|
692
|
+
* [saveState](https://bryntum.com/products/taskboard/docs/api/Core/mixin/State#function-saveState).
|
|
693
|
+
* ...
|
|
694
|
+
* [View online docs...](https://bryntum.com/products/taskboard/docs/api/TaskBoard/view/TaskBoardBase#config-statefulEvents)
|
|
695
|
+
*/
|
|
696
|
+
statefulEvents?: object | string[];
|
|
697
|
+
/**
|
|
698
|
+
* The key to use when saving this object's state in the [stateProvider](https://bryntum.com/products/taskboard/docs/api/Core/mixin/State#config-stateProvider). If this config is
|
|
699
|
+
* not assigned, and [stateful](https://bryntum.com/products/taskboard/docs/api/Core/mixin/State#config-stateful) is not set to `false`, the [id](#Core/widget/Widget#config-id)
|
|
700
|
+
* (if explicitly specified) will be used as the `stateId`.
|
|
701
|
+
* ...
|
|
702
|
+
* [View online docs...](https://bryntum.com/products/taskboard/docs/api/TaskBoard/view/TaskBoardBase#config-stateId)
|
|
703
|
+
*/
|
|
704
|
+
stateId?: string;
|
|
705
|
+
/**
|
|
706
|
+
* The `StateProvider` to use to save and restore this object's [state](https://bryntum.com/products/taskboard/docs/api/Core/mixin/State#property-state). By default, `state`
|
|
707
|
+
* will be saved using the [default state provider](https://bryntum.com/products/taskboard/docs/api/Core/state/StateProvider#property-instance-static).
|
|
708
|
+
* ...
|
|
709
|
+
* [View online docs...](https://bryntum.com/products/taskboard/docs/api/TaskBoard/view/TaskBoardBase#config-stateProvider)
|
|
710
|
+
*/
|
|
711
|
+
stateProvider?: StateProvider;
|
|
712
|
+
/**
|
|
713
|
+
* Makes column and swimlane headers sticky
|
|
714
|
+
* ...
|
|
715
|
+
* [View online docs...](https://bryntum.com/products/taskboard/docs/api/TaskBoard/view/TaskBoardBase#config-stickyHeaders)
|
|
716
|
+
*/
|
|
717
|
+
stickyHeaders?: boolean;
|
|
718
|
+
/**
|
|
719
|
+
* Setting this will cause cards to expand to share the available width if there are fewer than
|
|
720
|
+
* [tasksPerRow](https://bryntum.com/products/taskboard/docs/api/TaskBoard/view/TaskBoardBase#config-tasksPerRow).
|
|
721
|
+
* ...
|
|
722
|
+
* [View online docs...](https://bryntum.com/products/taskboard/docs/api/TaskBoard/view/TaskBoardBase#config-stretchCards)
|
|
723
|
+
*/
|
|
724
|
+
stretchCards?: boolean;
|
|
725
|
+
/**
|
|
726
|
+
* Specify `true` to match fields by their `name` property only when assigning a [record](https://bryntum.com/products/taskboard/docs/api/Core/widget/Container#config-record),
|
|
727
|
+
* without falling back to `ref`.
|
|
728
|
+
*/
|
|
729
|
+
strictRecordMapping?: boolean;
|
|
730
|
+
/**
|
|
731
|
+
* An object containing widgets keyed by name. By default (when no `type` is given), strips are
|
|
732
|
+
* [toolbars](https://bryntum.com/products/taskboard/docs/api/Core/widget/Toolbar). If you want to pass an array, you can use
|
|
733
|
+
* the toolbar's [items](https://bryntum.com/products/taskboard/docs/api/Core/widget/Container#config-items).
|
|
734
|
+
* ...
|
|
735
|
+
* [View online docs...](https://bryntum.com/products/taskboard/docs/api/TaskBoard/view/TaskBoardBase#config-strips)
|
|
736
|
+
*/
|
|
737
|
+
strips?: Record<string, ContainerItemConfig>;
|
|
738
|
+
/**
|
|
739
|
+
* Field on a task record used to determine which swimlane the task belongs to.
|
|
740
|
+
* ...
|
|
741
|
+
* [View online docs...](https://bryntum.com/products/taskboard/docs/api/TaskBoard/view/TaskBoardBase#config-swimlaneField)
|
|
742
|
+
*/
|
|
743
|
+
swimlaneField?: string;
|
|
744
|
+
/**
|
|
745
|
+
* An empty function by default, but provided so that you can override it. This function is called each time
|
|
746
|
+
* a swimlane is rendered into the task board. It allows you to manipulate the DOM config object used for the
|
|
747
|
+
* swimlane before it is synced to DOM, thus giving you control over styling and contents.
|
|
748
|
+
* ...
|
|
749
|
+
* [View online docs...](https://bryntum.com/products/taskboard/docs/api/TaskBoard/view/TaskBoardBase#config-swimlaneRenderer)
|
|
750
|
+
* @param {object} detail An object containing the information needed to render a swimlane.
|
|
751
|
+
* @param {TaskBoard.model.SwimlaneModel} detail.swimlaneRecord The swimlane.
|
|
752
|
+
* @param {DomConfig} detail.swimlaneConfig DOM config object for the swimlane
|
|
753
|
+
* @returns {void}
|
|
754
|
+
*/
|
|
755
|
+
swimlaneRenderer?: (detail: {
|
|
756
|
+
swimlaneRecord: SwimlaneModel;
|
|
757
|
+
swimlaneConfig: DomConfig;
|
|
758
|
+
}) => void;
|
|
759
|
+
/**
|
|
760
|
+
* Store containing the TaskBoard swimlanes. A tasks [swimlaneField](https://bryntum.com/products/taskboard/docs/api/TaskBoard/view/mixin/TaskBoardSwimlanes#config-swimlaneField) is matched against the `id`
|
|
761
|
+
* of a swimlane to determine in which swimlane it is displayed.
|
|
762
|
+
* ...
|
|
763
|
+
* [View online docs...](https://bryntum.com/products/taskboard/docs/api/TaskBoard/view/TaskBoardBase#config-swimlanes)
|
|
764
|
+
*/
|
|
765
|
+
swimlanes?: SwimlaneModel[] | SwimlaneModelConfig[] | Store | string | StoreConfig;
|
|
766
|
+
/**
|
|
767
|
+
* TaskBoard does not use a sync mask by default. If you want one, see
|
|
768
|
+
* [syncMask](https://bryntum.com/products/taskboard/docs/api/Core/mixin/LoadMaskable#config-syncMask) for configuration options.
|
|
769
|
+
*/
|
|
770
|
+
syncMask?: string | object | null;
|
|
771
|
+
/**
|
|
772
|
+
* A configuration for the [tab](https://bryntum.com/products/taskboard/docs/api/Core/widget/Tab) created for this widget when it is placed in a
|
|
773
|
+
* [TabPanel](https://bryntum.com/products/taskboard/docs/api/Core/widget/TabPanel). For example, this config can be used to control the icon of the `tab` for
|
|
774
|
+
* this widget:
|
|
775
|
+
* ...
|
|
776
|
+
* [View online docs...](https://bryntum.com/products/taskboard/docs/api/TaskBoard/view/TaskBoardBase#config-tab)
|
|
777
|
+
*/
|
|
778
|
+
tab?: boolean | TabConfig;
|
|
779
|
+
/**
|
|
780
|
+
* When this container is used as a tab in a TabPanel, these items are added to the
|
|
781
|
+
* [TabBar](https://bryntum.com/products/taskboard/docs/api/Core/widget/TabBar) when this container is the active tab.
|
|
782
|
+
* ...
|
|
783
|
+
* [View online docs...](https://bryntum.com/products/taskboard/docs/api/TaskBoard/view/TaskBoardBase#config-tabBarItems)
|
|
784
|
+
*/
|
|
785
|
+
tabBarItems?: ToolbarItems[] | Widget[];
|
|
786
|
+
/**
|
|
787
|
+
* An empty function by default, but provided so that you can override it. This function is called each time
|
|
788
|
+
* a task is rendered into the task board. It allows you to manipulate the DOM config object used for the card
|
|
789
|
+
* before it is synced to DOM, thus giving you control over styling and contents.
|
|
790
|
+
* ...
|
|
791
|
+
* [View online docs...](https://bryntum.com/products/taskboard/docs/api/TaskBoard/view/TaskBoardBase#config-taskRenderer)
|
|
792
|
+
* @param {object} detail An object containing the information needed to render a task.
|
|
793
|
+
* @param {TaskBoard.model.TaskModel} detail.taskRecord The task record.
|
|
794
|
+
* @param {TaskBoard.model.ColumnModel} detail.columnRecord The column the task will be displayed in.
|
|
795
|
+
* @param {TaskBoard.model.SwimlaneModel} detail.swimlaneRecord The swimlane the task will be displayed in.
|
|
796
|
+
* @param {DomConfig} detail.cardConfig DOM config object for the cards element
|
|
797
|
+
* @returns {void}
|
|
798
|
+
*/
|
|
799
|
+
taskRenderer?: (detail: {
|
|
800
|
+
taskRecord: TaskModel;
|
|
801
|
+
columnRecord: ColumnModel;
|
|
802
|
+
swimlaneRecord: SwimlaneModel;
|
|
803
|
+
cardConfig: DomConfig;
|
|
804
|
+
}) => void;
|
|
805
|
+
/**
|
|
806
|
+
* Inline [tasks](https://bryntum.com/products/taskboard/docs/api/TaskBoard/model/TaskModel), will be loaded into an internally created
|
|
807
|
+
* [TaskStore](https://bryntum.com/products/taskboard/docs/api/TaskBoard/store/TaskStore) as a part of a [project](#TaskBoard/model/ProjectModel).
|
|
808
|
+
*/
|
|
809
|
+
tasks?: TaskModel[] | object[] | TaskModelConfig[];
|
|
810
|
+
/**
|
|
811
|
+
* Allows sorting tasks in the UI independent of how they are sorted in the task store.
|
|
812
|
+
* ...
|
|
813
|
+
* [View online docs...](https://bryntum.com/products/taskboard/docs/api/TaskBoard/view/TaskBoardBase#config-taskSorterFn)
|
|
814
|
+
* @param {TaskBoard.model.TaskModel} first The first task to compare
|
|
815
|
+
* @param {TaskBoard.model.TaskModel} second The second task to compare
|
|
816
|
+
* @returns {number} Return `1` if first task is greater than second task, `-1` if the opposite is true or `0` if they are equal
|
|
817
|
+
*/
|
|
818
|
+
taskSorterFn?: boolean | ((first: TaskModel, second: TaskModel) => number);
|
|
819
|
+
/**
|
|
820
|
+
* Controls how many cards are rendered to a row in each column. Can be controlled on a per column basis by
|
|
821
|
+
* setting [tasksPerRow](https://bryntum.com/products/taskboard/docs/api/TaskBoard/model/ColumnModel#field-tasksPerRow)
|
|
822
|
+
* ...
|
|
823
|
+
* [View online docs...](https://bryntum.com/products/taskboard/docs/api/TaskBoard/view/TaskBoardBase#config-tasksPerRow)
|
|
824
|
+
*/
|
|
825
|
+
tasksPerRow?: number;
|
|
826
|
+
/**
|
|
827
|
+
* A Config object representing the configuration of a [Toolbar](https://bryntum.com/products/taskboard/docs/api/Core/widget/Toolbar),
|
|
828
|
+
* or array of config objects representing the child items of a Toolbar.
|
|
829
|
+
* This creates a toolbar docked to the top of the panel immediately below the header.
|
|
830
|
+
* ...
|
|
831
|
+
* [View online docs...](https://bryntum.com/products/taskboard/docs/api/TaskBoard/view/TaskBoardBase#config-tbar)
|
|
832
|
+
*/
|
|
833
|
+
tbar?: (ContainerItemConfig | string)[] | ToolbarConfig | PagingToolbarConfig | null;
|
|
834
|
+
/**
|
|
835
|
+
* A title to display in the header or owning TabPanel. Causes creation and docking of a header
|
|
836
|
+
* to the top if no header is configured.
|
|
837
|
+
* ...
|
|
838
|
+
* [View online docs...](https://bryntum.com/products/taskboard/docs/api/TaskBoard/view/TaskBoardBase#config-title)
|
|
839
|
+
*/
|
|
840
|
+
title?: string;
|
|
841
|
+
/**
|
|
842
|
+
* The [tools](https://bryntum.com/products/taskboard/docs/api/Core/widget/Tool) to add either before or after the `title` in the Panel header. Each
|
|
843
|
+
* property name is the reference by which an instantiated tool may be retrieved from the live
|
|
844
|
+
* `[tools](https://bryntum.com/products/taskboard/docs/api/Core/widget/mixin/Toolable#property-tools)` property.
|
|
845
|
+
* ...
|
|
846
|
+
* [View online docs...](https://bryntum.com/products/taskboard/docs/api/TaskBoard/view/TaskBoardBase#config-tools)
|
|
847
|
+
*/
|
|
848
|
+
tools?: Record<string, ToolConfig> | null;
|
|
849
|
+
/**
|
|
850
|
+
* Custom CSS class name suffixes to apply to the elements rendered by this widget. This may be specified
|
|
851
|
+
* as a space separated string, an array of strings, or as an object in which property names with truthy
|
|
852
|
+
* values are used as the class names.
|
|
853
|
+
* ...
|
|
854
|
+
* [View online docs...](https://bryntum.com/products/taskboard/docs/api/TaskBoard/view/TaskBoardBase#config-ui)
|
|
855
|
+
*/
|
|
856
|
+
ui?: 'plain' | 'toolbar' | string | object;
|
|
857
|
+
/**
|
|
858
|
+
* Experimental, animate actions that cannot be animated using CSS transitions. Currently includes:
|
|
859
|
+
* ...
|
|
860
|
+
* [View online docs...](https://bryntum.com/products/taskboard/docs/api/TaskBoard/view/TaskBoardBase#config-useDomTransition)
|
|
861
|
+
*/
|
|
862
|
+
useDomTransition?: boolean;
|
|
863
|
+
/**
|
|
864
|
+
* By turning on this setting you enable partial virtualized rendering for the board, which reduces initial
|
|
865
|
+
* rendering time and makes interaction less sluggish when using thousands of tasks. The tradeoff is that
|
|
866
|
+
* scrolling in most cases will be slower.
|
|
867
|
+
* ...
|
|
868
|
+
* [View online docs...](https://bryntum.com/products/taskboard/docs/api/TaskBoard/view/TaskBoardBase#config-virtualize)
|
|
869
|
+
*/
|
|
870
|
+
virtualize?: boolean;
|
|
871
|
+
/**
|
|
872
|
+
* A widgets weight determines its position among siblings when added to a [Container](https://bryntum.com/products/taskboard/docs/api/Core/widget/Container).
|
|
873
|
+
* Higher weights go further down.
|
|
874
|
+
*/
|
|
875
|
+
weight?: number;
|
|
876
|
+
/**
|
|
877
|
+
* Widget's width, used to set element `style.width`. Either specify a valid width string or a number, which
|
|
878
|
+
* will get 'px' appended. We recommend using CSS as the primary way to control width, but in some cases
|
|
879
|
+
* this config is convenient.
|
|
880
|
+
*/
|
|
881
|
+
width?: string | number;
|
|
882
|
+
/**
|
|
883
|
+
* The x position for the widget.
|
|
884
|
+
* ...
|
|
885
|
+
* [View online docs...](https://bryntum.com/products/taskboard/docs/api/TaskBoard/view/TaskBoardBase#config-x)
|
|
886
|
+
*/
|
|
887
|
+
x?: number;
|
|
888
|
+
/**
|
|
889
|
+
* The y position for the widget.
|
|
890
|
+
* ...
|
|
891
|
+
* [View online docs...](https://bryntum.com/products/taskboard/docs/api/TaskBoard/view/TaskBoardBase#config-y)
|
|
892
|
+
*/
|
|
893
|
+
y?: number;
|
|
894
|
+
/**
|
|
895
|
+
* This feature allows users to drag columns on the TaskBoard to change the column order. Drag is initiated upon
|
|
896
|
+
* mouse down in the column header. Try it out below!
|
|
897
|
+
* ...
|
|
898
|
+
* [View online docs...](https://bryntum.com/products/taskboard/docs/api/TaskBoard/feature/ColumnDrag)
|
|
899
|
+
*/
|
|
900
|
+
columnDragFeature?: object | boolean | string | ColumnDrag | ColumnDragConfig;
|
|
901
|
+
/**
|
|
902
|
+
* Adds the ability to filter each column of the TaskBoard.
|
|
903
|
+
* ...
|
|
904
|
+
* [View online docs...](https://bryntum.com/products/taskboard/docs/api/TaskBoard/feature/ColumnFilter)
|
|
905
|
+
*/
|
|
906
|
+
columnFilterFeature?: object | boolean | string | ColumnFilter | ColumnFilterConfig;
|
|
907
|
+
/**
|
|
908
|
+
* Adds a menu button (`···`) to column headers, clicking it displays a menu. Items are populated by other features
|
|
909
|
+
* and/or application code.
|
|
910
|
+
* ...
|
|
911
|
+
* [View online docs...](https://bryntum.com/products/taskboard/docs/api/TaskBoard/feature/ColumnHeaderMenu)
|
|
912
|
+
*/
|
|
913
|
+
columnHeaderMenuFeature?: object | boolean | string | ColumnHeaderMenu | ColumnHeaderMenuConfig;
|
|
914
|
+
/**
|
|
915
|
+
* Allows user to lock columns to the left or right using the new [locked](https://bryntum.com/products/taskboard/docs/api/TaskBoard/model/ColumnModel#field-locked) field
|
|
916
|
+
* on columns.
|
|
917
|
+
* ...
|
|
918
|
+
* [View online docs...](https://bryntum.com/products/taskboard/docs/api/TaskBoard/feature/ColumnLock)
|
|
919
|
+
*/
|
|
920
|
+
columnLockFeature?: object | boolean | string | ColumnLock | ColumnLockConfig;
|
|
921
|
+
/**
|
|
922
|
+
* Allows user to rename columns by either double-clicking column text, or via the column header menu.
|
|
923
|
+
* ...
|
|
924
|
+
* [View online docs...](https://bryntum.com/products/taskboard/docs/api/TaskBoard/feature/ColumnRename)
|
|
925
|
+
*/
|
|
926
|
+
columnRenameFeature?: object | boolean | string | ColumnRename | ColumnRenameConfig;
|
|
927
|
+
/**
|
|
928
|
+
* This feature allows users to change the width of individual TaskBoard columns. Resize is initiated upon mouse down on
|
|
929
|
+
* the separator element between column headers. Try it out below!
|
|
930
|
+
* ...
|
|
931
|
+
* [View online docs...](https://bryntum.com/products/taskboard/docs/api/TaskBoard/feature/ColumnResize)
|
|
932
|
+
*/
|
|
933
|
+
columnResizeFeature?: object | boolean | string | ColumnResize | ColumnResizeConfig;
|
|
934
|
+
/**
|
|
935
|
+
* Adds the ability to sort each column of the TaskBoard.
|
|
936
|
+
* ...
|
|
937
|
+
* [View online docs...](https://bryntum.com/products/taskboard/docs/api/TaskBoard/feature/ColumnSort)
|
|
938
|
+
*/
|
|
939
|
+
columnSortFeature?: object | boolean | string | ColumnSort | ColumnSortConfig;
|
|
940
|
+
/**
|
|
941
|
+
* Adds toolbars to the top and/or bottom of each column. By default it adds a bottom toolbar containing a single button
|
|
942
|
+
* for adding events to that column/swimlane:
|
|
943
|
+
* ...
|
|
944
|
+
* [View online docs...](https://bryntum.com/products/taskboard/docs/api/TaskBoard/feature/ColumnToolbars)
|
|
945
|
+
*/
|
|
946
|
+
columnToolbarsFeature?: object | boolean | string | ColumnToolbars | ColumnToolbarsConfig;
|
|
947
|
+
/**
|
|
948
|
+
* Adds the ability to quick search in configured fields of tasks.
|
|
949
|
+
* Renders a filter bar below each column's header.
|
|
950
|
+
* ...
|
|
951
|
+
* [View online docs...](https://bryntum.com/products/taskboard/docs/api/TaskBoard/feature/FilterBar)
|
|
952
|
+
*/
|
|
953
|
+
filterBarFeature?: object | boolean | string | FilterBar | FilterBarConfig;
|
|
954
|
+
/**
|
|
955
|
+
* This feature allows inline editing of tasks. Double-clicking an item starts editing it:
|
|
956
|
+
* ...
|
|
957
|
+
* [View online docs...](https://bryntum.com/products/taskboard/docs/api/TaskBoard/feature/SimpleTaskEdit)
|
|
958
|
+
*/
|
|
959
|
+
simpleTaskEditFeature?: object | boolean | string | SimpleTaskEdit | SimpleTaskEditConfig;
|
|
960
|
+
/**
|
|
961
|
+
* This feature allows users to drag drop swimlanes on the TaskBoard changing their order (by grabbing their header).
|
|
962
|
+
* ...
|
|
963
|
+
* [View online docs...](https://bryntum.com/products/taskboard/docs/api/TaskBoard/feature/SwimlaneDrag)
|
|
964
|
+
*/
|
|
965
|
+
swimlaneDragFeature?: object | boolean | string | SwimlaneDrag | SwimlaneDragConfig;
|
|
966
|
+
/**
|
|
967
|
+
* This feature allows cards on the TaskBoard to be dragged across swimlanes and columns but also vertically in the
|
|
968
|
+
* same column to change the order:
|
|
969
|
+
* ...
|
|
970
|
+
* [View online docs...](https://bryntum.com/products/taskboard/docs/api/TaskBoard/feature/TaskDrag)
|
|
971
|
+
*/
|
|
972
|
+
taskDragFeature?: object | boolean | string | TaskDrag | TaskDragConfig;
|
|
973
|
+
/**
|
|
974
|
+
* Enables users to click and drag to select cards on the TaskBoard (marquee selection).
|
|
975
|
+
* ...
|
|
976
|
+
* [View online docs...](https://bryntum.com/products/taskboard/docs/api/TaskBoard/feature/TaskDragSelect)
|
|
977
|
+
*/
|
|
978
|
+
taskDragSelectFeature?: object | boolean | string | TaskDragSelect | TaskDragSelectConfig;
|
|
979
|
+
/**
|
|
980
|
+
* This features allows the user to edit tasks in a popup editor that can either be shown centered on screen (the
|
|
981
|
+
* default, double click a task to show the editor):
|
|
982
|
+
* ...
|
|
983
|
+
* [View online docs...](https://bryntum.com/products/taskboard/docs/api/TaskBoard/feature/TaskEdit)
|
|
984
|
+
*/
|
|
985
|
+
taskEditFeature?: object | boolean | string | TaskEdit | TaskEditConfig;
|
|
986
|
+
/**
|
|
987
|
+
* Displays a context menu for tasks. Items are populated by other features and/or application code.
|
|
988
|
+
* ...
|
|
989
|
+
* [View online docs...](https://bryntum.com/products/taskboard/docs/api/TaskBoard/feature/TaskMenu)
|
|
990
|
+
*/
|
|
991
|
+
taskMenuFeature?: object | boolean | string | TaskMenu | TaskMenuConfig;
|
|
992
|
+
/**
|
|
993
|
+
* Displays a tooltip when hovering a task. By default the tooltip displays:
|
|
994
|
+
* ...
|
|
995
|
+
* [View online docs...](https://bryntum.com/products/taskboard/docs/api/TaskBoard/feature/TaskTooltip)
|
|
996
|
+
*/
|
|
997
|
+
taskTooltipFeature?: object | boolean | string | TaskTooltip | TaskTooltipConfig;
|
|
998
|
+
};
|
|
999
|
+
export declare class BryntumTaskBoardBaseComponent implements OnInit, OnDestroy {
|
|
1000
|
+
static instanceClass: typeof TaskBoardBase;
|
|
1001
|
+
static instanceName: string;
|
|
1002
|
+
private static bryntumEvents;
|
|
1003
|
+
private static bryntumFeatureNames;
|
|
1004
|
+
private static bryntumConfigs;
|
|
1005
|
+
private static bryntumConfigsOnly;
|
|
1006
|
+
private static bryntumProps;
|
|
1007
|
+
private elementRef;
|
|
1008
|
+
instance: TaskBoardBase;
|
|
1009
|
+
private bryntumConfig;
|
|
1010
|
+
constructor(element: ElementRef);
|
|
1011
|
+
activateTaskEvent: 'taskClick' | 'taskDblClick' | null;
|
|
1012
|
+
adopt: HTMLElement | string;
|
|
1013
|
+
align: AlignSpec | string;
|
|
1014
|
+
anchor: boolean;
|
|
1015
|
+
ariaDescription: string;
|
|
1016
|
+
ariaLabel: string;
|
|
1017
|
+
autoGenerateColumns: boolean;
|
|
1018
|
+
autoGenerateSwimlanes: boolean;
|
|
1019
|
+
bbar: (ContainerItemConfig | string)[] | ToolbarConfig | PagingToolbarConfig | null;
|
|
1020
|
+
bodyCls: string | object;
|
|
1021
|
+
bubbleEvents: object;
|
|
1022
|
+
cardSizes: CardSize;
|
|
1023
|
+
centered: boolean;
|
|
1024
|
+
chainFilters: boolean;
|
|
1025
|
+
collapseTitle: boolean;
|
|
1026
|
+
collapsible: boolean | PanelCollapserConfig | PanelCollapserOverlayConfig;
|
|
1027
|
+
color: string;
|
|
1028
|
+
columnTitleRenderer: (renderData: object, columnRecord: ColumnModel) => string | DomConfig;
|
|
1029
|
+
config: object;
|
|
1030
|
+
constrainTo: HTMLElement | Widget | Rectangle;
|
|
1031
|
+
cssVarPrefix: string;
|
|
1032
|
+
dataField: string;
|
|
1033
|
+
detectCSSCompatibilityIssues: boolean;
|
|
1034
|
+
dock: 'top' | 'bottom' | 'left' | 'right' | 'start' | 'end' | 'header' | 'pre-header' | object;
|
|
1035
|
+
draggable: boolean | {
|
|
1036
|
+
handleSelector?: string;
|
|
1037
|
+
};
|
|
1038
|
+
drawer: boolean | {
|
|
1039
|
+
side?: 'start' | 'left' | 'end' | 'right' | 'top' | 'bottom';
|
|
1040
|
+
size?: string | number;
|
|
1041
|
+
inline?: boolean;
|
|
1042
|
+
autoClose: {
|
|
1043
|
+
mousedown?: boolean | string;
|
|
1044
|
+
focusout?: boolean | string;
|
|
1045
|
+
mouseout?: string;
|
|
1046
|
+
};
|
|
1047
|
+
autoCloseDelay?: number;
|
|
1048
|
+
};
|
|
1049
|
+
elementAttributes: Record<string, string | null>;
|
|
1050
|
+
floating: boolean;
|
|
1051
|
+
footer: {
|
|
1052
|
+
dock?: 'top' | 'right' | 'bottom' | 'left' | 'start' | 'end';
|
|
1053
|
+
html?: string;
|
|
1054
|
+
cls?: string;
|
|
1055
|
+
} | string;
|
|
1056
|
+
header: string | boolean | PanelHeader;
|
|
1057
|
+
hideAnimation: boolean | object;
|
|
1058
|
+
htmlEncodeHeaderText: boolean;
|
|
1059
|
+
icon: string | DomConfig;
|
|
1060
|
+
ignoreParentReadOnly: boolean;
|
|
1061
|
+
listeners: TaskBoardBaseListeners;
|
|
1062
|
+
loadMask: string | MaskConfig | null;
|
|
1063
|
+
loadMaskDefaults: MaskConfig;
|
|
1064
|
+
loadMaskError: MaskConfig | Mask | boolean;
|
|
1065
|
+
localeClass: typeof Base;
|
|
1066
|
+
localizable: boolean;
|
|
1067
|
+
localizableProperties: string[];
|
|
1068
|
+
maskDefaults: MaskConfig;
|
|
1069
|
+
masked: boolean | string | MaskConfig;
|
|
1070
|
+
newTaskDefaults: TaskModelConfig;
|
|
1071
|
+
owner: Widget | any;
|
|
1072
|
+
plugins: Function[];
|
|
1073
|
+
positioned: boolean;
|
|
1074
|
+
processItems: (context: {
|
|
1075
|
+
headerItems: Record<string, TaskItemOptions>;
|
|
1076
|
+
bodyItems: Record<string, TaskItemOptions>;
|
|
1077
|
+
footerItems: Record<string, TaskItemOptions>;
|
|
1078
|
+
taskRecord: TaskModel;
|
|
1079
|
+
}) => boolean | void;
|
|
1080
|
+
record: Model;
|
|
1081
|
+
relayStoreEvents: boolean;
|
|
1082
|
+
resourceImagePath: string;
|
|
1083
|
+
responsive: object;
|
|
1084
|
+
responsiveRoot: boolean;
|
|
1085
|
+
responsiveState: string;
|
|
1086
|
+
responsiveTarget: string | Widget;
|
|
1087
|
+
rootElement: ShadowRoot | HTMLElement;
|
|
1088
|
+
scrollable: boolean | ScrollerConfig | Scroller;
|
|
1089
|
+
scrollAction: 'hide' | 'realign' | null;
|
|
1090
|
+
scrollManager: ScrollManagerConfig;
|
|
1091
|
+
scrollOptions: BryntumScrollOptions;
|
|
1092
|
+
selectOnNavigation: boolean | string;
|
|
1093
|
+
showAnimation: boolean | object;
|
|
1094
|
+
showCollapseInHeader: boolean;
|
|
1095
|
+
showCountInHeader: boolean;
|
|
1096
|
+
stateful: boolean | object | string[];
|
|
1097
|
+
statefulEvents: object | string[];
|
|
1098
|
+
stateId: string;
|
|
1099
|
+
stateProvider: StateProvider;
|
|
1100
|
+
stickyHeaders: boolean;
|
|
1101
|
+
strips: Record<string, ContainerItemConfig>;
|
|
1102
|
+
swimlaneRenderer: (detail: {
|
|
1103
|
+
swimlaneRecord: SwimlaneModel;
|
|
1104
|
+
swimlaneConfig: DomConfig;
|
|
1105
|
+
}) => void;
|
|
1106
|
+
syncMask: string | object | null;
|
|
1107
|
+
tab: boolean | TabConfig;
|
|
1108
|
+
tabBarItems: ToolbarItems[] | Widget[];
|
|
1109
|
+
taskRenderer: (detail: {
|
|
1110
|
+
taskRecord: TaskModel;
|
|
1111
|
+
columnRecord: ColumnModel;
|
|
1112
|
+
swimlaneRecord: SwimlaneModel;
|
|
1113
|
+
cardConfig: DomConfig;
|
|
1114
|
+
}) => void;
|
|
1115
|
+
taskSorterFn: boolean | ((first: TaskModel, second: TaskModel) => number);
|
|
1116
|
+
tasksPerRow: number;
|
|
1117
|
+
tbar: (ContainerItemConfig | string)[] | ToolbarConfig | PagingToolbarConfig | null;
|
|
1118
|
+
ui: 'plain' | 'toolbar' | string | object;
|
|
1119
|
+
useDomTransition: boolean;
|
|
1120
|
+
weight: number;
|
|
1121
|
+
alignSelf: string;
|
|
1122
|
+
appendTo: HTMLElement | string;
|
|
1123
|
+
assignments: AssignmentModel[] | object[] | AssignmentModelConfig[];
|
|
1124
|
+
bodyItems: Record<string, TaskItemOptions>;
|
|
1125
|
+
callOnFunctions: boolean;
|
|
1126
|
+
catchEventHandlerExceptions: boolean;
|
|
1127
|
+
cls: string | object;
|
|
1128
|
+
collapsed: boolean;
|
|
1129
|
+
column: number;
|
|
1130
|
+
columnField: string;
|
|
1131
|
+
columns: Store | ColumnModel[] | ColumnModelConfig[] | string[] | string | StoreConfig;
|
|
1132
|
+
css: typeof Proxy | Record<string, string>;
|
|
1133
|
+
dataset: object | Record<string, string>;
|
|
1134
|
+
disabled: boolean | 'inert';
|
|
1135
|
+
drawOnScroll: boolean;
|
|
1136
|
+
extraData: any;
|
|
1137
|
+
flex: number | string;
|
|
1138
|
+
footerItems: Record<string, TaskItemOptions>;
|
|
1139
|
+
getTaskHeight: (taskRecord: TaskModel) => number;
|
|
1140
|
+
headerItems: Record<string, TaskItemOptions>;
|
|
1141
|
+
height: number | string;
|
|
1142
|
+
hidden: boolean;
|
|
1143
|
+
id: string;
|
|
1144
|
+
inputFieldAlign: 'start' | 'end';
|
|
1145
|
+
insertBefore: HTMLElement | string;
|
|
1146
|
+
insertFirst: HTMLElement | string;
|
|
1147
|
+
isTaskSelectable: (taskRecord: TaskModel) => boolean;
|
|
1148
|
+
keyMap: Record<string, KeyMapConfig>;
|
|
1149
|
+
labelPosition: 'before' | 'above' | 'align-before' | 'auto' | null;
|
|
1150
|
+
margin: number | string;
|
|
1151
|
+
maxHeight: string | number;
|
|
1152
|
+
maximizeOnMobile: number | string;
|
|
1153
|
+
maxWidth: string | number;
|
|
1154
|
+
minHeight: string | number;
|
|
1155
|
+
minWidth: string | number;
|
|
1156
|
+
project: ProjectModel | ProjectModelConfig | object;
|
|
1157
|
+
readOnly: boolean;
|
|
1158
|
+
rendition: string | Record<string, string> | null;
|
|
1159
|
+
resources: ResourceModel[] | object[] | ResourceModelConfig[];
|
|
1160
|
+
rtl: boolean;
|
|
1161
|
+
selectedTasks: TaskModel[];
|
|
1162
|
+
showCollapseTooltip: boolean;
|
|
1163
|
+
span: number;
|
|
1164
|
+
stretchCards: boolean;
|
|
1165
|
+
strictRecordMapping: boolean;
|
|
1166
|
+
swimlaneField: string;
|
|
1167
|
+
swimlanes: Store | SwimlaneModel[] | SwimlaneModelConfig[] | string | StoreConfig;
|
|
1168
|
+
tasks: TaskModel[] | object[] | TaskModelConfig[];
|
|
1169
|
+
title: string;
|
|
1170
|
+
tools: Record<string, Tool | ToolConfig> | null | Record<string, Tool> | Record<string, ToolConfig>;
|
|
1171
|
+
virtualize: boolean;
|
|
1172
|
+
width: number | string;
|
|
1173
|
+
x: number;
|
|
1174
|
+
y: number;
|
|
1175
|
+
anchorSize: number[];
|
|
1176
|
+
focusVisible: boolean;
|
|
1177
|
+
hasChanges: boolean;
|
|
1178
|
+
parent: Widget;
|
|
1179
|
+
state: any;
|
|
1180
|
+
columnDragFeature: object | boolean | string | ColumnDrag | ColumnDragConfig;
|
|
1181
|
+
columnFilterFeature: object | boolean | string | ColumnFilter | ColumnFilterConfig;
|
|
1182
|
+
columnHeaderMenuFeature: object | boolean | string | ColumnHeaderMenu | ColumnHeaderMenuConfig;
|
|
1183
|
+
columnLockFeature: object | boolean | string | ColumnLock | ColumnLockConfig;
|
|
1184
|
+
columnRenameFeature: object | boolean | string | ColumnRename | ColumnRenameConfig;
|
|
1185
|
+
columnResizeFeature: object | boolean | string | ColumnResize | ColumnResizeConfig;
|
|
1186
|
+
columnSortFeature: object | boolean | string | ColumnSort | ColumnSortConfig;
|
|
1187
|
+
columnToolbarsFeature: object | boolean | string | ColumnToolbars | ColumnToolbarsConfig;
|
|
1188
|
+
filterBarFeature: object | boolean | string | FilterBar | FilterBarConfig;
|
|
1189
|
+
simpleTaskEditFeature: object | boolean | string | SimpleTaskEdit | SimpleTaskEditConfig;
|
|
1190
|
+
swimlaneDragFeature: object | boolean | string | SwimlaneDrag | SwimlaneDragConfig;
|
|
1191
|
+
taskDragFeature: object | boolean | string | TaskDrag | TaskDragConfig;
|
|
1192
|
+
taskDragSelectFeature: object | boolean | string | TaskDragSelect | TaskDragSelectConfig;
|
|
1193
|
+
taskEditFeature: object | boolean | string | TaskEdit | TaskEditConfig;
|
|
1194
|
+
taskMenuFeature: object | boolean | string | TaskMenu | TaskMenuConfig;
|
|
1195
|
+
taskTooltipFeature: object | boolean | string | TaskTooltip | TaskTooltipConfig;
|
|
1196
|
+
/**
|
|
1197
|
+
* Triggered when a task is "activated" by pressing `Enter` or double clicking it.
|
|
1198
|
+
* ...
|
|
1199
|
+
* [View online docs...](https://bryntum.com/products/taskboard/docs/api/TaskBoard/view/TaskBoardBase#event-activateTask)
|
|
1200
|
+
* @param {object} event Event object
|
|
1201
|
+
* @param {TaskBoard.view.TaskBoard} event.source This TaskBoard
|
|
1202
|
+
* @param {TaskBoard.model.TaskModel} event.taskRecord Task record
|
|
1203
|
+
* @param {MouseEvent} event.event Browser event
|
|
1204
|
+
*/
|
|
1205
|
+
onActivateTask: any;
|
|
1206
|
+
/**
|
|
1207
|
+
* Fires on the owning TaskBoard before column dragging starts. Return `false` to prevent the action
|
|
1208
|
+
* @param {object} event Event object
|
|
1209
|
+
* @param {TaskBoard.view.TaskBoard} event.source Owning TaskBoard
|
|
1210
|
+
* @param {TaskBoard.model.ColumnModel} event.columnRecord Column to be dragged
|
|
1211
|
+
*/
|
|
1212
|
+
onBeforeColumnDrag: any;
|
|
1213
|
+
/**
|
|
1214
|
+
* Fires on the owning TaskBoard when dropping a column, before the operation completes. Handles async
|
|
1215
|
+
* listeners, returning `false` from one will abort the operation
|
|
1216
|
+
* ...
|
|
1217
|
+
* [View online docs...](https://bryntum.com/products/taskboard/docs/api/TaskBoard/view/TaskBoardBase#event-beforeColumnDrop)
|
|
1218
|
+
* @param {object} event Event object
|
|
1219
|
+
* @param {TaskBoard.view.TaskBoard} event.source Owning TaskBoard
|
|
1220
|
+
* @param {TaskBoard.model.ColumnModel} event.columnRecord Dropped column
|
|
1221
|
+
* @param {TaskBoard.model.ColumnModel} event.beforeColumn Dropped before this column
|
|
1222
|
+
*/
|
|
1223
|
+
onBeforeColumnDrop: any;
|
|
1224
|
+
/**
|
|
1225
|
+
* This event is fired prior to starting a column resize gesture. The resize is canceled if a listener returns
|
|
1226
|
+
* `false`.
|
|
1227
|
+
* @param {object} event Event object
|
|
1228
|
+
* @param {TaskBoard.view.TaskBoard} event.source The TaskBoard instance
|
|
1229
|
+
* @param {TaskBoard.model.ColumnModel} event.column The column
|
|
1230
|
+
* @param {Event} event.domEvent The browser event
|
|
1231
|
+
*/
|
|
1232
|
+
onBeforeColumnResize: any;
|
|
1233
|
+
/**
|
|
1234
|
+
* Fires before an object is destroyed.
|
|
1235
|
+
* @param {object} event Event object
|
|
1236
|
+
* @param {Core.Base} event.source The Object that is being destroyed.
|
|
1237
|
+
*/
|
|
1238
|
+
onBeforeDestroy: any;
|
|
1239
|
+
/**
|
|
1240
|
+
* Triggered before a widget is hidden. Return `false` to prevent the action.
|
|
1241
|
+
* @param {object} event Event object
|
|
1242
|
+
* @param {Core.widget.Widget} event.source The widget being hidden.
|
|
1243
|
+
*/
|
|
1244
|
+
onBeforeHide: any;
|
|
1245
|
+
/**
|
|
1246
|
+
* Triggered before a new [responsiveState](https://bryntum.com/products/taskboard/docs/api/Core/widget/mixin/Responsive#config-responsiveState) is applied.
|
|
1247
|
+
* @param {object} event Event object
|
|
1248
|
+
* @param {Core.widget.Widget} event.source The widget whose `responsiveState` is to be changed
|
|
1249
|
+
* @param {string} event.state The new value for the widget's `responsiveState`
|
|
1250
|
+
* @param {string} event.oldState The previous value for the widget's `responsiveState`
|
|
1251
|
+
*/
|
|
1252
|
+
onBeforeResponsiveStateChange: any;
|
|
1253
|
+
/**
|
|
1254
|
+
* Triggered before a widget is shown. Return `false` to prevent the action.
|
|
1255
|
+
* @param {object} event Event object
|
|
1256
|
+
* @param {Core.widget.Widget,any} event.source The widget being shown
|
|
1257
|
+
*/
|
|
1258
|
+
onBeforeShow: any;
|
|
1259
|
+
/**
|
|
1260
|
+
* Fires on the owning TaskBoard before displaying an inline editor. Returning `false` stops the editor from
|
|
1261
|
+
* being shown.
|
|
1262
|
+
* ...
|
|
1263
|
+
* [View online docs...](https://bryntum.com/products/taskboard/docs/api/TaskBoard/view/TaskBoardBase#event-beforeSimpleTaskEdit)
|
|
1264
|
+
* @param {object} event Event object
|
|
1265
|
+
* @param {TaskBoard.view.TaskBoard} event.source The task board
|
|
1266
|
+
* @param {TaskBoard.feature.SimpleTaskEdit} event.simpleTaskEdit The simpleTaskEdit feature
|
|
1267
|
+
* @param {TaskBoard.model.TaskModel} event.taskRecord The record about to be shown in the editor
|
|
1268
|
+
* @param {string} event.field Field name being edited
|
|
1269
|
+
*/
|
|
1270
|
+
onBeforeSimpleTaskEdit: any;
|
|
1271
|
+
/**
|
|
1272
|
+
* Fired before state is applied to the source. Allows editing the state object or preventing the operation.
|
|
1273
|
+
* @param {object} event Event object
|
|
1274
|
+
* @param {any} event.state State object config
|
|
1275
|
+
*/
|
|
1276
|
+
onBeforeStateApply: any;
|
|
1277
|
+
/**
|
|
1278
|
+
* Fired before state is saved by the StateProvider. Allows editing the state object or preventing the operation.
|
|
1279
|
+
* @param {object} event Event object
|
|
1280
|
+
* @param {any} event.state State object config
|
|
1281
|
+
*/
|
|
1282
|
+
onBeforeStateSave: any;
|
|
1283
|
+
/**
|
|
1284
|
+
* Fires on the owning TaskBoard before task dragging starts. Return `false` to prevent the action
|
|
1285
|
+
* @param {object} event Event object
|
|
1286
|
+
* @param {TaskBoard.view.TaskBoard} event.source Owning TaskBoard
|
|
1287
|
+
* @param {TaskBoard.model.TaskModel[]} event.taskRecords Tasks to be dragged
|
|
1288
|
+
* @param {Event} event.domEvent The mouse event
|
|
1289
|
+
*/
|
|
1290
|
+
onBeforeTaskDrag: any;
|
|
1291
|
+
/**
|
|
1292
|
+
* Fires on the owning TaskBoard when tasks are dropped, before the operation completes. Handles async
|
|
1293
|
+
* listeners, returning `false` from one will abort the operation
|
|
1294
|
+
* ...
|
|
1295
|
+
* [View online docs...](https://bryntum.com/products/taskboard/docs/api/TaskBoard/view/TaskBoardBase#event-beforeTaskDrop)
|
|
1296
|
+
* @param {object} event Event object
|
|
1297
|
+
* @param {TaskBoard.view.TaskBoard} event.source Owning TaskBoard
|
|
1298
|
+
* @param {TaskBoard.model.TaskModel[]} event.taskRecords Dropped tasks
|
|
1299
|
+
* @param {TaskBoard.model.ColumnModel} event.targetColumn Dropped on this column
|
|
1300
|
+
* @param {TaskBoard.model.SwimlaneModel} event.targetSwimlane Dropped in this swimlane (if used)
|
|
1301
|
+
* @param {Event} event.domEvent The mouse event
|
|
1302
|
+
*/
|
|
1303
|
+
onBeforeTaskDrop: any;
|
|
1304
|
+
/**
|
|
1305
|
+
* Fires on the owning TaskBoard before a task is displayed in an editor.
|
|
1306
|
+
* ...
|
|
1307
|
+
* [View online docs...](https://bryntum.com/products/taskboard/docs/api/TaskBoard/view/TaskBoardBase#event-beforeTaskEdit)
|
|
1308
|
+
* @param {object} event Event object
|
|
1309
|
+
* @param {TaskBoard.view.TaskBoard} event.source The owning TaskBoard
|
|
1310
|
+
* @param {TaskBoard.model.TaskModel} event.taskRecord The record about to be shown in the task editor
|
|
1311
|
+
*/
|
|
1312
|
+
onBeforeTaskEdit: any;
|
|
1313
|
+
/**
|
|
1314
|
+
* Fires on the owning TaskBoard when the editor for a task is available, but before it is populated with data
|
|
1315
|
+
* and shown. Allows manipulating fields etc.
|
|
1316
|
+
* ...
|
|
1317
|
+
* [View online docs...](https://bryntum.com/products/taskboard/docs/api/TaskBoard/view/TaskBoardBase#event-beforeTaskEditShow)
|
|
1318
|
+
* @param {object} event Event object
|
|
1319
|
+
* @param {TaskBoard.view.TaskBoard} event.source The owning TaskBoard
|
|
1320
|
+
* @param {TaskBoard.model.TaskModel} event.taskRecord The record about to be shown in the task editor
|
|
1321
|
+
* @param {TaskBoard.widget.TaskEditor} event.editor The editor
|
|
1322
|
+
*/
|
|
1323
|
+
onBeforeTaskEditShow: any;
|
|
1324
|
+
/**
|
|
1325
|
+
* Triggered when one or more tasks are to be removed by a call to `removeTask()`.
|
|
1326
|
+
* ...
|
|
1327
|
+
* [View online docs...](https://bryntum.com/products/taskboard/docs/api/TaskBoard/view/TaskBoardBase#event-beforeTaskRemove)
|
|
1328
|
+
* @param {object} event Event object
|
|
1329
|
+
* @param {TaskBoard.view.TaskBoard} event.source This TaskBoard
|
|
1330
|
+
* @param {TaskBoard.model.TaskModel[]} event.taskRecords Task records to be removed
|
|
1331
|
+
*/
|
|
1332
|
+
onBeforeTaskRemove: any;
|
|
1333
|
+
/**
|
|
1334
|
+
* Fires when any other event is fired from the object.
|
|
1335
|
+
* ...
|
|
1336
|
+
* [View online docs...](https://bryntum.com/products/taskboard/docs/api/TaskBoard/view/TaskBoardBase#event-catchAll)
|
|
1337
|
+
* @param {object} event Event object
|
|
1338
|
+
* @param {{[key: string]: any, type: string}} event.event The Object that contains event details
|
|
1339
|
+
* @param {string} event.event.type The type of the event which is caught by the listener
|
|
1340
|
+
*/
|
|
1341
|
+
onCatchAll: any;
|
|
1342
|
+
/**
|
|
1343
|
+
* This event fires on the owning TaskBoard when an item is selected in the column header menu.
|
|
1344
|
+
* @param {object} event Event object
|
|
1345
|
+
* @param {TaskBoard.view.TaskBoard} event.source The grid
|
|
1346
|
+
* @param {Core.widget.Menu} event.menu The menu
|
|
1347
|
+
* @param {Core.widget.MenuItem} event.item Selected menu item
|
|
1348
|
+
* @param {TaskBoard.model.ColumnModel} event.columnRecord The column
|
|
1349
|
+
*/
|
|
1350
|
+
onCellMenuItem: any;
|
|
1351
|
+
/**
|
|
1352
|
+
* This event fires on the owning TaskBoard after the context menu is shown for a column header.
|
|
1353
|
+
* @param {object} event Event object
|
|
1354
|
+
* @param {TaskBoard.view.TaskBoard} event.source The grid
|
|
1355
|
+
* @param {Core.widget.Menu} event.menu The menu
|
|
1356
|
+
* @param {Record<string, MenuItemEntry>} event.items Menu item configs
|
|
1357
|
+
* @param {TaskBoard.model.ColumnModel} event.columnRecord The column
|
|
1358
|
+
*/
|
|
1359
|
+
onCellMenuShow: any;
|
|
1360
|
+
/**
|
|
1361
|
+
* This event fires on the owning TaskBoard when a check item is toggled in the column header menu.
|
|
1362
|
+
* @param {object} event Event object
|
|
1363
|
+
* @param {TaskBoard.view.TaskBoard} event.source The grid
|
|
1364
|
+
* @param {Core.widget.Menu} event.menu The menu
|
|
1365
|
+
* @param {Core.widget.MenuItem} event.item Selected menu item
|
|
1366
|
+
* @param {TaskBoard.model.ColumnModel} event.columnRecord The column
|
|
1367
|
+
* @param {boolean} event.checked Checked or not
|
|
1368
|
+
*/
|
|
1369
|
+
onCellMenuToggleItem: any;
|
|
1370
|
+
/**
|
|
1371
|
+
* Fires when a Panel is collapsed using the [collapsible](https://bryntum.com/products/taskboard/docs/api/Core/widget/Panel#config-collapsible) setting.
|
|
1372
|
+
* @param {object} event Event object
|
|
1373
|
+
* @param {Core.widget.Panel} event.source This Panel.
|
|
1374
|
+
*/
|
|
1375
|
+
onCollapse: any;
|
|
1376
|
+
/**
|
|
1377
|
+
* Triggered when a column is collapsed.
|
|
1378
|
+
* @param {object} event Event object
|
|
1379
|
+
* @param {TaskBoard.view.TaskBoard} event.source This TaskBoard
|
|
1380
|
+
* @param {TaskBoard.model.ColumnModel} event.columnRecord Column record
|
|
1381
|
+
*/
|
|
1382
|
+
onColumnCollapse: any;
|
|
1383
|
+
/**
|
|
1384
|
+
* Fires on the owning TaskBoard when a column is dragged, if the drag leads to a change compared to
|
|
1385
|
+
* the last columnDrag event.
|
|
1386
|
+
* ...
|
|
1387
|
+
* [View online docs...](https://bryntum.com/products/taskboard/docs/api/TaskBoard/view/TaskBoardBase#event-columnDrag)
|
|
1388
|
+
* @param {object} event Event object
|
|
1389
|
+
* @param {TaskBoard.view.TaskBoard} event.source Owning TaskBoard
|
|
1390
|
+
* @param {TaskBoard.model.ColumnModel} event.columnRecord Column being dragged
|
|
1391
|
+
* @param {TaskBoard.model.ColumnModel} event.beforeColumn Insert before this column on drop, `null` if last
|
|
1392
|
+
*/
|
|
1393
|
+
onColumnDrag: any;
|
|
1394
|
+
/**
|
|
1395
|
+
* Fires on the owning TaskBoard when a drag operation is aborted (invalid drop or aborted using ESC)
|
|
1396
|
+
* @param {object} event Event object
|
|
1397
|
+
* @param {TaskBoard.view.TaskBoard} event.source Owning TaskBoard
|
|
1398
|
+
* @param {TaskBoard.model.ColumnModel} event.columnRecord Dragged column
|
|
1399
|
+
*/
|
|
1400
|
+
onColumnDragAbort: any;
|
|
1401
|
+
/**
|
|
1402
|
+
* Fires on the owning TaskBoard when a previously started drag operation ends, no matter the
|
|
1403
|
+
* outcome of it (whether valid, invalid or aborted)
|
|
1404
|
+
* @param {object} event Event object
|
|
1405
|
+
* @param {TaskBoard.view.TaskBoard} event.source Owning TaskBoard
|
|
1406
|
+
* @param {TaskBoard.model.ColumnModel} event.columnRecord Affected column
|
|
1407
|
+
*/
|
|
1408
|
+
onColumnDragEnd: any;
|
|
1409
|
+
/**
|
|
1410
|
+
* Fires on the owning TaskBoard when column dragging starts
|
|
1411
|
+
* @param {object} event Event object
|
|
1412
|
+
* @param {TaskBoard.view.TaskBoard} event.source Owning TaskBoard
|
|
1413
|
+
* @param {TaskBoard.model.ColumnModel} event.columnRecord Column to be dragged
|
|
1414
|
+
*/
|
|
1415
|
+
onColumnDragStart: any;
|
|
1416
|
+
/**
|
|
1417
|
+
* Fires on the owning TaskBoard when a column is successfully dropped (after the drop transition
|
|
1418
|
+
* has finished)
|
|
1419
|
+
* @param {object} event Event object
|
|
1420
|
+
* @param {TaskBoard.view.TaskBoard} event.source Owning TaskBoard
|
|
1421
|
+
* @param {TaskBoard.model.ColumnModel} event.columnRecord Dropped column
|
|
1422
|
+
* @param {TaskBoard.model.ColumnModel} event.beforeColumn Dropped before this column (`null` if last)
|
|
1423
|
+
* @param {TaskBoard.model.SwimlaneModel} event.targetSwimlane Dropped in this swimlane (if used)
|
|
1424
|
+
*/
|
|
1425
|
+
onColumnDrop: any;
|
|
1426
|
+
/**
|
|
1427
|
+
* Triggered when a column is expanded.
|
|
1428
|
+
* @param {object} event Event object
|
|
1429
|
+
* @param {TaskBoard.view.TaskBoard} event.source This TaskBoard
|
|
1430
|
+
* @param {TaskBoard.model.ColumnModel} event.columnRecord Column record
|
|
1431
|
+
*/
|
|
1432
|
+
onColumnExpand: any;
|
|
1433
|
+
/**
|
|
1434
|
+
* Triggered when the column filter is hidden.
|
|
1435
|
+
* @param {object} event Event object
|
|
1436
|
+
* @param {TaskBoard.view.TaskBoard} event.source This TaskBoard
|
|
1437
|
+
* @param {TaskBoard.model.ColumnModel} event.columnRecord Column record
|
|
1438
|
+
*/
|
|
1439
|
+
onColumnFilterHide: any;
|
|
1440
|
+
/**
|
|
1441
|
+
* Triggered when the column filter is displayed.
|
|
1442
|
+
* @param {object} event Event object
|
|
1443
|
+
* @param {TaskBoard.view.TaskBoard} event.source This TaskBoard
|
|
1444
|
+
* @param {TaskBoard.model.ColumnModel} event.columnRecord Column record
|
|
1445
|
+
*/
|
|
1446
|
+
onColumnFilterShow: any;
|
|
1447
|
+
/**
|
|
1448
|
+
* Triggered when the column filter visibility is toggled.
|
|
1449
|
+
* @param {object} event Event object
|
|
1450
|
+
* @param {TaskBoard.view.TaskBoard} event.source This TaskBoard
|
|
1451
|
+
* @param {TaskBoard.model.ColumnModel} event.columnRecord Column record
|
|
1452
|
+
* @param {boolean} event.visible True if filter popup is visible, false otherwise
|
|
1453
|
+
*/
|
|
1454
|
+
onColumnFilterToggle: any;
|
|
1455
|
+
/**
|
|
1456
|
+
* Triggered when a column header is clicked.
|
|
1457
|
+
* ...
|
|
1458
|
+
* [View online docs...](https://bryntum.com/products/taskboard/docs/api/TaskBoard/view/TaskBoardBase#event-columnHeaderClick)
|
|
1459
|
+
* @param {object} event Event object
|
|
1460
|
+
* @param {TaskBoard.view.TaskBoard} event.source This TaskBoard
|
|
1461
|
+
* @param {TaskBoard.model.ColumnModel} event.columnRecord Column record
|
|
1462
|
+
* @param {MouseEvent} event.event Browser event
|
|
1463
|
+
*/
|
|
1464
|
+
onColumnHeaderClick: any;
|
|
1465
|
+
/**
|
|
1466
|
+
* Triggered when a column header is right-clicked.
|
|
1467
|
+
* ...
|
|
1468
|
+
* [View online docs...](https://bryntum.com/products/taskboard/docs/api/TaskBoard/view/TaskBoardBase#event-columnHeaderContextMenu)
|
|
1469
|
+
* @param {object} event Event object
|
|
1470
|
+
* @param {TaskBoard.view.TaskBoard} event.source This TaskBoard
|
|
1471
|
+
* @param {TaskBoard.model.ColumnModel} event.columnRecord Column record
|
|
1472
|
+
* @param {MouseEvent} event.event Browser event
|
|
1473
|
+
*/
|
|
1474
|
+
onColumnHeaderContextMenu: any;
|
|
1475
|
+
/**
|
|
1476
|
+
* Triggered when a column header is double-clicked.
|
|
1477
|
+
* ...
|
|
1478
|
+
* [View online docs...](https://bryntum.com/products/taskboard/docs/api/TaskBoard/view/TaskBoardBase#event-columnHeaderDblClick)
|
|
1479
|
+
* @param {object} event Event object
|
|
1480
|
+
* @param {TaskBoard.view.TaskBoard} event.source This TaskBoard
|
|
1481
|
+
* @param {TaskBoard.model.ColumnModel} event.columnRecord Column record
|
|
1482
|
+
* @param {MouseEvent} event.event Browser event
|
|
1483
|
+
*/
|
|
1484
|
+
onColumnHeaderDblClick: any;
|
|
1485
|
+
/**
|
|
1486
|
+
* This event fires on the owning TaskBoard before the menu is shown for a column header.
|
|
1487
|
+
* Allows manipulation of the items to show in the same way as in the [processItems](https://bryntum.com/products/taskboard/docs/api/TaskBoard/feature/ColumnHeaderMenu#config-processItems).
|
|
1488
|
+
* ...
|
|
1489
|
+
* [View online docs...](https://bryntum.com/products/taskboard/docs/api/TaskBoard/view/TaskBoardBase#event-columnHeaderMenuBeforeShow)
|
|
1490
|
+
* @param {object} event Event object
|
|
1491
|
+
* @param {TaskBoard.view.TaskBoard} event.source The grid
|
|
1492
|
+
* @param {Core.widget.Menu} event.menu The menu
|
|
1493
|
+
* @param {Record<string, MenuItemEntry>} event.items Menu item configs
|
|
1494
|
+
* @param {TaskBoard.model.ColumnModel} event.columnRecord The column
|
|
1495
|
+
*/
|
|
1496
|
+
onColumnHeaderMenuBeforeShow: any;
|
|
1497
|
+
/**
|
|
1498
|
+
* This event is fired after a resize gesture is completed.
|
|
1499
|
+
* @param {object} event Event object
|
|
1500
|
+
* @param {TaskBoard.view.TaskBoard} event.source The TaskBoard instance
|
|
1501
|
+
* @param {TaskBoard.model.ColumnModel} event.column The column
|
|
1502
|
+
* @param {Event} event.domEvent The browser event
|
|
1503
|
+
*/
|
|
1504
|
+
onColumnResize: any;
|
|
1505
|
+
/**
|
|
1506
|
+
* This event is fired when a column resize gesture starts.
|
|
1507
|
+
* @param {object} event Event object
|
|
1508
|
+
* @param {TaskBoard.view.TaskBoard} event.source The TaskBoard instance
|
|
1509
|
+
* @param {TaskBoard.model.ColumnModel} event.column The column
|
|
1510
|
+
* @param {Event} event.domEvent The browser event
|
|
1511
|
+
*/
|
|
1512
|
+
onColumnResizeStart: any;
|
|
1513
|
+
/**
|
|
1514
|
+
* Triggered when a column title element is clicked.
|
|
1515
|
+
* ...
|
|
1516
|
+
* [View online docs...](https://bryntum.com/products/taskboard/docs/api/TaskBoard/view/TaskBoardBase#event-columnTitleClick)
|
|
1517
|
+
* @param {object} event Event object
|
|
1518
|
+
* @param {TaskBoard.view.TaskBoard} event.source This TaskBoard
|
|
1519
|
+
* @param {TaskBoard.model.ColumnModel} event.columnRecord Column record
|
|
1520
|
+
* @param {MouseEvent} event.event Browser event
|
|
1521
|
+
*/
|
|
1522
|
+
onColumnTitleClick: any;
|
|
1523
|
+
/**
|
|
1524
|
+
* Triggered when a column title element is right-clicked.
|
|
1525
|
+
* ...
|
|
1526
|
+
* [View online docs...](https://bryntum.com/products/taskboard/docs/api/TaskBoard/view/TaskBoardBase#event-columnTitleContextMenu)
|
|
1527
|
+
* @param {object} event Event object
|
|
1528
|
+
* @param {TaskBoard.view.TaskBoard} event.source This TaskBoard
|
|
1529
|
+
* @param {TaskBoard.model.ColumnModel} event.columnRecord Column record
|
|
1530
|
+
* @param {MouseEvent} event.event Browser event
|
|
1531
|
+
*/
|
|
1532
|
+
onColumnTitleContextMenu: any;
|
|
1533
|
+
/**
|
|
1534
|
+
* Triggered when a column title element is double-clicked.
|
|
1535
|
+
* ...
|
|
1536
|
+
* [View online docs...](https://bryntum.com/products/taskboard/docs/api/TaskBoard/view/TaskBoardBase#event-columnTitleDblClick)
|
|
1537
|
+
* @param {object} event Event object
|
|
1538
|
+
* @param {TaskBoard.view.TaskBoard} event.source This TaskBoard
|
|
1539
|
+
* @param {TaskBoard.model.ColumnModel} event.columnRecord Column record
|
|
1540
|
+
* @param {MouseEvent} event.event Browser event
|
|
1541
|
+
*/
|
|
1542
|
+
onColumnTitleDblClick: any;
|
|
1543
|
+
/**
|
|
1544
|
+
* Triggered when the column collapsed state is toggled.
|
|
1545
|
+
* @param {object} event Event object
|
|
1546
|
+
* @param {TaskBoard.view.TaskBoard} event.source This TaskBoard
|
|
1547
|
+
* @param {TaskBoard.model.ColumnModel} event.columnRecord Column record
|
|
1548
|
+
* @param {boolean} event.collapse `true` if the column is being collapsed.
|
|
1549
|
+
*/
|
|
1550
|
+
onColumnToggle: any;
|
|
1551
|
+
/**
|
|
1552
|
+
* Fires when an object is destroyed.
|
|
1553
|
+
* @param {object} event Event object
|
|
1554
|
+
* @param {Core.Base} event.source The Object that is being destroyed.
|
|
1555
|
+
*/
|
|
1556
|
+
onDestroy: any;
|
|
1557
|
+
/**
|
|
1558
|
+
* Fires when a field is mutated and the state of the [hasChanges](https://bryntum.com/products/taskboard/docs/api/Core/widget/Container#property-hasChanges) property changes
|
|
1559
|
+
* @param {object} event Event object
|
|
1560
|
+
* @param {Core.widget.Container} event.source The container.
|
|
1561
|
+
* @param {boolean} event.dirty The dirty state of the Container - `true` if there are any fields which have been changed since initial load.
|
|
1562
|
+
*/
|
|
1563
|
+
onDirtyStateChange: any;
|
|
1564
|
+
/**
|
|
1565
|
+
* Triggered when a widget's [element](https://bryntum.com/products/taskboard/docs/api/Core/widget/Widget#property-element) is available.
|
|
1566
|
+
* @param {object} event Event object
|
|
1567
|
+
* @param {HTMLElement} event.element The Widget's element.
|
|
1568
|
+
*/
|
|
1569
|
+
onElementCreated: any;
|
|
1570
|
+
/**
|
|
1571
|
+
* Fires when a Panel is expanded using the [collapsible](https://bryntum.com/products/taskboard/docs/api/Core/widget/Panel#config-collapsible) setting.
|
|
1572
|
+
* @param {object} event Event object
|
|
1573
|
+
* @param {Core.widget.Panel} event.source This Panel.
|
|
1574
|
+
*/
|
|
1575
|
+
onExpand: any;
|
|
1576
|
+
/**
|
|
1577
|
+
* Fired when focus enters this Widget.
|
|
1578
|
+
* @param {object} event Event object
|
|
1579
|
+
* @param {Core.widget.Widget} event.source This Widget
|
|
1580
|
+
* @param {HTMLElement} event.fromElement The element which lost focus.
|
|
1581
|
+
* @param {HTMLElement} event.toElement The element which gained focus.
|
|
1582
|
+
* @param {Core.widget.Widget} event.fromWidget The widget which lost focus.
|
|
1583
|
+
* @param {Core.widget.Widget} event.toWidget The widget which gained focus.
|
|
1584
|
+
* @param {boolean} event.backwards `true` if the `toElement` is before the `fromElement` in document order.
|
|
1585
|
+
*/
|
|
1586
|
+
onFocusIn: any;
|
|
1587
|
+
/**
|
|
1588
|
+
* Fired when focus exits this Widget's ownership tree. This is different from a `blur` event.
|
|
1589
|
+
* focus moving from within this Widget's ownership tree, even if there are floating widgets
|
|
1590
|
+
* will not trigger this event. This is when focus exits this widget completely.
|
|
1591
|
+
* @param {object} event Event object
|
|
1592
|
+
* @param {Core.widget.Widget} event.source This Widget
|
|
1593
|
+
* @param {HTMLElement} event.fromElement The element which lost focus.
|
|
1594
|
+
* @param {HTMLElement} event.toElement The element which gained focus.
|
|
1595
|
+
* @param {Core.widget.Widget} event.fromWidget The widget which lost focus.
|
|
1596
|
+
* @param {Core.widget.Widget} event.toWidget The widget which gained focus.
|
|
1597
|
+
* @param {boolean} event.backwards `true` if the `toElement` is before the `fromElement` in document order.
|
|
1598
|
+
*/
|
|
1599
|
+
onFocusOut: any;
|
|
1600
|
+
/**
|
|
1601
|
+
* Triggered after a widget was hidden
|
|
1602
|
+
* @param {object} event Event object
|
|
1603
|
+
* @param {Core.widget.Widget} event.source The widget
|
|
1604
|
+
*/
|
|
1605
|
+
onHide: any;
|
|
1606
|
+
/**
|
|
1607
|
+
* Triggered when a widget which had been in a non-visible state for any reason
|
|
1608
|
+
* achieves visibility.
|
|
1609
|
+
* ...
|
|
1610
|
+
* [View online docs...](https://bryntum.com/products/taskboard/docs/api/TaskBoard/view/TaskBoardBase#event-paint)
|
|
1611
|
+
* @param {object} event Event object
|
|
1612
|
+
* @param {Core.widget.Widget} event.source The widget being painted.
|
|
1613
|
+
* @param {boolean} event.firstPaint `true` if this is the first paint.
|
|
1614
|
+
*/
|
|
1615
|
+
onPaint: any;
|
|
1616
|
+
/**
|
|
1617
|
+
* Fired when a Widget's read only state is toggled
|
|
1618
|
+
* @param {object} event Event object
|
|
1619
|
+
* @param {boolean} event.readOnly Read only or not
|
|
1620
|
+
*/
|
|
1621
|
+
onReadOnly: any;
|
|
1622
|
+
/**
|
|
1623
|
+
* This event is fired after a widget's elements have been synchronized due to a direct or indirect call
|
|
1624
|
+
* to [recompose](https://bryntum.com/products/taskboard/docs/api/Core/widget/Widget#function-recompose), if this results in some change to the widget's rendered DOM elements.
|
|
1625
|
+
*/
|
|
1626
|
+
onRecompose: any;
|
|
1627
|
+
/**
|
|
1628
|
+
* Triggered when a tasks element is removed.
|
|
1629
|
+
* ...
|
|
1630
|
+
* [View online docs...](https://bryntum.com/products/taskboard/docs/api/TaskBoard/view/TaskBoardBase#event-removeTaskElement)
|
|
1631
|
+
* @param {object} event Event object
|
|
1632
|
+
* @param {TaskBoard.view.TaskBoard} event.source TaskBoard instance
|
|
1633
|
+
* @param {string,number} event.taskId Id of the task (not the record itself since it might be removed)
|
|
1634
|
+
* @param {HTMLElement} event.element Tasks element
|
|
1635
|
+
*/
|
|
1636
|
+
onRemoveTaskElement: any;
|
|
1637
|
+
/**
|
|
1638
|
+
* Triggered when a task is rendered.
|
|
1639
|
+
* ...
|
|
1640
|
+
* [View online docs...](https://bryntum.com/products/taskboard/docs/api/TaskBoard/view/TaskBoardBase#event-renderTask)
|
|
1641
|
+
* @param {object} event Event object
|
|
1642
|
+
* @param {TaskBoard.view.TaskBoard} event.source TaskBoard instance
|
|
1643
|
+
* @param {TaskBoard.model.TaskModel} event.taskRecord Task being rendered
|
|
1644
|
+
* @param {boolean} event.isRefresh `true` if the element was updated, `false` if it was added
|
|
1645
|
+
* @param {HTMLElement} event.element Tasks element
|
|
1646
|
+
*/
|
|
1647
|
+
onRenderTask: any;
|
|
1648
|
+
/**
|
|
1649
|
+
* Triggered when all tasks in the task board are rendered
|
|
1650
|
+
* @param {object} event Event object
|
|
1651
|
+
* @param {TaskBoard.view.TaskBoard} event.source TaskBoard instance
|
|
1652
|
+
* @param {TaskBoard.model.TaskModel[]} event.taskRecords Tasks being rendered
|
|
1653
|
+
*/
|
|
1654
|
+
onRenderTasks: any;
|
|
1655
|
+
/**
|
|
1656
|
+
* Fired when the encapsulating element of a Widget resizes *only when [monitorResize](https://bryntum.com/products/taskboard/docs/api/Core/widget/Widget#config-monitorResize) is `true`*.
|
|
1657
|
+
* @param {object} event Event object
|
|
1658
|
+
* @param {Core.widget.Widget} event.source This Widget
|
|
1659
|
+
* @param {number} event.width The new width
|
|
1660
|
+
* @param {number} event.height The new height
|
|
1661
|
+
* @param {number} event.oldWidth The old width
|
|
1662
|
+
* @param {number} event.oldHeight The old height
|
|
1663
|
+
*/
|
|
1664
|
+
onResize: any;
|
|
1665
|
+
/**
|
|
1666
|
+
* Triggered when a new [responsiveState](https://bryntum.com/products/taskboard/docs/api/Core/widget/mixin/Responsive#config-responsiveState) is applied.
|
|
1667
|
+
* @param {object} event Event object
|
|
1668
|
+
* @param {Core.widget.Widget} event.source The widget whose `responsiveState` has changed
|
|
1669
|
+
* @param {string} event.state The new value for the widget's `responsiveState`
|
|
1670
|
+
* @param {string} event.oldState The previous value for the widget's `responsiveState`
|
|
1671
|
+
*/
|
|
1672
|
+
onResponsiveStateChange: any;
|
|
1673
|
+
/**
|
|
1674
|
+
* Triggered when task selection changes.
|
|
1675
|
+
* @param {object} event Event object
|
|
1676
|
+
* @param {TaskBoard.view.TaskBoard} event.source TaskBoard instance
|
|
1677
|
+
* @param {'select','deselect'} event.action Either 'select' or 'deselect', depending on operation
|
|
1678
|
+
* @param {TaskBoard.model.TaskModel[]} event.selection All currently selected tasks
|
|
1679
|
+
* @param {TaskBoard.model.TaskModel[]} event.select Tasks selected by the operation
|
|
1680
|
+
* @param {TaskBoard.model.TaskModel[]} event.deselect Tasks deselected by the operation
|
|
1681
|
+
*/
|
|
1682
|
+
onSelectionChange: any;
|
|
1683
|
+
/**
|
|
1684
|
+
* Triggered after a widget is shown.
|
|
1685
|
+
* @param {object} event Event object
|
|
1686
|
+
* @param {Core.widget.Widget} event.source The widget
|
|
1687
|
+
*/
|
|
1688
|
+
onShow: any;
|
|
1689
|
+
/**
|
|
1690
|
+
* Fires on the owning TaskBoard when inline editing of a field is cancelled (by pressing ESC).
|
|
1691
|
+
* ...
|
|
1692
|
+
* [View online docs...](https://bryntum.com/products/taskboard/docs/api/TaskBoard/view/TaskBoardBase#event-simpleTaskEditCancel)
|
|
1693
|
+
* @param {object} event Event object
|
|
1694
|
+
* @param {TaskBoard.view.TaskBoard} event.source The task board
|
|
1695
|
+
* @param {TaskBoard.feature.SimpleTaskEdit} event.simpleTaskEdit The simpleTaskEdit feature
|
|
1696
|
+
* @param {TaskBoard.model.TaskModel} event.taskRecord Record that was edited
|
|
1697
|
+
* @param {string} event.field Field name being edited
|
|
1698
|
+
*/
|
|
1699
|
+
onSimpleTaskEditCancel: any;
|
|
1700
|
+
/**
|
|
1701
|
+
* Fires on the owning TaskBoard when inline editing of a field has successfully finished.
|
|
1702
|
+
* ...
|
|
1703
|
+
* [View online docs...](https://bryntum.com/products/taskboard/docs/api/TaskBoard/view/TaskBoardBase#event-simpleTaskEditComplete)
|
|
1704
|
+
* @param {object} event Event object
|
|
1705
|
+
* @param {TaskBoard.view.TaskBoard} event.source The task board
|
|
1706
|
+
* @param {TaskBoard.feature.SimpleTaskEdit} event.simpleTaskEdit The simpleTaskEdit feature
|
|
1707
|
+
* @param {TaskBoard.model.TaskModel} event.taskRecord Record that was edited
|
|
1708
|
+
* @param {string} event.field Field name being edited
|
|
1709
|
+
*/
|
|
1710
|
+
onSimpleTaskEditComplete: any;
|
|
1711
|
+
/**
|
|
1712
|
+
* Triggered when a swimlane is collapsed.
|
|
1713
|
+
* @param {object} event Event object
|
|
1714
|
+
* @param {TaskBoard.view.TaskBoard} event.source This TaskBoard
|
|
1715
|
+
* @param {TaskBoard.model.SwimlaneModel} event.swimlaneRecord Swimlane record
|
|
1716
|
+
*/
|
|
1717
|
+
onSwimlaneCollapse: any;
|
|
1718
|
+
/**
|
|
1719
|
+
* Triggered when a swimlane is expanded.
|
|
1720
|
+
* @param {object} event Event object
|
|
1721
|
+
* @param {TaskBoard.view.TaskBoard} event.source This TaskBoard
|
|
1722
|
+
* @param {TaskBoard.model.SwimlaneModel} event.swimlaneRecord Swimlane record
|
|
1723
|
+
*/
|
|
1724
|
+
onSwimlaneExpand: any;
|
|
1725
|
+
/**
|
|
1726
|
+
* Triggered when a swimlane header is clicked.
|
|
1727
|
+
* ...
|
|
1728
|
+
* [View online docs...](https://bryntum.com/products/taskboard/docs/api/TaskBoard/view/TaskBoardBase#event-swimlaneHeaderClick)
|
|
1729
|
+
* @param {object} event Event object
|
|
1730
|
+
* @param {TaskBoard.view.TaskBoard} event.source This TaskBoard
|
|
1731
|
+
* @param {TaskBoard.model.SwimlaneModel} event.swimlaneRecord Swimlane record
|
|
1732
|
+
* @param {MouseEvent} event.event Browser event
|
|
1733
|
+
*/
|
|
1734
|
+
onSwimlaneHeaderClick: any;
|
|
1735
|
+
/**
|
|
1736
|
+
* Triggered when a swimlane header is right-clicked.
|
|
1737
|
+
* ...
|
|
1738
|
+
* [View online docs...](https://bryntum.com/products/taskboard/docs/api/TaskBoard/view/TaskBoardBase#event-swimlaneHeaderContextMenu)
|
|
1739
|
+
* @param {object} event Event object
|
|
1740
|
+
* @param {TaskBoard.view.TaskBoard} event.source This TaskBoard
|
|
1741
|
+
* @param {TaskBoard.model.SwimlaneModel} event.swimlaneRecord Swimlane record
|
|
1742
|
+
* @param {MouseEvent} event.event Browser event
|
|
1743
|
+
*/
|
|
1744
|
+
onSwimlaneHeaderContextMenu: any;
|
|
1745
|
+
/**
|
|
1746
|
+
* Triggered when a swimlane header is double-clicked.
|
|
1747
|
+
* ...
|
|
1748
|
+
* [View online docs...](https://bryntum.com/products/taskboard/docs/api/TaskBoard/view/TaskBoardBase#event-swimlaneHeaderDblClick)
|
|
1749
|
+
* @param {object} event Event object
|
|
1750
|
+
* @param {TaskBoard.view.TaskBoard} event.source This TaskBoard
|
|
1751
|
+
* @param {TaskBoard.model.SwimlaneModel} event.swimlaneRecord Swimlane record
|
|
1752
|
+
* @param {MouseEvent} event.event Browser event
|
|
1753
|
+
*/
|
|
1754
|
+
onSwimlaneHeaderDblClick: any;
|
|
1755
|
+
/**
|
|
1756
|
+
* Triggered when the swimlane collapsed state is toggled.
|
|
1757
|
+
* @param {object} event Event object
|
|
1758
|
+
* @param {TaskBoard.view.TaskBoard} event.source This TaskBoard
|
|
1759
|
+
* @param {TaskBoard.model.SwimlaneModel} event.swimlaneRecord Swimlane record
|
|
1760
|
+
* @param {boolean} event.collapse `true` if the column is being collapsed.
|
|
1761
|
+
*/
|
|
1762
|
+
onSwimlaneToggle: any;
|
|
1763
|
+
/**
|
|
1764
|
+
* Triggered when a card is clicked.
|
|
1765
|
+
* ...
|
|
1766
|
+
* [View online docs...](https://bryntum.com/products/taskboard/docs/api/TaskBoard/view/TaskBoardBase#event-taskClick)
|
|
1767
|
+
* @param {object} event Event object
|
|
1768
|
+
* @param {TaskBoard.view.TaskBoard} event.source This TaskBoard
|
|
1769
|
+
* @param {TaskBoard.model.TaskModel} event.taskRecord Task record
|
|
1770
|
+
* @param {TaskBoard.model.ColumnModel} event.columnRecord Column record for the tasks column
|
|
1771
|
+
* @param {TaskBoard.model.SwimlaneModel} event.swimlaneRecord Swimlane record for the tasks swimlane (if used)
|
|
1772
|
+
* @param {MouseEvent} event.event Browser event
|
|
1773
|
+
*/
|
|
1774
|
+
onTaskClick: any;
|
|
1775
|
+
/**
|
|
1776
|
+
* Triggered when a card is double-clicked
|
|
1777
|
+
* ...
|
|
1778
|
+
* [View online docs...](https://bryntum.com/products/taskboard/docs/api/TaskBoard/view/TaskBoardBase#event-taskDblClick)
|
|
1779
|
+
* @param {object} event Event object
|
|
1780
|
+
* @param {TaskBoard.view.TaskBoard} event.source This TaskBoard
|
|
1781
|
+
* @param {TaskBoard.model.TaskModel} event.taskRecord Task record
|
|
1782
|
+
* @param {TaskBoard.model.ColumnModel} event.columnRecord Column record for the tasks column
|
|
1783
|
+
* @param {TaskBoard.model.SwimlaneModel} event.swimlaneRecord Swimlane record for the tasks swimlane (if used)
|
|
1784
|
+
* @param {MouseEvent} event.event Browser event
|
|
1785
|
+
*/
|
|
1786
|
+
onTaskDblClick: any;
|
|
1787
|
+
/**
|
|
1788
|
+
* Fires on the owning TaskBoard when tasks are dragged, if the drag leads to any changes compared to
|
|
1789
|
+
* the last taskDrag event (moved to a new column or changed order within a column).
|
|
1790
|
+
* ...
|
|
1791
|
+
* [View online docs...](https://bryntum.com/products/taskboard/docs/api/TaskBoard/view/TaskBoardBase#event-taskDrag)
|
|
1792
|
+
* @param {object} event Event object
|
|
1793
|
+
* @param {TaskBoard.view.TaskBoard} event.source Owning TaskBoard
|
|
1794
|
+
* @param {TaskBoard.model.TaskModel[]} event.taskRecords Dragged tasks
|
|
1795
|
+
* @param {TaskBoard.model.ColumnModel} event.targetColumn Currently over this column
|
|
1796
|
+
* @param {TaskBoard.model.SwimlaneModel} event.targetSwimlane Currently over this swimlane (if used)
|
|
1797
|
+
* @param {Event} event.domEvent The mouse event
|
|
1798
|
+
*/
|
|
1799
|
+
onTaskDrag: any;
|
|
1800
|
+
/**
|
|
1801
|
+
* Fires on the owning TaskBoard when a drag operation is aborted (invalid drop or aborted using ESC)
|
|
1802
|
+
* @param {object} event Event object
|
|
1803
|
+
* @param {TaskBoard.view.TaskBoard} event.source Owning TaskBoard
|
|
1804
|
+
* @param {TaskBoard.model.TaskModel[]} event.taskRecords Dragged tasks
|
|
1805
|
+
*/
|
|
1806
|
+
onTaskDragAbort: any;
|
|
1807
|
+
/**
|
|
1808
|
+
* Fires on the owning TaskBoard when a previously started drag operation ends, no matter the
|
|
1809
|
+
* outcome of it (whether valid, invalid or aborted)
|
|
1810
|
+
* @param {object} event Event object
|
|
1811
|
+
* @param {TaskBoard.view.TaskBoard} event.source Owning TaskBoard
|
|
1812
|
+
* @param {TaskBoard.model.TaskModel[]} event.taskRecords Affected tasks
|
|
1813
|
+
* @param {Event} event.domEvent The mouse event
|
|
1814
|
+
*/
|
|
1815
|
+
onTaskDragEnd: any;
|
|
1816
|
+
/**
|
|
1817
|
+
* Fires on the owning TaskBoard when task dragging starts
|
|
1818
|
+
* @param {object} event Event object
|
|
1819
|
+
* @param {TaskBoard.view.TaskBoard} event.source Owning TaskBoard
|
|
1820
|
+
* @param {TaskBoard.model.TaskModel[]} event.taskRecords Tasks to be dragged
|
|
1821
|
+
* @param {Event} event.domEvent The mouse event
|
|
1822
|
+
*/
|
|
1823
|
+
onTaskDragStart: any;
|
|
1824
|
+
/**
|
|
1825
|
+
* Fires on the owning TaskBoard when tasks are successfully dropped (after the drop transition has
|
|
1826
|
+
* finished)
|
|
1827
|
+
* @param {object} event Event object
|
|
1828
|
+
* @param {TaskBoard.view.TaskBoard} event.source Owning TaskBoard
|
|
1829
|
+
* @param {TaskBoard.model.TaskModel[]} event.taskRecords Dropped tasks
|
|
1830
|
+
* @param {TaskBoard.model.ColumnModel} event.targetColumn Dropped on this column
|
|
1831
|
+
* @param {TaskBoard.model.SwimlaneModel} event.targetSwimlane Dropped in this swimlane (if used)
|
|
1832
|
+
* @param {Event} event.domEvent The mouse event
|
|
1833
|
+
*/
|
|
1834
|
+
onTaskDrop: any;
|
|
1835
|
+
/**
|
|
1836
|
+
* This event fires on the owning TaskBoard before the context menu is shown for a task.
|
|
1837
|
+
* Allows manipulation of the items to show in the same way as in the [processItems](https://bryntum.com/products/taskboard/docs/api/TaskBoard/feature/TaskMenu#config-processItems).
|
|
1838
|
+
* ...
|
|
1839
|
+
* [View online docs...](https://bryntum.com/products/taskboard/docs/api/TaskBoard/view/TaskBoardBase#event-taskMenuBeforeShow)
|
|
1840
|
+
* @param {object} event Event object
|
|
1841
|
+
* @param {TaskBoard.view.TaskBoard} event.source The grid
|
|
1842
|
+
* @param {Core.widget.Menu} event.menu The menu
|
|
1843
|
+
* @param {Record<string, MenuItemEntry>} event.items Menu item configs
|
|
1844
|
+
* @param {TaskBoard.model.TaskModel} event.taskRecord The task
|
|
1845
|
+
*/
|
|
1846
|
+
onTaskMenuBeforeShow: any;
|
|
1847
|
+
/**
|
|
1848
|
+
* This event fires on the owning TaskBoard when an item is selected in the task context menu.
|
|
1849
|
+
* @param {object} event Event object
|
|
1850
|
+
* @param {TaskBoard.view.TaskBoard} event.source The grid
|
|
1851
|
+
* @param {Core.widget.Menu} event.menu The menu
|
|
1852
|
+
* @param {Core.widget.MenuItem} event.item Selected menu item
|
|
1853
|
+
* @param {TaskBoard.model.TaskModel} event.taskRecord The task
|
|
1854
|
+
*/
|
|
1855
|
+
onTaskMenuItem: any;
|
|
1856
|
+
/**
|
|
1857
|
+
* This event fires on the owning TaskBoard after the context menu is shown for a task.
|
|
1858
|
+
* @param {object} event Event object
|
|
1859
|
+
* @param {TaskBoard.view.TaskBoard} event.source The grid
|
|
1860
|
+
* @param {Core.widget.Menu} event.menu The menu
|
|
1861
|
+
* @param {Record<string, MenuItemEntry>} event.items Menu item configs
|
|
1862
|
+
* @param {TaskBoard.model.TaskModel} event.taskRecord The task
|
|
1863
|
+
*/
|
|
1864
|
+
onTaskMenuShow: any;
|
|
1865
|
+
/**
|
|
1866
|
+
* This event fires on the owning TaskBoard when a check item is toggled in the task context menu.
|
|
1867
|
+
* @param {object} event Event object
|
|
1868
|
+
* @param {TaskBoard.view.TaskBoard} event.source The grid
|
|
1869
|
+
* @param {Core.widget.Menu} event.menu The menu
|
|
1870
|
+
* @param {Core.widget.MenuItem} event.item Selected menu item
|
|
1871
|
+
* @param {TaskBoard.model.TaskModel} event.taskRecord The task
|
|
1872
|
+
* @param {boolean} event.checked Checked or not
|
|
1873
|
+
*/
|
|
1874
|
+
onTaskMenuToggleItem: any;
|
|
1875
|
+
/**
|
|
1876
|
+
* Triggered when the mouse enters a card
|
|
1877
|
+
* ...
|
|
1878
|
+
* [View online docs...](https://bryntum.com/products/taskboard/docs/api/TaskBoard/view/TaskBoardBase#event-taskMouseEnter)
|
|
1879
|
+
* @param {object} event Event object
|
|
1880
|
+
* @param {TaskBoard.view.TaskBoard} event.source This TaskBoard
|
|
1881
|
+
* @param {TaskBoard.model.TaskModel} event.taskRecord Task record
|
|
1882
|
+
* @param {TaskBoard.model.ColumnModel} event.columnRecord Column record for the tasks column
|
|
1883
|
+
* @param {TaskBoard.model.SwimlaneModel} event.swimlaneRecord Swimlane record for the tasks swimlane (if used)
|
|
1884
|
+
* @param {MouseEvent} event.event Browser event
|
|
1885
|
+
*/
|
|
1886
|
+
onTaskMouseEnter: any;
|
|
1887
|
+
/**
|
|
1888
|
+
* Triggered when the mouse leaves a card
|
|
1889
|
+
* ...
|
|
1890
|
+
* [View online docs...](https://bryntum.com/products/taskboard/docs/api/TaskBoard/view/TaskBoardBase#event-taskMouseLeave)
|
|
1891
|
+
* @param {object} event Event object
|
|
1892
|
+
* @param {TaskBoard.view.TaskBoard} event.source This TaskBoard
|
|
1893
|
+
* @param {TaskBoard.model.TaskModel} event.taskRecord Task record
|
|
1894
|
+
* @param {TaskBoard.model.ColumnModel} event.columnRecord Column record for the tasks column
|
|
1895
|
+
* @param {TaskBoard.model.SwimlaneModel} event.swimlaneRecord Swimlane record for the tasks swimlane (if used)
|
|
1896
|
+
* @param {MouseEvent} event.event Browser event
|
|
1897
|
+
*/
|
|
1898
|
+
onTaskMouseLeave: any;
|
|
1899
|
+
/**
|
|
1900
|
+
* A header [tool](https://bryntum.com/products/taskboard/docs/api/Core/widget/Panel#config-tools) has been clicked.
|
|
1901
|
+
* @param {object} event Event object
|
|
1902
|
+
* @param {Core.widget.Tool} event.source This Panel.
|
|
1903
|
+
* @param {Core.widget.Tool} event.tool The tool which is being clicked.
|
|
1904
|
+
*/
|
|
1905
|
+
onToolClick: any;
|
|
1906
|
+
/**
|
|
1907
|
+
* Create and append the underlying widget
|
|
1908
|
+
*/
|
|
1909
|
+
ngOnInit(): void;
|
|
1910
|
+
/**
|
|
1911
|
+
* Watch for changes
|
|
1912
|
+
* @param changes
|
|
1913
|
+
*/
|
|
1914
|
+
ngOnChanges(changes: SimpleChanges): void;
|
|
1915
|
+
/**
|
|
1916
|
+
* Destroy the component
|
|
1917
|
+
*/
|
|
1918
|
+
ngOnDestroy(): void;
|
|
1919
|
+
static ɵfac: i0.ɵɵFactoryDeclaration<BryntumTaskBoardBaseComponent, never>;
|
|
1920
|
+
static ɵcmp: i0.ɵɵComponentDeclaration<BryntumTaskBoardBaseComponent, "bryntum-task-board-base", never, { "activateTaskEvent": "activateTaskEvent"; "adopt": "adopt"; "align": "align"; "anchor": "anchor"; "ariaDescription": "ariaDescription"; "ariaLabel": "ariaLabel"; "autoGenerateColumns": "autoGenerateColumns"; "autoGenerateSwimlanes": "autoGenerateSwimlanes"; "bbar": "bbar"; "bodyCls": "bodyCls"; "bubbleEvents": "bubbleEvents"; "cardSizes": "cardSizes"; "centered": "centered"; "chainFilters": "chainFilters"; "collapseTitle": "collapseTitle"; "collapsible": "collapsible"; "color": "color"; "columnTitleRenderer": "columnTitleRenderer"; "config": "config"; "constrainTo": "constrainTo"; "cssVarPrefix": "cssVarPrefix"; "dataField": "dataField"; "detectCSSCompatibilityIssues": "detectCSSCompatibilityIssues"; "dock": "dock"; "draggable": "draggable"; "drawer": "drawer"; "elementAttributes": "elementAttributes"; "floating": "floating"; "footer": "footer"; "header": "header"; "hideAnimation": "hideAnimation"; "htmlEncodeHeaderText": "htmlEncodeHeaderText"; "icon": "icon"; "ignoreParentReadOnly": "ignoreParentReadOnly"; "listeners": "listeners"; "loadMask": "loadMask"; "loadMaskDefaults": "loadMaskDefaults"; "loadMaskError": "loadMaskError"; "localeClass": "localeClass"; "localizable": "localizable"; "localizableProperties": "localizableProperties"; "maskDefaults": "maskDefaults"; "masked": "masked"; "newTaskDefaults": "newTaskDefaults"; "owner": "owner"; "plugins": "plugins"; "positioned": "positioned"; "processItems": "processItems"; "record": "record"; "relayStoreEvents": "relayStoreEvents"; "resourceImagePath": "resourceImagePath"; "responsive": "responsive"; "responsiveRoot": "responsiveRoot"; "responsiveState": "responsiveState"; "responsiveTarget": "responsiveTarget"; "rootElement": "rootElement"; "scrollable": "scrollable"; "scrollAction": "scrollAction"; "scrollManager": "scrollManager"; "scrollOptions": "scrollOptions"; "selectOnNavigation": "selectOnNavigation"; "showAnimation": "showAnimation"; "showCollapseInHeader": "showCollapseInHeader"; "showCountInHeader": "showCountInHeader"; "stateful": "stateful"; "statefulEvents": "statefulEvents"; "stateId": "stateId"; "stateProvider": "stateProvider"; "stickyHeaders": "stickyHeaders"; "strips": "strips"; "swimlaneRenderer": "swimlaneRenderer"; "syncMask": "syncMask"; "tab": "tab"; "tabBarItems": "tabBarItems"; "taskRenderer": "taskRenderer"; "taskSorterFn": "taskSorterFn"; "tasksPerRow": "tasksPerRow"; "tbar": "tbar"; "ui": "ui"; "useDomTransition": "useDomTransition"; "weight": "weight"; "alignSelf": "alignSelf"; "appendTo": "appendTo"; "assignments": "assignments"; "bodyItems": "bodyItems"; "callOnFunctions": "callOnFunctions"; "catchEventHandlerExceptions": "catchEventHandlerExceptions"; "cls": "cls"; "collapsed": "collapsed"; "column": "column"; "columnField": "columnField"; "columns": "columns"; "css": "css"; "dataset": "dataset"; "disabled": "disabled"; "drawOnScroll": "drawOnScroll"; "extraData": "extraData"; "flex": "flex"; "footerItems": "footerItems"; "getTaskHeight": "getTaskHeight"; "headerItems": "headerItems"; "height": "height"; "hidden": "hidden"; "id": "id"; "inputFieldAlign": "inputFieldAlign"; "insertBefore": "insertBefore"; "insertFirst": "insertFirst"; "isTaskSelectable": "isTaskSelectable"; "keyMap": "keyMap"; "labelPosition": "labelPosition"; "margin": "margin"; "maxHeight": "maxHeight"; "maximizeOnMobile": "maximizeOnMobile"; "maxWidth": "maxWidth"; "minHeight": "minHeight"; "minWidth": "minWidth"; "project": "project"; "readOnly": "readOnly"; "rendition": "rendition"; "resources": "resources"; "rtl": "rtl"; "selectedTasks": "selectedTasks"; "showCollapseTooltip": "showCollapseTooltip"; "span": "span"; "stretchCards": "stretchCards"; "strictRecordMapping": "strictRecordMapping"; "swimlaneField": "swimlaneField"; "swimlanes": "swimlanes"; "tasks": "tasks"; "title": "title"; "tools": "tools"; "virtualize": "virtualize"; "width": "width"; "x": "x"; "y": "y"; "anchorSize": "anchorSize"; "focusVisible": "focusVisible"; "hasChanges": "hasChanges"; "parent": "parent"; "state": "state"; "columnDragFeature": "columnDragFeature"; "columnFilterFeature": "columnFilterFeature"; "columnHeaderMenuFeature": "columnHeaderMenuFeature"; "columnLockFeature": "columnLockFeature"; "columnRenameFeature": "columnRenameFeature"; "columnResizeFeature": "columnResizeFeature"; "columnSortFeature": "columnSortFeature"; "columnToolbarsFeature": "columnToolbarsFeature"; "filterBarFeature": "filterBarFeature"; "simpleTaskEditFeature": "simpleTaskEditFeature"; "swimlaneDragFeature": "swimlaneDragFeature"; "taskDragFeature": "taskDragFeature"; "taskDragSelectFeature": "taskDragSelectFeature"; "taskEditFeature": "taskEditFeature"; "taskMenuFeature": "taskMenuFeature"; "taskTooltipFeature": "taskTooltipFeature"; }, { "onActivateTask": "onActivateTask"; "onBeforeColumnDrag": "onBeforeColumnDrag"; "onBeforeColumnDrop": "onBeforeColumnDrop"; "onBeforeColumnResize": "onBeforeColumnResize"; "onBeforeDestroy": "onBeforeDestroy"; "onBeforeHide": "onBeforeHide"; "onBeforeResponsiveStateChange": "onBeforeResponsiveStateChange"; "onBeforeShow": "onBeforeShow"; "onBeforeSimpleTaskEdit": "onBeforeSimpleTaskEdit"; "onBeforeStateApply": "onBeforeStateApply"; "onBeforeStateSave": "onBeforeStateSave"; "onBeforeTaskDrag": "onBeforeTaskDrag"; "onBeforeTaskDrop": "onBeforeTaskDrop"; "onBeforeTaskEdit": "onBeforeTaskEdit"; "onBeforeTaskEditShow": "onBeforeTaskEditShow"; "onBeforeTaskRemove": "onBeforeTaskRemove"; "onCatchAll": "onCatchAll"; "onCellMenuItem": "onCellMenuItem"; "onCellMenuShow": "onCellMenuShow"; "onCellMenuToggleItem": "onCellMenuToggleItem"; "onCollapse": "onCollapse"; "onColumnCollapse": "onColumnCollapse"; "onColumnDrag": "onColumnDrag"; "onColumnDragAbort": "onColumnDragAbort"; "onColumnDragEnd": "onColumnDragEnd"; "onColumnDragStart": "onColumnDragStart"; "onColumnDrop": "onColumnDrop"; "onColumnExpand": "onColumnExpand"; "onColumnFilterHide": "onColumnFilterHide"; "onColumnFilterShow": "onColumnFilterShow"; "onColumnFilterToggle": "onColumnFilterToggle"; "onColumnHeaderClick": "onColumnHeaderClick"; "onColumnHeaderContextMenu": "onColumnHeaderContextMenu"; "onColumnHeaderDblClick": "onColumnHeaderDblClick"; "onColumnHeaderMenuBeforeShow": "onColumnHeaderMenuBeforeShow"; "onColumnResize": "onColumnResize"; "onColumnResizeStart": "onColumnResizeStart"; "onColumnTitleClick": "onColumnTitleClick"; "onColumnTitleContextMenu": "onColumnTitleContextMenu"; "onColumnTitleDblClick": "onColumnTitleDblClick"; "onColumnToggle": "onColumnToggle"; "onDestroy": "onDestroy"; "onDirtyStateChange": "onDirtyStateChange"; "onElementCreated": "onElementCreated"; "onExpand": "onExpand"; "onFocusIn": "onFocusIn"; "onFocusOut": "onFocusOut"; "onHide": "onHide"; "onPaint": "onPaint"; "onReadOnly": "onReadOnly"; "onRecompose": "onRecompose"; "onRemoveTaskElement": "onRemoveTaskElement"; "onRenderTask": "onRenderTask"; "onRenderTasks": "onRenderTasks"; "onResize": "onResize"; "onResponsiveStateChange": "onResponsiveStateChange"; "onSelectionChange": "onSelectionChange"; "onShow": "onShow"; "onSimpleTaskEditCancel": "onSimpleTaskEditCancel"; "onSimpleTaskEditComplete": "onSimpleTaskEditComplete"; "onSwimlaneCollapse": "onSwimlaneCollapse"; "onSwimlaneExpand": "onSwimlaneExpand"; "onSwimlaneHeaderClick": "onSwimlaneHeaderClick"; "onSwimlaneHeaderContextMenu": "onSwimlaneHeaderContextMenu"; "onSwimlaneHeaderDblClick": "onSwimlaneHeaderDblClick"; "onSwimlaneToggle": "onSwimlaneToggle"; "onTaskClick": "onTaskClick"; "onTaskDblClick": "onTaskDblClick"; "onTaskDrag": "onTaskDrag"; "onTaskDragAbort": "onTaskDragAbort"; "onTaskDragEnd": "onTaskDragEnd"; "onTaskDragStart": "onTaskDragStart"; "onTaskDrop": "onTaskDrop"; "onTaskMenuBeforeShow": "onTaskMenuBeforeShow"; "onTaskMenuItem": "onTaskMenuItem"; "onTaskMenuShow": "onTaskMenuShow"; "onTaskMenuToggleItem": "onTaskMenuToggleItem"; "onTaskMouseEnter": "onTaskMouseEnter"; "onTaskMouseLeave": "onTaskMouseLeave"; "onToolClick": "onToolClick"; }, never, never>;
|
|
1921
|
+
}
|