@bryntum/scheduler-vue-3-thin 7.2.3 → 7.3.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +6 -6
- package/lib/chunks/{C7ZFK2B7.js → 5o-YjSb7.js} +16 -10
- package/lib/chunks/5o-YjSb7.js.map +1 -0
- package/lib/chunks/BXIuEgYD.js +265 -0
- package/lib/chunks/BXIuEgYD.js.map +1 -0
- package/lib/chunks/{BD-Hg3lY.js → DB0UHrA3.js} +17 -24
- package/lib/chunks/DB0UHrA3.js.map +1 -0
- package/lib/chunks/{DmQj0tBi.js → DP61St-u.js} +14 -6
- package/lib/chunks/DP61St-u.js.map +1 -0
- package/lib/chunks/{B0m0r-NV.js → DVFhf2Ma.js} +11 -11
- package/lib/chunks/DVFhf2Ma.js.map +1 -0
- package/lib/chunks/{DerP_qo7.js → DhhzgoYL.js} +16 -10
- package/lib/chunks/DhhzgoYL.js.map +1 -0
- package/lib/chunks/{BNGLBrCN.js → OJaN5ZWK.js} +6 -6
- package/lib/chunks/OJaN5ZWK.js.map +1 -0
- package/lib/chunks/{CP1Mm_Ak.js → R69sJLmF.js} +16 -17
- package/lib/chunks/R69sJLmF.js.map +1 -0
- package/lib/chunks/{mKqb8_2f.js → ZkU6CtWX.js} +6 -6
- package/lib/chunks/ZkU6CtWX.js.map +1 -0
- package/lib/chunks/{C0UqC4Uj.js → eUISgYXE.js} +9 -9
- package/lib/chunks/eUISgYXE.js.map +1 -0
- package/lib/chunks/{CsoS615B.js → kN-s_8Na.js} +6 -6
- package/lib/chunks/kN-s_8Na.js.map +1 -0
- package/lib/chunks/{C2PT-Ukt.js → t8aiH3XL.js} +13 -14
- package/lib/chunks/t8aiH3XL.js.map +1 -0
- package/lib/components/BryntumEventColorField.js +1 -1
- package/lib/components/BryntumProjectCombo.js +1 -1
- package/lib/components/BryntumResourceCombo.js +1 -1
- package/lib/components/BryntumResourceFilter.js +1 -1
- package/lib/components/BryntumScheduler.js +1 -1
- package/lib/components/BryntumSchedulerBase.js +1 -1
- package/lib/components/BryntumSchedulerDatePicker.js +1 -1
- package/lib/components/BryntumSchedulerProjectModel.js +1 -1
- package/lib/components/BryntumThemeCombo.js +57 -0
- package/lib/components/BryntumThemeCombo.js.map +1 -0
- package/lib/components/BryntumTimeZoomSlider.js +5 -0
- package/lib/components/BryntumTimeZoomSlider.js.map +1 -0
- package/lib/components/BryntumTimelineHistogram.js +1 -1
- package/lib/components/BryntumUndoRedo.js +1 -1
- package/lib/components/BryntumViewPresetCombo.js +1 -1
- package/lib/index.js +18 -16
- package/lib/index.js.map +1 -1
- package/package.json +1 -1
- package/src/components/BryntumEventColorField.vue +72 -116
- package/src/components/BryntumEventColorFieldProps.ts +68 -108
- package/src/components/BryntumProjectCombo.vue +90 -149
- package/src/components/BryntumProjectComboProps.ts +86 -141
- package/src/components/BryntumResourceCombo.vue +91 -151
- package/src/components/BryntumResourceComboProps.ts +87 -143
- package/src/components/BryntumResourceFilter.vue +63 -104
- package/src/components/BryntumResourceFilterProps.ts +60 -98
- package/src/components/BryntumScheduler.vue +429 -600
- package/src/components/BryntumSchedulerBase.vue +429 -600
- package/src/components/BryntumSchedulerBaseProps.ts +367 -522
- package/src/components/BryntumSchedulerDatePicker.vue +120 -196
- package/src/components/BryntumSchedulerDatePickerProps.ts +116 -187
- package/src/components/BryntumSchedulerProjectModel.vue +12 -31
- package/src/components/BryntumSchedulerProjectModelProps.ts +10 -20
- package/src/components/BryntumSchedulerProps.ts +367 -522
- package/src/components/BryntumThemeCombo.vue +60 -0
- package/src/components/BryntumTimeZoomSlider.vue +859 -0
- package/src/components/BryntumTimeZoomSliderProps.ts +482 -0
- package/src/components/BryntumTimelineHistogram.vue +325 -444
- package/src/components/BryntumTimelineHistogramProps.ts +275 -388
- package/src/components/BryntumUndoRedo.vue +78 -125
- package/src/components/BryntumUndoRedoProps.ts +74 -116
- package/src/components/BryntumViewPresetCombo.vue +67 -107
- package/src/components/BryntumViewPresetComboProps.ts +63 -99
- package/src/index.ts +2 -0
- package/lib/chunks/B0m0r-NV.js.map +0 -1
- package/lib/chunks/BD-Hg3lY.js.map +0 -1
- package/lib/chunks/BNGLBrCN.js.map +0 -1
- package/lib/chunks/C0UqC4Uj.js.map +0 -1
- package/lib/chunks/C2PT-Ukt.js.map +0 -1
- package/lib/chunks/C7ZFK2B7.js.map +0 -1
- package/lib/chunks/CP1Mm_Ak.js.map +0 -1
- package/lib/chunks/CsoS615B.js.map +0 -1
- package/lib/chunks/DerP_qo7.js.map +0 -1
- package/lib/chunks/DmQj0tBi.js.map +0 -1
- package/lib/chunks/mKqb8_2f.js.map +0 -1
|
@@ -1,27 +1,25 @@
|
|
|
1
|
-
import type { AjaxStore, AjaxStoreConfig, Color, DomConfig, DurationUnit, FormulaProviderConfig, Histogram, HistogramConfig, HistogramSeries, KeyMapConfig, Mask, MaskConfig, Model, ModelConfig, PagingToolbarConfig, PanelCollapserConfig, PanelCollapserOverlayConfig, PanelHeader, ScrollManager, ScrollManagerConfig, Scroller, ScrollerConfig, StateProvider, Store, StoreConfig, TabConfig, ToolConfig, ToolbarConfig, ToolbarItems, Tooltip, TooltipConfig, Widget } from '@bryntum/core-thin';
|
|
1
|
+
import type { AjaxStore, AjaxStoreConfig, Color, DomConfig, DurationUnit, FormulaProviderConfig, Histogram, HistogramConfig, HistogramSeries, InstancePlugin, KeyMapConfig, Mask, MaskConfig, Model, ModelConfig, PagingToolbarConfig, PanelCollapserConfig, PanelCollapserOverlayConfig, PanelHeader, ScrollManager, ScrollManagerConfig, Scroller, ScrollerConfig, StateProvider, Store, StoreConfig, TabConfig, ToolConfig, ToolbarConfig, ToolbarItems, Tooltip, TooltipConfig, Widget } from '@bryntum/core-thin';
|
|
2
2
|
import type { AI as GridAI, AIConfig as GridAIConfig, AIFilter, AIFilterConfig, CellCopyPaste, CellCopyPasteConfig, CellEdit, CellEditConfig, CellMenu, CellMenuConfig, CellTooltip, CellTooltipConfig, Charts, ChartsConfig, ColumnAutoWidth, ColumnAutoWidthConfig, ColumnDragToolbar, ColumnDragToolbarConfig, ColumnPicker, ColumnPickerConfig, ColumnRename, ColumnRenameConfig, ColumnReorder, ColumnReorderConfig, ColumnResize, ColumnResizeConfig, ColumnStore, ColumnStoreConfig, EmptyTextDomConfig, ExcelExporter as GridExcelExporter, ExcelExporterConfig as GridExcelExporterConfig, FileDrop, FileDropConfig, FillHandle, FillHandleConfig, Filter, FilterBar, FilterBarConfig, FilterConfig, GridSelectionMode, Group, GroupConfig, HeaderMenu, HeaderMenuConfig, LockRows as GridLockRows, LockRowsConfig as GridLockRowsConfig, MergeCells, MergeCellsConfig, PdfExport as GridPdfExport, PdfExportConfig as GridPdfExportConfig, PinColumns, PinColumnsConfig, PreserveScrollOptions, Print as GridPrint, PrintConfig as GridPrintConfig, QuickFind, QuickFindConfig, RegionResize, RegionResizeConfig, ResponsiveLevelConfig, RowCopyPaste, RowCopyPasteConfig, RowEdit, RowEditConfig, RowExpander, RowExpanderConfig, RowResize as GridRowResize, RowResizeConfig as GridRowResizeConfig, Search, SearchConfig, Sort, SortConfig, StickyCells, StickyCellsConfig, Stripe, StripeConfig, SubGridConfig, Tree, TreeConfig, TreeGroup, TreeGroupConfig } from '@bryntum/grid-thin';
|
|
3
|
-
import type { ColumnLines, ColumnLinesConfig, SchedulerContainerItemConfig, EventColor, SchedulerColumnConfig, GroupSummary, GroupSummaryConfig, HeaderZoom, HeaderZoomConfig, HistogramRenderData, NonWorkingTime, NonWorkingTimeConfig, Pan, PanConfig,
|
|
3
|
+
import type { ColumnLines, ColumnLinesConfig, SchedulerContainerItemConfig, EventColor, SchedulerColumnConfig, GroupSummary, GroupSummaryConfig, HeaderZoom, HeaderZoomConfig, HistogramRenderData, NonWorkingTime, NonWorkingTimeConfig, Pan, PanConfig, RecurrenceConfirmationPopupConfig, ResourceMenu, ResourceMenuConfig, ResourceModel, ResourceTimeRangeModel, ResourceTimeRanges, ResourceTimeRangesConfig, RowReorder, RowReorderConfig, ScaleColumnConfig, ScalePoint, ScheduleTooltip, ScheduleTooltipConfig, Split, SplitConfig, Summary, SummaryConfig, TimeAxis, TimeAxisConfig, TimeAxisHeaderMenu, TimeAxisHeaderMenuConfig, TimeRanges, TimeRangesConfig, TimelineBase, TimelineHistogramListeners, ViewPresetConfig, VisibleDate } from '@bryntum/scheduler-thin';
|
|
4
4
|
|
|
5
5
|
export declare type BryntumTimelineHistogramProps = {
|
|
6
6
|
// Configs
|
|
7
7
|
/**
|
|
8
8
|
* Element (or element id) to adopt as this Widget's encapsulating element. The widget's
|
|
9
9
|
* content will be placed inside this element.
|
|
10
|
-
* ...
|
|
11
|
-
* [View online docs...](https://bryntum.com/products/scheduler/docs/api/Scheduler/view/TimelineHistogram#config-adopt)
|
|
10
|
+
* [More...](https://bryntum.com/products/scheduler/docs/api/Scheduler/view/TimelineHistogram#config-adopt)
|
|
12
11
|
*/
|
|
13
12
|
adopt ? : HTMLElement|string
|
|
14
13
|
/**
|
|
15
14
|
* A function used for aggregating child records histogram data entries to their parent entry.
|
|
16
|
-
* ...
|
|
17
|
-
* [View online docs...](https://bryntum.com/products/scheduler/docs/api/Scheduler/view/TimelineHistogram#config-aggregateDataEntry)
|
|
15
|
+
* [More...](https://bryntum.com/products/scheduler/docs/api/Scheduler/view/TimelineHistogram#config-aggregateDataEntry)
|
|
18
16
|
* @param {object} aggregateDataEntry.aggregated Target parent data entry to aggregate the entry into.
|
|
19
17
|
* @param {object} aggregateDataEntry.entry Current entry to aggregate into `aggregated`.
|
|
20
18
|
* @param {number} aggregateDataEntry.arrayIndex Index of current array (index of the record among other records being aggregated).
|
|
21
19
|
* @param {object[]} aggregateDataEntry.entryIndex Index of `entry` in the current array.
|
|
22
20
|
* @returns {object} Return value becomes the value of the `aggregated` parameter on the next invocation of this function.
|
|
23
21
|
*/
|
|
24
|
-
aggregateDataEntry ? : ((
|
|
22
|
+
aggregateDataEntry ? : (() => object)|string
|
|
25
23
|
/**
|
|
26
24
|
* When `true` the component will automatically calculate data for group records
|
|
27
25
|
* based on the groups members data by calling [getGroupRecordHistogramData](https://bryntum.com/products/scheduler/docs/api/Scheduler/view/mixin/TimelineHistogramGrouping#function-getGroupRecordHistogramData) method.
|
|
@@ -59,15 +57,13 @@ export declare type BryntumTimelineHistogramProps = {
|
|
|
59
57
|
/**
|
|
60
58
|
* A localizable string (May contain `'L{}'` tokens which resolve in the locale file) to inject
|
|
61
59
|
* into an element which will be linked using the `aria-describedby` attribute.
|
|
62
|
-
* ...
|
|
63
|
-
* [View online docs...](https://bryntum.com/products/scheduler/docs/api/Scheduler/view/TimelineHistogram#config-ariaDescription)
|
|
60
|
+
* [More...](https://bryntum.com/products/scheduler/docs/api/Scheduler/view/TimelineHistogram#config-ariaDescription)
|
|
64
61
|
*/
|
|
65
62
|
ariaDescription ? : string
|
|
66
63
|
/**
|
|
67
64
|
* A localizable string (May contain `'L{}'` tokens which resolve in the locale file) to inject as
|
|
68
65
|
* the `aria-label` attribute.
|
|
69
|
-
* ...
|
|
70
|
-
* [View online docs...](https://bryntum.com/products/scheduler/docs/api/Scheduler/view/TimelineHistogram#config-ariaLabel)
|
|
66
|
+
* [More...](https://bryntum.com/products/scheduler/docs/api/Scheduler/view/TimelineHistogram#config-ariaLabel)
|
|
71
67
|
*/
|
|
72
68
|
ariaLabel ? : string
|
|
73
69
|
/**
|
|
@@ -83,8 +79,7 @@ export declare type BryntumTimelineHistogramProps = {
|
|
|
83
79
|
autoHeight ? : Boolean
|
|
84
80
|
/**
|
|
85
81
|
* Controls how much space to leave between stacked event bars in px.
|
|
86
|
-
* ...
|
|
87
|
-
* [View online docs...](https://bryntum.com/products/scheduler/docs/api/Scheduler/view/TimelineHistogram#config-barMargin)
|
|
82
|
+
* [More...](https://bryntum.com/products/scheduler/docs/api/Scheduler/view/TimelineHistogram#config-barMargin)
|
|
88
83
|
*/
|
|
89
84
|
barMargin ? : number
|
|
90
85
|
/**
|
|
@@ -103,14 +98,12 @@ export declare type BryntumTimelineHistogramProps = {
|
|
|
103
98
|
/**
|
|
104
99
|
* A Config object representing the configuration of a [Toolbar](https://bryntum.com/products/scheduler/docs/api/Core/widget/Toolbar),
|
|
105
100
|
* 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).
|
|
106
|
-
* ...
|
|
107
|
-
* [View online docs...](https://bryntum.com/products/scheduler/docs/api/Scheduler/view/TimelineHistogram#config-bbar)
|
|
101
|
+
* [More...](https://bryntum.com/products/scheduler/docs/api/Scheduler/view/TimelineHistogram#config-bbar)
|
|
108
102
|
*/
|
|
109
103
|
bbar ? : (SchedulerContainerItemConfig|string)[]|ToolbarConfig|PagingToolbarConfig|null
|
|
110
104
|
/**
|
|
111
105
|
* Custom CSS classes to add to the panel's body element.
|
|
112
|
-
* ...
|
|
113
|
-
* [View online docs...](https://bryntum.com/products/scheduler/docs/api/Scheduler/view/TimelineHistogram#config-bodyCls)
|
|
106
|
+
* [More...](https://bryntum.com/products/scheduler/docs/api/Scheduler/view/TimelineHistogram#config-bodyCls)
|
|
114
107
|
*/
|
|
115
108
|
bodyCls ? : string|object
|
|
116
109
|
/**
|
|
@@ -120,35 +113,30 @@ export declare type BryntumTimelineHistogramProps = {
|
|
|
120
113
|
/**
|
|
121
114
|
* An object where property names with a truthy value indicate which events should bubble up the ownership
|
|
122
115
|
* hierarchy when triggered.
|
|
123
|
-
* ...
|
|
124
|
-
* [View online docs...](https://bryntum.com/products/scheduler/docs/api/Scheduler/view/TimelineHistogram#config-bubbleEvents)
|
|
116
|
+
* [More...](https://bryntum.com/products/scheduler/docs/api/Scheduler/view/TimelineHistogram#config-bubbleEvents)
|
|
125
117
|
*/
|
|
126
118
|
bubbleEvents ? : object
|
|
127
119
|
/**
|
|
128
120
|
* This config defines the size of the start and end invisible parts of the timespan when [infiniteScroll](https://bryntum.com/products/scheduler/docs/api/Scheduler/view/mixin/TimelineScroll#config-infiniteScroll) set to `true`.
|
|
129
|
-
* ...
|
|
130
|
-
* [View online docs...](https://bryntum.com/products/scheduler/docs/api/Scheduler/view/TimelineHistogram#config-bufferCoef)
|
|
121
|
+
* [More...](https://bryntum.com/products/scheduler/docs/api/Scheduler/view/TimelineHistogram#config-bufferCoef)
|
|
131
122
|
*/
|
|
132
123
|
bufferCoef ? : number
|
|
133
124
|
/**
|
|
134
125
|
* This config defines the scroll limit, which, when exceeded will cause a timespan shift.
|
|
135
126
|
* The limit is calculated as the `panelWidth * [bufferCoef](https://bryntum.com/products/scheduler/docs/api/Scheduler/view/mixin/TimelineScroll#config-bufferCoef) * bufferThreshold`. During scrolling, if the left or right side
|
|
136
127
|
* has less than that of the rendered content - a shift is triggered.
|
|
137
|
-
* ...
|
|
138
|
-
* [View online docs...](https://bryntum.com/products/scheduler/docs/api/Scheduler/view/TimelineHistogram#config-bufferThreshold)
|
|
128
|
+
* [More...](https://bryntum.com/products/scheduler/docs/api/Scheduler/view/TimelineHistogram#config-bufferThreshold)
|
|
139
129
|
*/
|
|
140
130
|
bufferThreshold ? : number
|
|
141
131
|
/**
|
|
142
132
|
* Set to `false` to not call onXXX method names (e.g. `onShow`, `onClick`), as an easy way to listen for events.
|
|
143
|
-
* ...
|
|
144
|
-
* [View online docs...](https://bryntum.com/products/scheduler/docs/api/Scheduler/view/TimelineHistogram#config-callOnFunctions)
|
|
133
|
+
* [More...](https://bryntum.com/products/scheduler/docs/api/Scheduler/view/TimelineHistogram#config-callOnFunctions)
|
|
145
134
|
*/
|
|
146
135
|
callOnFunctions ? : Boolean
|
|
147
136
|
/**
|
|
148
137
|
* By default, if an event handler throws an exception, the error propagates up the stack and the
|
|
149
138
|
* application state is undefined. Code which follows the event handler will *not* be executed.
|
|
150
|
-
* ...
|
|
151
|
-
* [View online docs...](https://bryntum.com/products/scheduler/docs/api/Scheduler/view/TimelineHistogram#config-catchEventHandlerExceptions)
|
|
139
|
+
* [More...](https://bryntum.com/products/scheduler/docs/api/Scheduler/view/TimelineHistogram#config-catchEventHandlerExceptions)
|
|
152
140
|
*/
|
|
153
141
|
catchEventHandlerExceptions ? : Boolean
|
|
154
142
|
/**
|
|
@@ -161,8 +149,7 @@ export declare type BryntumTimelineHistogramProps = {
|
|
|
161
149
|
* Custom CSS classes to add to element.
|
|
162
150
|
* May be specified as a space separated string, or as an object in which property names
|
|
163
151
|
* with truthy values are used as the class names:
|
|
164
|
-
* ...
|
|
165
|
-
* [View online docs...](https://bryntum.com/products/scheduler/docs/api/Scheduler/view/TimelineHistogram#config-cls)
|
|
152
|
+
* [More...](https://bryntum.com/products/scheduler/docs/api/Scheduler/view/TimelineHistogram#config-cls)
|
|
166
153
|
*/
|
|
167
154
|
cls ? : string|object
|
|
168
155
|
/**
|
|
@@ -172,15 +159,13 @@ export declare type BryntumTimelineHistogramProps = {
|
|
|
172
159
|
collapsed ? : Boolean
|
|
173
160
|
/**
|
|
174
161
|
* This config enables collapsibility for the panel. See [collapsed](https://bryntum.com/products/scheduler/docs/api/Core/widget/Panel#config-collapsed).
|
|
175
|
-
* ...
|
|
176
|
-
* [View online docs...](https://bryntum.com/products/scheduler/docs/api/Scheduler/view/TimelineHistogram#config-collapsible)
|
|
162
|
+
* [More...](https://bryntum.com/products/scheduler/docs/api/Scheduler/view/TimelineHistogram#config-collapsible)
|
|
177
163
|
*/
|
|
178
164
|
collapsible ? : Boolean|PanelCollapserConfig|PanelCollapserOverlayConfig
|
|
179
165
|
/**
|
|
180
166
|
* Applies the specified color to the widget, by setting the `--b-primary` CSS variable in the widgets
|
|
181
167
|
* `style` block.
|
|
182
|
-
* ...
|
|
183
|
-
* [View online docs...](https://bryntum.com/products/scheduler/docs/api/Scheduler/view/TimelineHistogram#config-color)
|
|
168
|
+
* [More...](https://bryntum.com/products/scheduler/docs/api/Scheduler/view/TimelineHistogram#config-color)
|
|
184
169
|
*/
|
|
185
170
|
color ? : Color
|
|
186
171
|
/**
|
|
@@ -194,8 +179,7 @@ export declare type BryntumTimelineHistogramProps = {
|
|
|
194
179
|
/**
|
|
195
180
|
* Accepts column definitions for the grid during initialization. They will be used to create
|
|
196
181
|
* [Column](https://bryntum.com/products/scheduler/docs/api/Grid/column/Column) instances that are added to a [ColumnStore](#Grid/data/ColumnStore).
|
|
197
|
-
* ...
|
|
198
|
-
* [View online docs...](https://bryntum.com/products/scheduler/docs/api/Scheduler/view/TimelineHistogram#config-columns)
|
|
182
|
+
* [More...](https://bryntum.com/products/scheduler/docs/api/Scheduler/view/TimelineHistogram#config-columns)
|
|
199
183
|
*/
|
|
200
184
|
columns ? : ColumnStore|SchedulerColumnConfig[]|ColumnStoreConfig
|
|
201
185
|
config ? : object
|
|
@@ -203,8 +187,7 @@ export declare type BryntumTimelineHistogramProps = {
|
|
|
203
187
|
* Custom CSS classes to add to the [contentElement](https://bryntum.com/products/scheduler/docs/api/Core/widget/Widget#property-contentElement).
|
|
204
188
|
* May be specified as a space separated string, or as an object in which property names
|
|
205
189
|
* with truthy values are used as the class names:
|
|
206
|
-
* ...
|
|
207
|
-
* [View online docs...](https://bryntum.com/products/scheduler/docs/api/Scheduler/view/TimelineHistogram#config-contentElementCls)
|
|
190
|
+
* [More...](https://bryntum.com/products/scheduler/docs/api/Scheduler/view/TimelineHistogram#config-contentElementCls)
|
|
208
191
|
*/
|
|
209
192
|
contentElementCls ? : string|object
|
|
210
193
|
/**
|
|
@@ -216,8 +199,7 @@ export declare type BryntumTimelineHistogramProps = {
|
|
|
216
199
|
* Convenient shortcut to set data in grids store both during initialization and at runtime. Can also be
|
|
217
200
|
* used to retrieve data at runtime, although we do recommend interacting with Grids store instead using
|
|
218
201
|
* the [store](https://bryntum.com/products/scheduler/docs/api/Grid/view/GridBase#property-store) property.
|
|
219
|
-
* ...
|
|
220
|
-
* [View online docs...](https://bryntum.com/products/scheduler/docs/api/Scheduler/view/TimelineHistogram#config-data)
|
|
202
|
+
* [More...](https://bryntum.com/products/scheduler/docs/api/Scheduler/view/TimelineHistogram#config-data)
|
|
221
203
|
*/
|
|
222
204
|
data ? : object[]|Model[]|ModelConfig[]
|
|
223
205
|
/**
|
|
@@ -227,8 +209,7 @@ export declare type BryntumTimelineHistogramProps = {
|
|
|
227
209
|
dataField ? : string
|
|
228
210
|
/**
|
|
229
211
|
* Record field from which the histogram data will be collected.
|
|
230
|
-
* ...
|
|
231
|
-
* [View online docs...](https://bryntum.com/products/scheduler/docs/api/Scheduler/view/TimelineHistogram#config-dataModelField)
|
|
212
|
+
* [More...](https://bryntum.com/products/scheduler/docs/api/Scheduler/view/TimelineHistogram#config-dataModelField)
|
|
232
213
|
*/
|
|
233
214
|
dataModelField ? : string
|
|
234
215
|
/**
|
|
@@ -244,16 +225,15 @@ export declare type BryntumTimelineHistogramProps = {
|
|
|
244
225
|
*/
|
|
245
226
|
destroyStore ? : Boolean
|
|
246
227
|
/**
|
|
247
|
-
* Check for CSS compatibility issues
|
|
248
|
-
*
|
|
249
|
-
* [
|
|
228
|
+
* Check for CSS compatibility and inclusion related issues and try to auto fix them. Performs the following
|
|
229
|
+
* checks:
|
|
230
|
+
* [More...](https://bryntum.com/products/scheduler/docs/api/Scheduler/view/TimelineHistogram#config-detectCSSCompatibilityIssues)
|
|
250
231
|
*/
|
|
251
232
|
detectCSSCompatibilityIssues ? : Boolean
|
|
252
233
|
/**
|
|
253
234
|
* 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
|
|
254
235
|
* cannot be focused, uses a different rendition (usually greyish) and does not allow selecting its value.
|
|
255
|
-
* ...
|
|
256
|
-
* [View online docs...](https://bryntum.com/products/scheduler/docs/api/Scheduler/view/TimelineHistogram#config-disabled)
|
|
236
|
+
* [More...](https://bryntum.com/products/scheduler/docs/api/Scheduler/view/TimelineHistogram#config-disabled)
|
|
257
237
|
*/
|
|
258
238
|
disabled ? : Boolean|'inert'
|
|
259
239
|
/**
|
|
@@ -271,8 +251,7 @@ export declare type BryntumTimelineHistogramProps = {
|
|
|
271
251
|
/**
|
|
272
252
|
* Defines how dates will be formatted in tooltips etc. This config has priority over similar config on the
|
|
273
253
|
* view preset. For allowed values see [format](https://bryntum.com/products/scheduler/docs/api/Core/helper/DateHelper#function-format-static).
|
|
274
|
-
* ...
|
|
275
|
-
* [View online docs...](https://bryntum.com/products/scheduler/docs/api/Scheduler/view/TimelineHistogram#config-displayDateFormat)
|
|
254
|
+
* [More...](https://bryntum.com/products/scheduler/docs/api/Scheduler/view/TimelineHistogram#config-displayDateFormat)
|
|
276
255
|
*/
|
|
277
256
|
displayDateFormat ? : string
|
|
278
257
|
/**
|
|
@@ -280,24 +259,22 @@ export declare type BryntumTimelineHistogramProps = {
|
|
|
280
259
|
* [strips collection](https://bryntum.com/products/scheduler/docs/api/Core/widget/Panel#config-strips). Typical values for this config are `'top'`,
|
|
281
260
|
* `'bottom'`, `'left'`, or `'right'`, which cause the widget to be placed on that side of the panel's
|
|
282
261
|
* body. Such widgets are called "edge strips".
|
|
283
|
-
* ...
|
|
284
|
-
* [View online docs...](https://bryntum.com/products/scheduler/docs/api/Scheduler/view/TimelineHistogram#config-dock)
|
|
262
|
+
* [More...](https://bryntum.com/products/scheduler/docs/api/Scheduler/view/TimelineHistogram#config-dock)
|
|
285
263
|
*/
|
|
286
264
|
dock ? : 'top'|'bottom'|'left'|'right'|'start'|'end'|'header'|'pre-header'|object
|
|
287
265
|
/**
|
|
288
266
|
* Make this Panel a docked drawer which slides out from one side of the browser viewport by default.
|
|
289
|
-
* ...
|
|
290
|
-
* [
|
|
291
|
-
* @param {
|
|
292
|
-
* @param {
|
|
293
|
-
* @param {boolean}
|
|
294
|
-
* @param {boolean,
|
|
295
|
-
* @param {boolean,string} autoClose.
|
|
296
|
-
* @param {
|
|
297
|
-
* @param {
|
|
298
|
-
|
|
299
|
-
|
|
300
|
-
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}
|
|
267
|
+
* [More...](https://bryntum.com/products/scheduler/docs/api/Scheduler/view/TimelineHistogram#config-drawer)
|
|
268
|
+
* @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.
|
|
269
|
+
* @param {string,number} [size] The size of the drawer in its collapsible axis.
|
|
270
|
+
* @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.
|
|
271
|
+
* @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.
|
|
272
|
+
* @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.
|
|
273
|
+
* @param {boolean,string} [autoClose.focusout] If focus moves outside of the drawer, the drawer will automatically be hidden.
|
|
274
|
+
* @param {string} [autoClose.mouseout] Hides the drawer when the mouse leaves the drawer after the `autoCloseDelay` period.
|
|
275
|
+
* @param {number} [autoCloseDelay] When using `mouseout`, this is the delay in milliseconds
|
|
276
|
+
*/
|
|
277
|
+
drawer ? : Boolean|{ side?: 'start'|'left'|'end'|'right'|'top'|'bottom', size?: string|number, inline?: Boolean, autoClose?: Boolean|{ mousedown?: Boolean|string, focusout?: Boolean|string, mouseout?: string }, autoCloseDelay?: number }
|
|
301
278
|
/**
|
|
302
279
|
* Decimal precision used when displaying durations, used by tooltips and DurationColumn.
|
|
303
280
|
* Specify `false` to use raw value
|
|
@@ -306,16 +283,14 @@ export declare type BryntumTimelineHistogramProps = {
|
|
|
306
283
|
/**
|
|
307
284
|
* An object specifying attributes to assign to the root element of this widget.
|
|
308
285
|
* Set `null` value to attribute to remove it.
|
|
309
|
-
* ...
|
|
310
|
-
* [View online docs...](https://bryntum.com/products/scheduler/docs/api/Scheduler/view/TimelineHistogram#config-elementAttributes)
|
|
286
|
+
* [More...](https://bryntum.com/products/scheduler/docs/api/Scheduler/view/TimelineHistogram#config-elementAttributes)
|
|
311
287
|
*/
|
|
312
288
|
elementAttributes ? : Record<string, string|null>
|
|
313
289
|
/**
|
|
314
290
|
* 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.
|
|
315
291
|
* When using multiple Grid regions, provide the `region` property to decide where the text is shown.
|
|
316
292
|
* By default, it is shown in the first region.
|
|
317
|
-
* ...
|
|
318
|
-
* [View online docs...](https://bryntum.com/products/scheduler/docs/api/Scheduler/view/TimelineHistogram#config-emptyText)
|
|
293
|
+
* [More...](https://bryntum.com/products/scheduler/docs/api/Scheduler/view/TimelineHistogram#config-emptyText)
|
|
319
294
|
*/
|
|
320
295
|
emptyText ? : string|EmptyTextDomConfig
|
|
321
296
|
/**
|
|
@@ -327,16 +302,14 @@ export declare type BryntumTimelineHistogramProps = {
|
|
|
327
302
|
* Enables showing occurrences of recurring events across the scheduler's time axis. If you want to disable
|
|
328
303
|
* the recurrence popup, you can choose set the `defaultAction` to `future` to affect all future
|
|
329
304
|
* occurrences, or `single` to just affect the currently selected event.
|
|
330
|
-
* ...
|
|
331
|
-
*
|
|
305
|
+
* [More...](https://bryntum.com/products/scheduler/docs/api/Scheduler/view/TimelineHistogram#config-enableRecurringEvents)
|
|
306
|
+
* @property {'single','future'} defaultAction
|
|
332
307
|
*/
|
|
333
|
-
enableRecurringEvents ? : Boolean|
|
|
334
|
-
defaultAction?: 'single'|'future'
|
|
335
|
-
}
|
|
308
|
+
enableRecurringEvents ? : Boolean|object
|
|
336
309
|
/**
|
|
337
|
-
*
|
|
338
|
-
*
|
|
339
|
-
*
|
|
310
|
+
* Set to `true` to enable the [StickyCells](https://bryntum.com/products/scheduler/docs/api/Grid/feature/StickyCells) feature, which pins cell
|
|
311
|
+
* content to the top of the grid while rows scroll off the top but remain visible.
|
|
312
|
+
* @deprecated 7.3.0 Use `features : { stickyCells : true }` instead
|
|
340
313
|
*/
|
|
341
314
|
enableSticky ? : Boolean
|
|
342
315
|
/**
|
|
@@ -351,23 +324,20 @@ export declare type BryntumTimelineHistogramProps = {
|
|
|
351
324
|
enableUndoRedoKeys ? : Boolean
|
|
352
325
|
/**
|
|
353
326
|
* The end date of the timeline (if not configure with [infiniteScroll](https://bryntum.com/products/scheduler/docs/api/Scheduler/view/TimelineBase#config-infiniteScroll)).
|
|
354
|
-
* ...
|
|
355
|
-
* [View online docs...](https://bryntum.com/products/scheduler/docs/api/Scheduler/view/TimelineHistogram#config-endDate)
|
|
327
|
+
* [More...](https://bryntum.com/products/scheduler/docs/api/Scheduler/view/TimelineHistogram#config-endDate)
|
|
356
328
|
*/
|
|
357
329
|
endDate ? : Date|string
|
|
358
330
|
/**
|
|
359
331
|
* Event color used by default. Events and resources can specify their own color, with priority order being:
|
|
360
332
|
* Event -> Resource -> Scheduler default.
|
|
361
|
-
* ...
|
|
362
|
-
* [View online docs...](https://bryntum.com/products/scheduler/docs/api/Scheduler/view/TimelineHistogram#config-eventColor)
|
|
333
|
+
* [More...](https://bryntum.com/products/scheduler/docs/api/Scheduler/view/TimelineHistogram#config-eventColor)
|
|
363
334
|
*/
|
|
364
335
|
eventColor ? : EventColor
|
|
365
336
|
/**
|
|
366
337
|
* Event style used by default. Events and resources can specify their own style, with priority order being:
|
|
367
338
|
* Event -> Resource -> Scheduler default. Determines the appearance of the event by assigning a CSS class
|
|
368
339
|
* to it. Available styles are:
|
|
369
|
-
* ...
|
|
370
|
-
* [View online docs...](https://bryntum.com/products/scheduler/docs/api/Scheduler/view/TimelineHistogram#config-eventStyle)
|
|
340
|
+
* [More...](https://bryntum.com/products/scheduler/docs/api/Scheduler/view/TimelineHistogram#config-eventStyle)
|
|
371
341
|
*/
|
|
372
342
|
eventStyle ? : 'tonal'|'filled'|'bordered'|'traced'|'outlined'|'indented'|'line'|'dashed'|'minimal'|'rounded'|'calendar'|'interday'|'gantt'|null
|
|
373
343
|
extraData ? : any
|
|
@@ -380,16 +350,14 @@ export declare type BryntumTimelineHistogramProps = {
|
|
|
380
350
|
/**
|
|
381
351
|
* Specify `true` to force rendered events/tasks to fill entire ticks. This only affects rendering, start
|
|
382
352
|
* and end dates retain their value on the data level.
|
|
383
|
-
* ...
|
|
384
|
-
* [View online docs...](https://bryntum.com/products/scheduler/docs/api/Scheduler/view/TimelineHistogram#config-fillTicks)
|
|
353
|
+
* [More...](https://bryntum.com/products/scheduler/docs/api/Scheduler/view/TimelineHistogram#config-fillTicks)
|
|
385
354
|
*/
|
|
386
355
|
fillTicks ? : Boolean
|
|
387
356
|
/**
|
|
388
357
|
* Use fixed row height. Setting this to `true` will configure the underlying RowManager to use fixed row
|
|
389
358
|
* height, which sacrifices the ability to use rows with variable height to gain a fraction better
|
|
390
359
|
* performance.
|
|
391
|
-
* ...
|
|
392
|
-
* [View online docs...](https://bryntum.com/products/scheduler/docs/api/Scheduler/view/TimelineHistogram#config-fixedRowHeight)
|
|
360
|
+
* [More...](https://bryntum.com/products/scheduler/docs/api/Scheduler/view/TimelineHistogram#config-fixedRowHeight)
|
|
393
361
|
*/
|
|
394
362
|
fixedRowHeight ? : Boolean
|
|
395
363
|
/**
|
|
@@ -403,14 +371,12 @@ export declare type BryntumTimelineHistogramProps = {
|
|
|
403
371
|
/**
|
|
404
372
|
* Config object of a footer. May contain a `dock`, `html` and a `cls` property. A footer is not a widget,
|
|
405
373
|
* 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).
|
|
406
|
-
* ...
|
|
407
|
-
*
|
|
374
|
+
* [More...](https://bryntum.com/products/scheduler/docs/api/Scheduler/view/TimelineHistogram#config-footer)
|
|
375
|
+
* @property {'top','right','bottom','left','start','end'} dock Where to dock
|
|
376
|
+
* @property {string} html Html to populate the footer with
|
|
377
|
+
* @property {string} cls CSS class to add to the footer
|
|
408
378
|
*/
|
|
409
|
-
footer ? :
|
|
410
|
-
dock?: 'top'|'right'|'bottom'|'left'|'start'|'end'
|
|
411
|
-
html?: string
|
|
412
|
-
cls?: string
|
|
413
|
-
}|string
|
|
379
|
+
footer ? : object|string
|
|
414
380
|
/**
|
|
415
381
|
* Set to `true` to force the time columns to fit to the available space (horizontal or vertical depends on mode).
|
|
416
382
|
* Note that setting [suppressFit](https://bryntum.com/products/scheduler/docs/api/Scheduler/view/TimelineBase#config-suppressFit) to `true`, will disable `forceFit` functionality. Zooming
|
|
@@ -420,14 +386,12 @@ export declare type BryntumTimelineHistogramProps = {
|
|
|
420
386
|
/**
|
|
421
387
|
* An object which names formula prefixes which will be applied to all columns configured with
|
|
422
388
|
* `formula : true`.
|
|
423
|
-
* ...
|
|
424
|
-
* [View online docs...](https://bryntum.com/products/scheduler/docs/api/Scheduler/view/TimelineHistogram#config-formulaProviders)
|
|
389
|
+
* [More...](https://bryntum.com/products/scheduler/docs/api/Scheduler/view/TimelineHistogram#config-formulaProviders)
|
|
425
390
|
*/
|
|
426
391
|
formulaProviders ? : Record<string, FormulaProviderConfig>
|
|
427
392
|
/**
|
|
428
393
|
* Refresh entire row when a record changes (`true`) or, if possible, only the cells affected (`false`).
|
|
429
|
-
* ...
|
|
430
|
-
* [View online docs...](https://bryntum.com/products/scheduler/docs/api/Scheduler/view/TimelineHistogram#config-fullRowRefresh)
|
|
394
|
+
* [More...](https://bryntum.com/products/scheduler/docs/api/Scheduler/view/TimelineHistogram#config-fullRowRefresh)
|
|
431
395
|
*/
|
|
432
396
|
fullRowRefresh ? : Boolean
|
|
433
397
|
/**
|
|
@@ -446,8 +410,7 @@ export declare type BryntumTimelineHistogramProps = {
|
|
|
446
410
|
* (a `RECT` element representing a single "bar"-type value).
|
|
447
411
|
* The function is passed a default prepared DOM configuration
|
|
448
412
|
* in an argument which then can be processed and returned.
|
|
449
|
-
* ...
|
|
450
|
-
* [View online docs...](https://bryntum.com/products/scheduler/docs/api/Scheduler/view/TimelineHistogram#config-getBarDOMConfig)
|
|
413
|
+
* [More...](https://bryntum.com/products/scheduler/docs/api/Scheduler/view/TimelineHistogram#config-getBarDOMConfig)
|
|
451
414
|
* @param {HistogramSeries} series The series being rendered
|
|
452
415
|
* @param {DomConfig} domConfig The rectangle DOM configuration object
|
|
453
416
|
* @param {object} datum The datum being rendered
|
|
@@ -458,8 +421,7 @@ export declare type BryntumTimelineHistogramProps = {
|
|
|
458
421
|
getBarDOMConfig ? : (series: HistogramSeries, domConfig: DomConfig, datum: object, index: number, renderData: HistogramRenderData) => object
|
|
459
422
|
/**
|
|
460
423
|
* A Function which returns the text to render inside a bar.
|
|
461
|
-
* ...
|
|
462
|
-
* [View online docs...](https://bryntum.com/products/scheduler/docs/api/Scheduler/view/TimelineHistogram#config-getBarText)
|
|
424
|
+
* [More...](https://bryntum.com/products/scheduler/docs/api/Scheduler/view/TimelineHistogram#config-getBarText)
|
|
463
425
|
* @param {object} datum The datum being rendered
|
|
464
426
|
* @param {number} index The index of the datum being rendered
|
|
465
427
|
* @param {HistogramSeries} series The series (provided if histogram widget [singleTextForAllBars](https://bryntum.com/products/scheduler/docs/api/Core/widget/graph/Histogram#config-singleTextForAllBars) is `false`)
|
|
@@ -469,8 +431,7 @@ export declare type BryntumTimelineHistogramProps = {
|
|
|
469
431
|
getBarText ? : (datum: object, index: number, series: HistogramSeries, renderData: HistogramRenderData) => string
|
|
470
432
|
/**
|
|
471
433
|
* A Function which returns a DOM configuration object for text elements.
|
|
472
|
-
* ...
|
|
473
|
-
* [View online docs...](https://bryntum.com/products/scheduler/docs/api/Scheduler/view/TimelineHistogram#config-getBarTextDOMConfig)
|
|
434
|
+
* [More...](https://bryntum.com/products/scheduler/docs/api/Scheduler/view/TimelineHistogram#config-getBarTextDOMConfig)
|
|
474
435
|
* @param {DomConfig} domConfig The `TEXT` element DOM configuration object
|
|
475
436
|
* @param {object} datum The datum being rendered
|
|
476
437
|
* @param {number} index The index of the datum being rendered
|
|
@@ -483,12 +444,11 @@ export declare type BryntumTimelineHistogramProps = {
|
|
|
483
444
|
* Function that extracts a record histogram data entry for aggregating.
|
|
484
445
|
* By default it returns the entry as is. Override the function if you need a more complex way
|
|
485
446
|
* to retrieve the value for aggregating.
|
|
486
|
-
* ...
|
|
487
|
-
* [View online docs...](https://bryntum.com/products/scheduler/docs/api/Scheduler/view/TimelineHistogram#config-getDataEntryForAggregating)
|
|
447
|
+
* [More...](https://bryntum.com/products/scheduler/docs/api/Scheduler/view/TimelineHistogram#config-getDataEntryForAggregating)
|
|
488
448
|
* @param {object} getDataEntryForAggregating.entry Current data entry.
|
|
489
449
|
* @returns {object} Entry to aggregate
|
|
490
450
|
*/
|
|
491
|
-
getDataEntryForAggregating ? : ((
|
|
451
|
+
getDataEntryForAggregating ? : (() => object)|string
|
|
492
452
|
/**
|
|
493
453
|
* A Function which returns a CSS class name to add to a path element
|
|
494
454
|
* built for an `outline` type series.
|
|
@@ -504,8 +464,7 @@ export declare type BryntumTimelineHistogramProps = {
|
|
|
504
464
|
* a `path` element built for an `outline` type series.
|
|
505
465
|
* The function accepts a default prepared DOM configuration
|
|
506
466
|
* in an argument which then can be processed and returned.
|
|
507
|
-
* ...
|
|
508
|
-
* [View online docs...](https://bryntum.com/products/scheduler/docs/api/Scheduler/view/TimelineHistogram#config-getOutlineDOMConfig)
|
|
467
|
+
* [More...](https://bryntum.com/products/scheduler/docs/api/Scheduler/view/TimelineHistogram#config-getOutlineDOMConfig)
|
|
509
468
|
* @param {HistogramSeries} series The series being rendered
|
|
510
469
|
* @param {DomConfig} domConfig The `path` element DOM configuration object
|
|
511
470
|
* @param {object[]} data The series data
|
|
@@ -514,23 +473,21 @@ export declare type BryntumTimelineHistogramProps = {
|
|
|
514
473
|
getOutlineDOMConfig ? : (series: HistogramSeries, domConfig: DomConfig, data: object[]) => object
|
|
515
474
|
/**
|
|
516
475
|
* A function, or name of a function which builds histogram data for the provided record.
|
|
517
|
-
* ...
|
|
518
|
-
* [View online docs...](https://bryntum.com/products/scheduler/docs/api/Scheduler/view/TimelineHistogram#config-getRecordData)
|
|
476
|
+
* [More...](https://bryntum.com/products/scheduler/docs/api/Scheduler/view/TimelineHistogram#config-getRecordData)
|
|
519
477
|
* @param {Core.data.Model} getRecordData.record Record to get histogram data for.
|
|
520
|
-
* @param {object} aggregationContext Context object passed in case the data is being retrieved as a part of some parent record data collecting.
|
|
478
|
+
* @param {object} [aggregationContext] Context object passed in case the data is being retrieved as a part of some parent record data collecting.
|
|
521
479
|
* @returns {object} Histogram data.
|
|
522
480
|
*/
|
|
523
|
-
getRecordData ? : ((
|
|
481
|
+
getRecordData ? : ((aggregationContext: object) => object)|string
|
|
524
482
|
/**
|
|
525
483
|
* 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
|
|
526
484
|
* expected to return the desired height of that records row. If the function returns a falsy value, Grids
|
|
527
485
|
* configured [rowHeight](https://bryntum.com/products/scheduler/docs/api/Grid/view/GridBase#config-rowHeight) is used.
|
|
528
|
-
* ...
|
|
529
|
-
* [View online docs...](https://bryntum.com/products/scheduler/docs/api/Scheduler/view/TimelineHistogram#config-getRowHeight)
|
|
486
|
+
* [More...](https://bryntum.com/products/scheduler/docs/api/Scheduler/view/TimelineHistogram#config-getRowHeight)
|
|
530
487
|
* @param {Core.data.Model} getRowHeight.record Record to determine row height for
|
|
531
488
|
* @returns {number} Desired row height
|
|
532
489
|
*/
|
|
533
|
-
getRowHeight ? : (
|
|
490
|
+
getRowHeight ? : () => number
|
|
534
491
|
/**
|
|
535
492
|
* When set to `true` (default) the component reacts on time axis changes
|
|
536
493
|
* (zooming or changing the displayed time span), clears the histogram data cache of the records
|
|
@@ -539,8 +496,7 @@ export declare type BryntumTimelineHistogramProps = {
|
|
|
539
496
|
hardRefreshOnTimeAxisReconfigure ? : Boolean
|
|
540
497
|
/**
|
|
541
498
|
* 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`.
|
|
542
|
-
* ...
|
|
543
|
-
* [View online docs...](https://bryntum.com/products/scheduler/docs/api/Scheduler/view/TimelineHistogram#config-header)
|
|
499
|
+
* [More...](https://bryntum.com/products/scheduler/docs/api/Scheduler/view/TimelineHistogram#config-header)
|
|
544
500
|
*/
|
|
545
501
|
header ? : string|Boolean|PanelHeader
|
|
546
502
|
/**
|
|
@@ -567,8 +523,7 @@ export declare type BryntumTimelineHistogramProps = {
|
|
|
567
523
|
hideHorizontalScrollbar ? : Boolean
|
|
568
524
|
/**
|
|
569
525
|
* By default the row hover effect is not visible in the Scheduler part of the grid.
|
|
570
|
-
* ...
|
|
571
|
-
* [View online docs...](https://bryntum.com/products/scheduler/docs/api/Scheduler/view/TimelineHistogram#config-hideRowHover)
|
|
526
|
+
* [More...](https://bryntum.com/products/scheduler/docs/api/Scheduler/view/TimelineHistogram#config-hideRowHover)
|
|
572
527
|
*/
|
|
573
528
|
hideRowHover ? : Boolean
|
|
574
529
|
/**
|
|
@@ -602,21 +557,18 @@ export declare type BryntumTimelineHistogramProps = {
|
|
|
602
557
|
ignoreDomEventsWhileScrolling ? : Boolean
|
|
603
558
|
/**
|
|
604
559
|
* Determines if the widgets read-only state should be controlled by its parent.
|
|
605
|
-
* ...
|
|
606
|
-
* [View online docs...](https://bryntum.com/products/scheduler/docs/api/Scheduler/view/TimelineHistogram#config-ignoreParentReadOnly)
|
|
560
|
+
* [More...](https://bryntum.com/products/scheduler/docs/api/Scheduler/view/TimelineHistogram#config-ignoreParentReadOnly)
|
|
607
561
|
*/
|
|
608
562
|
ignoreParentReadOnly ? : Boolean
|
|
609
563
|
/**
|
|
610
564
|
* Set to `true` to automatically adjust the panel timespan during scrolling in the time dimension,
|
|
611
565
|
* when the scroller comes close to the start/end edges.
|
|
612
|
-
* ...
|
|
613
|
-
* [View online docs...](https://bryntum.com/products/scheduler/docs/api/Scheduler/view/TimelineHistogram#config-infiniteScroll)
|
|
566
|
+
* [More...](https://bryntum.com/products/scheduler/docs/api/Scheduler/view/TimelineHistogram#config-infiniteScroll)
|
|
614
567
|
*/
|
|
615
568
|
infiniteScroll ? : Boolean
|
|
616
569
|
/**
|
|
617
570
|
* A function that initializes a target group record entry.
|
|
618
|
-
* ...
|
|
619
|
-
* [View online docs...](https://bryntum.com/products/scheduler/docs/api/Scheduler/view/TimelineHistogram#config-initAggregatedDataEntry)
|
|
571
|
+
* [More...](https://bryntum.com/products/scheduler/docs/api/Scheduler/view/TimelineHistogram#config-initAggregatedDataEntry)
|
|
620
572
|
* @returns {object} Target aggregated entry
|
|
621
573
|
*/
|
|
622
574
|
initAggregatedDataEntry ? : (() => object)|string
|
|
@@ -624,8 +576,7 @@ export declare type BryntumTimelineHistogramProps = {
|
|
|
624
576
|
* Convenience setting to align input fields of child widgets. By default, the Field input element is
|
|
625
577
|
* placed immediately following the `label`. If you prefer to have all input fields aligned to the
|
|
626
578
|
* right, set this config to `'end'`.
|
|
627
|
-
* ...
|
|
628
|
-
* [View online docs...](https://bryntum.com/products/scheduler/docs/api/Scheduler/view/TimelineHistogram#config-inputFieldAlign)
|
|
579
|
+
* [More...](https://bryntum.com/products/scheduler/docs/api/Scheduler/view/TimelineHistogram#config-inputFieldAlign)
|
|
629
580
|
*/
|
|
630
581
|
inputFieldAlign ? : 'start'|'end'
|
|
631
582
|
/**
|
|
@@ -642,14 +593,17 @@ export declare type BryntumTimelineHistogramProps = {
|
|
|
642
593
|
keyMap ? : Record<string, KeyMapConfig>
|
|
643
594
|
/**
|
|
644
595
|
* Convenience setting to use same label placement on all child widgets.
|
|
645
|
-
* ...
|
|
646
|
-
* [View online docs...](https://bryntum.com/products/scheduler/docs/api/Scheduler/view/TimelineHistogram#config-labelPosition)
|
|
596
|
+
* [More...](https://bryntum.com/products/scheduler/docs/api/Scheduler/view/TimelineHistogram#config-labelPosition)
|
|
647
597
|
*/
|
|
648
598
|
labelPosition ? : 'before'|'above'|'align-before'|'auto'|null
|
|
599
|
+
/**
|
|
600
|
+
* Sets `labelWidth´ for all children of this Container, that does not define their own `labelWidth`.
|
|
601
|
+
* [More...](https://bryntum.com/products/scheduler/docs/api/Scheduler/view/TimelineHistogram#config-labelWidth)
|
|
602
|
+
*/
|
|
603
|
+
labelWidth ? : number|null
|
|
649
604
|
/**
|
|
650
605
|
* The listener set for this object.
|
|
651
|
-
* ...
|
|
652
|
-
* [View online docs...](https://bryntum.com/products/scheduler/docs/api/Scheduler/view/TimelineHistogram#config-listeners)
|
|
606
|
+
* [More...](https://bryntum.com/products/scheduler/docs/api/Scheduler/view/TimelineHistogram#config-listeners)
|
|
653
607
|
*/
|
|
654
608
|
listeners ? : TimelineHistogramListeners
|
|
655
609
|
/**
|
|
@@ -662,15 +616,13 @@ export declare type BryntumTimelineHistogramProps = {
|
|
|
662
616
|
* when data is loading. The message and optional configuration from the
|
|
663
617
|
* [loadMask](https://bryntum.com/products/scheduler/docs/api/Core/mixin/LoadMaskable#config-loadMask) config take priority over these options, just as they do
|
|
664
618
|
* for `maskDefaults`, respectively.
|
|
665
|
-
* ...
|
|
666
|
-
* [View online docs...](https://bryntum.com/products/scheduler/docs/api/Scheduler/view/TimelineHistogram#config-loadMaskDefaults)
|
|
619
|
+
* [More...](https://bryntum.com/products/scheduler/docs/api/Scheduler/view/TimelineHistogram#config-loadMaskDefaults)
|
|
667
620
|
*/
|
|
668
621
|
loadMaskDefaults ? : MaskConfig
|
|
669
622
|
/**
|
|
670
623
|
* A [Mask](https://bryntum.com/products/scheduler/docs/api/Core/widget/Mask) config object to adjust the [maskDefaults](#Core/widget/Widget#config-maskDefaults)
|
|
671
624
|
* when an error occurs loading data.
|
|
672
|
-
* ...
|
|
673
|
-
* [View online docs...](https://bryntum.com/products/scheduler/docs/api/Scheduler/view/TimelineHistogram#config-loadMaskError)
|
|
625
|
+
* [More...](https://bryntum.com/products/scheduler/docs/api/Scheduler/view/TimelineHistogram#config-loadMaskError)
|
|
674
626
|
*/
|
|
675
627
|
loadMaskError ? : MaskConfig|Mask|Boolean
|
|
676
628
|
/**
|
|
@@ -684,8 +636,7 @@ export declare type BryntumTimelineHistogramProps = {
|
|
|
684
636
|
/**
|
|
685
637
|
* When `true`, events are sized and positioned based on rowHeight, resourceMargin and barMargin settings.
|
|
686
638
|
* Set this to `false` if you want to control height and vertical position using CSS instead.
|
|
687
|
-
* ...
|
|
688
|
-
* [View online docs...](https://bryntum.com/products/scheduler/docs/api/Scheduler/view/TimelineHistogram#config-managedEventSizing)
|
|
639
|
+
* [More...](https://bryntum.com/products/scheduler/docs/api/Scheduler/view/TimelineHistogram#config-managedEventSizing)
|
|
689
640
|
*/
|
|
690
641
|
managedEventSizing ? : Boolean
|
|
691
642
|
/**
|
|
@@ -716,8 +667,7 @@ export declare type BryntumTimelineHistogramProps = {
|
|
|
716
667
|
/**
|
|
717
668
|
* The maximum time axis unit to display non-working ranges for ('hour' or 'day' etc).
|
|
718
669
|
* When zooming to a view with a larger unit, no non-working time elements will be rendered.
|
|
719
|
-
* ...
|
|
720
|
-
* [View online docs...](https://bryntum.com/products/scheduler/docs/api/Scheduler/view/TimelineHistogram#config-maxTimeAxisUnit)
|
|
670
|
+
* [More...](https://bryntum.com/products/scheduler/docs/api/Scheduler/view/TimelineHistogram#config-maxTimeAxisUnit)
|
|
721
671
|
*/
|
|
722
672
|
maxTimeAxisUnit ? : DurationUnit
|
|
723
673
|
/**
|
|
@@ -726,12 +676,10 @@ export declare type BryntumTimelineHistogramProps = {
|
|
|
726
676
|
*/
|
|
727
677
|
maxWidth ? : string|number
|
|
728
678
|
/**
|
|
729
|
-
* The maximum zoom level to which [zoomIn](https://bryntum.com/products/scheduler/docs/api/Scheduler/view/mixin/TimelineZoomable#function-zoomIn) will work.
|
|
730
|
-
* [
|
|
731
|
-
* for information. Unless you have modified the collection of available presets, the max zoom level is
|
|
732
|
-
* milliseconds.
|
|
679
|
+
* The maximum zoom level to which [zoomIn](https://bryntum.com/products/scheduler/docs/api/Scheduler/view/mixin/TimelineZoomable#function-zoomIn) will work.
|
|
680
|
+
* [More...](https://bryntum.com/products/scheduler/docs/api/Scheduler/view/TimelineHistogram#config-maxZoomLevel)
|
|
733
681
|
*/
|
|
734
|
-
maxZoomLevel ? : number
|
|
682
|
+
maxZoomLevel ? : number|string
|
|
735
683
|
/**
|
|
736
684
|
* Get/set start date limit of the timeline.
|
|
737
685
|
* Actions such as timeline scrolling, all types of timeline zooms and shifts
|
|
@@ -741,8 +689,7 @@ export declare type BryntumTimelineHistogramProps = {
|
|
|
741
689
|
/**
|
|
742
690
|
* Grid's `min-height`. Defaults to `10em` to be sure that the Grid always has a height wherever it is
|
|
743
691
|
* inserted.
|
|
744
|
-
* ...
|
|
745
|
-
* [View online docs...](https://bryntum.com/products/scheduler/docs/api/Scheduler/view/TimelineHistogram#config-minHeight)
|
|
692
|
+
* [More...](https://bryntum.com/products/scheduler/docs/api/Scheduler/view/TimelineHistogram#config-minHeight)
|
|
746
693
|
*/
|
|
747
694
|
minHeight ? : string|number
|
|
748
695
|
/**
|
|
@@ -751,9 +698,10 @@ export declare type BryntumTimelineHistogramProps = {
|
|
|
751
698
|
*/
|
|
752
699
|
minWidth ? : string|number
|
|
753
700
|
/**
|
|
754
|
-
* The minimum zoom level to which [zoomOut](https://bryntum.com/products/scheduler/docs/api/Scheduler/view/mixin/TimelineZoomable#function-zoomOut) will work.
|
|
701
|
+
* The minimum zoom level to which [zoomOut](https://bryntum.com/products/scheduler/docs/api/Scheduler/view/mixin/TimelineZoomable#function-zoomOut) will work.
|
|
702
|
+
* [More...](https://bryntum.com/products/scheduler/docs/api/Scheduler/view/TimelineHistogram#config-minZoomLevel)
|
|
755
703
|
*/
|
|
756
|
-
minZoomLevel ? : number
|
|
704
|
+
minZoomLevel ? : number|string
|
|
757
705
|
/**
|
|
758
706
|
* Grid monitors window resize by default.
|
|
759
707
|
*/
|
|
@@ -761,14 +709,13 @@ export declare type BryntumTimelineHistogramProps = {
|
|
|
761
709
|
/**
|
|
762
710
|
* Partners this Timeline panel with another Timeline in order to sync their region sizes (sub-grids like locked, normal will get the same width),
|
|
763
711
|
* start and end dates, view preset, zoom level and scrolling position. All these values will be synced with the timeline defined as the `partner`.
|
|
764
|
-
* ...
|
|
765
|
-
* [View online docs...](https://bryntum.com/products/scheduler/docs/api/Scheduler/view/TimelineHistogram#config-partner)
|
|
712
|
+
* [More...](https://bryntum.com/products/scheduler/docs/api/Scheduler/view/TimelineHistogram#config-partner)
|
|
766
713
|
*/
|
|
767
714
|
partner ? : TimelineBase|string
|
|
768
715
|
/**
|
|
769
716
|
* Specify plugins (an array of classes) in config
|
|
770
717
|
*/
|
|
771
|
-
plugins ? :
|
|
718
|
+
plugins ? : InstancePlugin[]|InstancePlugin
|
|
772
719
|
/**
|
|
773
720
|
* True to preserve focused cell after loading new data
|
|
774
721
|
*/
|
|
@@ -784,10 +731,9 @@ export declare type BryntumTimelineHistogramProps = {
|
|
|
784
731
|
*/
|
|
785
732
|
preserveScrollOnDatasetChange ? : Boolean
|
|
786
733
|
/**
|
|
787
|
-
* An array of [ViewPreset](https://bryntum.com/products/scheduler/docs/api/Scheduler/preset/ViewPreset) config objects
|
|
788
|
-
*
|
|
789
|
-
* ...
|
|
790
|
-
* [View online docs...](https://bryntum.com/products/scheduler/docs/api/Scheduler/view/TimelineHistogram#config-presets)
|
|
734
|
+
* An array of [ViewPreset](https://bryntum.com/products/scheduler/docs/api/Scheduler/preset/ViewPreset) config objects which describes the available timeline layouts
|
|
735
|
+
* for this scheduler.
|
|
736
|
+
* [More...](https://bryntum.com/products/scheduler/docs/api/Scheduler/view/TimelineHistogram#config-presets)
|
|
791
737
|
*/
|
|
792
738
|
presets ? : ViewPresetConfig[]
|
|
793
739
|
/**
|
|
@@ -797,37 +743,40 @@ export declare type BryntumTimelineHistogramProps = {
|
|
|
797
743
|
preventTooltipOnTouch ? : Boolean
|
|
798
744
|
/**
|
|
799
745
|
* Set to `true` to make the grid read-only, by disabling any UIs for modifying data.
|
|
800
|
-
* ...
|
|
801
|
-
* [View online docs...](https://bryntum.com/products/scheduler/docs/api/Scheduler/view/TimelineHistogram#config-readOnly)
|
|
746
|
+
* [More...](https://bryntum.com/products/scheduler/docs/api/Scheduler/view/TimelineHistogram#config-readOnly)
|
|
802
747
|
*/
|
|
803
748
|
readOnly ? : Boolean
|
|
804
749
|
/**
|
|
805
750
|
* The confirmation dialog shown when a recurring event is edited.
|
|
806
|
-
* ...
|
|
807
|
-
* [View online docs...](https://bryntum.com/products/scheduler/docs/api/Scheduler/view/TimelineHistogram#config-recurrenceConfirmationPopup)
|
|
751
|
+
* [More...](https://bryntum.com/products/scheduler/docs/api/Scheduler/view/TimelineHistogram#config-recurrenceConfirmationPopup)
|
|
808
752
|
*/
|
|
809
|
-
recurrenceConfirmationPopup ? : RecurrenceConfirmationPopupConfig
|
|
753
|
+
recurrenceConfirmationPopup ? : RecurrenceConfirmationPopupConfig
|
|
810
754
|
relayStoreEvents ? : Boolean
|
|
811
755
|
/**
|
|
812
756
|
* Either a default `rendition` to apply to all child widgets, or a map of renditions keyed by child widget
|
|
813
757
|
* `type`.
|
|
814
|
-
* ...
|
|
815
|
-
* [View online docs...](https://bryntum.com/products/scheduler/docs/api/Scheduler/view/TimelineHistogram#config-rendition)
|
|
758
|
+
* [More...](https://bryntum.com/products/scheduler/docs/api/Scheduler/view/TimelineHistogram#config-rendition)
|
|
816
759
|
*/
|
|
817
760
|
rendition ? : string|Record<string, string>|null
|
|
818
761
|
/**
|
|
819
762
|
* Configure this property to allow the widget/component to be resized. Pressing <kbd>Shift</kbd> while resizing will
|
|
820
763
|
* constrain the aspect ratio.
|
|
821
|
-
* ...
|
|
822
|
-
* [
|
|
823
|
-
|
|
824
|
-
|
|
825
|
-
|
|
826
|
-
|
|
827
|
-
|
|
828
|
-
|
|
829
|
-
|
|
830
|
-
|
|
764
|
+
* [More...](https://bryntum.com/products/scheduler/docs/api/Scheduler/view/TimelineHistogram#config-resizable)
|
|
765
|
+
* @property {number} [resizable.minWidth] The minimum width of the element.
|
|
766
|
+
* @property {number} [resizable.maxWidth] The maximum width of the element.
|
|
767
|
+
* @property {number} [resizable.minHeight] The minimum height of the element.
|
|
768
|
+
* @property {number} [resizable.maxHeight] The maximum height of the element
|
|
769
|
+
* @property {object} [resizable.handles] An object controlling which edges/corners are resizable.
|
|
770
|
+
* @property {boolean} [resizable.handles.topStart] Resizable from top-start corner
|
|
771
|
+
* @property {boolean} [resizable.handles.top] Resizable from top edge
|
|
772
|
+
* @property {boolean} [resizable.handles.topEnd] Resizable from top-end corner
|
|
773
|
+
* @property {boolean} [resizable.handles.end] Resizable from end edge
|
|
774
|
+
* @property {boolean} [resizable.handles.bottomEnd] Resizable from bottom-end corner
|
|
775
|
+
* @property {boolean} [resizable.handles.bottom] Resizable from bottom edge
|
|
776
|
+
* @property {boolean} [resizable.handles.bottomStart] Resizable from bottom-start corner
|
|
777
|
+
* @property {boolean} [resizable.handles.start] Resizable from start edge
|
|
778
|
+
*/
|
|
779
|
+
resizable ? : Boolean|{ minWidth?: number, maxWidth?: number, minHeight?: number, maxHeight?: number, handles?: { topStart?: Boolean, top?: Boolean, topEnd?: Boolean, end?: Boolean, bottomEnd?: Boolean, bottom?: Boolean, bottomStart?: Boolean, start?: Boolean } }
|
|
831
780
|
/**
|
|
832
781
|
* Set to `false` to only measure cell contents when double-clicking the edge between column headers.
|
|
833
782
|
*/
|
|
@@ -836,8 +785,7 @@ export declare type BryntumTimelineHistogramProps = {
|
|
|
836
785
|
* An empty function by default, but provided so that you can override it. This function is called each time
|
|
837
786
|
* a resource time range is rendered into the schedule. It's called with `resourceTimeRangeRecord`, `resourceRecord`,
|
|
838
787
|
* and `renderData` params.
|
|
839
|
-
* ...
|
|
840
|
-
* [View online docs...](https://bryntum.com/products/scheduler/docs/api/Scheduler/view/TimelineHistogram#config-resourceTimeRangeRenderer)
|
|
788
|
+
* [More...](https://bryntum.com/products/scheduler/docs/api/Scheduler/view/TimelineHistogram#config-resourceTimeRangeRenderer)
|
|
841
789
|
* @param {object} detail An object containing the information needed to render a ResourceTimeRangeModel.
|
|
842
790
|
* @param {Scheduler.model.ResourceTimeRangeModel} detail.resourceTimeRangeRecord The resource time range record.
|
|
843
791
|
* @param {Scheduler.model.ResourceModel} detail.resourceRecord The resource record.
|
|
@@ -847,23 +795,26 @@ export declare type BryntumTimelineHistogramProps = {
|
|
|
847
795
|
resourceTimeRangeRenderer ? : (detail: { resourceTimeRangeRecord: ResourceTimeRangeModel, resourceRecord: ResourceModel, renderData: object }) => string|DomConfig|DomConfig[]
|
|
848
796
|
/**
|
|
849
797
|
* "Break points" for which responsive config to use for columns and css.
|
|
850
|
-
* ...
|
|
851
|
-
* [View online docs...](https://bryntum.com/products/scheduler/docs/api/Scheduler/view/TimelineHistogram#config-responsiveLevels)
|
|
798
|
+
* [More...](https://bryntum.com/products/scheduler/docs/api/Scheduler/view/TimelineHistogram#config-responsiveLevels)
|
|
852
799
|
*/
|
|
853
800
|
responsiveLevels ? : Record<string, number|string|ResponsiveLevelConfig>
|
|
854
801
|
/**
|
|
855
802
|
* Configure as `true` to have the component display a translucent ripple when its
|
|
856
803
|
* [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
|
|
857
804
|
* current theme supports ripples</em>. Out of the box, only the Material theme supports ripples.
|
|
858
|
-
* ...
|
|
859
|
-
* [
|
|
805
|
+
* [More...](https://bryntum.com/products/scheduler/docs/api/Scheduler/view/TimelineHistogram#config-ripple)
|
|
806
|
+
* @property {string} [delegate] A CSS selector to filter which child elements trigger ripples. By default, the ripple is clipped to the triggering element.
|
|
807
|
+
* @property {string} [color] A CSS color name or specification.
|
|
808
|
+
* @property {number} [radius] The ending radius of the ripple. Note that it will be clipped by the target element by default.
|
|
809
|
+
* @property {string} [clip] A string which describes how to clip the ripple if it is not to be clipped to the default element. Either the property of the widget to use as the clipping element, or a selector to allow clipping to the closest matching ancestor to the target element.
|
|
810
|
+
*/
|
|
811
|
+
ripple ? : Boolean|object
|
|
812
|
+
/**
|
|
813
|
+
* The ARIA role to apply to this widget's element. By default, this is set to `'presentation'` to avoid
|
|
814
|
+
* accidentally applying a role which may interfere with screen readers.
|
|
815
|
+
* [More...](https://bryntum.com/products/scheduler/docs/api/Scheduler/view/TimelineHistogram#config-role)
|
|
860
816
|
*/
|
|
861
|
-
|
|
862
|
-
delegate?: string
|
|
863
|
-
color?: string
|
|
864
|
-
radius?: number
|
|
865
|
-
clip?: string
|
|
866
|
-
}
|
|
817
|
+
role ? : string
|
|
867
818
|
/**
|
|
868
819
|
* 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`
|
|
869
820
|
*/
|
|
@@ -872,8 +823,7 @@ export declare type BryntumTimelineHistogramProps = {
|
|
|
872
823
|
* Row height in pixels. This allows the default height for rows to be controlled. Note that it may be
|
|
873
824
|
* overridden by specifying a [rowHeight](https://bryntum.com/products/scheduler/docs/api/Grid/data/GridRowModel#field-rowHeight) on a per record basis, or from
|
|
874
825
|
* a column [renderer](https://bryntum.com/products/scheduler/docs/api/Grid/column/Column#config-renderer).
|
|
875
|
-
* ...
|
|
876
|
-
* [View online docs...](https://bryntum.com/products/scheduler/docs/api/Scheduler/view/TimelineHistogram#config-rowHeight)
|
|
826
|
+
* [More...](https://bryntum.com/products/scheduler/docs/api/Scheduler/view/TimelineHistogram#config-rowHeight)
|
|
877
827
|
*/
|
|
878
828
|
rowHeight ? : number
|
|
879
829
|
/**
|
|
@@ -882,29 +832,25 @@ export declare type BryntumTimelineHistogramProps = {
|
|
|
882
832
|
rowLines ? : Boolean
|
|
883
833
|
/**
|
|
884
834
|
* This may be configured as `true` to make the widget's element use the `direction:rtl` style.
|
|
885
|
-
* ...
|
|
886
|
-
* [View online docs...](https://bryntum.com/products/scheduler/docs/api/Scheduler/view/TimelineHistogram#config-rtl)
|
|
835
|
+
* [More...](https://bryntum.com/products/scheduler/docs/api/Scheduler/view/TimelineHistogram#config-rtl)
|
|
887
836
|
*/
|
|
888
837
|
rtl ? : Boolean
|
|
889
838
|
/**
|
|
890
839
|
* An object with configuration for the [ScaleColumn](https://bryntum.com/products/scheduler/docs/api/Scheduler/column/ScaleColumn).
|
|
891
|
-
* ...
|
|
892
|
-
* [View online docs...](https://bryntum.com/products/scheduler/docs/api/Scheduler/view/TimelineHistogram#config-scaleColumn)
|
|
840
|
+
* [More...](https://bryntum.com/products/scheduler/docs/api/Scheduler/view/TimelineHistogram#config-scaleColumn)
|
|
893
841
|
*/
|
|
894
842
|
scaleColumn ? : ScaleColumnConfig
|
|
895
843
|
/**
|
|
896
844
|
* Array of objects representing the [scale column](https://bryntum.com/products/scheduler/docs/api/Scheduler/view/mixin/TimelineHistogramScaleColumn#config-scaleColumn) scale points.
|
|
897
845
|
* The config basically is a mapping to the column [scalePoints](https://bryntum.com/products/scheduler/docs/api/Scheduler/column/ScaleColumn#config-scalePoints)
|
|
898
846
|
* config.
|
|
899
|
-
* ...
|
|
900
|
-
* [View online docs...](https://bryntum.com/products/scheduler/docs/api/Scheduler/view/TimelineHistogram#config-scalePoints)
|
|
847
|
+
* [More...](https://bryntum.com/products/scheduler/docs/api/Scheduler/view/TimelineHistogram#config-scalePoints)
|
|
901
848
|
*/
|
|
902
849
|
scalePoints ? : ScalePoint[]
|
|
903
850
|
/**
|
|
904
851
|
* 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).
|
|
905
852
|
* See the [scrollerClass](https://bryntum.com/products/scheduler/docs/api/Grid/view/GridBase#config-scrollerClass) config option.
|
|
906
|
-
* ...
|
|
907
|
-
* [View online docs...](https://bryntum.com/products/scheduler/docs/api/Scheduler/view/TimelineHistogram#config-scrollable)
|
|
853
|
+
* [More...](https://bryntum.com/products/scheduler/docs/api/Scheduler/view/TimelineHistogram#config-scrollable)
|
|
908
854
|
*/
|
|
909
855
|
scrollable ? : Boolean|ScrollerConfig|Scroller
|
|
910
856
|
/**
|
|
@@ -919,16 +865,14 @@ export declare type BryntumTimelineHistogramProps = {
|
|
|
919
865
|
/**
|
|
920
866
|
* Selection configuration settings, change these properties to control how selection works and what can be
|
|
921
867
|
* selected.
|
|
922
|
-
* ...
|
|
923
|
-
* [View online docs...](https://bryntum.com/products/scheduler/docs/api/Scheduler/view/TimelineHistogram#config-selectionMode)
|
|
868
|
+
* [More...](https://bryntum.com/products/scheduler/docs/api/Scheduler/view/TimelineHistogram#config-selectionMode)
|
|
924
869
|
*/
|
|
925
870
|
selectionMode ? : GridSelectionMode
|
|
926
871
|
/**
|
|
927
872
|
* Object enumerating data series for the histogram.
|
|
928
873
|
* The object keys are treated as the series identifiers and values are objects that
|
|
929
874
|
* must contain two properties:
|
|
930
|
-
* ...
|
|
931
|
-
* [View online docs...](https://bryntum.com/products/scheduler/docs/api/Scheduler/view/TimelineHistogram#config-series)
|
|
875
|
+
* [More...](https://bryntum.com/products/scheduler/docs/api/Scheduler/view/TimelineHistogram#config-series)
|
|
932
876
|
*/
|
|
933
877
|
series ? : Record<string, HistogramSeries>
|
|
934
878
|
/**
|
|
@@ -946,24 +890,30 @@ export declare type BryntumTimelineHistogramProps = {
|
|
|
946
890
|
/**
|
|
947
891
|
* Configure as `true` to have the grid show a red "changed" tag in cells whose
|
|
948
892
|
* field value has changed and not yet been committed.
|
|
949
|
-
* ...
|
|
950
|
-
*
|
|
893
|
+
* [More...](https://bryntum.com/products/scheduler/docs/api/Scheduler/view/TimelineHistogram#config-showDirty)
|
|
894
|
+
* @property {boolean} showDirty.duringEdit Set to `true` to show the red tag while editing a cell
|
|
895
|
+
* @property {boolean} showDirty.newRecord Set to `true` to show the red tag for all the cells of the new record
|
|
951
896
|
*/
|
|
952
|
-
showDirty ? : Boolean|{
|
|
953
|
-
|
|
954
|
-
|
|
955
|
-
|
|
897
|
+
showDirty ? : Boolean|{ duringEdit: Boolean, newRecord: Boolean }
|
|
898
|
+
/**
|
|
899
|
+
* When `true`, all zoom operations ([zoomIn](https://bryntum.com/products/scheduler/docs/api/Scheduler/view/mixin/TimelineZoomable#function-zoomIn),
|
|
900
|
+
* [zoomOut](https://bryntum.com/products/scheduler/docs/api/Scheduler/view/mixin/TimelineZoomable#function-zoomOut),
|
|
901
|
+
* [zoomInFull](https://bryntum.com/products/scheduler/docs/api/Scheduler/view/mixin/TimelineZoomable#function-zoomInFull),
|
|
902
|
+
* [zoomOutFull](https://bryntum.com/products/scheduler/docs/api/Scheduler/view/mixin/TimelineZoomable#function-zoomOutFull)) will use the smooth zoom system instead
|
|
903
|
+
* of jumping between discrete preset levels. This provides finer-grained control over zoom levels by
|
|
904
|
+
* interpolating tick sizes between presets.
|
|
905
|
+
* [More...](https://bryntum.com/products/scheduler/docs/api/Scheduler/view/TimelineHistogram#config-smoothZoom)
|
|
906
|
+
*/
|
|
907
|
+
smoothZoom ? : Boolean
|
|
956
908
|
/**
|
|
957
909
|
* Set to `true` to snap to the current time resolution increment while interacting with scheduled events.
|
|
958
|
-
* ...
|
|
959
|
-
* [View online docs...](https://bryntum.com/products/scheduler/docs/api/Scheduler/view/TimelineHistogram#config-snap)
|
|
910
|
+
* [More...](https://bryntum.com/products/scheduler/docs/api/Scheduler/view/TimelineHistogram#config-snap)
|
|
960
911
|
*/
|
|
961
912
|
snap ? : Boolean
|
|
962
913
|
/**
|
|
963
914
|
* Affects drag drop and resizing of events when [snap](https://bryntum.com/products/scheduler/docs/api/Scheduler/view/mixin/TimelineDateMapper#config-snap)
|
|
964
915
|
* is enabled.
|
|
965
|
-
* ...
|
|
966
|
-
* [View online docs...](https://bryntum.com/products/scheduler/docs/api/Scheduler/view/TimelineHistogram#config-snapRelativeToEventStartDate)
|
|
916
|
+
* [More...](https://bryntum.com/products/scheduler/docs/api/Scheduler/view/TimelineHistogram#config-snapRelativeToEventStartDate)
|
|
967
917
|
*/
|
|
968
918
|
snapRelativeToEventStartDate ? : Boolean
|
|
969
919
|
/**
|
|
@@ -972,46 +922,39 @@ export declare type BryntumTimelineHistogramProps = {
|
|
|
972
922
|
span ? : number
|
|
973
923
|
/**
|
|
974
924
|
* The start date of the timeline (if not configure with [infiniteScroll](https://bryntum.com/products/scheduler/docs/api/Scheduler/view/TimelineBase#config-infiniteScroll)).
|
|
975
|
-
* ...
|
|
976
|
-
* [View online docs...](https://bryntum.com/products/scheduler/docs/api/Scheduler/view/TimelineHistogram#config-startDate)
|
|
925
|
+
* [More...](https://bryntum.com/products/scheduler/docs/api/Scheduler/view/TimelineHistogram#config-startDate)
|
|
977
926
|
*/
|
|
978
927
|
startDate ? : Date|string
|
|
979
928
|
/**
|
|
980
929
|
* This value can be one of the following:
|
|
981
|
-
* ...
|
|
982
|
-
* [View online docs...](https://bryntum.com/products/scheduler/docs/api/Scheduler/view/TimelineHistogram#config-stateful)
|
|
930
|
+
* [More...](https://bryntum.com/products/scheduler/docs/api/Scheduler/view/TimelineHistogram#config-stateful)
|
|
983
931
|
*/
|
|
984
932
|
stateful ? : Boolean|object|string[]
|
|
985
933
|
/**
|
|
986
934
|
* The events that, when fired by this component, should trigger it to save its state by calling
|
|
987
935
|
* [saveState](https://bryntum.com/products/scheduler/docs/api/Core/mixin/State#function-saveState).
|
|
988
|
-
* ...
|
|
989
|
-
* [View online docs...](https://bryntum.com/products/scheduler/docs/api/Scheduler/view/TimelineHistogram#config-statefulEvents)
|
|
936
|
+
* [More...](https://bryntum.com/products/scheduler/docs/api/Scheduler/view/TimelineHistogram#config-statefulEvents)
|
|
990
937
|
*/
|
|
991
938
|
statefulEvents ? : object|string[]
|
|
992
939
|
/**
|
|
993
940
|
* 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
|
|
994
941
|
* 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)
|
|
995
942
|
* (if explicitly specified) will be used as the `stateId`.
|
|
996
|
-
* ...
|
|
997
|
-
* [View online docs...](https://bryntum.com/products/scheduler/docs/api/Scheduler/view/TimelineHistogram#config-stateId)
|
|
943
|
+
* [More...](https://bryntum.com/products/scheduler/docs/api/Scheduler/view/TimelineHistogram#config-stateId)
|
|
998
944
|
*/
|
|
999
945
|
stateId ? : string
|
|
1000
946
|
/**
|
|
1001
947
|
* 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`
|
|
1002
948
|
* will be saved using the [default state provider](https://bryntum.com/products/scheduler/docs/api/Core/state/StateProvider#property-instance-static).
|
|
1003
|
-
* ...
|
|
1004
|
-
* [View online docs...](https://bryntum.com/products/scheduler/docs/api/Scheduler/view/TimelineHistogram#config-stateProvider)
|
|
949
|
+
* [More...](https://bryntum.com/products/scheduler/docs/api/Scheduler/view/TimelineHistogram#config-stateProvider)
|
|
1005
950
|
*/
|
|
1006
951
|
stateProvider ? : StateProvider
|
|
1007
952
|
/**
|
|
1008
953
|
* The properties of this settings object controls how grid is restored from state data.
|
|
1009
|
-
* ...
|
|
1010
|
-
* [
|
|
954
|
+
* [More...](https://bryntum.com/products/scheduler/docs/api/Scheduler/view/TimelineHistogram#config-stateSettings)
|
|
955
|
+
* @property {boolean} [restoreUnconfiguredColumns] Determines whether to restore columns from the state that are not explicitly defined in the grid configuration.
|
|
1011
956
|
*/
|
|
1012
|
-
stateSettings ? :
|
|
1013
|
-
restoreUnconfiguredColumns?: Boolean
|
|
1014
|
-
}
|
|
957
|
+
stateSettings ? : object
|
|
1015
958
|
/**
|
|
1016
959
|
* When set, the text in the major time axis header sticks in the scrolling viewport as long as possible.
|
|
1017
960
|
*/
|
|
@@ -1019,24 +962,21 @@ export declare type BryntumTimelineHistogramProps = {
|
|
|
1019
962
|
/**
|
|
1020
963
|
* Store that holds records to display in the grid, or a store config object. If the configuration contains
|
|
1021
964
|
* a `readUrl`, an `AjaxStore` will be created.
|
|
1022
|
-
* ...
|
|
1023
|
-
* [View online docs...](https://bryntum.com/products/scheduler/docs/api/Scheduler/view/TimelineHistogram#config-store)
|
|
965
|
+
* [More...](https://bryntum.com/products/scheduler/docs/api/Scheduler/view/TimelineHistogram#config-store)
|
|
1024
966
|
*/
|
|
1025
967
|
store ? : Store|StoreConfig|AjaxStore|AjaxStoreConfig
|
|
1026
968
|
/**
|
|
1027
969
|
* An object containing widgets keyed by name. By default (when no `type` is given), strips are
|
|
1028
970
|
* [toolbars](https://bryntum.com/products/scheduler/docs/api/Core/widget/Toolbar). If you want to pass an array, you can use
|
|
1029
971
|
* the toolbar's [items](https://bryntum.com/products/scheduler/docs/api/Core/widget/Container#config-items).
|
|
1030
|
-
* ...
|
|
1031
|
-
* [View online docs...](https://bryntum.com/products/scheduler/docs/api/Scheduler/view/TimelineHistogram#config-strips)
|
|
972
|
+
* [More...](https://bryntum.com/products/scheduler/docs/api/Scheduler/view/TimelineHistogram#config-strips)
|
|
1032
973
|
*/
|
|
1033
974
|
strips ? : Record<string, SchedulerContainerItemConfig>
|
|
1034
975
|
/**
|
|
1035
976
|
* An object containing sub grid configuration objects keyed by a `region` property.
|
|
1036
977
|
* By default, grid has a 'locked' region (if configured with locked columns) and a 'normal' region.
|
|
1037
978
|
* The 'normal' region defaults to use `flex: 1`.
|
|
1038
|
-
* ...
|
|
1039
|
-
* [View online docs...](https://bryntum.com/products/scheduler/docs/api/Scheduler/view/TimelineHistogram#config-subGridConfigs)
|
|
979
|
+
* [More...](https://bryntum.com/products/scheduler/docs/api/Scheduler/view/TimelineHistogram#config-subGridConfigs)
|
|
1040
980
|
*/
|
|
1041
981
|
subGridConfigs ? : Record<string, SubGridConfig>
|
|
1042
982
|
/**
|
|
@@ -1047,37 +987,32 @@ export declare type BryntumTimelineHistogramProps = {
|
|
|
1047
987
|
/**
|
|
1048
988
|
* A [Mask](https://bryntum.com/products/scheduler/docs/api/Core/widget/Mask) config object, or a message to be shown when Crud Manager
|
|
1049
989
|
* is persisting changes on the server. Set to `null` to disable default sync mask.
|
|
1050
|
-
* ...
|
|
1051
|
-
* [View online docs...](https://bryntum.com/products/scheduler/docs/api/Scheduler/view/TimelineHistogram#config-syncMask)
|
|
990
|
+
* [More...](https://bryntum.com/products/scheduler/docs/api/Scheduler/view/TimelineHistogram#config-syncMask)
|
|
1052
991
|
*/
|
|
1053
992
|
syncMask ? : string|MaskConfig|null
|
|
1054
993
|
/**
|
|
1055
994
|
* 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
|
|
1056
995
|
* [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
|
|
1057
996
|
* this widget:
|
|
1058
|
-
* ...
|
|
1059
|
-
* [View online docs...](https://bryntum.com/products/scheduler/docs/api/Scheduler/view/TimelineHistogram#config-tab)
|
|
997
|
+
* [More...](https://bryntum.com/products/scheduler/docs/api/Scheduler/view/TimelineHistogram#config-tab)
|
|
1060
998
|
*/
|
|
1061
999
|
tab ? : Boolean|TabConfig
|
|
1062
1000
|
/**
|
|
1063
1001
|
* When this container is used as a tab in a TabPanel, these items are added to the
|
|
1064
1002
|
* [TabBar](https://bryntum.com/products/scheduler/docs/api/Core/widget/TabBar) when this container is the active tab.
|
|
1065
|
-
* ...
|
|
1066
|
-
* [View online docs...](https://bryntum.com/products/scheduler/docs/api/Scheduler/view/TimelineHistogram#config-tabBarItems)
|
|
1003
|
+
* [More...](https://bryntum.com/products/scheduler/docs/api/Scheduler/view/TimelineHistogram#config-tabBarItems)
|
|
1067
1004
|
*/
|
|
1068
1005
|
tabBarItems ? : ToolbarItems[]|Widget[]
|
|
1069
1006
|
/**
|
|
1070
1007
|
* A Config object representing the configuration of a [Toolbar](https://bryntum.com/products/scheduler/docs/api/Core/widget/Toolbar),
|
|
1071
1008
|
* or array of config objects representing the child items of a Toolbar.
|
|
1072
1009
|
* This creates a toolbar docked to the top of the panel immediately below the header.
|
|
1073
|
-
* ...
|
|
1074
|
-
* [View online docs...](https://bryntum.com/products/scheduler/docs/api/Scheduler/view/TimelineHistogram#config-tbar)
|
|
1010
|
+
* [More...](https://bryntum.com/products/scheduler/docs/api/Scheduler/view/TimelineHistogram#config-tbar)
|
|
1075
1011
|
*/
|
|
1076
1012
|
tbar ? : (SchedulerContainerItemConfig|string)[]|ToolbarConfig|PagingToolbarConfig|null
|
|
1077
1013
|
/**
|
|
1078
1014
|
* The width/height (depending on vertical / horizontal mode) of all the time columns.
|
|
1079
|
-
* ...
|
|
1080
|
-
* [View online docs...](https://bryntum.com/products/scheduler/docs/api/Scheduler/view/TimelineHistogram#config-tickSize)
|
|
1015
|
+
* [More...](https://bryntum.com/products/scheduler/docs/api/Scheduler/view/TimelineHistogram#config-tickSize)
|
|
1081
1016
|
*/
|
|
1082
1017
|
tickSize ? : number
|
|
1083
1018
|
/**
|
|
@@ -1089,50 +1024,41 @@ export declare type BryntumTimelineHistogramProps = {
|
|
|
1089
1024
|
/**
|
|
1090
1025
|
* Gets/sets the current time resolution object, which contains a unit identifier and an increment count
|
|
1091
1026
|
* `{ unit, increment }`. This value means minimal task duration you can create using UI.
|
|
1092
|
-
* ...
|
|
1093
|
-
*
|
|
1027
|
+
* [More...](https://bryntum.com/products/scheduler/docs/api/Scheduler/view/TimelineHistogram#config-timeResolution)
|
|
1028
|
+
* @property {number} increment The increment in the specified unit
|
|
1029
|
+
* @property {DurationUnit} unit The time resolution unit
|
|
1094
1030
|
*/
|
|
1095
|
-
timeResolution ? :
|
|
1096
|
-
increment?: number
|
|
1097
|
-
unit?: DurationUnit
|
|
1098
|
-
}|number
|
|
1031
|
+
timeResolution ? : object|number
|
|
1099
1032
|
/**
|
|
1100
1033
|
* Set to a time zone or a UTC offset. This will set the projects
|
|
1101
1034
|
* [timeZone](https://bryntum.com/products/scheduler/docs/api/Scheduler/model/ProjectModel#config-timeZone) config accordingly. As this config is only a referer,
|
|
1102
1035
|
* please see project's config [documentation](https://bryntum.com/products/scheduler/docs/api/Scheduler/model/ProjectModel#config-timeZone) for more
|
|
1103
1036
|
* information.
|
|
1104
|
-
* ...
|
|
1105
|
-
* [View online docs...](https://bryntum.com/products/scheduler/docs/api/Scheduler/view/TimelineHistogram#config-timeZone)
|
|
1037
|
+
* [More...](https://bryntum.com/products/scheduler/docs/api/Scheduler/view/TimelineHistogram#config-timeZone)
|
|
1106
1038
|
*/
|
|
1107
1039
|
timeZone ? : string|number
|
|
1108
1040
|
/**
|
|
1109
1041
|
* A title to display in the header or owning TabPanel. Causes creation and docking of a header
|
|
1110
1042
|
* to the top if no header is configured.
|
|
1111
|
-
* ...
|
|
1112
|
-
* [View online docs...](https://bryntum.com/products/scheduler/docs/api/Scheduler/view/TimelineHistogram#config-title)
|
|
1043
|
+
* [More...](https://bryntum.com/products/scheduler/docs/api/Scheduler/view/TimelineHistogram#config-title)
|
|
1113
1044
|
*/
|
|
1114
1045
|
title ? : string
|
|
1115
1046
|
/**
|
|
1116
1047
|
* 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
|
|
1117
1048
|
* property name is the reference by which an instantiated tool may be retrieved from the live
|
|
1118
1049
|
* `[tools](https://bryntum.com/products/scheduler/docs/api/Core/widget/mixin/Toolable#property-tools)` property.
|
|
1119
|
-
* ...
|
|
1120
|
-
* [View online docs...](https://bryntum.com/products/scheduler/docs/api/Scheduler/view/TimelineHistogram#config-tools)
|
|
1050
|
+
* [More...](https://bryntum.com/products/scheduler/docs/api/Scheduler/view/TimelineHistogram#config-tools)
|
|
1121
1051
|
*/
|
|
1122
1052
|
tools ? : Record<string, ToolConfig>|null
|
|
1123
1053
|
/**
|
|
1124
1054
|
* Configure UI transitions for various actions in the grid.
|
|
1055
|
+
* @property {boolean} insertRecord Transition row insertions
|
|
1056
|
+
* @property {boolean} removeRecord Transition row removals
|
|
1057
|
+
* @property {boolean} barChange Transition data changes that lead to bars being updated
|
|
1058
|
+
* @property {boolean} toggleTreeNode Transition tree node expand/collapse
|
|
1059
|
+
* @property {boolean} toggleGroup Transition group expand/collapse
|
|
1125
1060
|
*/
|
|
1126
|
-
transition ? :
|
|
1127
|
-
insertRecord?: Boolean
|
|
1128
|
-
removeRecord?: Boolean
|
|
1129
|
-
toggleColumn?: Boolean
|
|
1130
|
-
expandCollapseColumn?: Boolean
|
|
1131
|
-
toggleRegion?: Boolean
|
|
1132
|
-
toggleTreeNode?: Boolean
|
|
1133
|
-
toggleGroup?: Boolean
|
|
1134
|
-
filterRemoval?: Boolean
|
|
1135
|
-
}
|
|
1061
|
+
transition ? : object
|
|
1136
1062
|
/**
|
|
1137
1063
|
* Animation transition duration in milliseconds.
|
|
1138
1064
|
*/
|
|
@@ -1142,22 +1068,19 @@ export declare type BryntumTimelineHistogramProps = {
|
|
|
1142
1068
|
* Custom CSS class name suffixes to apply to the elements rendered by this widget. This may be specified
|
|
1143
1069
|
* as a space separated string, an array of strings, or as an object in which property names with truthy
|
|
1144
1070
|
* values are used as the class names.
|
|
1145
|
-
* ...
|
|
1146
|
-
* [View online docs...](https://bryntum.com/products/scheduler/docs/api/Scheduler/view/TimelineHistogram#config-ui)
|
|
1071
|
+
* [More...](https://bryntum.com/products/scheduler/docs/api/Scheduler/view/TimelineHistogram#config-ui)
|
|
1147
1072
|
*/
|
|
1148
1073
|
ui ? : 'plain'|'toolbar'|string|object
|
|
1149
1074
|
/**
|
|
1150
|
-
* A string key used to
|
|
1151
|
-
* managed by [PresetManager](https://bryntum.com/products/scheduler/docs/api/Scheduler/preset/PresetManager). See [PresetManager](#Scheduler/preset/PresetManager)
|
|
1152
|
-
* Or a config object for a viewPreset.
|
|
1153
|
-
* ...
|
|
1154
|
-
* [View online docs...](https://bryntum.com/products/scheduler/docs/api/Scheduler/view/TimelineHistogram#config-viewPreset)
|
|
1075
|
+
* A string key used to look up a predefined [ViewPreset](https://bryntum.com/products/scheduler/docs/api/Scheduler/preset/ViewPreset) (e.g. 'weekAndDay',
|
|
1076
|
+
* 'hourAndDay'), managed by [PresetManager](https://bryntum.com/products/scheduler/docs/api/Scheduler/preset/PresetManager). See [PresetManager](#Scheduler/preset/PresetManager)
|
|
1077
|
+
* for more information. Or a config object for a viewPreset.
|
|
1078
|
+
* [More...](https://bryntum.com/products/scheduler/docs/api/Scheduler/view/TimelineHistogram#config-viewPreset)
|
|
1155
1079
|
*/
|
|
1156
1080
|
viewPreset ? : string|ViewPresetConfig
|
|
1157
1081
|
/**
|
|
1158
1082
|
* A date to bring into view initially on the scrollable timeline.
|
|
1159
|
-
* ...
|
|
1160
|
-
* [View online docs...](https://bryntum.com/products/scheduler/docs/api/Scheduler/view/TimelineHistogram#config-visibleDate)
|
|
1083
|
+
* [More...](https://bryntum.com/products/scheduler/docs/api/Scheduler/view/TimelineHistogram#config-visibleDate)
|
|
1161
1084
|
*/
|
|
1162
1085
|
visibleDate ? : Date|VisibleDate
|
|
1163
1086
|
/**
|
|
@@ -1185,15 +1108,19 @@ export declare type BryntumTimelineHistogramProps = {
|
|
|
1185
1108
|
/**
|
|
1186
1109
|
* An object with format `{ fromDay, toDay, fromHour, toHour }` that describes the working days and hours.
|
|
1187
1110
|
* This object will be used to populate TimeAxis [include](https://bryntum.com/products/scheduler/docs/api/Scheduler/data/TimeAxis#config-include) property.
|
|
1188
|
-
* ...
|
|
1189
|
-
*
|
|
1111
|
+
* [More...](https://bryntum.com/products/scheduler/docs/api/Scheduler/view/TimelineHistogram#config-workingTime)
|
|
1112
|
+
* @property {number} workingTime.fromDay Day index 0-6 (0 is Sunday)
|
|
1113
|
+
* @property {number} workingTime.toDay Day index 0-6 (0 is Sunday)
|
|
1114
|
+
* @property {number} workingTime.fromHour 0-23
|
|
1115
|
+
* @property {number} workingTime.toHour 0-23
|
|
1116
|
+
*/
|
|
1117
|
+
workingTime ? : { fromDay: number, toDay: number, fromHour: number, toHour: number }
|
|
1118
|
+
/**
|
|
1119
|
+
* Factor multiplied with wheel delta to calculate smooth zoom level changes when zooming with mouse wheel or
|
|
1120
|
+
* trackpad pinch gestures. A higher value means faster zooming.
|
|
1121
|
+
* [More...](https://bryntum.com/products/scheduler/docs/api/Scheduler/view/TimelineHistogram#config-zoomFactor)
|
|
1190
1122
|
*/
|
|
1191
|
-
|
|
1192
|
-
fromDay?: number
|
|
1193
|
-
toDay?: number
|
|
1194
|
-
fromHour?: number
|
|
1195
|
-
toHour?: number
|
|
1196
|
-
}
|
|
1123
|
+
zoomFactor ? : number
|
|
1197
1124
|
/**
|
|
1198
1125
|
* Whether the originally rendered timespan should be preserved while zooming. By default, it is set to `false`,
|
|
1199
1126
|
* meaning the timeline panel will adjust the currently rendered timespan to limit the amount of HTML content to
|
|
@@ -1203,11 +1130,11 @@ export declare type BryntumTimelineHistogramProps = {
|
|
|
1203
1130
|
*/
|
|
1204
1131
|
zoomKeepsOriginalTimespan ? : Boolean
|
|
1205
1132
|
/**
|
|
1206
|
-
* If true
|
|
1133
|
+
* If `true`, you can zoom in and out on the time axis using <kbd>CTRL</kbd> + mouse wheel.
|
|
1207
1134
|
*/
|
|
1208
1135
|
zoomOnMouseWheel ? : Boolean
|
|
1209
1136
|
/**
|
|
1210
|
-
*
|
|
1137
|
+
* If `true`, you can zoom to a time span by double-clicking a time axis cell.
|
|
1211
1138
|
*/
|
|
1212
1139
|
zoomOnTimeAxisDoubleClick ? : Boolean
|
|
1213
1140
|
|
|
@@ -1217,137 +1144,124 @@ export declare type BryntumTimelineHistogramProps = {
|
|
|
1217
1144
|
* agent and see the responses. Which allows the user to use natural language to interact with the Grid in different
|
|
1218
1145
|
* ways. For example, the user can ask the agent to filter the data, sort it, or select specific records. The agent can
|
|
1219
1146
|
* also perform data manipulation operations such as adding, updating, deleting records.
|
|
1220
|
-
* ...
|
|
1221
|
-
* [View online docs...](https://bryntum.com/products/scheduler/docs/api/Grid/feature/AI)
|
|
1147
|
+
* [More...](https://bryntum.com/products/scheduler/docs/api/Grid/feature/AI)
|
|
1222
1148
|
*/
|
|
1223
1149
|
aiFeature ? : object|Boolean|string|GridAI|GridAIConfig
|
|
1224
1150
|
/**
|
|
1225
1151
|
* AI-powered filter feature for Grid. Allows users to type natural language queries to filter grid data.
|
|
1226
|
-
* ...
|
|
1227
|
-
* [View online docs...](https://bryntum.com/products/scheduler/docs/api/Grid/feature/ai/AIFilter)
|
|
1152
|
+
* [More...](https://bryntum.com/products/scheduler/docs/api/Grid/feature/ai/AIFilter)
|
|
1228
1153
|
*/
|
|
1229
1154
|
aiFilterFeature ? : object|Boolean|string|AIFilter|AIFilterConfig
|
|
1230
1155
|
/**
|
|
1231
1156
|
* Allows using `[Ctrl/CMD + C]`, `[Ctrl/CMD + X]` and `[Ctrl/CMD + V]` to cut, copy and paste cell or cell ranges. Also
|
|
1232
1157
|
* makes cut, copy and paste actions available via the cell context menu.
|
|
1233
|
-
* ...
|
|
1234
|
-
* [View online docs...](https://bryntum.com/products/scheduler/docs/api/Grid/feature/CellCopyPaste)
|
|
1158
|
+
* [More...](https://bryntum.com/products/scheduler/docs/api/Grid/feature/CellCopyPaste)
|
|
1235
1159
|
*/
|
|
1236
1160
|
cellCopyPasteFeature ? : object|Boolean|string|CellCopyPaste|CellCopyPasteConfig
|
|
1237
1161
|
/**
|
|
1238
1162
|
* Adding this feature to the grid and other Bryntum products which are based on the Grid (i.e. Scheduler, SchedulerPro, and Gantt)
|
|
1239
1163
|
* enables cell editing. Any subclass of [Field](https://bryntum.com/products/scheduler/docs/api/Core/widget/Field) can be used
|
|
1240
1164
|
* as editor for the [Column](https://bryntum.com/products/scheduler/docs/api/Grid/column/Column). The most popular are:
|
|
1241
|
-
* ...
|
|
1242
|
-
* [View online docs...](https://bryntum.com/products/scheduler/docs/api/Grid/feature/CellEdit)
|
|
1165
|
+
* [More...](https://bryntum.com/products/scheduler/docs/api/Grid/feature/CellEdit)
|
|
1243
1166
|
*/
|
|
1244
1167
|
cellEditFeature ? : object|Boolean|string|CellEdit|CellEditConfig
|
|
1245
1168
|
/**
|
|
1246
1169
|
* Right click to display context menu for cells. To invoke the cell menu in a keyboard-accessible manner, use the
|
|
1247
1170
|
* <kbd>Space</kbd> key when the cell is focused.
|
|
1248
|
-
* ...
|
|
1249
|
-
* [View online docs...](https://bryntum.com/products/scheduler/docs/api/Grid/feature/CellMenu)
|
|
1171
|
+
* [More...](https://bryntum.com/products/scheduler/docs/api/Grid/feature/CellMenu)
|
|
1250
1172
|
*/
|
|
1251
1173
|
cellMenuFeature ? : object|Boolean|string|CellMenu|CellMenuConfig
|
|
1252
1174
|
/**
|
|
1253
1175
|
* Displays a tooltip when hovering cells.
|
|
1254
|
-
* ...
|
|
1255
|
-
* [View online docs...](https://bryntum.com/products/scheduler/docs/api/Grid/feature/CellTooltip)
|
|
1176
|
+
* [More...](https://bryntum.com/products/scheduler/docs/api/Grid/feature/CellTooltip)
|
|
1256
1177
|
*/
|
|
1257
1178
|
cellTooltipFeature ? : object|Boolean|string|CellTooltip|CellTooltipConfig
|
|
1258
1179
|
/**
|
|
1259
1180
|
* 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
|
|
1260
1181
|
* and updated in realtime as data changes. Supports many common chart types with extensive styling and customization
|
|
1261
1182
|
* options.
|
|
1262
|
-
* ...
|
|
1263
|
-
* [View online docs...](https://bryntum.com/products/scheduler/docs/api/Grid/feature/Charts)
|
|
1183
|
+
* [More...](https://bryntum.com/products/scheduler/docs/api/Grid/feature/Charts)
|
|
1264
1184
|
*/
|
|
1265
1185
|
chartsFeature ? : object|Boolean|string|Charts|ChartsConfig
|
|
1266
1186
|
/**
|
|
1267
|
-
* Enables the [autoWidth](https://bryntum.com/products/scheduler/docs/api/Grid/column/Column#config-autoWidth) config for a grid's columns.
|
|
1268
|
-
*
|
|
1269
|
-
*
|
|
1187
|
+
* Enables the [autoWidth](https://bryntum.com/products/scheduler/docs/api/Grid/column/Column#config-autoWidth) config for a grid's columns. When a column
|
|
1188
|
+
* has `autoWidth` set, this feature measures the rendered content of all visible cells in that column
|
|
1189
|
+
* and adjusts the column width to fit. The measurement is triggered automatically when data changes
|
|
1190
|
+
* or rows are rendered.
|
|
1191
|
+
* [More...](https://bryntum.com/products/scheduler/docs/api/Grid/feature/ColumnAutoWidth)
|
|
1270
1192
|
*/
|
|
1271
1193
|
columnAutoWidthFeature ? : object|Boolean|string|ColumnAutoWidth|ColumnAutoWidthConfig
|
|
1272
1194
|
/**
|
|
1273
1195
|
* Displays a toolbar while dragging column headers. Drop on a button in the toolbar to activate a certain function,
|
|
1274
1196
|
* for example to group by that column. This feature simplifies certain operations on touch devices.
|
|
1275
|
-
* ...
|
|
1276
|
-
* [View online docs...](https://bryntum.com/products/scheduler/docs/api/Grid/feature/ColumnDragToolbar)
|
|
1197
|
+
* [More...](https://bryntum.com/products/scheduler/docs/api/Grid/feature/ColumnDragToolbar)
|
|
1277
1198
|
*/
|
|
1278
1199
|
columnDragToolbarFeature ? : object|Boolean|string|ColumnDragToolbar|ColumnDragToolbarConfig
|
|
1279
1200
|
/**
|
|
1280
1201
|
* Displays column lines for ticks, with a different styling for major ticks (by default they are darker). If this
|
|
1281
1202
|
* feature is disabled, no lines are shown. If it's enabled, line are shown for the tick level which is set in current
|
|
1282
1203
|
* ViewPreset. Please see [columnLinesFor](https://bryntum.com/products/scheduler/docs/api/Scheduler/preset/ViewPreset#field-columnLinesFor) config for details.
|
|
1283
|
-
* ...
|
|
1284
|
-
* [View online docs...](https://bryntum.com/products/scheduler/docs/api/Scheduler/feature/ColumnLines)
|
|
1204
|
+
* [More...](https://bryntum.com/products/scheduler/docs/api/Scheduler/feature/ColumnLines)
|
|
1285
1205
|
*/
|
|
1286
1206
|
columnLinesFeature ? : object|Boolean|string|ColumnLines|ColumnLinesConfig
|
|
1287
1207
|
/**
|
|
1288
1208
|
* Displays a column picker (to show/hide columns) in the header context menu. Columns can be displayed in sub menus
|
|
1289
1209
|
* by region or tag. Grouped headers are displayed as menu hierarchies.
|
|
1290
|
-
* ...
|
|
1291
|
-
* [View online docs...](https://bryntum.com/products/scheduler/docs/api/Grid/feature/ColumnPicker)
|
|
1210
|
+
* [More...](https://bryntum.com/products/scheduler/docs/api/Grid/feature/ColumnPicker)
|
|
1292
1211
|
*/
|
|
1293
1212
|
columnPickerFeature ? : object|Boolean|string|ColumnPicker|ColumnPickerConfig
|
|
1294
1213
|
/**
|
|
1295
1214
|
* Allows user to rename columns by either right-clicking column header or using keyboard shortcuts when column header
|
|
1296
1215
|
* is focused.
|
|
1297
|
-
* ...
|
|
1298
|
-
* [View online docs...](https://bryntum.com/products/scheduler/docs/api/Grid/feature/ColumnRename)
|
|
1216
|
+
* [More...](https://bryntum.com/products/scheduler/docs/api/Grid/feature/ColumnRename)
|
|
1299
1217
|
*/
|
|
1300
1218
|
columnRenameFeature ? : object|Boolean|string|ColumnRename|ColumnRenameConfig
|
|
1301
1219
|
/**
|
|
1302
|
-
* Allows user to reorder columns by dragging headers.
|
|
1303
|
-
*
|
|
1304
|
-
*
|
|
1305
|
-
* [
|
|
1220
|
+
* Allows user to reorder columns by dragging headers. Click and drag a column header to move it to a new position.
|
|
1221
|
+
* Visual feedback shows the drop target while dragging. To get notified about column reorder, listen to the
|
|
1222
|
+
* `change` event on the [columns](https://bryntum.com/products/scheduler/docs/api/Grid/data/ColumnStore) store.
|
|
1223
|
+
* [More...](https://bryntum.com/products/scheduler/docs/api/Grid/feature/ColumnReorder)
|
|
1306
1224
|
*/
|
|
1307
1225
|
columnReorderFeature ? : object|Boolean|string|ColumnReorder|ColumnReorderConfig
|
|
1308
1226
|
/**
|
|
1309
|
-
* Enables user to resize columns by dragging a handle on the right hand side of the header.
|
|
1310
|
-
*
|
|
1311
|
-
*
|
|
1312
|
-
* [
|
|
1227
|
+
* Enables user to resize columns by dragging a handle on the right hand side of the header. A drag handle
|
|
1228
|
+
* appears when hovering near the right edge of a column header. Dragging it adjusts the column width, respecting
|
|
1229
|
+
* any [minWidth](https://bryntum.com/products/scheduler/docs/api/Grid/column/Column#config-minWidth) or [maxWidth](#Grid/column/Column#config-maxWidth) constraints.
|
|
1230
|
+
* [More...](https://bryntum.com/products/scheduler/docs/api/Grid/feature/ColumnResize)
|
|
1313
1231
|
*/
|
|
1314
1232
|
columnResizeFeature ? : object|Boolean|string|ColumnResize|ColumnResizeConfig
|
|
1315
1233
|
/**
|
|
1316
1234
|
* A feature that allows exporting Grid data to Excel or CSV without involving the server. It uses
|
|
1317
1235
|
* [TableExporter](https://bryntum.com/products/scheduler/docs/api/Grid/util/TableExporter) class as data provider, 3rd party provider to generate XLS files, and
|
|
1318
1236
|
* [Microsoft XML specification](https://msdn.microsoft.com/en-us/library/office/documentformat.openxml.spreadsheet.aspx).
|
|
1319
|
-
* ...
|
|
1320
|
-
* [View online docs...](https://bryntum.com/products/scheduler/docs/api/Grid/feature/experimental/ExcelExporter)
|
|
1237
|
+
* [More...](https://bryntum.com/products/scheduler/docs/api/Grid/feature/experimental/ExcelExporter)
|
|
1321
1238
|
*/
|
|
1322
1239
|
excelExporterFeature ? : object|Boolean|string|GridExcelExporter|GridExcelExporterConfig
|
|
1323
1240
|
/**
|
|
1324
|
-
* An experimental feature that lets users drop files on a Widget. The widget fires
|
|
1325
|
-
* In the event, you get access to the raw
|
|
1326
|
-
*
|
|
1327
|
-
* [
|
|
1241
|
+
* An experimental feature that lets users drop files on a Widget. The widget fires a
|
|
1242
|
+
* [fileDrop](https://bryntum.com/products/scheduler/docs/api/Grid/feature/experimental/FileDrop#event-fileDrop) event when a file is dropped onto it. In the event, you get access to the raw
|
|
1243
|
+
* files as strings, that were parsed by calling `readAsBinaryString`.
|
|
1244
|
+
* [More...](https://bryntum.com/products/scheduler/docs/api/Grid/feature/experimental/FileDrop)
|
|
1328
1245
|
*/
|
|
1329
1246
|
fileDropFeature ? : object|Boolean|string|FileDrop|FileDropConfig
|
|
1330
1247
|
/**
|
|
1331
1248
|
* This feature adds a fill handle to a Grid range selection, which when dragged, fills the cells being dragged over
|
|
1332
1249
|
* with values based on the values in the original selected range. This is similar to functionality normally seen in
|
|
1333
1250
|
* various spreadsheet applications.
|
|
1334
|
-
* ...
|
|
1335
|
-
* [View online docs...](https://bryntum.com/products/scheduler/docs/api/Grid/feature/FillHandle)
|
|
1251
|
+
* [More...](https://bryntum.com/products/scheduler/docs/api/Grid/feature/FillHandle)
|
|
1336
1252
|
*/
|
|
1337
1253
|
fillHandleFeature ? : object|Boolean|string|FillHandle|FillHandleConfig
|
|
1338
1254
|
/**
|
|
1339
1255
|
* Feature that allows filtering of the grid by settings filters on columns. The actual filtering is done by the store.
|
|
1340
1256
|
* For info on programmatically handling filters, see [StoreFilter](https://bryntum.com/products/scheduler/docs/api/Core/data/mixin/StoreFilter).
|
|
1341
|
-
* ...
|
|
1342
|
-
* [View online docs...](https://bryntum.com/products/scheduler/docs/api/Grid/feature/Filter)
|
|
1257
|
+
* [More...](https://bryntum.com/products/scheduler/docs/api/Grid/feature/Filter)
|
|
1343
1258
|
*/
|
|
1344
1259
|
filterFeature ? : object|Boolean|string|Filter|FilterConfig
|
|
1345
1260
|
/**
|
|
1346
1261
|
* Feature that allows filtering of the grid by entering filters on column headers.
|
|
1347
1262
|
* The actual filtering is done by the store.
|
|
1348
1263
|
* For info on programmatically handling filters, see [StoreFilter](https://bryntum.com/products/scheduler/docs/api/Core/data/mixin/StoreFilter).
|
|
1349
|
-
* ...
|
|
1350
|
-
* [View online docs...](https://bryntum.com/products/scheduler/docs/api/Grid/feature/FilterBar)
|
|
1264
|
+
* [More...](https://bryntum.com/products/scheduler/docs/api/Grid/feature/FilterBar)
|
|
1351
1265
|
*/
|
|
1352
1266
|
filterBarFeature ? : object|Boolean|string|FilterBar|FilterBarConfig
|
|
1353
1267
|
/**
|
|
@@ -1355,186 +1269,162 @@ export declare type BryntumTimelineHistogramProps = {
|
|
|
1355
1269
|
* <kbd>Shift</kbd> + clicking headers, or by using the context menu, or by using two finger tap (one on header,
|
|
1356
1270
|
* one anywhere on grid). Use <kbd>Shift</kbd> + <kbd>Alt</kbd> + click, or the context menu, to remove a column
|
|
1357
1271
|
* grouper.
|
|
1358
|
-
* ...
|
|
1359
|
-
* [View online docs...](https://bryntum.com/products/scheduler/docs/api/Grid/feature/Group)
|
|
1272
|
+
* [More...](https://bryntum.com/products/scheduler/docs/api/Grid/feature/Group)
|
|
1360
1273
|
*/
|
|
1361
1274
|
groupFeature ? : object|Boolean|string|Group|GroupConfig
|
|
1362
1275
|
/**
|
|
1363
1276
|
* A special version of the Grid GroupSummary feature that enables summaries within scheduler. To use a single summary
|
|
1364
1277
|
* it is easiest to configure [renderer](https://bryntum.com/products/scheduler/docs/api/Scheduler/feature/GroupSummary#config-renderer), for multiple summaries see [summaries](#Scheduler/feature/GroupSummary#config-summaries).
|
|
1365
|
-
* ...
|
|
1366
|
-
* [View online docs...](https://bryntum.com/products/scheduler/docs/api/Scheduler/feature/GroupSummary)
|
|
1278
|
+
* [More...](https://bryntum.com/products/scheduler/docs/api/Scheduler/feature/GroupSummary)
|
|
1367
1279
|
*/
|
|
1368
1280
|
groupSummaryFeature ? : object|Boolean|string|GroupSummary|GroupSummaryConfig
|
|
1369
1281
|
/**
|
|
1370
1282
|
* Right click column header or focus it and press SPACE key to show the context menu for headers.
|
|
1371
|
-
* ...
|
|
1372
|
-
* [View online docs...](https://bryntum.com/products/scheduler/docs/api/Grid/feature/HeaderMenu)
|
|
1283
|
+
* [More...](https://bryntum.com/products/scheduler/docs/api/Grid/feature/HeaderMenu)
|
|
1373
1284
|
*/
|
|
1374
1285
|
headerMenuFeature ? : object|Boolean|string|HeaderMenu|HeaderMenuConfig
|
|
1375
1286
|
/**
|
|
1376
1287
|
* Enables users to click and drag to zoom to a date range in Scheduler's header time axis. Only supported in horizontal
|
|
1377
1288
|
* mode.
|
|
1378
|
-
* ...
|
|
1379
|
-
* [View online docs...](https://bryntum.com/products/scheduler/docs/api/Scheduler/feature/HeaderZoom)
|
|
1289
|
+
* [More...](https://bryntum.com/products/scheduler/docs/api/Scheduler/feature/HeaderZoom)
|
|
1380
1290
|
*/
|
|
1381
1291
|
headerZoomFeature ? : object|Boolean|string|HeaderZoom|HeaderZoomConfig
|
|
1382
1292
|
/**
|
|
1383
1293
|
* This feature allows records which satisfy a certain condition to be locked at the top of the grid.
|
|
1384
|
-
* ...
|
|
1385
|
-
* [View online docs...](https://bryntum.com/products/scheduler/docs/api/Grid/feature/LockRows)
|
|
1294
|
+
* [More...](https://bryntum.com/products/scheduler/docs/api/Grid/feature/LockRows)
|
|
1386
1295
|
*/
|
|
1387
1296
|
lockRowsFeature ? : object|Boolean|string|GridLockRows|GridLockRowsConfig
|
|
1388
1297
|
/**
|
|
1389
1298
|
* 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
|
|
1390
1299
|
* configured to [mergeCells](https://bryntum.com/products/scheduler/docs/api/Grid/column/Column#config-mergeCells).
|
|
1391
|
-
* ...
|
|
1392
|
-
* [View online docs...](https://bryntum.com/products/scheduler/docs/api/Grid/feature/MergeCells)
|
|
1300
|
+
* [More...](https://bryntum.com/products/scheduler/docs/api/Grid/feature/MergeCells)
|
|
1393
1301
|
*/
|
|
1394
1302
|
mergeCellsFeature ? : object|Boolean|string|MergeCells|MergeCellsConfig
|
|
1395
1303
|
/**
|
|
1396
1304
|
* Feature that allows styling of weekends (and other non-working time) by adding timeRanges for those days.
|
|
1397
|
-
* ...
|
|
1398
|
-
* [View online docs...](https://bryntum.com/products/scheduler/docs/api/Scheduler/feature/NonWorkingTime)
|
|
1305
|
+
* [More...](https://bryntum.com/products/scheduler/docs/api/Scheduler/feature/NonWorkingTime)
|
|
1399
1306
|
*/
|
|
1400
1307
|
nonWorkingTimeFeature ? : object|Boolean|string|NonWorkingTime|NonWorkingTimeConfig
|
|
1401
1308
|
/**
|
|
1402
1309
|
* Makes the scheduler's timeline pannable by dragging with the mouse. Try it out in the demo below.
|
|
1403
|
-
* ...
|
|
1404
|
-
* [View online docs...](https://bryntum.com/products/scheduler/docs/api/Scheduler/feature/Pan)
|
|
1310
|
+
* [More...](https://bryntum.com/products/scheduler/docs/api/Scheduler/feature/Pan)
|
|
1405
1311
|
*/
|
|
1406
1312
|
panFeature ? : object|Boolean|string|Pan|PanConfig
|
|
1407
1313
|
/**
|
|
1408
1314
|
* Generates PDF/PNG files from the Grid component.
|
|
1409
|
-
* ...
|
|
1410
|
-
* [View online docs...](https://bryntum.com/products/scheduler/docs/api/Grid/feature/export/PdfExport)
|
|
1315
|
+
* [More...](https://bryntum.com/products/scheduler/docs/api/Grid/feature/export/PdfExport)
|
|
1411
1316
|
*/
|
|
1412
1317
|
pdfExportFeature ? : object|Boolean|string|GridPdfExport|GridPdfExportConfig
|
|
1413
1318
|
/**
|
|
1414
1319
|
* Allows pinning columns to the start or end region of the grid without any additional subGrid configurations.
|
|
1415
1320
|
* When pinning to a region that does not yet exist, the feature creates the required subGrid on the fly.
|
|
1416
|
-
* ...
|
|
1417
|
-
* [View online docs...](https://bryntum.com/products/scheduler/docs/api/Grid/feature/PinColumns)
|
|
1321
|
+
* [More...](https://bryntum.com/products/scheduler/docs/api/Grid/feature/PinColumns)
|
|
1418
1322
|
*/
|
|
1419
1323
|
pinColumnsFeature ? : object|Boolean|string|PinColumns|PinColumnsConfig
|
|
1420
1324
|
/**
|
|
1421
1325
|
* Allows printing Grid contents using browser print dialog.
|
|
1422
|
-
* ...
|
|
1423
|
-
* [View online docs...](https://bryntum.com/products/scheduler/docs/api/Grid/feature/export/Print)
|
|
1326
|
+
* [More...](https://bryntum.com/products/scheduler/docs/api/Grid/feature/export/Print)
|
|
1424
1327
|
*/
|
|
1425
1328
|
printFeature ? : object|Boolean|string|GridPrint|GridPrintConfig
|
|
1426
1329
|
/**
|
|
1427
1330
|
* Feature that allows the user to search in a column by focusing a cell and typing. Navigate between hits using the
|
|
1428
|
-
* keyboard,
|
|
1429
|
-
*
|
|
1430
|
-
* [
|
|
1331
|
+
* keyboard, <kbd>f3</kbd> or <kbd>ctrl</kbd>/<kbd>cmd</kbd> + <kbd>g</kbd> moves to next, also pressing
|
|
1332
|
+
* <kbd>shift</kbd> moves to previous.
|
|
1333
|
+
* [More...](https://bryntum.com/products/scheduler/docs/api/Grid/feature/QuickFind)
|
|
1431
1334
|
*/
|
|
1432
1335
|
quickFindFeature ? : object|Boolean|string|QuickFind|QuickFindConfig
|
|
1433
1336
|
/**
|
|
1434
1337
|
* Makes the splitter between grid [sections](https://bryntum.com/products/scheduler/docs/api/Grid/view/SubGrid) draggable, to let users resize, and
|
|
1435
1338
|
* collapse/expand the sections.
|
|
1436
|
-
* ...
|
|
1437
|
-
* [View online docs...](https://bryntum.com/products/scheduler/docs/api/Grid/feature/RegionResize)
|
|
1339
|
+
* [More...](https://bryntum.com/products/scheduler/docs/api/Grid/feature/RegionResize)
|
|
1438
1340
|
*/
|
|
1439
1341
|
regionResizeFeature ? : object|Boolean|string|RegionResize|RegionResizeConfig
|
|
1440
1342
|
/**
|
|
1441
1343
|
* Applicable only for Scheduler in `vertical` mode. Right click resource header cells to display a context menu.
|
|
1442
|
-
* ...
|
|
1443
|
-
* [View online docs...](https://bryntum.com/products/scheduler/docs/api/Scheduler/feature/ResourceMenu)
|
|
1344
|
+
* [More...](https://bryntum.com/products/scheduler/docs/api/Scheduler/feature/ResourceMenu)
|
|
1444
1345
|
*/
|
|
1445
1346
|
resourceMenuFeature ? : object|Boolean|string|ResourceMenu|ResourceMenuConfig
|
|
1446
1347
|
/**
|
|
1447
1348
|
* Feature that draws resource time ranges, shaded areas displayed behind events. These zones are similar to events in
|
|
1448
1349
|
* that they have a start and end date but different in that they do not take part in the event layout, and they always
|
|
1449
1350
|
* occupy full row height.
|
|
1450
|
-
* ...
|
|
1451
|
-
* [View online docs...](https://bryntum.com/products/scheduler/docs/api/Scheduler/feature/ResourceTimeRanges)
|
|
1351
|
+
* [More...](https://bryntum.com/products/scheduler/docs/api/Scheduler/feature/ResourceTimeRanges)
|
|
1452
1352
|
*/
|
|
1453
1353
|
resourceTimeRangesFeature ? : object|Boolean|string|ResourceTimeRanges|ResourceTimeRangesConfig
|
|
1454
1354
|
/**
|
|
1455
1355
|
* Allow using [Ctrl/CMD + C/X] and [Ctrl/CMD + V] to copy/cut-and-paste rows. Also makes cut, copy and paste actions
|
|
1456
1356
|
* available via the cell context menu.
|
|
1457
|
-
* ...
|
|
1458
|
-
* [View online docs...](https://bryntum.com/products/scheduler/docs/api/Grid/feature/RowCopyPaste)
|
|
1357
|
+
* [More...](https://bryntum.com/products/scheduler/docs/api/Grid/feature/RowCopyPaste)
|
|
1459
1358
|
*/
|
|
1460
1359
|
rowCopyPasteFeature ? : object|Boolean|string|RowCopyPaste|RowCopyPasteConfig
|
|
1461
1360
|
/**
|
|
1462
1361
|
* This feature allows editing of entire rows in a grid in a docked panel which by default slides out from the right.
|
|
1463
|
-
* ...
|
|
1464
|
-
* [View online docs...](https://bryntum.com/products/scheduler/docs/api/Grid/feature/RowEdit)
|
|
1362
|
+
* [More...](https://bryntum.com/products/scheduler/docs/api/Grid/feature/RowEdit)
|
|
1465
1363
|
*/
|
|
1466
1364
|
rowEditFeature ? : object|Boolean|string|RowEdit|RowEditConfig
|
|
1467
1365
|
/**
|
|
1468
1366
|
* Enables expanding of Grid rows by either row click or double click, or by adding a separate Grid column which renders
|
|
1469
1367
|
* a button that expands or collapses the row.
|
|
1470
|
-
* ...
|
|
1471
|
-
* [View online docs...](https://bryntum.com/products/scheduler/docs/api/Grid/feature/RowExpander)
|
|
1368
|
+
* [More...](https://bryntum.com/products/scheduler/docs/api/Grid/feature/RowExpander)
|
|
1472
1369
|
*/
|
|
1473
1370
|
rowExpanderFeature ? : object|Boolean|string|RowExpander|RowExpanderConfig
|
|
1474
1371
|
/**
|
|
1475
1372
|
* This feature implements support for project transactions and used by default in Gantt. For general RowReorder feature
|
|
1476
1373
|
* documentation see [RowReorder](https://bryntum.com/products/scheduler/docs/api/Grid/feature/RowReorder).
|
|
1477
|
-
* ...
|
|
1478
|
-
* [View online docs...](https://bryntum.com/products/scheduler/docs/api/Scheduler/feature/RowReorder)
|
|
1374
|
+
* [More...](https://bryntum.com/products/scheduler/docs/api/Scheduler/feature/RowReorder)
|
|
1479
1375
|
*/
|
|
1480
1376
|
rowReorderFeature ? : object|Boolean|string|RowReorder|RowReorderConfig
|
|
1481
1377
|
/**
|
|
1482
1378
|
* 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)
|
|
1483
1379
|
* field of the record is updated (when [applyToAllRows](https://bryntum.com/products/scheduler/docs/api/Grid/feature/RowResize#config-applyToAllRows) is `false`).
|
|
1484
|
-
* ...
|
|
1485
|
-
* [View online docs...](https://bryntum.com/products/scheduler/docs/api/Grid/feature/RowResize)
|
|
1380
|
+
* [More...](https://bryntum.com/products/scheduler/docs/api/Grid/feature/RowResize)
|
|
1486
1381
|
*/
|
|
1487
1382
|
rowResizeFeature ? : object|Boolean|string|GridRowResize|GridRowResizeConfig
|
|
1488
1383
|
/**
|
|
1489
1384
|
* Feature that displays a tooltip containing the time at the mouse position when hovering empty parts of the schedule.
|
|
1490
|
-
* ...
|
|
1491
|
-
* [View online docs...](https://bryntum.com/products/scheduler/docs/api/Scheduler/feature/ScheduleTooltip)
|
|
1385
|
+
* [More...](https://bryntum.com/products/scheduler/docs/api/Scheduler/feature/ScheduleTooltip)
|
|
1492
1386
|
*/
|
|
1493
1387
|
scheduleTooltipFeature ? : object|Boolean|string|ScheduleTooltip|ScheduleTooltipConfig
|
|
1494
1388
|
/**
|
|
1495
1389
|
* <div class="external-example vertical" data-file="Grid/feature/Search.js"></div>
|
|
1496
|
-
* ...
|
|
1497
|
-
* [View online docs...](https://bryntum.com/products/scheduler/docs/api/Grid/feature/Search)
|
|
1390
|
+
* [More...](https://bryntum.com/products/scheduler/docs/api/Grid/feature/Search)
|
|
1498
1391
|
*/
|
|
1499
1392
|
searchFeature ? : object|Boolean|string|Search|SearchConfig
|
|
1500
1393
|
/**
|
|
1501
1394
|
* Allows sorting of grid by clicking (or tapping) headers, also displays which columns grid is sorted by (numbered if
|
|
1502
1395
|
* using multisort). Use modifier keys for multisorting: [Ctrl/CMD + click] to add sorter, [Ctrl/CMD + Alt + click] to remove sorter.
|
|
1503
1396
|
* The actual sorting is done by the store, see [Store.sort()](https://bryntum.com/products/scheduler/docs/api/Core/data/mixin/StoreSort#function-sort).
|
|
1504
|
-
* ...
|
|
1505
|
-
* [View online docs...](https://bryntum.com/products/scheduler/docs/api/Grid/feature/Sort)
|
|
1397
|
+
* [More...](https://bryntum.com/products/scheduler/docs/api/Grid/feature/Sort)
|
|
1506
1398
|
*/
|
|
1507
1399
|
sortFeature ? : object|Boolean|string|Sort|SortConfig
|
|
1508
1400
|
/**
|
|
1509
1401
|
* This feature allows splitting the Scheduler into multiple views, either by using the cell context menu, or
|
|
1510
1402
|
* programmatically by calling [split()](https://bryntum.com/products/scheduler/docs/api/Scheduler/feature/Split#function-split).
|
|
1511
|
-
* ...
|
|
1512
|
-
* [View online docs...](https://bryntum.com/products/scheduler/docs/api/Scheduler/feature/Split)
|
|
1403
|
+
* [More...](https://bryntum.com/products/scheduler/docs/api/Scheduler/feature/Split)
|
|
1513
1404
|
*/
|
|
1514
1405
|
splitFeature ? : object|Boolean|string|Split|SplitConfig
|
|
1515
1406
|
/**
|
|
1516
|
-
* A feature which pins
|
|
1517
|
-
*
|
|
1518
|
-
*
|
|
1519
|
-
* [
|
|
1407
|
+
* A feature which pins cell content to the top of the grid while the row scrolls off the top but is still visible. Very
|
|
1408
|
+
* similar to native `position: sticky`, which because of Grid's multiple-region setup unfortunately cannot be used to
|
|
1409
|
+
* achieve the same effect.
|
|
1410
|
+
* [More...](https://bryntum.com/products/scheduler/docs/api/Grid/feature/StickyCells)
|
|
1520
1411
|
*/
|
|
1521
1412
|
stickyCellsFeature ? : object|Boolean|string|StickyCells|StickyCellsConfig
|
|
1522
1413
|
/**
|
|
1523
1414
|
* Stripes rows by adding alternating CSS classes to all row elements (`b-even` and `b-odd`).
|
|
1524
|
-
*
|
|
1525
|
-
*
|
|
1415
|
+
* This improves visual readability in data-heavy grids by giving adjacent rows different background colors.
|
|
1416
|
+
* Style the striped rows using the `.b-even` and `.b-odd` CSS classes.
|
|
1417
|
+
* [More...](https://bryntum.com/products/scheduler/docs/api/Grid/feature/Stripe)
|
|
1526
1418
|
*/
|
|
1527
1419
|
stripeFeature ? : object|Boolean|string|Stripe|StripeConfig
|
|
1528
1420
|
/**
|
|
1529
1421
|
* A special version of the Grid Summary feature. This feature displays a summary row in the grid footer.
|
|
1530
|
-
* ...
|
|
1531
|
-
* [View online docs...](https://bryntum.com/products/scheduler/docs/api/Scheduler/feature/Summary)
|
|
1422
|
+
* [More...](https://bryntum.com/products/scheduler/docs/api/Scheduler/feature/Summary)
|
|
1532
1423
|
*/
|
|
1533
1424
|
summaryFeature ? : object|Boolean|string|Summary|SummaryConfig
|
|
1534
1425
|
/**
|
|
1535
1426
|
* Adds scheduler specific menu items to the timeline header context menu.
|
|
1536
|
-
* ...
|
|
1537
|
-
* [View online docs...](https://bryntum.com/products/scheduler/docs/api/Scheduler/feature/TimeAxisHeaderMenu)
|
|
1427
|
+
* [More...](https://bryntum.com/products/scheduler/docs/api/Scheduler/feature/TimeAxisHeaderMenu)
|
|
1538
1428
|
*/
|
|
1539
1429
|
timeAxisHeaderMenuFeature ? : object|Boolean|string|TimeAxisHeaderMenu|TimeAxisHeaderMenuConfig
|
|
1540
1430
|
/**
|
|
@@ -1542,8 +1432,7 @@ export declare type BryntumTimelineHistogramProps = {
|
|
|
1542
1432
|
* or some important point in time (a `line`, i.e. a range with 0 duration). This feature can also show a current time
|
|
1543
1433
|
* indicator if you set [showCurrentTimeLine](https://bryntum.com/products/scheduler/docs/api/Scheduler/feature/TimeRanges#config-showCurrentTimeLine) to true. To style the rendered elements, use the
|
|
1544
1434
|
* [cls](https://bryntum.com/products/scheduler/docs/api/Scheduler/model/TimeSpan#field-cls) field of the `TimeSpan` class.
|
|
1545
|
-
* ...
|
|
1546
|
-
* [View online docs...](https://bryntum.com/products/scheduler/docs/api/Scheduler/feature/TimeRanges)
|
|
1435
|
+
* [More...](https://bryntum.com/products/scheduler/docs/api/Scheduler/feature/TimeRanges)
|
|
1547
1436
|
*/
|
|
1548
1437
|
timeRangesFeature ? : object|Boolean|string|TimeRanges|TimeRangesConfig
|
|
1549
1438
|
/**
|
|
@@ -1551,15 +1440,13 @@ export declare type BryntumTimelineHistogramProps = {
|
|
|
1551
1440
|
* 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
|
|
1552
1441
|
* tree renderer that adds padding and icon to give the appearance of a tree. The original renderer is preserved and
|
|
1553
1442
|
* also called.
|
|
1554
|
-
* ...
|
|
1555
|
-
* [View online docs...](https://bryntum.com/products/scheduler/docs/api/Grid/feature/Tree)
|
|
1443
|
+
* [More...](https://bryntum.com/products/scheduler/docs/api/Grid/feature/Tree)
|
|
1556
1444
|
*/
|
|
1557
1445
|
treeFeature ? : object|Boolean|string|Tree|TreeConfig
|
|
1558
1446
|
/**
|
|
1559
1447
|
* A feature that allows transforming a flat dataset (or the leaves of a hierarchical) into a tree by specifying a
|
|
1560
1448
|
* record field per parent level. Parents are generated based on each leaf's value for those fields.
|
|
1561
|
-
* ...
|
|
1562
|
-
* [View online docs...](https://bryntum.com/products/scheduler/docs/api/Grid/feature/TreeGroup)
|
|
1449
|
+
* [More...](https://bryntum.com/products/scheduler/docs/api/Grid/feature/TreeGroup)
|
|
1563
1450
|
*/
|
|
1564
1451
|
treeGroupFeature ? : object|Boolean|string|TreeGroup|TreeGroupConfig
|
|
1565
1452
|
|