@bryntum/grid-trial 7.3.1 → 7.3.2

package/grid.thin.d.ts

@@ -16031,6 +16031,8 @@ type CellTooltipConfig = {
     /**
      * Element (or the id of an element) to append this widget's element to. Can be configured, or set once at
      * runtime. To access the element of a rendered widget, see [element](https://bryntum.com/products/grid/docs/api/Core/widget/Widget#property-element).
+     * <div class="note">When creating nested trees of widgets, this should only be used on the outermost widget.
+     * [More...](https://bryntum.com/products/grid/docs/api/Grid/feature/CellTooltip#config-appendTo)
      */
     appendTo?: HTMLElement|string
     /**
@@ -16292,10 +16294,11 @@ type CellTooltipConfig = {
      * @param {Core.widget.Tooltip} context.tip The tooltip instance
      * @param {HTMLElement} context.element The Element for which the Tooltip is monitoring mouse movement
      * @param {HTMLElement} context.activeTarget The target element that triggered the show
+     * @param {HTMLElement} [context.forElement] Alias for `activeTarget`, provided for backward compatibility
      * @param {Event} context.event The raw DOM event
      * @returns {string,Promise<any>}
      */
-    getHtml?: ((context: { tip: Tooltip, element: HTMLElement, activeTarget: HTMLElement, event: Event }) => Promise<string|Promise<any>>)|string
+    getHtml?: ((context: { tip: Tooltip, element: HTMLElement, activeTarget: HTMLElement, forElement?: HTMLElement, event: Event }) => Promise<string|Promise<any>>)|string
     /**
      * A config [object](https://bryntum.com/products/grid/docs/api/Core/widget/Panel#typedef-PanelHeader) for the panel's header or a string in place of a `title`.
      * [More...](https://bryntum.com/products/grid/docs/api/Grid/feature/CellTooltip#config-header)
@@ -16371,10 +16374,14 @@ type CellTooltipConfig = {
     inputFieldAlign?: 'start'|'end'
     /**
      * 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.
+     * <div class="note">When creating nested trees of widgets, this should only be used on the outermost widget.
+     * [More...](https://bryntum.com/products/grid/docs/api/Grid/feature/CellTooltip#config-insertBefore)
      */
     insertBefore?: HTMLElement|string
     /**
      * 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.
+     * <div class="note">When creating nested trees of widgets, this should only be used on the outermost widget.
+     * [More...](https://bryntum.com/products/grid/docs/api/Grid/feature/CellTooltip#config-insertFirst)
      */
     insertFirst?: HTMLElement|string
     /**
@@ -30553,6 +30560,8 @@ type GridConfig = {
     /**
      * Element (or the id of an element) to append this widget's element to. Can be configured, or set once at
      * runtime. To access the element of a rendered widget, see [element](https://bryntum.com/products/grid/docs/api/Core/widget/Widget#property-element).
+     * <div class="note">When creating nested trees of widgets, this should only be used on the outermost widget.
+     * [More...](https://bryntum.com/products/grid/docs/api/Grid/view/Grid#config-appendTo)
      */
     appendTo?: HTMLElement|string
     /**
@@ -30867,10 +30876,14 @@ type GridConfig = {
     inputFieldAlign?: 'start'|'end'
     /**
      * 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.
+     * <div class="note">When creating nested trees of widgets, this should only be used on the outermost widget.
+     * [More...](https://bryntum.com/products/grid/docs/api/Grid/view/Grid#config-insertBefore)
      */
     insertBefore?: HTMLElement|string
     /**
      * 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.
+     * <div class="note">When creating nested trees of widgets, this should only be used on the outermost widget.
+     * [More...](https://bryntum.com/products/grid/docs/api/Grid/view/Grid#config-insertFirst)
      */
     insertFirst?: HTMLElement|string
     /**
@@ -34608,6 +34621,8 @@ type GridBaseConfig = {
     /**
      * Element (or the id of an element) to append this widget's element to. Can be configured, or set once at
      * runtime. To access the element of a rendered widget, see [element](https://bryntum.com/products/grid/docs/api/Core/widget/Widget#property-element).
+     * <div class="note">When creating nested trees of widgets, this should only be used on the outermost widget.
+     * [More...](https://bryntum.com/products/grid/docs/api/Grid/view/GridBase#config-appendTo)
      */
     appendTo?: HTMLElement|string
     /**
@@ -34922,10 +34937,14 @@ type GridBaseConfig = {
     inputFieldAlign?: 'start'|'end'
     /**
      * 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.
+     * <div class="note">When creating nested trees of widgets, this should only be used on the outermost widget.
+     * [More...](https://bryntum.com/products/grid/docs/api/Grid/view/GridBase#config-insertBefore)
      */
     insertBefore?: HTMLElement|string
     /**
      * 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.
+     * <div class="note">When creating nested trees of widgets, this should only be used on the outermost widget.
+     * [More...](https://bryntum.com/products/grid/docs/api/Grid/view/GridBase#config-insertFirst)
      */
     insertFirst?: HTMLElement|string
     /**
@@ -41080,6 +41099,8 @@ type TreeGridConfig = {
     /**
      * Element (or the id of an element) to append this widget's element to. Can be configured, or set once at
      * runtime. To access the element of a rendered widget, see [element](https://bryntum.com/products/grid/docs/api/Core/widget/Widget#property-element).
+     * <div class="note">When creating nested trees of widgets, this should only be used on the outermost widget.
+     * [More...](https://bryntum.com/products/grid/docs/api/Grid/view/TreeGrid#config-appendTo)
      */
     appendTo?: HTMLElement|string
     /**
@@ -41394,10 +41415,14 @@ type TreeGridConfig = {
     inputFieldAlign?: 'start'|'end'
     /**
      * 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.
+     * <div class="note">When creating nested trees of widgets, this should only be used on the outermost widget.
+     * [More...](https://bryntum.com/products/grid/docs/api/Grid/view/TreeGrid#config-insertBefore)
      */
     insertBefore?: HTMLElement|string
     /**
      * 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.
+     * <div class="note">When creating nested trees of widgets, this should only be used on the outermost widget.
+     * [More...](https://bryntum.com/products/grid/docs/api/Grid/view/TreeGrid#config-insertFirst)
      */
     insertFirst?: HTMLElement|string
     /**
@@ -43391,6 +43416,8 @@ type ExportDialogConfig = {
     /**
      * Element (or the id of an element) to append this widget's element to. Can be configured, or set once at
      * runtime. To access the element of a rendered widget, see [element](https://bryntum.com/products/grid/docs/api/Core/widget/Widget#property-element).
+     * <div class="note">When creating nested trees of widgets, this should only be used on the outermost widget.
+     * [More...](https://bryntum.com/products/grid/docs/api/Grid/view/export/ExportDialog#config-appendTo)
      */
     appendTo?: HTMLElement|string
     /**
@@ -43692,10 +43719,14 @@ type ExportDialogConfig = {
     inputFieldAlign?: 'start'|'end'
     /**
      * 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.
+     * <div class="note">When creating nested trees of widgets, this should only be used on the outermost widget.
+     * [More...](https://bryntum.com/products/grid/docs/api/Grid/view/export/ExportDialog#config-insertBefore)
      */
     insertBefore?: HTMLElement|string
     /**
      * 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.
+     * <div class="note">When creating nested trees of widgets, this should only be used on the outermost widget.
+     * [More...](https://bryntum.com/products/grid/docs/api/Grid/view/export/ExportDialog#config-insertFirst)
      */
     insertFirst?: HTMLElement|string
     /**
@@ -45390,6 +45421,8 @@ type AIFilterFieldConfig = {
     /**
      * Element (or the id of an element) to append this widget's element to. Can be configured, or set once at
      * runtime. To access the element of a rendered widget, see [element](https://bryntum.com/products/grid/docs/api/Core/widget/Widget#property-element).
+     * <div class="note">When creating nested trees of widgets, this should only be used on the outermost widget.
+     * [More...](https://bryntum.com/products/grid/docs/api/Grid/widget/AIFilterField#config-appendTo)
      */
     appendTo?: HTMLElement|string
     /**
@@ -45654,10 +45687,14 @@ type AIFilterFieldConfig = {
     inputWidth?: string|number
     /**
      * 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.
+     * <div class="note">When creating nested trees of widgets, this should only be used on the outermost widget.
+     * [More...](https://bryntum.com/products/grid/docs/api/Grid/widget/AIFilterField#config-insertBefore)
      */
     insertBefore?: HTMLElement|string
     /**
      * 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.
+     * <div class="note">When creating nested trees of widgets, this should only be used on the outermost widget.
+     * [More...](https://bryntum.com/products/grid/docs/api/Grid/widget/AIFilterField#config-insertFirst)
      */
     insertFirst?: HTMLElement|string
     /**
@@ -46536,6 +46573,8 @@ type ChecklistFilterComboConfig = {
     /**
      * Element (or the id of an element) to append this widget's element to. Can be configured, or set once at
      * runtime. To access the element of a rendered widget, see [element](https://bryntum.com/products/grid/docs/api/Core/widget/Widget#property-element).
+     * <div class="note">When creating nested trees of widgets, this should only be used on the outermost widget.
+     * [More...](https://bryntum.com/products/grid/docs/api/Grid/widget/ChecklistFilterCombo#config-appendTo)
      */
     appendTo?: HTMLElement|string
     /**
@@ -46898,10 +46937,14 @@ type ChecklistFilterComboConfig = {
     inputWidth?: string|number
     /**
      * 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.
+     * <div class="note">When creating nested trees of widgets, this should only be used on the outermost widget.
+     * [More...](https://bryntum.com/products/grid/docs/api/Grid/widget/ChecklistFilterCombo#config-insertBefore)
      */
     insertBefore?: HTMLElement|string
     /**
      * 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.
+     * <div class="note">When creating nested trees of widgets, this should only be used on the outermost widget.
+     * [More...](https://bryntum.com/products/grid/docs/api/Grid/widget/ChecklistFilterCombo#config-insertFirst)
      */
     insertFirst?: HTMLElement|string
     /**
@@ -47778,6 +47821,8 @@ type GridChartDesignerConfig = {
     /**
      * Element (or the id of an element) to append this widget's element to. Can be configured, or set once at
      * runtime. To access the element of a rendered widget, see [element](https://bryntum.com/products/grid/docs/api/Core/widget/Widget#property-element).
+     * <div class="note">When creating nested trees of widgets, this should only be used on the outermost widget.
+     * [More...](https://bryntum.com/products/grid/docs/api/Grid/widget/GridChartDesigner#config-appendTo)
      */
     appendTo?: HTMLElement|string
     /**
@@ -47953,10 +47998,14 @@ type GridChartDesignerConfig = {
     ignoreParentReadOnly?: boolean
     /**
      * 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.
+     * <div class="note">When creating nested trees of widgets, this should only be used on the outermost widget.
+     * [More...](https://bryntum.com/products/grid/docs/api/Grid/widget/GridChartDesigner#config-insertBefore)
      */
     insertBefore?: HTMLElement|string
     /**
      * 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.
+     * <div class="note">When creating nested trees of widgets, this should only be used on the outermost widget.
+     * [More...](https://bryntum.com/products/grid/docs/api/Grid/widget/GridChartDesigner#config-insertFirst)
      */
     insertFirst?: HTMLElement|string
     /**
@@ -48639,6 +48688,8 @@ type GridFieldFilterPickerConfig = {
     /**
      * Element (or the id of an element) to append this widget's element to. Can be configured, or set once at
      * runtime. To access the element of a rendered widget, see [element](https://bryntum.com/products/grid/docs/api/Core/widget/Widget#property-element).
+     * <div class="note">When creating nested trees of widgets, this should only be used on the outermost widget.
+     * [More...](https://bryntum.com/products/grid/docs/api/Grid/widget/GridFieldFilterPicker#config-appendTo)
      */
     appendTo?: HTMLElement|string
     /**
@@ -48873,10 +48924,14 @@ type GridFieldFilterPickerConfig = {
     inputFieldAlign?: 'start'|'end'
     /**
      * 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.
+     * <div class="note">When creating nested trees of widgets, this should only be used on the outermost widget.
+     * [More...](https://bryntum.com/products/grid/docs/api/Grid/widget/GridFieldFilterPicker#config-insertBefore)
      */
     insertBefore?: HTMLElement|string
     /**
      * 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.
+     * <div class="note">When creating nested trees of widgets, this should only be used on the outermost widget.
+     * [More...](https://bryntum.com/products/grid/docs/api/Grid/widget/GridFieldFilterPicker#config-insertFirst)
      */
     insertFirst?: HTMLElement|string
     /**
@@ -49698,6 +49753,8 @@ type GridFieldFilterPickerGroupConfig = {
     /**
      * Element (or the id of an element) to append this widget's element to. Can be configured, or set once at
      * runtime. To access the element of a rendered widget, see [element](https://bryntum.com/products/grid/docs/api/Core/widget/Widget#property-element).
+     * <div class="note">When creating nested trees of widgets, this should only be used on the outermost widget.
+     * [More...](https://bryntum.com/products/grid/docs/api/Grid/widget/GridFieldFilterPickerGroup#config-appendTo)
      */
     appendTo?: HTMLElement|string
     /**
@@ -49944,10 +50001,14 @@ type GridFieldFilterPickerGroupConfig = {
     inputFieldAlign?: 'start'|'end'
     /**
      * 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.
+     * <div class="note">When creating nested trees of widgets, this should only be used on the outermost widget.
+     * [More...](https://bryntum.com/products/grid/docs/api/Grid/widget/GridFieldFilterPickerGroup#config-insertBefore)
      */
     insertBefore?: HTMLElement|string
     /**
      * 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.
+     * <div class="note">When creating nested trees of widgets, this should only be used on the outermost widget.
+     * [More...](https://bryntum.com/products/grid/docs/api/Grid/widget/GridFieldFilterPickerGroup#config-insertFirst)
      */
     insertFirst?: HTMLElement|string
     /**
@@ -50794,6 +50855,8 @@ type GroupBarConfig = {
     /**
      * Element (or the id of an element) to append this widget's element to. Can be configured, or set once at
      * runtime. To access the element of a rendered widget, see [element](https://bryntum.com/products/grid/docs/api/Core/widget/Widget#property-element).
+     * <div class="note">When creating nested trees of widgets, this should only be used on the outermost widget.
+     * [More...](https://bryntum.com/products/grid/docs/api/Grid/widget/GroupBar#config-appendTo)
      */
     appendTo?: HTMLElement|string
     /**
@@ -50843,9 +50906,11 @@ type GroupBarConfig = {
     /**
      * If [closable](https://bryntum.com/products/grid/docs/api/Core/widget/ChipView#config-closable) is `true`, this is the name of a callback function to handle what the "close"
      * action means. If not provided, the record representing the chip is removed from the store.
+     * @param {Core.data.Model[]} records Records to be closed
+     * @param {object} options Close options
      * @returns {void}
      */
-    closeHandler?: string|(() => void)
+    closeHandler?: string|((records: Model[], options: object) => void)
     /**
      * Custom CSS classes to add to element.
      * May be specified as a space separated string, or as an object in which property names
@@ -51020,10 +51085,14 @@ type GroupBarConfig = {
     ignoreParentReadOnly?: boolean
     /**
      * 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.
+     * <div class="note">When creating nested trees of widgets, this should only be used on the outermost widget.
+     * [More...](https://bryntum.com/products/grid/docs/api/Grid/widget/GroupBar#config-insertBefore)
      */
     insertBefore?: HTMLElement|string
     /**
      * 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.
+     * <div class="note">When creating nested trees of widgets, this should only be used on the outermost widget.
+     * [More...](https://bryntum.com/products/grid/docs/api/Grid/widget/GroupBar#config-insertFirst)
      */
     insertFirst?: HTMLElement|string
     /**
@@ -51853,6 +51922,8 @@ type TreeComboConfig = {
     /**
      * Element (or the id of an element) to append this widget's element to. Can be configured, or set once at
      * runtime. To access the element of a rendered widget, see [element](https://bryntum.com/products/grid/docs/api/Core/widget/Widget#property-element).
+     * <div class="note">When creating nested trees of widgets, this should only be used on the outermost widget.
+     * [More...](https://bryntum.com/products/grid/docs/api/Grid/widget/TreeCombo#config-appendTo)
      */
     appendTo?: HTMLElement|string
     /**
@@ -52215,10 +52286,14 @@ type TreeComboConfig = {
     inputWidth?: string|number
     /**
      * 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.
+     * <div class="note">When creating nested trees of widgets, this should only be used on the outermost widget.
+     * [More...](https://bryntum.com/products/grid/docs/api/Grid/widget/TreeCombo#config-insertBefore)
      */
     insertBefore?: HTMLElement|string
     /**
      * 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.
+     * <div class="note">When creating nested trees of widgets, this should only be used on the outermost widget.
+     * [More...](https://bryntum.com/products/grid/docs/api/Grid/widget/TreeCombo#config-insertFirst)
      */
     insertFirst?: HTMLElement|string
     /**