@bryntum/taskboard-angular-thin 7.1.1 → 7.1.2

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