@bryntum/scheduler-react 7.1.1
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 +52 -0
- package/lib/BryntumAIFilterField.d.ts +231 -0
- package/lib/BryntumAIFilterField.js +168 -0
- package/lib/BryntumAIFilterField.js.map +1 -0
- package/lib/BryntumButton.d.ts +206 -0
- package/lib/BryntumButton.js +148 -0
- package/lib/BryntumButton.js.map +1 -0
- package/lib/BryntumButtonGroup.d.ts +201 -0
- package/lib/BryntumButtonGroup.js +154 -0
- package/lib/BryntumButtonGroup.js.map +1 -0
- package/lib/BryntumChatPanel.d.ts +246 -0
- package/lib/BryntumChatPanel.js +178 -0
- package/lib/BryntumChatPanel.js.map +1 -0
- package/lib/BryntumCheckbox.d.ts +239 -0
- package/lib/BryntumCheckbox.js +168 -0
- package/lib/BryntumCheckbox.js.map +1 -0
- package/lib/BryntumCheckboxGroup.d.ts +249 -0
- package/lib/BryntumCheckboxGroup.js +182 -0
- package/lib/BryntumCheckboxGroup.js.map +1 -0
- package/lib/BryntumChecklistFilterCombo.d.ts +268 -0
- package/lib/BryntumChecklistFilterCombo.js +205 -0
- package/lib/BryntumChecklistFilterCombo.js.map +1 -0
- package/lib/BryntumChipView.d.ts +208 -0
- package/lib/BryntumChipView.js +152 -0
- package/lib/BryntumChipView.js.map +1 -0
- package/lib/BryntumCodeEditor.d.ts +237 -0
- package/lib/BryntumCodeEditor.js +176 -0
- package/lib/BryntumCodeEditor.js.map +1 -0
- package/lib/BryntumColorField.d.ts +231 -0
- package/lib/BryntumColorField.js +169 -0
- package/lib/BryntumColorField.js.map +1 -0
- package/lib/BryntumCombo.d.ts +266 -0
- package/lib/BryntumCombo.js +202 -0
- package/lib/BryntumCombo.js.map +1 -0
- package/lib/BryntumContainer.d.ts +185 -0
- package/lib/BryntumContainer.js +148 -0
- package/lib/BryntumContainer.js.map +1 -0
- package/lib/BryntumDateField.d.ts +241 -0
- package/lib/BryntumDateField.js +178 -0
- package/lib/BryntumDateField.js.map +1 -0
- package/lib/BryntumDatePicker.d.ts +310 -0
- package/lib/BryntumDatePicker.js +213 -0
- package/lib/BryntumDatePicker.js.map +1 -0
- package/lib/BryntumDateRangeField.d.ts +242 -0
- package/lib/BryntumDateRangeField.js +179 -0
- package/lib/BryntumDateRangeField.js.map +1 -0
- package/lib/BryntumDateTimeField.d.ts +222 -0
- package/lib/BryntumDateTimeField.js +158 -0
- package/lib/BryntumDateTimeField.js.map +1 -0
- package/lib/BryntumDemoCodeEditor.d.ts +240 -0
- package/lib/BryntumDemoCodeEditor.js +179 -0
- package/lib/BryntumDemoCodeEditor.js.map +1 -0
- package/lib/BryntumDemoHeader.d.ts +30 -0
- package/lib/BryntumDemoHeader.js +84 -0
- package/lib/BryntumDemoHeader.js.map +1 -0
- package/lib/BryntumDisplayField.d.ts +227 -0
- package/lib/BryntumDisplayField.js +163 -0
- package/lib/BryntumDisplayField.js.map +1 -0
- package/lib/BryntumDurationField.d.ts +234 -0
- package/lib/BryntumDurationField.js +175 -0
- package/lib/BryntumDurationField.js.map +1 -0
- package/lib/BryntumEditor.d.ts +249 -0
- package/lib/BryntumEditor.js +167 -0
- package/lib/BryntumEditor.js.map +1 -0
- package/lib/BryntumEventColorField.d.ts +231 -0
- package/lib/BryntumEventColorField.js +169 -0
- package/lib/BryntumEventColorField.js.map +1 -0
- package/lib/BryntumFieldFilterPicker.d.ts +202 -0
- package/lib/BryntumFieldFilterPicker.js +161 -0
- package/lib/BryntumFieldFilterPicker.js.map +1 -0
- package/lib/BryntumFieldFilterPickerGroup.d.ts +207 -0
- package/lib/BryntumFieldFilterPickerGroup.js +164 -0
- package/lib/BryntumFieldFilterPickerGroup.js.map +1 -0
- package/lib/BryntumFieldSet.d.ts +235 -0
- package/lib/BryntumFieldSet.js +174 -0
- package/lib/BryntumFieldSet.js.map +1 -0
- package/lib/BryntumFileField.d.ts +228 -0
- package/lib/BryntumFileField.js +164 -0
- package/lib/BryntumFileField.js.map +1 -0
- package/lib/BryntumFilePicker.d.ts +192 -0
- package/lib/BryntumFilePicker.js +153 -0
- package/lib/BryntumFilePicker.js.map +1 -0
- package/lib/BryntumFilterField.d.ts +234 -0
- package/lib/BryntumFilterField.js +171 -0
- package/lib/BryntumFilterField.js.map +1 -0
- package/lib/BryntumFullscreenButton.d.ts +8 -0
- package/lib/BryntumFullscreenButton.js +37 -0
- package/lib/BryntumFullscreenButton.js.map +1 -0
- package/lib/BryntumGrid.d.ts +844 -0
- package/lib/BryntumGrid.js +335 -0
- package/lib/BryntumGrid.js.map +1 -0
- package/lib/BryntumGridBase.d.ts +842 -0
- package/lib/BryntumGridBase.js +333 -0
- package/lib/BryntumGridBase.js.map +1 -0
- package/lib/BryntumGridChartDesigner.d.ts +162 -0
- package/lib/BryntumGridChartDesigner.js +127 -0
- package/lib/BryntumGridChartDesigner.js.map +1 -0
- package/lib/BryntumGridFieldFilterPicker.d.ts +203 -0
- package/lib/BryntumGridFieldFilterPicker.js +162 -0
- package/lib/BryntumGridFieldFilterPicker.js.map +1 -0
- package/lib/BryntumGridFieldFilterPickerGroup.d.ts +206 -0
- package/lib/BryntumGridFieldFilterPickerGroup.js +163 -0
- package/lib/BryntumGridFieldFilterPickerGroup.js.map +1 -0
- package/lib/BryntumGroupBar.d.ts +208 -0
- package/lib/BryntumGroupBar.js +152 -0
- package/lib/BryntumGroupBar.js.map +1 -0
- package/lib/BryntumHint.d.ts +260 -0
- package/lib/BryntumHint.js +184 -0
- package/lib/BryntumHint.js.map +1 -0
- package/lib/BryntumLabel.d.ts +161 -0
- package/lib/BryntumLabel.js +126 -0
- package/lib/BryntumLabel.js.map +1 -0
- package/lib/BryntumList.d.ts +205 -0
- package/lib/BryntumList.js +149 -0
- package/lib/BryntumList.js.map +1 -0
- package/lib/BryntumMenu.d.ts +264 -0
- package/lib/BryntumMenu.js +187 -0
- package/lib/BryntumMenu.js.map +1 -0
- package/lib/BryntumMonthPicker.d.ts +240 -0
- package/lib/BryntumMonthPicker.js +173 -0
- package/lib/BryntumMonthPicker.js.map +1 -0
- package/lib/BryntumNumberField.d.ts +234 -0
- package/lib/BryntumNumberField.js +170 -0
- package/lib/BryntumNumberField.js.map +1 -0
- package/lib/BryntumPagingToolbar.d.ts +210 -0
- package/lib/BryntumPagingToolbar.js +156 -0
- package/lib/BryntumPagingToolbar.js.map +1 -0
- package/lib/BryntumPanel.d.ts +231 -0
- package/lib/BryntumPanel.js +170 -0
- package/lib/BryntumPanel.js.map +1 -0
- package/lib/BryntumPasswordField.d.ts +226 -0
- package/lib/BryntumPasswordField.js +162 -0
- package/lib/BryntumPasswordField.js.map +1 -0
- package/lib/BryntumProjectCombo.d.ts +267 -0
- package/lib/BryntumProjectCombo.js +203 -0
- package/lib/BryntumProjectCombo.js.map +1 -0
- package/lib/BryntumRadio.d.ts +239 -0
- package/lib/BryntumRadio.js +168 -0
- package/lib/BryntumRadio.js.map +1 -0
- package/lib/BryntumRadioGroup.d.ts +239 -0
- package/lib/BryntumRadioGroup.js +178 -0
- package/lib/BryntumRadioGroup.js.map +1 -0
- package/lib/BryntumResourceCombo.d.ts +267 -0
- package/lib/BryntumResourceCombo.js +203 -0
- package/lib/BryntumResourceCombo.js.map +1 -0
- package/lib/BryntumResourceFilter.d.ts +214 -0
- package/lib/BryntumResourceFilter.js +154 -0
- package/lib/BryntumResourceFilter.js.map +1 -0
- package/lib/BryntumScheduler.d.ts +2037 -0
- package/lib/BryntumScheduler.js +642 -0
- package/lib/BryntumScheduler.js.map +1 -0
- package/lib/BryntumSchedulerBase.d.ts +2036 -0
- package/lib/BryntumSchedulerBase.js +641 -0
- package/lib/BryntumSchedulerBase.js.map +1 -0
- package/lib/BryntumSchedulerDatePicker.d.ts +313 -0
- package/lib/BryntumSchedulerDatePicker.js +216 -0
- package/lib/BryntumSchedulerDatePicker.js.map +1 -0
- package/lib/BryntumSchedulerProjectModel.d.ts +90 -0
- package/lib/BryntumSchedulerProjectModel.js +98 -0
- package/lib/BryntumSchedulerProjectModel.js.map +1 -0
- package/lib/BryntumSlideToggle.d.ts +239 -0
- package/lib/BryntumSlideToggle.js +168 -0
- package/lib/BryntumSlideToggle.js.map +1 -0
- package/lib/BryntumSlider.d.ts +184 -0
- package/lib/BryntumSlider.js +142 -0
- package/lib/BryntumSlider.js.map +1 -0
- package/lib/BryntumSplitter.d.ts +174 -0
- package/lib/BryntumSplitter.js +130 -0
- package/lib/BryntumSplitter.js.map +1 -0
- package/lib/BryntumTabPanel.d.ts +249 -0
- package/lib/BryntumTabPanel.js +178 -0
- package/lib/BryntumTabPanel.js.map +1 -0
- package/lib/BryntumTextAreaField.d.ts +228 -0
- package/lib/BryntumTextAreaField.js +164 -0
- package/lib/BryntumTextAreaField.js.map +1 -0
- package/lib/BryntumTextAreaPickerField.d.ts +232 -0
- package/lib/BryntumTextAreaPickerField.js +170 -0
- package/lib/BryntumTextAreaPickerField.js.map +1 -0
- package/lib/BryntumTextField.d.ts +229 -0
- package/lib/BryntumTextField.js +166 -0
- package/lib/BryntumTextField.js.map +1 -0
- package/lib/BryntumThemeCombo.d.ts +17 -0
- package/lib/BryntumThemeCombo.js +75 -0
- package/lib/BryntumThemeCombo.js.map +1 -0
- package/lib/BryntumTimeField.d.ts +238 -0
- package/lib/BryntumTimeField.js +175 -0
- package/lib/BryntumTimeField.js.map +1 -0
- package/lib/BryntumTimePicker.d.ts +192 -0
- package/lib/BryntumTimePicker.js +154 -0
- package/lib/BryntumTimePicker.js.map +1 -0
- package/lib/BryntumTimelineHistogram.d.ts +1183 -0
- package/lib/BryntumTimelineHistogram.js +448 -0
- package/lib/BryntumTimelineHistogram.js.map +1 -0
- package/lib/BryntumToolbar.d.ts +209 -0
- package/lib/BryntumToolbar.js +155 -0
- package/lib/BryntumToolbar.js.map +1 -0
- package/lib/BryntumTreeCombo.d.ts +266 -0
- package/lib/BryntumTreeCombo.js +202 -0
- package/lib/BryntumTreeCombo.js.map +1 -0
- package/lib/BryntumTreeGrid.d.ts +843 -0
- package/lib/BryntumTreeGrid.js +334 -0
- package/lib/BryntumTreeGrid.js.map +1 -0
- package/lib/BryntumUndoRedo.d.ts +189 -0
- package/lib/BryntumUndoRedo.js +152 -0
- package/lib/BryntumUndoRedo.js.map +1 -0
- package/lib/BryntumViewPresetCombo.d.ts +215 -0
- package/lib/BryntumViewPresetCombo.js +158 -0
- package/lib/BryntumViewPresetCombo.js.map +1 -0
- package/lib/BryntumWidget.d.ts +160 -0
- package/lib/BryntumWidget.js +125 -0
- package/lib/BryntumWidget.js.map +1 -0
- package/lib/BryntumYearPicker.d.ts +240 -0
- package/lib/BryntumYearPicker.js +177 -0
- package/lib/BryntumYearPicker.js.map +1 -0
- package/lib/WrapperHelper.d.ts +26 -0
- package/lib/WrapperHelper.js +569 -0
- package/lib/WrapperHelper.js.map +1 -0
- package/lib/index.d.ts +71 -0
- package/lib/index.js +72 -0
- package/lib/index.js.map +1 -0
- package/license.pdf +0 -0
- package/licenses.md +310 -0
- package/package.json +25 -0
- package/src/BryntumAIFilterField.tsx +998 -0
- package/src/BryntumButton.tsx +887 -0
- package/src/BryntumButtonGroup.tsx +902 -0
- package/src/BryntumChatPanel.tsx +1082 -0
- package/src/BryntumCheckbox.tsx +1000 -0
- package/src/BryntumCheckboxGroup.tsx +1116 -0
- package/src/BryntumChecklistFilterCombo.tsx +1241 -0
- package/src/BryntumChipView.tsx +914 -0
- package/src/BryntumCodeEditor.tsx +1065 -0
- package/src/BryntumColorField.tsx +995 -0
- package/src/BryntumCombo.tsx +1230 -0
- package/src/BryntumContainer.tsx +861 -0
- package/src/BryntumDateField.tsx +1055 -0
- package/src/BryntumDatePicker.tsx +1340 -0
- package/src/BryntumDateRangeField.tsx +1057 -0
- package/src/BryntumDateTimeField.tsx +942 -0
- package/src/BryntumDemoCodeEditor.tsx +1081 -0
- package/src/BryntumDemoHeader.tsx +160 -0
- package/src/BryntumDisplayField.tsx +979 -0
- package/src/BryntumDurationField.tsx +1038 -0
- package/src/BryntumEditor.tsx +1013 -0
- package/src/BryntumEventColorField.tsx +995 -0
- package/src/BryntumFieldFilterPicker.tsx +943 -0
- package/src/BryntumFieldFilterPickerGroup.tsx +976 -0
- package/src/BryntumFieldSet.tsx +1058 -0
- package/src/BryntumFileField.tsx +982 -0
- package/src/BryntumFilePicker.tsx +888 -0
- package/src/BryntumFilterField.tsx +1023 -0
- package/src/BryntumFullscreenButton.tsx +45 -0
- package/src/BryntumGrid.tsx +2402 -0
- package/src/BryntumGridBase.tsx +2399 -0
- package/src/BryntumGridChartDesigner.tsx +728 -0
- package/src/BryntumGridFieldFilterPicker.tsx +956 -0
- package/src/BryntumGridFieldFilterPickerGroup.tsx +970 -0
- package/src/BryntumGroupBar.tsx +914 -0
- package/src/BryntumHint.tsx +1125 -0
- package/src/BryntumLabel.tsx +720 -0
- package/src/BryntumList.tsx +891 -0
- package/src/BryntumMenu.tsx +1143 -0
- package/src/BryntumMonthPicker.tsx +1056 -0
- package/src/BryntumNumberField.tsx +1025 -0
- package/src/BryntumPagingToolbar.tsx +924 -0
- package/src/BryntumPanel.tsx +1035 -0
- package/src/BryntumPasswordField.tsx +969 -0
- package/src/BryntumProjectCombo.tsx +1232 -0
- package/src/BryntumRadio.tsx +1000 -0
- package/src/BryntumRadioGroup.tsx +1088 -0
- package/src/BryntumResourceCombo.tsx +1235 -0
- package/src/BryntumResourceFilter.tsx +930 -0
- package/src/BryntumScheduler.tsx +5182 -0
- package/src/BryntumSchedulerBase.tsx +5180 -0
- package/src/BryntumSchedulerDatePicker.tsx +1364 -0
- package/src/BryntumSchedulerProjectModel.tsx +423 -0
- package/src/BryntumSlideToggle.tsx +1000 -0
- package/src/BryntumSlider.tsx +815 -0
- package/src/BryntumSplitter.tsx +754 -0
- package/src/BryntumTabPanel.tsx +1087 -0
- package/src/BryntumTextAreaField.tsx +981 -0
- package/src/BryntumTextAreaPickerField.tsx +1002 -0
- package/src/BryntumTextField.tsx +987 -0
- package/src/BryntumThemeCombo.tsx +101 -0
- package/src/BryntumTimeField.tsx +1036 -0
- package/src/BryntumTimePicker.tsx +893 -0
- package/src/BryntumTimelineHistogram.tsx +3425 -0
- package/src/BryntumToolbar.tsx +917 -0
- package/src/BryntumTreeCombo.tsx +1230 -0
- package/src/BryntumTreeGrid.tsx +2401 -0
- package/src/BryntumUndoRedo.tsx +885 -0
- package/src/BryntumViewPresetCombo.tsx +914 -0
- package/src/BryntumWidget.tsx +715 -0
- package/src/BryntumYearPicker.tsx +1070 -0
- package/src/WrapperHelper.tsx +1125 -0
- package/src/index.ts +76 -0
|
@@ -0,0 +1,2402 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* React wrapper for Bryntum Grid
|
|
3
|
+
*/
|
|
4
|
+
// eslint-disable-next-line @typescript-eslint/no-unused-vars
|
|
5
|
+
import React, { RefObject } from 'react';
|
|
6
|
+
import { AIFilter, AIFilterConfig, AjaxStore, AjaxStoreConfig, Base, CellCopyPaste, CellCopyPasteConfig, CellEdit, CellEditConfig, CellEditorContext, CellMenu, CellMenuConfig, CellTooltip, CellTooltipConfig, Charts, ChartsConfig, Column, ColumnAutoWidth, ColumnAutoWidthConfig, ColumnDragToolbar, ColumnDragToolbarConfig, ColumnPicker, ColumnPickerConfig, ColumnRename, ColumnRenameConfig, ColumnReorder, ColumnReorderConfig, ColumnResize, ColumnResizeConfig, ColumnStore, ColumnStoreConfig, Container, ContainerItemConfig, DomConfig, EmptyTextDomConfig, ExportConfig, FileDrop, FileDropConfig, FillHandle, FillHandleConfig, Filter, FilterBar, FilterBarConfig, FilterConfig, FormulaProviderConfig, Grid, GridBase, GridColumnConfig, GridExcelExporter, GridExcelExporterConfig, GridGroupSummary, GridGroupSummaryConfig, GridListeners, GridLocation, GridLocationConfig, GridLockRows, GridLockRowsConfig, GridPdfExport, GridPdfExportConfig, GridPrint, GridPrintConfig, GridRowReorder, GridRowReorderConfig, GridRowResize, GridRowResizeConfig, GridSelectionMode, GridSplit, GridSplitConfig, GridStateInfo, GridSummary, GridSummaryConfig, Group, GroupConfig, HeaderMenu, HeaderMenuConfig, KeyMapConfig, Mask, MaskConfig, Menu, MenuItem, MenuItemEntry, MergeCells, MergeCellsConfig, Model, ModelConfig, PagingToolbarConfig, Panel, PanelCollapserConfig, PanelCollapserOverlayConfig, PanelHeader, PinColumns, PinColumnsConfig, PreserveScrollOptions, QuickFind, QuickFindConfig, RecordPositionContext, RegionResize, RegionResizeConfig, ResponsiveLevelConfig, Row, RowCopyPaste, RowCopyPasteConfig, RowEdit, RowEditConfig, RowEditorContext, RowExpander, RowExpanderConfig, ScrollManager, ScrollManagerConfig, Scroller, ScrollerConfig, Search, SearchConfig, Sort, SortConfig, StateProvider, StickyCells, StickyCellsConfig, Store, StoreConfig, Stripe, StripeConfig, SubGrid, SubGridConfig, TabConfig, Tool, ToolConfig, ToolbarConfig, ToolbarItems, TooltipConfig, Tree, TreeConfig, TreeGroup, TreeGroupConfig, Widget, XLSColumn } from '@bryntum/scheduler';
|
|
7
|
+
|
|
8
|
+
import { createWidget, shouldComponentUpdate, processWidgetContent } from './WrapperHelper.js';
|
|
9
|
+
|
|
10
|
+
export type BryntumGridProps = {
|
|
11
|
+
// Configs
|
|
12
|
+
/**
|
|
13
|
+
* Element (or element id) to adopt as this Widget's encapsulating element. The widget's
|
|
14
|
+
* content will be placed inside this element.
|
|
15
|
+
* ...
|
|
16
|
+
* [View online docs...](https://bryntum.com/products/scheduler/docs/api/Grid/view/Grid#config-adopt)
|
|
17
|
+
*/
|
|
18
|
+
adopt? : HTMLElement|string
|
|
19
|
+
/**
|
|
20
|
+
* When this widget is a child of a [Container](https://bryntum.com/products/scheduler/docs/api/Core/widget/Container), it will by default be participating in a
|
|
21
|
+
* flexbox layout. This config allows you to set this widget's
|
|
22
|
+
* [align-self](https://developer.mozilla.org/en-US/docs/Web/CSS/align-self) style.
|
|
23
|
+
*/
|
|
24
|
+
alignSelf? : string
|
|
25
|
+
/**
|
|
26
|
+
* Set to `true` to animate row removals caused by filtering.
|
|
27
|
+
* @deprecated 7.0.0 Deprecated `animateFilterRemovals`. Use `transition.filterRemoval` instead
|
|
28
|
+
*/
|
|
29
|
+
animateFilterRemovals? : boolean
|
|
30
|
+
/**
|
|
31
|
+
* Controls if removing and inserting rows should be animated. Set to `false` to prevent those animations,
|
|
32
|
+
* removing the related delays.
|
|
33
|
+
* @deprecated 7.0.0 Deprecated `animateRemovingRows`. Use `transition.removeRecord` instead
|
|
34
|
+
*/
|
|
35
|
+
animateRemovingRows? : boolean
|
|
36
|
+
/**
|
|
37
|
+
* When the [Tree](https://bryntum.com/products/scheduler/docs/api/Grid/feature/Tree) feature is in use and the Store is a tree store, this
|
|
38
|
+
* config may be set to `true` to visually animate branch node expand and collapse operations.
|
|
39
|
+
* *This is not supported in Scheduler and Gantt*
|
|
40
|
+
* @deprecated 7.0.0 Deprecated `animateTreeNodeToggle`. Use `transition.toggleTreeNode` instead
|
|
41
|
+
*/
|
|
42
|
+
animateTreeNodeToggle? : boolean
|
|
43
|
+
/**
|
|
44
|
+
* Element (or the id of an element) to append this widget's element to. Can be configured, or set once at
|
|
45
|
+
* runtime. To access the element of a rendered widget, see [element](https://bryntum.com/products/scheduler/docs/api/Core/widget/Widget#property-element).
|
|
46
|
+
*/
|
|
47
|
+
appendTo? : HTMLElement|string
|
|
48
|
+
/**
|
|
49
|
+
* A localizable string (May contain `'L{}'` tokens which resolve in the locale file) to inject
|
|
50
|
+
* into an element which will be linked using the `aria-describedby` attribute.
|
|
51
|
+
* ...
|
|
52
|
+
* [View online docs...](https://bryntum.com/products/scheduler/docs/api/Grid/view/Grid#config-ariaDescription)
|
|
53
|
+
*/
|
|
54
|
+
ariaDescription? : string
|
|
55
|
+
/**
|
|
56
|
+
* A localizable string (May contain `'L{}'` tokens which resolve in the locale file) to inject as
|
|
57
|
+
* the `aria-label` attribute.
|
|
58
|
+
* ...
|
|
59
|
+
* [View online docs...](https://bryntum.com/products/scheduler/docs/api/Grid/view/Grid#config-ariaLabel)
|
|
60
|
+
*/
|
|
61
|
+
ariaLabel? : string
|
|
62
|
+
/**
|
|
63
|
+
* Automatically set grids height to fit all rows (no scrolling in the grid). In general you should avoid
|
|
64
|
+
* using `autoHeight: true`, since it will bypass Grids virtual rendering and render all rows at once, which
|
|
65
|
+
* in a larger grid is really bad for performance.
|
|
66
|
+
*/
|
|
67
|
+
autoHeight? : boolean
|
|
68
|
+
/**
|
|
69
|
+
* A Config object representing the configuration of a [Toolbar](https://bryntum.com/products/scheduler/docs/api/Core/widget/Toolbar),
|
|
70
|
+
* or array of config objects representing the child items of a Toolbar. Another way to add a bbar is to use [strips](https://bryntum.com/products/scheduler/docs/api/Core/widget/Panel#config-strips).
|
|
71
|
+
* ...
|
|
72
|
+
* [View online docs...](https://bryntum.com/products/scheduler/docs/api/Grid/view/Grid#config-bbar)
|
|
73
|
+
*/
|
|
74
|
+
bbar? : (ContainerItemConfig|string)[]|ToolbarConfig|PagingToolbarConfig|null
|
|
75
|
+
/**
|
|
76
|
+
* Custom CSS classes to add to the panel's body element.
|
|
77
|
+
* ...
|
|
78
|
+
* [View online docs...](https://bryntum.com/products/scheduler/docs/api/Grid/view/Grid#config-bodyCls)
|
|
79
|
+
*/
|
|
80
|
+
bodyCls? : string|object
|
|
81
|
+
/**
|
|
82
|
+
* An object where property names with a truthy value indicate which events should bubble up the ownership
|
|
83
|
+
* hierarchy when triggered.
|
|
84
|
+
* ...
|
|
85
|
+
* [View online docs...](https://bryntum.com/products/scheduler/docs/api/Grid/view/Grid#config-bubbleEvents)
|
|
86
|
+
*/
|
|
87
|
+
bubbleEvents? : object
|
|
88
|
+
/**
|
|
89
|
+
* Set to `false` to not call onXXX method names (e.g. `onShow`, `onClick`), as an easy way to listen for events.
|
|
90
|
+
* ...
|
|
91
|
+
* [View online docs...](https://bryntum.com/products/scheduler/docs/api/Grid/view/Grid#config-callOnFunctions)
|
|
92
|
+
*/
|
|
93
|
+
callOnFunctions? : boolean
|
|
94
|
+
/**
|
|
95
|
+
* By default, if an event handler throws an exception, the error propagates up the stack and the
|
|
96
|
+
* application state is undefined. Code which follows the event handler will *not* be executed.
|
|
97
|
+
* ...
|
|
98
|
+
* [View online docs...](https://bryntum.com/products/scheduler/docs/api/Grid/view/Grid#config-catchEventHandlerExceptions)
|
|
99
|
+
*/
|
|
100
|
+
catchEventHandlerExceptions? : boolean
|
|
101
|
+
/**
|
|
102
|
+
* Set to `false` to crop text in grid cells without ellipsis (...). When enabled, cells containing pure
|
|
103
|
+
* use `display : block`, instead of `display : flex` to allow ellipsis to work.
|
|
104
|
+
* <strong>NOTE</strong> Only supported in browsers that support `:has()` CSS selector
|
|
105
|
+
*/
|
|
106
|
+
cellEllipsis? : boolean
|
|
107
|
+
/**
|
|
108
|
+
* Custom CSS classes to add to element.
|
|
109
|
+
* May be specified as a space separated string, or as an object in which property names
|
|
110
|
+
* with truthy values are used as the class names:
|
|
111
|
+
* ...
|
|
112
|
+
* [View online docs...](https://bryntum.com/products/scheduler/docs/api/Grid/view/Grid#config-cls)
|
|
113
|
+
*/
|
|
114
|
+
cls? : string|object
|
|
115
|
+
/**
|
|
116
|
+
* Controls whether the panel is collapsed (the body of the panel is hidden while only the header is
|
|
117
|
+
* visible). Only valid if the panel is [collapsible](https://bryntum.com/products/scheduler/docs/api/Core/widget/Panel#config-collapsible).
|
|
118
|
+
*/
|
|
119
|
+
collapsed? : boolean
|
|
120
|
+
/**
|
|
121
|
+
* This config enables collapsibility for the panel. See [collapsed](https://bryntum.com/products/scheduler/docs/api/Core/widget/Panel#config-collapsed).
|
|
122
|
+
* ...
|
|
123
|
+
* [View online docs...](https://bryntum.com/products/scheduler/docs/api/Grid/view/Grid#config-collapsible)
|
|
124
|
+
*/
|
|
125
|
+
collapsible? : boolean|PanelCollapserConfig|PanelCollapserOverlayConfig
|
|
126
|
+
/**
|
|
127
|
+
* Applies the specified color to the widget, by setting the `--b-primary` CSS variable in the widgets
|
|
128
|
+
* `style` block.
|
|
129
|
+
* ...
|
|
130
|
+
* [View online docs...](https://bryntum.com/products/scheduler/docs/api/Grid/view/Grid#config-color)
|
|
131
|
+
*/
|
|
132
|
+
color? : string
|
|
133
|
+
/**
|
|
134
|
+
* Programmatic control over which column to start in when used in a grid layout.
|
|
135
|
+
*/
|
|
136
|
+
column? : number
|
|
137
|
+
/**
|
|
138
|
+
* Set to `false` to not show column lines. End result might be overruled by/differ between themes.
|
|
139
|
+
*/
|
|
140
|
+
columnLines? : boolean
|
|
141
|
+
/**
|
|
142
|
+
* Accepts column definitions for the grid during initialization. They will be used to create
|
|
143
|
+
* [Column](https://bryntum.com/products/scheduler/docs/api/Grid/column/Column) instances that are added to a [ColumnStore](#Grid/data/ColumnStore).
|
|
144
|
+
* ...
|
|
145
|
+
* [View online docs...](https://bryntum.com/products/scheduler/docs/api/Grid/view/Grid#config-columns)
|
|
146
|
+
*/
|
|
147
|
+
columns? : ColumnStore|GridColumnConfig[]|ColumnStoreConfig
|
|
148
|
+
config? : object
|
|
149
|
+
/**
|
|
150
|
+
* Custom CSS classes to add to the [contentElement](https://bryntum.com/products/scheduler/docs/api/Core/widget/Widget#property-contentElement).
|
|
151
|
+
* May be specified as a space separated string, or as an object in which property names
|
|
152
|
+
* with truthy values are used as the class names:
|
|
153
|
+
* ...
|
|
154
|
+
* [View online docs...](https://bryntum.com/products/scheduler/docs/api/Grid/view/Grid#config-contentElementCls)
|
|
155
|
+
*/
|
|
156
|
+
contentElementCls? : string|object
|
|
157
|
+
/**
|
|
158
|
+
* Event which is used to show context menus.
|
|
159
|
+
* Available options are: 'contextmenu', 'click', 'dblclick'.
|
|
160
|
+
*/
|
|
161
|
+
contextMenuTriggerEvent? : 'contextmenu'|'click'|'dblclick'
|
|
162
|
+
/**
|
|
163
|
+
* Convenient shortcut to set data in grids store both during initialization and at runtime. Can also be
|
|
164
|
+
* used to retrieve data at runtime, although we do recommend interacting with Grids store instead using
|
|
165
|
+
* the [store](https://bryntum.com/products/scheduler/docs/api/Grid/view/GridBase#property-store) property.
|
|
166
|
+
* ...
|
|
167
|
+
* [View online docs...](https://bryntum.com/products/scheduler/docs/api/Grid/view/Grid#config-data)
|
|
168
|
+
*/
|
|
169
|
+
data? : object[]|Model[]|ModelConfig[]
|
|
170
|
+
/**
|
|
171
|
+
* When this Widget configuration is used in the Grid's RowExpander feature's `widget` config, provide the
|
|
172
|
+
* field on the expanded record to use for populating this widget's store (if applicable)
|
|
173
|
+
*/
|
|
174
|
+
dataField? : string
|
|
175
|
+
/**
|
|
176
|
+
* Object to apply to elements dataset (each key will be used as a data-attribute on the element)
|
|
177
|
+
*/
|
|
178
|
+
dataset? : Record<string, string>
|
|
179
|
+
/**
|
|
180
|
+
* Region to which columns are added when they have none specified
|
|
181
|
+
*/
|
|
182
|
+
defaultRegion? : string
|
|
183
|
+
/**
|
|
184
|
+
* Set to `true` to destroy the store when the grid is destroyed.
|
|
185
|
+
*/
|
|
186
|
+
destroyStore? : boolean
|
|
187
|
+
/**
|
|
188
|
+
* Check for CSS compatibility issues when upgrading to v7. Performs the following checks:
|
|
189
|
+
* ...
|
|
190
|
+
* [View online docs...](https://bryntum.com/products/scheduler/docs/api/Grid/view/Grid#config-detectCSSCompatibilityIssues)
|
|
191
|
+
*/
|
|
192
|
+
detectCSSCompatibilityIssues? : boolean
|
|
193
|
+
/**
|
|
194
|
+
* Disable or enable the widget. It is similar to [readOnly](https://bryntum.com/products/scheduler/docs/api/Core/widget/Widget#config-readOnly) except a disabled widget
|
|
195
|
+
* cannot be focused, uses a different rendition (usually greyish) and does not allow selecting its value.
|
|
196
|
+
* ...
|
|
197
|
+
* [View online docs...](https://bryntum.com/products/scheduler/docs/api/Grid/view/Grid#config-disabled)
|
|
198
|
+
*/
|
|
199
|
+
disabled? : boolean|'inert'
|
|
200
|
+
/**
|
|
201
|
+
* Set to `true` to not get a warning when calling [getState](https://bryntum.com/products/scheduler/docs/api/Grid/view/GridBase#function-getState) when there is a column
|
|
202
|
+
* configured without an `id`. But the recommended action is to always configure columns with an `id` when
|
|
203
|
+
* using states.
|
|
204
|
+
*/
|
|
205
|
+
disableGridColumnIdWarning? : boolean
|
|
206
|
+
/**
|
|
207
|
+
* Set to `true` to not get a warning when using another base class than GridRowModel for your grid data. If
|
|
208
|
+
* you do, and would like to use the full feature set of the grid then include the fields from GridRowModel
|
|
209
|
+
* in your model definition.
|
|
210
|
+
*/
|
|
211
|
+
disableGridRowModelWarning? : boolean
|
|
212
|
+
/**
|
|
213
|
+
* Controls the placement of this widget when it is added to a [panel's ](https://bryntum.com/products/scheduler/docs/api/Core/widget/Panel)
|
|
214
|
+
* [strips collection](https://bryntum.com/products/scheduler/docs/api/Core/widget/Panel#config-strips). Typical values for this config are `'top'`,
|
|
215
|
+
* `'bottom'`, `'left'`, or `'right'`, which cause the widget to be placed on that side of the panel's
|
|
216
|
+
* body. Such widgets are called "edge strips".
|
|
217
|
+
* ...
|
|
218
|
+
* [View online docs...](https://bryntum.com/products/scheduler/docs/api/Grid/view/Grid#config-dock)
|
|
219
|
+
*/
|
|
220
|
+
dock? : 'top'|'bottom'|'left'|'right'|'start'|'end'|'header'|'pre-header'|object
|
|
221
|
+
/**
|
|
222
|
+
* Make this Panel a docked drawer which slides out from one side of the browser viewport by default.
|
|
223
|
+
* ...
|
|
224
|
+
* [View online docs...](https://bryntum.com/products/scheduler/docs/api/Grid/view/Grid#config-drawer)
|
|
225
|
+
* @param {'start','left','end','right','top','bottom'} side The side of the viewport to dock the drawer to. * `'start'` means the `inline-start` side. * `'end'` means the `inline-end` side.
|
|
226
|
+
* @param {string,number} size The size of the drawer in its collapsible axis.
|
|
227
|
+
* @param {boolean} inline If using the [appendTo](https://bryntum.com/products/scheduler/docs/api/Core/widget/Panel#config-appendTo) config to place the drawer inside a host widget, this may be set to `true` to make the drawer inline within that host. Note that, if using this, the layout of the host element must have `flex-direction` set appropriately.
|
|
228
|
+
* @param {boolean,object} autoClose Specifies what user actions should automatically close the drawer. Defaults to closing when the user clicks outside of the drawer or when focus moves outside of the drawer.
|
|
229
|
+
* @param {boolean,string} autoClose.mousedown If the user clicks outside of the drawer, the drawer will automatically be hidden. If the value is a string, it is used as a CSS selector to filter clicks which should close the drawer.
|
|
230
|
+
* @param {boolean,string} autoClose.focusout If focus moves outside of the drawer, the drawer will automatically be hidden.
|
|
231
|
+
* @param {string} autoClose.mouseout Hides the drawer when the mouse leaves the drawer after the `autoCloseDelay` period.
|
|
232
|
+
* @param {number} autoCloseDelay When using `mouseout`, this is the delay in milliseconds
|
|
233
|
+
*/
|
|
234
|
+
drawer? : boolean|{side?: 'start'|'left'|'end'|'right'|'top'|'bottom', size?: string|number, inline?: boolean, autoClose: { mousedown?: boolean|string, focusout?: boolean|string, mouseout?: string }, autoCloseDelay?: number}
|
|
235
|
+
/**
|
|
236
|
+
* An object specifying attributes to assign to the root element of this widget.
|
|
237
|
+
* Set `null` value to attribute to remove it.
|
|
238
|
+
* ...
|
|
239
|
+
* [View online docs...](https://bryntum.com/products/scheduler/docs/api/Grid/view/Grid#config-elementAttributes)
|
|
240
|
+
*/
|
|
241
|
+
elementAttributes? : Record<string, string|null>
|
|
242
|
+
/**
|
|
243
|
+
* Text or HTML, or a [EmptyTextDomConfig](https://bryntum.com/products/scheduler/docs/api/Grid/view/GridBase#typedef-EmptyTextDomConfig) block to display when there is no data to display in the grid.
|
|
244
|
+
* When using multiple Grid regions, provide the `region` property to decide where the text is shown.
|
|
245
|
+
* By default, it is shown in the first region.
|
|
246
|
+
* ...
|
|
247
|
+
* [View online docs...](https://bryntum.com/products/scheduler/docs/api/Grid/view/Grid#config-emptyText)
|
|
248
|
+
*/
|
|
249
|
+
emptyText? : string|EmptyTextDomConfig
|
|
250
|
+
/**
|
|
251
|
+
* Configure this as `true` to allow elements within cells to be styled as `position: sticky`.
|
|
252
|
+
* ...
|
|
253
|
+
* [View online docs...](https://bryntum.com/products/scheduler/docs/api/Grid/view/Grid#config-enableSticky)
|
|
254
|
+
*/
|
|
255
|
+
enableSticky? : boolean
|
|
256
|
+
/**
|
|
257
|
+
* Set to `true` to allow text selection in the grid cells. Note, this cannot be used simultaneously with the
|
|
258
|
+
* `RowReorder` feature.
|
|
259
|
+
*/
|
|
260
|
+
enableTextSelection? : boolean
|
|
261
|
+
/**
|
|
262
|
+
* Set to `true` to listen for CTRL-Z (CMD-Z on Mac OS) keyboard event and trigger undo (redo when SHIFT is
|
|
263
|
+
* pressed). Only applicable when using a [StateTrackingManager](https://bryntum.com/products/scheduler/docs/api/Core/data/stm/StateTrackingManager).
|
|
264
|
+
*/
|
|
265
|
+
enableUndoRedoKeys? : boolean
|
|
266
|
+
extraData? : any
|
|
267
|
+
/**
|
|
268
|
+
* Set to `true` to stretch the last column in a grid with all fixed width columns
|
|
269
|
+
* to fill extra available space if the grid's width is wider than the sum of all
|
|
270
|
+
* configured column widths.
|
|
271
|
+
*/
|
|
272
|
+
fillLastColumn? : boolean
|
|
273
|
+
/**
|
|
274
|
+
* Use fixed row height. Setting this to `true` will configure the underlying RowManager to use fixed row
|
|
275
|
+
* height, which sacrifices the ability to use rows with variable height to gain a fraction better
|
|
276
|
+
* performance.
|
|
277
|
+
* ...
|
|
278
|
+
* [View online docs...](https://bryntum.com/products/scheduler/docs/api/Grid/view/Grid#config-fixedRowHeight)
|
|
279
|
+
*/
|
|
280
|
+
fixedRowHeight? : boolean
|
|
281
|
+
/**
|
|
282
|
+
* When this widget is a child of a [Container](https://bryntum.com/products/scheduler/docs/api/Core/widget/Container), it will by default be participating in a
|
|
283
|
+
* flexbox layout. This config allows you to set this widget's
|
|
284
|
+
* [flex](https://developer.mozilla.org/en-US/docs/Web/CSS/flex) style.
|
|
285
|
+
* This may be configured as a single number or a `<flex-grow> <flex-shrink> <flex-basis>` format string.
|
|
286
|
+
* numeric-only values are interpreted as the `flex-grow` value.
|
|
287
|
+
*/
|
|
288
|
+
flex? : number|string
|
|
289
|
+
/**
|
|
290
|
+
* Config object of a footer. May contain a `dock`, `html` and a `cls` property. A footer is not a widget,
|
|
291
|
+
* but rather plain HTML that follows the last element of the panel's body and [strips](https://bryntum.com/products/scheduler/docs/api/Core/widget/Panel#config-strips).
|
|
292
|
+
* ...
|
|
293
|
+
* [View online docs...](https://bryntum.com/products/scheduler/docs/api/Grid/view/Grid#config-footer)
|
|
294
|
+
*/
|
|
295
|
+
footer? : {
|
|
296
|
+
dock?: 'top'|'right'|'bottom'|'left'|'start'|'end'
|
|
297
|
+
html?: string
|
|
298
|
+
cls?: string
|
|
299
|
+
}|string
|
|
300
|
+
/**
|
|
301
|
+
* An object which names formula prefixes which will be applied to all columns configured with
|
|
302
|
+
* `formula : true`.
|
|
303
|
+
* ...
|
|
304
|
+
* [View online docs...](https://bryntum.com/products/scheduler/docs/api/Grid/view/Grid#config-formulaProviders)
|
|
305
|
+
*/
|
|
306
|
+
formulaProviders? : Record<string, FormulaProviderConfig>
|
|
307
|
+
/**
|
|
308
|
+
* Refresh entire row when a record changes (`true`) or, if possible, only the cells affected (`false`).
|
|
309
|
+
* ...
|
|
310
|
+
* [View online docs...](https://bryntum.com/products/scheduler/docs/api/Grid/view/Grid#config-fullRowRefresh)
|
|
311
|
+
*/
|
|
312
|
+
fullRowRefresh? : boolean
|
|
313
|
+
/**
|
|
314
|
+
* A function called for each row to determine its height. It is passed a [record](https://bryntum.com/products/scheduler/docs/api/Core/data/Model) and
|
|
315
|
+
* expected to return the desired height of that records row. If the function returns a falsy value, Grids
|
|
316
|
+
* configured [rowHeight](https://bryntum.com/products/scheduler/docs/api/Grid/view/GridBase#config-rowHeight) is used.
|
|
317
|
+
* ...
|
|
318
|
+
* [View online docs...](https://bryntum.com/products/scheduler/docs/api/Grid/view/Grid#config-getRowHeight)
|
|
319
|
+
* @param {Core.data.Model} getRowHeight.record Record to determine row height for
|
|
320
|
+
* @returns {number} Desired row height
|
|
321
|
+
*/
|
|
322
|
+
getRowHeight? : (getRowHeight: { record: Model }) => number
|
|
323
|
+
/**
|
|
324
|
+
* A config [object](https://bryntum.com/products/scheduler/docs/api/Core/widget/Panel#typedef-PanelHeader) for the panel's header or a string in place of a `title`.
|
|
325
|
+
* ...
|
|
326
|
+
* [View online docs...](https://bryntum.com/products/scheduler/docs/api/Grid/view/Grid#config-header)
|
|
327
|
+
*/
|
|
328
|
+
header? : string|boolean|PanelHeader
|
|
329
|
+
/**
|
|
330
|
+
* Widget's height, used to set element `style.height`. Either specify a valid height string or a number,
|
|
331
|
+
* which will get 'px' appended. We recommend using CSS as the primary way to control height, but in some
|
|
332
|
+
* cases this config is convenient.
|
|
333
|
+
*/
|
|
334
|
+
height? : string|number
|
|
335
|
+
/**
|
|
336
|
+
* Configure with true to make widget initially hidden.
|
|
337
|
+
*/
|
|
338
|
+
hidden? : boolean
|
|
339
|
+
/**
|
|
340
|
+
* Set to `true` to hide the footer elements
|
|
341
|
+
*/
|
|
342
|
+
hideFooters? : boolean
|
|
343
|
+
/**
|
|
344
|
+
* Set to `true` to hide the column header elements
|
|
345
|
+
*/
|
|
346
|
+
hideHeaders? : boolean
|
|
347
|
+
/**
|
|
348
|
+
* Set to `true` to hide the Grid's horizontal scrollbar(s)
|
|
349
|
+
*/
|
|
350
|
+
hideHorizontalScrollbar? : boolean
|
|
351
|
+
/**
|
|
352
|
+
* A CSS class to add to hovered row elements
|
|
353
|
+
*/
|
|
354
|
+
hoverCls? : string
|
|
355
|
+
/**
|
|
356
|
+
* An icon to show before the [title](https://bryntum.com/products/scheduler/docs/api/Core/widget/Panel#config-title). Either pass a CSS class as a string, or pass a
|
|
357
|
+
* [DomConfig](https://bryntum.com/products/scheduler/docs/api/Core/helper/DomHelper#typedef-DomConfig) object describing an element to represent the icon.
|
|
358
|
+
*/
|
|
359
|
+
icon? : string|DomConfig
|
|
360
|
+
/**
|
|
361
|
+
* Widget id, if not specified one will be generated. Also used for lookups through Widget.getById
|
|
362
|
+
*/
|
|
363
|
+
id? : string
|
|
364
|
+
/**
|
|
365
|
+
* Determines if the widgets read-only state should be controlled by its parent.
|
|
366
|
+
* ...
|
|
367
|
+
* [View online docs...](https://bryntum.com/products/scheduler/docs/api/Grid/view/Grid#config-ignoreParentReadOnly)
|
|
368
|
+
*/
|
|
369
|
+
ignoreParentReadOnly? : boolean
|
|
370
|
+
/**
|
|
371
|
+
* Convenience setting to align input fields of child widgets. By default, the Field input element is
|
|
372
|
+
* placed immediately following the `label`. If you prefer to have all input fields aligned to the
|
|
373
|
+
* right, set this config to `'end'`.
|
|
374
|
+
* ...
|
|
375
|
+
* [View online docs...](https://bryntum.com/products/scheduler/docs/api/Grid/view/Grid#config-inputFieldAlign)
|
|
376
|
+
*/
|
|
377
|
+
inputFieldAlign? : 'start'|'end'
|
|
378
|
+
/**
|
|
379
|
+
* Element (or element id) to insert this widget before. If provided, [appendTo](https://bryntum.com/products/scheduler/docs/api/Core/widget/Widget#config-appendTo) config is ignored.
|
|
380
|
+
*/
|
|
381
|
+
insertBefore? : HTMLElement|string
|
|
382
|
+
/**
|
|
383
|
+
* Element (or element id) to append this widget element to, as a first child. If provided, [appendTo](https://bryntum.com/products/scheduler/docs/api/Core/widget/Widget#config-appendTo) config is ignored.
|
|
384
|
+
*/
|
|
385
|
+
insertFirst? : HTMLElement|string
|
|
386
|
+
/**
|
|
387
|
+
* See [Keyboard shortcuts](https://bryntum.com/products/scheduler/docs/api/Grid/view/Grid#keyboard-shortcuts) for details
|
|
388
|
+
*/
|
|
389
|
+
keyMap? : Record<string, KeyMapConfig>
|
|
390
|
+
/**
|
|
391
|
+
* Convenience setting to use same label placement on all child widgets.
|
|
392
|
+
* ...
|
|
393
|
+
* [View online docs...](https://bryntum.com/products/scheduler/docs/api/Grid/view/Grid#config-labelPosition)
|
|
394
|
+
*/
|
|
395
|
+
labelPosition? : 'before'|'above'|'align-before'|'auto'|null
|
|
396
|
+
/**
|
|
397
|
+
* The listener set for this object.
|
|
398
|
+
* ...
|
|
399
|
+
* [View online docs...](https://bryntum.com/products/scheduler/docs/api/Grid/view/Grid#config-listeners)
|
|
400
|
+
*/
|
|
401
|
+
listeners? : GridListeners
|
|
402
|
+
/**
|
|
403
|
+
* A [Mask](https://bryntum.com/products/scheduler/docs/api/Core/widget/Mask) config object, or a message to be shown when a store is performing a remote
|
|
404
|
+
* operation, or Crud Manager is loading data from the sever. Set to `null` to disable default load mask.
|
|
405
|
+
*/
|
|
406
|
+
loadMask? : string|MaskConfig|null
|
|
407
|
+
/**
|
|
408
|
+
* A [Mask](https://bryntum.com/products/scheduler/docs/api/Core/widget/Mask) config object to adjust the [maskDefaults](#Core/widget/Widget#config-maskDefaults)
|
|
409
|
+
* when data is loading. The message and optional configuration from the
|
|
410
|
+
* [loadMask](https://bryntum.com/products/scheduler/docs/api/Core/mixin/LoadMaskable#config-loadMask) config take priority over these options, just as they do
|
|
411
|
+
* for `maskDefaults`, respectively.
|
|
412
|
+
* ...
|
|
413
|
+
* [View online docs...](https://bryntum.com/products/scheduler/docs/api/Grid/view/Grid#config-loadMaskDefaults)
|
|
414
|
+
*/
|
|
415
|
+
loadMaskDefaults? : MaskConfig
|
|
416
|
+
/**
|
|
417
|
+
* A [Mask](https://bryntum.com/products/scheduler/docs/api/Core/widget/Mask) config object to adjust the [maskDefaults](#Core/widget/Widget#config-maskDefaults)
|
|
418
|
+
* when an error occurs loading data.
|
|
419
|
+
* ...
|
|
420
|
+
* [View online docs...](https://bryntum.com/products/scheduler/docs/api/Grid/view/Grid#config-loadMaskError)
|
|
421
|
+
*/
|
|
422
|
+
loadMaskError? : MaskConfig|Mask|boolean
|
|
423
|
+
/**
|
|
424
|
+
* Set to `false` to disable localization of this object.
|
|
425
|
+
*/
|
|
426
|
+
localizable? : boolean
|
|
427
|
+
/**
|
|
428
|
+
* Time in ms until a longpress is triggered
|
|
429
|
+
*/
|
|
430
|
+
longPressTime? : number
|
|
431
|
+
/**
|
|
432
|
+
* Widget's margin. This may be configured as a single number or a `TRBL` format string.
|
|
433
|
+
* numeric-only values are interpreted as pixels.
|
|
434
|
+
*/
|
|
435
|
+
margin? : number|string
|
|
436
|
+
/**
|
|
437
|
+
* Grids change the `maskDefaults` to cover only their `body` element.
|
|
438
|
+
*/
|
|
439
|
+
maskDefaults? : MaskConfig
|
|
440
|
+
/**
|
|
441
|
+
* Set to `true` to apply the default mask to the widget. Alternatively, this can be the mask message or a
|
|
442
|
+
* [Mask](https://bryntum.com/products/scheduler/docs/api/Core/widget/Mask) config object.
|
|
443
|
+
*/
|
|
444
|
+
masked? : boolean|string|MaskConfig
|
|
445
|
+
/**
|
|
446
|
+
* The element's maxHeight. Can be either a String or a Number (which will have 'px' appended). Note that
|
|
447
|
+
* like [height](https://bryntum.com/products/scheduler/docs/api/Core/widget/Widget#config-height), *reading* the value will return the numeric value in pixels.
|
|
448
|
+
*/
|
|
449
|
+
maxHeight? : string|number
|
|
450
|
+
/**
|
|
451
|
+
* The elements maxWidth. Can be either a String or a Number (which will have 'px' appended). Note that
|
|
452
|
+
* like [width](https://bryntum.com/products/scheduler/docs/api/Core/widget/Widget#config-width), *reading* the value will return the numeric value in pixels.
|
|
453
|
+
*/
|
|
454
|
+
maxWidth? : string|number
|
|
455
|
+
/**
|
|
456
|
+
* Grid's `min-height`. Defaults to `10em` to be sure that the Grid always has a height wherever it is
|
|
457
|
+
* inserted.
|
|
458
|
+
* ...
|
|
459
|
+
* [View online docs...](https://bryntum.com/products/scheduler/docs/api/Grid/view/Grid#config-minHeight)
|
|
460
|
+
*/
|
|
461
|
+
minHeight? : string|number
|
|
462
|
+
/**
|
|
463
|
+
* The elements minWidth. Can be either a String or a Number (which will have 'px' appended). Note that
|
|
464
|
+
* like [width](https://bryntum.com/products/scheduler/docs/api/Core/widget/Widget#config-width), *reading* the value will return the numeric value in pixels.
|
|
465
|
+
*/
|
|
466
|
+
minWidth? : string|number
|
|
467
|
+
/**
|
|
468
|
+
* Grid monitors window resize by default.
|
|
469
|
+
*/
|
|
470
|
+
monitorResize? : boolean
|
|
471
|
+
/**
|
|
472
|
+
* The owning Widget of this Widget. If this Widget is directly contained (that is, it is one of the
|
|
473
|
+
* [items](https://bryntum.com/products/scheduler/docs/api/Core/widget/Container#property-items) of a Container), this config will be ignored. In this case
|
|
474
|
+
* the owner is <strong>always</strong> the encapsulating Container.
|
|
475
|
+
* ...
|
|
476
|
+
* [View online docs...](https://bryntum.com/products/scheduler/docs/api/Grid/view/Grid#config-owner)
|
|
477
|
+
*/
|
|
478
|
+
owner? : Widget|any
|
|
479
|
+
/**
|
|
480
|
+
* Specify plugins (an array of classes) in config
|
|
481
|
+
*/
|
|
482
|
+
plugins? : Function[]
|
|
483
|
+
/**
|
|
484
|
+
* True to preserve focused cell after loading new data
|
|
485
|
+
*/
|
|
486
|
+
preserveFocusOnDatasetChange? : boolean
|
|
487
|
+
/**
|
|
488
|
+
* Preserve the grid's vertical scroll position when changesets are applied, as in the case of remote
|
|
489
|
+
* changes, or when stores are configured with [syncDataOnLoad](https://bryntum.com/products/scheduler/docs/api/Core/data/Store#config-syncDataOnLoad).
|
|
490
|
+
*/
|
|
491
|
+
preserveScroll? : PreserveScrollOptions|boolean
|
|
492
|
+
/**
|
|
493
|
+
* Specify `true` to preserve vertical scroll position after store actions that trigger a `refresh` event,
|
|
494
|
+
* such as loading new data and filtering.
|
|
495
|
+
*/
|
|
496
|
+
preserveScrollOnDatasetChange? : boolean
|
|
497
|
+
/**
|
|
498
|
+
* Prevent tooltip from being displayed on touch devices. Useful for example for buttons that display a
|
|
499
|
+
* menu on click etc, since the tooltip would be displayed at the same time.
|
|
500
|
+
*/
|
|
501
|
+
preventTooltipOnTouch? : boolean
|
|
502
|
+
/**
|
|
503
|
+
* Set to `true` to make the grid read-only, by disabling any UIs for modifying data.
|
|
504
|
+
* ...
|
|
505
|
+
* [View online docs...](https://bryntum.com/products/scheduler/docs/api/Grid/view/Grid#config-readOnly)
|
|
506
|
+
*/
|
|
507
|
+
readOnly? : boolean
|
|
508
|
+
relayStoreEvents? : boolean
|
|
509
|
+
/**
|
|
510
|
+
* Either a default `rendition` to apply to all child widgets, or a map of renditions keyed by child widget
|
|
511
|
+
* `type`.
|
|
512
|
+
* ...
|
|
513
|
+
* [View online docs...](https://bryntum.com/products/scheduler/docs/api/Grid/view/Grid#config-rendition)
|
|
514
|
+
*/
|
|
515
|
+
rendition? : string|Record<string, string>|null
|
|
516
|
+
/**
|
|
517
|
+
* Configure this property to allow the widget/component to be resized. Pressing <kbd>Shift</kbd> while resizing will
|
|
518
|
+
* constrain the aspect ratio.
|
|
519
|
+
* ...
|
|
520
|
+
* [View online docs...](https://bryntum.com/products/scheduler/docs/api/Grid/view/Grid#config-resizable)
|
|
521
|
+
*/
|
|
522
|
+
resizable? : boolean|{
|
|
523
|
+
minWidth?: number
|
|
524
|
+
maxWidth?: number
|
|
525
|
+
minHeight?: number
|
|
526
|
+
maxHeight?: number
|
|
527
|
+
handles?: object
|
|
528
|
+
}
|
|
529
|
+
/**
|
|
530
|
+
* Set to `false` to only measure cell contents when double-clicking the edge between column headers.
|
|
531
|
+
*/
|
|
532
|
+
resizeToFitIncludesHeader? : boolean
|
|
533
|
+
/**
|
|
534
|
+
* "Break points" for which responsive config to use for columns and css.
|
|
535
|
+
* ...
|
|
536
|
+
* [View online docs...](https://bryntum.com/products/scheduler/docs/api/Grid/view/Grid#config-responsiveLevels)
|
|
537
|
+
*/
|
|
538
|
+
responsiveLevels? : Record<string, number|string|ResponsiveLevelConfig>
|
|
539
|
+
/**
|
|
540
|
+
* Configure as `true` to have the component display a translucent ripple when its
|
|
541
|
+
* [focusElement](https://bryntum.com/products/scheduler/docs/api/Core/widget/Widget#property-focusElement), or [element](#Core/widget/Widget#property-element) is tapped <em>if the
|
|
542
|
+
* current theme supports ripples</em>. Out of the box, only the Material theme supports ripples.
|
|
543
|
+
* ...
|
|
544
|
+
* [View online docs...](https://bryntum.com/products/scheduler/docs/api/Grid/view/Grid#config-ripple)
|
|
545
|
+
*/
|
|
546
|
+
ripple? : boolean|{
|
|
547
|
+
delegate?: string
|
|
548
|
+
color?: string
|
|
549
|
+
radius?: number
|
|
550
|
+
clip?: string
|
|
551
|
+
}
|
|
552
|
+
/**
|
|
553
|
+
* If you are rendering this widget to a shadow root inside a web component, set this config to the shadowRoot. If not inside a web component, set it to `document.body`
|
|
554
|
+
*/
|
|
555
|
+
rootElement? : ShadowRoot|HTMLElement
|
|
556
|
+
/**
|
|
557
|
+
* Row height in pixels. This allows the default height for rows to be controlled. Note that it may be
|
|
558
|
+
* overriden by specifying a [rowHeight](https://bryntum.com/products/scheduler/docs/api/Grid/data/GridRowModel#field-rowHeight) on a per record basis, or from
|
|
559
|
+
* a column [renderer](https://bryntum.com/products/scheduler/docs/api/Grid/column/Column#config-renderer).
|
|
560
|
+
* ...
|
|
561
|
+
* [View online docs...](https://bryntum.com/products/scheduler/docs/api/Grid/view/Grid#config-rowHeight)
|
|
562
|
+
*/
|
|
563
|
+
rowHeight? : number
|
|
564
|
+
/**
|
|
565
|
+
* Set to `false` to not show row lines. End result might be overruled by/differ between themes.
|
|
566
|
+
*/
|
|
567
|
+
rowLines? : boolean
|
|
568
|
+
/**
|
|
569
|
+
* This may be configured as `true` to make the widget's element use the `direction:rtl` style.
|
|
570
|
+
* ...
|
|
571
|
+
* [View online docs...](https://bryntum.com/products/scheduler/docs/api/Grid/view/Grid#config-rtl)
|
|
572
|
+
*/
|
|
573
|
+
rtl? : boolean
|
|
574
|
+
/**
|
|
575
|
+
* Configures whether the grid is scrollable in the `Y` axis. This is used to configure a [Scroller](https://bryntum.com/products/scheduler/docs/api/Core/helper/util/Scroller).
|
|
576
|
+
* See the [scrollerClass](https://bryntum.com/products/scheduler/docs/api/Grid/view/GridBase#config-scrollerClass) config option.
|
|
577
|
+
* ...
|
|
578
|
+
* [View online docs...](https://bryntum.com/products/scheduler/docs/api/Grid/view/Grid#config-scrollable)
|
|
579
|
+
*/
|
|
580
|
+
scrollable? : boolean|ScrollerConfig|Scroller
|
|
581
|
+
/**
|
|
582
|
+
* The class to instantiate to use as the [scrollable](https://bryntum.com/products/scheduler/docs/api/Grid/view/GridBase#config-scrollable). Defaults to [Scroller](#Core/helper/util/Scroller).
|
|
583
|
+
*/
|
|
584
|
+
scrollerClass? : typeof Scroller
|
|
585
|
+
/**
|
|
586
|
+
* Configuration values for the [ScrollManager](https://bryntum.com/products/scheduler/docs/api/Core/util/ScrollManager) class on initialization. Returns the
|
|
587
|
+
* [ScrollManager](https://bryntum.com/products/scheduler/docs/api/Core/util/ScrollManager) at runtime.
|
|
588
|
+
*/
|
|
589
|
+
scrollManager? : ScrollManagerConfig|ScrollManager
|
|
590
|
+
/**
|
|
591
|
+
* Selection configuration settings, change these properties to control how selection works and what can be
|
|
592
|
+
* selected.
|
|
593
|
+
* ...
|
|
594
|
+
* [View online docs...](https://bryntum.com/products/scheduler/docs/api/Grid/view/Grid#config-selectionMode)
|
|
595
|
+
*/
|
|
596
|
+
selectionMode? : GridSelectionMode
|
|
597
|
+
/**
|
|
598
|
+
* Configure as `true` to have the grid show a red "changed" tag in cells whose
|
|
599
|
+
* field value has changed and not yet been committed.
|
|
600
|
+
* ...
|
|
601
|
+
* [View online docs...](https://bryntum.com/products/scheduler/docs/api/Grid/view/Grid#config-showDirty)
|
|
602
|
+
*/
|
|
603
|
+
showDirty? : boolean|{
|
|
604
|
+
duringEdit?: boolean
|
|
605
|
+
newRecord?: boolean
|
|
606
|
+
}
|
|
607
|
+
/**
|
|
608
|
+
* Programmatic control over how many columns to span when used in a grid layout.
|
|
609
|
+
*/
|
|
610
|
+
span? : number
|
|
611
|
+
/**
|
|
612
|
+
* This value can be one of the following:
|
|
613
|
+
* ...
|
|
614
|
+
* [View online docs...](https://bryntum.com/products/scheduler/docs/api/Grid/view/Grid#config-stateful)
|
|
615
|
+
*/
|
|
616
|
+
stateful? : boolean|object|string[]
|
|
617
|
+
/**
|
|
618
|
+
* The events that, when fired by this component, should trigger it to save its state by calling
|
|
619
|
+
* [saveState](https://bryntum.com/products/scheduler/docs/api/Core/mixin/State#function-saveState).
|
|
620
|
+
* ...
|
|
621
|
+
* [View online docs...](https://bryntum.com/products/scheduler/docs/api/Grid/view/Grid#config-statefulEvents)
|
|
622
|
+
*/
|
|
623
|
+
statefulEvents? : object|string[]
|
|
624
|
+
/**
|
|
625
|
+
* The key to use when saving this object's state in the [stateProvider](https://bryntum.com/products/scheduler/docs/api/Core/mixin/State#config-stateProvider). If this config is
|
|
626
|
+
* not assigned, and [stateful](https://bryntum.com/products/scheduler/docs/api/Core/mixin/State#config-stateful) is not set to `false`, the [id](#Core/widget/Widget#config-id)
|
|
627
|
+
* (if explicitly specified) will be used as the `stateId`.
|
|
628
|
+
* ...
|
|
629
|
+
* [View online docs...](https://bryntum.com/products/scheduler/docs/api/Grid/view/Grid#config-stateId)
|
|
630
|
+
*/
|
|
631
|
+
stateId? : string
|
|
632
|
+
/**
|
|
633
|
+
* The `StateProvider` to use to save and restore this object's [state](https://bryntum.com/products/scheduler/docs/api/Core/mixin/State#property-state). By default, `state`
|
|
634
|
+
* will be saved using the [default state provider](https://bryntum.com/products/scheduler/docs/api/Core/state/StateProvider#property-instance-static).
|
|
635
|
+
* ...
|
|
636
|
+
* [View online docs...](https://bryntum.com/products/scheduler/docs/api/Grid/view/Grid#config-stateProvider)
|
|
637
|
+
*/
|
|
638
|
+
stateProvider? : StateProvider
|
|
639
|
+
/**
|
|
640
|
+
* The properties of this settings object controls how grid is restored from state data.
|
|
641
|
+
* ...
|
|
642
|
+
* [View online docs...](https://bryntum.com/products/scheduler/docs/api/Grid/view/Grid#config-stateSettings)
|
|
643
|
+
*/
|
|
644
|
+
stateSettings? : {
|
|
645
|
+
restoreUnconfiguredColumns?: boolean
|
|
646
|
+
}
|
|
647
|
+
/**
|
|
648
|
+
* Store that holds records to display in the grid, or a store config object. If the configuration contains
|
|
649
|
+
* a `readUrl`, an `AjaxStore` will be created.
|
|
650
|
+
* ...
|
|
651
|
+
* [View online docs...](https://bryntum.com/products/scheduler/docs/api/Grid/view/Grid#config-store)
|
|
652
|
+
*/
|
|
653
|
+
store? : Store|StoreConfig|AjaxStore|AjaxStoreConfig
|
|
654
|
+
/**
|
|
655
|
+
* An object containing widgets keyed by name. By default (when no `type` is given), strips are
|
|
656
|
+
* [toolbars](https://bryntum.com/products/scheduler/docs/api/Core/widget/Toolbar). If you want to pass an array, you can use
|
|
657
|
+
* the toolbar's [items](https://bryntum.com/products/scheduler/docs/api/Core/widget/Container#config-items).
|
|
658
|
+
* ...
|
|
659
|
+
* [View online docs...](https://bryntum.com/products/scheduler/docs/api/Grid/view/Grid#config-strips)
|
|
660
|
+
*/
|
|
661
|
+
strips? : Record<string, ContainerItemConfig>
|
|
662
|
+
/**
|
|
663
|
+
* An object containing sub grid configuration objects keyed by a `region` property.
|
|
664
|
+
* By default, grid has a 'locked' region (if configured with locked columns) and a 'normal' region.
|
|
665
|
+
* The 'normal' region defaults to use `flex: 1`.
|
|
666
|
+
* ...
|
|
667
|
+
* [View online docs...](https://bryntum.com/products/scheduler/docs/api/Grid/view/Grid#config-subGridConfigs)
|
|
668
|
+
*/
|
|
669
|
+
subGridConfigs? : Record<string, SubGridConfig>
|
|
670
|
+
/**
|
|
671
|
+
* A [Mask](https://bryntum.com/products/scheduler/docs/api/Core/widget/Mask) config object, or a message to be shown when Crud Manager
|
|
672
|
+
* is persisting changes on the server. Set to `null` to disable default sync mask.
|
|
673
|
+
* ...
|
|
674
|
+
* [View online docs...](https://bryntum.com/products/scheduler/docs/api/Grid/view/Grid#config-syncMask)
|
|
675
|
+
*/
|
|
676
|
+
syncMask? : string|MaskConfig|null
|
|
677
|
+
/**
|
|
678
|
+
* A configuration for the [tab](https://bryntum.com/products/scheduler/docs/api/Core/widget/Tab) created for this widget when it is placed in a
|
|
679
|
+
* [TabPanel](https://bryntum.com/products/scheduler/docs/api/Core/widget/TabPanel). For example, this config can be used to control the icon of the `tab` for
|
|
680
|
+
* this widget:
|
|
681
|
+
* ...
|
|
682
|
+
* [View online docs...](https://bryntum.com/products/scheduler/docs/api/Grid/view/Grid#config-tab)
|
|
683
|
+
*/
|
|
684
|
+
tab? : boolean|TabConfig
|
|
685
|
+
/**
|
|
686
|
+
* When this container is used as a tab in a TabPanel, these items are added to the
|
|
687
|
+
* [TabBar](https://bryntum.com/products/scheduler/docs/api/Core/widget/TabBar) when this container is the active tab.
|
|
688
|
+
* ...
|
|
689
|
+
* [View online docs...](https://bryntum.com/products/scheduler/docs/api/Grid/view/Grid#config-tabBarItems)
|
|
690
|
+
*/
|
|
691
|
+
tabBarItems? : ToolbarItems[]|Widget[]
|
|
692
|
+
/**
|
|
693
|
+
* A Config object representing the configuration of a [Toolbar](https://bryntum.com/products/scheduler/docs/api/Core/widget/Toolbar),
|
|
694
|
+
* or array of config objects representing the child items of a Toolbar.
|
|
695
|
+
* This creates a toolbar docked to the top of the panel immediately below the header.
|
|
696
|
+
* ...
|
|
697
|
+
* [View online docs...](https://bryntum.com/products/scheduler/docs/api/Grid/view/Grid#config-tbar)
|
|
698
|
+
*/
|
|
699
|
+
tbar? : (ContainerItemConfig|string)[]|ToolbarConfig|PagingToolbarConfig|null
|
|
700
|
+
/**
|
|
701
|
+
* A title to display in the header or owning TabPanel. Causes creation and docking of a header
|
|
702
|
+
* to the top if no header is configured.
|
|
703
|
+
* ...
|
|
704
|
+
* [View online docs...](https://bryntum.com/products/scheduler/docs/api/Grid/view/Grid#config-title)
|
|
705
|
+
*/
|
|
706
|
+
title? : string
|
|
707
|
+
/**
|
|
708
|
+
* The [tools](https://bryntum.com/products/scheduler/docs/api/Core/widget/Tool) to add either before or after the `title` in the Panel header. Each
|
|
709
|
+
* property name is the reference by which an instantiated tool may be retrieved from the live
|
|
710
|
+
* `[tools](https://bryntum.com/products/scheduler/docs/api/Core/widget/mixin/Toolable#property-tools)` property.
|
|
711
|
+
* ...
|
|
712
|
+
* [View online docs...](https://bryntum.com/products/scheduler/docs/api/Grid/view/Grid#config-tools)
|
|
713
|
+
*/
|
|
714
|
+
tools? : Record<string, ToolConfig>|null
|
|
715
|
+
/**
|
|
716
|
+
* Configure UI transitions for various actions in the grid.
|
|
717
|
+
*/
|
|
718
|
+
transition? : {
|
|
719
|
+
insertRecord?: boolean
|
|
720
|
+
removeRecord?: boolean
|
|
721
|
+
toggleColumn?: boolean
|
|
722
|
+
expandCollapseColumn?: boolean
|
|
723
|
+
toggleRegion?: boolean
|
|
724
|
+
toggleTreeNode?: boolean
|
|
725
|
+
toggleGroup?: boolean
|
|
726
|
+
filterRemoval?: boolean
|
|
727
|
+
}
|
|
728
|
+
/**
|
|
729
|
+
* Animation transition duration in milliseconds.
|
|
730
|
+
*/
|
|
731
|
+
transitionDuration? : number
|
|
732
|
+
type? : 'grid'
|
|
733
|
+
/**
|
|
734
|
+
* Custom CSS class name suffixes to apply to the elements rendered by this widget. This may be specified
|
|
735
|
+
* as a space separated string, an array of strings, or as an object in which property names with truthy
|
|
736
|
+
* values are used as the class names.
|
|
737
|
+
* ...
|
|
738
|
+
* [View online docs...](https://bryntum.com/products/scheduler/docs/api/Grid/view/Grid#config-ui)
|
|
739
|
+
*/
|
|
740
|
+
ui? : 'plain'|'toolbar'|string|object
|
|
741
|
+
/**
|
|
742
|
+
* A widgets weight determines its position among siblings when added to a [Container](https://bryntum.com/products/scheduler/docs/api/Core/widget/Container).
|
|
743
|
+
* Higher weights go further down.
|
|
744
|
+
*/
|
|
745
|
+
weight? : number
|
|
746
|
+
/**
|
|
747
|
+
* Widget's width, used to set element `style.width`. Either specify a valid width string or a number, which
|
|
748
|
+
* will get 'px' appended. We recommend using CSS as the primary way to control width, but in some cases
|
|
749
|
+
* this config is convenient.
|
|
750
|
+
*/
|
|
751
|
+
width? : string|number
|
|
752
|
+
|
|
753
|
+
// Events
|
|
754
|
+
/**
|
|
755
|
+
* Fires on the owning Grid before the cell editing is canceled, return `false` to prevent cancellation.
|
|
756
|
+
* @param {object} event Event object
|
|
757
|
+
* @param {Grid.view.Grid} event.source Owner grid
|
|
758
|
+
* @param {Grid.util.GridLocation} event.editorContext Editing context
|
|
759
|
+
*/
|
|
760
|
+
onBeforeCancelCellEdit? : ((event: { source: Grid, editorContext: GridLocation }) => Promise<boolean>|boolean|void)|string
|
|
761
|
+
/**
|
|
762
|
+
* Fires on the owning Grid before the row editing is canceled, return false to signal that the value is invalid and editing should not be finalized.
|
|
763
|
+
* ...
|
|
764
|
+
* [View online docs...](https://bryntum.com/products/scheduler/docs/api/Grid/view/Grid#event-beforeCancelRowEdit)
|
|
765
|
+
* @param {object} event Event object
|
|
766
|
+
* @param {Grid.view.Grid} event.grid Target grid
|
|
767
|
+
* @param {RowEditorContext} event.editorContext Editing context
|
|
768
|
+
*/
|
|
769
|
+
onBeforeCancelRowEdit? : ((event: { grid: Grid, editorContext: RowEditorContext }) => Promise<boolean>|boolean|void)|string
|
|
770
|
+
/**
|
|
771
|
+
* Fires on the owning Grid before editing starts, return `false` to prevent editing
|
|
772
|
+
* @param {object} event Event object
|
|
773
|
+
* @param {Grid.view.Grid} event.source Owner grid
|
|
774
|
+
* @param {CellEditorContext} event.editorContext Editing context
|
|
775
|
+
*/
|
|
776
|
+
onBeforeCellEditStart? : ((event: { source: Grid, editorContext: CellEditorContext }) => Promise<boolean>|boolean|void)|string
|
|
777
|
+
/**
|
|
778
|
+
* Fires on the owning Grid before deleting a range of selected cell values by pressing `Backspace` or `Del`
|
|
779
|
+
* buttons while [autoEdit](https://bryntum.com/products/scheduler/docs/api/Grid/feature/CellEdit#config-autoEdit) is set to `true`. Return `false` to prevent editing.
|
|
780
|
+
* @param {object} event Event object
|
|
781
|
+
* @param {Grid.view.Grid} event.source Owner grid
|
|
782
|
+
* @param {(Grid.util.GridLocation|Core.data.Model)[]} event.gridSelection An array of cell selectors or records that will have their values deleted (the records themselves will not get deleted, only visible column values).
|
|
783
|
+
*/
|
|
784
|
+
onBeforeCellRangeDelete? : ((event: { source: Grid, gridSelection: (GridLocation|Model)[] }) => Promise<boolean>|boolean|void)|string
|
|
785
|
+
/**
|
|
786
|
+
* Fires for each selected record on the owning Grid before editing a range of selected cell values
|
|
787
|
+
* @param {object} event Event object
|
|
788
|
+
* @param {Core.data.Model} event.record Current selected record from the range
|
|
789
|
+
* @param {string} event.field The field being changed
|
|
790
|
+
* @param {any} event.value The value being set
|
|
791
|
+
*/
|
|
792
|
+
onBeforeCellRangeEdit? : ((event: { record: Model, field: string, value: any }) => Promise<boolean>|boolean|void)|string
|
|
793
|
+
/**
|
|
794
|
+
* This event is fired prior to starting a column drag gesture. The drag is canceled if a listener returns `false`.
|
|
795
|
+
* @param {object} event Event object
|
|
796
|
+
* @param {Grid.view.Grid} event.source The grid instance.
|
|
797
|
+
* @param {Grid.column.Column} event.column The dragged column.
|
|
798
|
+
* @param {Event} event.event The browser event.
|
|
799
|
+
*/
|
|
800
|
+
onBeforeColumnDragStart? : ((event: { source: Grid, column: Column, event: Event }) => Promise<boolean>|boolean|void)|string
|
|
801
|
+
/**
|
|
802
|
+
* This event is fired when a column is dropped, and you can return false from a listener to abort the operation.
|
|
803
|
+
* @param {object} event Event object
|
|
804
|
+
* @param {Grid.view.Grid} event.source The grid instance.
|
|
805
|
+
* @param {Grid.column.Column} event.column The dragged column.
|
|
806
|
+
* @param {Grid.column.Column} event.insertBefore The column before which the dragged column will be inserted.
|
|
807
|
+
* @param {Grid.column.Column} event.newParent The new parent column.
|
|
808
|
+
* @param {Event} event.event The browser event.
|
|
809
|
+
* @param {string} event.region The region where the column was dropped.
|
|
810
|
+
*/
|
|
811
|
+
onBeforeColumnDropFinalize? : ((event: { source: Grid, column: Column, insertBefore: Column, newParent: Column, event: Event, region: string }) => Promise<boolean>|boolean|void)|string
|
|
812
|
+
/**
|
|
813
|
+
* This event is fired prior to starting a column resize gesture. The resize is canceled if a listener returns
|
|
814
|
+
* `false`.
|
|
815
|
+
* @param {object} event Event object
|
|
816
|
+
* @param {Grid.view.Grid} event.source The grid instance
|
|
817
|
+
* @param {Grid.column.Column} event.column The column
|
|
818
|
+
* @param {Event} event.domEvent The browser event
|
|
819
|
+
*/
|
|
820
|
+
onBeforeColumnResize? : ((event: { source: Grid, column: Column, domEvent: Event }) => Promise<boolean>|boolean|void)|string
|
|
821
|
+
/**
|
|
822
|
+
* Fires on the owning Grid before a copy action is performed, return `false` to prevent the action
|
|
823
|
+
* @param {object} event Event object
|
|
824
|
+
* @param {Grid.view.Grid} event.source Owner grid
|
|
825
|
+
* @param {Grid.util.GridLocation[]} event.cells The cells about to be copied or cut
|
|
826
|
+
* @param {string} event.data The string data about to be copied or cut
|
|
827
|
+
* @param {boolean} event.isCut `true` if this is a cut action
|
|
828
|
+
* @param {string} event.entityName 'cell' to distinguish this event from other beforeCopy events
|
|
829
|
+
*/
|
|
830
|
+
onBeforeCopy? : ((event: { source: Grid, cells: GridLocation[], data: string, isCut: boolean, entityName: string }) => Promise<boolean>|boolean|void)|string
|
|
831
|
+
/**
|
|
832
|
+
* Fires on the owning Grid before CSV export starts. Return `false` to cancel the export.
|
|
833
|
+
* @param {object} event Event object
|
|
834
|
+
* @param {ExportConfig} event.config Export config
|
|
835
|
+
* @param {Grid.column.Column[]} event.columns An array of columns to export
|
|
836
|
+
* @param {Core.data.Model[]} event.rows An array of records to export
|
|
837
|
+
* @param {string} event.lineDelimiter The CSV delimiter to separate lines
|
|
838
|
+
* @param {string} event.columnDelimiter The CSV delimiter to separate values on one line
|
|
839
|
+
*/
|
|
840
|
+
onBeforeCSVExport? : ((event: { config: ExportConfig, columns: Column[], rows: Model[], lineDelimiter: string, columnDelimiter: string }) => Promise<boolean>|boolean|void)|string
|
|
841
|
+
/**
|
|
842
|
+
* Fires before an object is destroyed.
|
|
843
|
+
* @param {object} event Event object
|
|
844
|
+
* @param {Core.Base} event.source The Object that is being destroyed.
|
|
845
|
+
*/
|
|
846
|
+
onBeforeDestroy? : ((event: { source: Base }) => void)|string
|
|
847
|
+
/**
|
|
848
|
+
* Fires on the owning Grid before Excel export starts. Return `false` to cancel the export.
|
|
849
|
+
* @param {object} event Event object
|
|
850
|
+
* @param {ExportConfig} event.config Export config
|
|
851
|
+
* @param {XLSColumn[]} event.columns An array of columns to export
|
|
852
|
+
* @param {any[][]} event.rows An array of records to export
|
|
853
|
+
*/
|
|
854
|
+
onBeforeExcelExport? : ((event: { config: ExportConfig, columns: XLSColumn[], rows: any[] }) => Promise<boolean>|boolean|void)|string
|
|
855
|
+
/**
|
|
856
|
+
* Fired before dragging of the FillHandle starts, return `false` to prevent the drag operation.
|
|
857
|
+
* @param {object} event Event object
|
|
858
|
+
* @param {Grid.util.GridLocation} event.cell Information about the column / record
|
|
859
|
+
* @param {MouseEvent} event.domEvent The raw DOM event
|
|
860
|
+
*/
|
|
861
|
+
onBeforeFillHandleDragStart? : ((event: { cell: GridLocation, domEvent: MouseEvent }) => Promise<boolean>|boolean|void)|string
|
|
862
|
+
/**
|
|
863
|
+
* Fires on the owning Grid before the cell editing is finished, return false to signal that the value is invalid and editing should not be finalized.
|
|
864
|
+
* @param {object} event Event object
|
|
865
|
+
* @param {Grid.view.Grid} event.grid Target grid
|
|
866
|
+
* @param {CellEditorContext} event.editorContext Editing context
|
|
867
|
+
*/
|
|
868
|
+
onBeforeFinishCellEdit? : ((event: { grid: Grid, editorContext: CellEditorContext }) => void)|string
|
|
869
|
+
/**
|
|
870
|
+
* Fires on the owning Grid before the row editing is finished, return false to signal that the value is invalid and editing should not be finalized.
|
|
871
|
+
* ...
|
|
872
|
+
* [View online docs...](https://bryntum.com/products/scheduler/docs/api/Grid/view/Grid#event-beforeFinishRowEdit)
|
|
873
|
+
* @param {object} event Event object
|
|
874
|
+
* @param {Grid.view.Grid} event.grid Target grid
|
|
875
|
+
* @param {RowEditorContext} event.editorContext Editing context
|
|
876
|
+
*/
|
|
877
|
+
onBeforeFinishRowEdit? : ((event: { grid: Grid, editorContext: RowEditorContext }) => Promise<boolean>|boolean|void)|string
|
|
878
|
+
/**
|
|
879
|
+
* Triggered before a widget is hidden. Return `false` to prevent the action.
|
|
880
|
+
* @param {object} event Event object
|
|
881
|
+
* @param {Core.widget.Widget} event.source The widget being hidden.
|
|
882
|
+
*/
|
|
883
|
+
onBeforeHide? : ((event: { source: Widget }) => Promise<boolean>|boolean|void)|string
|
|
884
|
+
/**
|
|
885
|
+
* Fires on the owning Grid before a paste action is performed, return `false` to prevent the action
|
|
886
|
+
* @param {object} event Event object
|
|
887
|
+
* @param {Grid.view.Grid} event.source Owner grid
|
|
888
|
+
* @param {string} event.clipboardData The clipboardData about to be pasted
|
|
889
|
+
* @param {Grid.util.GridLocation} event.targetCell The cell from which the paste will be started
|
|
890
|
+
* @param {string} event.entityName 'cell' to distinguish this event from other beforePaste events
|
|
891
|
+
* @param {string} event.text The raw text from clipboard
|
|
892
|
+
*/
|
|
893
|
+
onBeforePaste? : ((event: { source: Grid, clipboardData: string, targetCell: GridLocation, entityName: string, text: string }) => Promise<boolean>|boolean|void)|string
|
|
894
|
+
/**
|
|
895
|
+
* Fires on the owning Grid before export started. Return `false` to cancel the export.
|
|
896
|
+
* @param {object} event Event object
|
|
897
|
+
* @param {object} event.config Export config
|
|
898
|
+
*/
|
|
899
|
+
onBeforePdfExport? : ((event: { config: object }) => Promise<boolean>|boolean|void)|string
|
|
900
|
+
/**
|
|
901
|
+
* Fires before a row is rendered.
|
|
902
|
+
* @param {object} event Event object
|
|
903
|
+
* @param {Grid.view.Grid} event.source The firing Grid instance.
|
|
904
|
+
* @param {Grid.row.Row} event.row The row about to be rendered.
|
|
905
|
+
* @param {Core.data.Model} event.record The record for the row.
|
|
906
|
+
* @param {number} event.recordIndex The zero-based index of the record.
|
|
907
|
+
*/
|
|
908
|
+
onBeforeRenderRow? : ((event: { source: Grid, row: Row, record: Model, recordIndex: number }) => void)|string
|
|
909
|
+
/**
|
|
910
|
+
* Grid rows are about to be rendered
|
|
911
|
+
* @param {object} event Event object
|
|
912
|
+
* @param {Grid.view.Grid} event.source This grid.
|
|
913
|
+
*/
|
|
914
|
+
onBeforeRenderRows? : ((event: { source: Grid }) => void)|string
|
|
915
|
+
/**
|
|
916
|
+
* This event fires before row collapse is started.
|
|
917
|
+
* ...
|
|
918
|
+
* [View online docs...](https://bryntum.com/products/scheduler/docs/api/Grid/view/Grid#event-beforeRowCollapse)
|
|
919
|
+
* @param {object} event Event object
|
|
920
|
+
* @param {Core.data.Model} event.record Record
|
|
921
|
+
*/
|
|
922
|
+
onBeforeRowCollapse? : ((event: { record: Model }) => Promise<boolean>|boolean|void)|string
|
|
923
|
+
/**
|
|
924
|
+
* This event fires before row expand is started.
|
|
925
|
+
* ...
|
|
926
|
+
* [View online docs...](https://bryntum.com/products/scheduler/docs/api/Grid/view/Grid#event-beforeRowExpand)
|
|
927
|
+
* @param {object} event Event object
|
|
928
|
+
* @param {Core.data.Model} event.record Record
|
|
929
|
+
*/
|
|
930
|
+
onBeforeRowExpand? : ((event: { record: Model }) => Promise<boolean>|boolean|void)|string
|
|
931
|
+
/**
|
|
932
|
+
* Fires before the selection changes. Returning `false` from a listener prevents the change
|
|
933
|
+
* @param {object} event Event object
|
|
934
|
+
* @param {string} event.action `'select'`/`'deselect'`
|
|
935
|
+
* @param {'row','cell'} event.mode `'row'`/`'cell'`
|
|
936
|
+
* @param {Grid.view.Grid} event.source
|
|
937
|
+
* @param {Core.data.Model[]} event.deselected The records to be deselected in this operation.
|
|
938
|
+
* @param {Core.data.Model[]} event.selected The records to be selected in this operation.
|
|
939
|
+
* @param {Core.data.Model[]} event.selection The records in the current selection, before applying `selected` and `deselected`
|
|
940
|
+
* @param {Grid.util.GridLocation[]} event.deselectedCells The cells to be deselected in this operation.
|
|
941
|
+
* @param {Grid.util.GridLocation[]} event.selectedCells The cells to be selected in this operation.
|
|
942
|
+
* @param {Grid.util.GridLocation[]} event.cellSelection The cells in the current selection, before applying `selectedCells` and `deselectedCells`
|
|
943
|
+
*/
|
|
944
|
+
onBeforeSelectionChange? : ((event: { action: string, mode: 'row'|'cell', source: Grid, deselected: Model[], selected: Model[], selection: Model[], deselectedCells: GridLocation[], selectedCells: GridLocation[], cellSelection: GridLocation[] }) => Promise<boolean>|boolean|void)|string
|
|
945
|
+
/**
|
|
946
|
+
* Fired before this container will load record values into its child fields. This is useful if you
|
|
947
|
+
* want to modify the UI before data is loaded (e.g. set some input field to be readonly)
|
|
948
|
+
* @param {object} event Event object
|
|
949
|
+
* @param {Core.widget.Container} event.source The container
|
|
950
|
+
* @param {Core.data.Model} event.record The record
|
|
951
|
+
*/
|
|
952
|
+
onBeforeSetRecord? : ((event: { source: Container, record: Model }) => void)|string
|
|
953
|
+
/**
|
|
954
|
+
* Triggered before a widget is shown. Return `false` to prevent the action.
|
|
955
|
+
* @param {object} event Event object
|
|
956
|
+
* @param {Core.widget.Widget,any} event.source The widget being shown
|
|
957
|
+
*/
|
|
958
|
+
onBeforeShow? : ((event: { source: Widget|any }) => Promise<boolean>|boolean|void)|string
|
|
959
|
+
/**
|
|
960
|
+
* Fires on the owning Grid before editing starts, return `false` to prevent editing
|
|
961
|
+
* @param {object} event Event object
|
|
962
|
+
* @param {Grid.view.Grid} event.source Owner grid
|
|
963
|
+
* @param {RowEditorContext} event.editorContext Editing context
|
|
964
|
+
*/
|
|
965
|
+
onBeforeStartRowEdit? : ((event: { source: Grid, editorContext: RowEditorContext }) => Promise<boolean>|boolean|void)|string
|
|
966
|
+
/**
|
|
967
|
+
* Fired before state is applied to the source. Allows editing the state object or preventing the operation.
|
|
968
|
+
* @param {object} event Event object
|
|
969
|
+
* @param {GridStateInfo} event.state State object config
|
|
970
|
+
*/
|
|
971
|
+
onBeforeStateApply? : ((event: { state: GridStateInfo }) => Promise<boolean>|boolean|void)|string
|
|
972
|
+
/**
|
|
973
|
+
* Fired before state is saved by the StateProvider. Allows editing the state object or preventing the operation.
|
|
974
|
+
* @param {object} event Event object
|
|
975
|
+
* @param {GridStateInfo} event.state State object config
|
|
976
|
+
*/
|
|
977
|
+
onBeforeStateSave? : ((event: { state: GridStateInfo }) => Promise<boolean>|boolean|void)|string
|
|
978
|
+
/**
|
|
979
|
+
* Fired when a group is going to be expanded or collapsed using the UI.
|
|
980
|
+
* Returning `false` from a listener prevents the operation
|
|
981
|
+
* @param {object} event Event object
|
|
982
|
+
* @param {Core.data.Model} event.groupRecord [DEPRECATED] Use `groupRecords` param instead
|
|
983
|
+
* @param {Core.data.Model[]} event.groupRecords The group records being toggled
|
|
984
|
+
* @param {boolean} event.collapse Collapsed (true) or expanded (false)
|
|
985
|
+
* @param {Event} event.domEvent The user interaction event (eg a `click` event) if the toggle request was instigated by user interaction.
|
|
986
|
+
*/
|
|
987
|
+
onBeforeToggleGroup? : ((event: { groupRecord: Model, groupRecords: Model[], collapse: boolean, domEvent: Event }) => Promise<boolean>|boolean|void)|string
|
|
988
|
+
/**
|
|
989
|
+
* Fired before a parent node record toggles its collapsed state.
|
|
990
|
+
* @param {object} event Event object
|
|
991
|
+
* @param {Grid.view.Grid} event.source The firing Grid instance.
|
|
992
|
+
* @param {Core.data.Model} event.record The record being toggled.
|
|
993
|
+
* @param {boolean} event.collapse `true` if the node is being collapsed.
|
|
994
|
+
*/
|
|
995
|
+
onBeforeToggleNode? : ((event: { source: Grid, record: Model, collapse: boolean }) => void)|string
|
|
996
|
+
/**
|
|
997
|
+
* Fires on the owning Grid when editing is cancelled
|
|
998
|
+
* @param {object} event Event object
|
|
999
|
+
* @param {Grid.view.Grid} event.source Owner grid
|
|
1000
|
+
* @param {Grid.util.GridLocation} event.editorContext Editing context
|
|
1001
|
+
* @param {Event} event.event Included if the cancellation was triggered by a DOM event
|
|
1002
|
+
*/
|
|
1003
|
+
onCancelCellEdit? : ((event: { source: Grid, editorContext: GridLocation, event: Event }) => void)|string
|
|
1004
|
+
/**
|
|
1005
|
+
* Fires when any other event is fired from the object.
|
|
1006
|
+
* ...
|
|
1007
|
+
* [View online docs...](https://bryntum.com/products/scheduler/docs/api/Grid/view/Grid#event-catchAll)
|
|
1008
|
+
* @param {object} event Event object
|
|
1009
|
+
* @param {{[key: string]: any, type: string}} event.event The Object that contains event details
|
|
1010
|
+
* @param {string} event.event.type The type of the event which is caught by the listener
|
|
1011
|
+
*/
|
|
1012
|
+
onCatchAll? : ((event: {[key: string]: any, type: string}) => void)|string
|
|
1013
|
+
/**
|
|
1014
|
+
* Fired when user clicks in a grid cell
|
|
1015
|
+
* @param {object} event Event object
|
|
1016
|
+
* @param {Grid.view.Grid} event.grid The grid instance
|
|
1017
|
+
* @param {Core.data.Model} event.record The record representing the row
|
|
1018
|
+
* @param {Grid.column.Column} event.column The column to which the cell belongs
|
|
1019
|
+
* @param {HTMLElement} event.cellElement The cell HTML element
|
|
1020
|
+
* @param {HTMLElement} event.target The target element
|
|
1021
|
+
* @param {MouseEvent} event.event The native DOM event
|
|
1022
|
+
*/
|
|
1023
|
+
onCellClick? : ((event: { grid: Grid, record: Model, column: Column, cellElement: HTMLElement, target: HTMLElement, event: MouseEvent }) => void)|string
|
|
1024
|
+
/**
|
|
1025
|
+
* Fired when user activates contextmenu in a grid cell
|
|
1026
|
+
* @param {object} event Event object
|
|
1027
|
+
* @param {Grid.view.Grid} event.grid The grid instance
|
|
1028
|
+
* @param {Core.data.Model} event.record The record representing the row
|
|
1029
|
+
* @param {Grid.column.Column} event.column The column to which the cell belongs
|
|
1030
|
+
* @param {HTMLElement} event.cellElement The cell HTML element
|
|
1031
|
+
* @param {HTMLElement} event.target The target element
|
|
1032
|
+
* @param {MouseEvent} event.event The native DOM event
|
|
1033
|
+
*/
|
|
1034
|
+
onCellContextMenu? : ((event: { grid: Grid, record: Model, column: Column, cellElement: HTMLElement, target: HTMLElement, event: MouseEvent }) => void)|string
|
|
1035
|
+
/**
|
|
1036
|
+
* Fired when user double clicks a grid cell
|
|
1037
|
+
* @param {object} event Event object
|
|
1038
|
+
* @param {Grid.view.Grid} event.grid The grid instance
|
|
1039
|
+
* @param {Core.data.Model} event.record The record representing the row
|
|
1040
|
+
* @param {Grid.column.Column} event.column The column to which the cell belongs
|
|
1041
|
+
* @param {HTMLElement} event.cellElement The cell HTML element
|
|
1042
|
+
* @param {HTMLElement} event.target The target element
|
|
1043
|
+
* @param {MouseEvent} event.event The native DOM event
|
|
1044
|
+
*/
|
|
1045
|
+
onCellDblClick? : ((event: { grid: Grid, record: Model, column: Column, cellElement: HTMLElement, target: HTMLElement, event: MouseEvent }) => void)|string
|
|
1046
|
+
/**
|
|
1047
|
+
* This event fires on the owning grid before the context menu is shown for a cell.
|
|
1048
|
+
* Allows manipulation of the items to show in the same way as in the [processItems](https://bryntum.com/products/scheduler/docs/api/Grid/feature/CellMenu#config-processItems).
|
|
1049
|
+
* ...
|
|
1050
|
+
* [View online docs...](https://bryntum.com/products/scheduler/docs/api/Grid/view/Grid#event-cellMenuBeforeShow)
|
|
1051
|
+
* @param {object} event Event object
|
|
1052
|
+
* @param {Grid.view.Grid} event.source The grid
|
|
1053
|
+
* @param {Core.widget.Menu} event.menu The menu
|
|
1054
|
+
* @param {Record<string, MenuItemEntry>} event.items Menu item configs
|
|
1055
|
+
* @param {Grid.column.Column} event.column Column
|
|
1056
|
+
* @param {Core.data.Model} event.record Record
|
|
1057
|
+
*/
|
|
1058
|
+
onCellMenuBeforeShow? : ((event: { source: Grid, menu: Menu, items: Record<string, MenuItemEntry>, column: Column, record: Model }) => Promise<boolean>|boolean|void)|string
|
|
1059
|
+
/**
|
|
1060
|
+
* This event fires on the owning grid when an item is selected in the cell context menu.
|
|
1061
|
+
* @param {object} event Event object
|
|
1062
|
+
* @param {Grid.view.Grid} event.source The grid
|
|
1063
|
+
* @param {Core.widget.Menu} event.menu The menu
|
|
1064
|
+
* @param {Core.widget.MenuItem} event.item Selected menu item
|
|
1065
|
+
* @param {Grid.column.Column} event.column Column
|
|
1066
|
+
* @param {Core.data.Model} event.record Record
|
|
1067
|
+
*/
|
|
1068
|
+
onCellMenuItem? : ((event: { source: Grid, menu: Menu, item: MenuItem, column: Column, record: Model }) => void)|string
|
|
1069
|
+
/**
|
|
1070
|
+
* This event fires on the owning grid after the context menu is shown for a cell.
|
|
1071
|
+
* @param {object} event Event object
|
|
1072
|
+
* @param {Grid.view.Grid} event.source The grid
|
|
1073
|
+
* @param {Core.widget.Menu} event.menu The menu
|
|
1074
|
+
* @param {Record<string, MenuItemEntry>} event.items Menu item configs
|
|
1075
|
+
* @param {Grid.column.Column} event.column Column
|
|
1076
|
+
* @param {Core.data.Model} event.record Record
|
|
1077
|
+
*/
|
|
1078
|
+
onCellMenuShow? : ((event: { source: Grid, menu: Menu, items: Record<string, MenuItemEntry>, column: Column, record: Model }) => void)|string
|
|
1079
|
+
/**
|
|
1080
|
+
* This event fires on the owning grid when a check item is toggled in the cell context menu.
|
|
1081
|
+
* @param {object} event Event object
|
|
1082
|
+
* @param {Grid.view.Grid} event.source The grid
|
|
1083
|
+
* @param {Core.widget.Menu} event.menu The menu
|
|
1084
|
+
* @param {Core.widget.MenuItem} event.item Selected menu item
|
|
1085
|
+
* @param {Grid.column.Column} event.column Column
|
|
1086
|
+
* @param {Core.data.Model} event.record Record
|
|
1087
|
+
* @param {boolean} event.checked Checked or not
|
|
1088
|
+
*/
|
|
1089
|
+
onCellMenuToggleItem? : ((event: { source: Grid, menu: Menu, item: MenuItem, column: Column, record: Model, checked: boolean }) => void)|string
|
|
1090
|
+
/**
|
|
1091
|
+
* Fired when the mouse enters a cell
|
|
1092
|
+
* @param {object} event Event object
|
|
1093
|
+
* @param {Grid.view.Grid} event.source The grid instance
|
|
1094
|
+
* @param {Core.data.Model} event.record The record representing the hovered cell
|
|
1095
|
+
* @param {Grid.column.Column} event.column The column currently hovered
|
|
1096
|
+
* @param {HTMLElement} event.cellElement The cell HTML element
|
|
1097
|
+
* @param {MouseEvent} event.event The native DOM event
|
|
1098
|
+
*/
|
|
1099
|
+
onCellMouseEnter? : ((event: { source: Grid, record: Model, column: Column, cellElement: HTMLElement, event: MouseEvent }) => void)|string
|
|
1100
|
+
/**
|
|
1101
|
+
* Fired when the mouse leaves a cell
|
|
1102
|
+
* @param {object} event Event object
|
|
1103
|
+
* @param {Grid.view.Grid} event.source The grid instance
|
|
1104
|
+
* @param {Core.data.Model} event.record The record representing the cell that the mouse left
|
|
1105
|
+
* @param {Grid.column.Column} event.column The column representing the cell that the mouse left
|
|
1106
|
+
* @param {HTMLElement} event.cellElement The cell HTML element that the mouse left
|
|
1107
|
+
* @param {MouseEvent} event.event The native DOM event
|
|
1108
|
+
*/
|
|
1109
|
+
onCellMouseLeave? : ((event: { source: Grid, record: Model, column: Column, cellElement: HTMLElement, event: MouseEvent }) => void)|string
|
|
1110
|
+
/**
|
|
1111
|
+
* Fired when a user moves the mouse out of a grid cell
|
|
1112
|
+
* @param {object} event Event object
|
|
1113
|
+
* @param {Grid.view.Grid} event.grid The grid instance
|
|
1114
|
+
* @param {Core.data.Model} event.record The record representing the row
|
|
1115
|
+
* @param {Grid.column.Column} event.column The column to which the cell belongs
|
|
1116
|
+
* @param {HTMLElement} event.cellElement The cell HTML element
|
|
1117
|
+
* @param {HTMLElement} event.target The target element
|
|
1118
|
+
* @param {MouseEvent} event.event The native DOM event
|
|
1119
|
+
*/
|
|
1120
|
+
onCellMouseOut? : ((event: { grid: Grid, record: Model, column: Column, cellElement: HTMLElement, target: HTMLElement, event: MouseEvent }) => void)|string
|
|
1121
|
+
/**
|
|
1122
|
+
* Fired when user moves the mouse over a grid cell
|
|
1123
|
+
* @param {object} event Event object
|
|
1124
|
+
* @param {Grid.view.Grid} event.grid The grid instance
|
|
1125
|
+
* @param {Core.data.Model} event.record The record representing the row
|
|
1126
|
+
* @param {Grid.column.Column} event.column The column to which the cell belongs
|
|
1127
|
+
* @param {HTMLElement} event.cellElement The cell HTML element
|
|
1128
|
+
* @param {HTMLElement} event.target The target element
|
|
1129
|
+
* @param {MouseEvent} event.event The native DOM event
|
|
1130
|
+
*/
|
|
1131
|
+
onCellMouseOver? : ((event: { grid: Grid, record: Model, column: Column, cellElement: HTMLElement, target: HTMLElement, event: MouseEvent }) => void)|string
|
|
1132
|
+
/**
|
|
1133
|
+
* Fires when a Panel is collapsed using the [collapsible](https://bryntum.com/products/scheduler/docs/api/Core/widget/Panel#config-collapsible) setting.
|
|
1134
|
+
* @param {object} event Event object
|
|
1135
|
+
* @param {Core.widget.Panel} event.source This Panel.
|
|
1136
|
+
*/
|
|
1137
|
+
onCollapse? : ((event: { source: Panel }) => void)|string
|
|
1138
|
+
/**
|
|
1139
|
+
* Fired before a parent node record is collapsed.
|
|
1140
|
+
* @param {object} event Event object
|
|
1141
|
+
* @param {Grid.view.Grid} event.source The firing Grid instance.
|
|
1142
|
+
* @param {Core.data.Model} event.record The record which has been collapsed.
|
|
1143
|
+
*/
|
|
1144
|
+
onCollapseNode? : ((event: { source: Grid, record: Model }) => void)|string
|
|
1145
|
+
/**
|
|
1146
|
+
* This event is fired when a column is being dragged, and you can set the `valid` flag on the `context` object
|
|
1147
|
+
* to indicate whether the drop position is valid or not.
|
|
1148
|
+
* @param {object} event Event object
|
|
1149
|
+
* @param {Grid.view.Grid} event.source The grid instance.
|
|
1150
|
+
* @param {Grid.column.Column} event.column The dragged column.
|
|
1151
|
+
* @param {Grid.column.Column} event.insertBefore The column before which the dragged column will be inserted (if not last).
|
|
1152
|
+
* @param {Event} event.event The browser event.
|
|
1153
|
+
* @param {object} event.context
|
|
1154
|
+
* @param {boolean} event.context.valid Set this to `true` or `false` to indicate whether the drop position is valid.
|
|
1155
|
+
*/
|
|
1156
|
+
onColumnDrag? : ((event: { source: Grid, column: Column, insertBefore: Column, event: Event, context: { valid: boolean } }) => void)|string
|
|
1157
|
+
/**
|
|
1158
|
+
* This event is fired when a column drag gesture has started.
|
|
1159
|
+
* @param {object} event Event object
|
|
1160
|
+
* @param {Grid.view.Grid} event.source The grid instance.
|
|
1161
|
+
* @param {Grid.column.Column} event.column The dragged column.
|
|
1162
|
+
* @param {Event} event.event The browser event.
|
|
1163
|
+
*/
|
|
1164
|
+
onColumnDragStart? : ((event: { source: Grid, column: Column, event: Event }) => void)|string
|
|
1165
|
+
/**
|
|
1166
|
+
* This event is always fired after a column is dropped. The `valid` param is `true` if the operation was not
|
|
1167
|
+
* vetoed and the column was moved in the column store.
|
|
1168
|
+
* @param {object} event Event object
|
|
1169
|
+
* @param {Grid.view.Grid} event.source The grid instance.
|
|
1170
|
+
* @param {Grid.column.Column} event.column The dragged column.
|
|
1171
|
+
* @param {Grid.column.Column} event.insertBefore The column before which the dragged column will be inserted.
|
|
1172
|
+
* @param {Grid.column.Column} event.newParent The new parent column.
|
|
1173
|
+
* @param {boolean} event.valid `true` if the operation was not vetoed.
|
|
1174
|
+
* @param {Event} event.event The browser event.
|
|
1175
|
+
* @param {string} event.region The region where the column was dropped.
|
|
1176
|
+
*/
|
|
1177
|
+
onColumnDrop? : ((event: { source: Grid, column: Column, insertBefore: Column, newParent: Column, valid: boolean, event: Event, region: string }) => Promise<boolean>|boolean|void)|string
|
|
1178
|
+
/**
|
|
1179
|
+
* This event is fired after a resize gesture is completed.
|
|
1180
|
+
* @param {object} event Event object
|
|
1181
|
+
* @param {Grid.view.Grid} event.source The grid instance
|
|
1182
|
+
* @param {Grid.column.Column} event.column The resized column
|
|
1183
|
+
* @param {Event} event.domEvent The browser event
|
|
1184
|
+
*/
|
|
1185
|
+
onColumnResize? : ((event: { source: Grid, column: Column, domEvent: Event }) => void)|string
|
|
1186
|
+
/**
|
|
1187
|
+
* This event is fired when a column resize gesture starts.
|
|
1188
|
+
* @param {object} event Event object
|
|
1189
|
+
* @param {Grid.view.Grid} event.source The grid instance
|
|
1190
|
+
* @param {Grid.column.Column} event.column The column
|
|
1191
|
+
* @param {Event} event.domEvent The browser event
|
|
1192
|
+
*/
|
|
1193
|
+
onColumnResizeStart? : ((event: { source: Grid, column: Column, domEvent: Event }) => void)|string
|
|
1194
|
+
/**
|
|
1195
|
+
* This event fires on the owning widget when an item is selected in the context menu.
|
|
1196
|
+
* @param {object} event Event object
|
|
1197
|
+
* @param {Core.widget.Widget} event.source The owning widget
|
|
1198
|
+
* @param {Core.widget.Menu} event.menu The menu
|
|
1199
|
+
* @param {Core.widget.MenuItem} event.item Selected menu item
|
|
1200
|
+
*/
|
|
1201
|
+
onContextMenuItem? : ((event: { source: Widget, menu: Menu, item: MenuItem }) => void)|string
|
|
1202
|
+
/**
|
|
1203
|
+
* This event fires on the owning widget when a check item is toggled in the context menu.
|
|
1204
|
+
* @param {object} event Event object
|
|
1205
|
+
* @param {Core.widget.Widget} event.source The owning widget
|
|
1206
|
+
* @param {Core.widget.Menu} event.menu The menu
|
|
1207
|
+
* @param {Core.widget.MenuItem} event.item Selected menu item
|
|
1208
|
+
* @param {boolean} event.checked Checked or not
|
|
1209
|
+
*/
|
|
1210
|
+
onContextMenuToggleItem? : ((event: { source: Widget, menu: Menu, item: MenuItem, checked: boolean }) => void)|string
|
|
1211
|
+
/**
|
|
1212
|
+
* Fires on the owning Grid after a copy action is performed.
|
|
1213
|
+
* @param {object} event Event object
|
|
1214
|
+
* @param {Grid.view.Grid} event.source Owner grid
|
|
1215
|
+
* @param {Grid.util.GridLocation[]} event.cells The cells about to be copied or cut
|
|
1216
|
+
* @param {string} event.copiedDataString The concatenated data string that was copied or cut
|
|
1217
|
+
* @param {boolean} event.isCut `true` if this was a cut action
|
|
1218
|
+
* @param {string} event.entityName 'cell' to distinguish this event from other copy events
|
|
1219
|
+
*/
|
|
1220
|
+
onCopy? : ((event: { source: Grid, cells: GridLocation[], copiedDataString: string, isCut: boolean, entityName: string }) => void)|string
|
|
1221
|
+
/**
|
|
1222
|
+
* Fired when data in the store changes.
|
|
1223
|
+
* ...
|
|
1224
|
+
* [View online docs...](https://bryntum.com/products/scheduler/docs/api/Grid/view/Grid#event-dataChange)
|
|
1225
|
+
* @param {object} event Event object
|
|
1226
|
+
* @param {Grid.view.Grid} event.source Owning grid
|
|
1227
|
+
* @param {Core.data.Store} event.store The originating store
|
|
1228
|
+
* @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'`
|
|
1229
|
+
* @param {Core.data.Model} event.record Changed record, for actions that affects exactly one record (`'update'`)
|
|
1230
|
+
* @param {Core.data.Model[]} event.records Changed records, passed for all actions except `'removeAll'`
|
|
1231
|
+
* @param {object} event.changes Passed for the `'update'` action, info on which record fields changed
|
|
1232
|
+
*/
|
|
1233
|
+
onDataChange? : ((event: { source: Grid, store: Store, action: 'remove'|'removeAll'|'add'|'clearchanges'|'filter'|'update'|'dataset'|'replace', record: Model, records: Model[], changes: object }) => void)|string
|
|
1234
|
+
/**
|
|
1235
|
+
* Fires when an object is destroyed.
|
|
1236
|
+
* @param {object} event Event object
|
|
1237
|
+
* @param {Core.Base} event.source The Object that is being destroyed.
|
|
1238
|
+
*/
|
|
1239
|
+
onDestroy? : ((event: { source: Base }) => void)|string
|
|
1240
|
+
/**
|
|
1241
|
+
* Fires when a field is mutated and the state of the [hasChanges](https://bryntum.com/products/scheduler/docs/api/Core/widget/Container#property-hasChanges) property changes
|
|
1242
|
+
* @param {object} event Event object
|
|
1243
|
+
* @param {Core.widget.Container} event.source The container.
|
|
1244
|
+
* @param {boolean} event.dirty The dirty state of the Container - `true` if there are any fields which have been changed since initial load.
|
|
1245
|
+
*/
|
|
1246
|
+
onDirtyStateChange? : ((event: { source: Container, dirty: boolean }) => void)|string
|
|
1247
|
+
/**
|
|
1248
|
+
* Fires while drag selecting. UI will update with current range, but the cells will not be selected until
|
|
1249
|
+
* mouse up. This event can be listened for to perform actions while drag selecting.
|
|
1250
|
+
* @param {object} event Event object
|
|
1251
|
+
* @param {Grid.view.Grid} event.source
|
|
1252
|
+
* @param {GridLocationConfig[],Grid.util.GridLocation[]} event.selectedCells The cells that is currently being dragged over
|
|
1253
|
+
* @param {Core.data.Model[]} event.selectedRecords The records that is currently being dragged over
|
|
1254
|
+
*/
|
|
1255
|
+
onDragSelecting? : ((event: { source: Grid, selectedCells: GridLocationConfig[]|GridLocation[], selectedRecords: Model[] }) => void)|string
|
|
1256
|
+
/**
|
|
1257
|
+
* Triggered when a widget's [element](https://bryntum.com/products/scheduler/docs/api/Core/widget/Widget#property-element) is available.
|
|
1258
|
+
* @param {object} event Event object
|
|
1259
|
+
* @param {HTMLElement} event.element The Widget's element.
|
|
1260
|
+
*/
|
|
1261
|
+
onElementCreated? : ((event: { element: HTMLElement }) => void)|string
|
|
1262
|
+
/**
|
|
1263
|
+
* Fires when a Panel is expanded using the [collapsible](https://bryntum.com/products/scheduler/docs/api/Core/widget/Panel#config-collapsible) setting.
|
|
1264
|
+
* @param {object} event Event object
|
|
1265
|
+
* @param {Core.widget.Panel} event.source This Panel.
|
|
1266
|
+
*/
|
|
1267
|
+
onExpand? : ((event: { source: Panel }) => void)|string
|
|
1268
|
+
/**
|
|
1269
|
+
* Fired after a parent node record is expanded.
|
|
1270
|
+
* @param {object} event Event object
|
|
1271
|
+
* @param {Grid.view.Grid} event.source The firing Grid instance.
|
|
1272
|
+
* @param {Core.data.Model} event.record The record which has been expanded.
|
|
1273
|
+
*/
|
|
1274
|
+
onExpandNode? : ((event: { source: Grid, record: Model }) => void)|string
|
|
1275
|
+
/**
|
|
1276
|
+
* Fired when a file is dropped on the widget element
|
|
1277
|
+
* @param {object} event Event object
|
|
1278
|
+
* @param {Grid.view.Grid} event.source The owning Grid instance
|
|
1279
|
+
* @param {DataTransferItem} event.file The dropped file descriptor
|
|
1280
|
+
* @param {DragEvent} event.domEvent The native DragEvent
|
|
1281
|
+
*/
|
|
1282
|
+
onFileDrop? : ((event: { source: Grid, file: DataTransferItem, domEvent: DragEvent }) => void)|string
|
|
1283
|
+
/**
|
|
1284
|
+
* Fired before the FillHandle dragging is finalized and values are applied to cells, return `false` to prevent the
|
|
1285
|
+
* drag operation from applying data changes.
|
|
1286
|
+
* @param {object} event Event object
|
|
1287
|
+
* @param {Grid.util.GridLocation} event.from The from cell
|
|
1288
|
+
* @param {Grid.util.GridLocation} event.to The to cell
|
|
1289
|
+
* @param {MouseEvent} event.domEvent The raw DOM event
|
|
1290
|
+
*/
|
|
1291
|
+
onFillHandleBeforeDragFinalize? : ((event: { from: GridLocation, to: GridLocation, domEvent: MouseEvent }) => Promise<boolean>|boolean|void)|string
|
|
1292
|
+
/**
|
|
1293
|
+
* Fired while dragging the FillHandle.
|
|
1294
|
+
* @param {object} event Event object
|
|
1295
|
+
* @param {Grid.util.GridLocation} event.from The from cell
|
|
1296
|
+
* @param {Grid.util.GridLocation} event.to The to cell
|
|
1297
|
+
* @param {MouseEvent} event.domEvent The raw DOM event
|
|
1298
|
+
*/
|
|
1299
|
+
onFillHandleDrag? : ((event: { from: GridLocation, to: GridLocation, domEvent: MouseEvent }) => void)|string
|
|
1300
|
+
/**
|
|
1301
|
+
* Fired when a FillHandle drag operation is aborted.
|
|
1302
|
+
*/
|
|
1303
|
+
onFillHandleDragAbort? : (() => void)|string
|
|
1304
|
+
/**
|
|
1305
|
+
* Fired after a FillHandle drag operation.
|
|
1306
|
+
* @param {object} event Event object
|
|
1307
|
+
* @param {Grid.util.GridLocation} event.from The from cell
|
|
1308
|
+
* @param {Grid.util.GridLocation} event.to The to cell
|
|
1309
|
+
* @param {MouseEvent} event.domEvent The raw DOM event
|
|
1310
|
+
*/
|
|
1311
|
+
onFillHandleDragEnd? : ((event: { from: GridLocation, to: GridLocation, domEvent: MouseEvent }) => void)|string
|
|
1312
|
+
/**
|
|
1313
|
+
* Fired when dragging of the FillHandle starts.
|
|
1314
|
+
* @param {object} event Event object
|
|
1315
|
+
* @param {Grid.util.GridLocation} event.cell Information about the column / record
|
|
1316
|
+
* @param {MouseEvent} event.domEvent The raw DOM event
|
|
1317
|
+
*/
|
|
1318
|
+
onFillHandleDragStart? : ((event: { cell: GridLocation, domEvent: MouseEvent }) => Promise<boolean>|boolean|void)|string
|
|
1319
|
+
/**
|
|
1320
|
+
* Fires on the owning Grid when cell editing is finished
|
|
1321
|
+
* @param {object} event Event object
|
|
1322
|
+
* @param {Grid.view.Grid} event.grid Target grid
|
|
1323
|
+
* @param {CellEditorContext} event.editorContext Editing context
|
|
1324
|
+
*/
|
|
1325
|
+
onFinishCellEdit? : ((event: { grid: Grid, editorContext: CellEditorContext }) => void)|string
|
|
1326
|
+
/**
|
|
1327
|
+
* Fires on the owning Grid before the row editing is finished, return false to signal that the value is invalid and editing should not be finalized.
|
|
1328
|
+
* ...
|
|
1329
|
+
* [View online docs...](https://bryntum.com/products/scheduler/docs/api/Grid/view/Grid#event-finishRowEdit)
|
|
1330
|
+
* @param {object} event Event object
|
|
1331
|
+
* @param {Grid.view.Grid} event.grid Target grid
|
|
1332
|
+
* @param {RowEditorContext} event.editorContext Editing context
|
|
1333
|
+
*/
|
|
1334
|
+
onFinishRowEdit? : ((event: { grid: Grid, editorContext: RowEditorContext }) => Promise<boolean>|boolean|void)|string
|
|
1335
|
+
/**
|
|
1336
|
+
* Fired when focus enters this Widget.
|
|
1337
|
+
* @param {object} event Event object
|
|
1338
|
+
* @param {Core.widget.Widget} event.source This Widget
|
|
1339
|
+
* @param {HTMLElement} event.fromElement The element which lost focus.
|
|
1340
|
+
* @param {HTMLElement} event.toElement The element which gained focus.
|
|
1341
|
+
* @param {Core.widget.Widget} event.fromWidget The widget which lost focus.
|
|
1342
|
+
* @param {Core.widget.Widget} event.toWidget The widget which gained focus.
|
|
1343
|
+
* @param {boolean} event.backwards `true` if the `toElement` is before the `fromElement` in document order.
|
|
1344
|
+
*/
|
|
1345
|
+
onFocusIn? : ((event: { source: Widget, fromElement: HTMLElement, toElement: HTMLElement, fromWidget: Widget, toWidget: Widget, backwards: boolean }) => void)|string
|
|
1346
|
+
/**
|
|
1347
|
+
* Fired when focus exits this Widget's ownership tree. This is different from a `blur` event.
|
|
1348
|
+
* focus moving from within this Widget's ownership tree, even if there are floating widgets
|
|
1349
|
+
* will not trigger this event. This is when focus exits this widget completely.
|
|
1350
|
+
* @param {object} event Event object
|
|
1351
|
+
* @param {Core.widget.Widget} event.source This Widget
|
|
1352
|
+
* @param {HTMLElement} event.fromElement The element which lost focus.
|
|
1353
|
+
* @param {HTMLElement} event.toElement The element which gained focus.
|
|
1354
|
+
* @param {Core.widget.Widget} event.fromWidget The widget which lost focus.
|
|
1355
|
+
* @param {Core.widget.Widget} event.toWidget The widget which gained focus.
|
|
1356
|
+
* @param {boolean} event.backwards `true` if the `toElement` is before the `fromElement` in document order.
|
|
1357
|
+
*/
|
|
1358
|
+
onFocusOut? : ((event: { source: Widget, fromElement: HTMLElement, toElement: HTMLElement, fromWidget: Widget, toWidget: Widget, backwards: boolean }) => void)|string
|
|
1359
|
+
/**
|
|
1360
|
+
* Fired before dragging starts, return false to prevent the drag operation.
|
|
1361
|
+
* @param {object} event Event object
|
|
1362
|
+
* @param {Grid.view.GridBase} event.source
|
|
1363
|
+
* @param {object} event.context
|
|
1364
|
+
* @param {Core.data.Model[]} event.context.records The dragged row records
|
|
1365
|
+
* @param {MouseEvent,TouchEvent} event.event
|
|
1366
|
+
*/
|
|
1367
|
+
onGridRowBeforeDragStart? : ((event: { source: GridBase, context: { records: Model[] }, event: MouseEvent|TouchEvent }) => Promise<boolean>|boolean|void)|string
|
|
1368
|
+
/**
|
|
1369
|
+
* Fired before the row drop operation is finalized. You can return false to abort the drop operation, or a
|
|
1370
|
+
* Promise yielding `true` / `false` which allows for asynchronous abort (e.g. first show user a confirmation dialog).
|
|
1371
|
+
* @param {object} event Event object
|
|
1372
|
+
* @param {Grid.view.GridBase} event.source
|
|
1373
|
+
* @param {object} event.context
|
|
1374
|
+
* @param {boolean} event.context.valid Set this to true or false to indicate whether the drop position is valid
|
|
1375
|
+
* @param {Core.data.Model} event.context.insertBefore The record to insert before (`null` if inserting at last position of a parent node)
|
|
1376
|
+
* @param {Core.data.Model} event.context.parent The parent record of the current drop position (only applicable for trees)
|
|
1377
|
+
* @param {Core.data.Model[]} event.context.records The dragged row records
|
|
1378
|
+
* @param {RecordPositionContext[]} event.context.oldPositionContext An array of objects with information about the previous tree position. Objects contain the `record`, and its original `parentIndex` and `parentId` values
|
|
1379
|
+
* @param {MouseEvent} event.event
|
|
1380
|
+
*/
|
|
1381
|
+
onGridRowBeforeDropFinalize? : ((event: { source: GridBase, context: { valid: boolean, insertBefore: Model, parent: Model, records: Model[], oldPositionContext: RecordPositionContext[] }, event: MouseEvent }) => Promise<boolean>|boolean|void)|string
|
|
1382
|
+
/**
|
|
1383
|
+
* Fired while the row is being dragged, in the listener function you have access to `context.insertBefore` a grid /
|
|
1384
|
+
* tree record, and additionally `context.parent` (a TreeNode) for trees. You can signal that the drop position is
|
|
1385
|
+
* valid or invalid by setting `context.valid = false;`
|
|
1386
|
+
* @param {object} event Event object
|
|
1387
|
+
* @param {Grid.view.GridBase} event.source
|
|
1388
|
+
* @param {object} event.context
|
|
1389
|
+
* @param {boolean} event.context.valid Set this to true or false to indicate whether the drop position is valid.
|
|
1390
|
+
* @param {Core.data.Model} event.context.insertBefore The record to insert before (`null` if inserting at last position of a parent node)
|
|
1391
|
+
* @param {Core.data.Model} event.context.parent The parent record of the current drop position (only applicable for trees)
|
|
1392
|
+
* @param {Core.data.Model[]} event.context.records The dragged row records
|
|
1393
|
+
* @param {MouseEvent} event.event
|
|
1394
|
+
*/
|
|
1395
|
+
onGridRowDrag? : ((event: { source: GridBase, context: { valid: boolean, insertBefore: Model, parent: Model, records: Model[] }, event: MouseEvent }) => void)|string
|
|
1396
|
+
/**
|
|
1397
|
+
* Fired when a row drag operation is aborted
|
|
1398
|
+
* @param {object} event Event object
|
|
1399
|
+
* @param {Grid.view.GridBase} event.source
|
|
1400
|
+
* @param {object} event.context
|
|
1401
|
+
* @param {Core.data.Model[]} event.context.records The dragged row records
|
|
1402
|
+
* @param {MouseEvent} event.event
|
|
1403
|
+
*/
|
|
1404
|
+
onGridRowDragAbort? : ((event: { source: GridBase, context: { records: Model[] }, event: MouseEvent }) => void)|string
|
|
1405
|
+
/**
|
|
1406
|
+
* Fired when dragging starts.
|
|
1407
|
+
* @param {object} event Event object
|
|
1408
|
+
* @param {Grid.view.GridBase} event.source
|
|
1409
|
+
* @param {object} event.context
|
|
1410
|
+
* @param {Core.data.Model[]} event.context.records The dragged row records
|
|
1411
|
+
* @param {MouseEvent,TouchEvent} event.event
|
|
1412
|
+
*/
|
|
1413
|
+
onGridRowDragStart? : ((event: { source: GridBase, context: { records: Model[] }, event: MouseEvent|TouchEvent }) => void)|string
|
|
1414
|
+
/**
|
|
1415
|
+
* Fired after the row drop operation has completed, regardless of validity
|
|
1416
|
+
* @param {object} event Event object
|
|
1417
|
+
* @param {Grid.view.GridBase} event.source
|
|
1418
|
+
* @param {object} event.context
|
|
1419
|
+
* @param {boolean} event.context.valid true or false depending on whether the drop position was valid
|
|
1420
|
+
* @param {Core.data.Model} event.context.insertBefore The record to insert before (`null` if inserting at last position of a parent node)
|
|
1421
|
+
* @param {Core.data.Model} event.context.parent The parent record of the current drop position (only applicable for trees)
|
|
1422
|
+
* @param {Core.data.Model[]} event.context.records The dragged row records
|
|
1423
|
+
* @param {RecordPositionContext[]} event.context.oldPositionContext An array of objects with information about the previous tree position. Objects contain the record, and its original `parentIndex` and `parentId` values
|
|
1424
|
+
* @param {MouseEvent} event.event
|
|
1425
|
+
*/
|
|
1426
|
+
onGridRowDrop? : ((event: { source: GridBase, context: { valid: boolean, insertBefore: Model, parent: Model, records: Model[], oldPositionContext: RecordPositionContext[] }, event: MouseEvent }) => void)|string
|
|
1427
|
+
/**
|
|
1428
|
+
* Fired when a grid header is clicked on.
|
|
1429
|
+
* ...
|
|
1430
|
+
* [View online docs...](https://bryntum.com/products/scheduler/docs/api/Grid/view/Grid#event-headerClick)
|
|
1431
|
+
* @param {object} event Event object
|
|
1432
|
+
* @param {Event} event.domEvent The triggering DOM event.
|
|
1433
|
+
* @param {Grid.column.Column} event.column The column clicked on.
|
|
1434
|
+
*/
|
|
1435
|
+
onHeaderClick? : ((event: { domEvent: Event, column: Column }) => Promise<boolean>|boolean|void)|string
|
|
1436
|
+
/**
|
|
1437
|
+
* This event fires on the owning Grid before the context menu is shown for a header.
|
|
1438
|
+
* Allows manipulation of the items to show in the same way as in the [processItems](https://bryntum.com/products/scheduler/docs/api/Grid/feature/HeaderMenu#config-processItems).
|
|
1439
|
+
* ...
|
|
1440
|
+
* [View online docs...](https://bryntum.com/products/scheduler/docs/api/Grid/view/Grid#event-headerMenuBeforeShow)
|
|
1441
|
+
* @param {object} event Event object
|
|
1442
|
+
* @param {Grid.view.Grid} event.source The grid
|
|
1443
|
+
* @param {Core.widget.Menu} event.menu The menu
|
|
1444
|
+
* @param {Record<string, MenuItemEntry>} event.items Menu item configs
|
|
1445
|
+
* @param {Grid.column.Column} event.column Column
|
|
1446
|
+
*/
|
|
1447
|
+
onHeaderMenuBeforeShow? : ((event: { source: Grid, menu: Menu, items: Record<string, MenuItemEntry>, column: Column }) => Promise<boolean>|boolean|void)|string
|
|
1448
|
+
/**
|
|
1449
|
+
* This event fires on the owning Grid when an item is selected in the header context menu.
|
|
1450
|
+
* @param {object} event Event object
|
|
1451
|
+
* @param {Grid.view.Grid} event.source The grid
|
|
1452
|
+
* @param {Core.widget.Menu} event.menu The menu
|
|
1453
|
+
* @param {Core.widget.MenuItem} event.item Selected menu item
|
|
1454
|
+
* @param {Grid.column.Column} event.column Column
|
|
1455
|
+
*/
|
|
1456
|
+
onHeaderMenuItem? : ((event: { source: Grid, menu: Menu, item: MenuItem, column: Column }) => void)|string
|
|
1457
|
+
/**
|
|
1458
|
+
* This event fires on the owning Grid after the context menu is shown for a header
|
|
1459
|
+
* @param {object} event Event object
|
|
1460
|
+
* @param {Grid.view.Grid} event.source The grid
|
|
1461
|
+
* @param {Core.widget.Menu} event.menu The menu
|
|
1462
|
+
* @param {Record<string, MenuItemEntry>} event.items Menu item configs
|
|
1463
|
+
* @param {Grid.column.Column} event.column Column
|
|
1464
|
+
*/
|
|
1465
|
+
onHeaderMenuShow? : ((event: { source: Grid, menu: Menu, items: Record<string, MenuItemEntry>, column: Column }) => void)|string
|
|
1466
|
+
/**
|
|
1467
|
+
* This event fires on the owning Grid when a check item is toggled in the header context menu.
|
|
1468
|
+
* @param {object} event Event object
|
|
1469
|
+
* @param {Grid.view.Grid} event.source The grid
|
|
1470
|
+
* @param {Core.widget.Menu} event.menu The menu
|
|
1471
|
+
* @param {Core.widget.MenuItem} event.item Selected menu item
|
|
1472
|
+
* @param {Grid.column.Column} event.column Column
|
|
1473
|
+
* @param {boolean} event.checked Checked or not
|
|
1474
|
+
*/
|
|
1475
|
+
onHeaderMenuToggleItem? : ((event: { source: Grid, menu: Menu, item: MenuItem, column: Column, checked: boolean }) => void)|string
|
|
1476
|
+
/**
|
|
1477
|
+
* Triggered after a widget was hidden
|
|
1478
|
+
* @param {object} event Event object
|
|
1479
|
+
* @param {Core.widget.Widget} event.source The widget
|
|
1480
|
+
*/
|
|
1481
|
+
onHide? : ((event: { source: Widget }) => void)|string
|
|
1482
|
+
/**
|
|
1483
|
+
* Fires when row locking is enabled.
|
|
1484
|
+
* @param {object} event Event object
|
|
1485
|
+
* @param {Grid.view.GridBase} event.clone The created clone
|
|
1486
|
+
*/
|
|
1487
|
+
onLockRows? : ((event: { clone: GridBase }) => void)|string
|
|
1488
|
+
/**
|
|
1489
|
+
* Mouse moved out from element in grid
|
|
1490
|
+
* @param {object} event Event object
|
|
1491
|
+
* @param {MouseEvent} event.event The native browser event
|
|
1492
|
+
*/
|
|
1493
|
+
onMouseOut? : ((event: { event: MouseEvent }) => void)|string
|
|
1494
|
+
/**
|
|
1495
|
+
* Mouse moved in over element in grid
|
|
1496
|
+
* @param {object} event Event object
|
|
1497
|
+
* @param {MouseEvent} event.event The native browser event
|
|
1498
|
+
*/
|
|
1499
|
+
onMouseOver? : ((event: { event: MouseEvent }) => void)|string
|
|
1500
|
+
/**
|
|
1501
|
+
* Triggered when a widget which had been in a non-visible state for any reason
|
|
1502
|
+
* achieves visibility.
|
|
1503
|
+
* ...
|
|
1504
|
+
* [View online docs...](https://bryntum.com/products/scheduler/docs/api/Grid/view/Grid#event-paint)
|
|
1505
|
+
* @param {object} event Event object
|
|
1506
|
+
* @param {Core.widget.Widget} event.source The widget being painted.
|
|
1507
|
+
* @param {boolean} event.firstPaint `true` if this is the first paint.
|
|
1508
|
+
*/
|
|
1509
|
+
onPaint? : ((event: { source: Widget, firstPaint: boolean }) => void)|string
|
|
1510
|
+
/**
|
|
1511
|
+
* Fires on the owning Grid after a paste action is performed.
|
|
1512
|
+
* @param {object} event Event object
|
|
1513
|
+
* @param {Grid.view.Grid} event.source Owner grid
|
|
1514
|
+
* @param {string} event.clipboardData The clipboardData that was pasted
|
|
1515
|
+
* @param {Core.data.Model[]} event.modifiedRecords The records which have been modified due to the paste action
|
|
1516
|
+
* @param {Grid.util.GridLocation} event.targetCell The cell from which the paste will be started
|
|
1517
|
+
* @param {string} event.entityName 'cell' to distinguish this event from other paste events
|
|
1518
|
+
*/
|
|
1519
|
+
onPaste? : ((event: { source: Grid, clipboardData: string, modifiedRecords: Model[], targetCell: GridLocation, entityName: string }) => void)|string
|
|
1520
|
+
/**
|
|
1521
|
+
* Fires on the owning Grid when export has finished
|
|
1522
|
+
* @param {object} event Event object
|
|
1523
|
+
* @param {Response} event.response Optional response, if received
|
|
1524
|
+
* @param {Error} event.error Optional error, if exception occurred
|
|
1525
|
+
*/
|
|
1526
|
+
onPdfExport? : ((event: { response?: any, error?: Error }) => void)|string
|
|
1527
|
+
/**
|
|
1528
|
+
* Fired when a Widget's read only state is toggled
|
|
1529
|
+
* @param {object} event Event object
|
|
1530
|
+
* @param {boolean} event.readOnly Read only or not
|
|
1531
|
+
*/
|
|
1532
|
+
onReadOnly? : ((event: { readOnly: boolean }) => void)|string
|
|
1533
|
+
/**
|
|
1534
|
+
* This event is fired after a widget's elements have been synchronized due to a direct or indirect call
|
|
1535
|
+
* to [recompose](https://bryntum.com/products/scheduler/docs/api/Core/widget/Widget#function-recompose), if this results in some change to the widget's rendered DOM elements.
|
|
1536
|
+
*/
|
|
1537
|
+
onRecompose? : (() => void)|string
|
|
1538
|
+
/**
|
|
1539
|
+
* Fires after a row is rendered.
|
|
1540
|
+
* @param {object} event Event object
|
|
1541
|
+
* @param {Grid.view.Grid} event.source The firing Grid instance.
|
|
1542
|
+
* @param {Grid.row.Row} event.row The row that has been rendered.
|
|
1543
|
+
* @param {Core.data.Model} event.record The record for the row.
|
|
1544
|
+
* @param {number} event.recordIndex The zero-based index of the record.
|
|
1545
|
+
*/
|
|
1546
|
+
onRenderRow? : ((event: { source: Grid, row: Row, record: Model, recordIndex: number }) => void)|string
|
|
1547
|
+
/**
|
|
1548
|
+
* Grid rows have been rendered
|
|
1549
|
+
* @param {object} event Event object
|
|
1550
|
+
* @param {Grid.view.Grid} event.source This grid.
|
|
1551
|
+
*/
|
|
1552
|
+
onRenderRows? : ((event: { source: Grid }) => void)|string
|
|
1553
|
+
/**
|
|
1554
|
+
* Fired when the encapsulating element of a Widget resizes *only when [monitorResize](https://bryntum.com/products/scheduler/docs/api/Core/widget/Widget#config-monitorResize) is `true`*.
|
|
1555
|
+
* @param {object} event Event object
|
|
1556
|
+
* @param {Core.widget.Widget} event.source This Widget
|
|
1557
|
+
* @param {number} event.width The new width
|
|
1558
|
+
* @param {number} event.height The new height
|
|
1559
|
+
* @param {number} event.oldWidth The old width
|
|
1560
|
+
* @param {number} event.oldHeight The old height
|
|
1561
|
+
*/
|
|
1562
|
+
onResize? : ((event: { source: Widget, width: number, height: number, oldWidth: number, oldHeight: number }) => void)|string
|
|
1563
|
+
/**
|
|
1564
|
+
* Grid resize lead to a new responsive level being applied
|
|
1565
|
+
* @param {object} event Event object
|
|
1566
|
+
* @param {Grid.view.Grid} event.grid Grid that was resized
|
|
1567
|
+
* @param {string} event.level New responsive level (small, large, etc)
|
|
1568
|
+
* @param {number} event.width New width in px
|
|
1569
|
+
* @param {string} event.oldLevel Old responsive level
|
|
1570
|
+
* @param {number} event.oldWidth Old width in px
|
|
1571
|
+
*/
|
|
1572
|
+
onResponsive? : ((event: { grid: Grid, level: string, width: number, oldLevel: string, oldWidth: number }) => void)|string
|
|
1573
|
+
/**
|
|
1574
|
+
* This event fires when a row has finished collapsing.
|
|
1575
|
+
* @param {object} event Event object
|
|
1576
|
+
* @param {Core.data.Model} event.record Record
|
|
1577
|
+
*/
|
|
1578
|
+
onRowCollapse? : ((event: { record: Model }) => void)|string
|
|
1579
|
+
/**
|
|
1580
|
+
* This event fires when a row expand has finished expanding.
|
|
1581
|
+
* ...
|
|
1582
|
+
* [View online docs...](https://bryntum.com/products/scheduler/docs/api/Grid/view/Grid#event-rowExpand)
|
|
1583
|
+
* @param {object} event Event object
|
|
1584
|
+
* @param {Core.data.Model} event.record Record
|
|
1585
|
+
* @param {object} event.expandedElements An object with the Grid region name as property and the expanded body element as value
|
|
1586
|
+
* @param {Core.widget.Widget} event.widget In case of expanding a Widget, this will be a reference to the instance created by the actual expansion. If there is multiple Grid regions, use the `widgets` param instead.
|
|
1587
|
+
* @param {object} event.widgets In case of expanding a Widget, this will be an object with the Grid region name as property and the reference to the widget instance created by the actual expansion
|
|
1588
|
+
*/
|
|
1589
|
+
onRowExpand? : ((event: { record: Model, expandedElements: object, widget: Widget, widgets: object }) => void)|string
|
|
1590
|
+
/**
|
|
1591
|
+
* Fired when the mouse enters a row
|
|
1592
|
+
* @param {object} event Event object
|
|
1593
|
+
* @param {Grid.view.Grid} event.source The grid instance
|
|
1594
|
+
* @param {Core.data.Model} event.record The record representing the hovered row
|
|
1595
|
+
* @param {Grid.column.Column} event.column The column currently hovered
|
|
1596
|
+
* @param {HTMLElement} event.cellElement The cell HTML element
|
|
1597
|
+
* @param {MouseEvent} event.event The native DOM event
|
|
1598
|
+
*/
|
|
1599
|
+
onRowMouseEnter? : ((event: { source: Grid, record: Model, column: Column, cellElement: HTMLElement, event: MouseEvent }) => void)|string
|
|
1600
|
+
/**
|
|
1601
|
+
* Fired when the mouse leaves a row
|
|
1602
|
+
* @param {object} event Event object
|
|
1603
|
+
* @param {Grid.view.Grid} event.source The grid instance
|
|
1604
|
+
* @param {Core.data.Model} event.record The record representing the row that the mouse left
|
|
1605
|
+
* @param {HTMLElement} event.cellElement The cell HTML element that the mouse left
|
|
1606
|
+
* @param {MouseEvent} event.event The native DOM event
|
|
1607
|
+
*/
|
|
1608
|
+
onRowMouseLeave? : ((event: { source: Grid, record: Model, cellElement: HTMLElement, event: MouseEvent }) => void)|string
|
|
1609
|
+
/**
|
|
1610
|
+
* Grid has scrolled vertically
|
|
1611
|
+
* @param {object} event Event object
|
|
1612
|
+
* @param {Grid.view.Grid} event.source The firing Grid instance.
|
|
1613
|
+
* @param {number} event.scrollTop The vertical scroll position.
|
|
1614
|
+
*/
|
|
1615
|
+
onScroll? : ((event: { source: Grid, scrollTop: number }) => void)|string
|
|
1616
|
+
/**
|
|
1617
|
+
* The selection has been changed.
|
|
1618
|
+
* @param {object} event Event object
|
|
1619
|
+
* @param {'select','deselect'} event.action `'select'`/`'deselect'`
|
|
1620
|
+
* @param {'row','cell'} event.mode `'row'`/`'cell'`
|
|
1621
|
+
* @param {Grid.view.Grid} event.source
|
|
1622
|
+
* @param {Core.data.Model[]} event.deselected The records deselected in this operation.
|
|
1623
|
+
* @param {Core.data.Model[]} event.selected The records selected in this operation.
|
|
1624
|
+
* @param {Core.data.Model[]} event.selection The records in the new selection.
|
|
1625
|
+
* @param {Grid.util.GridLocation[]} event.deselectedCells The cells deselected in this operation.
|
|
1626
|
+
* @param {Grid.util.GridLocation[]} event.selectedCells The cells selected in this operation.
|
|
1627
|
+
* @param {Grid.util.GridLocation[]} event.cellSelection The cells in the new selection.
|
|
1628
|
+
*/
|
|
1629
|
+
onSelectionChange? : ((event: { action: 'select'|'deselect', mode: 'row'|'cell', source: Grid, deselected: Model[], selected: Model[], selection: Model[], deselectedCells: GridLocation[], selectedCells: GridLocation[], cellSelection: GridLocation[] }) => void)|string
|
|
1630
|
+
/**
|
|
1631
|
+
* The selectionMode configuration has been changed.
|
|
1632
|
+
* @param {object} event Event object
|
|
1633
|
+
* @param {object} event.selectionMode The new [selectionMode](https://bryntum.com/products/scheduler/docs/api/Grid/view/mixin/GridSelection#config-selectionMode)
|
|
1634
|
+
*/
|
|
1635
|
+
onSelectionModeChange? : ((event: { selectionMode: object }) => void)|string
|
|
1636
|
+
/**
|
|
1637
|
+
* Triggered after a widget is shown.
|
|
1638
|
+
* @param {object} event Event object
|
|
1639
|
+
* @param {Core.widget.Widget} event.source The widget
|
|
1640
|
+
*/
|
|
1641
|
+
onShow? : ((event: { source: Widget }) => void)|string
|
|
1642
|
+
/**
|
|
1643
|
+
* Fires when splitting the Grid.
|
|
1644
|
+
* @param {object} event Event object
|
|
1645
|
+
* @param {Grid.view.GridBase[]} event.subViews The sub views created by the split
|
|
1646
|
+
* @param {object} event.options The options passed to the split call
|
|
1647
|
+
* @param {'horizontal','vertical','both'} event.options.direction The direction of the split
|
|
1648
|
+
* @param {Grid.column.Column} event.options.atColumn The column to split at
|
|
1649
|
+
* @param {Core.data.Model} event.options.atRecord The record to split at
|
|
1650
|
+
*/
|
|
1651
|
+
onSplit? : ((event: { subViews: GridBase[], options: { direction: 'horizontal'|'vertical'|'both', atColumn: Column, atRecord: Model } }) => void)|string
|
|
1652
|
+
/**
|
|
1653
|
+
* Fired by the Grid when the collapse icon is clicked. Return `false` to prevent the default collapse action,
|
|
1654
|
+
* if you want to implement your own behavior.
|
|
1655
|
+
* @param {object} event Event object
|
|
1656
|
+
* @param {Grid.view.Grid} event.source The Grid instance.
|
|
1657
|
+
* @param {Grid.view.SubGrid} event.subGrid The subgrid
|
|
1658
|
+
* @param {Event} event.domEvent The native DOM event
|
|
1659
|
+
*/
|
|
1660
|
+
onSplitterCollapseClick? : ((event: { source: Grid, subGrid: SubGrid, domEvent: Event }) => Promise<boolean>|boolean|void)|string
|
|
1661
|
+
/**
|
|
1662
|
+
* Fired by the Grid after a sub-grid has been resized using the splitter
|
|
1663
|
+
* @param {object} event Event object
|
|
1664
|
+
* @param {Grid.view.Grid} event.source The Grid instance.
|
|
1665
|
+
* @param {Grid.view.SubGrid} event.subGrid The resized subgrid
|
|
1666
|
+
* @param {Event} event.domEvent The native DOM event
|
|
1667
|
+
*/
|
|
1668
|
+
onSplitterDragEnd? : ((event: { source: Grid, subGrid: SubGrid, domEvent: Event }) => void)|string
|
|
1669
|
+
/**
|
|
1670
|
+
* Fired by the Grid when a sub-grid resize gesture starts
|
|
1671
|
+
* @param {object} event Event object
|
|
1672
|
+
* @param {Grid.view.Grid} event.source The Grid instance.
|
|
1673
|
+
* @param {Grid.view.SubGrid} event.subGrid The subgrid about to be resized
|
|
1674
|
+
* @param {Event} event.domEvent The native DOM event
|
|
1675
|
+
*/
|
|
1676
|
+
onSplitterDragStart? : ((event: { source: Grid, subGrid: SubGrid, domEvent: Event }) => void)|string
|
|
1677
|
+
/**
|
|
1678
|
+
* Fired by the Grid when the expand icon is clicked. Return `false` to prevent the default expand action,
|
|
1679
|
+
* if you want to implement your own behavior.
|
|
1680
|
+
* @param {object} event Event object
|
|
1681
|
+
* @param {Grid.view.Grid} event.source The Grid instance.
|
|
1682
|
+
* @param {Grid.view.SubGrid} event.subGrid The subgrid
|
|
1683
|
+
* @param {Event} event.domEvent The native DOM event
|
|
1684
|
+
*/
|
|
1685
|
+
onSplitterExpandClick? : ((event: { source: Grid, subGrid: SubGrid, domEvent: Event }) => Promise<boolean>|boolean|void)|string
|
|
1686
|
+
/**
|
|
1687
|
+
* Fires on the owning Grid when editing starts
|
|
1688
|
+
* @param {object} event Event object
|
|
1689
|
+
* @param {Grid.view.Grid} event.source Owner grid
|
|
1690
|
+
* @param {CellEditorContext} event.editorContext Editing context
|
|
1691
|
+
*/
|
|
1692
|
+
onStartCellEdit? : ((event: { source: Grid, editorContext: CellEditorContext }) => void)|string
|
|
1693
|
+
/**
|
|
1694
|
+
* Fires on the owning Grid when editing starts
|
|
1695
|
+
* @param {object} event Event object
|
|
1696
|
+
* @param {Grid.view.Grid} event.source Owner grid
|
|
1697
|
+
* @param {RowEditorContext} event.editorContext Editing context
|
|
1698
|
+
*/
|
|
1699
|
+
onStartRowEdit? : ((event: { source: Grid, editorContext: RowEditorContext }) => void)|string
|
|
1700
|
+
/**
|
|
1701
|
+
* Fires after a sub grid is collapsed.
|
|
1702
|
+
* @param {object} event Event object
|
|
1703
|
+
* @param {Grid.view.Grid} event.source The firing Grid instance
|
|
1704
|
+
* @param {Grid.view.SubGrid} event.subGrid The sub grid instance
|
|
1705
|
+
*/
|
|
1706
|
+
onSubGridCollapse? : ((event: { source: Grid, subGrid: SubGrid }) => void)|string
|
|
1707
|
+
/**
|
|
1708
|
+
* Fires after a sub grid is expanded.
|
|
1709
|
+
* @param {object} event Event object
|
|
1710
|
+
* @param {Grid.view.Grid} event.source The firing Grid instance
|
|
1711
|
+
* @param {Grid.view.SubGrid} event.subGrid The sub grid instance
|
|
1712
|
+
*/
|
|
1713
|
+
onSubGridExpand? : ((event: { source: Grid, subGrid: SubGrid }) => void)|string
|
|
1714
|
+
/**
|
|
1715
|
+
* Fired when one or more groups are expanded or collapsed
|
|
1716
|
+
* @param {object} event Event object
|
|
1717
|
+
* @param {Core.data.Model} event.groupRecord [DEPRECATED] Use `groupRecords` param instead
|
|
1718
|
+
* @param {Core.data.Model[]} event.groupRecords The group records being toggled
|
|
1719
|
+
* @param {boolean} event.collapse Collapsed (true) or expanded (false)
|
|
1720
|
+
* @param {boolean} event.allRecords True if this event is part of toggling all groups
|
|
1721
|
+
*/
|
|
1722
|
+
onToggleGroup? : ((event: { groupRecord: Model, groupRecords: Model[], collapse: boolean, allRecords?: boolean }) => void)|string
|
|
1723
|
+
/**
|
|
1724
|
+
* Fired after a parent node record toggles its collapsed state.
|
|
1725
|
+
* @param {object} event Event object
|
|
1726
|
+
* @param {Core.data.Model} event.record The record being toggled.
|
|
1727
|
+
* @param {boolean} event.collapse `true` if the node is being collapsed.
|
|
1728
|
+
*/
|
|
1729
|
+
onToggleNode? : ((event: { record: Model, collapse: boolean }) => void)|string
|
|
1730
|
+
/**
|
|
1731
|
+
* A header [tool](https://bryntum.com/products/scheduler/docs/api/Core/widget/Panel#config-tools) has been clicked.
|
|
1732
|
+
* @param {object} event Event object
|
|
1733
|
+
* @param {Core.widget.Tool} event.source This Panel.
|
|
1734
|
+
* @param {Core.widget.Tool} event.tool The tool which is being clicked.
|
|
1735
|
+
*/
|
|
1736
|
+
onToolClick? : ((event: { source: Tool, tool: Tool }) => void)|string
|
|
1737
|
+
/**
|
|
1738
|
+
* Fires when row locking is disabled.
|
|
1739
|
+
* @param {object} event Event object
|
|
1740
|
+
* @param {Grid.view.GridBase} event.clone The locked clone that will be destroyed
|
|
1741
|
+
*/
|
|
1742
|
+
onUnlockRows? : ((event: { clone: GridBase }) => void)|string
|
|
1743
|
+
/**
|
|
1744
|
+
* Fires when un-splitting the Grid.
|
|
1745
|
+
*/
|
|
1746
|
+
onUnsplit? : (() => void)|string
|
|
1747
|
+
|
|
1748
|
+
// Features
|
|
1749
|
+
/**
|
|
1750
|
+
* AI-powered filter feature for Grid. Allows users to type natural language queries to filter grid data.
|
|
1751
|
+
* ...
|
|
1752
|
+
* [View online docs...](https://bryntum.com/products/scheduler/docs/api/Grid/feature/ai/AIFilter)
|
|
1753
|
+
*/
|
|
1754
|
+
aiFilterFeature? : object|boolean|string|AIFilter|AIFilterConfig
|
|
1755
|
+
/**
|
|
1756
|
+
* Allows using `[Ctrl/CMD + C]`, `[Ctrl/CMD + X]` and `[Ctrl/CMD + V]` to cut, copy and paste cell or cell ranges. Also
|
|
1757
|
+
* makes cut, copy and paste actions available via the cell context menu.
|
|
1758
|
+
* ...
|
|
1759
|
+
* [View online docs...](https://bryntum.com/products/scheduler/docs/api/Grid/feature/CellCopyPaste)
|
|
1760
|
+
*/
|
|
1761
|
+
cellCopyPasteFeature? : object|boolean|string|CellCopyPaste|CellCopyPasteConfig
|
|
1762
|
+
/**
|
|
1763
|
+
* Adding this feature to the grid and other Bryntum products which are based on the Grid (i.e. Scheduler, SchedulerPro, and Gantt)
|
|
1764
|
+
* enables cell editing. Any subclass of [Field](https://bryntum.com/products/scheduler/docs/api/Core/widget/Field) can be used
|
|
1765
|
+
* as editor for the [Column](https://bryntum.com/products/scheduler/docs/api/Grid/column/Column). The most popular are:
|
|
1766
|
+
* ...
|
|
1767
|
+
* [View online docs...](https://bryntum.com/products/scheduler/docs/api/Grid/feature/CellEdit)
|
|
1768
|
+
*/
|
|
1769
|
+
cellEditFeature? : object|boolean|string|CellEdit|CellEditConfig
|
|
1770
|
+
/**
|
|
1771
|
+
* Right click to display context menu for cells. To invoke the cell menu in a keyboard-accessible manner, use the
|
|
1772
|
+
* `SPACE` key when the cell is focused.
|
|
1773
|
+
* ...
|
|
1774
|
+
* [View online docs...](https://bryntum.com/products/scheduler/docs/api/Grid/feature/CellMenu)
|
|
1775
|
+
*/
|
|
1776
|
+
cellMenuFeature? : object|boolean|string|CellMenu|CellMenuConfig
|
|
1777
|
+
/**
|
|
1778
|
+
* Displays a tooltip when hovering cells.
|
|
1779
|
+
* ...
|
|
1780
|
+
* [View online docs...](https://bryntum.com/products/scheduler/docs/api/Grid/feature/CellTooltip)
|
|
1781
|
+
*/
|
|
1782
|
+
cellTooltipFeature? : object|boolean|string|CellTooltip|CellTooltipConfig
|
|
1783
|
+
/**
|
|
1784
|
+
* Adds interactive charting to a Grid. [Charts](https://bryntum.com/products/scheduler/docs/api/Chart/widget/Chart) can be created from a selection of Grid data
|
|
1785
|
+
* and updated in realtime as data changes. Supports many common chart types with extensive styling and customization
|
|
1786
|
+
* options.
|
|
1787
|
+
* ...
|
|
1788
|
+
* [View online docs...](https://bryntum.com/products/scheduler/docs/api/Grid/feature/Charts)
|
|
1789
|
+
*/
|
|
1790
|
+
chartsFeature? : object|boolean|string|Charts|ChartsConfig
|
|
1791
|
+
/**
|
|
1792
|
+
* Enables the [autoWidth](https://bryntum.com/products/scheduler/docs/api/Grid/column/Column#config-autoWidth) config for a grid's columns.
|
|
1793
|
+
* ...
|
|
1794
|
+
* [View online docs...](https://bryntum.com/products/scheduler/docs/api/Grid/feature/ColumnAutoWidth)
|
|
1795
|
+
*/
|
|
1796
|
+
columnAutoWidthFeature? : object|boolean|string|ColumnAutoWidth|ColumnAutoWidthConfig
|
|
1797
|
+
/**
|
|
1798
|
+
* Displays a toolbar while dragging column headers. Drop on a button in the toolbar to activate a certain function,
|
|
1799
|
+
* for example to group by that column. This feature simplifies certain operations on touch devices.
|
|
1800
|
+
* ...
|
|
1801
|
+
* [View online docs...](https://bryntum.com/products/scheduler/docs/api/Grid/feature/ColumnDragToolbar)
|
|
1802
|
+
*/
|
|
1803
|
+
columnDragToolbarFeature? : object|boolean|string|ColumnDragToolbar|ColumnDragToolbarConfig
|
|
1804
|
+
/**
|
|
1805
|
+
* Displays a column picker (to show/hide columns) in the header context menu. Columns can be displayed in sub menus
|
|
1806
|
+
* by region or tag. Grouped headers are displayed as menu hierarchies.
|
|
1807
|
+
* ...
|
|
1808
|
+
* [View online docs...](https://bryntum.com/products/scheduler/docs/api/Grid/feature/ColumnPicker)
|
|
1809
|
+
*/
|
|
1810
|
+
columnPickerFeature? : object|boolean|string|ColumnPicker|ColumnPickerConfig
|
|
1811
|
+
/**
|
|
1812
|
+
* Allows user to rename columns by either right-clicking column header or using keyboard shortcuts when column header
|
|
1813
|
+
* is focused.
|
|
1814
|
+
* ...
|
|
1815
|
+
* [View online docs...](https://bryntum.com/products/scheduler/docs/api/Grid/feature/ColumnRename)
|
|
1816
|
+
*/
|
|
1817
|
+
columnRenameFeature? : object|boolean|string|ColumnRename|ColumnRenameConfig
|
|
1818
|
+
/**
|
|
1819
|
+
* Allows user to reorder columns by dragging headers. To get notified about column reorder listen to `change` event
|
|
1820
|
+
* on [columns](https://bryntum.com/products/scheduler/docs/api/Grid/data/ColumnStore) store.
|
|
1821
|
+
* ...
|
|
1822
|
+
* [View online docs...](https://bryntum.com/products/scheduler/docs/api/Grid/feature/ColumnReorder)
|
|
1823
|
+
*/
|
|
1824
|
+
columnReorderFeature? : object|boolean|string|ColumnReorder|ColumnReorderConfig
|
|
1825
|
+
/**
|
|
1826
|
+
* Enables user to resize columns by dragging a handle on the right hand side of the header. To get notified about column
|
|
1827
|
+
* resize listen to `change` event on [columns](https://bryntum.com/products/scheduler/docs/api/Grid/data/ColumnStore) store.
|
|
1828
|
+
* ...
|
|
1829
|
+
* [View online docs...](https://bryntum.com/products/scheduler/docs/api/Grid/feature/ColumnResize)
|
|
1830
|
+
*/
|
|
1831
|
+
columnResizeFeature? : object|boolean|string|ColumnResize|ColumnResizeConfig
|
|
1832
|
+
/**
|
|
1833
|
+
* A feature that allows exporting Grid data to Excel or CSV without involving the server. It uses
|
|
1834
|
+
* [TableExporter](https://bryntum.com/products/scheduler/docs/api/Grid/util/TableExporter) class as data provider, 3rd party provider to generate XLS files, and
|
|
1835
|
+
* [Microsoft XML specification](https://msdn.microsoft.com/en-us/library/office/documentformat.openxml.spreadsheet.aspx).
|
|
1836
|
+
* ...
|
|
1837
|
+
* [View online docs...](https://bryntum.com/products/scheduler/docs/api/Grid/feature/experimental/ExcelExporter)
|
|
1838
|
+
*/
|
|
1839
|
+
excelExporterFeature? : object|boolean|string|GridExcelExporter|GridExcelExporterConfig
|
|
1840
|
+
/**
|
|
1841
|
+
* An experimental feature that lets users drop files on a Widget. The widget fires an event when a file is dropped onto it.
|
|
1842
|
+
* In the event, you get access to the raw files as strings, that were parsed by calling `readAsBinaryString`.
|
|
1843
|
+
* ...
|
|
1844
|
+
* [View online docs...](https://bryntum.com/products/scheduler/docs/api/Grid/feature/experimental/FileDrop)
|
|
1845
|
+
*/
|
|
1846
|
+
fileDropFeature? : object|boolean|string|FileDrop|FileDropConfig
|
|
1847
|
+
/**
|
|
1848
|
+
* This feature adds a fill handle to a Grid range selection, which when dragged, fills the cells being dragged over
|
|
1849
|
+
* with values based on the values in the original selected range. This is similar to functionality normally seen in
|
|
1850
|
+
* various spreadsheet applications.
|
|
1851
|
+
* ...
|
|
1852
|
+
* [View online docs...](https://bryntum.com/products/scheduler/docs/api/Grid/feature/FillHandle)
|
|
1853
|
+
*/
|
|
1854
|
+
fillHandleFeature? : object|boolean|string|FillHandle|FillHandleConfig
|
|
1855
|
+
/**
|
|
1856
|
+
* Feature that allows filtering of the grid by settings filters on columns. The actual filtering is done by the store.
|
|
1857
|
+
* For info on programmatically handling filters, see [StoreFilter](https://bryntum.com/products/scheduler/docs/api/Core/data/mixin/StoreFilter).
|
|
1858
|
+
* ...
|
|
1859
|
+
* [View online docs...](https://bryntum.com/products/scheduler/docs/api/Grid/feature/Filter)
|
|
1860
|
+
*/
|
|
1861
|
+
filterFeature? : object|boolean|string|Filter|FilterConfig
|
|
1862
|
+
/**
|
|
1863
|
+
* Feature that allows filtering of the grid by entering filters on column headers.
|
|
1864
|
+
* The actual filtering is done by the store.
|
|
1865
|
+
* For info on programmatically handling filters, see [StoreFilter](https://bryntum.com/products/scheduler/docs/api/Core/data/mixin/StoreFilter).
|
|
1866
|
+
* ...
|
|
1867
|
+
* [View online docs...](https://bryntum.com/products/scheduler/docs/api/Grid/feature/FilterBar)
|
|
1868
|
+
*/
|
|
1869
|
+
filterBarFeature? : object|boolean|string|FilterBar|FilterBarConfig
|
|
1870
|
+
/**
|
|
1871
|
+
* Enables rendering and handling of row groups. The actual grouping is done in the store, but triggered by
|
|
1872
|
+
* <kbd>shift</kbd> + clicking headers, or by using the context menu, or by using two finger tap (one on header,
|
|
1873
|
+
* one anywhere on grid). Use <kbd>shift</kbd> + <kbd>alt</kbd> + click, or the context menu, to remove a column
|
|
1874
|
+
* grouper.
|
|
1875
|
+
* ...
|
|
1876
|
+
* [View online docs...](https://bryntum.com/products/scheduler/docs/api/Grid/feature/Group)
|
|
1877
|
+
*/
|
|
1878
|
+
groupFeature? : object|boolean|string|Group|GroupConfig
|
|
1879
|
+
/**
|
|
1880
|
+
* Displays a summary row as a group footer in a grouped grid. Uses the same configuration options on columns as
|
|
1881
|
+
* [Summary](https://bryntum.com/products/scheduler/docs/api/Grid/feature/Summary).
|
|
1882
|
+
* ...
|
|
1883
|
+
* [View online docs...](https://bryntum.com/products/scheduler/docs/api/Grid/feature/GroupSummary)
|
|
1884
|
+
*/
|
|
1885
|
+
groupSummaryFeature? : object|boolean|string|GridGroupSummary|GridGroupSummaryConfig
|
|
1886
|
+
/**
|
|
1887
|
+
* Right click column header or focus it and press SPACE key to show the context menu for headers.
|
|
1888
|
+
* ...
|
|
1889
|
+
* [View online docs...](https://bryntum.com/products/scheduler/docs/api/Grid/feature/HeaderMenu)
|
|
1890
|
+
*/
|
|
1891
|
+
headerMenuFeature? : object|boolean|string|HeaderMenu|HeaderMenuConfig
|
|
1892
|
+
/**
|
|
1893
|
+
* This feature allows records which satisfy a certain condition to be locked at the top of the grid.
|
|
1894
|
+
* ...
|
|
1895
|
+
* [View online docs...](https://bryntum.com/products/scheduler/docs/api/Grid/feature/LockRows)
|
|
1896
|
+
*/
|
|
1897
|
+
lockRowsFeature? : object|boolean|string|GridLockRows|GridLockRowsConfig
|
|
1898
|
+
/**
|
|
1899
|
+
* This feature merges cells that have the same value in sorted (or [optionally](https://bryntum.com/products/scheduler/docs/api/Grid/feature/MergeCells#config-sortedOnly) any) columns
|
|
1900
|
+
* configured to [mergeCells](https://bryntum.com/products/scheduler/docs/api/Grid/column/Column#config-mergeCells).
|
|
1901
|
+
* ...
|
|
1902
|
+
* [View online docs...](https://bryntum.com/products/scheduler/docs/api/Grid/feature/MergeCells)
|
|
1903
|
+
*/
|
|
1904
|
+
mergeCellsFeature? : object|boolean|string|MergeCells|MergeCellsConfig
|
|
1905
|
+
/**
|
|
1906
|
+
* Generates PDF/PNG files from the Grid component.
|
|
1907
|
+
* ...
|
|
1908
|
+
* [View online docs...](https://bryntum.com/products/scheduler/docs/api/Grid/feature/export/PdfExport)
|
|
1909
|
+
*/
|
|
1910
|
+
pdfExportFeature? : object|boolean|string|GridPdfExport|GridPdfExportConfig
|
|
1911
|
+
/**
|
|
1912
|
+
* Allows pinning columns to the start or end region of the grid without any additional subGrid configurations.
|
|
1913
|
+
* When pinning to a region that does not yet exist, the feature creates the required subGrid on the fly.
|
|
1914
|
+
* ...
|
|
1915
|
+
* [View online docs...](https://bryntum.com/products/scheduler/docs/api/Grid/feature/PinColumns)
|
|
1916
|
+
*/
|
|
1917
|
+
pinColumnsFeature? : object|boolean|string|PinColumns|PinColumnsConfig
|
|
1918
|
+
/**
|
|
1919
|
+
* Allows printing Grid contents using browser print dialog.
|
|
1920
|
+
* ...
|
|
1921
|
+
* [View online docs...](https://bryntum.com/products/scheduler/docs/api/Grid/feature/export/Print)
|
|
1922
|
+
*/
|
|
1923
|
+
printFeature? : object|boolean|string|GridPrint|GridPrintConfig
|
|
1924
|
+
/**
|
|
1925
|
+
* Feature that allows the user to search in a column by focusing a cell and typing. Navigate between hits using the
|
|
1926
|
+
* keyboard, [f3] or [ctrl]/[cmd] + [g] moves to next, also pressing [shift] moves to previous.
|
|
1927
|
+
* ...
|
|
1928
|
+
* [View online docs...](https://bryntum.com/products/scheduler/docs/api/Grid/feature/QuickFind)
|
|
1929
|
+
*/
|
|
1930
|
+
quickFindFeature? : object|boolean|string|QuickFind|QuickFindConfig
|
|
1931
|
+
/**
|
|
1932
|
+
* Makes the splitter between grid [sections](https://bryntum.com/products/scheduler/docs/api/Grid/view/SubGrid) draggable, to let users resize, and
|
|
1933
|
+
* collapse/expand the sections.
|
|
1934
|
+
* ...
|
|
1935
|
+
* [View online docs...](https://bryntum.com/products/scheduler/docs/api/Grid/feature/RegionResize)
|
|
1936
|
+
*/
|
|
1937
|
+
regionResizeFeature? : object|boolean|string|RegionResize|RegionResizeConfig
|
|
1938
|
+
/**
|
|
1939
|
+
* Allow using [Ctrl/CMD + C/X] and [Ctrl/CMD + V] to copy/cut-and-paste rows. Also makes cut, copy and paste actions
|
|
1940
|
+
* available via the cell context menu.
|
|
1941
|
+
* ...
|
|
1942
|
+
* [View online docs...](https://bryntum.com/products/scheduler/docs/api/Grid/feature/RowCopyPaste)
|
|
1943
|
+
*/
|
|
1944
|
+
rowCopyPasteFeature? : object|boolean|string|RowCopyPaste|RowCopyPasteConfig
|
|
1945
|
+
/**
|
|
1946
|
+
* This feature allows editing of entire rows in a grid in a docked panel which by default slides out from the right.
|
|
1947
|
+
* ...
|
|
1948
|
+
* [View online docs...](https://bryntum.com/products/scheduler/docs/api/Grid/feature/RowEdit)
|
|
1949
|
+
*/
|
|
1950
|
+
rowEditFeature? : object|boolean|string|RowEdit|RowEditConfig
|
|
1951
|
+
/**
|
|
1952
|
+
* Enables expanding of Grid rows by either row click or double click, or by adding a separate Grid column which renders
|
|
1953
|
+
* a button that expands or collapses the row.
|
|
1954
|
+
* ...
|
|
1955
|
+
* [View online docs...](https://bryntum.com/products/scheduler/docs/api/Grid/feature/RowExpander)
|
|
1956
|
+
*/
|
|
1957
|
+
rowExpanderFeature? : object|boolean|string|RowExpander|RowExpanderConfig
|
|
1958
|
+
/**
|
|
1959
|
+
* Allows user to reorder rows by dragging them. To get notified about row reorder listen to `change` event
|
|
1960
|
+
* on the grid [store](https://bryntum.com/products/scheduler/docs/api/Core/data/Store).
|
|
1961
|
+
* ...
|
|
1962
|
+
* [View online docs...](https://bryntum.com/products/scheduler/docs/api/Grid/feature/RowReorder)
|
|
1963
|
+
*/
|
|
1964
|
+
rowReorderFeature? : object|boolean|string|GridRowReorder|GridRowReorderConfig
|
|
1965
|
+
/**
|
|
1966
|
+
* Enables user to change row height by dragging the bottom row border. After a resize operation, the [rowHeight](https://bryntum.com/products/scheduler/docs/api/Grid/data/GridRowModel#field-rowHeight)
|
|
1967
|
+
* field of the record is updated (when [applyToAllRows](https://bryntum.com/products/scheduler/docs/api/Grid/feature/RowResize#config-applyToAllRows) is `false`).
|
|
1968
|
+
* ...
|
|
1969
|
+
* [View online docs...](https://bryntum.com/products/scheduler/docs/api/Grid/feature/RowResize)
|
|
1970
|
+
*/
|
|
1971
|
+
rowResizeFeature? : object|boolean|string|GridRowResize|GridRowResizeConfig
|
|
1972
|
+
/**
|
|
1973
|
+
* <div class="external-example vertical" data-file="Grid/feature/Search.js"></div>
|
|
1974
|
+
* ...
|
|
1975
|
+
* [View online docs...](https://bryntum.com/products/scheduler/docs/api/Grid/feature/Search)
|
|
1976
|
+
*/
|
|
1977
|
+
searchFeature? : object|boolean|string|Search|SearchConfig
|
|
1978
|
+
/**
|
|
1979
|
+
* Allows sorting of grid by clicking (or tapping) headers, also displays which columns grid is sorted by (numbered if
|
|
1980
|
+
* using multisort). Use modifier keys for multisorting: [Ctrl/CMD + click] to add sorter, [Ctrl/CMD + Alt + click] to remove sorter.
|
|
1981
|
+
* The actual sorting is done by the store, see [Store.sort()](https://bryntum.com/products/scheduler/docs/api/Core/data/mixin/StoreSort#function-sort).
|
|
1982
|
+
* ...
|
|
1983
|
+
* [View online docs...](https://bryntum.com/products/scheduler/docs/api/Grid/feature/Sort)
|
|
1984
|
+
*/
|
|
1985
|
+
sortFeature? : object|boolean|string|Sort|SortConfig
|
|
1986
|
+
/**
|
|
1987
|
+
* This feature allows splitting the Grid into multiple views, either by using the cell context menu, or
|
|
1988
|
+
* programmatically by calling [split()](https://bryntum.com/products/scheduler/docs/api/Grid/feature/Split#function-split).
|
|
1989
|
+
* ...
|
|
1990
|
+
* [View online docs...](https://bryntum.com/products/scheduler/docs/api/Grid/feature/Split)
|
|
1991
|
+
*/
|
|
1992
|
+
splitFeature? : object|boolean|string|GridSplit|GridSplitConfig
|
|
1993
|
+
/**
|
|
1994
|
+
* A feature which pins configurable content from a grid row to the top of the grid
|
|
1995
|
+
* while the row scrolls off the top but is still visible.
|
|
1996
|
+
* ...
|
|
1997
|
+
* [View online docs...](https://bryntum.com/products/scheduler/docs/api/Grid/feature/StickyCells)
|
|
1998
|
+
*/
|
|
1999
|
+
stickyCellsFeature? : object|boolean|string|StickyCells|StickyCellsConfig
|
|
2000
|
+
/**
|
|
2001
|
+
* Stripes rows by adding alternating CSS classes to all row elements (`b-even` and `b-odd`).
|
|
2002
|
+
* ...
|
|
2003
|
+
* [View online docs...](https://bryntum.com/products/scheduler/docs/api/Grid/feature/Stripe)
|
|
2004
|
+
*/
|
|
2005
|
+
stripeFeature? : object|boolean|string|Stripe|StripeConfig
|
|
2006
|
+
/**
|
|
2007
|
+
* Displays a summary row in the grid footer.
|
|
2008
|
+
* ...
|
|
2009
|
+
* [View online docs...](https://bryntum.com/products/scheduler/docs/api/Grid/feature/Summary)
|
|
2010
|
+
*/
|
|
2011
|
+
summaryFeature? : object|boolean|string|GridSummary|GridSummaryConfig
|
|
2012
|
+
/**
|
|
2013
|
+
* Feature that makes the grid work more like a tree. Included by default in [TreeGrid](https://bryntum.com/products/scheduler/docs/api/Grid/view/TreeGrid). Requires
|
|
2014
|
+
* exactly one [TreeColumn](https://bryntum.com/products/scheduler/docs/api/Grid/column/TreeColumn) among grids columns. That column will have its renderer replaced with a
|
|
2015
|
+
* tree renderer that adds padding and icon to give the appearance of a tree. The original renderer is preserved and
|
|
2016
|
+
* also called.
|
|
2017
|
+
* ...
|
|
2018
|
+
* [View online docs...](https://bryntum.com/products/scheduler/docs/api/Grid/feature/Tree)
|
|
2019
|
+
*/
|
|
2020
|
+
treeFeature? : object|boolean|string|Tree|TreeConfig
|
|
2021
|
+
/**
|
|
2022
|
+
* A feature that allows transforming a flat dataset (or the leaves of a hierarchical) into a tree by specifying a
|
|
2023
|
+
* record field per parent level. Parents are generated based on each leaf's value for those fields.
|
|
2024
|
+
* ...
|
|
2025
|
+
* [View online docs...](https://bryntum.com/products/scheduler/docs/api/Grid/feature/TreeGroup)
|
|
2026
|
+
*/
|
|
2027
|
+
treeGroupFeature? : object|boolean|string|TreeGroup|TreeGroupConfig
|
|
2028
|
+
|
|
2029
|
+
}
|
|
2030
|
+
|
|
2031
|
+
export class BryntumGrid extends React.Component<BryntumGridProps> {
|
|
2032
|
+
|
|
2033
|
+
static instanceClass = Grid;
|
|
2034
|
+
|
|
2035
|
+
static instanceName = 'Grid';
|
|
2036
|
+
|
|
2037
|
+
processWidgetContent = processWidgetContent;
|
|
2038
|
+
|
|
2039
|
+
// Component is View class
|
|
2040
|
+
static isView = true;
|
|
2041
|
+
|
|
2042
|
+
// Hidden div to host unused portals DOM
|
|
2043
|
+
portalsCache? : HTMLElement;
|
|
2044
|
+
|
|
2045
|
+
// CSS class used for individual portal containers
|
|
2046
|
+
portalContainerClass = 'b-react-portal-container';
|
|
2047
|
+
|
|
2048
|
+
state = {
|
|
2049
|
+
// Holds React portals
|
|
2050
|
+
portals : new Map(),
|
|
2051
|
+
|
|
2052
|
+
// Needed to trigger refresh when portals change
|
|
2053
|
+
generation : 0
|
|
2054
|
+
};
|
|
2055
|
+
|
|
2056
|
+
static featureNames = [
|
|
2057
|
+
'aiFilterFeature',
|
|
2058
|
+
'cellCopyPasteFeature',
|
|
2059
|
+
'cellEditFeature',
|
|
2060
|
+
'cellMenuFeature',
|
|
2061
|
+
'cellTooltipFeature',
|
|
2062
|
+
'chartsFeature',
|
|
2063
|
+
'columnAutoWidthFeature',
|
|
2064
|
+
'columnDragToolbarFeature',
|
|
2065
|
+
'columnPickerFeature',
|
|
2066
|
+
'columnRenameFeature',
|
|
2067
|
+
'columnReorderFeature',
|
|
2068
|
+
'columnResizeFeature',
|
|
2069
|
+
'excelExporterFeature',
|
|
2070
|
+
'fileDropFeature',
|
|
2071
|
+
'fillHandleFeature',
|
|
2072
|
+
'filterFeature',
|
|
2073
|
+
'filterBarFeature',
|
|
2074
|
+
'groupFeature',
|
|
2075
|
+
'groupSummaryFeature',
|
|
2076
|
+
'headerMenuFeature',
|
|
2077
|
+
'lockRowsFeature',
|
|
2078
|
+
'mergeCellsFeature',
|
|
2079
|
+
'pdfExportFeature',
|
|
2080
|
+
'pinColumnsFeature',
|
|
2081
|
+
'printFeature',
|
|
2082
|
+
'quickFindFeature',
|
|
2083
|
+
'regionResizeFeature',
|
|
2084
|
+
'rowCopyPasteFeature',
|
|
2085
|
+
'rowEditFeature',
|
|
2086
|
+
'rowExpanderFeature',
|
|
2087
|
+
'rowReorderFeature',
|
|
2088
|
+
'rowResizeFeature',
|
|
2089
|
+
'searchFeature',
|
|
2090
|
+
'sortFeature',
|
|
2091
|
+
'splitFeature',
|
|
2092
|
+
'stickyCellsFeature',
|
|
2093
|
+
'stripeFeature',
|
|
2094
|
+
'summaryFeature',
|
|
2095
|
+
'treeFeature',
|
|
2096
|
+
'treeGroupFeature'
|
|
2097
|
+
];
|
|
2098
|
+
|
|
2099
|
+
projectStores = false;
|
|
2100
|
+
|
|
2101
|
+
dataStores = {
|
|
2102
|
+
'originalStore': 'originals',
|
|
2103
|
+
'store': 'data'
|
|
2104
|
+
};
|
|
2105
|
+
|
|
2106
|
+
static configNames = [
|
|
2107
|
+
'adopt',
|
|
2108
|
+
'animateFilterRemovals',
|
|
2109
|
+
'animateRemovingRows',
|
|
2110
|
+
'ariaDescription',
|
|
2111
|
+
'ariaLabel',
|
|
2112
|
+
'autoHeight',
|
|
2113
|
+
'bbar',
|
|
2114
|
+
'bodyCls',
|
|
2115
|
+
'bubbleEvents',
|
|
2116
|
+
'collapsible',
|
|
2117
|
+
'color',
|
|
2118
|
+
'config',
|
|
2119
|
+
'contentElementCls',
|
|
2120
|
+
'contextMenuTriggerEvent',
|
|
2121
|
+
'dataField',
|
|
2122
|
+
'defaultRegion',
|
|
2123
|
+
'destroyStore',
|
|
2124
|
+
'detectCSSCompatibilityIssues',
|
|
2125
|
+
'disableGridColumnIdWarning',
|
|
2126
|
+
'disableGridRowModelWarning',
|
|
2127
|
+
'dock',
|
|
2128
|
+
'drawer',
|
|
2129
|
+
'elementAttributes',
|
|
2130
|
+
'enableSticky',
|
|
2131
|
+
'enableTextSelection',
|
|
2132
|
+
'fillLastColumn',
|
|
2133
|
+
'fixedRowHeight',
|
|
2134
|
+
'footer',
|
|
2135
|
+
'formulaProviders',
|
|
2136
|
+
'fullRowRefresh',
|
|
2137
|
+
'getRowHeight',
|
|
2138
|
+
'header',
|
|
2139
|
+
'hideHorizontalScrollbar',
|
|
2140
|
+
'hoverCls',
|
|
2141
|
+
'icon',
|
|
2142
|
+
'ignoreParentReadOnly',
|
|
2143
|
+
'listeners',
|
|
2144
|
+
'loadMask',
|
|
2145
|
+
'loadMaskDefaults',
|
|
2146
|
+
'loadMaskError',
|
|
2147
|
+
'localizable',
|
|
2148
|
+
'maskDefaults',
|
|
2149
|
+
'masked',
|
|
2150
|
+
'monitorResize',
|
|
2151
|
+
'owner',
|
|
2152
|
+
'plugins',
|
|
2153
|
+
'preserveFocusOnDatasetChange',
|
|
2154
|
+
'preserveScrollOnDatasetChange',
|
|
2155
|
+
'preventTooltipOnTouch',
|
|
2156
|
+
'relayStoreEvents',
|
|
2157
|
+
'resizable',
|
|
2158
|
+
'resizeToFitIncludesHeader',
|
|
2159
|
+
'responsiveLevels',
|
|
2160
|
+
'ripple',
|
|
2161
|
+
'rootElement',
|
|
2162
|
+
'scrollerClass',
|
|
2163
|
+
'scrollManager',
|
|
2164
|
+
'showDirty',
|
|
2165
|
+
'stateful',
|
|
2166
|
+
'statefulEvents',
|
|
2167
|
+
'stateId',
|
|
2168
|
+
'stateProvider',
|
|
2169
|
+
'strips',
|
|
2170
|
+
'subGridConfigs',
|
|
2171
|
+
'syncMask',
|
|
2172
|
+
'tab',
|
|
2173
|
+
'tabBarItems',
|
|
2174
|
+
'tbar',
|
|
2175
|
+
'type',
|
|
2176
|
+
'ui',
|
|
2177
|
+
'weight'
|
|
2178
|
+
];
|
|
2179
|
+
|
|
2180
|
+
static propertyConfigNames = [
|
|
2181
|
+
'alignSelf',
|
|
2182
|
+
'animateTreeNodeToggle',
|
|
2183
|
+
'appendTo',
|
|
2184
|
+
'callOnFunctions',
|
|
2185
|
+
'catchEventHandlerExceptions',
|
|
2186
|
+
'cellEllipsis',
|
|
2187
|
+
'cls',
|
|
2188
|
+
'collapsed',
|
|
2189
|
+
'column',
|
|
2190
|
+
'columnLines',
|
|
2191
|
+
'columns',
|
|
2192
|
+
'data',
|
|
2193
|
+
'dataset',
|
|
2194
|
+
'disabled',
|
|
2195
|
+
'emptyText',
|
|
2196
|
+
'enableUndoRedoKeys',
|
|
2197
|
+
'extraData',
|
|
2198
|
+
'flex',
|
|
2199
|
+
'height',
|
|
2200
|
+
'hidden',
|
|
2201
|
+
'hideFooters',
|
|
2202
|
+
'hideHeaders',
|
|
2203
|
+
'id',
|
|
2204
|
+
'inputFieldAlign',
|
|
2205
|
+
'insertBefore',
|
|
2206
|
+
'insertFirst',
|
|
2207
|
+
'keyMap',
|
|
2208
|
+
'labelPosition',
|
|
2209
|
+
'longPressTime',
|
|
2210
|
+
'margin',
|
|
2211
|
+
'maxHeight',
|
|
2212
|
+
'maxWidth',
|
|
2213
|
+
'minHeight',
|
|
2214
|
+
'minWidth',
|
|
2215
|
+
'onBeforeCancelCellEdit',
|
|
2216
|
+
'onBeforeCancelRowEdit',
|
|
2217
|
+
'onBeforeCellEditStart',
|
|
2218
|
+
'onBeforeCellRangeDelete',
|
|
2219
|
+
'onBeforeCellRangeEdit',
|
|
2220
|
+
'onBeforeColumnDragStart',
|
|
2221
|
+
'onBeforeColumnDropFinalize',
|
|
2222
|
+
'onBeforeColumnResize',
|
|
2223
|
+
'onBeforeCopy',
|
|
2224
|
+
'onBeforeCSVExport',
|
|
2225
|
+
'onBeforeDestroy',
|
|
2226
|
+
'onBeforeExcelExport',
|
|
2227
|
+
'onBeforeFillHandleDragStart',
|
|
2228
|
+
'onBeforeFinishCellEdit',
|
|
2229
|
+
'onBeforeFinishRowEdit',
|
|
2230
|
+
'onBeforeHide',
|
|
2231
|
+
'onBeforePaste',
|
|
2232
|
+
'onBeforePdfExport',
|
|
2233
|
+
'onBeforeRenderRow',
|
|
2234
|
+
'onBeforeRenderRows',
|
|
2235
|
+
'onBeforeRowCollapse',
|
|
2236
|
+
'onBeforeRowExpand',
|
|
2237
|
+
'onBeforeSelectionChange',
|
|
2238
|
+
'onBeforeSetRecord',
|
|
2239
|
+
'onBeforeShow',
|
|
2240
|
+
'onBeforeStartRowEdit',
|
|
2241
|
+
'onBeforeStateApply',
|
|
2242
|
+
'onBeforeStateSave',
|
|
2243
|
+
'onBeforeToggleGroup',
|
|
2244
|
+
'onBeforeToggleNode',
|
|
2245
|
+
'onCancelCellEdit',
|
|
2246
|
+
'onCatchAll',
|
|
2247
|
+
'onCellClick',
|
|
2248
|
+
'onCellContextMenu',
|
|
2249
|
+
'onCellDblClick',
|
|
2250
|
+
'onCellMenuBeforeShow',
|
|
2251
|
+
'onCellMenuItem',
|
|
2252
|
+
'onCellMenuShow',
|
|
2253
|
+
'onCellMenuToggleItem',
|
|
2254
|
+
'onCellMouseEnter',
|
|
2255
|
+
'onCellMouseLeave',
|
|
2256
|
+
'onCellMouseOut',
|
|
2257
|
+
'onCellMouseOver',
|
|
2258
|
+
'onCollapse',
|
|
2259
|
+
'onCollapseNode',
|
|
2260
|
+
'onColumnDrag',
|
|
2261
|
+
'onColumnDragStart',
|
|
2262
|
+
'onColumnDrop',
|
|
2263
|
+
'onColumnResize',
|
|
2264
|
+
'onColumnResizeStart',
|
|
2265
|
+
'onContextMenuItem',
|
|
2266
|
+
'onContextMenuToggleItem',
|
|
2267
|
+
'onCopy',
|
|
2268
|
+
'onDataChange',
|
|
2269
|
+
'onDestroy',
|
|
2270
|
+
'onDirtyStateChange',
|
|
2271
|
+
'onDragSelecting',
|
|
2272
|
+
'onElementCreated',
|
|
2273
|
+
'onExpand',
|
|
2274
|
+
'onExpandNode',
|
|
2275
|
+
'onFileDrop',
|
|
2276
|
+
'onFillHandleBeforeDragFinalize',
|
|
2277
|
+
'onFillHandleDrag',
|
|
2278
|
+
'onFillHandleDragAbort',
|
|
2279
|
+
'onFillHandleDragEnd',
|
|
2280
|
+
'onFillHandleDragStart',
|
|
2281
|
+
'onFinishCellEdit',
|
|
2282
|
+
'onFinishRowEdit',
|
|
2283
|
+
'onFocusIn',
|
|
2284
|
+
'onFocusOut',
|
|
2285
|
+
'onGridRowBeforeDragStart',
|
|
2286
|
+
'onGridRowBeforeDropFinalize',
|
|
2287
|
+
'onGridRowDrag',
|
|
2288
|
+
'onGridRowDragAbort',
|
|
2289
|
+
'onGridRowDragStart',
|
|
2290
|
+
'onGridRowDrop',
|
|
2291
|
+
'onHeaderClick',
|
|
2292
|
+
'onHeaderMenuBeforeShow',
|
|
2293
|
+
'onHeaderMenuItem',
|
|
2294
|
+
'onHeaderMenuShow',
|
|
2295
|
+
'onHeaderMenuToggleItem',
|
|
2296
|
+
'onHide',
|
|
2297
|
+
'onLockRows',
|
|
2298
|
+
'onMouseOut',
|
|
2299
|
+
'onMouseOver',
|
|
2300
|
+
'onPaint',
|
|
2301
|
+
'onPaste',
|
|
2302
|
+
'onPdfExport',
|
|
2303
|
+
'onReadOnly',
|
|
2304
|
+
'onRecompose',
|
|
2305
|
+
'onRenderRow',
|
|
2306
|
+
'onRenderRows',
|
|
2307
|
+
'onResize',
|
|
2308
|
+
'onResponsive',
|
|
2309
|
+
'onRowCollapse',
|
|
2310
|
+
'onRowExpand',
|
|
2311
|
+
'onRowMouseEnter',
|
|
2312
|
+
'onRowMouseLeave',
|
|
2313
|
+
'onScroll',
|
|
2314
|
+
'onSelectionChange',
|
|
2315
|
+
'onSelectionModeChange',
|
|
2316
|
+
'onShow',
|
|
2317
|
+
'onSplit',
|
|
2318
|
+
'onSplitterCollapseClick',
|
|
2319
|
+
'onSplitterDragEnd',
|
|
2320
|
+
'onSplitterDragStart',
|
|
2321
|
+
'onSplitterExpandClick',
|
|
2322
|
+
'onStartCellEdit',
|
|
2323
|
+
'onStartRowEdit',
|
|
2324
|
+
'onSubGridCollapse',
|
|
2325
|
+
'onSubGridExpand',
|
|
2326
|
+
'onToggleGroup',
|
|
2327
|
+
'onToggleNode',
|
|
2328
|
+
'onToolClick',
|
|
2329
|
+
'onUnlockRows',
|
|
2330
|
+
'onUnsplit',
|
|
2331
|
+
'preserveScroll',
|
|
2332
|
+
'readOnly',
|
|
2333
|
+
'rendition',
|
|
2334
|
+
'rowHeight',
|
|
2335
|
+
'rowLines',
|
|
2336
|
+
'rtl',
|
|
2337
|
+
'scrollable',
|
|
2338
|
+
'selectionMode',
|
|
2339
|
+
'span',
|
|
2340
|
+
'stateSettings',
|
|
2341
|
+
'store',
|
|
2342
|
+
'title',
|
|
2343
|
+
'tools',
|
|
2344
|
+
'transition',
|
|
2345
|
+
'transitionDuration',
|
|
2346
|
+
'width'
|
|
2347
|
+
];
|
|
2348
|
+
|
|
2349
|
+
static propertyNames = [
|
|
2350
|
+
'focusVisible',
|
|
2351
|
+
'hasChanges',
|
|
2352
|
+
'originalStore',
|
|
2353
|
+
'parent',
|
|
2354
|
+
'selectedCell',
|
|
2355
|
+
'selectedCells',
|
|
2356
|
+
'selectedRecord',
|
|
2357
|
+
'selectedRecords',
|
|
2358
|
+
'selectedRows',
|
|
2359
|
+
'state',
|
|
2360
|
+
'tooltip'
|
|
2361
|
+
];
|
|
2362
|
+
|
|
2363
|
+
// Component instance
|
|
2364
|
+
instance!: Grid;
|
|
2365
|
+
|
|
2366
|
+
// Component element
|
|
2367
|
+
element! : HTMLElement;
|
|
2368
|
+
|
|
2369
|
+
componentDidMount(): void {
|
|
2370
|
+
this.instance = createWidget(this);
|
|
2371
|
+
}
|
|
2372
|
+
|
|
2373
|
+
componentWillUnmount(): void {
|
|
2374
|
+
// @ts-ignore
|
|
2375
|
+
this.instance?.destroy?.();
|
|
2376
|
+
}
|
|
2377
|
+
|
|
2378
|
+
/**
|
|
2379
|
+
* Component about to be updated, from changing a prop using state.
|
|
2380
|
+
* React to it depending on what changed and prevent react from re-rendering our component.
|
|
2381
|
+
* @param nextProps
|
|
2382
|
+
* @param nextState
|
|
2383
|
+
* @returns {boolean}
|
|
2384
|
+
*/
|
|
2385
|
+
shouldComponentUpdate(nextProps: Readonly<BryntumGridProps>, nextState: Readonly<{}>): boolean {
|
|
2386
|
+
return shouldComponentUpdate(this, nextProps, nextState);
|
|
2387
|
+
}
|
|
2388
|
+
|
|
2389
|
+
render(): React.ReactNode {
|
|
2390
|
+
|
|
2391
|
+
const className = `b-react-grid-container`;
|
|
2392
|
+
return (
|
|
2393
|
+
<React.Fragment>
|
|
2394
|
+
<div className={className} ref={(element) => (this.element = element!)}>
|
|
2395
|
+
{Array.from(this.state.portals).map((item) => item[1])}
|
|
2396
|
+
</div>
|
|
2397
|
+
<div ref={el => (this.portalsCache = el!)} className="b-react-portals-cache" style={{ display : 'none' }}></div>
|
|
2398
|
+
</React.Fragment>
|
|
2399
|
+
);
|
|
2400
|
+
|
|
2401
|
+
}
|
|
2402
|
+
}
|