@bryntum/grid-angular-thin 7.3.1 → 7.3.3

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 (36) hide show
  1. package/README.md +4 -4
  2. package/bundles/bryntum-grid-angular-thin.umd.js +40 -31
  3. package/bundles/bryntum-grid-angular-thin.umd.js.map +1 -1
  4. package/esm2015/lib/bryntum-a-i-filter-field.component.js +5 -5
  5. package/esm2015/lib/bryntum-checklist-filter-combo.component.js +5 -5
  6. package/esm2015/lib/bryntum-grid-base.component.js +5 -2
  7. package/esm2015/lib/bryntum-grid-chart-designer.component.js +5 -5
  8. package/esm2015/lib/bryntum-grid-field-filter-picker-group.component.js +5 -5
  9. package/esm2015/lib/bryntum-grid-field-filter-picker.component.js +5 -5
  10. package/esm2015/lib/bryntum-grid.component.js +5 -2
  11. package/esm2015/lib/bryntum-group-bar.component.js +5 -5
  12. package/esm2015/lib/bryntum-tree-combo.component.js +5 -5
  13. package/esm2015/lib/bryntum-tree-grid.component.js +5 -2
  14. package/fesm2015/bryntum-grid-angular-thin.js +40 -31
  15. package/fesm2015/bryntum-grid-angular-thin.js.map +1 -1
  16. package/lib/bryntum-a-i-filter-field.component.d.ts +15 -6
  17. package/lib/bryntum-checklist-filter-combo.component.d.ts +15 -6
  18. package/lib/bryntum-grid-base.component.d.ts +11 -2
  19. package/lib/bryntum-grid-chart-designer.component.d.ts +15 -6
  20. package/lib/bryntum-grid-field-filter-picker-group.component.d.ts +16 -7
  21. package/lib/bryntum-grid-field-filter-picker.component.d.ts +16 -7
  22. package/lib/bryntum-grid.component.d.ts +11 -2
  23. package/lib/bryntum-group-bar.component.d.ts +19 -8
  24. package/lib/bryntum-tree-combo.component.d.ts +15 -6
  25. package/lib/bryntum-tree-grid.component.d.ts +11 -2
  26. package/package.json +1 -1
  27. package/src/lib/bryntum-a-i-filter-field.component.ts +15 -6
  28. package/src/lib/bryntum-checklist-filter-combo.component.ts +15 -6
  29. package/src/lib/bryntum-grid-base.component.ts +11 -1
  30. package/src/lib/bryntum-grid-chart-designer.component.ts +15 -6
  31. package/src/lib/bryntum-grid-field-filter-picker-group.component.ts +16 -7
  32. package/src/lib/bryntum-grid-field-filter-picker.component.ts +16 -7
  33. package/src/lib/bryntum-grid.component.ts +11 -1
  34. package/src/lib/bryntum-group-bar.component.ts +19 -8
  35. package/src/lib/bryntum-tree-combo.component.ts +15 -6
  36. package/src/lib/bryntum-tree-grid.component.ts +11 -1
@@ -40,6 +40,8 @@ export type BryntumAIFilterFieldProps = {
40
40
  /**
41
41
  * Element (or the id of an element) to append this widget's element to. Can be configured, or set once at
42
42
  * runtime. To access the element of a rendered widget, see [element](https://bryntum.com/products/grid/docs/api/Core/widget/Widget#property-element).
43
+ * <div class="note">When creating nested trees of widgets, this should only be used on the outermost widget.
44
+ * [More...](https://bryntum.com/products/grid/docs/api/Grid/widget/AIFilterField#config-appendTo)
43
45
  */
44
46
  appendTo ? : HTMLElement|string
45
47
  /**
@@ -86,9 +88,10 @@ export type BryntumAIFilterFieldProps = {
86
88
  catchEventHandlerExceptions ? : boolean
87
89
  /**
88
90
  * *Only valid if this Widget is [floating](https://bryntum.com/products/grid/docs/api/Core/widget/Widget#config-floating).*
89
- * Set to `true` to centre the Widget in browser viewport space.
91
+ * [More...](https://bryntum.com/products/grid/docs/api/Grid/widget/AIFilterField#config-centered)
92
+ * @property {boolean} [once] If `true`, the Widget will be centred on its first show, but if it is moved at runtime, it will opt out of centering for future shows.
90
93
  */
91
- centered ? : boolean
94
+ centered ? : boolean|object
92
95
  /**
93
96
  * A function (or the name of a function in the ownership hierarchy) called during field validation
94
97
  * to perform custom validity checks. The function is called as part of the [isValid](https://bryntum.com/products/grid/docs/api/Core/widget/Field#property-isValid)
@@ -190,7 +193,7 @@ export type BryntumAIFilterFieldProps = {
190
193
  dock ? : 'top'|'bottom'|'left'|'right'|'start'|'end'|'header'|'pre-header'|object
191
194
  /**
192
195
  * *Only valid if this Widget is [floating](https://bryntum.com/products/grid/docs/api/Core/widget/Widget#config-floating).*
193
- * Set to `true` to be able to drag a widget freely on the page. Or set to an object with a ´handleSelector´
196
+ * Set to `true` to be able to drag a widget freely on the page. Or set to an object with a `handleSelector`
194
197
  * property which controls when a drag should start.
195
198
  * [More...](https://bryntum.com/products/grid/docs/api/Grid/widget/AIFilterField#config-draggable)
196
199
  * @property {string} handleSelector CSS selector used to determine if drag can be started from a mouse-downed element inside the widget
@@ -306,10 +309,14 @@ export type BryntumAIFilterFieldProps = {
306
309
  inputWidth ? : string|number
307
310
  /**
308
311
  * Element (or element id) to insert this widget before. If provided, [appendTo](https://bryntum.com/products/grid/docs/api/Core/widget/Widget#config-appendTo) config is ignored.
312
+ * <div class="note">When creating nested trees of widgets, this should only be used on the outermost widget.
313
+ * [More...](https://bryntum.com/products/grid/docs/api/Grid/widget/AIFilterField#config-insertBefore)
309
314
  */
310
315
  insertBefore ? : HTMLElement|string
311
316
  /**
312
317
  * Element (or element id) to append this widget element to, as a first child. If provided, [appendTo](https://bryntum.com/products/grid/docs/api/Core/widget/Widget#config-appendTo) config is ignored.
318
+ * <div class="note">When creating nested trees of widgets, this should only be used on the outermost widget.
319
+ * [More...](https://bryntum.com/products/grid/docs/api/Grid/widget/AIFilterField#config-insertFirst)
313
320
  */
314
321
  insertFirst ? : HTMLElement|string
315
322
  /**
@@ -511,7 +518,7 @@ export type BryntumAIFilterFieldProps = {
511
518
  rtl ? : boolean
512
519
  /**
513
520
  * Defines what to do if document is scrolled while Widget is visible (only relevant when floating is set to `true`).
514
- * Valid values: ´null´: do nothing, ´hide´: hide the widget or ´realign´: realign to the target if possible.
521
+ * Valid values: `null`: do nothing, `hide`: hide the widget or `realign`: realign to the target if possible.
515
522
  */
516
523
  scrollAction ? : 'hide'|'realign'|null
517
524
  /**
@@ -775,7 +782,6 @@ export class BryntumAIFilterFieldComponent implements OnInit, OnDestroy {
775
782
  'autoComplete',
776
783
  'autoSelect',
777
784
  'bubbleEvents',
778
- 'centered',
779
785
  'checkValidity',
780
786
  'clearable',
781
787
  'client',
@@ -847,6 +853,7 @@ export class BryntumAIFilterFieldComponent implements OnInit, OnDestroy {
847
853
  'badge',
848
854
  'callOnFunctions',
849
855
  'catchEventHandlerExceptions',
856
+ 'centered',
850
857
  'cls',
851
858
  'column',
852
859
  'content',
@@ -913,7 +920,6 @@ export class BryntumAIFilterFieldComponent implements OnInit, OnDestroy {
913
920
  @Input() autoComplete ! : string;
914
921
  @Input() autoSelect ! : boolean;
915
922
  @Input() bubbleEvents ! : object;
916
- @Input() centered ! : boolean;
917
923
  @Input() checkValidity ! : ((field: Field) => void)|string;
918
924
  @Input() clearable ! : boolean|FieldTriggerConfig;
919
925
  @Input() client ! : Grid;
@@ -984,6 +990,9 @@ export class BryntumAIFilterFieldComponent implements OnInit, OnDestroy {
984
990
  @Input() badge ! : string;
985
991
  @Input() callOnFunctions ! : boolean;
986
992
  @Input() catchEventHandlerExceptions ! : boolean;
993
+ @Input() centered ! : boolean|{
994
+ once?: boolean
995
+ }|boolean|object;
987
996
  @Input() cls ! : string|object;
988
997
  @Input() column ! : number;
989
998
  @Input() dataset ! : object|Record<string, string>;
@@ -40,6 +40,8 @@ export type BryntumChecklistFilterComboProps = {
40
40
  /**
41
41
  * Element (or the id of an element) to append this widget's element to. Can be configured, or set once at
42
42
  * runtime. To access the element of a rendered widget, see [element](https://bryntum.com/products/grid/docs/api/Core/widget/Widget#property-element).
43
+ * <div class="note">When creating nested trees of widgets, this should only be used on the outermost widget.
44
+ * [More...](https://bryntum.com/products/grid/docs/api/Grid/widget/ChecklistFilterCombo#config-appendTo)
43
45
  */
44
46
  appendTo ? : HTMLElement|string
45
47
  /**
@@ -99,9 +101,10 @@ export type BryntumChecklistFilterComboProps = {
99
101
  catchEventHandlerExceptions ? : boolean
100
102
  /**
101
103
  * *Only valid if this Widget is [floating](https://bryntum.com/products/grid/docs/api/Core/widget/Widget#config-floating).*
102
- * Set to `true` to centre the Widget in browser viewport space.
104
+ * [More...](https://bryntum.com/products/grid/docs/api/Grid/widget/ChecklistFilterCombo#config-centered)
105
+ * @property {boolean} [once] If `true`, the Widget will be centred on its first show, but if it is moved at runtime, it will opt out of centering for future shows.
103
106
  */
104
- centered ? : boolean
107
+ centered ? : boolean|object
105
108
  /**
106
109
  * A function (or the name of a function in the ownership hierarchy) called during field validation
107
110
  * to perform custom validity checks. The function is called as part of the [isValid](https://bryntum.com/products/grid/docs/api/Core/widget/Field#property-isValid)
@@ -237,7 +240,7 @@ export type BryntumChecklistFilterComboProps = {
237
240
  dock ? : 'top'|'bottom'|'left'|'right'|'start'|'end'|'header'|'pre-header'|object
238
241
  /**
239
242
  * *Only valid if this Widget is [floating](https://bryntum.com/products/grid/docs/api/Core/widget/Widget#config-floating).*
240
- * Set to `true` to be able to drag a widget freely on the page. Or set to an object with a ´handleSelector´
243
+ * Set to `true` to be able to drag a widget freely on the page. Or set to an object with a `handleSelector`
241
244
  * property which controls when a drag should start.
242
245
  * [More...](https://bryntum.com/products/grid/docs/api/Grid/widget/ChecklistFilterCombo#config-draggable)
243
246
  * @property {string} handleSelector CSS selector used to determine if drag can be started from a mouse-downed element inside the widget
@@ -404,10 +407,14 @@ export type BryntumChecklistFilterComboProps = {
404
407
  inputWidth ? : string|number
405
408
  /**
406
409
  * Element (or element id) to insert this widget before. If provided, [appendTo](https://bryntum.com/products/grid/docs/api/Core/widget/Widget#config-appendTo) config is ignored.
410
+ * <div class="note">When creating nested trees of widgets, this should only be used on the outermost widget.
411
+ * [More...](https://bryntum.com/products/grid/docs/api/Grid/widget/ChecklistFilterCombo#config-insertBefore)
407
412
  */
408
413
  insertBefore ? : HTMLElement|string
409
414
  /**
410
415
  * Element (or element id) to append this widget element to, as a first child. If provided, [appendTo](https://bryntum.com/products/grid/docs/api/Core/widget/Widget#config-appendTo) config is ignored.
416
+ * <div class="note">When creating nested trees of widgets, this should only be used on the outermost widget.
417
+ * [More...](https://bryntum.com/products/grid/docs/api/Grid/widget/ChecklistFilterCombo#config-insertFirst)
411
418
  */
412
419
  insertFirst ? : HTMLElement|string
413
420
  /**
@@ -669,7 +676,7 @@ export type BryntumChecklistFilterComboProps = {
669
676
  rtl ? : boolean
670
677
  /**
671
678
  * Defines what to do if document is scrolled while Widget is visible (only relevant when floating is set to `true`).
672
- * Valid values: ´null´: do nothing, ´hide´: hide the widget or ´realign´: realign to the target if possible.
679
+ * Valid values: `null`: do nothing, `hide`: hide the widget or `realign`: realign to the target if possible.
673
680
  */
674
681
  scrollAction ? : 'hide'|'realign'|null
675
682
  /**
@@ -1000,7 +1007,6 @@ export class BryntumChecklistFilterComboComponent implements OnInit, OnDestroy {
1000
1007
  'bubbleEvents',
1001
1008
  'cacheLastResult',
1002
1009
  'caseSensitive',
1003
- 'centered',
1004
1010
  'checkValidity',
1005
1011
  'chipView',
1006
1012
  'clearable',
@@ -1098,6 +1104,7 @@ export class BryntumChecklistFilterComboComponent implements OnInit, OnDestroy {
1098
1104
  'badge',
1099
1105
  'callOnFunctions',
1100
1106
  'catchEventHandlerExceptions',
1107
+ 'centered',
1101
1108
  'cls',
1102
1109
  'column',
1103
1110
  'content',
@@ -1174,7 +1181,6 @@ export class BryntumChecklistFilterComboComponent implements OnInit, OnDestroy {
1174
1181
  @Input() bubbleEvents ! : object;
1175
1182
  @Input() cacheLastResult ! : number|string|Duration|DurationConfig;
1176
1183
  @Input() caseSensitive ! : boolean;
1177
- @Input() centered ! : boolean;
1178
1184
  @Input() checkValidity ! : ((field: Field) => void)|string;
1179
1185
  @Input() chipView ! : ChipViewConfig;
1180
1186
  @Input() clearable ! : boolean|FieldTriggerConfig;
@@ -1271,6 +1277,9 @@ export class BryntumChecklistFilterComboComponent implements OnInit, OnDestroy {
1271
1277
  @Input() badge ! : string;
1272
1278
  @Input() callOnFunctions ! : boolean;
1273
1279
  @Input() catchEventHandlerExceptions ! : boolean;
1280
+ @Input() centered ! : boolean|{
1281
+ once?: boolean
1282
+ }|boolean|object;
1274
1283
  @Input() cls ! : string|object;
1275
1284
  @Input() column ! : number;
1276
1285
  @Input() dataset ! : object|Record<string, string>;
@@ -48,6 +48,8 @@ export type BryntumGridBaseProps = {
48
48
  /**
49
49
  * Element (or the id of an element) to append this widget's element to. Can be configured, or set once at
50
50
  * runtime. To access the element of a rendered widget, see [element](https://bryntum.com/products/grid/docs/api/Core/widget/Widget#property-element).
51
+ * <div class="note">When creating nested trees of widgets, this should only be used on the outermost widget.
52
+ * [More...](https://bryntum.com/products/grid/docs/api/Grid/view/GridBase#config-appendTo)
51
53
  */
52
54
  appendTo ? : HTMLElement|string
53
55
  /**
@@ -359,10 +361,14 @@ export type BryntumGridBaseProps = {
359
361
  inputFieldAlign ? : 'start'|'end'
360
362
  /**
361
363
  * Element (or element id) to insert this widget before. If provided, [appendTo](https://bryntum.com/products/grid/docs/api/Core/widget/Widget#config-appendTo) config is ignored.
364
+ * <div class="note">When creating nested trees of widgets, this should only be used on the outermost widget.
365
+ * [More...](https://bryntum.com/products/grid/docs/api/Grid/view/GridBase#config-insertBefore)
362
366
  */
363
367
  insertBefore ? : HTMLElement|string
364
368
  /**
365
369
  * Element (or element id) to append this widget element to, as a first child. If provided, [appendTo](https://bryntum.com/products/grid/docs/api/Core/widget/Widget#config-appendTo) config is ignored.
370
+ * <div class="note">When creating nested trees of widgets, this should only be used on the outermost widget.
371
+ * [More...](https://bryntum.com/products/grid/docs/api/Grid/view/GridBase#config-insertFirst)
366
372
  */
367
373
  insertFirst ? : HTMLElement|string
368
374
  /**
@@ -375,7 +381,7 @@ export type BryntumGridBaseProps = {
375
381
  */
376
382
  labelPosition ? : 'before'|'above'|'align-before'|'auto'|null
377
383
  /**
378
- * Sets `labelWidth´ for all children of this Container, that does not define their own `labelWidth`.
384
+ * Sets `labelWidth` for all children of this Container, that do not define their own `labelWidth`.
379
385
  * [More...](https://bryntum.com/products/grid/docs/api/Grid/view/GridBase#config-labelWidth)
380
386
  */
381
387
  labelWidth ? : number|null
@@ -1350,6 +1356,7 @@ export class BryntumGridBaseComponent implements OnInit, OnDestroy {
1350
1356
  'callOnFunctions',
1351
1357
  'catchEventHandlerExceptions',
1352
1358
  'cellEllipsis',
1359
+ 'centered',
1353
1360
  'cls',
1354
1361
  'collapsed',
1355
1362
  'column',
@@ -1560,6 +1567,9 @@ export class BryntumGridBaseComponent implements OnInit, OnDestroy {
1560
1567
  @Input() width ! : number|string;
1561
1568
 
1562
1569
  // Properties only
1570
+ @Input() centered ! : boolean|{
1571
+ once?: boolean
1572
+ };
1563
1573
  @Input() originalStore ! : Store;
1564
1574
  @Input() parent ! : Widget;
1565
1575
  @Input() selectedCell ! : GridLocation|GridLocationConfig;
@@ -40,6 +40,8 @@ export type BryntumGridChartDesignerProps = {
40
40
  /**
41
41
  * Element (or the id of an element) to append this widget's element to. Can be configured, or set once at
42
42
  * runtime. To access the element of a rendered widget, see [element](https://bryntum.com/products/grid/docs/api/Core/widget/Widget#property-element).
43
+ * <div class="note">When creating nested trees of widgets, this should only be used on the outermost widget.
44
+ * [More...](https://bryntum.com/products/grid/docs/api/Grid/widget/GridChartDesigner#config-appendTo)
43
45
  */
44
46
  appendTo ? : HTMLElement|string
45
47
  /**
@@ -73,9 +75,10 @@ export type BryntumGridChartDesignerProps = {
73
75
  catchEventHandlerExceptions ? : boolean
74
76
  /**
75
77
  * *Only valid if this Widget is [floating](https://bryntum.com/products/grid/docs/api/Core/widget/Widget#config-floating).*
76
- * Set to `true` to centre the Widget in browser viewport space.
78
+ * [More...](https://bryntum.com/products/grid/docs/api/Grid/widget/GridChartDesigner#config-centered)
79
+ * @property {boolean} [once] If `true`, the Widget will be centred on its first show, but if it is moved at runtime, it will opt out of centering for future shows.
77
80
  */
78
- centered ? : boolean
81
+ centered ? : boolean|object
79
82
  /**
80
83
  * Custom CSS classes to add to element.
81
84
  * May be specified as a space separated string, or as an object in which property names
@@ -149,7 +152,7 @@ export type BryntumGridChartDesignerProps = {
149
152
  dock ? : 'top'|'bottom'|'left'|'right'|'start'|'end'|'header'|'pre-header'|object
150
153
  /**
151
154
  * *Only valid if this Widget is [floating](https://bryntum.com/products/grid/docs/api/Core/widget/Widget#config-floating).*
152
- * Set to `true` to be able to drag a widget freely on the page. Or set to an object with a ´handleSelector´
155
+ * Set to `true` to be able to drag a widget freely on the page. Or set to an object with a `handleSelector`
153
156
  * property which controls when a drag should start.
154
157
  * [More...](https://bryntum.com/products/grid/docs/api/Grid/widget/GridChartDesigner#config-draggable)
155
158
  * @property {string} handleSelector CSS selector used to determine if drag can be started from a mouse-downed element inside the widget
@@ -217,10 +220,14 @@ export type BryntumGridChartDesignerProps = {
217
220
  ignoreParentReadOnly ? : boolean
218
221
  /**
219
222
  * Element (or element id) to insert this widget before. If provided, [appendTo](https://bryntum.com/products/grid/docs/api/Core/widget/Widget#config-appendTo) config is ignored.
223
+ * <div class="note">When creating nested trees of widgets, this should only be used on the outermost widget.
224
+ * [More...](https://bryntum.com/products/grid/docs/api/Grid/widget/GridChartDesigner#config-insertBefore)
220
225
  */
221
226
  insertBefore ? : HTMLElement|string
222
227
  /**
223
228
  * Element (or element id) to append this widget element to, as a first child. If provided, [appendTo](https://bryntum.com/products/grid/docs/api/Core/widget/Widget#config-appendTo) config is ignored.
229
+ * <div class="note">When creating nested trees of widgets, this should only be used on the outermost widget.
230
+ * [More...](https://bryntum.com/products/grid/docs/api/Grid/widget/GridChartDesigner#config-insertFirst)
224
231
  */
225
232
  insertFirst ? : HTMLElement|string
226
233
  /**
@@ -358,7 +365,7 @@ export type BryntumGridChartDesignerProps = {
358
365
  scrollable ? : boolean|ScrollerConfig|Scroller
359
366
  /**
360
367
  * Defines what to do if document is scrolled while Widget is visible (only relevant when floating is set to `true`).
361
- * Valid values: ´null´: do nothing, ´hide´: hide the widget or ´realign´: realign to the target if possible.
368
+ * Valid values: `null`: do nothing, `hide`: hide the widget or `realign`: realign to the target if possible.
362
369
  */
363
370
  scrollAction ? : 'hide'|'realign'|null
364
371
  /**
@@ -555,7 +562,6 @@ export class BryntumGridChartDesignerComponent implements OnInit, OnDestroy {
555
562
  'ariaDescription',
556
563
  'ariaLabel',
557
564
  'bubbleEvents',
558
- 'centered',
559
565
  'color',
560
566
  'config',
561
567
  'constrainTo',
@@ -602,6 +608,7 @@ export class BryntumGridChartDesignerComponent implements OnInit, OnDestroy {
602
608
  'appendTo',
603
609
  'callOnFunctions',
604
610
  'catchEventHandlerExceptions',
611
+ 'centered',
605
612
  'cls',
606
613
  'column',
607
614
  'content',
@@ -656,7 +663,6 @@ export class BryntumGridChartDesignerComponent implements OnInit, OnDestroy {
656
663
  @Input() ariaDescription ! : string;
657
664
  @Input() ariaLabel ! : string;
658
665
  @Input() bubbleEvents ! : object;
659
- @Input() centered ! : boolean;
660
666
  @Input() color ! : Color;
661
667
  @Input() config ! : object;
662
668
  @Input() constrainTo ! : HTMLElement|Widget|Rectangle;
@@ -702,6 +708,9 @@ export class BryntumGridChartDesignerComponent implements OnInit, OnDestroy {
702
708
  @Input() appendTo ! : HTMLElement|string;
703
709
  @Input() callOnFunctions ! : boolean;
704
710
  @Input() catchEventHandlerExceptions ! : boolean;
711
+ @Input() centered ! : boolean|{
712
+ once?: boolean
713
+ }|boolean|object;
705
714
  @Input() cls ! : string|object;
706
715
  @Input() column ! : number;
707
716
  @Input() content ! : string;
@@ -50,6 +50,8 @@ export type BryntumGridFieldFilterPickerGroupProps = {
50
50
  /**
51
51
  * Element (or the id of an element) to append this widget's element to. Can be configured, or set once at
52
52
  * runtime. To access the element of a rendered widget, see [element](https://bryntum.com/products/grid/docs/api/Core/widget/Widget#property-element).
53
+ * <div class="note">When creating nested trees of widgets, this should only be used on the outermost widget.
54
+ * [More...](https://bryntum.com/products/grid/docs/api/Grid/widget/GridFieldFilterPickerGroup#config-appendTo)
53
55
  */
54
56
  appendTo ? : HTMLElement|string
55
57
  /**
@@ -107,9 +109,10 @@ export type BryntumGridFieldFilterPickerGroupProps = {
107
109
  catchEventHandlerExceptions ? : boolean
108
110
  /**
109
111
  * *Only valid if this Widget is [floating](https://bryntum.com/products/grid/docs/api/Core/widget/Widget#config-floating).*
110
- * Set to `true` to centre the Widget in browser viewport space.
112
+ * [More...](https://bryntum.com/products/grid/docs/api/Grid/widget/GridFieldFilterPickerGroup#config-centered)
113
+ * @property {boolean} [once] If `true`, the Widget will be centred on its first show, but if it is moved at runtime, it will opt out of centering for future shows.
111
114
  */
112
- centered ? : boolean
115
+ centered ? : boolean|object
113
116
  /**
114
117
  * Custom CSS classes to add to element.
115
118
  * May be specified as a space separated string, or as an object in which property names
@@ -198,7 +201,7 @@ export type BryntumGridFieldFilterPickerGroupProps = {
198
201
  dock ? : 'top'|'bottom'|'left'|'right'|'start'|'end'|'header'|'pre-header'|object
199
202
  /**
200
203
  * *Only valid if this Widget is [floating](https://bryntum.com/products/grid/docs/api/Core/widget/Widget#config-floating).*
201
- * Set to `true` to be able to drag a widget freely on the page. Or set to an object with a ´handleSelector´
204
+ * Set to `true` to be able to drag a widget freely on the page. Or set to an object with a `handleSelector`
202
205
  * property which controls when a drag should start.
203
206
  * [More...](https://bryntum.com/products/grid/docs/api/Grid/widget/GridFieldFilterPickerGroup#config-draggable)
204
207
  * @property {string} handleSelector CSS selector used to determine if drag can be started from a mouse-downed element inside the widget
@@ -298,10 +301,14 @@ export type BryntumGridFieldFilterPickerGroupProps = {
298
301
  inputFieldAlign ? : 'start'|'end'
299
302
  /**
300
303
  * Element (or element id) to insert this widget before. If provided, [appendTo](https://bryntum.com/products/grid/docs/api/Core/widget/Widget#config-appendTo) config is ignored.
304
+ * <div class="note">When creating nested trees of widgets, this should only be used on the outermost widget.
305
+ * [More...](https://bryntum.com/products/grid/docs/api/Grid/widget/GridFieldFilterPickerGroup#config-insertBefore)
301
306
  */
302
307
  insertBefore ? : HTMLElement|string
303
308
  /**
304
309
  * Element (or element id) to append this widget element to, as a first child. If provided, [appendTo](https://bryntum.com/products/grid/docs/api/Core/widget/Widget#config-appendTo) config is ignored.
310
+ * <div class="note">When creating nested trees of widgets, this should only be used on the outermost widget.
311
+ * [More...](https://bryntum.com/products/grid/docs/api/Grid/widget/GridFieldFilterPickerGroup#config-insertFirst)
305
312
  */
306
313
  insertFirst ? : HTMLElement|string
307
314
  /**
@@ -327,7 +334,7 @@ export type BryntumGridFieldFilterPickerGroupProps = {
327
334
  */
328
335
  labelPosition ? : 'before'|'above'|'align-before'|'auto'|null
329
336
  /**
330
- * Sets `labelWidth´ for all children of this Container, that does not define their own `labelWidth`.
337
+ * Sets `labelWidth` for all children of this Container, that do not define their own `labelWidth`.
331
338
  * [More...](https://bryntum.com/products/grid/docs/api/Grid/widget/GridFieldFilterPickerGroup#config-labelWidth)
332
339
  */
333
340
  labelWidth ? : number|null
@@ -504,7 +511,7 @@ export type BryntumGridFieldFilterPickerGroupProps = {
504
511
  scrollable ? : boolean|ScrollerConfig|Scroller
505
512
  /**
506
513
  * Defines what to do if document is scrolled while Widget is visible (only relevant when floating is set to `true`).
507
- * Valid values: ´null´: do nothing, ´hide´: hide the widget or ´realign´: realign to the target if possible.
514
+ * Valid values: `null`: do nothing, `hide`: hide the widget or `realign`: realign to the target if possible.
508
515
  */
509
516
  scrollAction ? : 'hide'|'realign'|null
510
517
  /**
@@ -762,7 +769,6 @@ export class BryntumGridFieldFilterPickerGroupComponent implements OnInit, OnDes
762
769
  'bubbleEvents',
763
770
  'canDeleteFilter',
764
771
  'canManageFilter',
765
- 'centered',
766
772
  'color',
767
773
  'config',
768
774
  'constrainTo',
@@ -823,6 +829,7 @@ export class BryntumGridFieldFilterPickerGroupComponent implements OnInit, OnDes
823
829
  'appendTo',
824
830
  'callOnFunctions',
825
831
  'catchEventHandlerExceptions',
832
+ 'centered',
826
833
  'cls',
827
834
  'column',
828
835
  'content',
@@ -894,7 +901,6 @@ export class BryntumGridFieldFilterPickerGroupComponent implements OnInit, OnDes
894
901
  @Input() bubbleEvents ! : object;
895
902
  @Input() canDeleteFilter ! : (filter: any) => boolean;
896
903
  @Input() canManageFilter ! : (filter: any) => boolean;
897
- @Input() centered ! : boolean;
898
904
  @Input() color ! : Color;
899
905
  @Input() config ! : object;
900
906
  @Input() constrainTo ! : HTMLElement|Widget|Rectangle;
@@ -954,6 +960,9 @@ export class BryntumGridFieldFilterPickerGroupComponent implements OnInit, OnDes
954
960
  @Input() appendTo ! : HTMLElement|string;
955
961
  @Input() callOnFunctions ! : boolean;
956
962
  @Input() catchEventHandlerExceptions ! : boolean;
963
+ @Input() centered ! : boolean|{
964
+ once?: boolean
965
+ }|boolean|object;
957
966
  @Input() cls ! : string|object;
958
967
  @Input() column ! : number;
959
968
  @Input() content ! : string;
@@ -47,6 +47,8 @@ export type BryntumGridFieldFilterPickerProps = {
47
47
  /**
48
48
  * Element (or the id of an element) to append this widget's element to. Can be configured, or set once at
49
49
  * runtime. To access the element of a rendered widget, see [element](https://bryntum.com/products/grid/docs/api/Core/widget/Widget#property-element).
50
+ * <div class="note">When creating nested trees of widgets, this should only be used on the outermost widget.
51
+ * [More...](https://bryntum.com/products/grid/docs/api/Grid/widget/GridFieldFilterPicker#config-appendTo)
50
52
  */
51
53
  appendTo ? : HTMLElement|string
52
54
  /**
@@ -88,9 +90,10 @@ export type BryntumGridFieldFilterPickerProps = {
88
90
  catchEventHandlerExceptions ? : boolean
89
91
  /**
90
92
  * *Only valid if this Widget is [floating](https://bryntum.com/products/grid/docs/api/Core/widget/Widget#config-floating).*
91
- * Set to `true` to centre the Widget in browser viewport space.
93
+ * [More...](https://bryntum.com/products/grid/docs/api/Grid/widget/GridFieldFilterPicker#config-centered)
94
+ * @property {boolean} [once] If `true`, the Widget will be centred on its first show, but if it is moved at runtime, it will opt out of centering for future shows.
92
95
  */
93
- centered ? : boolean
96
+ centered ? : boolean|object
94
97
  /**
95
98
  * Custom CSS classes to add to element.
96
99
  * May be specified as a space separated string, or as an object in which property names
@@ -179,7 +182,7 @@ export type BryntumGridFieldFilterPickerProps = {
179
182
  dock ? : 'top'|'bottom'|'left'|'right'|'start'|'end'|'header'|'pre-header'|object
180
183
  /**
181
184
  * *Only valid if this Widget is [floating](https://bryntum.com/products/grid/docs/api/Core/widget/Widget#config-floating).*
182
- * Set to `true` to be able to drag a widget freely on the page. Or set to an object with a ´handleSelector´
185
+ * Set to `true` to be able to drag a widget freely on the page. Or set to an object with a `handleSelector`
183
186
  * property which controls when a drag should start.
184
187
  * [More...](https://bryntum.com/products/grid/docs/api/Grid/widget/GridFieldFilterPicker#config-draggable)
185
188
  * @property {string} handleSelector CSS selector used to determine if drag can be started from a mouse-downed element inside the widget
@@ -283,10 +286,14 @@ export type BryntumGridFieldFilterPickerProps = {
283
286
  inputFieldAlign ? : 'start'|'end'
284
287
  /**
285
288
  * Element (or element id) to insert this widget before. If provided, [appendTo](https://bryntum.com/products/grid/docs/api/Core/widget/Widget#config-appendTo) config is ignored.
289
+ * <div class="note">When creating nested trees of widgets, this should only be used on the outermost widget.
290
+ * [More...](https://bryntum.com/products/grid/docs/api/Grid/widget/GridFieldFilterPicker#config-insertBefore)
286
291
  */
287
292
  insertBefore ? : HTMLElement|string
288
293
  /**
289
294
  * Element (or element id) to append this widget element to, as a first child. If provided, [appendTo](https://bryntum.com/products/grid/docs/api/Core/widget/Widget#config-appendTo) config is ignored.
295
+ * <div class="note">When creating nested trees of widgets, this should only be used on the outermost widget.
296
+ * [More...](https://bryntum.com/products/grid/docs/api/Grid/widget/GridFieldFilterPicker#config-insertFirst)
290
297
  */
291
298
  insertFirst ? : HTMLElement|string
292
299
  /**
@@ -312,7 +319,7 @@ export type BryntumGridFieldFilterPickerProps = {
312
319
  */
313
320
  labelPosition ? : 'before'|'above'|'align-before'|'auto'|null
314
321
  /**
315
- * Sets `labelWidth´ for all children of this Container, that does not define their own `labelWidth`.
322
+ * Sets `labelWidth` for all children of this Container, that do not define their own `labelWidth`.
316
323
  * [More...](https://bryntum.com/products/grid/docs/api/Grid/widget/GridFieldFilterPicker#config-labelWidth)
317
324
  */
318
325
  labelWidth ? : number|null
@@ -494,7 +501,7 @@ export type BryntumGridFieldFilterPickerProps = {
494
501
  scrollable ? : boolean|ScrollerConfig|Scroller
495
502
  /**
496
503
  * Defines what to do if document is scrolled while Widget is visible (only relevant when floating is set to `true`).
497
- * Valid values: ´null´: do nothing, ´hide´: hide the widget or ´realign´: realign to the target if possible.
504
+ * Valid values: `null`: do nothing, `hide`: hide the widget or `realign`: realign to the target if possible.
498
505
  */
499
506
  scrollAction ? : 'hide'|'realign'|null
500
507
  /**
@@ -753,7 +760,6 @@ export class BryntumGridFieldFilterPickerComponent implements OnInit, OnDestroy
753
760
  'autoUpdateRecord',
754
761
  'border',
755
762
  'bubbleEvents',
756
- 'centered',
757
763
  'color',
758
764
  'config',
759
765
  'constrainTo',
@@ -818,6 +824,7 @@ export class BryntumGridFieldFilterPickerComponent implements OnInit, OnDestroy
818
824
  'appendTo',
819
825
  'callOnFunctions',
820
826
  'catchEventHandlerExceptions',
827
+ 'centered',
821
828
  'cls',
822
829
  'column',
823
830
  'content',
@@ -885,7 +892,6 @@ export class BryntumGridFieldFilterPickerComponent implements OnInit, OnDestroy
885
892
  @Input() autoUpdateRecord ! : boolean;
886
893
  @Input() border ! : boolean;
887
894
  @Input() bubbleEvents ! : object;
888
- @Input() centered ! : boolean;
889
895
  @Input() color ! : Color;
890
896
  @Input() config ! : object;
891
897
  @Input() constrainTo ! : HTMLElement|Widget|Rectangle;
@@ -949,6 +955,9 @@ export class BryntumGridFieldFilterPickerComponent implements OnInit, OnDestroy
949
955
  @Input() appendTo ! : HTMLElement|string;
950
956
  @Input() callOnFunctions ! : boolean;
951
957
  @Input() catchEventHandlerExceptions ! : boolean;
958
+ @Input() centered ! : boolean|{
959
+ once?: boolean
960
+ }|boolean|object;
952
961
  @Input() cls ! : string|object;
953
962
  @Input() column ! : number;
954
963
  @Input() content ! : string;
@@ -48,6 +48,8 @@ export type BryntumGridProps = {
48
48
  /**
49
49
  * Element (or the id of an element) to append this widget's element to. Can be configured, or set once at
50
50
  * runtime. To access the element of a rendered widget, see [element](https://bryntum.com/products/grid/docs/api/Core/widget/Widget#property-element).
51
+ * <div class="note">When creating nested trees of widgets, this should only be used on the outermost widget.
52
+ * [More...](https://bryntum.com/products/grid/docs/api/Grid/view/Grid#config-appendTo)
51
53
  */
52
54
  appendTo ? : HTMLElement|string
53
55
  /**
@@ -359,10 +361,14 @@ export type BryntumGridProps = {
359
361
  inputFieldAlign ? : 'start'|'end'
360
362
  /**
361
363
  * Element (or element id) to insert this widget before. If provided, [appendTo](https://bryntum.com/products/grid/docs/api/Core/widget/Widget#config-appendTo) config is ignored.
364
+ * <div class="note">When creating nested trees of widgets, this should only be used on the outermost widget.
365
+ * [More...](https://bryntum.com/products/grid/docs/api/Grid/view/Grid#config-insertBefore)
362
366
  */
363
367
  insertBefore ? : HTMLElement|string
364
368
  /**
365
369
  * Element (or element id) to append this widget element to, as a first child. If provided, [appendTo](https://bryntum.com/products/grid/docs/api/Core/widget/Widget#config-appendTo) config is ignored.
370
+ * <div class="note">When creating nested trees of widgets, this should only be used on the outermost widget.
371
+ * [More...](https://bryntum.com/products/grid/docs/api/Grid/view/Grid#config-insertFirst)
366
372
  */
367
373
  insertFirst ? : HTMLElement|string
368
374
  /**
@@ -375,7 +381,7 @@ export type BryntumGridProps = {
375
381
  */
376
382
  labelPosition ? : 'before'|'above'|'align-before'|'auto'|null
377
383
  /**
378
- * Sets `labelWidth´ for all children of this Container, that does not define their own `labelWidth`.
384
+ * Sets `labelWidth` for all children of this Container, that do not define their own `labelWidth`.
379
385
  * [More...](https://bryntum.com/products/grid/docs/api/Grid/view/Grid#config-labelWidth)
380
386
  */
381
387
  labelWidth ? : number|null
@@ -1353,6 +1359,7 @@ export class BryntumGridComponent implements OnInit, OnDestroy {
1353
1359
  'callOnFunctions',
1354
1360
  'catchEventHandlerExceptions',
1355
1361
  'cellEllipsis',
1362
+ 'centered',
1356
1363
  'cls',
1357
1364
  'collapsed',
1358
1365
  'column',
@@ -1564,6 +1571,9 @@ export class BryntumGridComponent implements OnInit, OnDestroy {
1564
1571
  @Input() width ! : number|string;
1565
1572
 
1566
1573
  // Properties only
1574
+ @Input() centered ! : boolean|{
1575
+ once?: boolean
1576
+ };
1567
1577
  @Input() originalStore ! : Store;
1568
1578
  @Input() parent ! : Widget;
1569
1579
  @Input() selectedCell ! : GridLocation|GridLocationConfig;