@bryntum/schedulerpro-vue-3 7.2.1 → 7.2.2

package/src/components/BryntumTimelineHistogramProps.ts

@@ -877,7 +877,7 @@ export declare type BryntumTimelineHistogramProps = {
     rootElement ? : ShadowRoot|HTMLElement
     /**
      * Row height in pixels. This allows the default height for rows to be controlled. Note that it may be
-     * overriden by specifying a [rowHeight](https://bryntum.com/products/schedulerpro/docs/api/Grid/data/GridRowModel#field-rowHeight) on a per record basis, or from
+     * overridden by specifying a [rowHeight](https://bryntum.com/products/schedulerpro/docs/api/Grid/data/GridRowModel#field-rowHeight) on a per record basis, or from
      * a column [renderer](https://bryntum.com/products/schedulerpro/docs/api/Grid/column/Column#config-renderer).
      * ...
      * [View online docs...](https://bryntum.com/products/schedulerpro/docs/api/Scheduler/view/TimelineHistogram#config-rowHeight)
@@ -1251,7 +1251,7 @@ export declare type BryntumTimelineHistogramProps = {
     cellEditFeature ? : object|Boolean|string|GridCellEdit|GridCellEditConfig
     /**
      * Right click to display context menu for cells. To invoke the cell menu in a keyboard-accessible manner, use the
-     * `SPACE` key when the cell is focused.
+     * <kbd>Space</kbd> key when the cell is focused.
      * ...
      * [View online docs...](https://bryntum.com/products/schedulerpro/docs/api/Grid/feature/CellMenu)
      */
@@ -1359,8 +1359,8 @@ export declare type BryntumTimelineHistogramProps = {
     filterBarFeature ? : object|Boolean|string|FilterBar|FilterBarConfig
     /**
      * Enables rendering and handling of row groups. The actual grouping is done in the store, but triggered by
-     * <kbd>shift</kbd> + clicking headers, or by using the context menu, or by using two finger tap (one on header,
-     * one anywhere on grid). Use <kbd>shift</kbd> + <kbd>alt</kbd> + click, or the context menu, to remove a column
+     * <kbd>Shift</kbd> + clicking headers, or by using the context menu, or by using two finger tap (one on header,
+     * one anywhere on grid). Use <kbd>Shift</kbd> + <kbd>Alt</kbd> + click, or the context menu, to remove a column
      * grouper.
      * ...
      * [View online docs...](https://bryntum.com/products/schedulerpro/docs/api/Grid/feature/Group)

package/src/components/BryntumTimelineProps.ts

@@ -413,7 +413,7 @@ export declare type BryntumTimelineProps = {
      */
     emptyText ? : string|EmptyTextDomConfig
     /**
-     * Allow using [Delete] and [Backspace] to remove events/assignments
+     * Allow using <kbd>Delete</kbd> and <kbd>Backspace</kbd> to remove events/assignments
      */
     enableDeleteKey ? : Boolean
     /**
@@ -1591,7 +1591,7 @@ export declare type BryntumTimelineProps = {
     cellEditFeature ? : object|Boolean|string|GridCellEdit|GridCellEditConfig
     /**
      * Right click to display context menu for cells. To invoke the cell menu in a keyboard-accessible manner, use the
-     * `SPACE` key when the cell is focused.
+     * <kbd>Space</kbd> key when the cell is focused.
      * ...
      * [View online docs...](https://bryntum.com/products/schedulerpro/docs/api/Grid/feature/CellMenu)
      */
@@ -1683,8 +1683,8 @@ export declare type BryntumTimelineProps = {
      */
     dependencyMenuFeature ? : object|Boolean|string|DependencyMenu|DependencyMenuConfig
     /**
-     * Allow using <kbd>Ctrl</kbd>/<kbd>CMD</kbd> + <kbd>C</kbd>/<kbd>X</kbd> and <kbd>Ctrl</kbd>/<kbd>CMD</kbd> +
-     * <kbd>V</kbd> to copy/cut and paste events.
+     * Allow using <kbd>Ctrl</kbd>/<kbd>Cmd</kbd>+<kbd>C</kbd>, <kbd>Ctrl</kbd>/<kbd>Cmd</kbd>+<kbd>X</kbd> and
+     * <kbd>Ctrl</kbd>/<kbd>Cmd</kbd>+<kbd>V</kbd> to copy/cut and paste events.
      * ...
      * [View online docs...](https://bryntum.com/products/schedulerpro/docs/api/Scheduler/feature/EventCopyPaste)
      */
@@ -1786,8 +1786,8 @@ export declare type BryntumTimelineProps = {
     filterBarFeature ? : object|Boolean|string|FilterBar|FilterBarConfig
     /**
      * Enables rendering and handling of row groups. The actual grouping is done in the store, but triggered by
-     * <kbd>shift</kbd> + clicking headers, or by using the context menu, or by using two finger tap (one on header,
-     * one anywhere on grid). Use <kbd>shift</kbd> + <kbd>alt</kbd> + click, or the context menu, to remove a column
+     * <kbd>Shift</kbd> + clicking headers, or by using the context menu, or by using two finger tap (one on header,
+     * one anywhere on grid). Use <kbd>Shift</kbd> + <kbd>Alt</kbd> + click, or the context menu, to remove a column
      * grouper.
      * ...
      * [View online docs...](https://bryntum.com/products/schedulerpro/docs/api/Grid/feature/Group)

package/src/components/BryntumTreeCombo.vue

@@ -189,7 +189,7 @@ defineProps<{
     contentElementCls ? : string|object
     /**
      * If configured as `true`, this means that when an unmatched string is typed into the
-     * combo's input field, and `ENTER`, or the [multiValueSeparator](https://bryntum.com/products/schedulerpro/docs/api/Core/widget/Combo#config-multiValueSeparator) is typed,
+     * combo's input field, and <kbd>Enter</kbd>, or the [multiValueSeparator](https://bryntum.com/products/schedulerpro/docs/api/Core/widget/Combo#config-multiValueSeparator) is typed,
      * a new record will be created using the typed string as the [displayField](https://bryntum.com/products/schedulerpro/docs/api/Core/widget/Combo#config-displayField).
      * ...
      * [View online docs...](https://bryntum.com/products/schedulerpro/docs/api/Grid/widget/TreeCombo#config-createOnUnmatched)
@@ -684,7 +684,7 @@ defineProps<{
     required ? : Boolean
     /**
      * If this field is not [readOnly](https://bryntum.com/products/schedulerpro/docs/api/Core/widget/Field#config-readOnly), then setting this option means that pressing
-     * the `ESCAPE` key after editing the field will revert the field to the value it had when
+     * the <kbd>Escape</kbd> key after editing the field will revert the field to the value it had when
      * the user focused the field. If the field is *not* changed from when focused, the [clearable](https://bryntum.com/products/schedulerpro/docs/api/Core/widget/Field#config-clearable)
      * behaviour will be activated.
      */

package/src/components/BryntumTreeComboProps.ts

@@ -175,7 +175,7 @@ export declare type BryntumTreeComboProps = {
     contentElementCls ? : string|object
     /**
      * If configured as `true`, this means that when an unmatched string is typed into the
-     * combo's input field, and `ENTER`, or the [multiValueSeparator](https://bryntum.com/products/schedulerpro/docs/api/Core/widget/Combo#config-multiValueSeparator) is typed,
+     * combo's input field, and <kbd>Enter</kbd>, or the [multiValueSeparator](https://bryntum.com/products/schedulerpro/docs/api/Core/widget/Combo#config-multiValueSeparator) is typed,
      * a new record will be created using the typed string as the [displayField](https://bryntum.com/products/schedulerpro/docs/api/Core/widget/Combo#config-displayField).
      * ...
      * [View online docs...](https://bryntum.com/products/schedulerpro/docs/api/Grid/widget/TreeCombo#config-createOnUnmatched)
@@ -670,7 +670,7 @@ export declare type BryntumTreeComboProps = {
     required ? : Boolean
     /**
      * If this field is not [readOnly](https://bryntum.com/products/schedulerpro/docs/api/Core/widget/Field#config-readOnly), then setting this option means that pressing
-     * the `ESCAPE` key after editing the field will revert the field to the value it had when
+     * the <kbd>Escape</kbd> key after editing the field will revert the field to the value it had when
      * the user focused the field. If the field is *not* changed from when focused, the [clearable](https://bryntum.com/products/schedulerpro/docs/api/Core/widget/Field#config-clearable)
      * behaviour will be activated.
      */

package/src/components/BryntumTreeGrid.vue

@@ -590,7 +590,7 @@ defineProps<{
     rootElement ? : ShadowRoot|HTMLElement
     /**
      * Row height in pixels. This allows the default height for rows to be controlled. Note that it may be
-     * overriden by specifying a [rowHeight](https://bryntum.com/products/schedulerpro/docs/api/Grid/data/GridRowModel#field-rowHeight) on a per record basis, or from
+     * overridden by specifying a [rowHeight](https://bryntum.com/products/schedulerpro/docs/api/Grid/data/GridRowModel#field-rowHeight) on a per record basis, or from
      * a column [renderer](https://bryntum.com/products/schedulerpro/docs/api/Grid/column/Column#config-renderer).
      * ...
      * [View online docs...](https://bryntum.com/products/schedulerpro/docs/api/Grid/view/TreeGrid#config-rowHeight)
@@ -818,7 +818,7 @@ defineProps<{
     cellEditFeature ? : object|Boolean|string|GridCellEdit|GridCellEditConfig
     /**
      * Right click to display context menu for cells. To invoke the cell menu in a keyboard-accessible manner, use the
-     * `SPACE` key when the cell is focused.
+     * <kbd>Space</kbd> key when the cell is focused.
      * ...
      * [View online docs...](https://bryntum.com/products/schedulerpro/docs/api/Grid/feature/CellMenu)
      */
@@ -918,8 +918,8 @@ defineProps<{
     filterBarFeature ? : object|Boolean|string|FilterBar|FilterBarConfig
     /**
      * Enables rendering and handling of row groups. The actual grouping is done in the store, but triggered by
-     * <kbd>shift</kbd> + clicking headers, or by using the context menu, or by using two finger tap (one on header,
-     * one anywhere on grid). Use <kbd>shift</kbd> + <kbd>alt</kbd> + click, or the context menu, to remove a column
+     * <kbd>Shift</kbd> + clicking headers, or by using the context menu, or by using two finger tap (one on header,
+     * one anywhere on grid). Use <kbd>Shift</kbd> + <kbd>Alt</kbd> + click, or the context menu, to remove a column
      * grouper.
      * ...
      * [View online docs...](https://bryntum.com/products/schedulerpro/docs/api/Grid/feature/Group)
@@ -1108,7 +1108,7 @@ const emit = defineEmits<{
      */
     (e: 'beforeCellEditStart', params: ((event: { source: Grid, editorContext: CellEditorContext }) => Promise<boolean>|boolean|void)|string): Promise<boolean>|boolean|void
     /**
-     * Fires on the owning Grid before deleting a range of selected cell values by pressing `Backspace` or `Del`
+     * Fires on the owning Grid before deleting a range of selected cell values by pressing <kbd>Backspace</kbd> or <kbd>Delete</kbd>
      * buttons while [autoEdit](https://bryntum.com/products/schedulerpro/docs/api/Grid/feature/CellEdit#config-autoEdit) is set to `true`. Return `false` to prevent editing.
      * @param {string} e Event name
      * @param {object} params Event parameters
@@ -2044,7 +2044,7 @@ const emit = defineEmits<{
      * @param {Response} params.event.response Optional response, if received
      * @param {Error} params.event.error Optional error, if exception occurred
      */
-    (e: 'pdfExport', params: ((event: { response?: any, error?: Error }) => void)|string): void
+    (e: 'pdfExport', params: ((event: { response?: Response, error?: Error }) => void)|string): void
     /**
      * Fired when a Widget's read only state is toggled
      * @param {string} e Event name
@@ -2305,6 +2305,16 @@ const emit = defineEmits<{
      * @param {Core.widget.Tool} params.event.tool The tool which is being clicked.
      */
     (e: 'toolClick', params: ((event: { source: Tool, tool: Tool }) => void)|string): void
+    /**
+     * Fired on the owning Grid/Scheduler/Gantt after tree grouping levels change
+     * @param {string} e Event name
+     * @param {object} params Event parameters
+     * @param {object} params.event Event object
+     * @param {Grid.view.Grid} params.event.source The grid instance
+     * @param {(string|Function)[]} params.event.groupers Array of field names or functions representing the current grouping levels
+     * @param {(string|Function)[]} params.event.oldGroupers Array of field names or functions representing the previous grouping levels
+     */
+    (e: 'treeGroup', params: ((event: { source: Grid, groupers: (string|Function)[], oldGroupers: (string|Function)[] }) => void)|string): void
     /**
      * Fires when row locking is disabled.
      * @param {string} e Event name
@@ -2597,6 +2607,7 @@ const widgetData = {
         'onToggleGroup',
         'onToggleNode',
         'onToolClick',
+        'onTreeGroup',
         'onUnlockRows',
         'onUnsplit',
         'preserveScroll',
@@ -2746,6 +2757,7 @@ const widgetData = {
         'toggleGroup',
         'toggleNode',
         'toolClick',
+        'treeGroup',
         'unlockRows',
         'unsplit'
     ]

package/src/components/BryntumTreeGridProps.ts

@@ -553,7 +553,7 @@ export declare type BryntumTreeGridProps = {
     rootElement ? : ShadowRoot|HTMLElement
     /**
      * Row height in pixels. This allows the default height for rows to be controlled. Note that it may be
-     * overriden by specifying a [rowHeight](https://bryntum.com/products/schedulerpro/docs/api/Grid/data/GridRowModel#field-rowHeight) on a per record basis, or from
+     * overridden by specifying a [rowHeight](https://bryntum.com/products/schedulerpro/docs/api/Grid/data/GridRowModel#field-rowHeight) on a per record basis, or from
      * a column [renderer](https://bryntum.com/products/schedulerpro/docs/api/Grid/column/Column#config-renderer).
      * ...
      * [View online docs...](https://bryntum.com/products/schedulerpro/docs/api/Grid/view/TreeGrid#config-rowHeight)
@@ -781,7 +781,7 @@ export declare type BryntumTreeGridProps = {
     cellEditFeature ? : object|Boolean|string|GridCellEdit|GridCellEditConfig
     /**
      * Right click to display context menu for cells. To invoke the cell menu in a keyboard-accessible manner, use the
-     * `SPACE` key when the cell is focused.
+     * <kbd>Space</kbd> key when the cell is focused.
      * ...
      * [View online docs...](https://bryntum.com/products/schedulerpro/docs/api/Grid/feature/CellMenu)
      */
@@ -881,8 +881,8 @@ export declare type BryntumTreeGridProps = {
     filterBarFeature ? : object|Boolean|string|FilterBar|FilterBarConfig
     /**
      * Enables rendering and handling of row groups. The actual grouping is done in the store, but triggered by
-     * <kbd>shift</kbd> + clicking headers, or by using the context menu, or by using two finger tap (one on header,
-     * one anywhere on grid). Use <kbd>shift</kbd> + <kbd>alt</kbd> + click, or the context menu, to remove a column
+     * <kbd>Shift</kbd> + clicking headers, or by using the context menu, or by using two finger tap (one on header,
+     * one anywhere on grid). Use <kbd>Shift</kbd> + <kbd>Alt</kbd> + click, or the context menu, to remove a column
      * grouper.
      * ...
      * [View online docs...](https://bryntum.com/products/schedulerpro/docs/api/Grid/feature/Group)

package/src/components/BryntumVersionGrid.vue

@@ -579,7 +579,7 @@ defineProps<{
     rootElement ? : ShadowRoot|HTMLElement
     /**
      * Row height in pixels. This allows the default height for rows to be controlled. Note that it may be
-     * overriden by specifying a [rowHeight](https://bryntum.com/products/schedulerpro/docs/api/Grid/data/GridRowModel#field-rowHeight) on a per record basis, or from
+     * overridden by specifying a [rowHeight](https://bryntum.com/products/schedulerpro/docs/api/Grid/data/GridRowModel#field-rowHeight) on a per record basis, or from
      * a column [renderer](https://bryntum.com/products/schedulerpro/docs/api/Grid/column/Column#config-renderer).
      * ...
      * [View online docs...](https://bryntum.com/products/schedulerpro/docs/api/SchedulerPro/widget/VersionGrid#config-rowHeight)
@@ -819,7 +819,7 @@ defineProps<{
     cellEditFeature ? : object|Boolean|string|GridCellEdit|GridCellEditConfig
     /**
      * Right click to display context menu for cells. To invoke the cell menu in a keyboard-accessible manner, use the
-     * `SPACE` key when the cell is focused.
+     * <kbd>Space</kbd> key when the cell is focused.
      * ...
      * [View online docs...](https://bryntum.com/products/schedulerpro/docs/api/Grid/feature/CellMenu)
      */
@@ -919,8 +919,8 @@ defineProps<{
     filterBarFeature ? : object|Boolean|string|FilterBar|FilterBarConfig
     /**
      * Enables rendering and handling of row groups. The actual grouping is done in the store, but triggered by
-     * <kbd>shift</kbd> + clicking headers, or by using the context menu, or by using two finger tap (one on header,
-     * one anywhere on grid). Use <kbd>shift</kbd> + <kbd>alt</kbd> + click, or the context menu, to remove a column
+     * <kbd>Shift</kbd> + clicking headers, or by using the context menu, or by using two finger tap (one on header,
+     * one anywhere on grid). Use <kbd>Shift</kbd> + <kbd>Alt</kbd> + click, or the context menu, to remove a column
      * grouper.
      * ...
      * [View online docs...](https://bryntum.com/products/schedulerpro/docs/api/Grid/feature/Group)
@@ -1109,7 +1109,7 @@ const emit = defineEmits<{
      */
     (e: 'beforeCellEditStart', params: ((event: { source: Grid, editorContext: CellEditorContext }) => Promise<boolean>|boolean|void)|string): Promise<boolean>|boolean|void
     /**
-     * Fires on the owning Grid before deleting a range of selected cell values by pressing `Backspace` or `Del`
+     * Fires on the owning Grid before deleting a range of selected cell values by pressing <kbd>Backspace</kbd> or <kbd>Delete</kbd>
      * buttons while [autoEdit](https://bryntum.com/products/schedulerpro/docs/api/Grid/feature/CellEdit#config-autoEdit) is set to `true`. Return `false` to prevent editing.
      * @param {string} e Event name
      * @param {object} params Event parameters
@@ -2053,7 +2053,7 @@ const emit = defineEmits<{
      * @param {Response} params.event.response Optional response, if received
      * @param {Error} params.event.error Optional error, if exception occurred
      */
-    (e: 'pdfExport', params: ((event: { response?: any, error?: Error }) => void)|string): void
+    (e: 'pdfExport', params: ((event: { response?: Response, error?: Error }) => void)|string): void
     /**
      * Fired when a Widget's read only state is toggled
      * @param {string} e Event name
@@ -2326,6 +2326,16 @@ const emit = defineEmits<{
      * @param {Core.widget.Tool} params.event.tool The tool which is being clicked.
      */
     (e: 'toolClick', params: ((event: { source: Tool, tool: Tool }) => void)|string): void
+    /**
+     * Fired on the owning Grid/Scheduler/Gantt after tree grouping levels change
+     * @param {string} e Event name
+     * @param {object} params Event parameters
+     * @param {object} params.event Event object
+     * @param {Grid.view.Grid} params.event.source The grid instance
+     * @param {(string|Function)[]} params.event.groupers Array of field names or functions representing the current grouping levels
+     * @param {(string|Function)[]} params.event.oldGroupers Array of field names or functions representing the previous grouping levels
+     */
+    (e: 'treeGroup', params: ((event: { source: Grid, groupers: (string|Function)[], oldGroupers: (string|Function)[] }) => void)|string): void
     /**
      * Fires when row locking is disabled.
      * @param {string} e Event name
@@ -2575,6 +2585,7 @@ const widgetData = {
         'onToggleGroup',
         'onToggleNode',
         'onToolClick',
+        'onTreeGroup',
         'onUnlockRows',
         'onUnsplit',
         'preserveScroll',
@@ -2730,6 +2741,7 @@ const widgetData = {
         'toggleGroup',
         'toggleNode',
         'toolClick',
+        'treeGroup',
         'unlockRows',
         'unsplit'
     ]

package/src/components/BryntumVersionGridProps.ts

@@ -565,7 +565,7 @@ export declare type BryntumVersionGridProps = {
     rootElement ? : ShadowRoot|HTMLElement
     /**
      * Row height in pixels. This allows the default height for rows to be controlled. Note that it may be
-     * overriden by specifying a [rowHeight](https://bryntum.com/products/schedulerpro/docs/api/Grid/data/GridRowModel#field-rowHeight) on a per record basis, or from
+     * overridden by specifying a [rowHeight](https://bryntum.com/products/schedulerpro/docs/api/Grid/data/GridRowModel#field-rowHeight) on a per record basis, or from
      * a column [renderer](https://bryntum.com/products/schedulerpro/docs/api/Grid/column/Column#config-renderer).
      * ...
      * [View online docs...](https://bryntum.com/products/schedulerpro/docs/api/SchedulerPro/widget/VersionGrid#config-rowHeight)
@@ -805,7 +805,7 @@ export declare type BryntumVersionGridProps = {
     cellEditFeature ? : object|Boolean|string|GridCellEdit|GridCellEditConfig
     /**
      * Right click to display context menu for cells. To invoke the cell menu in a keyboard-accessible manner, use the
-     * `SPACE` key when the cell is focused.
+     * <kbd>Space</kbd> key when the cell is focused.
      * ...
      * [View online docs...](https://bryntum.com/products/schedulerpro/docs/api/Grid/feature/CellMenu)
      */
@@ -905,8 +905,8 @@ export declare type BryntumVersionGridProps = {
     filterBarFeature ? : object|Boolean|string|FilterBar|FilterBarConfig
     /**
      * Enables rendering and handling of row groups. The actual grouping is done in the store, but triggered by
-     * <kbd>shift</kbd> + clicking headers, or by using the context menu, or by using two finger tap (one on header,
-     * one anywhere on grid). Use <kbd>shift</kbd> + <kbd>alt</kbd> + click, or the context menu, to remove a column
+     * <kbd>Shift</kbd> + clicking headers, or by using the context menu, or by using two finger tap (one on header,
+     * one anywhere on grid). Use <kbd>Shift</kbd> + <kbd>Alt</kbd> + click, or the context menu, to remove a column
      * grouper.
      * ...
      * [View online docs...](https://bryntum.com/products/schedulerpro/docs/api/Grid/feature/Group)