@bryntum/grid-angular-thin 7.1.2 → 7.2.0

package/src/lib/bryntum-tree-grid.component.ts

@@ -7,8 +7,8 @@ import { Component, ElementRef, EventEmitter, Output, Input, SimpleChange, Simpl
 
 import WrapperHelper from './wrapper.helper';
 
-import { AjaxStore, AjaxStoreConfig, Base, Container, DomConfig, FormulaProviderConfig, KeyMapConfig, Mask, MaskConfig, Menu, MenuItem, MenuItemEntry, Model, ModelConfig, PagingToolbarConfig, Panel, PanelCollapserConfig, PanelCollapserOverlayConfig, PanelHeader, ScrollManager, ScrollManagerConfig, Scroller, ScrollerConfig, StateProvider, Store, StoreConfig, TabConfig, Tool, ToolConfig, ToolbarConfig, ToolbarItems, TooltipConfig, Widget } from '@bryntum/core-thin';
-import { AIFilter, AIFilterConfig, CellCopyPaste, CellCopyPasteConfig, CellEdit, CellEditConfig, CellEditorContext, CellMenu, CellMenuConfig, CellTooltip, CellTooltipConfig, Charts, ChartsConfig, Column, ColumnAutoWidth, ColumnAutoWidthConfig, ColumnDragToolbar, ColumnDragToolbarConfig, ColumnPicker, ColumnPickerConfig, ColumnRename, ColumnRenameConfig, ColumnReorder, ColumnReorderConfig, ColumnResize, ColumnResizeConfig, ColumnStore, ColumnStoreConfig, GridContainerItemConfig, EmptyTextDomConfig, ExcelExporter, ExcelExporterConfig, ExportConfig, FileDrop, FileDropConfig, FillHandle, FillHandleConfig, Filter, FilterBar, FilterBarConfig, FilterConfig, Grid, GridBase, GridColumnConfig, GridLocation, GridLocationConfig, GridSelectionMode, GridStateInfo, Group, GroupConfig, GroupSummary, GroupSummaryConfig, HeaderMenu, HeaderMenuConfig, LockRows, LockRowsConfig, MergeCells, MergeCellsConfig, PdfExport, PdfExportConfig, PinColumns, PinColumnsConfig, PreserveScrollOptions, Print, PrintConfig, QuickFind, QuickFindConfig, RecordPositionContext, RegionResize, RegionResizeConfig, ResponsiveLevelConfig, Row, RowCopyPaste, RowCopyPasteConfig, RowEdit, RowEditConfig, RowEditorContext, RowExpander, RowExpanderConfig, RowReorder, RowReorderConfig, RowResize, RowResizeConfig, Search, SearchConfig, Sort, SortConfig, Split, SplitConfig, StickyCells, StickyCellsConfig, Stripe, StripeConfig, SubGrid, SubGridConfig, Summary, SummaryConfig, Tree, TreeConfig, TreeGrid, TreeGridListeners, TreeGroup, TreeGroupConfig, XLSColumn } from '@bryntum/grid-thin';
+import { AjaxStore, AjaxStoreConfig, Base, Color, Container, DomConfig, FormulaProviderConfig, KeyMapConfig, Mask, MaskConfig, Menu, MenuItem, MenuItemEntry, Model, ModelConfig, PagingToolbarConfig, Panel, PanelCollapserConfig, PanelCollapserOverlayConfig, PanelHeader, ScrollManager, ScrollManagerConfig, Scroller, ScrollerConfig, StateProvider, Store, StoreConfig, TabConfig, Tool, ToolConfig, ToolbarConfig, ToolbarItems, TooltipConfig, Widget } from '@bryntum/core-thin';
+import { AI, AIConfig, AIFilter, AIFilterConfig, CellCopyPaste, CellCopyPasteConfig, CellEdit, CellEditConfig, CellEditorContext, CellMenu, CellMenuConfig, CellTooltip, CellTooltipConfig, Charts, ChartsConfig, Column, ColumnAutoWidth, ColumnAutoWidthConfig, ColumnDragToolbar, ColumnDragToolbarConfig, ColumnPicker, ColumnPickerConfig, ColumnRename, ColumnRenameConfig, ColumnReorder, ColumnReorderConfig, ColumnResize, ColumnResizeConfig, ColumnStore, ColumnStoreConfig, GridContainerItemConfig, EmptyTextDomConfig, ExcelExporter, ExcelExporterConfig, ExportConfig, FileDrop, FileDropConfig, FillHandle, FillHandleConfig, Filter, FilterBar, FilterBarConfig, FilterConfig, Grid, GridBase, GridColumnConfig, GridLocation, GridLocationConfig, GridSelectionMode, GridStateInfo, Group, GroupConfig, GroupSummary, GroupSummaryConfig, HeaderMenu, HeaderMenuConfig, LockRows, LockRowsConfig, MergeCells, MergeCellsConfig, PdfExport, PdfExportConfig, PinColumns, PinColumnsConfig, PreserveScrollOptions, Print, PrintConfig, QuickFind, QuickFindConfig, RecordPositionContext, RegionResize, RegionResizeConfig, ResponsiveLevelConfig, Row, RowCopyPaste, RowCopyPasteConfig, RowEdit, RowEditConfig, RowEditorContext, RowExpander, RowExpanderConfig, RowReorder, RowReorderConfig, RowResize, RowResizeConfig, Search, SearchConfig, Sort, SortConfig, Split, SplitConfig, StickyCells, StickyCellsConfig, Stripe, StripeConfig, SubGrid, SubGridConfig, Summary, SummaryConfig, Tree, TreeConfig, TreeGrid, TreeGridListeners, TreeGroup, TreeGroupConfig, XLSColumn } from '@bryntum/grid-thin';
 
 import { StringHelper } from '@bryntum/core-thin';
 
@@ -83,6 +83,10 @@ export type BryntumTreeGridProps = {
      * [View online docs...](https://bryntum.com/products/grid/docs/api/Grid/view/TreeGrid#config-bodyCls)
      */
     bodyCls ? : string|object
+    /**
+     * Set `true` to add a border to this container's element.
+     */
+    border ? : boolean
     /**
      * An object where property names with a truthy value indicate which events should bubble up the ownership
      * hierarchy when triggered.
@@ -134,7 +138,7 @@ export type BryntumTreeGridProps = {
      * ...
      * [View online docs...](https://bryntum.com/products/grid/docs/api/Grid/view/TreeGrid#config-color)
      */
-    color ? : string
+    color ? : Color
     /**
      * Programmatic control over which column to start in when used in a grid layout.
      */
@@ -756,6 +760,15 @@ export type BryntumTreeGridProps = {
     width ? : string|number
 
     // Features
+    /**
+     * This feature provides an AI agent for Grid. It provides a chat panel that allows the user to send messages to the
+     * agent and see the responses. Which allows the user to use natural language to interact with the Grid in different
+     * ways. For example, the user can ask the agent to filter the data, sort it, or select specific records. The agent can
+     * also perform data manipulation operations such as adding, updating, deleting records.
+     * ...
+     * [View online docs...](https://bryntum.com/products/grid/docs/api/Grid/feature/AI)
+     */
+    aiFeature ? : object|boolean|string|AI|AIConfig
     /**
      * AI-powered filter feature for Grid. Allows users to type natural language queries to filter grid data.
      * ...
@@ -1054,6 +1067,7 @@ export class BryntumTreeGridComponent implements OnInit, OnDestroy {
         'onBeforeCellEditStart',
         'onBeforeCellRangeDelete',
         'onBeforeCellRangeEdit',
+        'onBeforeColumnCollapseToggle',
         'onBeforeColumnDragStart',
         'onBeforeColumnDropFinalize',
         'onBeforeColumnResize',
@@ -1094,6 +1108,7 @@ export class BryntumTreeGridComponent implements OnInit, OnDestroy {
         'onCellMouseOver',
         'onCollapse',
         'onCollapseNode',
+        'onColumnCollapseToggle',
         'onColumnDrag',
         'onColumnDragStart',
         'onColumnDrop',
@@ -1168,6 +1183,7 @@ export class BryntumTreeGridComponent implements OnInit, OnDestroy {
     ];
 
     private static bryntumFeatureNames: string[] = [
+        'aiFeature',
         'aiFilterFeature',
         'cellCopyPasteFeature',
         'cellEditFeature',
@@ -1222,6 +1238,7 @@ export class BryntumTreeGridComponent implements OnInit, OnDestroy {
         'autoHeight',
         'bbar',
         'bodyCls',
+        'border',
         'bubbleEvents',
         'callOnFunctions',
         'catchEventHandlerExceptions',
@@ -1343,6 +1360,7 @@ export class BryntumTreeGridComponent implements OnInit, OnDestroy {
         'autoHeight',
         'bbar',
         'bodyCls',
+        'border',
         'bubbleEvents',
         'collapsible',
         'color',
@@ -1497,9 +1515,10 @@ export class BryntumTreeGridComponent implements OnInit, OnDestroy {
     @Input() autoHeight                    ! : boolean;
     @Input() bbar                          ! : (GridContainerItemConfig|string)[]|ToolbarConfig|PagingToolbarConfig|null;
     @Input() bodyCls                       ! : string|object;
+    @Input() border                        ! : boolean;
     @Input() bubbleEvents                  ! : object;
     @Input() collapsible                   ! : boolean|PanelCollapserConfig|PanelCollapserOverlayConfig;
-    @Input() color                         ! : string;
+    @Input() color                         ! : Color;
     @Input() config                        ! : object;
     @Input() contentElementCls             ! : string|object;
     @Input() contextMenuTriggerEvent       ! : 'contextmenu'|'click'|'dblclick';
@@ -1656,6 +1675,7 @@ export class BryntumTreeGridComponent implements OnInit, OnDestroy {
     @Input() tooltip         ! : string|TooltipConfig;
 
     // Features
+    @Input() aiFeature                 ! : object|boolean|string|AI|AIConfig;
     @Input() aiFilterFeature           ! : object|boolean|string|AIFilter|AIFilterConfig;
     @Input() cellCopyPasteFeature      ! : object|boolean|string|CellCopyPaste|CellCopyPasteConfig;
     @Input() cellEditFeature           ! : object|boolean|string|CellEdit|CellEditConfig;
@@ -1737,6 +1757,14 @@ export class BryntumTreeGridComponent implements OnInit, OnDestroy {
      * @param {any} event.value The value being set
      */
     @Output() onBeforeCellRangeEdit: any = new EventEmitter<((event: { record: Model, field: string, value: any }) => Promise<boolean>|boolean|void)|string>();
+    /**
+     * This event is triggered before a parent column is collapsed or expanded.
+     * @param {object} event Event object
+     * @param {Grid.view.GridBase} event.source The grid instance
+     * @param {Grid.column.Column} event.column The column
+     * @param {boolean} event.collapsed `true` if the column is being collapsed, `false` if expanded
+     */
+    @Output() onBeforeColumnCollapseToggle: any = new EventEmitter<((event: { source: GridBase, column: Column, collapsed: boolean }) => void)|string>();
     /**
      * This event is fired prior to starting a column drag gesture. The drag is canceled if a listener returns `false`.
      * @param {object} event Event object
@@ -1847,18 +1875,18 @@ export class BryntumTreeGridComponent implements OnInit, OnDestroy {
     /**
      * Fires before a row is rendered.
      * @param {object} event Event object
-     * @param {Grid.view.Grid} event.source The firing Grid instance.
-     * @param {Grid.row.Row} event.row The row about to be rendered.
-     * @param {Core.data.Model} event.record The record for the row.
-     * @param {number} event.recordIndex The zero-based index of the record.
+     * @param {Grid.view.GridBase} event.source The firing Grid instance
+     * @param {Grid.row.Row} event.row The row about to be rendered
+     * @param {Core.data.Model} event.record The record for the row
+     * @param {number} event.recordIndex The zero-based index of the record
      */
-    @Output() onBeforeRenderRow: any = new EventEmitter<((event: { source: Grid, row: Row, record: Model, recordIndex: number }) => void)|string>();
+    @Output() onBeforeRenderRow: any = new EventEmitter<((event: { source: GridBase, row: Row, record: Model, recordIndex: number }) => void)|string>();
     /**
      * Grid rows are about to be rendered
      * @param {object} event Event object
-     * @param {Grid.view.Grid} event.source This grid.
+     * @param {Grid.view.GridBase} event.source This grid.
      */
-    @Output() onBeforeRenderRows: any = new EventEmitter<((event: { source: Grid }) => void)|string>();
+    @Output() onBeforeRenderRows: any = new EventEmitter<((event: { source: GridBase }) => void)|string>();
     /**
      * This event fires before row collapse is started.
      * ...
@@ -2089,6 +2117,14 @@ export class BryntumTreeGridComponent implements OnInit, OnDestroy {
      * @param {Core.data.Model} event.record The record which has been collapsed.
      */
     @Output() onCollapseNode: any = new EventEmitter<((event: { source: Grid, record: Model }) => void)|string>();
+    /**
+     * This event is triggered after a parent column has been collapsed or expanded.
+     * @param {object} event Event object
+     * @param {Grid.view.GridBase} event.source The Grid instance
+     * @param {Grid.column.Column} event.column The column being toggled
+     * @param {boolean} event.collapsed `true` if the column is now collapsed, `false` if expanded
+     */
+    @Output() onColumnCollapseToggle: any = new EventEmitter<((event: { source: GridBase, column: Column, collapsed: boolean }) => void)|string>();
     /**
      * This event is fired when a column is being dragged, and you can set the `valid` flag on the `context` object
      * to indicate whether the drop position is valid or not.
@@ -2170,14 +2206,14 @@ export class BryntumTreeGridComponent implements OnInit, OnDestroy {
      * ...
      * [View online docs...](https://bryntum.com/products/grid/docs/api/Grid/view/TreeGrid#event-dataChange)
      * @param {object} event Event object
-     * @param {Grid.view.Grid} event.source Owning grid
+     * @param {Grid.view.GridBase} event.source Owning grid
      * @param {Core.data.Store} event.store The originating store
      * @param {'remove','removeAll','add','clearchanges','filter','update','dataset','replace'} event.action Name of action which triggered the change. May be one of:  * `'remove'` * `'removeAll'` * `'add'` * `'clearchanges'` * `'filter'` * `'update'` * `'dataset'` * `'replace'`
      * @param {Core.data.Model} event.record Changed record, for actions that affects exactly one record (`'update'`)
      * @param {Core.data.Model[]} event.records Changed records, passed for all actions except `'removeAll'`
      * @param {object} event.changes Passed for the `'update'` action, info on which record fields changed
      */
-    @Output() onDataChange: any = new EventEmitter<((event: { source: Grid, store: Store, action: 'remove'|'removeAll'|'add'|'clearchanges'|'filter'|'update'|'dataset'|'replace', record: Model, records: Model[], changes: object }) => void)|string>();
+    @Output() onDataChange: any = new EventEmitter<((event: { source: GridBase, store: Store, action: 'remove'|'removeAll'|'add'|'clearchanges'|'filter'|'update'|'dataset'|'replace', record: Model, records: Model[], changes: object }) => void)|string>();
     /**
      * Fires when an object is destroyed.
      * @param {object} event Event object
@@ -2485,18 +2521,18 @@ export class BryntumTreeGridComponent implements OnInit, OnDestroy {
     /**
      * Fires after a row is rendered.
      * @param {object} event Event object
-     * @param {Grid.view.Grid} event.source The firing Grid instance.
-     * @param {Grid.row.Row} event.row The row that has been rendered.
-     * @param {Core.data.Model} event.record The record for the row.
-     * @param {number} event.recordIndex The zero-based index of the record.
+     * @param {Grid.view.GridBase} event.source The firing Grid instance
+     * @param {Grid.row.Row} event.row The row that has been rendered
+     * @param {Core.data.Model} event.record The record for the row
+     * @param {number} event.recordIndex The zero-based index of the record
      */
-    @Output() onRenderRow: any = new EventEmitter<((event: { source: Grid, row: Row, record: Model, recordIndex: number }) => void)|string>();
+    @Output() onRenderRow: any = new EventEmitter<((event: { source: GridBase, row: Row, record: Model, recordIndex: number }) => void)|string>();
     /**
      * Grid rows have been rendered
      * @param {object} event Event object
-     * @param {Grid.view.Grid} event.source This grid.
+     * @param {Grid.view.GridBase} event.source This grid.
      */
-    @Output() onRenderRows: any = new EventEmitter<((event: { source: Grid }) => void)|string>();
+    @Output() onRenderRows: any = new EventEmitter<((event: { source: GridBase }) => void)|string>();
     /**
      * Fired when the encapsulating element of a Widget resizes *only when [monitorResize](https://bryntum.com/products/grid/docs/api/Core/widget/Widget#config-monitorResize) is `true`*.
      * @param {object} event Event object
@@ -2556,10 +2592,10 @@ export class BryntumTreeGridComponent implements OnInit, OnDestroy {
     /**
      * Grid has scrolled vertically
      * @param {object} event Event object
-     * @param {Grid.view.Grid} event.source The firing Grid instance.
+     * @param {Grid.view.GridBase} event.source The firing Grid instance.
      * @param {number} event.scrollTop The vertical scroll position.
      */
-    @Output() onScroll: any = new EventEmitter<((event: { source: Grid, scrollTop: number }) => void)|string>();
+    @Output() onScroll: any = new EventEmitter<((event: { source: GridBase, scrollTop: number }) => void)|string>();
     /**
      * The selection has been changed.
      * @param {object} event Event object
@@ -2647,17 +2683,17 @@ export class BryntumTreeGridComponent implements OnInit, OnDestroy {
     /**
      * Fires after a sub grid is collapsed.
      * @param {object} event Event object
-     * @param {Grid.view.Grid} event.source The firing Grid instance
+     * @param {Grid.view.GridBase} event.source The firing Grid instance
      * @param {Grid.view.SubGrid} event.subGrid The sub grid instance
      */
-    @Output() onSubGridCollapse: any = new EventEmitter<((event: { source: Grid, subGrid: SubGrid }) => void)|string>();
+    @Output() onSubGridCollapse: any = new EventEmitter<((event: { source: GridBase, subGrid: SubGrid }) => void)|string>();
     /**
      * Fires after a sub grid is expanded.
      * @param {object} event Event object
-     * @param {Grid.view.Grid} event.source The firing Grid instance
+     * @param {Grid.view.GridBase} event.source The firing Grid instance
      * @param {Grid.view.SubGrid} event.subGrid The sub grid instance
      */
-    @Output() onSubGridExpand: any = new EventEmitter<((event: { source: Grid, subGrid: SubGrid }) => void)|string>();
+    @Output() onSubGridExpand: any = new EventEmitter<((event: { source: GridBase, subGrid: SubGrid }) => void)|string>();
     /**
      * Fired when one or more groups are expanded or collapsed
      * @param {object} event Event object