@bryntum/grid-trial 7.1.2 → 7.2.0
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.
- package/README.md +6 -1
- package/fluent2-dark.css +1 -1
- package/fluent2-light.css +1 -1
- package/grid.css +2 -2
- package/grid.d.ts +5939 -1631
- package/grid.lwc.module.d.ts +1 -1
- package/grid.lwc.module.js +2 -2
- package/grid.module.d.ts +1 -1
- package/grid.module.js +48 -47
- package/grid.thin.d.ts +942 -251
- package/grid.umd.d.ts +1 -1
- package/grid.umd.js +53 -52
- package/grid.wc.module.d.ts +1 -1
- package/grid.wc.module.js +45 -44
- package/high-contrast-dark.css +1 -1
- package/high-contrast-light.css +1 -1
- package/locales/grid.locale.Ar.js +1 -1
- package/locales/grid.locale.Bg.js +1 -1
- package/locales/grid.locale.Ca.js +1 -1
- package/locales/grid.locale.Cs.js +1 -1
- package/locales/grid.locale.Da.js +1 -1
- package/locales/grid.locale.De.js +1 -1
- package/locales/grid.locale.El.js +1 -1
- package/locales/grid.locale.En.js +1 -1
- package/locales/grid.locale.EnGb.js +1 -1
- package/locales/grid.locale.Es.js +1 -1
- package/locales/grid.locale.Et.js +1 -1
- package/locales/grid.locale.Eu.js +1 -1
- package/locales/grid.locale.Fi.js +1 -1
- package/locales/grid.locale.FrFr.js +1 -1
- package/locales/grid.locale.Gl.js +1 -1
- package/locales/grid.locale.He.js +1 -1
- package/locales/grid.locale.Hi.js +1 -1
- package/locales/grid.locale.Hr.js +1 -1
- package/locales/grid.locale.Hu.js +1 -1
- package/locales/grid.locale.Id.js +1 -1
- package/locales/grid.locale.It.js +1 -1
- package/locales/grid.locale.Ja.js +1 -1
- package/locales/grid.locale.Kk.js +1 -1
- package/locales/grid.locale.Ko.js +1 -1
- package/locales/grid.locale.Lt.js +1 -1
- package/locales/grid.locale.Lv.js +1 -1
- package/locales/grid.locale.Ms.js +1 -1
- package/locales/grid.locale.Nl.js +1 -1
- package/locales/grid.locale.No.js +1 -1
- package/locales/grid.locale.Pl.js +1 -1
- package/locales/grid.locale.Pt.js +1 -1
- package/locales/grid.locale.PtBr.js +1 -1
- package/locales/grid.locale.Ro.js +1 -1
- package/locales/grid.locale.Ru.js +1 -1
- package/locales/grid.locale.Sk.js +1 -1
- package/locales/grid.locale.Sl.js +1 -1
- package/locales/grid.locale.Sr.js +1 -1
- package/locales/grid.locale.SrRs.js +1 -1
- package/locales/grid.locale.SvSE.js +1 -1
- package/locales/grid.locale.Th.js +1 -1
- package/locales/grid.locale.Tr.js +1 -1
- package/locales/grid.locale.Uk.js +1 -1
- package/locales/grid.locale.Vi.js +1 -1
- package/locales/grid.locale.ZhCn.js +1 -1
- package/locales/grid.locale.ZhTw.js +1 -1
- package/material3-dark.css +1 -1
- package/material3-light.css +1 -1
- package/package.json +1 -1
- package/stockholm-dark.css +1 -1
- package/stockholm-light.css +1 -1
- package/svalbard-dark.css +1 -1
- package/svalbard-light.css +1 -1
- package/visby-dark.css +1 -1
- package/visby-light.css +1 -1
package/grid.thin.d.ts
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
/*!
|
|
2
2
|
*
|
|
3
|
-
* Bryntum Grid 7.
|
|
3
|
+
* Bryntum Grid 7.2.0 (TRIAL VERSION)
|
|
4
4
|
*
|
|
5
5
|
* Copyright(c) 2026 Bryntum AB
|
|
6
6
|
* https://bryntum.com/contact
|
|
@@ -321,15 +321,16 @@
|
|
|
321
321
|
* OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
|
|
322
322
|
*
|
|
323
323
|
*/
|
|
324
|
-
import { AIBase, AIModelConfiguration,
|
|
325
|
-
|
|
326
|
-
|
|
327
|
-
|
|
328
|
-
|
|
329
|
-
|
|
330
|
-
|
|
331
|
-
|
|
332
|
-
|
|
324
|
+
import { AIBase, AIModelConfiguration, AIModelSelector, AISettingsModel, AISettingsModelConfig, AITool, AIToolConfig,
|
|
325
|
+
AIVoiceActivationConfig, AbstractApiPlugin, AjaxStore, AjaxStoreConfig, AlignSpec, AnimateScrollOptions, Base, BryntumListenerConfig,
|
|
326
|
+
BryntumScrollOptions, ChatButton, ChatButtonConfig, ChipView, ChipViewConfig, Collection, CollectionCompareOperator, CollectionConfig,
|
|
327
|
+
CollectionFilter, CollectionFilterConfig, CollectionSorter, CollectionSorterConfig, Color, ColorDescriptor, Combo, ComboConfig,
|
|
328
|
+
ComboModel, Container, ContextMenuBase, CoreColumn, CoreColumnConfig, CoreContainerItem, CoreContainerItemConfig,
|
|
329
|
+
CoreContainerLayoutConfig, CoreInputFieldConfig, CoreModelFieldConfig, DataField, DataLoadRequestResponse, DomClassList, DomConfig,
|
|
330
|
+
DragHelper, DragHelperConfig, Duration, DurationConfig, Editor, EditorConfig, EventsClass, FetchOptions, Field, FieldContainer,
|
|
331
|
+
FieldContainerConfig, FieldFilterPicker, FieldFilterPickerConfig, FieldFilterPickerGroup, FieldOption, FieldTriggerConfig,
|
|
332
|
+
FormulaProvider, FormulaProviderConfig, Grouper, InstancePlugin, KeyMap, KeyMapConfig, LazyLoadRequestParams, List, ListConfig,
|
|
333
|
+
LocaleHelper, LocaleManager, Mask, MaskConfig, Menu, MenuConfig, MenuItem, MenuItemEntry, Model, NumberFormat, NumberFormatConfig,
|
|
333
334
|
PagingRequestParams, PagingToolbar, PagingToolbarConfig, Panel, PanelCollapser, PanelCollapserConfig, PanelCollapserOverlay,
|
|
334
335
|
PanelCollapserOverlayConfig, PanelConfig, PanelHeader, Popup, PopupConfig, Rectangle, ScrollManager, ScrollManagerConfig, Scroller,
|
|
335
336
|
ScrollerConfig, Sorter, StateProvider, StateTrackingManager, Store, StoreConfig, StoreSearchResult, SyncDataOnLoadOptions, Tab,
|
|
@@ -7215,8 +7216,8 @@ type DateColumnConfig = {
|
|
|
7215
7216
|
*/
|
|
7216
7217
|
remoteChildCount?: number
|
|
7217
7218
|
/**
|
|
7218
|
-
* Renderer function, used to style the date displayed in the cell. Can also affect other aspects of
|
|
7219
|
-
*
|
|
7219
|
+
* Renderer function, used to style the date displayed in the cell. Can also affect other aspects of the cell,
|
|
7220
|
+
* such as styling.
|
|
7220
7221
|
* ...
|
|
7221
7222
|
* [View online docs...](https://bryntum.com/products/grid/docs/api/Grid/column/DateColumn#config-renderer)
|
|
7222
7223
|
* @param {object} renderData Object containing renderer parameters
|
|
@@ -7377,9 +7378,9 @@ type DateColumnConfig = {
|
|
|
7377
7378
|
}
|
|
7378
7379
|
|
|
7379
7380
|
/**
|
|
7380
|
-
* A column that displays a date in the specified [format](https://bryntum.com/products/grid/docs/api/Grid/column/DateColumn#config-format). By default `L` format is used, which
|
|
7381
|
-
*
|
|
7382
|
-
*
|
|
7381
|
+
* A column that displays a date in the specified [format](https://bryntum.com/products/grid/docs/api/Grid/column/DateColumn#config-format). By default `L` format is used, which contains
|
|
7382
|
+
* the following info: full year, 2-digit month, and 2-digit day. Depending on the browser locale, the formatted date
|
|
7383
|
+
* might look different. [Intl.DateTimeFormat API](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Intl/DateTimeFormat/DateTimeFormat)
|
|
7383
7384
|
* is used to format the date. Here is an example of possible outputs depending on the browser locale:
|
|
7384
7385
|
* ...
|
|
7385
7386
|
* [View online docs...](https://bryntum.com/products/grid/docs/api/Grid/column/DateColumn)
|
|
@@ -7413,8 +7414,8 @@ export class DateColumn extends Column {
|
|
|
7413
7414
|
*/
|
|
7414
7415
|
min: string|Date
|
|
7415
7416
|
/**
|
|
7416
|
-
* Renderer function, used to style the date displayed in the cell. Can also affect other aspects of
|
|
7417
|
-
*
|
|
7417
|
+
* Renderer function, used to style the date displayed in the cell. Can also affect other aspects of the cell,
|
|
7418
|
+
* such as styling.
|
|
7418
7419
|
*/
|
|
7419
7420
|
renderer: (renderData: { cellElement: HTMLElement, value: Date|null|undefined, record: Model, column: Column, grid: Grid, row: Row, size: { height: number, configuredHeight: number }, isExport: boolean, isMeasuring: boolean }) => string|DomConfig|DomConfig[]|void
|
|
7420
7421
|
/**
|
|
@@ -13219,6 +13220,10 @@ export class TreeColumn extends Column {
|
|
|
13219
13220
|
* Identifies an object as an instance of [TreeColumn](https://bryntum.com/products/grid/docs/api/Grid/column/TreeColumn) class, or subclass thereof.
|
|
13220
13221
|
*/
|
|
13221
13222
|
static readonly isTreeColumn: boolean
|
|
13223
|
+
/**
|
|
13224
|
+
* Identifies an object as an instance of [TreeColumnMixin](https://bryntum.com/products/grid/docs/api/Grid/column/mixin/TreeColumnMixin) class, or subclass thereof.
|
|
13225
|
+
*/
|
|
13226
|
+
static readonly isTreeColumnMixin: boolean
|
|
13222
13227
|
/**
|
|
13223
13228
|
* The icon to use for the expand / collapse button in expanded state
|
|
13224
13229
|
*/
|
|
@@ -13243,6 +13248,10 @@ export class TreeColumn extends Column {
|
|
|
13243
13248
|
* Identifies an object as an instance of [TreeColumn](https://bryntum.com/products/grid/docs/api/Grid/column/TreeColumn) class, or subclass thereof.
|
|
13244
13249
|
*/
|
|
13245
13250
|
readonly isTreeColumn: boolean
|
|
13251
|
+
/**
|
|
13252
|
+
* Identifies an object as an instance of [TreeColumnMixin](https://bryntum.com/products/grid/docs/api/Grid/column/mixin/TreeColumnMixin) class, or subclass thereof.
|
|
13253
|
+
*/
|
|
13254
|
+
readonly isTreeColumnMixin: boolean
|
|
13246
13255
|
/**
|
|
13247
13256
|
* The icon to use for the leaf nodes in the tree
|
|
13248
13257
|
*/
|
|
@@ -14035,6 +14044,88 @@ export class WidgetColumn extends Column {
|
|
|
14035
14044
|
}): void;
|
|
14036
14045
|
}
|
|
14037
14046
|
|
|
14047
|
+
/**
|
|
14048
|
+
* Type with configuration options for [TreeColumnMixin](https://bryntum.com/products/grid/docs/api/Grid/column/mixin/TreeColumnMixin) class.
|
|
14049
|
+
*/
|
|
14050
|
+
type TreeColumnMixinClassConfig = {
|
|
14051
|
+
/**
|
|
14052
|
+
* The icon to use for the expand / collapse button in expanded state
|
|
14053
|
+
*/
|
|
14054
|
+
collapseIconCls?: string|null
|
|
14055
|
+
/**
|
|
14056
|
+
* The icon to use for a parent node in collapsed state
|
|
14057
|
+
*/
|
|
14058
|
+
collapsedFolderIconCls?: string|null
|
|
14059
|
+
/**
|
|
14060
|
+
* The icon to use for the expand / collapse button icon in collapsed state
|
|
14061
|
+
*/
|
|
14062
|
+
expandIconCls?: string|null
|
|
14063
|
+
/**
|
|
14064
|
+
* The icon to use for a parent node in expanded state
|
|
14065
|
+
*/
|
|
14066
|
+
expandedFolderIconCls?: string|null
|
|
14067
|
+
/**
|
|
14068
|
+
* Size of the child indent in em. Resulting indent is indentSize multiplied by child level.
|
|
14069
|
+
* ...
|
|
14070
|
+
* [View online docs...](https://bryntum.com/products/grid/docs/api/Grid/column/mixin/TreeColumnMixin#config-indentSize)
|
|
14071
|
+
*/
|
|
14072
|
+
indentSize?: number
|
|
14073
|
+
/**
|
|
14074
|
+
* The icon to use for the leaf nodes in the tree
|
|
14075
|
+
*/
|
|
14076
|
+
leafIconCls?: string|null
|
|
14077
|
+
}
|
|
14078
|
+
|
|
14079
|
+
export class TreeColumnMixinClass {
|
|
14080
|
+
/**
|
|
14081
|
+
* Identifies this column as a tree column
|
|
14082
|
+
*/
|
|
14083
|
+
static readonly isTreeColumn: boolean
|
|
14084
|
+
/**
|
|
14085
|
+
* Identifies an object as an instance of [TreeColumnMixin](https://bryntum.com/products/grid/docs/api/Grid/column/mixin/TreeColumnMixin) class, or subclass thereof.
|
|
14086
|
+
*/
|
|
14087
|
+
static readonly isTreeColumnMixin: boolean
|
|
14088
|
+
/**
|
|
14089
|
+
* The icon to use for the expand / collapse button in expanded state
|
|
14090
|
+
*/
|
|
14091
|
+
collapseIconCls: string|null
|
|
14092
|
+
/**
|
|
14093
|
+
* The icon to use for a parent node in collapsed state
|
|
14094
|
+
*/
|
|
14095
|
+
collapsedFolderIconCls: string|null
|
|
14096
|
+
/**
|
|
14097
|
+
* The icon to use for the expand / collapse button icon in collapsed state
|
|
14098
|
+
*/
|
|
14099
|
+
expandIconCls: string|null
|
|
14100
|
+
/**
|
|
14101
|
+
* The icon to use for a parent node in expanded state
|
|
14102
|
+
*/
|
|
14103
|
+
expandedFolderIconCls: string|null
|
|
14104
|
+
/**
|
|
14105
|
+
* Size of the child indent in em. Resulting indent is indentSize multiplied by child level.
|
|
14106
|
+
*/
|
|
14107
|
+
indentSize: number
|
|
14108
|
+
/**
|
|
14109
|
+
* Identifies this column as a tree column
|
|
14110
|
+
*/
|
|
14111
|
+
readonly isTreeColumn: boolean
|
|
14112
|
+
/**
|
|
14113
|
+
* Identifies an object as an instance of [TreeColumnMixin](https://bryntum.com/products/grid/docs/api/Grid/column/mixin/TreeColumnMixin) class, or subclass thereof.
|
|
14114
|
+
*/
|
|
14115
|
+
readonly isTreeColumnMixin: boolean
|
|
14116
|
+
/**
|
|
14117
|
+
* The icon to use for the leaf nodes in the tree
|
|
14118
|
+
*/
|
|
14119
|
+
leafIconCls: string|null
|
|
14120
|
+
/**
|
|
14121
|
+
* Creates an instance of the class using the supplied configuration
|
|
14122
|
+
* @param {TreeColumnMixinClassConfig} config
|
|
14123
|
+
*/
|
|
14124
|
+
constructor(config?: TreeColumnMixinClassConfig);
|
|
14125
|
+
}
|
|
14126
|
+
|
|
14127
|
+
export const TreeColumnMixin : <T extends AnyConstructor<Base>>(base : T) => AnyConstructor<InstanceType<T> & TreeColumnMixinClass>
|
|
14128
|
+
|
|
14038
14129
|
/**
|
|
14039
14130
|
* Type with available listeners functions for [ColumnStore](https://bryntum.com/products/grid/docs/api/Grid/data/ColumnStore) class.
|
|
14040
14131
|
* Could be used for callbacks typings in TypeScript application.
|
|
@@ -15489,6 +15580,339 @@ export class GridRowModel extends Model {
|
|
|
15489
15580
|
target: '_self'|'_blank'|'_parent'|'_top'|null
|
|
15490
15581
|
}
|
|
15491
15582
|
|
|
15583
|
+
/**
|
|
15584
|
+
* Type with available listeners functions for [AI](https://bryntum.com/products/grid/docs/api/Grid/feature/AI) class.
|
|
15585
|
+
* Could be used for callbacks typings in TypeScript application.
|
|
15586
|
+
*/
|
|
15587
|
+
type AIListenersTypes = {
|
|
15588
|
+
/**
|
|
15589
|
+
* Fires before an object is destroyed.
|
|
15590
|
+
* @param {object} event Event object
|
|
15591
|
+
* @param {Core.Base} event.source The Object that is being destroyed.
|
|
15592
|
+
*/
|
|
15593
|
+
beforeDestroy: (event: { source: Base }) => void
|
|
15594
|
+
/**
|
|
15595
|
+
* Fires when any other event is fired from the object.
|
|
15596
|
+
* ...
|
|
15597
|
+
* [View online docs...](https://bryntum.com/products/grid/docs/api/Grid/feature/AI#event-catchAll)
|
|
15598
|
+
* @param {object} event Event object
|
|
15599
|
+
* @param {{[key: string]: any, type: string}} event.event The Object that contains event details
|
|
15600
|
+
* @param {string} event.event.type The type of the event which is caught by the listener
|
|
15601
|
+
*/
|
|
15602
|
+
catchAll: (event: {[key: string]: any, type: string}) => void
|
|
15603
|
+
/**
|
|
15604
|
+
* Fires when an object is destroyed.
|
|
15605
|
+
* @param {object} event Event object
|
|
15606
|
+
* @param {Core.Base} event.source The Object that is being destroyed.
|
|
15607
|
+
*/
|
|
15608
|
+
destroy: (event: { source: Base }) => void
|
|
15609
|
+
/**
|
|
15610
|
+
* Fired when the plugin/feature is disabled.
|
|
15611
|
+
* @param {object} event Event object
|
|
15612
|
+
* @param {Core.mixin.InstancePlugin} event.source
|
|
15613
|
+
*/
|
|
15614
|
+
disable: (event: { source: InstancePlugin }) => void
|
|
15615
|
+
/**
|
|
15616
|
+
* Fired when the plugin/feature is enabled.
|
|
15617
|
+
* @param {object} event Event object
|
|
15618
|
+
* @param {Core.mixin.InstancePlugin} event.source
|
|
15619
|
+
*/
|
|
15620
|
+
enable: (event: { source: InstancePlugin }) => void
|
|
15621
|
+
/**
|
|
15622
|
+
* Fired when the user changes it's settings via the settings panel
|
|
15623
|
+
* @param {object} event Event object
|
|
15624
|
+
* @param {Core.data.AISettingsModel} event.userSettings The user settings record
|
|
15625
|
+
* @param {object} event.changes The changed properties and the new value
|
|
15626
|
+
*/
|
|
15627
|
+
userSettingsUpdate: (event: { userSettings: AISettingsModel, changes: object }) => void
|
|
15628
|
+
}
|
|
15629
|
+
|
|
15630
|
+
/**
|
|
15631
|
+
* Type with listeners options for [AI](https://bryntum.com/products/grid/docs/api/Grid/feature/AI) class.
|
|
15632
|
+
*/
|
|
15633
|
+
type AIListeners = {
|
|
15634
|
+
/**
|
|
15635
|
+
* The `this` object for listener methods
|
|
15636
|
+
*/
|
|
15637
|
+
thisObj?: object
|
|
15638
|
+
/**
|
|
15639
|
+
* Fires before an object is destroyed.
|
|
15640
|
+
* @param {object} event Event object
|
|
15641
|
+
* @param {Core.Base} event.source The Object that is being destroyed.
|
|
15642
|
+
*/
|
|
15643
|
+
beforeDestroy?: ((event: { source: Base }) => void)|string
|
|
15644
|
+
/**
|
|
15645
|
+
* Fires when any other event is fired from the object.
|
|
15646
|
+
* ...
|
|
15647
|
+
* [View online docs...](https://bryntum.com/products/grid/docs/api/Grid/feature/AI#event-catchAll)
|
|
15648
|
+
* @param {object} event Event object
|
|
15649
|
+
* @param {{[key: string]: any, type: string}} event.event The Object that contains event details
|
|
15650
|
+
* @param {string} event.event.type The type of the event which is caught by the listener
|
|
15651
|
+
*/
|
|
15652
|
+
catchAll?: ((event: {[key: string]: any, type: string}) => void)|string
|
|
15653
|
+
/**
|
|
15654
|
+
* Fires when an object is destroyed.
|
|
15655
|
+
* @param {object} event Event object
|
|
15656
|
+
* @param {Core.Base} event.source The Object that is being destroyed.
|
|
15657
|
+
*/
|
|
15658
|
+
destroy?: ((event: { source: Base }) => void)|string
|
|
15659
|
+
/**
|
|
15660
|
+
* Fired when the plugin/feature is disabled.
|
|
15661
|
+
* @param {object} event Event object
|
|
15662
|
+
* @param {Core.mixin.InstancePlugin} event.source
|
|
15663
|
+
*/
|
|
15664
|
+
disable?: ((event: { source: InstancePlugin }) => void)|string
|
|
15665
|
+
/**
|
|
15666
|
+
* Fired when the plugin/feature is enabled.
|
|
15667
|
+
* @param {object} event Event object
|
|
15668
|
+
* @param {Core.mixin.InstancePlugin} event.source
|
|
15669
|
+
*/
|
|
15670
|
+
enable?: ((event: { source: InstancePlugin }) => void)|string
|
|
15671
|
+
/**
|
|
15672
|
+
* Fired when the user changes it's settings via the settings panel
|
|
15673
|
+
* @param {object} event Event object
|
|
15674
|
+
* @param {Core.data.AISettingsModel} event.userSettings The user settings record
|
|
15675
|
+
* @param {object} event.changes The changed properties and the new value
|
|
15676
|
+
*/
|
|
15677
|
+
userSettingsUpdate?: ((event: { userSettings: AISettingsModel, changes: object }) => void)|string
|
|
15678
|
+
}
|
|
15679
|
+
|
|
15680
|
+
/**
|
|
15681
|
+
* Type with configuration options for [AI](https://bryntum.com/products/grid/docs/api/Grid/feature/AI) class.
|
|
15682
|
+
*/
|
|
15683
|
+
type AIConfig = {
|
|
15684
|
+
type?: 'ai'
|
|
15685
|
+
/**
|
|
15686
|
+
* AI plugin to use. Provide the class here. Available plugins are:
|
|
15687
|
+
* ...
|
|
15688
|
+
* [View online docs...](https://bryntum.com/products/grid/docs/api/Grid/feature/AI#config-apiPlugin)
|
|
15689
|
+
*/
|
|
15690
|
+
apiPlugin?: typeof AbstractApiPlugin
|
|
15691
|
+
/**
|
|
15692
|
+
* Shows an AI model selector in the SettingsPanel where the user can select between the available API:s
|
|
15693
|
+
*/
|
|
15694
|
+
availableApis?: AIModelSelector[]
|
|
15695
|
+
/**
|
|
15696
|
+
* Set this to `true` or a config object to add a [ChatButton](https://bryntum.com/products/grid/docs/api/Core/widget/chat/ChatButton)
|
|
15697
|
+
*/
|
|
15698
|
+
chatButton?: boolean|ChatButtonConfig
|
|
15699
|
+
/**
|
|
15700
|
+
* Set to `true` to automatically console.log things that happen internally. AI responses and audio processing
|
|
15701
|
+
* for example.
|
|
15702
|
+
*/
|
|
15703
|
+
debugMode?: boolean
|
|
15704
|
+
/**
|
|
15705
|
+
* An array of strings which will be circulated as waiting status texts when awaiting long AI responses
|
|
15706
|
+
* Defaults to `['Waiting', 'Waiting ...', 'Still waiting', 'Still waiting ...']`
|
|
15707
|
+
*/
|
|
15708
|
+
delayStatusTexts?: string[]
|
|
15709
|
+
/**
|
|
15710
|
+
* The plugin/feature `disabled` state.
|
|
15711
|
+
* ...
|
|
15712
|
+
* [View online docs...](https://bryntum.com/products/grid/docs/api/Grid/feature/AI#config-disabled)
|
|
15713
|
+
*/
|
|
15714
|
+
disabled?: boolean|'inert'
|
|
15715
|
+
/**
|
|
15716
|
+
* The URL to send feedback (thumbs up/thumbs down) to
|
|
15717
|
+
*/
|
|
15718
|
+
feedbackUrl?: string
|
|
15719
|
+
/**
|
|
15720
|
+
* Additional options to pass to fetch requests
|
|
15721
|
+
*/
|
|
15722
|
+
fetchOptions?: object
|
|
15723
|
+
/**
|
|
15724
|
+
* By default, data item which are targeted in an AI action will be highlighted in the UI. Set this to `false`
|
|
15725
|
+
* to prevent this behavior.
|
|
15726
|
+
*/
|
|
15727
|
+
highlightRelatedItems?: boolean
|
|
15728
|
+
/**
|
|
15729
|
+
* The listener set for this object.
|
|
15730
|
+
* ...
|
|
15731
|
+
* [View online docs...](https://bryntum.com/products/grid/docs/api/Grid/feature/AI#config-listeners)
|
|
15732
|
+
*/
|
|
15733
|
+
listeners?: AIListeners
|
|
15734
|
+
/**
|
|
15735
|
+
* Set to `false` to not manage chat history on the client
|
|
15736
|
+
*/
|
|
15737
|
+
manageChatHistory?: boolean
|
|
15738
|
+
/**
|
|
15739
|
+
* Max tokens setting (if applicable)
|
|
15740
|
+
*/
|
|
15741
|
+
max_tokens?: number
|
|
15742
|
+
/**
|
|
15743
|
+
* AI model name (if applicable)
|
|
15744
|
+
*/
|
|
15745
|
+
model?: string
|
|
15746
|
+
/**
|
|
15747
|
+
* Use this to provide more details of data models currently available for the AI agent to work with. Provide
|
|
15748
|
+
* an object with model class names as keys and configuration objects as values.
|
|
15749
|
+
* ...
|
|
15750
|
+
* [View online docs...](https://bryntum.com/products/grid/docs/api/Grid/feature/AI#config-models)
|
|
15751
|
+
*/
|
|
15752
|
+
models?: Record<string, AIModelConfiguration>
|
|
15753
|
+
/**
|
|
15754
|
+
* The URL to send text prompts to
|
|
15755
|
+
*/
|
|
15756
|
+
promptUrl?: string
|
|
15757
|
+
/**
|
|
15758
|
+
* Enables support for redoing data modifying actions performed by the AI. Shows a redo icon under the last
|
|
15759
|
+
* redoable message in the ChatPanel. Requires undo to be enabled.
|
|
15760
|
+
*/
|
|
15761
|
+
redo?: boolean
|
|
15762
|
+
/**
|
|
15763
|
+
* Set to `true` to always prompt the user for confirmation before allowing the AI to add records
|
|
15764
|
+
*/
|
|
15765
|
+
requireConfirmationOnAdds?: boolean
|
|
15766
|
+
/**
|
|
15767
|
+
* Set to `true` to always prompt the user for confirmation before allowing the AI to remove records
|
|
15768
|
+
*/
|
|
15769
|
+
requireConfirmationOnRemovals?: boolean
|
|
15770
|
+
/**
|
|
15771
|
+
* Set to `true` to always prompt the user for confirmation before allowing the AI to update records
|
|
15772
|
+
*/
|
|
15773
|
+
requireConfirmationOnUpdates?: boolean
|
|
15774
|
+
/**
|
|
15775
|
+
* Set to `true` to upon creation, send a test prompt to verify the connection to the AI backend. If the test
|
|
15776
|
+
* fails, a warning icon will be shown on the chat panel.
|
|
15777
|
+
*/
|
|
15778
|
+
showNoConnectionIcon?: boolean
|
|
15779
|
+
/**
|
|
15780
|
+
* Temperature setting (if applicable). Overrides the default temperature set by the apiPlugin.
|
|
15781
|
+
*/
|
|
15782
|
+
temperature?: number
|
|
15783
|
+
/**
|
|
15784
|
+
* The URL to send text for speech synthesizing
|
|
15785
|
+
*/
|
|
15786
|
+
textToSpeechUrl?: string
|
|
15787
|
+
/**
|
|
15788
|
+
* A number of milliseconds a prompt is allowed to take before being aborted. Defaults to `60000` (1 minute).
|
|
15789
|
+
*/
|
|
15790
|
+
timeout?: number
|
|
15791
|
+
/**
|
|
15792
|
+
* Use this to add custom tools to the AI model's tool list or to remove existing tools. Provide an object
|
|
15793
|
+
* with the tool names as keys and configuration objects as values. Please note that modifying existing tools is
|
|
15794
|
+
* not supported, only removing them.
|
|
15795
|
+
* ...
|
|
15796
|
+
* [View online docs...](https://bryntum.com/products/grid/docs/api/Grid/feature/AI#config-tools)
|
|
15797
|
+
*/
|
|
15798
|
+
tools?: Record<string, AIToolConfig>
|
|
15799
|
+
/**
|
|
15800
|
+
* Use this to provide example prompt scenarios to "teach" the AI of more complex tasks. Must be configured as
|
|
15801
|
+
* an array containing arrays which contains the AI messages for the complete conversation.
|
|
15802
|
+
* ...
|
|
15803
|
+
* [View online docs...](https://bryntum.com/products/grid/docs/api/Grid/feature/AI#config-trainingData)
|
|
15804
|
+
*/
|
|
15805
|
+
trainingData?: any[]
|
|
15806
|
+
/**
|
|
15807
|
+
* The URL to send audio for transcribing
|
|
15808
|
+
*/
|
|
15809
|
+
transcribeUrl?: string
|
|
15810
|
+
/**
|
|
15811
|
+
* Enables support for undoing data modifying actions performed by the AI. Shows an undo icon under the last
|
|
15812
|
+
* undoable message in the ChatPanel.
|
|
15813
|
+
*/
|
|
15814
|
+
undo?: boolean
|
|
15815
|
+
/**
|
|
15816
|
+
* A configuration object containing the user's preferred AI feature settings. If there is a matching AI feature
|
|
15817
|
+
* class config, the user setting will take precedence
|
|
15818
|
+
* JSON.
|
|
15819
|
+
*/
|
|
15820
|
+
userSettings?: AISettingsModelConfig|AISettingsModel
|
|
15821
|
+
/**
|
|
15822
|
+
* Experimental configuration of the AI verbosity. Valid values are `"1"`, `"2"` and `"3"`, where `"1"` is
|
|
15823
|
+
* lowest.
|
|
15824
|
+
*/
|
|
15825
|
+
verbosityLevel?: string
|
|
15826
|
+
/**
|
|
15827
|
+
* Configuration settings for voice activation
|
|
15828
|
+
*/
|
|
15829
|
+
voiceActivation?: AIVoiceActivationConfig
|
|
15830
|
+
/**
|
|
15831
|
+
* Forces voice only mode, which hides the chat panel and only shows a record chat button.
|
|
15832
|
+
*/
|
|
15833
|
+
voiceOnly?: boolean
|
|
15834
|
+
/**
|
|
15835
|
+
* Fires before an object is destroyed.
|
|
15836
|
+
* @param {object} event Event object
|
|
15837
|
+
* @param {Core.Base} event.source The Object that is being destroyed.
|
|
15838
|
+
*/
|
|
15839
|
+
onBeforeDestroy?: ((event: { source: Base }) => void)|string
|
|
15840
|
+
/**
|
|
15841
|
+
* Fires when any other event is fired from the object.
|
|
15842
|
+
* ...
|
|
15843
|
+
* [View online docs...](https://bryntum.com/products/grid/docs/api/Grid/feature/AI#event-catchAll)
|
|
15844
|
+
* @param {object} event Event object
|
|
15845
|
+
* @param {{[key: string]: any, type: string}} event.event The Object that contains event details
|
|
15846
|
+
* @param {string} event.event.type The type of the event which is caught by the listener
|
|
15847
|
+
*/
|
|
15848
|
+
onCatchAll?: ((event: {[key: string]: any, type: string}) => void)|string
|
|
15849
|
+
/**
|
|
15850
|
+
* Fires when an object is destroyed.
|
|
15851
|
+
* @param {object} event Event object
|
|
15852
|
+
* @param {Core.Base} event.source The Object that is being destroyed.
|
|
15853
|
+
*/
|
|
15854
|
+
onDestroy?: ((event: { source: Base }) => void)|string
|
|
15855
|
+
/**
|
|
15856
|
+
* Fired when the plugin/feature is disabled.
|
|
15857
|
+
* @param {object} event Event object
|
|
15858
|
+
* @param {Core.mixin.InstancePlugin} event.source
|
|
15859
|
+
*/
|
|
15860
|
+
onDisable?: ((event: { source: InstancePlugin }) => void)|string
|
|
15861
|
+
/**
|
|
15862
|
+
* Fired when the plugin/feature is enabled.
|
|
15863
|
+
* @param {object} event Event object
|
|
15864
|
+
* @param {Core.mixin.InstancePlugin} event.source
|
|
15865
|
+
*/
|
|
15866
|
+
onEnable?: ((event: { source: InstancePlugin }) => void)|string
|
|
15867
|
+
/**
|
|
15868
|
+
* Fired when the user changes it's settings via the settings panel
|
|
15869
|
+
* @param {object} event Event object
|
|
15870
|
+
* @param {Core.data.AISettingsModel} event.userSettings The user settings record
|
|
15871
|
+
* @param {object} event.changes The changed properties and the new value
|
|
15872
|
+
*/
|
|
15873
|
+
onUserSettingsUpdate?: ((event: { userSettings: AISettingsModel, changes: object }) => void)|string
|
|
15874
|
+
}
|
|
15875
|
+
|
|
15876
|
+
/**
|
|
15877
|
+
* This feature provides an AI agent for Grid. It provides a chat panel that allows the user to send messages to the
|
|
15878
|
+
* agent and see the responses. Which allows the user to use natural language to interact with the Grid in different
|
|
15879
|
+
* ways. For example, the user can ask the agent to filter the data, sort it, or select specific records. The agent can
|
|
15880
|
+
* also perform data manipulation operations such as adding, updating, deleting records.
|
|
15881
|
+
* ...
|
|
15882
|
+
* [View online docs...](https://bryntum.com/products/grid/docs/api/Grid/feature/AI)
|
|
15883
|
+
*/
|
|
15884
|
+
export class AI extends AIBase {
|
|
15885
|
+
/**
|
|
15886
|
+
* Identifies an object as an instance of [AI](https://bryntum.com/products/grid/docs/api/Grid/feature/AI) class, or subclass thereof.
|
|
15887
|
+
*/
|
|
15888
|
+
static readonly isAI: boolean
|
|
15889
|
+
/**
|
|
15890
|
+
* Identifies an object as an instance of [AI](https://bryntum.com/products/grid/docs/api/Grid/feature/AI) class, or subclass thereof.
|
|
15891
|
+
*/
|
|
15892
|
+
readonly isAI: boolean
|
|
15893
|
+
/**
|
|
15894
|
+
* Fires before an object is destroyed.
|
|
15895
|
+
* @param {object} event Event object
|
|
15896
|
+
* @param {Core.Base} event.source The Object that is being destroyed.
|
|
15897
|
+
*/
|
|
15898
|
+
onBeforeDestroy: ((event: { source: Base }) => void)|string
|
|
15899
|
+
/**
|
|
15900
|
+
* Fires when any other event is fired from the object.
|
|
15901
|
+
* ...
|
|
15902
|
+
* [View online docs...](https://bryntum.com/products/grid/docs/api/Grid/feature/AI#event-catchAll)
|
|
15903
|
+
* @param {object} event Event object
|
|
15904
|
+
* @param {{[key: string]: any, type: string}} event.event The Object that contains event details
|
|
15905
|
+
* @param {string} event.event.type The type of the event which is caught by the listener
|
|
15906
|
+
*/
|
|
15907
|
+
onCatchAll: ((event: {[key: string]: any, type: string}) => void)|string
|
|
15908
|
+
/**
|
|
15909
|
+
* Fires when an object is destroyed.
|
|
15910
|
+
* @param {object} event Event object
|
|
15911
|
+
* @param {Core.Base} event.source The Object that is being destroyed.
|
|
15912
|
+
*/
|
|
15913
|
+
onDestroy: ((event: { source: Base }) => void)|string
|
|
15914
|
+
}
|
|
15915
|
+
|
|
15492
15916
|
/**
|
|
15493
15917
|
* Type with available listeners functions for [CellCopyPaste](https://bryntum.com/products/grid/docs/api/Grid/feature/CellCopyPaste) class.
|
|
15494
15918
|
* Could be used for callbacks typings in TypeScript application.
|
|
@@ -16592,6 +17016,10 @@ type CellTooltipConfig = {
|
|
|
16592
17016
|
* [View online docs...](https://bryntum.com/products/grid/docs/api/Grid/feature/CellTooltip#config-bodyCls)
|
|
16593
17017
|
*/
|
|
16594
17018
|
bodyCls?: string|object
|
|
17019
|
+
/**
|
|
17020
|
+
* Set `true` to add a border to this container's element.
|
|
17021
|
+
*/
|
|
17022
|
+
border?: boolean
|
|
16595
17023
|
/**
|
|
16596
17024
|
* An object where property names with a truthy value indicate which events should bubble up the ownership
|
|
16597
17025
|
* hierarchy when triggered.
|
|
@@ -16664,7 +17092,7 @@ type CellTooltipConfig = {
|
|
|
16664
17092
|
* ...
|
|
16665
17093
|
* [View online docs...](https://bryntum.com/products/grid/docs/api/Grid/feature/CellTooltip#config-color)
|
|
16666
17094
|
*/
|
|
16667
|
-
color?:
|
|
17095
|
+
color?: Color
|
|
16668
17096
|
/**
|
|
16669
17097
|
* Programmatic control over which column to start in when used in a grid layout.
|
|
16670
17098
|
*/
|
|
@@ -25698,6 +26126,13 @@ type AIFilterListenersTypes = {
|
|
|
25698
26126
|
* @param {Core.mixin.InstancePlugin} event.source
|
|
25699
26127
|
*/
|
|
25700
26128
|
enable: (event: { source: InstancePlugin }) => void
|
|
26129
|
+
/**
|
|
26130
|
+
* Fired when the user changes it's settings via the settings panel
|
|
26131
|
+
* @param {object} event Event object
|
|
26132
|
+
* @param {Core.data.AISettingsModel} event.userSettings The user settings record
|
|
26133
|
+
* @param {object} event.changes The changed properties and the new value
|
|
26134
|
+
*/
|
|
26135
|
+
userSettingsUpdate: (event: { userSettings: AISettingsModel, changes: object }) => void
|
|
25701
26136
|
}
|
|
25702
26137
|
|
|
25703
26138
|
/**
|
|
@@ -25741,6 +26176,13 @@ type AIFilterListeners = {
|
|
|
25741
26176
|
* @param {Core.mixin.InstancePlugin} event.source
|
|
25742
26177
|
*/
|
|
25743
26178
|
enable?: ((event: { source: InstancePlugin }) => void)|string
|
|
26179
|
+
/**
|
|
26180
|
+
* Fired when the user changes it's settings via the settings panel
|
|
26181
|
+
* @param {object} event Event object
|
|
26182
|
+
* @param {Core.data.AISettingsModel} event.userSettings The user settings record
|
|
26183
|
+
* @param {object} event.changes The changed properties and the new value
|
|
26184
|
+
*/
|
|
26185
|
+
userSettingsUpdate?: ((event: { userSettings: AISettingsModel, changes: object }) => void)|string
|
|
25744
26186
|
}
|
|
25745
26187
|
|
|
25746
26188
|
/**
|
|
@@ -25754,11 +26196,20 @@ type AIFilterConfig = {
|
|
|
25754
26196
|
* [View online docs...](https://bryntum.com/products/grid/docs/api/Grid/feature/ai/AIFilter#config-apiPlugin)
|
|
25755
26197
|
*/
|
|
25756
26198
|
apiPlugin?: typeof AbstractApiPlugin
|
|
26199
|
+
/**
|
|
26200
|
+
* Shows an AI model selector in the SettingsPanel where the user can select between the available API:s
|
|
26201
|
+
*/
|
|
26202
|
+
availableApis?: AIModelSelector[]
|
|
25757
26203
|
/**
|
|
25758
26204
|
* Set to `true` to automatically console.log things that happen internally. AI responses and audio processing
|
|
25759
26205
|
* for example.
|
|
25760
26206
|
*/
|
|
25761
26207
|
debugMode?: boolean
|
|
26208
|
+
/**
|
|
26209
|
+
* An array of strings which will be circulated as waiting status texts when awaiting long AI responses
|
|
26210
|
+
* Defaults to `['Waiting', 'Waiting ...', 'Still waiting', 'Still waiting ...']`
|
|
26211
|
+
*/
|
|
26212
|
+
delayStatusTexts?: string[]
|
|
25762
26213
|
/**
|
|
25763
26214
|
* The plugin/feature `disabled` state.
|
|
25764
26215
|
* ...
|
|
@@ -25769,6 +26220,11 @@ type AIFilterConfig = {
|
|
|
25769
26220
|
* Additional options to pass to fetch requests
|
|
25770
26221
|
*/
|
|
25771
26222
|
fetchOptions?: object
|
|
26223
|
+
/**
|
|
26224
|
+
* By default, data item which are targeted in an AI action will be highlighted in the UI. Set this to `false`
|
|
26225
|
+
* to prevent this behavior.
|
|
26226
|
+
*/
|
|
26227
|
+
highlightRelatedItems?: boolean
|
|
25772
26228
|
/**
|
|
25773
26229
|
* The listener set for this object.
|
|
25774
26230
|
* ...
|
|
@@ -25795,13 +26251,51 @@ type AIFilterConfig = {
|
|
|
25795
26251
|
*/
|
|
25796
26252
|
promptUrl?: string
|
|
25797
26253
|
/**
|
|
25798
|
-
*
|
|
26254
|
+
* Set to `true` to always prompt the user for confirmation before allowing the AI to add records
|
|
26255
|
+
*/
|
|
26256
|
+
requireConfirmationOnAdds?: boolean
|
|
26257
|
+
/**
|
|
26258
|
+
* Set to `true` to always prompt the user for confirmation before allowing the AI to remove records
|
|
26259
|
+
*/
|
|
26260
|
+
requireConfirmationOnRemovals?: boolean
|
|
26261
|
+
/**
|
|
26262
|
+
* Set to `true` to always prompt the user for confirmation before allowing the AI to update records
|
|
26263
|
+
*/
|
|
26264
|
+
requireConfirmationOnUpdates?: boolean
|
|
26265
|
+
/**
|
|
26266
|
+
* Temperature setting (if applicable). Overrides the default temperature set by the apiPlugin.
|
|
25799
26267
|
*/
|
|
25800
26268
|
temperature?: number
|
|
26269
|
+
/**
|
|
26270
|
+
* A number of milliseconds a prompt is allowed to take before being aborted. Defaults to `60000` (1 minute).
|
|
26271
|
+
*/
|
|
26272
|
+
timeout?: number
|
|
26273
|
+
/**
|
|
26274
|
+
* Use this to provide example prompt scenarios to "teach" the AI of more complex tasks. Must be configured as
|
|
26275
|
+
* an array containing arrays which contains the AI messages for the complete conversation.
|
|
26276
|
+
* ...
|
|
26277
|
+
* [View online docs...](https://bryntum.com/products/grid/docs/api/Grid/feature/ai/AIFilter#config-trainingData)
|
|
26278
|
+
*/
|
|
26279
|
+
trainingData?: any[]
|
|
25801
26280
|
/**
|
|
25802
26281
|
* The text to show in the toast when the text input did not result in any filter being applied
|
|
25803
26282
|
*/
|
|
25804
26283
|
unsuccessfulFilterMessage?: string
|
|
26284
|
+
/**
|
|
26285
|
+
* A configuration object containing the user's preferred AI feature settings. If there is a matching AI feature
|
|
26286
|
+
* class config, the user setting will take precedence
|
|
26287
|
+
* JSON.
|
|
26288
|
+
*/
|
|
26289
|
+
userSettings?: AISettingsModelConfig|AISettingsModel
|
|
26290
|
+
/**
|
|
26291
|
+
* Experimental configuration of the AI verbosity. Valid values are `"1"`, `"2"` and `"3"`, where `"1"` is
|
|
26292
|
+
* lowest.
|
|
26293
|
+
*/
|
|
26294
|
+
verbosityLevel?: string
|
|
26295
|
+
/**
|
|
26296
|
+
* Configuration settings for voice activation
|
|
26297
|
+
*/
|
|
26298
|
+
voiceActivation?: AIVoiceActivationConfig
|
|
25805
26299
|
/**
|
|
25806
26300
|
* Fires before an object is destroyed.
|
|
25807
26301
|
* @param {object} event Event object
|
|
@@ -25835,6 +26329,13 @@ type AIFilterConfig = {
|
|
|
25835
26329
|
* @param {Core.mixin.InstancePlugin} event.source
|
|
25836
26330
|
*/
|
|
25837
26331
|
onEnable?: ((event: { source: InstancePlugin }) => void)|string
|
|
26332
|
+
/**
|
|
26333
|
+
* Fired when the user changes it's settings via the settings panel
|
|
26334
|
+
* @param {object} event Event object
|
|
26335
|
+
* @param {Core.data.AISettingsModel} event.userSettings The user settings record
|
|
26336
|
+
* @param {object} event.changes The changed properties and the new value
|
|
26337
|
+
*/
|
|
26338
|
+
onUserSettingsUpdate?: ((event: { userSettings: AISettingsModel, changes: object }) => void)|string
|
|
25838
26339
|
}
|
|
25839
26340
|
|
|
25840
26341
|
/**
|
|
@@ -29535,6 +30036,14 @@ type GridListenersTypes = {
|
|
|
29535
30036
|
* @param {any} event.value The value being set
|
|
29536
30037
|
*/
|
|
29537
30038
|
beforeCellRangeEdit: (event: { record: Model, field: string, value: any }) => Promise<boolean>|boolean|void
|
|
30039
|
+
/**
|
|
30040
|
+
* This event is triggered before a parent column is collapsed or expanded.
|
|
30041
|
+
* @param {object} event Event object
|
|
30042
|
+
* @param {Grid.view.GridBase} event.source The grid instance
|
|
30043
|
+
* @param {Grid.column.Column} event.column The column
|
|
30044
|
+
* @param {boolean} event.collapsed `true` if the column is being collapsed, `false` if expanded
|
|
30045
|
+
*/
|
|
30046
|
+
beforeColumnCollapseToggle: (event: { source: GridBase, column: Column, collapsed: boolean }) => void
|
|
29538
30047
|
/**
|
|
29539
30048
|
* This event is fired prior to starting a column drag gesture. The drag is canceled if a listener returns `false`.
|
|
29540
30049
|
* @param {object} event Event object
|
|
@@ -29635,18 +30144,18 @@ type GridListenersTypes = {
|
|
|
29635
30144
|
/**
|
|
29636
30145
|
* Fires before a row is rendered.
|
|
29637
30146
|
* @param {object} event Event object
|
|
29638
|
-
* @param {Grid.view.
|
|
29639
|
-
* @param {Grid.row.Row} event.row The row about to be rendered
|
|
29640
|
-
* @param {Core.data.Model} event.record The record for the row
|
|
29641
|
-
* @param {number} event.recordIndex The zero-based index of the record
|
|
30147
|
+
* @param {Grid.view.GridBase} event.source The firing Grid instance
|
|
30148
|
+
* @param {Grid.row.Row} event.row The row about to be rendered
|
|
30149
|
+
* @param {Core.data.Model} event.record The record for the row
|
|
30150
|
+
* @param {number} event.recordIndex The zero-based index of the record
|
|
29642
30151
|
*/
|
|
29643
|
-
beforeRenderRow: (event: { source:
|
|
30152
|
+
beforeRenderRow: (event: { source: GridBase, row: Row, record: Model, recordIndex: number }) => void
|
|
29644
30153
|
/**
|
|
29645
30154
|
* Grid rows are about to be rendered
|
|
29646
30155
|
* @param {object} event Event object
|
|
29647
|
-
* @param {Grid.view.
|
|
30156
|
+
* @param {Grid.view.GridBase} event.source This grid.
|
|
29648
30157
|
*/
|
|
29649
|
-
beforeRenderRows: (event: { source:
|
|
30158
|
+
beforeRenderRows: (event: { source: GridBase }) => void
|
|
29650
30159
|
/**
|
|
29651
30160
|
* This event fires before row collapse is started.
|
|
29652
30161
|
* ...
|
|
@@ -29877,6 +30386,14 @@ type GridListenersTypes = {
|
|
|
29877
30386
|
* @param {Core.data.Model} event.record The record which has been collapsed.
|
|
29878
30387
|
*/
|
|
29879
30388
|
collapseNode: (event: { source: Grid, record: Model }) => void
|
|
30389
|
+
/**
|
|
30390
|
+
* This event is triggered after a parent column has been collapsed or expanded.
|
|
30391
|
+
* @param {object} event Event object
|
|
30392
|
+
* @param {Grid.view.GridBase} event.source The Grid instance
|
|
30393
|
+
* @param {Grid.column.Column} event.column The column being toggled
|
|
30394
|
+
* @param {boolean} event.collapsed `true` if the column is now collapsed, `false` if expanded
|
|
30395
|
+
*/
|
|
30396
|
+
columnCollapseToggle: (event: { source: GridBase, column: Column, collapsed: boolean }) => void
|
|
29880
30397
|
/**
|
|
29881
30398
|
* This event is fired when a column is being dragged, and you can set the `valid` flag on the `context` object
|
|
29882
30399
|
* to indicate whether the drop position is valid or not.
|
|
@@ -29958,14 +30475,14 @@ type GridListenersTypes = {
|
|
|
29958
30475
|
* ...
|
|
29959
30476
|
* [View online docs...](https://bryntum.com/products/grid/docs/api/Grid/view/Grid#event-dataChange)
|
|
29960
30477
|
* @param {object} event Event object
|
|
29961
|
-
* @param {Grid.view.
|
|
30478
|
+
* @param {Grid.view.GridBase} event.source Owning grid
|
|
29962
30479
|
* @param {Core.data.Store} event.store The originating store
|
|
29963
30480
|
* @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'`
|
|
29964
30481
|
* @param {Core.data.Model} event.record Changed record, for actions that affects exactly one record (`'update'`)
|
|
29965
30482
|
* @param {Core.data.Model[]} event.records Changed records, passed for all actions except `'removeAll'`
|
|
29966
30483
|
* @param {object} event.changes Passed for the `'update'` action, info on which record fields changed
|
|
29967
30484
|
*/
|
|
29968
|
-
dataChange: (event: { source:
|
|
30485
|
+
dataChange: (event: { source: GridBase, store: Store, action: 'remove'|'removeAll'|'add'|'clearchanges'|'filter'|'update'|'dataset'|'replace', record: Model, records: Model[], changes: object }) => void
|
|
29969
30486
|
/**
|
|
29970
30487
|
* Fires when an object is destroyed.
|
|
29971
30488
|
* @param {object} event Event object
|
|
@@ -30273,18 +30790,18 @@ type GridListenersTypes = {
|
|
|
30273
30790
|
/**
|
|
30274
30791
|
* Fires after a row is rendered.
|
|
30275
30792
|
* @param {object} event Event object
|
|
30276
|
-
* @param {Grid.view.
|
|
30277
|
-
* @param {Grid.row.Row} event.row The row that has been rendered
|
|
30278
|
-
* @param {Core.data.Model} event.record The record for the row
|
|
30279
|
-
* @param {number} event.recordIndex The zero-based index of the record
|
|
30793
|
+
* @param {Grid.view.GridBase} event.source The firing Grid instance
|
|
30794
|
+
* @param {Grid.row.Row} event.row The row that has been rendered
|
|
30795
|
+
* @param {Core.data.Model} event.record The record for the row
|
|
30796
|
+
* @param {number} event.recordIndex The zero-based index of the record
|
|
30280
30797
|
*/
|
|
30281
|
-
renderRow: (event: { source:
|
|
30798
|
+
renderRow: (event: { source: GridBase, row: Row, record: Model, recordIndex: number }) => void
|
|
30282
30799
|
/**
|
|
30283
30800
|
* Grid rows have been rendered
|
|
30284
30801
|
* @param {object} event Event object
|
|
30285
|
-
* @param {Grid.view.
|
|
30802
|
+
* @param {Grid.view.GridBase} event.source This grid.
|
|
30286
30803
|
*/
|
|
30287
|
-
renderRows: (event: { source:
|
|
30804
|
+
renderRows: (event: { source: GridBase }) => void
|
|
30288
30805
|
/**
|
|
30289
30806
|
* 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`*.
|
|
30290
30807
|
* @param {object} event Event object
|
|
@@ -30344,10 +30861,10 @@ type GridListenersTypes = {
|
|
|
30344
30861
|
/**
|
|
30345
30862
|
* Grid has scrolled vertically
|
|
30346
30863
|
* @param {object} event Event object
|
|
30347
|
-
* @param {Grid.view.
|
|
30864
|
+
* @param {Grid.view.GridBase} event.source The firing Grid instance.
|
|
30348
30865
|
* @param {number} event.scrollTop The vertical scroll position.
|
|
30349
30866
|
*/
|
|
30350
|
-
scroll: (event: { source:
|
|
30867
|
+
scroll: (event: { source: GridBase, scrollTop: number }) => void
|
|
30351
30868
|
/**
|
|
30352
30869
|
* The selection has been changed.
|
|
30353
30870
|
* @param {object} event Event object
|
|
@@ -30435,17 +30952,17 @@ type GridListenersTypes = {
|
|
|
30435
30952
|
/**
|
|
30436
30953
|
* Fires after a sub grid is collapsed.
|
|
30437
30954
|
* @param {object} event Event object
|
|
30438
|
-
* @param {Grid.view.
|
|
30955
|
+
* @param {Grid.view.GridBase} event.source The firing Grid instance
|
|
30439
30956
|
* @param {Grid.view.SubGrid} event.subGrid The sub grid instance
|
|
30440
30957
|
*/
|
|
30441
|
-
subGridCollapse: (event: { source:
|
|
30958
|
+
subGridCollapse: (event: { source: GridBase, subGrid: SubGrid }) => void
|
|
30442
30959
|
/**
|
|
30443
30960
|
* Fires after a sub grid is expanded.
|
|
30444
30961
|
* @param {object} event Event object
|
|
30445
|
-
* @param {Grid.view.
|
|
30962
|
+
* @param {Grid.view.GridBase} event.source The firing Grid instance
|
|
30446
30963
|
* @param {Grid.view.SubGrid} event.subGrid The sub grid instance
|
|
30447
30964
|
*/
|
|
30448
|
-
subGridExpand: (event: { source:
|
|
30965
|
+
subGridExpand: (event: { source: GridBase, subGrid: SubGrid }) => void
|
|
30449
30966
|
/**
|
|
30450
30967
|
* Fired when one or more groups are expanded or collapsed
|
|
30451
30968
|
* @param {object} event Event object
|
|
@@ -30538,6 +31055,14 @@ type GridListeners = {
|
|
|
30538
31055
|
* @param {any} event.value The value being set
|
|
30539
31056
|
*/
|
|
30540
31057
|
beforeCellRangeEdit?: ((event: { record: Model, field: string, value: any }) => Promise<boolean>|boolean|void)|string
|
|
31058
|
+
/**
|
|
31059
|
+
* This event is triggered before a parent column is collapsed or expanded.
|
|
31060
|
+
* @param {object} event Event object
|
|
31061
|
+
* @param {Grid.view.GridBase} event.source The grid instance
|
|
31062
|
+
* @param {Grid.column.Column} event.column The column
|
|
31063
|
+
* @param {boolean} event.collapsed `true` if the column is being collapsed, `false` if expanded
|
|
31064
|
+
*/
|
|
31065
|
+
beforeColumnCollapseToggle?: ((event: { source: GridBase, column: Column, collapsed: boolean }) => void)|string
|
|
30541
31066
|
/**
|
|
30542
31067
|
* This event is fired prior to starting a column drag gesture. The drag is canceled if a listener returns `false`.
|
|
30543
31068
|
* @param {object} event Event object
|
|
@@ -30638,18 +31163,18 @@ type GridListeners = {
|
|
|
30638
31163
|
/**
|
|
30639
31164
|
* Fires before a row is rendered.
|
|
30640
31165
|
* @param {object} event Event object
|
|
30641
|
-
* @param {Grid.view.
|
|
30642
|
-
* @param {Grid.row.Row} event.row The row about to be rendered
|
|
30643
|
-
* @param {Core.data.Model} event.record The record for the row
|
|
30644
|
-
* @param {number} event.recordIndex The zero-based index of the record
|
|
31166
|
+
* @param {Grid.view.GridBase} event.source The firing Grid instance
|
|
31167
|
+
* @param {Grid.row.Row} event.row The row about to be rendered
|
|
31168
|
+
* @param {Core.data.Model} event.record The record for the row
|
|
31169
|
+
* @param {number} event.recordIndex The zero-based index of the record
|
|
30645
31170
|
*/
|
|
30646
|
-
beforeRenderRow?: ((event: { source:
|
|
31171
|
+
beforeRenderRow?: ((event: { source: GridBase, row: Row, record: Model, recordIndex: number }) => void)|string
|
|
30647
31172
|
/**
|
|
30648
31173
|
* Grid rows are about to be rendered
|
|
30649
31174
|
* @param {object} event Event object
|
|
30650
|
-
* @param {Grid.view.
|
|
31175
|
+
* @param {Grid.view.GridBase} event.source This grid.
|
|
30651
31176
|
*/
|
|
30652
|
-
beforeRenderRows?: ((event: { source:
|
|
31177
|
+
beforeRenderRows?: ((event: { source: GridBase }) => void)|string
|
|
30653
31178
|
/**
|
|
30654
31179
|
* This event fires before row collapse is started.
|
|
30655
31180
|
* ...
|
|
@@ -30880,6 +31405,14 @@ type GridListeners = {
|
|
|
30880
31405
|
* @param {Core.data.Model} event.record The record which has been collapsed.
|
|
30881
31406
|
*/
|
|
30882
31407
|
collapseNode?: ((event: { source: Grid, record: Model }) => void)|string
|
|
31408
|
+
/**
|
|
31409
|
+
* This event is triggered after a parent column has been collapsed or expanded.
|
|
31410
|
+
* @param {object} event Event object
|
|
31411
|
+
* @param {Grid.view.GridBase} event.source The Grid instance
|
|
31412
|
+
* @param {Grid.column.Column} event.column The column being toggled
|
|
31413
|
+
* @param {boolean} event.collapsed `true` if the column is now collapsed, `false` if expanded
|
|
31414
|
+
*/
|
|
31415
|
+
columnCollapseToggle?: ((event: { source: GridBase, column: Column, collapsed: boolean }) => void)|string
|
|
30883
31416
|
/**
|
|
30884
31417
|
* This event is fired when a column is being dragged, and you can set the `valid` flag on the `context` object
|
|
30885
31418
|
* to indicate whether the drop position is valid or not.
|
|
@@ -30961,14 +31494,14 @@ type GridListeners = {
|
|
|
30961
31494
|
* ...
|
|
30962
31495
|
* [View online docs...](https://bryntum.com/products/grid/docs/api/Grid/view/Grid#event-dataChange)
|
|
30963
31496
|
* @param {object} event Event object
|
|
30964
|
-
* @param {Grid.view.
|
|
31497
|
+
* @param {Grid.view.GridBase} event.source Owning grid
|
|
30965
31498
|
* @param {Core.data.Store} event.store The originating store
|
|
30966
31499
|
* @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'`
|
|
30967
31500
|
* @param {Core.data.Model} event.record Changed record, for actions that affects exactly one record (`'update'`)
|
|
30968
31501
|
* @param {Core.data.Model[]} event.records Changed records, passed for all actions except `'removeAll'`
|
|
30969
31502
|
* @param {object} event.changes Passed for the `'update'` action, info on which record fields changed
|
|
30970
31503
|
*/
|
|
30971
|
-
dataChange?: ((event: { source:
|
|
31504
|
+
dataChange?: ((event: { source: GridBase, store: Store, action: 'remove'|'removeAll'|'add'|'clearchanges'|'filter'|'update'|'dataset'|'replace', record: Model, records: Model[], changes: object }) => void)|string
|
|
30972
31505
|
/**
|
|
30973
31506
|
* Fires when an object is destroyed.
|
|
30974
31507
|
* @param {object} event Event object
|
|
@@ -31276,18 +31809,18 @@ type GridListeners = {
|
|
|
31276
31809
|
/**
|
|
31277
31810
|
* Fires after a row is rendered.
|
|
31278
31811
|
* @param {object} event Event object
|
|
31279
|
-
* @param {Grid.view.
|
|
31280
|
-
* @param {Grid.row.Row} event.row The row that has been rendered
|
|
31281
|
-
* @param {Core.data.Model} event.record The record for the row
|
|
31282
|
-
* @param {number} event.recordIndex The zero-based index of the record
|
|
31812
|
+
* @param {Grid.view.GridBase} event.source The firing Grid instance
|
|
31813
|
+
* @param {Grid.row.Row} event.row The row that has been rendered
|
|
31814
|
+
* @param {Core.data.Model} event.record The record for the row
|
|
31815
|
+
* @param {number} event.recordIndex The zero-based index of the record
|
|
31283
31816
|
*/
|
|
31284
|
-
renderRow?: ((event: { source:
|
|
31817
|
+
renderRow?: ((event: { source: GridBase, row: Row, record: Model, recordIndex: number }) => void)|string
|
|
31285
31818
|
/**
|
|
31286
31819
|
* Grid rows have been rendered
|
|
31287
31820
|
* @param {object} event Event object
|
|
31288
|
-
* @param {Grid.view.
|
|
31821
|
+
* @param {Grid.view.GridBase} event.source This grid.
|
|
31289
31822
|
*/
|
|
31290
|
-
renderRows?: ((event: { source:
|
|
31823
|
+
renderRows?: ((event: { source: GridBase }) => void)|string
|
|
31291
31824
|
/**
|
|
31292
31825
|
* 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`*.
|
|
31293
31826
|
* @param {object} event Event object
|
|
@@ -31347,10 +31880,10 @@ type GridListeners = {
|
|
|
31347
31880
|
/**
|
|
31348
31881
|
* Grid has scrolled vertically
|
|
31349
31882
|
* @param {object} event Event object
|
|
31350
|
-
* @param {Grid.view.
|
|
31883
|
+
* @param {Grid.view.GridBase} event.source The firing Grid instance.
|
|
31351
31884
|
* @param {number} event.scrollTop The vertical scroll position.
|
|
31352
31885
|
*/
|
|
31353
|
-
scroll?: ((event: { source:
|
|
31886
|
+
scroll?: ((event: { source: GridBase, scrollTop: number }) => void)|string
|
|
31354
31887
|
/**
|
|
31355
31888
|
* The selection has been changed.
|
|
31356
31889
|
* @param {object} event Event object
|
|
@@ -31438,17 +31971,17 @@ type GridListeners = {
|
|
|
31438
31971
|
/**
|
|
31439
31972
|
* Fires after a sub grid is collapsed.
|
|
31440
31973
|
* @param {object} event Event object
|
|
31441
|
-
* @param {Grid.view.
|
|
31974
|
+
* @param {Grid.view.GridBase} event.source The firing Grid instance
|
|
31442
31975
|
* @param {Grid.view.SubGrid} event.subGrid The sub grid instance
|
|
31443
31976
|
*/
|
|
31444
|
-
subGridCollapse?: ((event: { source:
|
|
31977
|
+
subGridCollapse?: ((event: { source: GridBase, subGrid: SubGrid }) => void)|string
|
|
31445
31978
|
/**
|
|
31446
31979
|
* Fires after a sub grid is expanded.
|
|
31447
31980
|
* @param {object} event Event object
|
|
31448
|
-
* @param {Grid.view.
|
|
31981
|
+
* @param {Grid.view.GridBase} event.source The firing Grid instance
|
|
31449
31982
|
* @param {Grid.view.SubGrid} event.subGrid The sub grid instance
|
|
31450
31983
|
*/
|
|
31451
|
-
subGridExpand?: ((event: { source:
|
|
31984
|
+
subGridExpand?: ((event: { source: GridBase, subGrid: SubGrid }) => void)|string
|
|
31452
31985
|
/**
|
|
31453
31986
|
* Fired when one or more groups are expanded or collapsed
|
|
31454
31987
|
* @param {object} event Event object
|
|
@@ -31485,6 +32018,7 @@ type GridListeners = {
|
|
|
31485
32018
|
}
|
|
31486
32019
|
|
|
31487
32020
|
type GridFeaturesType = {
|
|
32021
|
+
ai: AI
|
|
31488
32022
|
aiFilter: AIFilter
|
|
31489
32023
|
cellCopyPaste: CellCopyPaste
|
|
31490
32024
|
cellEdit: CellEdit
|
|
@@ -31528,6 +32062,7 @@ type GridFeaturesType = {
|
|
|
31528
32062
|
}
|
|
31529
32063
|
|
|
31530
32064
|
type GridFeaturesConfigType = {
|
|
32065
|
+
ai?: string|boolean|AIConfig
|
|
31531
32066
|
aiFilter?: string|boolean|AIFilterConfig
|
|
31532
32067
|
cellCopyPaste?: string|boolean|CellCopyPasteConfig
|
|
31533
32068
|
cellEdit?: string|boolean|CellEditConfig
|
|
@@ -31644,6 +32179,10 @@ type GridConfig = {
|
|
|
31644
32179
|
* [View online docs...](https://bryntum.com/products/grid/docs/api/Grid/view/Grid#config-bodyCls)
|
|
31645
32180
|
*/
|
|
31646
32181
|
bodyCls?: string|object
|
|
32182
|
+
/**
|
|
32183
|
+
* Set `true` to add a border to this container's element.
|
|
32184
|
+
*/
|
|
32185
|
+
border?: boolean
|
|
31647
32186
|
/**
|
|
31648
32187
|
* An object where property names with a truthy value indicate which events should bubble up the ownership
|
|
31649
32188
|
* hierarchy when triggered.
|
|
@@ -31695,7 +32234,7 @@ type GridConfig = {
|
|
|
31695
32234
|
* ...
|
|
31696
32235
|
* [View online docs...](https://bryntum.com/products/grid/docs/api/Grid/view/Grid#config-color)
|
|
31697
32236
|
*/
|
|
31698
|
-
color?:
|
|
32237
|
+
color?: Color
|
|
31699
32238
|
/**
|
|
31700
32239
|
* Programmatic control over which column to start in when used in a grid layout.
|
|
31701
32240
|
*/
|
|
@@ -32376,6 +32915,14 @@ type GridConfig = {
|
|
|
32376
32915
|
* @param {any} event.value The value being set
|
|
32377
32916
|
*/
|
|
32378
32917
|
onBeforeCellRangeEdit?: ((event: { record: Model, field: string, value: any }) => Promise<boolean>|boolean|void)|string
|
|
32918
|
+
/**
|
|
32919
|
+
* This event is triggered before a parent column is collapsed or expanded.
|
|
32920
|
+
* @param {object} event Event object
|
|
32921
|
+
* @param {Grid.view.GridBase} event.source The grid instance
|
|
32922
|
+
* @param {Grid.column.Column} event.column The column
|
|
32923
|
+
* @param {boolean} event.collapsed `true` if the column is being collapsed, `false` if expanded
|
|
32924
|
+
*/
|
|
32925
|
+
onBeforeColumnCollapseToggle?: ((event: { source: GridBase, column: Column, collapsed: boolean }) => void)|string
|
|
32379
32926
|
/**
|
|
32380
32927
|
* This event is fired prior to starting a column drag gesture. The drag is canceled if a listener returns `false`.
|
|
32381
32928
|
* @param {object} event Event object
|
|
@@ -32476,18 +33023,18 @@ type GridConfig = {
|
|
|
32476
33023
|
/**
|
|
32477
33024
|
* Fires before a row is rendered.
|
|
32478
33025
|
* @param {object} event Event object
|
|
32479
|
-
* @param {Grid.view.
|
|
32480
|
-
* @param {Grid.row.Row} event.row The row about to be rendered
|
|
32481
|
-
* @param {Core.data.Model} event.record The record for the row
|
|
32482
|
-
* @param {number} event.recordIndex The zero-based index of the record
|
|
33026
|
+
* @param {Grid.view.GridBase} event.source The firing Grid instance
|
|
33027
|
+
* @param {Grid.row.Row} event.row The row about to be rendered
|
|
33028
|
+
* @param {Core.data.Model} event.record The record for the row
|
|
33029
|
+
* @param {number} event.recordIndex The zero-based index of the record
|
|
32483
33030
|
*/
|
|
32484
|
-
onBeforeRenderRow?: ((event: { source:
|
|
33031
|
+
onBeforeRenderRow?: ((event: { source: GridBase, row: Row, record: Model, recordIndex: number }) => void)|string
|
|
32485
33032
|
/**
|
|
32486
33033
|
* Grid rows are about to be rendered
|
|
32487
33034
|
* @param {object} event Event object
|
|
32488
|
-
* @param {Grid.view.
|
|
33035
|
+
* @param {Grid.view.GridBase} event.source This grid.
|
|
32489
33036
|
*/
|
|
32490
|
-
onBeforeRenderRows?: ((event: { source:
|
|
33037
|
+
onBeforeRenderRows?: ((event: { source: GridBase }) => void)|string
|
|
32491
33038
|
/**
|
|
32492
33039
|
* This event fires before row collapse is started.
|
|
32493
33040
|
* ...
|
|
@@ -32718,6 +33265,14 @@ type GridConfig = {
|
|
|
32718
33265
|
* @param {Core.data.Model} event.record The record which has been collapsed.
|
|
32719
33266
|
*/
|
|
32720
33267
|
onCollapseNode?: ((event: { source: Grid, record: Model }) => void)|string
|
|
33268
|
+
/**
|
|
33269
|
+
* This event is triggered after a parent column has been collapsed or expanded.
|
|
33270
|
+
* @param {object} event Event object
|
|
33271
|
+
* @param {Grid.view.GridBase} event.source The Grid instance
|
|
33272
|
+
* @param {Grid.column.Column} event.column The column being toggled
|
|
33273
|
+
* @param {boolean} event.collapsed `true` if the column is now collapsed, `false` if expanded
|
|
33274
|
+
*/
|
|
33275
|
+
onColumnCollapseToggle?: ((event: { source: GridBase, column: Column, collapsed: boolean }) => void)|string
|
|
32721
33276
|
/**
|
|
32722
33277
|
* This event is fired when a column is being dragged, and you can set the `valid` flag on the `context` object
|
|
32723
33278
|
* to indicate whether the drop position is valid or not.
|
|
@@ -32799,14 +33354,14 @@ type GridConfig = {
|
|
|
32799
33354
|
* ...
|
|
32800
33355
|
* [View online docs...](https://bryntum.com/products/grid/docs/api/Grid/view/Grid#event-dataChange)
|
|
32801
33356
|
* @param {object} event Event object
|
|
32802
|
-
* @param {Grid.view.
|
|
33357
|
+
* @param {Grid.view.GridBase} event.source Owning grid
|
|
32803
33358
|
* @param {Core.data.Store} event.store The originating store
|
|
32804
33359
|
* @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'`
|
|
32805
33360
|
* @param {Core.data.Model} event.record Changed record, for actions that affects exactly one record (`'update'`)
|
|
32806
33361
|
* @param {Core.data.Model[]} event.records Changed records, passed for all actions except `'removeAll'`
|
|
32807
33362
|
* @param {object} event.changes Passed for the `'update'` action, info on which record fields changed
|
|
32808
33363
|
*/
|
|
32809
|
-
onDataChange?: ((event: { source:
|
|
33364
|
+
onDataChange?: ((event: { source: GridBase, store: Store, action: 'remove'|'removeAll'|'add'|'clearchanges'|'filter'|'update'|'dataset'|'replace', record: Model, records: Model[], changes: object }) => void)|string
|
|
32810
33365
|
/**
|
|
32811
33366
|
* Fires when an object is destroyed.
|
|
32812
33367
|
* @param {object} event Event object
|
|
@@ -33114,18 +33669,18 @@ type GridConfig = {
|
|
|
33114
33669
|
/**
|
|
33115
33670
|
* Fires after a row is rendered.
|
|
33116
33671
|
* @param {object} event Event object
|
|
33117
|
-
* @param {Grid.view.
|
|
33118
|
-
* @param {Grid.row.Row} event.row The row that has been rendered
|
|
33119
|
-
* @param {Core.data.Model} event.record The record for the row
|
|
33120
|
-
* @param {number} event.recordIndex The zero-based index of the record
|
|
33672
|
+
* @param {Grid.view.GridBase} event.source The firing Grid instance
|
|
33673
|
+
* @param {Grid.row.Row} event.row The row that has been rendered
|
|
33674
|
+
* @param {Core.data.Model} event.record The record for the row
|
|
33675
|
+
* @param {number} event.recordIndex The zero-based index of the record
|
|
33121
33676
|
*/
|
|
33122
|
-
onRenderRow?: ((event: { source:
|
|
33677
|
+
onRenderRow?: ((event: { source: GridBase, row: Row, record: Model, recordIndex: number }) => void)|string
|
|
33123
33678
|
/**
|
|
33124
33679
|
* Grid rows have been rendered
|
|
33125
33680
|
* @param {object} event Event object
|
|
33126
|
-
* @param {Grid.view.
|
|
33681
|
+
* @param {Grid.view.GridBase} event.source This grid.
|
|
33127
33682
|
*/
|
|
33128
|
-
onRenderRows?: ((event: { source:
|
|
33683
|
+
onRenderRows?: ((event: { source: GridBase }) => void)|string
|
|
33129
33684
|
/**
|
|
33130
33685
|
* 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`*.
|
|
33131
33686
|
* @param {object} event Event object
|
|
@@ -33185,10 +33740,10 @@ type GridConfig = {
|
|
|
33185
33740
|
/**
|
|
33186
33741
|
* Grid has scrolled vertically
|
|
33187
33742
|
* @param {object} event Event object
|
|
33188
|
-
* @param {Grid.view.
|
|
33743
|
+
* @param {Grid.view.GridBase} event.source The firing Grid instance.
|
|
33189
33744
|
* @param {number} event.scrollTop The vertical scroll position.
|
|
33190
33745
|
*/
|
|
33191
|
-
onScroll?: ((event: { source:
|
|
33746
|
+
onScroll?: ((event: { source: GridBase, scrollTop: number }) => void)|string
|
|
33192
33747
|
/**
|
|
33193
33748
|
* The selection has been changed.
|
|
33194
33749
|
* @param {object} event Event object
|
|
@@ -33276,17 +33831,17 @@ type GridConfig = {
|
|
|
33276
33831
|
/**
|
|
33277
33832
|
* Fires after a sub grid is collapsed.
|
|
33278
33833
|
* @param {object} event Event object
|
|
33279
|
-
* @param {Grid.view.
|
|
33834
|
+
* @param {Grid.view.GridBase} event.source The firing Grid instance
|
|
33280
33835
|
* @param {Grid.view.SubGrid} event.subGrid The sub grid instance
|
|
33281
33836
|
*/
|
|
33282
|
-
onSubGridCollapse?: ((event: { source:
|
|
33837
|
+
onSubGridCollapse?: ((event: { source: GridBase, subGrid: SubGrid }) => void)|string
|
|
33283
33838
|
/**
|
|
33284
33839
|
* Fires after a sub grid is expanded.
|
|
33285
33840
|
* @param {object} event Event object
|
|
33286
|
-
* @param {Grid.view.
|
|
33841
|
+
* @param {Grid.view.GridBase} event.source The firing Grid instance
|
|
33287
33842
|
* @param {Grid.view.SubGrid} event.subGrid The sub grid instance
|
|
33288
33843
|
*/
|
|
33289
|
-
onSubGridExpand?: ((event: { source:
|
|
33844
|
+
onSubGridExpand?: ((event: { source: GridBase, subGrid: SubGrid }) => void)|string
|
|
33290
33845
|
/**
|
|
33291
33846
|
* Fired when one or more groups are expanded or collapsed
|
|
33292
33847
|
* @param {object} event Event object
|
|
@@ -33598,6 +34153,14 @@ type GridBaseListenersTypes = {
|
|
|
33598
34153
|
* @param {any} event.value The value being set
|
|
33599
34154
|
*/
|
|
33600
34155
|
beforeCellRangeEdit: (event: { record: Model, field: string, value: any }) => Promise<boolean>|boolean|void
|
|
34156
|
+
/**
|
|
34157
|
+
* This event is triggered before a parent column is collapsed or expanded.
|
|
34158
|
+
* @param {object} event Event object
|
|
34159
|
+
* @param {Grid.view.GridBase} event.source The grid instance
|
|
34160
|
+
* @param {Grid.column.Column} event.column The column
|
|
34161
|
+
* @param {boolean} event.collapsed `true` if the column is being collapsed, `false` if expanded
|
|
34162
|
+
*/
|
|
34163
|
+
beforeColumnCollapseToggle: (event: { source: GridBase, column: Column, collapsed: boolean }) => void
|
|
33601
34164
|
/**
|
|
33602
34165
|
* This event is fired prior to starting a column drag gesture. The drag is canceled if a listener returns `false`.
|
|
33603
34166
|
* @param {object} event Event object
|
|
@@ -33698,18 +34261,18 @@ type GridBaseListenersTypes = {
|
|
|
33698
34261
|
/**
|
|
33699
34262
|
* Fires before a row is rendered.
|
|
33700
34263
|
* @param {object} event Event object
|
|
33701
|
-
* @param {Grid.view.
|
|
33702
|
-
* @param {Grid.row.Row} event.row The row about to be rendered
|
|
33703
|
-
* @param {Core.data.Model} event.record The record for the row
|
|
33704
|
-
* @param {number} event.recordIndex The zero-based index of the record
|
|
34264
|
+
* @param {Grid.view.GridBase} event.source The firing Grid instance
|
|
34265
|
+
* @param {Grid.row.Row} event.row The row about to be rendered
|
|
34266
|
+
* @param {Core.data.Model} event.record The record for the row
|
|
34267
|
+
* @param {number} event.recordIndex The zero-based index of the record
|
|
33705
34268
|
*/
|
|
33706
|
-
beforeRenderRow: (event: { source:
|
|
34269
|
+
beforeRenderRow: (event: { source: GridBase, row: Row, record: Model, recordIndex: number }) => void
|
|
33707
34270
|
/**
|
|
33708
34271
|
* Grid rows are about to be rendered
|
|
33709
34272
|
* @param {object} event Event object
|
|
33710
|
-
* @param {Grid.view.
|
|
34273
|
+
* @param {Grid.view.GridBase} event.source This grid.
|
|
33711
34274
|
*/
|
|
33712
|
-
beforeRenderRows: (event: { source:
|
|
34275
|
+
beforeRenderRows: (event: { source: GridBase }) => void
|
|
33713
34276
|
/**
|
|
33714
34277
|
* This event fires before row collapse is started.
|
|
33715
34278
|
* ...
|
|
@@ -33940,6 +34503,14 @@ type GridBaseListenersTypes = {
|
|
|
33940
34503
|
* @param {Core.data.Model} event.record The record which has been collapsed.
|
|
33941
34504
|
*/
|
|
33942
34505
|
collapseNode: (event: { source: Grid, record: Model }) => void
|
|
34506
|
+
/**
|
|
34507
|
+
* This event is triggered after a parent column has been collapsed or expanded.
|
|
34508
|
+
* @param {object} event Event object
|
|
34509
|
+
* @param {Grid.view.GridBase} event.source The Grid instance
|
|
34510
|
+
* @param {Grid.column.Column} event.column The column being toggled
|
|
34511
|
+
* @param {boolean} event.collapsed `true` if the column is now collapsed, `false` if expanded
|
|
34512
|
+
*/
|
|
34513
|
+
columnCollapseToggle: (event: { source: GridBase, column: Column, collapsed: boolean }) => void
|
|
33943
34514
|
/**
|
|
33944
34515
|
* This event is fired when a column is being dragged, and you can set the `valid` flag on the `context` object
|
|
33945
34516
|
* to indicate whether the drop position is valid or not.
|
|
@@ -34021,14 +34592,14 @@ type GridBaseListenersTypes = {
|
|
|
34021
34592
|
* ...
|
|
34022
34593
|
* [View online docs...](https://bryntum.com/products/grid/docs/api/Grid/view/GridBase#event-dataChange)
|
|
34023
34594
|
* @param {object} event Event object
|
|
34024
|
-
* @param {Grid.view.
|
|
34595
|
+
* @param {Grid.view.GridBase} event.source Owning grid
|
|
34025
34596
|
* @param {Core.data.Store} event.store The originating store
|
|
34026
34597
|
* @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'`
|
|
34027
34598
|
* @param {Core.data.Model} event.record Changed record, for actions that affects exactly one record (`'update'`)
|
|
34028
34599
|
* @param {Core.data.Model[]} event.records Changed records, passed for all actions except `'removeAll'`
|
|
34029
34600
|
* @param {object} event.changes Passed for the `'update'` action, info on which record fields changed
|
|
34030
34601
|
*/
|
|
34031
|
-
dataChange: (event: { source:
|
|
34602
|
+
dataChange: (event: { source: GridBase, store: Store, action: 'remove'|'removeAll'|'add'|'clearchanges'|'filter'|'update'|'dataset'|'replace', record: Model, records: Model[], changes: object }) => void
|
|
34032
34603
|
/**
|
|
34033
34604
|
* Fires when an object is destroyed.
|
|
34034
34605
|
* @param {object} event Event object
|
|
@@ -34336,18 +34907,18 @@ type GridBaseListenersTypes = {
|
|
|
34336
34907
|
/**
|
|
34337
34908
|
* Fires after a row is rendered.
|
|
34338
34909
|
* @param {object} event Event object
|
|
34339
|
-
* @param {Grid.view.
|
|
34340
|
-
* @param {Grid.row.Row} event.row The row that has been rendered
|
|
34341
|
-
* @param {Core.data.Model} event.record The record for the row
|
|
34342
|
-
* @param {number} event.recordIndex The zero-based index of the record
|
|
34910
|
+
* @param {Grid.view.GridBase} event.source The firing Grid instance
|
|
34911
|
+
* @param {Grid.row.Row} event.row The row that has been rendered
|
|
34912
|
+
* @param {Core.data.Model} event.record The record for the row
|
|
34913
|
+
* @param {number} event.recordIndex The zero-based index of the record
|
|
34343
34914
|
*/
|
|
34344
|
-
renderRow: (event: { source:
|
|
34915
|
+
renderRow: (event: { source: GridBase, row: Row, record: Model, recordIndex: number }) => void
|
|
34345
34916
|
/**
|
|
34346
34917
|
* Grid rows have been rendered
|
|
34347
34918
|
* @param {object} event Event object
|
|
34348
|
-
* @param {Grid.view.
|
|
34919
|
+
* @param {Grid.view.GridBase} event.source This grid.
|
|
34349
34920
|
*/
|
|
34350
|
-
renderRows: (event: { source:
|
|
34921
|
+
renderRows: (event: { source: GridBase }) => void
|
|
34351
34922
|
/**
|
|
34352
34923
|
* 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`*.
|
|
34353
34924
|
* @param {object} event Event object
|
|
@@ -34407,10 +34978,10 @@ type GridBaseListenersTypes = {
|
|
|
34407
34978
|
/**
|
|
34408
34979
|
* Grid has scrolled vertically
|
|
34409
34980
|
* @param {object} event Event object
|
|
34410
|
-
* @param {Grid.view.
|
|
34981
|
+
* @param {Grid.view.GridBase} event.source The firing Grid instance.
|
|
34411
34982
|
* @param {number} event.scrollTop The vertical scroll position.
|
|
34412
34983
|
*/
|
|
34413
|
-
scroll: (event: { source:
|
|
34984
|
+
scroll: (event: { source: GridBase, scrollTop: number }) => void
|
|
34414
34985
|
/**
|
|
34415
34986
|
* The selection has been changed.
|
|
34416
34987
|
* @param {object} event Event object
|
|
@@ -34498,17 +35069,17 @@ type GridBaseListenersTypes = {
|
|
|
34498
35069
|
/**
|
|
34499
35070
|
* Fires after a sub grid is collapsed.
|
|
34500
35071
|
* @param {object} event Event object
|
|
34501
|
-
* @param {Grid.view.
|
|
35072
|
+
* @param {Grid.view.GridBase} event.source The firing Grid instance
|
|
34502
35073
|
* @param {Grid.view.SubGrid} event.subGrid The sub grid instance
|
|
34503
35074
|
*/
|
|
34504
|
-
subGridCollapse: (event: { source:
|
|
35075
|
+
subGridCollapse: (event: { source: GridBase, subGrid: SubGrid }) => void
|
|
34505
35076
|
/**
|
|
34506
35077
|
* Fires after a sub grid is expanded.
|
|
34507
35078
|
* @param {object} event Event object
|
|
34508
|
-
* @param {Grid.view.
|
|
35079
|
+
* @param {Grid.view.GridBase} event.source The firing Grid instance
|
|
34509
35080
|
* @param {Grid.view.SubGrid} event.subGrid The sub grid instance
|
|
34510
35081
|
*/
|
|
34511
|
-
subGridExpand: (event: { source:
|
|
35082
|
+
subGridExpand: (event: { source: GridBase, subGrid: SubGrid }) => void
|
|
34512
35083
|
/**
|
|
34513
35084
|
* Fired when one or more groups are expanded or collapsed
|
|
34514
35085
|
* @param {object} event Event object
|
|
@@ -34601,6 +35172,14 @@ type GridBaseListeners = {
|
|
|
34601
35172
|
* @param {any} event.value The value being set
|
|
34602
35173
|
*/
|
|
34603
35174
|
beforeCellRangeEdit?: ((event: { record: Model, field: string, value: any }) => Promise<boolean>|boolean|void)|string
|
|
35175
|
+
/**
|
|
35176
|
+
* This event is triggered before a parent column is collapsed or expanded.
|
|
35177
|
+
* @param {object} event Event object
|
|
35178
|
+
* @param {Grid.view.GridBase} event.source The grid instance
|
|
35179
|
+
* @param {Grid.column.Column} event.column The column
|
|
35180
|
+
* @param {boolean} event.collapsed `true` if the column is being collapsed, `false` if expanded
|
|
35181
|
+
*/
|
|
35182
|
+
beforeColumnCollapseToggle?: ((event: { source: GridBase, column: Column, collapsed: boolean }) => void)|string
|
|
34604
35183
|
/**
|
|
34605
35184
|
* This event is fired prior to starting a column drag gesture. The drag is canceled if a listener returns `false`.
|
|
34606
35185
|
* @param {object} event Event object
|
|
@@ -34701,18 +35280,18 @@ type GridBaseListeners = {
|
|
|
34701
35280
|
/**
|
|
34702
35281
|
* Fires before a row is rendered.
|
|
34703
35282
|
* @param {object} event Event object
|
|
34704
|
-
* @param {Grid.view.
|
|
34705
|
-
* @param {Grid.row.Row} event.row The row about to be rendered
|
|
34706
|
-
* @param {Core.data.Model} event.record The record for the row
|
|
34707
|
-
* @param {number} event.recordIndex The zero-based index of the record
|
|
35283
|
+
* @param {Grid.view.GridBase} event.source The firing Grid instance
|
|
35284
|
+
* @param {Grid.row.Row} event.row The row about to be rendered
|
|
35285
|
+
* @param {Core.data.Model} event.record The record for the row
|
|
35286
|
+
* @param {number} event.recordIndex The zero-based index of the record
|
|
34708
35287
|
*/
|
|
34709
|
-
beforeRenderRow?: ((event: { source:
|
|
35288
|
+
beforeRenderRow?: ((event: { source: GridBase, row: Row, record: Model, recordIndex: number }) => void)|string
|
|
34710
35289
|
/**
|
|
34711
35290
|
* Grid rows are about to be rendered
|
|
34712
35291
|
* @param {object} event Event object
|
|
34713
|
-
* @param {Grid.view.
|
|
35292
|
+
* @param {Grid.view.GridBase} event.source This grid.
|
|
34714
35293
|
*/
|
|
34715
|
-
beforeRenderRows?: ((event: { source:
|
|
35294
|
+
beforeRenderRows?: ((event: { source: GridBase }) => void)|string
|
|
34716
35295
|
/**
|
|
34717
35296
|
* This event fires before row collapse is started.
|
|
34718
35297
|
* ...
|
|
@@ -34943,6 +35522,14 @@ type GridBaseListeners = {
|
|
|
34943
35522
|
* @param {Core.data.Model} event.record The record which has been collapsed.
|
|
34944
35523
|
*/
|
|
34945
35524
|
collapseNode?: ((event: { source: Grid, record: Model }) => void)|string
|
|
35525
|
+
/**
|
|
35526
|
+
* This event is triggered after a parent column has been collapsed or expanded.
|
|
35527
|
+
* @param {object} event Event object
|
|
35528
|
+
* @param {Grid.view.GridBase} event.source The Grid instance
|
|
35529
|
+
* @param {Grid.column.Column} event.column The column being toggled
|
|
35530
|
+
* @param {boolean} event.collapsed `true` if the column is now collapsed, `false` if expanded
|
|
35531
|
+
*/
|
|
35532
|
+
columnCollapseToggle?: ((event: { source: GridBase, column: Column, collapsed: boolean }) => void)|string
|
|
34946
35533
|
/**
|
|
34947
35534
|
* This event is fired when a column is being dragged, and you can set the `valid` flag on the `context` object
|
|
34948
35535
|
* to indicate whether the drop position is valid or not.
|
|
@@ -35024,14 +35611,14 @@ type GridBaseListeners = {
|
|
|
35024
35611
|
* ...
|
|
35025
35612
|
* [View online docs...](https://bryntum.com/products/grid/docs/api/Grid/view/GridBase#event-dataChange)
|
|
35026
35613
|
* @param {object} event Event object
|
|
35027
|
-
* @param {Grid.view.
|
|
35614
|
+
* @param {Grid.view.GridBase} event.source Owning grid
|
|
35028
35615
|
* @param {Core.data.Store} event.store The originating store
|
|
35029
35616
|
* @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'`
|
|
35030
35617
|
* @param {Core.data.Model} event.record Changed record, for actions that affects exactly one record (`'update'`)
|
|
35031
35618
|
* @param {Core.data.Model[]} event.records Changed records, passed for all actions except `'removeAll'`
|
|
35032
35619
|
* @param {object} event.changes Passed for the `'update'` action, info on which record fields changed
|
|
35033
35620
|
*/
|
|
35034
|
-
dataChange?: ((event: { source:
|
|
35621
|
+
dataChange?: ((event: { source: GridBase, store: Store, action: 'remove'|'removeAll'|'add'|'clearchanges'|'filter'|'update'|'dataset'|'replace', record: Model, records: Model[], changes: object }) => void)|string
|
|
35035
35622
|
/**
|
|
35036
35623
|
* Fires when an object is destroyed.
|
|
35037
35624
|
* @param {object} event Event object
|
|
@@ -35339,18 +35926,18 @@ type GridBaseListeners = {
|
|
|
35339
35926
|
/**
|
|
35340
35927
|
* Fires after a row is rendered.
|
|
35341
35928
|
* @param {object} event Event object
|
|
35342
|
-
* @param {Grid.view.
|
|
35343
|
-
* @param {Grid.row.Row} event.row The row that has been rendered
|
|
35344
|
-
* @param {Core.data.Model} event.record The record for the row
|
|
35345
|
-
* @param {number} event.recordIndex The zero-based index of the record
|
|
35929
|
+
* @param {Grid.view.GridBase} event.source The firing Grid instance
|
|
35930
|
+
* @param {Grid.row.Row} event.row The row that has been rendered
|
|
35931
|
+
* @param {Core.data.Model} event.record The record for the row
|
|
35932
|
+
* @param {number} event.recordIndex The zero-based index of the record
|
|
35346
35933
|
*/
|
|
35347
|
-
renderRow?: ((event: { source:
|
|
35934
|
+
renderRow?: ((event: { source: GridBase, row: Row, record: Model, recordIndex: number }) => void)|string
|
|
35348
35935
|
/**
|
|
35349
35936
|
* Grid rows have been rendered
|
|
35350
35937
|
* @param {object} event Event object
|
|
35351
|
-
* @param {Grid.view.
|
|
35938
|
+
* @param {Grid.view.GridBase} event.source This grid.
|
|
35352
35939
|
*/
|
|
35353
|
-
renderRows?: ((event: { source:
|
|
35940
|
+
renderRows?: ((event: { source: GridBase }) => void)|string
|
|
35354
35941
|
/**
|
|
35355
35942
|
* 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`*.
|
|
35356
35943
|
* @param {object} event Event object
|
|
@@ -35410,10 +35997,10 @@ type GridBaseListeners = {
|
|
|
35410
35997
|
/**
|
|
35411
35998
|
* Grid has scrolled vertically
|
|
35412
35999
|
* @param {object} event Event object
|
|
35413
|
-
* @param {Grid.view.
|
|
36000
|
+
* @param {Grid.view.GridBase} event.source The firing Grid instance.
|
|
35414
36001
|
* @param {number} event.scrollTop The vertical scroll position.
|
|
35415
36002
|
*/
|
|
35416
|
-
scroll?: ((event: { source:
|
|
36003
|
+
scroll?: ((event: { source: GridBase, scrollTop: number }) => void)|string
|
|
35417
36004
|
/**
|
|
35418
36005
|
* The selection has been changed.
|
|
35419
36006
|
* @param {object} event Event object
|
|
@@ -35501,17 +36088,17 @@ type GridBaseListeners = {
|
|
|
35501
36088
|
/**
|
|
35502
36089
|
* Fires after a sub grid is collapsed.
|
|
35503
36090
|
* @param {object} event Event object
|
|
35504
|
-
* @param {Grid.view.
|
|
36091
|
+
* @param {Grid.view.GridBase} event.source The firing Grid instance
|
|
35505
36092
|
* @param {Grid.view.SubGrid} event.subGrid The sub grid instance
|
|
35506
36093
|
*/
|
|
35507
|
-
subGridCollapse?: ((event: { source:
|
|
36094
|
+
subGridCollapse?: ((event: { source: GridBase, subGrid: SubGrid }) => void)|string
|
|
35508
36095
|
/**
|
|
35509
36096
|
* Fires after a sub grid is expanded.
|
|
35510
36097
|
* @param {object} event Event object
|
|
35511
|
-
* @param {Grid.view.
|
|
36098
|
+
* @param {Grid.view.GridBase} event.source The firing Grid instance
|
|
35512
36099
|
* @param {Grid.view.SubGrid} event.subGrid The sub grid instance
|
|
35513
36100
|
*/
|
|
35514
|
-
subGridExpand?: ((event: { source:
|
|
36101
|
+
subGridExpand?: ((event: { source: GridBase, subGrid: SubGrid }) => void)|string
|
|
35515
36102
|
/**
|
|
35516
36103
|
* Fired when one or more groups are expanded or collapsed
|
|
35517
36104
|
* @param {object} event Event object
|
|
@@ -35548,6 +36135,7 @@ type GridBaseListeners = {
|
|
|
35548
36135
|
}
|
|
35549
36136
|
|
|
35550
36137
|
type GridBaseFeaturesType = {
|
|
36138
|
+
ai: AI
|
|
35551
36139
|
aiFilter: AIFilter
|
|
35552
36140
|
cellCopyPaste: CellCopyPaste
|
|
35553
36141
|
cellEdit: CellEdit
|
|
@@ -35591,6 +36179,7 @@ type GridBaseFeaturesType = {
|
|
|
35591
36179
|
}
|
|
35592
36180
|
|
|
35593
36181
|
type GridBaseFeaturesConfigType = {
|
|
36182
|
+
ai?: string|boolean|AIConfig
|
|
35594
36183
|
aiFilter?: string|boolean|AIFilterConfig
|
|
35595
36184
|
cellCopyPaste?: string|boolean|CellCopyPasteConfig
|
|
35596
36185
|
cellEdit?: string|boolean|CellEditConfig
|
|
@@ -35706,6 +36295,10 @@ type GridBaseConfig = {
|
|
|
35706
36295
|
* [View online docs...](https://bryntum.com/products/grid/docs/api/Grid/view/GridBase#config-bodyCls)
|
|
35707
36296
|
*/
|
|
35708
36297
|
bodyCls?: string|object
|
|
36298
|
+
/**
|
|
36299
|
+
* Set `true` to add a border to this container's element.
|
|
36300
|
+
*/
|
|
36301
|
+
border?: boolean
|
|
35709
36302
|
/**
|
|
35710
36303
|
* An object where property names with a truthy value indicate which events should bubble up the ownership
|
|
35711
36304
|
* hierarchy when triggered.
|
|
@@ -35757,7 +36350,7 @@ type GridBaseConfig = {
|
|
|
35757
36350
|
* ...
|
|
35758
36351
|
* [View online docs...](https://bryntum.com/products/grid/docs/api/Grid/view/GridBase#config-color)
|
|
35759
36352
|
*/
|
|
35760
|
-
color?:
|
|
36353
|
+
color?: Color
|
|
35761
36354
|
/**
|
|
35762
36355
|
* Programmatic control over which column to start in when used in a grid layout.
|
|
35763
36356
|
*/
|
|
@@ -36438,6 +37031,14 @@ type GridBaseConfig = {
|
|
|
36438
37031
|
* @param {any} event.value The value being set
|
|
36439
37032
|
*/
|
|
36440
37033
|
onBeforeCellRangeEdit?: ((event: { record: Model, field: string, value: any }) => Promise<boolean>|boolean|void)|string
|
|
37034
|
+
/**
|
|
37035
|
+
* This event is triggered before a parent column is collapsed or expanded.
|
|
37036
|
+
* @param {object} event Event object
|
|
37037
|
+
* @param {Grid.view.GridBase} event.source The grid instance
|
|
37038
|
+
* @param {Grid.column.Column} event.column The column
|
|
37039
|
+
* @param {boolean} event.collapsed `true` if the column is being collapsed, `false` if expanded
|
|
37040
|
+
*/
|
|
37041
|
+
onBeforeColumnCollapseToggle?: ((event: { source: GridBase, column: Column, collapsed: boolean }) => void)|string
|
|
36441
37042
|
/**
|
|
36442
37043
|
* This event is fired prior to starting a column drag gesture. The drag is canceled if a listener returns `false`.
|
|
36443
37044
|
* @param {object} event Event object
|
|
@@ -36538,18 +37139,18 @@ type GridBaseConfig = {
|
|
|
36538
37139
|
/**
|
|
36539
37140
|
* Fires before a row is rendered.
|
|
36540
37141
|
* @param {object} event Event object
|
|
36541
|
-
* @param {Grid.view.
|
|
36542
|
-
* @param {Grid.row.Row} event.row The row about to be rendered
|
|
36543
|
-
* @param {Core.data.Model} event.record The record for the row
|
|
36544
|
-
* @param {number} event.recordIndex The zero-based index of the record
|
|
37142
|
+
* @param {Grid.view.GridBase} event.source The firing Grid instance
|
|
37143
|
+
* @param {Grid.row.Row} event.row The row about to be rendered
|
|
37144
|
+
* @param {Core.data.Model} event.record The record for the row
|
|
37145
|
+
* @param {number} event.recordIndex The zero-based index of the record
|
|
36545
37146
|
*/
|
|
36546
|
-
onBeforeRenderRow?: ((event: { source:
|
|
37147
|
+
onBeforeRenderRow?: ((event: { source: GridBase, row: Row, record: Model, recordIndex: number }) => void)|string
|
|
36547
37148
|
/**
|
|
36548
37149
|
* Grid rows are about to be rendered
|
|
36549
37150
|
* @param {object} event Event object
|
|
36550
|
-
* @param {Grid.view.
|
|
37151
|
+
* @param {Grid.view.GridBase} event.source This grid.
|
|
36551
37152
|
*/
|
|
36552
|
-
onBeforeRenderRows?: ((event: { source:
|
|
37153
|
+
onBeforeRenderRows?: ((event: { source: GridBase }) => void)|string
|
|
36553
37154
|
/**
|
|
36554
37155
|
* This event fires before row collapse is started.
|
|
36555
37156
|
* ...
|
|
@@ -36780,6 +37381,14 @@ type GridBaseConfig = {
|
|
|
36780
37381
|
* @param {Core.data.Model} event.record The record which has been collapsed.
|
|
36781
37382
|
*/
|
|
36782
37383
|
onCollapseNode?: ((event: { source: Grid, record: Model }) => void)|string
|
|
37384
|
+
/**
|
|
37385
|
+
* This event is triggered after a parent column has been collapsed or expanded.
|
|
37386
|
+
* @param {object} event Event object
|
|
37387
|
+
* @param {Grid.view.GridBase} event.source The Grid instance
|
|
37388
|
+
* @param {Grid.column.Column} event.column The column being toggled
|
|
37389
|
+
* @param {boolean} event.collapsed `true` if the column is now collapsed, `false` if expanded
|
|
37390
|
+
*/
|
|
37391
|
+
onColumnCollapseToggle?: ((event: { source: GridBase, column: Column, collapsed: boolean }) => void)|string
|
|
36783
37392
|
/**
|
|
36784
37393
|
* This event is fired when a column is being dragged, and you can set the `valid` flag on the `context` object
|
|
36785
37394
|
* to indicate whether the drop position is valid or not.
|
|
@@ -36861,14 +37470,14 @@ type GridBaseConfig = {
|
|
|
36861
37470
|
* ...
|
|
36862
37471
|
* [View online docs...](https://bryntum.com/products/grid/docs/api/Grid/view/GridBase#event-dataChange)
|
|
36863
37472
|
* @param {object} event Event object
|
|
36864
|
-
* @param {Grid.view.
|
|
37473
|
+
* @param {Grid.view.GridBase} event.source Owning grid
|
|
36865
37474
|
* @param {Core.data.Store} event.store The originating store
|
|
36866
37475
|
* @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'`
|
|
36867
37476
|
* @param {Core.data.Model} event.record Changed record, for actions that affects exactly one record (`'update'`)
|
|
36868
37477
|
* @param {Core.data.Model[]} event.records Changed records, passed for all actions except `'removeAll'`
|
|
36869
37478
|
* @param {object} event.changes Passed for the `'update'` action, info on which record fields changed
|
|
36870
37479
|
*/
|
|
36871
|
-
onDataChange?: ((event: { source:
|
|
37480
|
+
onDataChange?: ((event: { source: GridBase, store: Store, action: 'remove'|'removeAll'|'add'|'clearchanges'|'filter'|'update'|'dataset'|'replace', record: Model, records: Model[], changes: object }) => void)|string
|
|
36872
37481
|
/**
|
|
36873
37482
|
* Fires when an object is destroyed.
|
|
36874
37483
|
* @param {object} event Event object
|
|
@@ -37176,18 +37785,18 @@ type GridBaseConfig = {
|
|
|
37176
37785
|
/**
|
|
37177
37786
|
* Fires after a row is rendered.
|
|
37178
37787
|
* @param {object} event Event object
|
|
37179
|
-
* @param {Grid.view.
|
|
37180
|
-
* @param {Grid.row.Row} event.row The row that has been rendered
|
|
37181
|
-
* @param {Core.data.Model} event.record The record for the row
|
|
37182
|
-
* @param {number} event.recordIndex The zero-based index of the record
|
|
37788
|
+
* @param {Grid.view.GridBase} event.source The firing Grid instance
|
|
37789
|
+
* @param {Grid.row.Row} event.row The row that has been rendered
|
|
37790
|
+
* @param {Core.data.Model} event.record The record for the row
|
|
37791
|
+
* @param {number} event.recordIndex The zero-based index of the record
|
|
37183
37792
|
*/
|
|
37184
|
-
onRenderRow?: ((event: { source:
|
|
37793
|
+
onRenderRow?: ((event: { source: GridBase, row: Row, record: Model, recordIndex: number }) => void)|string
|
|
37185
37794
|
/**
|
|
37186
37795
|
* Grid rows have been rendered
|
|
37187
37796
|
* @param {object} event Event object
|
|
37188
|
-
* @param {Grid.view.
|
|
37797
|
+
* @param {Grid.view.GridBase} event.source This grid.
|
|
37189
37798
|
*/
|
|
37190
|
-
onRenderRows?: ((event: { source:
|
|
37799
|
+
onRenderRows?: ((event: { source: GridBase }) => void)|string
|
|
37191
37800
|
/**
|
|
37192
37801
|
* 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`*.
|
|
37193
37802
|
* @param {object} event Event object
|
|
@@ -37247,10 +37856,10 @@ type GridBaseConfig = {
|
|
|
37247
37856
|
/**
|
|
37248
37857
|
* Grid has scrolled vertically
|
|
37249
37858
|
* @param {object} event Event object
|
|
37250
|
-
* @param {Grid.view.
|
|
37859
|
+
* @param {Grid.view.GridBase} event.source The firing Grid instance.
|
|
37251
37860
|
* @param {number} event.scrollTop The vertical scroll position.
|
|
37252
37861
|
*/
|
|
37253
|
-
onScroll?: ((event: { source:
|
|
37862
|
+
onScroll?: ((event: { source: GridBase, scrollTop: number }) => void)|string
|
|
37254
37863
|
/**
|
|
37255
37864
|
* The selection has been changed.
|
|
37256
37865
|
* @param {object} event Event object
|
|
@@ -37338,17 +37947,17 @@ type GridBaseConfig = {
|
|
|
37338
37947
|
/**
|
|
37339
37948
|
* Fires after a sub grid is collapsed.
|
|
37340
37949
|
* @param {object} event Event object
|
|
37341
|
-
* @param {Grid.view.
|
|
37950
|
+
* @param {Grid.view.GridBase} event.source The firing Grid instance
|
|
37342
37951
|
* @param {Grid.view.SubGrid} event.subGrid The sub grid instance
|
|
37343
37952
|
*/
|
|
37344
|
-
onSubGridCollapse?: ((event: { source:
|
|
37953
|
+
onSubGridCollapse?: ((event: { source: GridBase, subGrid: SubGrid }) => void)|string
|
|
37345
37954
|
/**
|
|
37346
37955
|
* Fires after a sub grid is expanded.
|
|
37347
37956
|
* @param {object} event Event object
|
|
37348
|
-
* @param {Grid.view.
|
|
37957
|
+
* @param {Grid.view.GridBase} event.source The firing Grid instance
|
|
37349
37958
|
* @param {Grid.view.SubGrid} event.subGrid The sub grid instance
|
|
37350
37959
|
*/
|
|
37351
|
-
onSubGridExpand?: ((event: { source:
|
|
37960
|
+
onSubGridExpand?: ((event: { source: GridBase, subGrid: SubGrid }) => void)|string
|
|
37352
37961
|
/**
|
|
37353
37962
|
* Fired when one or more groups are expanded or collapsed
|
|
37354
37963
|
* @param {object} event Event object
|
|
@@ -37770,6 +38379,14 @@ export class GridBase extends Panel {
|
|
|
37770
38379
|
* @param {any} event.value The value being set
|
|
37771
38380
|
*/
|
|
37772
38381
|
onBeforeCellRangeEdit: ((event: { record: Model, field: string, value: any }) => Promise<boolean>|boolean|void)|string
|
|
38382
|
+
/**
|
|
38383
|
+
* This event is triggered before a parent column is collapsed or expanded.
|
|
38384
|
+
* @param {object} event Event object
|
|
38385
|
+
* @param {Grid.view.GridBase} event.source The grid instance
|
|
38386
|
+
* @param {Grid.column.Column} event.column The column
|
|
38387
|
+
* @param {boolean} event.collapsed `true` if the column is being collapsed, `false` if expanded
|
|
38388
|
+
*/
|
|
38389
|
+
onBeforeColumnCollapseToggle: ((event: { source: GridBase, column: Column, collapsed: boolean }) => void)|string
|
|
37773
38390
|
/**
|
|
37774
38391
|
* This event is fired prior to starting a column drag gesture. The drag is canceled if a listener returns `false`.
|
|
37775
38392
|
* @param {object} event Event object
|
|
@@ -37864,18 +38481,18 @@ export class GridBase extends Panel {
|
|
|
37864
38481
|
/**
|
|
37865
38482
|
* Fires before a row is rendered.
|
|
37866
38483
|
* @param {object} event Event object
|
|
37867
|
-
* @param {Grid.view.
|
|
37868
|
-
* @param {Grid.row.Row} event.row The row about to be rendered
|
|
37869
|
-
* @param {Core.data.Model} event.record The record for the row
|
|
37870
|
-
* @param {number} event.recordIndex The zero-based index of the record
|
|
38484
|
+
* @param {Grid.view.GridBase} event.source The firing Grid instance
|
|
38485
|
+
* @param {Grid.row.Row} event.row The row about to be rendered
|
|
38486
|
+
* @param {Core.data.Model} event.record The record for the row
|
|
38487
|
+
* @param {number} event.recordIndex The zero-based index of the record
|
|
37871
38488
|
*/
|
|
37872
|
-
onBeforeRenderRow: ((event: { source:
|
|
38489
|
+
onBeforeRenderRow: ((event: { source: GridBase, row: Row, record: Model, recordIndex: number }) => void)|string
|
|
37873
38490
|
/**
|
|
37874
38491
|
* Grid rows are about to be rendered
|
|
37875
38492
|
* @param {object} event Event object
|
|
37876
|
-
* @param {Grid.view.
|
|
38493
|
+
* @param {Grid.view.GridBase} event.source This grid.
|
|
37877
38494
|
*/
|
|
37878
|
-
onBeforeRenderRows: ((event: { source:
|
|
38495
|
+
onBeforeRenderRows: ((event: { source: GridBase }) => void)|string
|
|
37879
38496
|
/**
|
|
37880
38497
|
* This event fires before row collapse is started.
|
|
37881
38498
|
* ...
|
|
@@ -38086,6 +38703,14 @@ export class GridBase extends Panel {
|
|
|
38086
38703
|
* @param {Core.data.Model} event.record The record which has been collapsed.
|
|
38087
38704
|
*/
|
|
38088
38705
|
onCollapseNode: ((event: { source: Grid, record: Model }) => void)|string
|
|
38706
|
+
/**
|
|
38707
|
+
* This event is triggered after a parent column has been collapsed or expanded.
|
|
38708
|
+
* @param {object} event Event object
|
|
38709
|
+
* @param {Grid.view.GridBase} event.source The Grid instance
|
|
38710
|
+
* @param {Grid.column.Column} event.column The column being toggled
|
|
38711
|
+
* @param {boolean} event.collapsed `true` if the column is now collapsed, `false` if expanded
|
|
38712
|
+
*/
|
|
38713
|
+
onColumnCollapseToggle: ((event: { source: GridBase, column: Column, collapsed: boolean }) => void)|string
|
|
38089
38714
|
/**
|
|
38090
38715
|
* This event is fired when a column is being dragged, and you can set the `valid` flag on the `context` object
|
|
38091
38716
|
* to indicate whether the drop position is valid or not.
|
|
@@ -38150,14 +38775,14 @@ export class GridBase extends Panel {
|
|
|
38150
38775
|
* ...
|
|
38151
38776
|
* [View online docs...](https://bryntum.com/products/grid/docs/api/Grid/view/GridBase#event-dataChange)
|
|
38152
38777
|
* @param {object} event Event object
|
|
38153
|
-
* @param {Grid.view.
|
|
38778
|
+
* @param {Grid.view.GridBase} event.source Owning grid
|
|
38154
38779
|
* @param {Core.data.Store} event.store The originating store
|
|
38155
38780
|
* @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'`
|
|
38156
38781
|
* @param {Core.data.Model} event.record Changed record, for actions that affects exactly one record (`'update'`)
|
|
38157
38782
|
* @param {Core.data.Model[]} event.records Changed records, passed for all actions except `'removeAll'`
|
|
38158
38783
|
* @param {object} event.changes Passed for the `'update'` action, info on which record fields changed
|
|
38159
38784
|
*/
|
|
38160
|
-
onDataChange: ((event: { source:
|
|
38785
|
+
onDataChange: ((event: { source: GridBase, store: Store, action: 'remove'|'removeAll'|'add'|'clearchanges'|'filter'|'update'|'dataset'|'replace', record: Model, records: Model[], changes: object }) => void)|string
|
|
38161
38786
|
/**
|
|
38162
38787
|
* Fires when an object is destroyed.
|
|
38163
38788
|
* @param {object} event Event object
|
|
@@ -38395,18 +39020,18 @@ export class GridBase extends Panel {
|
|
|
38395
39020
|
/**
|
|
38396
39021
|
* Fires after a row is rendered.
|
|
38397
39022
|
* @param {object} event Event object
|
|
38398
|
-
* @param {Grid.view.
|
|
38399
|
-
* @param {Grid.row.Row} event.row The row that has been rendered
|
|
38400
|
-
* @param {Core.data.Model} event.record The record for the row
|
|
38401
|
-
* @param {number} event.recordIndex The zero-based index of the record
|
|
39023
|
+
* @param {Grid.view.GridBase} event.source The firing Grid instance
|
|
39024
|
+
* @param {Grid.row.Row} event.row The row that has been rendered
|
|
39025
|
+
* @param {Core.data.Model} event.record The record for the row
|
|
39026
|
+
* @param {number} event.recordIndex The zero-based index of the record
|
|
38402
39027
|
*/
|
|
38403
|
-
onRenderRow: ((event: { source:
|
|
39028
|
+
onRenderRow: ((event: { source: GridBase, row: Row, record: Model, recordIndex: number }) => void)|string
|
|
38404
39029
|
/**
|
|
38405
39030
|
* Grid rows have been rendered
|
|
38406
39031
|
* @param {object} event Event object
|
|
38407
|
-
* @param {Grid.view.
|
|
39032
|
+
* @param {Grid.view.GridBase} event.source This grid.
|
|
38408
39033
|
*/
|
|
38409
|
-
onRenderRows: ((event: { source:
|
|
39034
|
+
onRenderRows: ((event: { source: GridBase }) => void)|string
|
|
38410
39035
|
/**
|
|
38411
39036
|
* Grid resize lead to a new responsive level being applied
|
|
38412
39037
|
* @param {object} event Event object
|
|
@@ -38456,10 +39081,10 @@ export class GridBase extends Panel {
|
|
|
38456
39081
|
/**
|
|
38457
39082
|
* Grid has scrolled vertically
|
|
38458
39083
|
* @param {object} event Event object
|
|
38459
|
-
* @param {Grid.view.
|
|
39084
|
+
* @param {Grid.view.GridBase} event.source The firing Grid instance.
|
|
38460
39085
|
* @param {number} event.scrollTop The vertical scroll position.
|
|
38461
39086
|
*/
|
|
38462
|
-
onScroll: ((event: { source:
|
|
39087
|
+
onScroll: ((event: { source: GridBase, scrollTop: number }) => void)|string
|
|
38463
39088
|
/**
|
|
38464
39089
|
* The selection has been changed.
|
|
38465
39090
|
* @param {object} event Event object
|
|
@@ -38541,17 +39166,17 @@ export class GridBase extends Panel {
|
|
|
38541
39166
|
/**
|
|
38542
39167
|
* Fires after a sub grid is collapsed.
|
|
38543
39168
|
* @param {object} event Event object
|
|
38544
|
-
* @param {Grid.view.
|
|
39169
|
+
* @param {Grid.view.GridBase} event.source The firing Grid instance
|
|
38545
39170
|
* @param {Grid.view.SubGrid} event.subGrid The sub grid instance
|
|
38546
39171
|
*/
|
|
38547
|
-
onSubGridCollapse: ((event: { source:
|
|
39172
|
+
onSubGridCollapse: ((event: { source: GridBase, subGrid: SubGrid }) => void)|string
|
|
38548
39173
|
/**
|
|
38549
39174
|
* Fires after a sub grid is expanded.
|
|
38550
39175
|
* @param {object} event Event object
|
|
38551
|
-
* @param {Grid.view.
|
|
39176
|
+
* @param {Grid.view.GridBase} event.source The firing Grid instance
|
|
38552
39177
|
* @param {Grid.view.SubGrid} event.subGrid The sub grid instance
|
|
38553
39178
|
*/
|
|
38554
|
-
onSubGridExpand: ((event: { source:
|
|
39179
|
+
onSubGridExpand: ((event: { source: GridBase, subGrid: SubGrid }) => void)|string
|
|
38555
39180
|
/**
|
|
38556
39181
|
* Fired when one or more groups are expanded or collapsed
|
|
38557
39182
|
* @param {object} event Event object
|
|
@@ -39471,7 +40096,7 @@ type SubGridConfig = {
|
|
|
39471
40096
|
* ...
|
|
39472
40097
|
* [View online docs...](https://bryntum.com/products/grid/docs/api/Grid/view/SubGrid#config-color)
|
|
39473
40098
|
*/
|
|
39474
|
-
color?:
|
|
40099
|
+
color?: Color
|
|
39475
40100
|
/**
|
|
39476
40101
|
* Programmatic control over which column to start in when used in a grid layout.
|
|
39477
40102
|
*/
|
|
@@ -40073,6 +40698,14 @@ type TreeGridListenersTypes = {
|
|
|
40073
40698
|
* @param {any} event.value The value being set
|
|
40074
40699
|
*/
|
|
40075
40700
|
beforeCellRangeEdit: (event: { record: Model, field: string, value: any }) => Promise<boolean>|boolean|void
|
|
40701
|
+
/**
|
|
40702
|
+
* This event is triggered before a parent column is collapsed or expanded.
|
|
40703
|
+
* @param {object} event Event object
|
|
40704
|
+
* @param {Grid.view.GridBase} event.source The grid instance
|
|
40705
|
+
* @param {Grid.column.Column} event.column The column
|
|
40706
|
+
* @param {boolean} event.collapsed `true` if the column is being collapsed, `false` if expanded
|
|
40707
|
+
*/
|
|
40708
|
+
beforeColumnCollapseToggle: (event: { source: GridBase, column: Column, collapsed: boolean }) => void
|
|
40076
40709
|
/**
|
|
40077
40710
|
* This event is fired prior to starting a column drag gesture. The drag is canceled if a listener returns `false`.
|
|
40078
40711
|
* @param {object} event Event object
|
|
@@ -40173,18 +40806,18 @@ type TreeGridListenersTypes = {
|
|
|
40173
40806
|
/**
|
|
40174
40807
|
* Fires before a row is rendered.
|
|
40175
40808
|
* @param {object} event Event object
|
|
40176
|
-
* @param {Grid.view.
|
|
40177
|
-
* @param {Grid.row.Row} event.row The row about to be rendered
|
|
40178
|
-
* @param {Core.data.Model} event.record The record for the row
|
|
40179
|
-
* @param {number} event.recordIndex The zero-based index of the record
|
|
40809
|
+
* @param {Grid.view.GridBase} event.source The firing Grid instance
|
|
40810
|
+
* @param {Grid.row.Row} event.row The row about to be rendered
|
|
40811
|
+
* @param {Core.data.Model} event.record The record for the row
|
|
40812
|
+
* @param {number} event.recordIndex The zero-based index of the record
|
|
40180
40813
|
*/
|
|
40181
|
-
beforeRenderRow: (event: { source:
|
|
40814
|
+
beforeRenderRow: (event: { source: GridBase, row: Row, record: Model, recordIndex: number }) => void
|
|
40182
40815
|
/**
|
|
40183
40816
|
* Grid rows are about to be rendered
|
|
40184
40817
|
* @param {object} event Event object
|
|
40185
|
-
* @param {Grid.view.
|
|
40818
|
+
* @param {Grid.view.GridBase} event.source This grid.
|
|
40186
40819
|
*/
|
|
40187
|
-
beforeRenderRows: (event: { source:
|
|
40820
|
+
beforeRenderRows: (event: { source: GridBase }) => void
|
|
40188
40821
|
/**
|
|
40189
40822
|
* This event fires before row collapse is started.
|
|
40190
40823
|
* ...
|
|
@@ -40415,6 +41048,14 @@ type TreeGridListenersTypes = {
|
|
|
40415
41048
|
* @param {Core.data.Model} event.record The record which has been collapsed.
|
|
40416
41049
|
*/
|
|
40417
41050
|
collapseNode: (event: { source: Grid, record: Model }) => void
|
|
41051
|
+
/**
|
|
41052
|
+
* This event is triggered after a parent column has been collapsed or expanded.
|
|
41053
|
+
* @param {object} event Event object
|
|
41054
|
+
* @param {Grid.view.GridBase} event.source The Grid instance
|
|
41055
|
+
* @param {Grid.column.Column} event.column The column being toggled
|
|
41056
|
+
* @param {boolean} event.collapsed `true` if the column is now collapsed, `false` if expanded
|
|
41057
|
+
*/
|
|
41058
|
+
columnCollapseToggle: (event: { source: GridBase, column: Column, collapsed: boolean }) => void
|
|
40418
41059
|
/**
|
|
40419
41060
|
* This event is fired when a column is being dragged, and you can set the `valid` flag on the `context` object
|
|
40420
41061
|
* to indicate whether the drop position is valid or not.
|
|
@@ -40496,14 +41137,14 @@ type TreeGridListenersTypes = {
|
|
|
40496
41137
|
* ...
|
|
40497
41138
|
* [View online docs...](https://bryntum.com/products/grid/docs/api/Grid/view/TreeGrid#event-dataChange)
|
|
40498
41139
|
* @param {object} event Event object
|
|
40499
|
-
* @param {Grid.view.
|
|
41140
|
+
* @param {Grid.view.GridBase} event.source Owning grid
|
|
40500
41141
|
* @param {Core.data.Store} event.store The originating store
|
|
40501
41142
|
* @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'`
|
|
40502
41143
|
* @param {Core.data.Model} event.record Changed record, for actions that affects exactly one record (`'update'`)
|
|
40503
41144
|
* @param {Core.data.Model[]} event.records Changed records, passed for all actions except `'removeAll'`
|
|
40504
41145
|
* @param {object} event.changes Passed for the `'update'` action, info on which record fields changed
|
|
40505
41146
|
*/
|
|
40506
|
-
dataChange: (event: { source:
|
|
41147
|
+
dataChange: (event: { source: GridBase, store: Store, action: 'remove'|'removeAll'|'add'|'clearchanges'|'filter'|'update'|'dataset'|'replace', record: Model, records: Model[], changes: object }) => void
|
|
40507
41148
|
/**
|
|
40508
41149
|
* Fires when an object is destroyed.
|
|
40509
41150
|
* @param {object} event Event object
|
|
@@ -40811,18 +41452,18 @@ type TreeGridListenersTypes = {
|
|
|
40811
41452
|
/**
|
|
40812
41453
|
* Fires after a row is rendered.
|
|
40813
41454
|
* @param {object} event Event object
|
|
40814
|
-
* @param {Grid.view.
|
|
40815
|
-
* @param {Grid.row.Row} event.row The row that has been rendered
|
|
40816
|
-
* @param {Core.data.Model} event.record The record for the row
|
|
40817
|
-
* @param {number} event.recordIndex The zero-based index of the record
|
|
41455
|
+
* @param {Grid.view.GridBase} event.source The firing Grid instance
|
|
41456
|
+
* @param {Grid.row.Row} event.row The row that has been rendered
|
|
41457
|
+
* @param {Core.data.Model} event.record The record for the row
|
|
41458
|
+
* @param {number} event.recordIndex The zero-based index of the record
|
|
40818
41459
|
*/
|
|
40819
|
-
renderRow: (event: { source:
|
|
41460
|
+
renderRow: (event: { source: GridBase, row: Row, record: Model, recordIndex: number }) => void
|
|
40820
41461
|
/**
|
|
40821
41462
|
* Grid rows have been rendered
|
|
40822
41463
|
* @param {object} event Event object
|
|
40823
|
-
* @param {Grid.view.
|
|
41464
|
+
* @param {Grid.view.GridBase} event.source This grid.
|
|
40824
41465
|
*/
|
|
40825
|
-
renderRows: (event: { source:
|
|
41466
|
+
renderRows: (event: { source: GridBase }) => void
|
|
40826
41467
|
/**
|
|
40827
41468
|
* 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`*.
|
|
40828
41469
|
* @param {object} event Event object
|
|
@@ -40882,10 +41523,10 @@ type TreeGridListenersTypes = {
|
|
|
40882
41523
|
/**
|
|
40883
41524
|
* Grid has scrolled vertically
|
|
40884
41525
|
* @param {object} event Event object
|
|
40885
|
-
* @param {Grid.view.
|
|
41526
|
+
* @param {Grid.view.GridBase} event.source The firing Grid instance.
|
|
40886
41527
|
* @param {number} event.scrollTop The vertical scroll position.
|
|
40887
41528
|
*/
|
|
40888
|
-
scroll: (event: { source:
|
|
41529
|
+
scroll: (event: { source: GridBase, scrollTop: number }) => void
|
|
40889
41530
|
/**
|
|
40890
41531
|
* The selection has been changed.
|
|
40891
41532
|
* @param {object} event Event object
|
|
@@ -40973,17 +41614,17 @@ type TreeGridListenersTypes = {
|
|
|
40973
41614
|
/**
|
|
40974
41615
|
* Fires after a sub grid is collapsed.
|
|
40975
41616
|
* @param {object} event Event object
|
|
40976
|
-
* @param {Grid.view.
|
|
41617
|
+
* @param {Grid.view.GridBase} event.source The firing Grid instance
|
|
40977
41618
|
* @param {Grid.view.SubGrid} event.subGrid The sub grid instance
|
|
40978
41619
|
*/
|
|
40979
|
-
subGridCollapse: (event: { source:
|
|
41620
|
+
subGridCollapse: (event: { source: GridBase, subGrid: SubGrid }) => void
|
|
40980
41621
|
/**
|
|
40981
41622
|
* Fires after a sub grid is expanded.
|
|
40982
41623
|
* @param {object} event Event object
|
|
40983
|
-
* @param {Grid.view.
|
|
41624
|
+
* @param {Grid.view.GridBase} event.source The firing Grid instance
|
|
40984
41625
|
* @param {Grid.view.SubGrid} event.subGrid The sub grid instance
|
|
40985
41626
|
*/
|
|
40986
|
-
subGridExpand: (event: { source:
|
|
41627
|
+
subGridExpand: (event: { source: GridBase, subGrid: SubGrid }) => void
|
|
40987
41628
|
/**
|
|
40988
41629
|
* Fired when one or more groups are expanded or collapsed
|
|
40989
41630
|
* @param {object} event Event object
|
|
@@ -41076,6 +41717,14 @@ type TreeGridListeners = {
|
|
|
41076
41717
|
* @param {any} event.value The value being set
|
|
41077
41718
|
*/
|
|
41078
41719
|
beforeCellRangeEdit?: ((event: { record: Model, field: string, value: any }) => Promise<boolean>|boolean|void)|string
|
|
41720
|
+
/**
|
|
41721
|
+
* This event is triggered before a parent column is collapsed or expanded.
|
|
41722
|
+
* @param {object} event Event object
|
|
41723
|
+
* @param {Grid.view.GridBase} event.source The grid instance
|
|
41724
|
+
* @param {Grid.column.Column} event.column The column
|
|
41725
|
+
* @param {boolean} event.collapsed `true` if the column is being collapsed, `false` if expanded
|
|
41726
|
+
*/
|
|
41727
|
+
beforeColumnCollapseToggle?: ((event: { source: GridBase, column: Column, collapsed: boolean }) => void)|string
|
|
41079
41728
|
/**
|
|
41080
41729
|
* This event is fired prior to starting a column drag gesture. The drag is canceled if a listener returns `false`.
|
|
41081
41730
|
* @param {object} event Event object
|
|
@@ -41176,18 +41825,18 @@ type TreeGridListeners = {
|
|
|
41176
41825
|
/**
|
|
41177
41826
|
* Fires before a row is rendered.
|
|
41178
41827
|
* @param {object} event Event object
|
|
41179
|
-
* @param {Grid.view.
|
|
41180
|
-
* @param {Grid.row.Row} event.row The row about to be rendered
|
|
41181
|
-
* @param {Core.data.Model} event.record The record for the row
|
|
41182
|
-
* @param {number} event.recordIndex The zero-based index of the record
|
|
41828
|
+
* @param {Grid.view.GridBase} event.source The firing Grid instance
|
|
41829
|
+
* @param {Grid.row.Row} event.row The row about to be rendered
|
|
41830
|
+
* @param {Core.data.Model} event.record The record for the row
|
|
41831
|
+
* @param {number} event.recordIndex The zero-based index of the record
|
|
41183
41832
|
*/
|
|
41184
|
-
beforeRenderRow?: ((event: { source:
|
|
41833
|
+
beforeRenderRow?: ((event: { source: GridBase, row: Row, record: Model, recordIndex: number }) => void)|string
|
|
41185
41834
|
/**
|
|
41186
41835
|
* Grid rows are about to be rendered
|
|
41187
41836
|
* @param {object} event Event object
|
|
41188
|
-
* @param {Grid.view.
|
|
41837
|
+
* @param {Grid.view.GridBase} event.source This grid.
|
|
41189
41838
|
*/
|
|
41190
|
-
beforeRenderRows?: ((event: { source:
|
|
41839
|
+
beforeRenderRows?: ((event: { source: GridBase }) => void)|string
|
|
41191
41840
|
/**
|
|
41192
41841
|
* This event fires before row collapse is started.
|
|
41193
41842
|
* ...
|
|
@@ -41418,6 +42067,14 @@ type TreeGridListeners = {
|
|
|
41418
42067
|
* @param {Core.data.Model} event.record The record which has been collapsed.
|
|
41419
42068
|
*/
|
|
41420
42069
|
collapseNode?: ((event: { source: Grid, record: Model }) => void)|string
|
|
42070
|
+
/**
|
|
42071
|
+
* This event is triggered after a parent column has been collapsed or expanded.
|
|
42072
|
+
* @param {object} event Event object
|
|
42073
|
+
* @param {Grid.view.GridBase} event.source The Grid instance
|
|
42074
|
+
* @param {Grid.column.Column} event.column The column being toggled
|
|
42075
|
+
* @param {boolean} event.collapsed `true` if the column is now collapsed, `false` if expanded
|
|
42076
|
+
*/
|
|
42077
|
+
columnCollapseToggle?: ((event: { source: GridBase, column: Column, collapsed: boolean }) => void)|string
|
|
41421
42078
|
/**
|
|
41422
42079
|
* This event is fired when a column is being dragged, and you can set the `valid` flag on the `context` object
|
|
41423
42080
|
* to indicate whether the drop position is valid or not.
|
|
@@ -41499,14 +42156,14 @@ type TreeGridListeners = {
|
|
|
41499
42156
|
* ...
|
|
41500
42157
|
* [View online docs...](https://bryntum.com/products/grid/docs/api/Grid/view/TreeGrid#event-dataChange)
|
|
41501
42158
|
* @param {object} event Event object
|
|
41502
|
-
* @param {Grid.view.
|
|
42159
|
+
* @param {Grid.view.GridBase} event.source Owning grid
|
|
41503
42160
|
* @param {Core.data.Store} event.store The originating store
|
|
41504
42161
|
* @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'`
|
|
41505
42162
|
* @param {Core.data.Model} event.record Changed record, for actions that affects exactly one record (`'update'`)
|
|
41506
42163
|
* @param {Core.data.Model[]} event.records Changed records, passed for all actions except `'removeAll'`
|
|
41507
42164
|
* @param {object} event.changes Passed for the `'update'` action, info on which record fields changed
|
|
41508
42165
|
*/
|
|
41509
|
-
dataChange?: ((event: { source:
|
|
42166
|
+
dataChange?: ((event: { source: GridBase, store: Store, action: 'remove'|'removeAll'|'add'|'clearchanges'|'filter'|'update'|'dataset'|'replace', record: Model, records: Model[], changes: object }) => void)|string
|
|
41510
42167
|
/**
|
|
41511
42168
|
* Fires when an object is destroyed.
|
|
41512
42169
|
* @param {object} event Event object
|
|
@@ -41814,18 +42471,18 @@ type TreeGridListeners = {
|
|
|
41814
42471
|
/**
|
|
41815
42472
|
* Fires after a row is rendered.
|
|
41816
42473
|
* @param {object} event Event object
|
|
41817
|
-
* @param {Grid.view.
|
|
41818
|
-
* @param {Grid.row.Row} event.row The row that has been rendered
|
|
41819
|
-
* @param {Core.data.Model} event.record The record for the row
|
|
41820
|
-
* @param {number} event.recordIndex The zero-based index of the record
|
|
42474
|
+
* @param {Grid.view.GridBase} event.source The firing Grid instance
|
|
42475
|
+
* @param {Grid.row.Row} event.row The row that has been rendered
|
|
42476
|
+
* @param {Core.data.Model} event.record The record for the row
|
|
42477
|
+
* @param {number} event.recordIndex The zero-based index of the record
|
|
41821
42478
|
*/
|
|
41822
|
-
renderRow?: ((event: { source:
|
|
42479
|
+
renderRow?: ((event: { source: GridBase, row: Row, record: Model, recordIndex: number }) => void)|string
|
|
41823
42480
|
/**
|
|
41824
42481
|
* Grid rows have been rendered
|
|
41825
42482
|
* @param {object} event Event object
|
|
41826
|
-
* @param {Grid.view.
|
|
42483
|
+
* @param {Grid.view.GridBase} event.source This grid.
|
|
41827
42484
|
*/
|
|
41828
|
-
renderRows?: ((event: { source:
|
|
42485
|
+
renderRows?: ((event: { source: GridBase }) => void)|string
|
|
41829
42486
|
/**
|
|
41830
42487
|
* 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`*.
|
|
41831
42488
|
* @param {object} event Event object
|
|
@@ -41885,10 +42542,10 @@ type TreeGridListeners = {
|
|
|
41885
42542
|
/**
|
|
41886
42543
|
* Grid has scrolled vertically
|
|
41887
42544
|
* @param {object} event Event object
|
|
41888
|
-
* @param {Grid.view.
|
|
42545
|
+
* @param {Grid.view.GridBase} event.source The firing Grid instance.
|
|
41889
42546
|
* @param {number} event.scrollTop The vertical scroll position.
|
|
41890
42547
|
*/
|
|
41891
|
-
scroll?: ((event: { source:
|
|
42548
|
+
scroll?: ((event: { source: GridBase, scrollTop: number }) => void)|string
|
|
41892
42549
|
/**
|
|
41893
42550
|
* The selection has been changed.
|
|
41894
42551
|
* @param {object} event Event object
|
|
@@ -41976,17 +42633,17 @@ type TreeGridListeners = {
|
|
|
41976
42633
|
/**
|
|
41977
42634
|
* Fires after a sub grid is collapsed.
|
|
41978
42635
|
* @param {object} event Event object
|
|
41979
|
-
* @param {Grid.view.
|
|
42636
|
+
* @param {Grid.view.GridBase} event.source The firing Grid instance
|
|
41980
42637
|
* @param {Grid.view.SubGrid} event.subGrid The sub grid instance
|
|
41981
42638
|
*/
|
|
41982
|
-
subGridCollapse?: ((event: { source:
|
|
42639
|
+
subGridCollapse?: ((event: { source: GridBase, subGrid: SubGrid }) => void)|string
|
|
41983
42640
|
/**
|
|
41984
42641
|
* Fires after a sub grid is expanded.
|
|
41985
42642
|
* @param {object} event Event object
|
|
41986
|
-
* @param {Grid.view.
|
|
42643
|
+
* @param {Grid.view.GridBase} event.source The firing Grid instance
|
|
41987
42644
|
* @param {Grid.view.SubGrid} event.subGrid The sub grid instance
|
|
41988
42645
|
*/
|
|
41989
|
-
subGridExpand?: ((event: { source:
|
|
42646
|
+
subGridExpand?: ((event: { source: GridBase, subGrid: SubGrid }) => void)|string
|
|
41990
42647
|
/**
|
|
41991
42648
|
* Fired when one or more groups are expanded or collapsed
|
|
41992
42649
|
* @param {object} event Event object
|
|
@@ -42023,6 +42680,7 @@ type TreeGridListeners = {
|
|
|
42023
42680
|
}
|
|
42024
42681
|
|
|
42025
42682
|
type TreeGridFeaturesType = {
|
|
42683
|
+
ai: AI
|
|
42026
42684
|
aiFilter: AIFilter
|
|
42027
42685
|
cellCopyPaste: CellCopyPaste
|
|
42028
42686
|
cellEdit: CellEdit
|
|
@@ -42066,6 +42724,7 @@ type TreeGridFeaturesType = {
|
|
|
42066
42724
|
}
|
|
42067
42725
|
|
|
42068
42726
|
type TreeGridFeaturesConfigType = {
|
|
42727
|
+
ai?: string|boolean|AIConfig
|
|
42069
42728
|
aiFilter?: string|boolean|AIFilterConfig
|
|
42070
42729
|
cellCopyPaste?: string|boolean|CellCopyPasteConfig
|
|
42071
42730
|
cellEdit?: string|boolean|CellEditConfig
|
|
@@ -42182,6 +42841,10 @@ type TreeGridConfig = {
|
|
|
42182
42841
|
* [View online docs...](https://bryntum.com/products/grid/docs/api/Grid/view/TreeGrid#config-bodyCls)
|
|
42183
42842
|
*/
|
|
42184
42843
|
bodyCls?: string|object
|
|
42844
|
+
/**
|
|
42845
|
+
* Set `true` to add a border to this container's element.
|
|
42846
|
+
*/
|
|
42847
|
+
border?: boolean
|
|
42185
42848
|
/**
|
|
42186
42849
|
* An object where property names with a truthy value indicate which events should bubble up the ownership
|
|
42187
42850
|
* hierarchy when triggered.
|
|
@@ -42233,7 +42896,7 @@ type TreeGridConfig = {
|
|
|
42233
42896
|
* ...
|
|
42234
42897
|
* [View online docs...](https://bryntum.com/products/grid/docs/api/Grid/view/TreeGrid#config-color)
|
|
42235
42898
|
*/
|
|
42236
|
-
color?:
|
|
42899
|
+
color?: Color
|
|
42237
42900
|
/**
|
|
42238
42901
|
* Programmatic control over which column to start in when used in a grid layout.
|
|
42239
42902
|
*/
|
|
@@ -42914,6 +43577,14 @@ type TreeGridConfig = {
|
|
|
42914
43577
|
* @param {any} event.value The value being set
|
|
42915
43578
|
*/
|
|
42916
43579
|
onBeforeCellRangeEdit?: ((event: { record: Model, field: string, value: any }) => Promise<boolean>|boolean|void)|string
|
|
43580
|
+
/**
|
|
43581
|
+
* This event is triggered before a parent column is collapsed or expanded.
|
|
43582
|
+
* @param {object} event Event object
|
|
43583
|
+
* @param {Grid.view.GridBase} event.source The grid instance
|
|
43584
|
+
* @param {Grid.column.Column} event.column The column
|
|
43585
|
+
* @param {boolean} event.collapsed `true` if the column is being collapsed, `false` if expanded
|
|
43586
|
+
*/
|
|
43587
|
+
onBeforeColumnCollapseToggle?: ((event: { source: GridBase, column: Column, collapsed: boolean }) => void)|string
|
|
42917
43588
|
/**
|
|
42918
43589
|
* This event is fired prior to starting a column drag gesture. The drag is canceled if a listener returns `false`.
|
|
42919
43590
|
* @param {object} event Event object
|
|
@@ -43014,18 +43685,18 @@ type TreeGridConfig = {
|
|
|
43014
43685
|
/**
|
|
43015
43686
|
* Fires before a row is rendered.
|
|
43016
43687
|
* @param {object} event Event object
|
|
43017
|
-
* @param {Grid.view.
|
|
43018
|
-
* @param {Grid.row.Row} event.row The row about to be rendered
|
|
43019
|
-
* @param {Core.data.Model} event.record The record for the row
|
|
43020
|
-
* @param {number} event.recordIndex The zero-based index of the record
|
|
43688
|
+
* @param {Grid.view.GridBase} event.source The firing Grid instance
|
|
43689
|
+
* @param {Grid.row.Row} event.row The row about to be rendered
|
|
43690
|
+
* @param {Core.data.Model} event.record The record for the row
|
|
43691
|
+
* @param {number} event.recordIndex The zero-based index of the record
|
|
43021
43692
|
*/
|
|
43022
|
-
onBeforeRenderRow?: ((event: { source:
|
|
43693
|
+
onBeforeRenderRow?: ((event: { source: GridBase, row: Row, record: Model, recordIndex: number }) => void)|string
|
|
43023
43694
|
/**
|
|
43024
43695
|
* Grid rows are about to be rendered
|
|
43025
43696
|
* @param {object} event Event object
|
|
43026
|
-
* @param {Grid.view.
|
|
43697
|
+
* @param {Grid.view.GridBase} event.source This grid.
|
|
43027
43698
|
*/
|
|
43028
|
-
onBeforeRenderRows?: ((event: { source:
|
|
43699
|
+
onBeforeRenderRows?: ((event: { source: GridBase }) => void)|string
|
|
43029
43700
|
/**
|
|
43030
43701
|
* This event fires before row collapse is started.
|
|
43031
43702
|
* ...
|
|
@@ -43256,6 +43927,14 @@ type TreeGridConfig = {
|
|
|
43256
43927
|
* @param {Core.data.Model} event.record The record which has been collapsed.
|
|
43257
43928
|
*/
|
|
43258
43929
|
onCollapseNode?: ((event: { source: Grid, record: Model }) => void)|string
|
|
43930
|
+
/**
|
|
43931
|
+
* This event is triggered after a parent column has been collapsed or expanded.
|
|
43932
|
+
* @param {object} event Event object
|
|
43933
|
+
* @param {Grid.view.GridBase} event.source The Grid instance
|
|
43934
|
+
* @param {Grid.column.Column} event.column The column being toggled
|
|
43935
|
+
* @param {boolean} event.collapsed `true` if the column is now collapsed, `false` if expanded
|
|
43936
|
+
*/
|
|
43937
|
+
onColumnCollapseToggle?: ((event: { source: GridBase, column: Column, collapsed: boolean }) => void)|string
|
|
43259
43938
|
/**
|
|
43260
43939
|
* This event is fired when a column is being dragged, and you can set the `valid` flag on the `context` object
|
|
43261
43940
|
* to indicate whether the drop position is valid or not.
|
|
@@ -43337,14 +44016,14 @@ type TreeGridConfig = {
|
|
|
43337
44016
|
* ...
|
|
43338
44017
|
* [View online docs...](https://bryntum.com/products/grid/docs/api/Grid/view/TreeGrid#event-dataChange)
|
|
43339
44018
|
* @param {object} event Event object
|
|
43340
|
-
* @param {Grid.view.
|
|
44019
|
+
* @param {Grid.view.GridBase} event.source Owning grid
|
|
43341
44020
|
* @param {Core.data.Store} event.store The originating store
|
|
43342
44021
|
* @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'`
|
|
43343
44022
|
* @param {Core.data.Model} event.record Changed record, for actions that affects exactly one record (`'update'`)
|
|
43344
44023
|
* @param {Core.data.Model[]} event.records Changed records, passed for all actions except `'removeAll'`
|
|
43345
44024
|
* @param {object} event.changes Passed for the `'update'` action, info on which record fields changed
|
|
43346
44025
|
*/
|
|
43347
|
-
onDataChange?: ((event: { source:
|
|
44026
|
+
onDataChange?: ((event: { source: GridBase, store: Store, action: 'remove'|'removeAll'|'add'|'clearchanges'|'filter'|'update'|'dataset'|'replace', record: Model, records: Model[], changes: object }) => void)|string
|
|
43348
44027
|
/**
|
|
43349
44028
|
* Fires when an object is destroyed.
|
|
43350
44029
|
* @param {object} event Event object
|
|
@@ -43652,18 +44331,18 @@ type TreeGridConfig = {
|
|
|
43652
44331
|
/**
|
|
43653
44332
|
* Fires after a row is rendered.
|
|
43654
44333
|
* @param {object} event Event object
|
|
43655
|
-
* @param {Grid.view.
|
|
43656
|
-
* @param {Grid.row.Row} event.row The row that has been rendered
|
|
43657
|
-
* @param {Core.data.Model} event.record The record for the row
|
|
43658
|
-
* @param {number} event.recordIndex The zero-based index of the record
|
|
44334
|
+
* @param {Grid.view.GridBase} event.source The firing Grid instance
|
|
44335
|
+
* @param {Grid.row.Row} event.row The row that has been rendered
|
|
44336
|
+
* @param {Core.data.Model} event.record The record for the row
|
|
44337
|
+
* @param {number} event.recordIndex The zero-based index of the record
|
|
43659
44338
|
*/
|
|
43660
|
-
onRenderRow?: ((event: { source:
|
|
44339
|
+
onRenderRow?: ((event: { source: GridBase, row: Row, record: Model, recordIndex: number }) => void)|string
|
|
43661
44340
|
/**
|
|
43662
44341
|
* Grid rows have been rendered
|
|
43663
44342
|
* @param {object} event Event object
|
|
43664
|
-
* @param {Grid.view.
|
|
44343
|
+
* @param {Grid.view.GridBase} event.source This grid.
|
|
43665
44344
|
*/
|
|
43666
|
-
onRenderRows?: ((event: { source:
|
|
44345
|
+
onRenderRows?: ((event: { source: GridBase }) => void)|string
|
|
43667
44346
|
/**
|
|
43668
44347
|
* 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`*.
|
|
43669
44348
|
* @param {object} event Event object
|
|
@@ -43723,10 +44402,10 @@ type TreeGridConfig = {
|
|
|
43723
44402
|
/**
|
|
43724
44403
|
* Grid has scrolled vertically
|
|
43725
44404
|
* @param {object} event Event object
|
|
43726
|
-
* @param {Grid.view.
|
|
44405
|
+
* @param {Grid.view.GridBase} event.source The firing Grid instance.
|
|
43727
44406
|
* @param {number} event.scrollTop The vertical scroll position.
|
|
43728
44407
|
*/
|
|
43729
|
-
onScroll?: ((event: { source:
|
|
44408
|
+
onScroll?: ((event: { source: GridBase, scrollTop: number }) => void)|string
|
|
43730
44409
|
/**
|
|
43731
44410
|
* The selection has been changed.
|
|
43732
44411
|
* @param {object} event Event object
|
|
@@ -43814,17 +44493,17 @@ type TreeGridConfig = {
|
|
|
43814
44493
|
/**
|
|
43815
44494
|
* Fires after a sub grid is collapsed.
|
|
43816
44495
|
* @param {object} event Event object
|
|
43817
|
-
* @param {Grid.view.
|
|
44496
|
+
* @param {Grid.view.GridBase} event.source The firing Grid instance
|
|
43818
44497
|
* @param {Grid.view.SubGrid} event.subGrid The sub grid instance
|
|
43819
44498
|
*/
|
|
43820
|
-
onSubGridCollapse?: ((event: { source:
|
|
44499
|
+
onSubGridCollapse?: ((event: { source: GridBase, subGrid: SubGrid }) => void)|string
|
|
43821
44500
|
/**
|
|
43822
44501
|
* Fires after a sub grid is expanded.
|
|
43823
44502
|
* @param {object} event Event object
|
|
43824
|
-
* @param {Grid.view.
|
|
44503
|
+
* @param {Grid.view.GridBase} event.source The firing Grid instance
|
|
43825
44504
|
* @param {Grid.view.SubGrid} event.subGrid The sub grid instance
|
|
43826
44505
|
*/
|
|
43827
|
-
onSubGridExpand?: ((event: { source:
|
|
44506
|
+
onSubGridExpand?: ((event: { source: GridBase, subGrid: SubGrid }) => void)|string
|
|
43828
44507
|
/**
|
|
43829
44508
|
* Fired when one or more groups are expanded or collapsed
|
|
43830
44509
|
* @param {object} event Event object
|
|
@@ -44545,6 +45224,10 @@ type ExportDialogConfig = {
|
|
|
44545
45224
|
* [View online docs...](https://bryntum.com/products/grid/docs/api/Grid/view/export/ExportDialog#config-bodyCls)
|
|
44546
45225
|
*/
|
|
44547
45226
|
bodyCls?: string|object
|
|
45227
|
+
/**
|
|
45228
|
+
* Set `true` to add a border to this container's element.
|
|
45229
|
+
*/
|
|
45230
|
+
border?: boolean
|
|
44548
45231
|
/**
|
|
44549
45232
|
* An object where property names with a truthy value indicate which events should bubble up the ownership
|
|
44550
45233
|
* hierarchy when triggered.
|
|
@@ -44617,7 +45300,7 @@ type ExportDialogConfig = {
|
|
|
44617
45300
|
* ...
|
|
44618
45301
|
* [View online docs...](https://bryntum.com/products/grid/docs/api/Grid/view/export/ExportDialog#config-color)
|
|
44619
45302
|
*/
|
|
44620
|
-
color?:
|
|
45303
|
+
color?: Color
|
|
44621
45304
|
/**
|
|
44622
45305
|
* Programmatic control over which column to start in when used in a grid layout.
|
|
44623
45306
|
*/
|
|
@@ -46645,7 +47328,7 @@ type AIFilterFieldConfig = {
|
|
|
46645
47328
|
* ...
|
|
46646
47329
|
* [View online docs...](https://bryntum.com/products/grid/docs/api/Grid/widget/AIFilterField#config-color)
|
|
46647
47330
|
*/
|
|
46648
|
-
color?:
|
|
47331
|
+
color?: Color
|
|
46649
47332
|
/**
|
|
46650
47333
|
* Programmatic control over which column to start in when used in a grid layout.
|
|
46651
47334
|
*/
|
|
@@ -47862,7 +48545,7 @@ type ChecklistFilterComboConfig = {
|
|
|
47862
48545
|
* ...
|
|
47863
48546
|
* [View online docs...](https://bryntum.com/products/grid/docs/api/Grid/widget/ChecklistFilterCombo#config-color)
|
|
47864
48547
|
*/
|
|
47865
|
-
color?:
|
|
48548
|
+
color?: Color
|
|
47866
48549
|
/**
|
|
47867
48550
|
* Programmatic control over which column to start in when used in a grid layout.
|
|
47868
48551
|
*/
|
|
@@ -49109,7 +49792,7 @@ type GridChartDesignerConfig = {
|
|
|
49109
49792
|
* ...
|
|
49110
49793
|
* [View online docs...](https://bryntum.com/products/grid/docs/api/Grid/widget/GridChartDesigner#config-color)
|
|
49111
49794
|
*/
|
|
49112
|
-
color?:
|
|
49795
|
+
color?: Color
|
|
49113
49796
|
/**
|
|
49114
49797
|
* Programmatic control over which column to start in when used in a grid layout.
|
|
49115
49798
|
*/
|
|
@@ -49979,6 +50662,10 @@ type GridFieldFilterPickerConfig = {
|
|
|
49979
50662
|
* Update assigned [record](https://bryntum.com/products/grid/docs/api/Core/widget/Container#config-record) automatically on field changes
|
|
49980
50663
|
*/
|
|
49981
50664
|
autoUpdateRecord?: boolean
|
|
50665
|
+
/**
|
|
50666
|
+
* Set `true` to add a border to this container's element.
|
|
50667
|
+
*/
|
|
50668
|
+
border?: boolean
|
|
49982
50669
|
/**
|
|
49983
50670
|
* An object where property names with a truthy value indicate which events should bubble up the ownership
|
|
49984
50671
|
* hierarchy when triggered.
|
|
@@ -50018,7 +50705,7 @@ type GridFieldFilterPickerConfig = {
|
|
|
50018
50705
|
* ...
|
|
50019
50706
|
* [View online docs...](https://bryntum.com/products/grid/docs/api/Grid/widget/GridFieldFilterPicker#config-color)
|
|
50020
50707
|
*/
|
|
50021
|
-
color?:
|
|
50708
|
+
color?: Color
|
|
50022
50709
|
/**
|
|
50023
50710
|
* Programmatic control over which column to start in when used in a grid layout.
|
|
50024
50711
|
*/
|
|
@@ -51087,6 +51774,10 @@ type GridFieldFilterPickerGroupConfig = {
|
|
|
51087
51774
|
* Update assigned [record](https://bryntum.com/products/grid/docs/api/Core/widget/Container#config-record) automatically on field changes
|
|
51088
51775
|
*/
|
|
51089
51776
|
autoUpdateRecord?: boolean
|
|
51777
|
+
/**
|
|
51778
|
+
* Set `true` to add a border to this container's element.
|
|
51779
|
+
*/
|
|
51780
|
+
border?: boolean
|
|
51090
51781
|
/**
|
|
51091
51782
|
* An object where property names with a truthy value indicate which events should bubble up the ownership
|
|
51092
51783
|
* hierarchy when triggered.
|
|
@@ -51142,7 +51833,7 @@ type GridFieldFilterPickerGroupConfig = {
|
|
|
51142
51833
|
* ...
|
|
51143
51834
|
* [View online docs...](https://bryntum.com/products/grid/docs/api/Grid/widget/GridFieldFilterPickerGroup#config-color)
|
|
51144
51835
|
*/
|
|
51145
|
-
color?:
|
|
51836
|
+
color?: Color
|
|
51146
51837
|
/**
|
|
51147
51838
|
* Programmatic control over which column to start in when used in a grid layout.
|
|
51148
51839
|
*/
|
|
@@ -52289,7 +52980,7 @@ type GroupBarConfig = {
|
|
|
52289
52980
|
* ...
|
|
52290
52981
|
* [View online docs...](https://bryntum.com/products/grid/docs/api/Grid/widget/GroupBar#config-color)
|
|
52291
52982
|
*/
|
|
52292
|
-
color?:
|
|
52983
|
+
color?: Color
|
|
52293
52984
|
/**
|
|
52294
52985
|
* Programmatic control over which column to start in when used in a grid layout.
|
|
52295
52986
|
*/
|
|
@@ -53428,7 +54119,7 @@ type TreeComboConfig = {
|
|
|
53428
54119
|
* ...
|
|
53429
54120
|
* [View online docs...](https://bryntum.com/products/grid/docs/api/Grid/widget/TreeCombo#config-color)
|
|
53430
54121
|
*/
|
|
53431
|
-
color?:
|
|
54122
|
+
color?: Color
|
|
53432
54123
|
/**
|
|
53433
54124
|
* Programmatic control over which column to start in when used in a grid layout.
|
|
53434
54125
|
*/
|