@smart-webcomponents-angular/combobox 13.1.70 → 15.0.2

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/index.d.ts CHANGED
@@ -1,6 +1,1252 @@
1
+ export interface ThreeDChartProperties {
2
+ /**
3
+ * Sets or gets the animation mode. Animation is disabled when the property is set to 'none'.
4
+ * Default value: advanced
5
+ */
6
+ animation?: Animation | string;
7
+ /**
8
+ * Determines the rate of the animation. The default animation rate is 1
9
+ * Default value: 1
10
+ */
11
+ animationSpeed?: number;
12
+ /**
13
+ * Sets whether the chart will rotate automatically.
14
+ * Default value: false
15
+ */
16
+ autoRotate?: boolean;
17
+ /**
18
+ * Sets the speed of the automatic rotation.
19
+ * Default value: 1
20
+ */
21
+ autoRotateSpeed?: number;
22
+ /**
23
+ * Sets the chart's background color. For example: '#DDFFE8'
24
+ * Default value: #ffffff
25
+ */
26
+ backgroundColor?: string | null;
27
+ /**
28
+ * Sets the chart's background to a static linear gradient. The property must be set to an Array of Strings in the format: 'offset, color'
29
+ * Default value: []
30
+ */
31
+ backgroundGradient?: any[];
32
+ /**
33
+ * Sets the chart's background to a static image. For example: 'https://www.htmlelements.com/demos/images/stars.jpg'
34
+ * Default value: ""
35
+ */
36
+ backgroundImage?: string;
37
+ /**
38
+ * Sets the chart's background to a dynamic background image which rotates with the camera. The property must be set an Array of 6 images. All images must have aspect ratio 1:1
39
+ * Default value: []
40
+ */
41
+ backgroundTexture?: any[];
42
+ /**
43
+ * Sets the camera's position. The property must be set to an {x, y, z} object.
44
+ * Default value: [object Object]
45
+ */
46
+ cameraPosition?: ThreeDChartCameraPosition;
47
+ /**
48
+ * Sets the intial camera zoom. The default value is 1
49
+ * Default value: 1
50
+ */
51
+ cameraZoom?: number;
52
+ /**
53
+ * Sets the caption (title) of the chart.
54
+ * Default value: "Caption"
55
+ */
56
+ caption?: string;
57
+ /**
58
+ * Sets the chart's color pallete. jqxChart suppports 32 color schemes from 'scheme01' to 'scheme32'.
59
+ * Default value: scheme01
60
+ */
61
+ colorScheme?: ThreeDChartColorScheme | string;
62
+ /**
63
+ * Sets the chart's controls settings.
64
+ * Default value: [object Object]
65
+ */
66
+ controlsSettings?: any;
67
+ /**
68
+ * Allows substituting default items with custom 3D Objects. The property must be set to an Array of Objects in the format: { groupIndex, serieIndex, itemIndex, modelUrl }
69
+ * Default value: []
70
+ */
71
+ customModels?: any[];
72
+ /**
73
+ * Sets the chart's data source.
74
+ * Default value:
75
+ */
76
+ dataSource?: any[];
77
+ /**
78
+ * Sets the description text of the chart.
79
+ * Default value: "Description"
80
+ */
81
+ description?: string;
82
+ /**
83
+ * Enables or disables the chart.
84
+ * Default value: false
85
+ */
86
+ disabled?: boolean;
87
+ /**
88
+ * Sets whether the chart's toolbar is enabled.
89
+ * Default value: true
90
+ */
91
+ enableControlsToolbar?: boolean;
92
+ /**
93
+ *
94
+ * Default value: reset-camera,zoom-in,zoom-out,save-image,camera-control
95
+ */
96
+ controlsToolbarItems?: any;
97
+ /**
98
+ * Sets the chart's grid options.
99
+ * Default value: [object Object]
100
+ */
101
+ gridOptions?: any;
102
+ /**
103
+ * Sets whether the legend will be created based on the chart's series or serie groups. "auto" - the legend index will change depending on the Chart type
104
+ * Default value: auto
105
+ */
106
+ legendIndex?: ThreeDChartLegendIndex | string;
107
+ /**
108
+ * Sets the legend's layout.
109
+ * Default value: [object Object]
110
+ */
111
+ legendLayout?: any;
112
+ /**
113
+ * Sets the light color of the 3D Scene.
114
+ * Default value: "#ffffff"
115
+ */
116
+ lightColor?: string;
117
+ /**
118
+ * Sets or gets the locale. Used in conjunction with the property messages.
119
+ * Default value: "en"
120
+ */
121
+ locale?: string;
122
+ /**
123
+ * Sets or gets an object specifying strings used in the widget that can be localized. Used in conjunction with the property locale.
124
+ * Default value: * [object Object]
125
+ */
126
+ messages?: any;
127
+ /**
128
+ * Sets or gets a value indicating whether the Chart's layout is mirrored.
129
+ * Default value: false
130
+ */
131
+ rightToLeft?: boolean;
132
+ /**
133
+ * Determines the selection mode.
134
+ * Default value: multiple
135
+ */
136
+ selectionMode?: ThreeDChartSelectionMode | string;
137
+ /**
138
+ * The seriesGroups property is used to describe all series displayed on the chart. jqxChart supports multiple series of different types and series grouping. Each series group may have its own Value Axis (Y-axis) which allows you to have values with different scales displayed on the same chart at the same time. It also allows you to display multiple series types together on the same chart. For example, you can display all series in one group as lines and the series in a second group as columns. seriesGroups is an array of objects where each object represents one group.
139
+ * Default value:
140
+ */
141
+ seriesGroups?: ThreeDChartSeriesGroup[];
142
+ /**
143
+ * Determines whether to show grid connecting lines when a chart item is hovered over.
144
+ * Default value: false
145
+ */
146
+ showConnectionLines?: boolean;
147
+ /**
148
+ * Determines whether to show or hide the chart series legend.
149
+ * Default value: true
150
+ */
151
+ showLegend?: boolean;
152
+ /**
153
+ * Determines whether to show or hide the chart series legend table.
154
+ * Default value: false
155
+ */
156
+ showLegendTable?: boolean;
157
+ /**
158
+ * Enables or disables the chart tooltips.
159
+ * Default value: true
160
+ */
161
+ showToolTips?: boolean;
162
+ /**
163
+ * Sets the padding of the chart's title (caption).
164
+ * Default value: [object Object]
165
+ */
166
+ titlePadding?: ThreeDChartPadding;
167
+ /**
168
+ * User defined tooltip text formatting callback function.
169
+ * Default value: null
170
+ */
171
+ toolTipFormatFunction?: {(value?: any, index?: number, series?: any): string};
172
+ /**
173
+ * Tooltip line color. By default it is set to the hovered item's color
174
+ * Default value: null
175
+ */
176
+ toolTipLineColor?: string | null;
177
+ /**
178
+ * An object with settings about the Chart's y-axis (value axis).
179
+ * Default value: [object Object]
180
+ */
181
+ valueAxis?: ThreeDChartValueAxis;
182
+ /**
183
+ * Sets the Chart's xAxis.
184
+ * Default value: [object Object]
185
+ */
186
+ xAxis?: ThreeDChartXAxis;
187
+ /**
188
+ * Sets the Chart's zAxis.
189
+ * Default value: [object Object]
190
+ */
191
+ zAxis?: ThreeDChartZAxis;
192
+ }
193
+ /**
194
+ 3D Chart is a feature-complete interactive WebGL 3D graph library that answers the data visualization needs of any modern web app.
195
+ */
196
+ export interface ThreeDChart extends BaseElement, ThreeDChartProperties {
197
+
198
+ /* Get a member by its name */
199
+ [name: string]: any;
200
+ /**
201
+ * The event is raised when the user clicks on a chart element.
202
+ * @param event. The custom event. Custom data event was created with: ev.detail(itemIndex, serieIndex, groupIndex)
203
+ * itemIndex - The item index of the item.
204
+ * serieIndex - The serie index of the item.
205
+ * groupIndex - The group index of the item.
206
+ */
207
+ onItemClick?: ((this: any, ev: Event) => any) | ((this: any, ev: CustomEvent<any>) => any) | null;
208
+ /**
209
+ * The event is raised when a chart element is shown.
210
+ * @param event. The custom event. Custom data event was created with: ev.detail(itemIndex, serieIndex, groupIndex)
211
+ * itemIndex - The item index of the item.
212
+ * serieIndex - The serie index of the item.
213
+ * groupIndex - The group index of the item.
214
+ */
215
+ onShow?: ((this: any, ev: Event) => any) | ((this: any, ev: CustomEvent<any>) => any) | null;
216
+ /**
217
+ * The event is raised when a chart element is hidden.
218
+ * @param event. The custom event. Custom data event was created with: ev.detail(itemIndex, serieIndex, groupIndex)
219
+ * itemIndex - The item index of the item.
220
+ * serieIndex - The serie index of the item.
221
+ * groupIndex - The group index of the item.
222
+ */
223
+ onHide?: ((this: any, ev: Event) => any) | ((this: any, ev: CustomEvent<any>) => any) | null;
224
+ /**
225
+ * The event is raised when a chart element is selected.
226
+ * @param event. The custom event. Custom data event was created with: ev.detail(itemIndex, serieIndex, groupIndex)
227
+ * itemIndex - The item index of the item.
228
+ * serieIndex - The serie index of the item.
229
+ * groupIndex - The group index of the item.
230
+ */
231
+ onSelect?: ((this: any, ev: Event) => any) | ((this: any, ev: CustomEvent<any>) => any) | null;
232
+ /**
233
+ * The event is raised when a chart element is unselected.
234
+ * @param event. The custom event. Custom data event was created with: ev.detail(itemIndex, serieIndex, groupIndex)
235
+ * itemIndex - The item index of the item.
236
+ * serieIndex - The serie index of the item.
237
+ * groupIndex - The group index of the item.
238
+ */
239
+ onUnselect?: ((this: any, ev: Event) => any) | ((this: any, ev: CustomEvent<any>) => any) | null;
240
+ /**
241
+ * The event is raised after the chart's range selector position changes and after the chart ends rendering.
242
+ * @param event. The custom event. Custom data event was created with: ev.detail(minValue, maxValue)
243
+ * minValue - The start value of the range selector.
244
+ * maxValue - The end value of the range selector.
245
+ */
246
+ onRangeSelectionChanged?: ((this: any, ev: Event) => any) | ((this: any, ev: CustomEvent<any>) => any) | null;
247
+ /**
248
+ * The event is raised when the chart's range selector position changes and before the chart starts rendering. The event can be default prevented to cancel the range selection change.
249
+ * @param event. The custom event. Custom data event was created with: ev.detail(minValue, maxValue, oldMinValue, oldMaxValue)
250
+ * minValue - The start value of the range selector.
251
+ * maxValue - The end value of the range selector.
252
+ * oldMinValue - The previous start value of the range selector.
253
+ * oldMaxValue - The previous end value of the range selector.
254
+ */
255
+ onRangeSelectionChanging?: ((this: any, ev: Event) => any) | ((this: any, ev: CustomEvent<any>) => any) | null;
256
+ /**
257
+ * The event is raised when the chart begins rendering.
258
+ * @param event. The custom event. */
259
+ onRefreshBegin?: ((this: any, ev: Event) => any) | ((this: any, ev: CustomEvent<any>) => any) | null;
260
+ /**
261
+ * The event is raised when the chart finishes rendering.
262
+ * @param event. The custom event. */
263
+ onRefreshEnd?: ((this: any, ev: Event) => any) | ((this: any, ev: CustomEvent<any>) => any) | null;
264
+ /**
265
+ * The event is raised when the chart begins resizing.
266
+ * @param event. The custom event. */
267
+ onResizeBegin?: ((this: any, ev: Event) => any) | ((this: any, ev: CustomEvent<any>) => any) | null;
268
+ /**
269
+ * The event is raised when the chart finishes resizing.
270
+ * @param event. The custom event. */
271
+ onResizeEnd?: ((this: any, ev: Event) => any) | ((this: any, ev: CustomEvent<any>) => any) | null;
272
+ /**
273
+ * Adds a new color sheme. If a scheme with the same name already exists, the method will update its colors.
274
+ * @param {string} schemeName. The name of the custom color scheme.
275
+ * @param {any[]} colorsArray. An array of color values.
276
+ */
277
+ addColorScheme(schemeName: string, colorsArray: any[]): void;
278
+ /**
279
+ * Begins an update of the chart. The chart will not be rendered until the endUpdate method is called.
280
+ */
281
+ beginUpdate(): void;
282
+ /**
283
+ * Ends an update of the chart. The chart will be rendered after the endUpdate method is called.
284
+ * @param {boolean} refresh?. If set to true, the chart will complete a full refresh.
285
+ */
286
+ endUpdate(refresh?: boolean): void;
287
+ /**
288
+ * Returns the colors of a color scheme by name. If the scheme doesn't exist the method returns undefined.
289
+ * @param {string} schemeName. The name of the color scheme.
290
+ * @returns {any[]}
291
+ */
292
+ getColorScheme(schemeName: string): any[];
293
+ /**
294
+ * Gets the item with the specified indexes.
295
+ * @param {number | null} groupIndex?. Series group index.
296
+ * @param {number | null} serieIndex?. Series index.
297
+ * @param {number | null} itemIndex?. Item (data point) index.
298
+ * @returns {any}
299
+ */
300
+ getItemByIndexes(groupIndex?: number | null, serieIndex?: number | null, itemIndex?: number | null): any;
301
+ /**
302
+ * Gets an arrat of the items with the specified indexes. Leaving an index null will return all items that match the other indexes.
303
+ * @param {number | null} groupIndex?. Series group index.
304
+ * @param {number | null} serieIndex?. Series index.
305
+ * @param {number | null} itemIndex?. Item (data point) index.
306
+ * @returns {any}
307
+ */
308
+ getItemsByIndexes(groupIndex?: number | null, serieIndex?: number | null, itemIndex?: number | null): any;
309
+ /**
310
+ * Gets the indexes of the hidden series.
311
+ * @returns {{ groupIndex: number, serieIndex: number, itemIndex: number }[]}
312
+ */
313
+ getHidden(): { groupIndex: number, serieIndex: number, itemIndex: number }[];
314
+ /**
315
+ * Gets the selected items.
316
+ * @returns {any[]}
317
+ */
318
+ getSelection(): any[];
319
+ /**
320
+ * Gets the rendered values of the valueAxis labels.
321
+ * @returns {any}
322
+ */
323
+ getValueAxisLabels(): any;
324
+ /**
325
+ * Gets the rendered values of the xAxis labels.
326
+ * @returns {any}
327
+ */
328
+ getXAxisLabels(): any;
329
+ /**
330
+ * Gets the rendered values of the zAxis labels.
331
+ * @returns {any}
332
+ */
333
+ getZAxisLabels(): any;
334
+ /**
335
+ * Hides all items of a chart group.
336
+ * @param {number} groupIndex. Series group index.
337
+ */
338
+ hideGroup(groupIndex: number): void;
339
+ /**
340
+ * Hides a chart item.
341
+ * @param {number} groupIndex. Series group index.
342
+ * @param {number} serieIndex. Series index.
343
+ * @param {number} itemIndex?. Item (data point) index.
344
+ */
345
+ hideItem(groupIndex: number, serieIndex: number, itemIndex?: number): void;
346
+ /**
347
+ * Hides all items of a chart serie.
348
+ * @param {number} groupIndex. Series group index.
349
+ * @param {number} serieIndex. Series index.
350
+ */
351
+ hideSerie(groupIndex: number, serieIndex: number): void;
352
+ /**
353
+ * Refreshes the content of the chart element after a property or data update.
354
+ */
355
+ refresh(): void;
356
+ /**
357
+ * Removes an existing color scheme. If the scheme does not exist, the method has no effect.
358
+ * @param {string} schemeName. The name of the custom color scheme.
359
+ */
360
+ removeColorScheme(schemeName: string): void;
361
+ /**
362
+ * Exports the chart's content as JPEG image.
363
+ * @param {string} fileName?. File name.
364
+ * @param {boolean} includeLegend?. Sets whether the legend will be part of the saved file.
365
+ * @param {boolean} includeCaption?. Sets whether the caption will be part of the saved file.
366
+ */
367
+ saveAsJPEG(fileName?: string, includeLegend?: boolean, includeCaption?: boolean): void;
368
+ /**
369
+ * Exports the chart's content as PNG image.
370
+ * @param {string} fileName?. File name.
371
+ * @param {boolean} includeLegend?. Sets whether the legend will be part of the saved file.
372
+ * @param {boolean} includeCaption?. Sets whether the caption will be part of the saved file.
373
+ */
374
+ saveAsPNG(fileName?: string, includeLegend?: boolean, includeCaption?: boolean): void;
375
+ /**
376
+ * Exports the chart's content as PDF file.
377
+ * @param {string} fileName?. File name.
378
+ * @param {boolean} includeLegend?. Sets whether the legend will be part of the saved file.
379
+ * @param {boolean} includeCaption?. Sets whether the caption will be part of the saved file.
380
+ */
381
+ saveAsPDF(fileName?: string, includeLegend?: boolean, includeCaption?: boolean): void;
382
+ /**
383
+ * Selects a chart item. If selectionMode is 'one', the previous item will be unselected.
384
+ * @param {number} groupIndex. Series group index.
385
+ * @param {number} serieIndex. Series index.
386
+ * @param {number} itemIndex?. Item (data point) index.
387
+ */
388
+ selectItem(groupIndex: number, serieIndex: number, itemIndex?: number): void;
389
+ /**
390
+ * Shows all items of a chart group.
391
+ * @param {number} groupIndex. Series group index.
392
+ */
393
+ showGroup(groupIndex: number): void;
394
+ /**
395
+ * Shows a chart item.
396
+ * @param {number} groupIndex. Series group index.
397
+ * @param {number} serieIndex. Series index.
398
+ * @param {number} itemIndex?. Item (data point) index.
399
+ */
400
+ showItem(groupIndex: number, serieIndex: number, itemIndex?: number): void;
401
+ /**
402
+ * Shows all items of a chart serie.
403
+ * @param {number} groupIndex. Series group index.
404
+ * @param {number} serieIndex. Series index.
405
+ */
406
+ showSerie(groupIndex: number, serieIndex: number): void;
407
+ /**
408
+ * Sets the camera position to its position during the initialization.
409
+ */
410
+ setDefaultPosition(): void;
411
+ /**
412
+ * Sets the camera mode. Different camera modes change the control actions of the mouse. Available modes are 'zoom', 'pan' and 'default'.
413
+ * @param {string} mode. Camera mode.
414
+ */
415
+ setCameraMode(mode: string): void;
416
+ /**
417
+ * Sets the camera position.
418
+ * @param {number} x. X coordinate.
419
+ * @param {number} y. Y coordinate.
420
+ * @param {number} z. Z coordinate.
421
+ * @param {boolean} animation?. Animation Enabled
422
+ */
423
+ setCameraPosition(x: number, y: number, z: number, animation?: boolean): void;
424
+ /**
425
+ * Sets the camera zoom.
426
+ * @param {number} level. Zoom level.
427
+ * @param {boolean} animation?. Animation Enabled
428
+ */
429
+ setCameraZoom(level: number, animation?: boolean): void;
430
+ /**
431
+ * Unelects a chart item.
432
+ * @param {number} groupIndex. Series group index.
433
+ * @param {number} serieIndex. Series index.
434
+ * @param {number} itemIndex?. Item (data point) index.
435
+ */
436
+ unselectItem(groupIndex: number, serieIndex: number, itemIndex?: number): void;
437
+ /**
438
+ * Updates the values of the chart series without full refresh of the entire chart. The method should be used for animation of frequently changing values.
439
+ */
440
+ update(): void;
441
+ }
442
+
443
+ /**Sets the camera's position. The property must be set to an {x, y, z} object. */
444
+ export interface ThreeDChartCameraPosition {
445
+ /**
446
+ * Sets the camera's x position. This is the left-right axis
447
+ * Default value: 5
448
+ */
449
+ x?: number;
450
+ /**
451
+ * Sets the camera's y position. This is the up-down axis
452
+ * Default value: 20
453
+ */
454
+ y?: number;
455
+ /**
456
+ * Sets the camera's z position. This is the forward-backward axis
457
+ * Default value: 55
458
+ */
459
+ z?: number;
460
+ }
461
+
462
+ export interface ThreeDChartSeriesGroup {
463
+ /**
464
+ * Optional color bands dislayed in the chart's plot area.
465
+ * Default value: null
466
+ */
467
+ bands?: ThreeDChartBand[];
468
+ /**
469
+ * Determines the data source of the serie
470
+ * Default value: null
471
+ */
472
+ dataSource?: any;
473
+ /**
474
+ * Sets the Z-axis width of the series group. Can be set as number or percetage of the slot's width.
475
+ * Default value: 2
476
+ */
477
+ depth?: number | string;
478
+ /**
479
+ * Callback function used to format series labels.
480
+ * Default value: null
481
+ */
482
+ formatFunction?: {(value?: any, index?: number, series?: any): string};
483
+ /**
484
+ * Object describing the format settings of series labels.
485
+ * Default value: [object Object]
486
+ */
487
+ formatSettings?: ThreeDChartFormatSettings;
488
+ /**
489
+ * Sets the opacity of the series group.
490
+ * Default value: 1
491
+ */
492
+ opacity?: number;
493
+ /**
494
+ * An array of chart series.
495
+ * Default value:
496
+ */
497
+ series?: ThreeDChartSeriesGroupSerie[];
498
+ /**
499
+ * When showLabels is set to true, the chart will render pie labels.
500
+ * Default value: true
501
+ */
502
+ showLabels?: boolean;
503
+ /**
504
+ * The start angle (in degrees) of the polar coordinate system. Applicable to polar and spider charts only.
505
+ * Default value: 0
506
+ */
507
+ startAngle?: number;
508
+ /**
509
+ * Sets the chart type. jqxChart supports several common chart types. You can easily plot series of different types on a common chart. A type must be specified for each series group. Currently, jqxChart supports the following series types:'column' - simple column series'stackedcolumn' - stacked column series'stackedcolumn100' - percentage stacked columns'rangecolumn' - floating column between two values'waterfall' - waterfall series'stackedwaterfall' - stacked waterfall series'line' - simple straight lines connecting the value points'stackedline' - stacked lines'stackedline100' - percentage stacked lines'spline' - smooth lines connecting the value points'stackedspline' - smooth stacked lines'stackedspline100' - percentage stacked smooth lines'stepline' - step line'stackedstepline' - stacked step line'stackedstepline100' - percentage stacked step line'area' - area connecting the value points with straight lines'stackedarea' - stacked area with straight lines between the points'stackedarea100' - percentage stacked area with straight lines between the points'rangearea' - floating area between pairs of value points'splinearea' - smooth area connecting the value points'stackedsplinearea' - stacked smooth area connecting the value points'stackedsplinearea100' - percentage stacked smooth area'splinerangearea' - smooth floating area between pairs of value points'steprangearea' - step area between pairs of value points'stackedsplineara' - smooth stacked area'steparea' - step area connecting the value points'stackedsteparea' - step stacked area'stackedsteparea100' - percentage stacked step area'pie' - circular chart divided into sectors, illustrating proportion'donut' - chart divided into circular sectors with different inner and outer radius'scatter' - data is displayed as a collection of points'stackedscatter' - data is displayed as a collection of points and the values are stacked'stackedscatter100' - data is displayed as a collection of points and the values are percentage stacked'bubble' - data is displayed as a collection of bubbles'stackedbubble' - data is displayed as a collection of bubbles and the values are stacked'stackedbubble100' - data is displayed as a collection of bubbles and the values are percentage stacked'candlestick' - display candlestick series using open, high, low, close data points'ohlc' - display OHLC series using open, high, low, close data points
510
+ * Default value: column
511
+ */
512
+ type?: ThreeDChartType | string;
513
+ /**
514
+ * Sets the Y-axis width of the series group. Used to set the thickness of the line series
515
+ * Default value: 2
516
+ */
517
+ verticalWidth?: number;
518
+ /**
519
+ * Sets the X-axis width of the series group. Can be set as number or percetage of the slot's width.
520
+ * Default value: 2
521
+ */
522
+ width?: number | string;
523
+ }
524
+
525
+ export interface ThreeDChartBand {
526
+ /**
527
+ * Color used to fill the area between the minValue and the maxValue.
528
+ * Default value: null
529
+ */
530
+ color?: string | null;
531
+ /**
532
+ * Band line color.
533
+ * Default value: null
534
+ */
535
+ lineColor?: string | null;
536
+ /**
537
+ * Band line width.
538
+ * Default value: null
539
+ */
540
+ lineWidth?: string | number | null;
541
+ /**
542
+ * End value of the color band.
543
+ * Default value: NaN
544
+ */
545
+ maxValue?: any;
546
+ /**
547
+ * Start value of the color band.
548
+ * Default value: NaN
549
+ */
550
+ minValue?: any;
551
+ /**
552
+ * Fraction indicating the fill opacity.
553
+ * Default value: 1
554
+ */
555
+ opacity?: number;
556
+ }
557
+
558
+ /**Object describing the format settings of series labels. */
559
+ export interface ThreeDChartFormatSettings {
560
+ /**
561
+ * Optional date format string. This property is applicable only when displaying Date objects.
562
+ * Default value: null
563
+ */
564
+ dateFormat?: string | null;
565
+ /**
566
+ * Decimal places of numeric values.
567
+ * Default value: null
568
+ */
569
+ decimalPlaces?: number | null;
570
+ /**
571
+ * A symbol used to mark the border between the integer and fractional parts of a number. The default value is inherited from localization.decimalSeparator.
572
+ * Default value: null
573
+ */
574
+ decimalSeparator?: string | null;
575
+ /**
576
+ * A boolean value indicating whether to display negative numbers in brackets.
577
+ * Default value: false
578
+ */
579
+ negativeWithBrackets?: boolean;
580
+ /**
581
+ * Text to prepend to the value.
582
+ * Default value: ""
583
+ */
584
+ prefix?: string;
585
+ /**
586
+ * Text to append to the value
587
+ * Default value: ""
588
+ */
589
+ sufix?: string;
590
+ /**
591
+ * A symbol used to mark the border between thousands, millions, billions, etc. The default value is inherited from localization.thousandsSeparator.
592
+ * Default value: null
593
+ */
594
+ thousandsSeparator?: string | null;
595
+ }
596
+
597
+ export interface ThreeDChartSeriesGroupSerie {
598
+ /**
599
+ * A custom function that returns the color of a data point. The function will receive the following parameters: dataValue, itemIndex, serie, group. The implementation of the function can return a single color which will be used as a fillColor and the other colors will be derived or it can return an object containing fillColor, fillColorSelected, etc.
600
+ * Default value: null
601
+ */
602
+ colorFunction?: any;
603
+ /**
604
+ * Name of the field in the data source.
605
+ * Default value: "null"
606
+ */
607
+ dataField?: string;
608
+ /**
609
+ * Data field used in candlestcik and ohlc series.
610
+ * Default value: "null"
611
+ */
612
+ dataFieldClose?: string;
613
+ /**
614
+ * Data field used in candlestcik and ohlc series.
615
+ * Default value: "null"
616
+ */
617
+ dataFieldHigh?: string;
618
+ /**
619
+ * Data field used in candlestcik and ohlc series.
620
+ * Default value: "null"
621
+ */
622
+ dataFieldLow?: string;
623
+ /**
624
+ * Data field used in candlestcik and ohlc series.
625
+ * Default value: "null"
626
+ */
627
+ dataFieldOpen?: string;
628
+ /**
629
+ * Data field used in in range column series as a start data field.
630
+ * Default value: "null"
631
+ */
632
+ dataFieldFrom?: string;
633
+ /**
634
+ * Data field used in range column series as an end data field.
635
+ * Default value: "null"
636
+ */
637
+ dataFieldTo?: string;
638
+ /**
639
+ * Data field used in bubble series.
640
+ * Default value: "null"
641
+ */
642
+ radiusDataField?: string;
643
+ /**
644
+ * Name to display for this serie.
645
+ * Default value: "null"
646
+ */
647
+ displayText?: string;
648
+ /**
649
+ * Name to display for candlestick and ohlc series.
650
+ * Default value: "null"
651
+ */
652
+ displayTextClose?: string;
653
+ /**
654
+ * Name to display for candlestick and ohlc series.
655
+ * Default value: "null"
656
+ */
657
+ displayTextHigh?: string;
658
+ /**
659
+ * Name to display for candlestick and ohlc series.
660
+ * Default value: "null"
661
+ */
662
+ displayTextLow?: string;
663
+ /**
664
+ * Name to display for candlestick and ohlc series.
665
+ * Default value: "null"
666
+ */
667
+ displayTextOpen?: string;
668
+ /**
669
+ * Callback function used to format the labels.
670
+ * Default value: null
671
+ */
672
+ formatFunction?: {(value?: any, index?: number, series?: any): string};
673
+ /**
674
+ * Object describing the format settings of the labels.
675
+ * Default value: [object Object]
676
+ */
677
+ formatSettings?: ThreeDChartFormatSettings;
678
+ /**
679
+ * Specifies the summary of the series group.
680
+ * Default value: ""
681
+ */
682
+ summary?: string;
683
+ /**
684
+ * Maximum angle in a pie, donut, polar and spider series.
685
+ * Default value: 360
686
+ */
687
+ endAngle?: number;
688
+ /**
689
+ * Initial angle in pie and donut series.
690
+ * Default value: 0
691
+ */
692
+ initialAngle?: number;
693
+ /**
694
+ * Inner radius of donut series in pixels or percents.
695
+ * Default value: 0
696
+ */
697
+ innerRadius?: number;
698
+ /**
699
+ * Object describing the labels properties of the axis.
700
+ * Default value: undefined
701
+ */
702
+ labels?: ThreeDChartLabels;
703
+ /**
704
+ * Fill color of the legend box. The default value is inherited from the serie's color.
705
+ * Default value: null
706
+ */
707
+ legendFillColor?: string | null;
708
+ /**
709
+ * Legend data formatting function for the values in the serie.
710
+ * Default value: null
711
+ */
712
+ legendFormatFunction?: any;
713
+ /**
714
+ * Legend data formatting settings for the values in the serie.
715
+ * Default value: [object Object]
716
+ */
717
+ legendFormatSettings?: ThreeDChartFormatSettings;
718
+ /**
719
+ * Line color of the legend box. The default value is inherited from the serie's color.
720
+ * Default value: null
721
+ */
722
+ legendLineColor?: string | null;
723
+ /**
724
+ * Line color for the serie.
725
+ * Default value: null
726
+ */
727
+ lineColor?: string | null;
728
+ /**
729
+ * Line color for the serie when selected.
730
+ * Default value: null
731
+ */
732
+ lineColorSelected?: string | null;
733
+ /**
734
+ * Line color for the marker symbols in serie.
735
+ * Default value: null
736
+ */
737
+ lineColorSymbol?: string | null;
738
+ /**
739
+ * Determines the line tickness of the items in this serie.
740
+ * Default value: null
741
+ */
742
+ lineWidth?: string | null | number;
743
+ /**
744
+ * Determines the line tickness of the items in this serie when selected.
745
+ * Default value: null
746
+ */
747
+ lineWidthSelected?: string | null | number;
748
+ /**
749
+ * Min radius of bubble series in pixels or percents.
750
+ * Default value: null
751
+ */
752
+ minRadius?: string | null | number;
753
+ /**
754
+ * Max radius of bubble series in pixels or percents.
755
+ * Default value: null
756
+ */
757
+ maxRadius?: string | null | number;
758
+ /**
759
+ * Determines the opacity of the items in this serie.
760
+ * Default value: 1
761
+ */
762
+ opacity?: number;
763
+ /**
764
+ * Outer radius of pie and donut series in pixels or percents.
765
+ * Default value: null
766
+ */
767
+ radius?: number | null;
768
+ /**
769
+ * Radius change on selection of pie and donut series in pixels or percents.
770
+ * Default value: null
771
+ */
772
+ selectedRadiusChange?: number | null;
773
+ /**
774
+ * Minimum angle in a pie, donut, polar and spider series.
775
+ * Default value: 0
776
+ */
777
+ startAngle?: number;
778
+ /**
779
+ * Determines the size of the symbol element.
780
+ * Default value: null
781
+ */
782
+ symbolSize?: number;
783
+ /**
784
+ * Determines the size of the symbol element. This property is applicable to line and area series only.
785
+ * Default value: null
786
+ */
787
+ symbolSizeSelected?: number;
788
+ /**
789
+ * Determines the symbol type displayed for the data points in the serie. This parameter is applicable to line, area, scatter and bubble series only.
790
+ * Default value: none
791
+ */
792
+ symbolType?: ThreeDChartSymbolType | string;
793
+ /**
794
+ * Determines the tooltip's background.
795
+ * Default value: null
796
+ */
797
+ toolTipBackground?: string | null;
798
+ /**
799
+ * Determines the tooltip's CSS class name.
800
+ * Default value: null
801
+ */
802
+ toolTipClass?: string | null;
803
+ /**
804
+ * Tooltip data formatting function for the values in the serie.
805
+ * Default value: null
806
+ */
807
+ toolTipFormatFunction?: {(value?: any, index?: number, series?: any): string};
808
+ /**
809
+ * Tooltip data formatting settings for the values in the serie.
810
+ * Default value: [object Object]
811
+ */
812
+ toolTipFormatSettings?: ThreeDChartFormatSettings;
813
+ /**
814
+ * Determines the tooltip's border lines color.
815
+ * Default value: null
816
+ */
817
+ toolTipLineColor?: string | null;
818
+ /**
819
+ * Determines whether to use color gradients.
820
+ * Default value: false
821
+ */
822
+ useGradientColors?: boolean;
823
+ }
824
+
825
+ /**Object describing the labels properties of the axis. */
826
+ export interface ThreeDChartLabels {
827
+ /**
828
+ * Text rotation angle.
829
+ * Default value: 0
830
+ */
831
+ angle?: number;
832
+ /**
833
+ * Callback function used to format the labels.
834
+ * Default value: null
835
+ */
836
+ formatFunction?: {(value?: any, index?: number, series?: any): string};
837
+ /**
838
+ * Object describing the format settings of the labels.
839
+ * Default value: [object Object]
840
+ */
841
+ formatSettings?: ThreeDChartFormatSettings;
842
+ /**
843
+ * Labels offset.
844
+ * Default value: [object Object]
845
+ */
846
+ offset?: ThreeDChartOffset;
847
+ /**
848
+ * Radius of the labels in pie/donut series.
849
+ * Default value: null
850
+ */
851
+ radius?: number | null;
852
+ /**
853
+ * Interval steps between label placements (multiples of the axis unit interval).
854
+ * Default value: null
855
+ */
856
+ step?: number | null;
857
+ /**
858
+ * Sets the interval between the labels.
859
+ * Default value: null
860
+ */
861
+ unitInterval?: number;
862
+ /**
863
+ * Possible values: true, false, 'custom'.Determines the visibility of labels. When 'custom' is set, displays only custom values/offsets from the labels.custom array.
864
+ * Default value: true
865
+ */
866
+ visible?: boolean | string;
867
+ }
868
+
869
+ /**Labels offset. */
870
+ export interface ThreeDChartOffset {
871
+ /**
872
+ * Horizontal offset.
873
+ * Default value: 0
874
+ */
875
+ x?: number | null;
876
+ /**
877
+ * Vertical offset.
878
+ * Default value: 0
879
+ */
880
+ y?: number | null;
881
+ /**
882
+ * Horizontal offset on Z-axis.
883
+ * Default value: 0
884
+ */
885
+ z?: number | null;
886
+ }
887
+
888
+ /**Sets the padding of the chart's title (caption). */
889
+ export interface ThreeDChartPadding {
890
+ /**
891
+ * Bottom padding.
892
+ * Default value: 10
893
+ */
894
+ bottom?: number;
895
+ /**
896
+ * Left padding.
897
+ * Default value: 5
898
+ */
899
+ left?: number;
900
+ /**
901
+ * Right padding.
902
+ * Default value: 5
903
+ */
904
+ right?: number;
905
+ /**
906
+ * Top padding.
907
+ * Default value: 5
908
+ */
909
+ top?: number;
910
+ }
911
+
912
+ /**An object with settings about the Chart's y-axis (value axis). */
913
+ export interface ThreeDChartValueAxis {
914
+ /**
915
+ * Sets the baseline value for the axis.
916
+ * Default value: 0
917
+ */
918
+ baselineValue?: any;
919
+ /**
920
+ * Sets the text displayed on the axis.
921
+ * Default value: null
922
+ */
923
+ displayText?: string | null;
924
+ /**
925
+ * Custom function to format the displayed values along the axis.
926
+ * Default value: null
927
+ */
928
+ formatFunction?: {(value?: any): string};
929
+ /**
930
+ * Settings used to format the displayed values along the axis.
931
+ * Default value: [object Object]
932
+ */
933
+ formatSettings?: ThreeDChartFormatSettings;
934
+ /**
935
+ * Object describing the grid lines properties of the valueAxis.
936
+ * Default value: [object Object]
937
+ */
938
+ gridLines?: ThreeDChartLines;
939
+ /**
940
+ * Object describing the labels properties of the axis.
941
+ * Default value: [object Object]
942
+ */
943
+ labels?: ThreeDChartLabels;
944
+ /**
945
+ * Determines whether to use logarithmic scale.
946
+ * Default value: false
947
+ */
948
+ logarithmicScale?: boolean;
949
+ /**
950
+ * Base for logarithmic scale.
951
+ * Default value: 10
952
+ */
953
+ logarithmicScaleBase?: number;
954
+ /**
955
+ * Sets the maximum value of the valueAxis.
956
+ * Default value: NaN
957
+ */
958
+ maxValue?: any;
959
+ /**
960
+ * Sets the minimum value of the valueAxis.
961
+ * Default value: NaN
962
+ */
963
+ minValue?: any;
964
+ /**
965
+ * Sets the interval between the units.
966
+ * Default value: null
967
+ */
968
+ unitInterval?: number | null;
969
+ /**
970
+ * Shows or hides the valueAxis.
971
+ * Default value: true
972
+ */
973
+ visible?: boolean;
974
+ }
975
+
976
+ /**Object describing the grid lines properties of the valueAxis. */
977
+ export interface ThreeDChartLines {
978
+ /**
979
+ * Color of the grid lines.
980
+ * Default value: ""
981
+ */
982
+ color?: string;
983
+ /**
984
+ * Interval steps between grid line placements (multiples of the axis unit interval).
985
+ * Default value: null
986
+ */
987
+ step?: number | null;
988
+ /**
989
+ * Possible values: true, false, 'custom'.Determines the visibility of grid lines. When 'custom' is set, displays only custom values/offsets from the gridLines.custom array.
990
+ * Default value: true
991
+ */
992
+ visible?: boolean | string;
993
+ }
994
+
995
+ /**Sets the Chart's xAxis. */
996
+ export interface ThreeDChartXAxis {
997
+ /**
998
+ * Points to a data field in the data source.
999
+ * Default value: ""
1000
+ */
1001
+ dataField?: string;
1002
+ /**
1003
+ * Optional custom xAxis display text.
1004
+ * Default value: null
1005
+ */
1006
+ displayText?: string | null;
1007
+ /**
1008
+ * Specifies whether the values are displayed in reverse order.
1009
+ * Default value: false
1010
+ */
1011
+ flip?: boolean;
1012
+ /**
1013
+ * Custom function to format the displayed values along the axis.
1014
+ * Default value: null
1015
+ */
1016
+ formatFunction?: {(value?: any, index?: number, series?: any): string};
1017
+ /**
1018
+ * Settings used to format the displayed values along the axis.
1019
+ * Default value: [object Object]
1020
+ */
1021
+ formatSettings?: ThreeDChartFormatSettings;
1022
+ /**
1023
+ * Object describing the grid lines properties of the xAxis.
1024
+ * Default value: [object Object]
1025
+ */
1026
+ gridLines?: ThreeDChartLines;
1027
+ /**
1028
+ * Object describing the labels properties of the axis.
1029
+ * Default value: [object Object]
1030
+ */
1031
+ labels?: ThreeDChartLabels;
1032
+ /**
1033
+ * Determines whether to use logarithmic scale.
1034
+ * Default value: false
1035
+ */
1036
+ logarithmicScale?: boolean;
1037
+ /**
1038
+ * Base for logarithmic scale.
1039
+ * Default value: 10
1040
+ */
1041
+ logarithmicScaleBase?: number;
1042
+ /**
1043
+ * Sets the maximum value of the xAxis.
1044
+ * Default value: NaN
1045
+ */
1046
+ maxValue?: any;
1047
+ /**
1048
+ * Sets the minimum value of the xAxis.
1049
+ * Default value: NaN
1050
+ */
1051
+ minValue?: any;
1052
+ /**
1053
+ * Definition of a range selector on the xAxis. The range selector itself is also an instance of smart-chart.
1054
+ * Default value: [object Object]
1055
+ */
1056
+ rangeSelector?: ThreeDChartRangeSelector;
1057
+ /**
1058
+ * The type of the axis. 'auto' - automatically detects and switches to 'basic', 'linear' or 'date'.'date' - when displaying dates.'basic' - displays all data points sequentially.'linear' - linear arrangement by the value of the xAxis data field.
1059
+ * Default value: auto
1060
+ */
1061
+ type?: ThreeDChartXAxisType | string;
1062
+ /**
1063
+ * Sets the interval between the units.
1064
+ * Default value: null
1065
+ */
1066
+ unitInterval?: number | null;
1067
+ /**
1068
+ * Shows or hides the xAxis.
1069
+ * Default value: true
1070
+ */
1071
+ visible?: boolean;
1072
+ }
1073
+
1074
+ /**Definition of a range selector on the xAxis. The range selector itself is also an instance of ${namespace.toLowerCase()}-chart. */
1075
+ export interface ThreeDChartRangeSelector {
1076
+ /**
1077
+ * Sets the color of the range selector chart. If null, it will be set to the same color as the chart
1078
+ * Default value: null
1079
+ */
1080
+ color?: string | null;
1081
+ /**
1082
+ * Callback function used to format the values.
1083
+ * Default value: null
1084
+ */
1085
+ formatFunction?: {(value?: any, index?: number, series?: any): string};
1086
+ /**
1087
+ * Chart Format Settings
1088
+ * Default value: null
1089
+ */
1090
+ formatSettings?: any;
1091
+ /**
1092
+ * Object describing the labels properties of the axis.
1093
+ * Default value: [object Object]
1094
+ */
1095
+ labels?: ThreeDChartLabels;
1096
+ /**
1097
+ * Sets the opacity of the range selector chart.
1098
+ * Default value: 1
1099
+ */
1100
+ opacity?: number;
1101
+ /**
1102
+ * Sets the range selector chart type
1103
+ * Default value: area
1104
+ */
1105
+ serieType?: ThreeDChartRangeSelectorSerieType | string;
1106
+ /**
1107
+ * Shows or hides the range selector.
1108
+ * Default value: false
1109
+ */
1110
+ visible?: boolean;
1111
+ }
1112
+
1113
+ /**Sets the Chart's zAxis. */
1114
+ export interface ThreeDChartZAxis {
1115
+ /**
1116
+ * Points to a data field in the data source.
1117
+ * Default value: ""
1118
+ */
1119
+ dataField?: string;
1120
+ /**
1121
+ * Optional custom zAxis display text.
1122
+ * Default value: null
1123
+ */
1124
+ displayText?: string | null;
1125
+ /**
1126
+ * Specifies whether the values are displayed in reverse order.
1127
+ * Default value: false
1128
+ */
1129
+ flip?: boolean;
1130
+ /**
1131
+ * Custom function to format the displayed values along the axis.
1132
+ * Default value: null
1133
+ */
1134
+ formatFunction?: {(value?: any, index?: number, series?: any): string};
1135
+ /**
1136
+ * Settings used to format the displayed values along the axis.
1137
+ * Default value: [object Object]
1138
+ */
1139
+ formatSettings?: ThreeDChartFormatSettings;
1140
+ /**
1141
+ * Object describing the grid lines properties of the zAxis.
1142
+ * Default value: [object Object]
1143
+ */
1144
+ gridLines?: ThreeDChartLines;
1145
+ /**
1146
+ * Object describing the labels properties of the axis.
1147
+ * Default value: [object Object]
1148
+ */
1149
+ labels?: ThreeDChartLabels;
1150
+ /**
1151
+ * Determines whether to use logarithmic scale.
1152
+ * Default value: false
1153
+ */
1154
+ logarithmicScale?: boolean;
1155
+ /**
1156
+ * Base for logarithmic scale.
1157
+ * Default value: 10
1158
+ */
1159
+ logarithmicScaleBase?: number;
1160
+ /**
1161
+ * Sets the maximum value of the zAxis.
1162
+ * Default value: NaN
1163
+ */
1164
+ maxValue?: any;
1165
+ /**
1166
+ * Sets the minimum value of the zAxis.
1167
+ * Default value: NaN
1168
+ */
1169
+ minValue?: any;
1170
+ /**
1171
+ * Sets the interval between the units.
1172
+ * Default value: null
1173
+ */
1174
+ unitInterval?: number | null;
1175
+ /**
1176
+ * Shows or hides the zAxis.
1177
+ * Default value: true
1178
+ */
1179
+ visible?: boolean;
1180
+ }
1
1181
 
2
- import { NgElement } from '@angular/elements';
1182
+ declare global {
1183
+ interface Document {
1184
+ createElement(tagName: "smart-3d-chart"): ThreeDChart;
1185
+ querySelector(selectors: "smart-3d-chart"): ThreeDChart | null;
1186
+ querySelectorAll(selectors: "smart-3d-chart"): NodeListOf<ThreeDChart>;
1187
+ getElementsByTagName(qualifiedName: "smart-3d-chart"): HTMLCollectionOf<ThreeDChart>;
1188
+ getElementsByName(elementName: "smart-3d-chart"): NodeListOf<ThreeDChart>;
1189
+ }
1190
+ }
3
1191
 
1192
+ /**Sets or gets the animation mode. Animation is disabled when the property is set to 'none'. */
1193
+ export declare type Animation = 'none' | 'simple' | 'advanced';
1194
+ /**Sets the chart's color pallete. jqxChart suppports 32 color schemes from 'scheme01' to 'scheme32'. */
1195
+ export declare type ThreeDChartColorScheme = 'scheme01' | 'scheme02' | 'scheme03' | 'scheme04' | 'scheme05' | 'scheme06' | 'scheme07' | 'scheme08' | 'scheme09' | 'scheme10' | 'scheme11' | 'scheme12' | 'scheme13' | 'scheme14' | 'scheme15' | 'scheme16' | 'scheme17' | 'scheme18' | 'scheme19' | 'scheme20' | 'scheme21' | 'scheme22' | 'scheme23' | 'scheme24' | 'scheme25' | 'scheme26' | 'scheme27' | 'scheme28' | 'scheme29' | 'scheme30' | 'scheme31' | 'scheme32' | 'custom';
1196
+ /**Sets whether the legend will be created based on the chart's series or serie groups. "auto" - the legend index will change depending on the Chart type */
1197
+ export declare type ThreeDChartLegendIndex = 'auto' | 'serie' | 'group';
1198
+ /**Determines the selection mode. */
1199
+ export declare type ThreeDChartSelectionMode = 'none' | 'single' | 'multiple';
1200
+ /**Determines the symbol type displayed for the data points in the serie. This parameter is applicable to line, area, scatter and bubble series only. */
1201
+ export declare type ThreeDChartSymbolType = 'none' | 'circle' | 'square' | 'diamond' | 'triangle_up' | 'triangle_down' | 'triangle_left' | 'triangle_right';
1202
+ /**Sets the chart type. jqxChart supports several common chart types. You can easily plot series of different types on a common chart. A type must be specified for each series group. Currently, jqxChart supports the following series types:'column' - simple column series
1203
+ 'stackedcolumn' - stacked column series
1204
+ 'stackedcolumn100' - percentage stacked columns
1205
+ 'rangecolumn' - floating column between two values
1206
+ 'waterfall' - waterfall series
1207
+ 'stackedwaterfall' - stacked waterfall series
1208
+ 'line' - simple straight lines connecting the value points
1209
+ 'stackedline' - stacked lines
1210
+ 'stackedline100' - percentage stacked lines
1211
+ 'spline' - smooth lines connecting the value points
1212
+ 'stackedspline' - smooth stacked lines
1213
+ 'stackedspline100' - percentage stacked smooth lines
1214
+ 'stepline' - step line
1215
+ 'stackedstepline' - stacked step line
1216
+ 'stackedstepline100' - percentage stacked step line
1217
+ 'area' - area connecting the value points with straight lines
1218
+ 'stackedarea' - stacked area with straight lines between the points
1219
+ 'stackedarea100' - percentage stacked area with straight lines between the points
1220
+ 'rangearea' - floating area between pairs of value points
1221
+ 'splinearea' - smooth area connecting the value points
1222
+ 'stackedsplinearea' - stacked smooth area connecting the value points
1223
+ 'stackedsplinearea100' - percentage stacked smooth area
1224
+ 'splinerangearea' - smooth floating area between pairs of value points
1225
+ 'steprangearea' - step area between pairs of value points
1226
+ 'stackedsplineara' - smooth stacked area
1227
+ 'steparea' - step area connecting the value points
1228
+ 'stackedsteparea' - step stacked area
1229
+ 'stackedsteparea100' - percentage stacked step area
1230
+ 'pie' - circular chart divided into sectors, illustrating proportion
1231
+ 'donut' - chart divided into circular sectors with different inner and outer radius
1232
+ 'scatter' - data is displayed as a collection of points
1233
+ 'stackedscatter' - data is displayed as a collection of points and the values are stacked
1234
+ 'stackedscatter100' - data is displayed as a collection of points and the values are percentage stacked
1235
+ 'bubble' - data is displayed as a collection of bubbles
1236
+ 'stackedbubble' - data is displayed as a collection of bubbles and the values are stacked
1237
+ 'stackedbubble100' - data is displayed as a collection of bubbles and the values are percentage stacked
1238
+ 'candlestick' - display candlestick series using open, high, low, close data points
1239
+ 'ohlc' - display OHLC series using open, high, low, close data points
1240
+ */
1241
+ export declare type ThreeDChartType = 'column' | 'stackedcolumn' | 'stackedcolumn100' | 'rangecolumn' | 'waterfall' | 'stackedwaterfall' | 'line' | 'stackedline' | 'stackedline100' | 'spline' | 'stackedspline' | 'stackedspline100' | 'stepline' | 'stackedstepline' | 'stackedstepline100' | 'area' | 'stackedarea' | 'stackedarea100' | 'rangearea' | 'splinearea' | 'stackedsplinearea' | 'stackedsplinearea100' | 'splinerangearea' | 'steprangearea' | 'stackedsplineara' | 'steparea' | 'stackedsteparea' | 'stackedsteparea100' | 'pie' | 'donut' | 'scatter' | 'stackedscatter' | 'stackedscatter100' | 'bubble' | 'stackedbubble' | 'stackedbubble100' | 'candlestick' | 'ohlc';
1242
+ /**Sets the range selector chart type */
1243
+ export declare type ThreeDChartRangeSelectorSerieType = 'line' | 'area';
1244
+ /**The type of the axis. 'auto' - automatically detects and switches to 'basic', 'linear' or 'date'.
1245
+ 'date' - when displaying dates.
1246
+ 'basic' - displays all data points sequentially.
1247
+ 'linear' - linear arrangement by the value of the xAxis data field.
1248
+ */
1249
+ export declare type ThreeDChartXAxisType = 'auto' | 'date' | 'basic' | 'linear';
4
1250
  export interface AccordionProperties {
5
1251
  /**
6
1252
  * Sets or gets the animation mode. Animation is disabled when the property is set to 'none'
@@ -184,8 +1430,6 @@ declare global {
184
1430
  }
185
1431
  }
186
1432
 
187
- /**Sets or gets the animation mode. Animation is disabled when the property is set to 'none' */
188
- export declare type Animation = 'none' | 'simple' | 'advanced';
189
1433
  /**Sets or gets the expand mode. Expand mode determines how the items will expand or collapse. */
190
1434
  export declare type AccordionExpandMode = 'single' | 'singleFitHeight' | 'multiple' | 'toggle' | 'none';
191
1435
  export interface AccordionItemProperties {
@@ -5755,6 +6999,11 @@ export interface ComboBoxProperties {
5755
6999
  * Default value: 2
5756
7000
  */
5757
7001
  minLength?: number;
7002
+ /**
7003
+ * Determines the maximum number of characters inside the input.
7004
+ * Default value: -1
7005
+ */
7006
+ maxLength?: number;
5758
7007
  /**
5759
7008
  * Sets or gets the name attribute for the element. Name is used when submiting HTML forms.
5760
7009
  * Default value: ""
@@ -6681,11 +7930,6 @@ export declare type DataAdapterVirtualDataSourceOnExpandDetailsAction = 'sort' |
6681
7930
  /**Request action type */
6682
7931
  export declare type DataAdapterVirtualDataSourceDetailsAction = 'sort' | 'filter' | 'dataBind' | 'scroll' | 'group' | 'expand' | 'pageIndexChange' | 'pageSizeChange';
6683
7932
  export interface DateInputProperties {
6684
- /**
6685
- * Sets or gets the animation mode. Animation is disabled when the property is set to 'none'
6686
- * Default value: advanced
6687
- */
6688
- animation?: Animation | string;
6689
7933
  /**
6690
7934
  * Determines whether the calendar button pop-up will be closed automatically when date or time is selected through it.
6691
7935
  * Default value: false
@@ -6700,7 +7944,7 @@ export interface DateInputProperties {
6700
7944
  * Determines the format of the dates displayed in the input. Accepts valid ECMAScript Internationalization API format. Intl.DateTimeFormat is used to format date strings in JavaScript. By default the date format is 'numeric'. The default value is: { day: 'numeric', month: 'numeric', year: 'numeric' }
6701
7945
  * Default value: { day: 'numeric', month: 'numeric', year: 'numeric' }
6702
7946
  */
6703
- dateTimeFormat?: DateTimeFormat;
7947
+ dateTimeFormat?: any;
6704
7948
  /**
6705
7949
  * Enables or disables the element.
6706
7950
  * Default value: false
@@ -6721,6 +7965,11 @@ export interface DateInputProperties {
6721
7965
  * Default value:
6722
7966
  */
6723
7967
  dropDownWidth?: string | number;
7968
+ /**
7969
+ * Sets the format string. When this property is set, the dateTimeFormat property will be disabled and the formatting will use the value of the formatString. Built-in Date formats:// short date pattern'd' - 'M/d/yyyy',// long date pattern'D' - 'dddd, MMMM dd, yyyy',// short time pattern't' - 'h:mm tt',// long time pattern'T' - 'h:mm:ss tt',// long date, short time pattern'f' - 'dddd, MMMM dd, yyyy h:mm tt',// long date, long time pattern'F' - 'dddd, MMMM dd, yyyy h:mm:ss tt',// month/day pattern'M' - 'MMMM dd',// month/year pattern'Y' - 'yyyy MMMM',// S is a sortable format that does not vary by culture'S' - 'yyyy'-'MM'-'dd'T'HH':'mm':'ss'Date format strings:'d'-the day of the month;'dd'-the day of the month'ddd'-the abbreviated name of the day of the week'dddd'- the full name of the day of the week'h'-the hour, using a 12-hour clock from 1 to 12'hh'-the hour, using a 12-hour clock from 01 to 12'H'-the hour, using a 24-hour clock from 0 to 23'HH'- the hour, using a 24-hour clock from 00 to 23'm'-the minute, from 0 through 59'mm'-the minutes,from 00 though59'M'- the month, from 1 through 12'MM'- the month, from 01 through 12'MMM'-the abbreviated name of the month'MMMM'-the full name of the month's'-the second, from 0 through 59'ss'-the second, from 00 through 59't'- the first character of the AM/PM designator'tt'-the AM/PM designator'y'- the year, from 0 to 99'yy'- the year, from 00 to 99'yyy'-the year, with a minimum of three digits'yyyy'-the year as a four-digit number;'yyyyy'-the year as a four-digit number.
7970
+ * Default value: ""
7971
+ */
7972
+ formatString?: string;
6724
7973
  /**
6725
7974
  * Sets the purpose of the input and what, if any, permission the user agent has to provide automated assistance in filling out the element's input when in a form, as well as guidance to the browser as to the type of information expected in the element. This value corresponds to the standard HTML autocomplete attribute and can be set to values such as 'on', 'name', 'organization', 'street-address', etc.
6726
7975
  * Default value: "off"
@@ -6849,25 +8098,6 @@ export interface DateInput extends BaseElement, DateInputProperties {
6849
8098
  setValue(value: string | Date): void;
6850
8099
  }
6851
8100
 
6852
- /**Determines the format of the dates displayed in the input. Accepts valid ECMAScript Internationalization API format. Intl.DateTimeFormat is used to format date strings in JavaScript. By default the date format is 'numeric'. The default value is: { day: 'numeric', month: 'numeric', year: 'numeric' } */
6853
- export interface DateTimeFormat {
6854
- /**
6855
- * Day format.
6856
- * Default value: numeric
6857
- */
6858
- day?: DateTimeFormatDay | string;
6859
- /**
6860
- * Month format.
6861
- * Default value: numeric
6862
- */
6863
- month?: DateTimeFormatMonth | string;
6864
- /**
6865
- * Year format.
6866
- * Default value: numeric
6867
- */
6868
- year?: DateTimeFormatYear | string;
6869
- }
6870
-
6871
8101
  declare global {
6872
8102
  interface Document {
6873
8103
  createElement(tagName: "smart-date-input"): DateInput;
@@ -6878,12 +8108,6 @@ declare global {
6878
8108
  }
6879
8109
  }
6880
8110
 
6881
- /**Day format. */
6882
- export declare type DateTimeFormatDay = 'numeric' | '2-digit';
6883
- /**Month format. */
6884
- export declare type DateTimeFormatMonth = 'numeric' | '2-digit' | 'narrow' | 'short' | 'long';
6885
- /**Year format. */
6886
- export declare type DateTimeFormatYear = 'numeric' | '2-digit';
6887
8111
  export interface DateRangeInputProperties {
6888
8112
  /**
6889
8113
  * Sets or gets the animation mode. Animation is disabled when the property is set to 'none'
@@ -7220,7 +8444,7 @@ export interface DateTimePickerProperties {
7220
8444
  */
7221
8445
  footer?: boolean;
7222
8446
  /**
7223
- * Determines the pattern that is used to display the value in.
8447
+ * Determines the pattern that is used to display the value in. Built-in Date formats:// short date pattern'd' - 'M/d/yyyy',// long date pattern'D' - 'dddd, MMMM dd, yyyy',// short time pattern't' - 'h:mm tt',// long time pattern'T' - 'h:mm:ss tt',// long date, short time pattern'f' - 'dddd, MMMM dd, yyyy h:mm tt',// long date, long time pattern'F' - 'dddd, MMMM dd, yyyy h:mm:ss tt',// month/day pattern'M' - 'MMMM dd',// month/year pattern'Y' - 'yyyy MMMM',// S is a sortable format that does not vary by culture'S' - 'yyyy'-'MM'-'dd'T'HH':'mm':'ss'Date format strings:'d'-the day of the month;'dd'-the day of the month'ddd'-the abbreviated name of the day of the week'dddd'- the full name of the day of the week'h'-the hour, using a 12-hour clock from 1 to 12'hh'-the hour, using a 12-hour clock from 01 to 12'H'-the hour, using a 24-hour clock from 0 to 23'HH'- the hour, using a 24-hour clock from 00 to 23'm'-the minute, from 0 through 59'mm'-the minutes,from 00 though59'M'- the month, from 1 through 12'MM'- the month, from 01 through 12'MMM'-the abbreviated name of the month'MMMM'-the full name of the month's'-the second, from 0 through 59'ss'-the second, from 00 through 59't'- the first character of the AM/PM designator'tt'-the AM/PM designator'y'- the year, from 0 to 99'yy'- the year, from 00 to 99'yyy'-the year, with a minimum of three digits'yyyy'-the year as a four-digit number;'yyyyy'-the year as a four-digit number.
7224
8448
  * Default value: "dd-MMM-yy HH:mm:ss.fff"
7225
8449
  */
7226
8450
  formatString?: string;
@@ -8595,6 +9819,11 @@ export interface EditorProperties {
8595
9819
  * Default value: null
8596
9820
  */
8597
9821
  charCountFormatFunction?: any;
9822
+ /**
9823
+ * Sets or gets whether files will be automatically uploaded after selection.
9824
+ * Default value: false
9825
+ */
9826
+ autoUpload?: boolean;
8598
9827
  /**
8599
9828
  * Determines the content filtering settings.
8600
9829
  * Default value: [object Object]
@@ -8942,6 +10171,16 @@ export interface EditorProperties {
8942
10171
  * Default value: 100
8943
10172
  */
8944
10173
  splitModeRefreshTimeout?: number;
10174
+ /**
10175
+ * Sets or gets the upload URL. This property corresponds to the upload form's action attribute. For example, the uploadUrl property can point to a PHP file, which handles the upload operation on the server-side.
10176
+ * Default value: ""
10177
+ */
10178
+ uploadUrl?: string;
10179
+ /**
10180
+ * Sets or gets the remove URL. This property corresponds to the form's action attribute. For example, the removeUrl property can point to a PHP file, which handles the remove operation on the server-side.
10181
+ * Default value: ""
10182
+ */
10183
+ removeUrl?: string;
8945
10184
  /**
8946
10185
  * Determines the theme. Theme defines the look of the element
8947
10186
  * Default value: ""
@@ -9146,7 +10385,7 @@ export interface Editor extends BaseElement, EditorProperties {
9146
10385
  onDialogClosing?: ((this: any, ev: Event) => any) | ((this: any, ev: CustomEvent<any>) => any) | null;
9147
10386
  /**
9148
10387
  * This event is triggered when the uploading of an image/video is successful.
9149
- * @param event. The custom event. Custom data event was created with: ev.detail(target, item, filename, type, size, index, status)
10388
+ * @param event. The custom event. Custom data event was created with: ev.detail(target, item, filename, type, size, index, status, serverResponse)
9150
10389
  * target - The file upload element that is the target of the operation.
9151
10390
  * item - The toolbar item that is the target of the operation.
9152
10391
  * filename - The name of the uploaded file.
@@ -9154,11 +10393,12 @@ export interface Editor extends BaseElement, EditorProperties {
9154
10393
  * size - The size of the uploaded file.
9155
10394
  * index - The index of the uploaded file.
9156
10395
  * status - The status of the uploaded file. Whether there was an error or success.
10396
+ * serverResponse - The response of the remote server.
9157
10397
  */
9158
10398
  onImageUploadSuccess?: ((this: any, ev: Event) => any) | ((this: any, ev: CustomEvent<any>) => any) | null;
9159
10399
  /**
9160
10400
  * This event is triggered when the uploading of an image/video is unsuccessful.
9161
- * @param event. The custom event. Custom data event was created with: ev.detail(target, item, filename, type, size, index, status)
10401
+ * @param event. The custom event. Custom data event was created with: ev.detail(target, item, filename, type, size, index, status, serverResponse)
9162
10402
  * target - The file upload element that is the target of the operation.
9163
10403
  * item - The toolbar item that is the target of the operation.
9164
10404
  * filename - The name of the canceled file.
@@ -9166,6 +10406,7 @@ export interface Editor extends BaseElement, EditorProperties {
9166
10406
  * size - The size of the canceled file.
9167
10407
  * index - The index of the canceled file.
9168
10408
  * status - The status of the uploaded file. Whether there was an error or success.
10409
+ * serverResponse - The response of the remote server.
9169
10410
  */
9170
10411
  onImageUploadFailed?: ((this: any, ev: Event) => any) | ((this: any, ev: CustomEvent<any>) => any) | null;
9171
10412
  /**
@@ -9673,7 +10914,7 @@ declare global {
9673
10914
  }
9674
10915
  }
9675
10916
 
9676
- export interface BaseElement extends NgElement, ElementProperties {
10917
+ export interface BaseElement extends HTMLElement, ElementProperties {
9677
10918
  /**
9678
10919
  * This event is triggered when the element is resized.
9679
10920
  * @param event. The custom event. */
@@ -9850,6 +11091,11 @@ export interface FileUploadProperties {
9850
11091
  * Default value: false
9851
11092
  */
9852
11093
  unfocusable?: boolean;
11094
+ /**
11095
+ * Sets or gets the remove URL. This property corresponds to the form's action attribute. For example, the removeUrl property can point to a PHP file, which handles the remove operation on the server-side.
11096
+ * Default value: ""
11097
+ */
11098
+ removeUrl?: string;
9853
11099
  /**
9854
11100
  * Gets the file upload value.
9855
11101
  * Default value: null
@@ -9888,12 +11134,13 @@ export interface FileUpload extends BaseElement, FileUploadProperties {
9888
11134
  onUploadCanceled?: ((this: any, ev: Event) => any) | ((this: any, ev: CustomEvent<any>) => any) | null;
9889
11135
  /**
9890
11136
  * This event is triggered when a file upload operation is completed.
9891
- * @param event. The custom event. Custom data event was created with: ev.detail(filename, type, size, index, status)
11137
+ * @param event. The custom event. Custom data event was created with: ev.detail(filename, type, size, index, status, serverResponse)
9892
11138
  * filename - The name of the canceled file.
9893
11139
  * type - The type of the canceled file.
9894
11140
  * size - The size of the canceled file.
9895
11141
  * index - The index of the canceled file.
9896
11142
  * status - The status of the uploaded file. Whether there was an error or success.
11143
+ * serverResponse - The response of the remote server.
9897
11144
  */
9898
11145
  onUploadCompleted?: ((this: any, ev: Event) => any) | ((this: any, ev: CustomEvent<any>) => any) | null;
9899
11146
  /**
@@ -11356,7 +12603,7 @@ export interface FormProperties {
11356
12603
  */
11357
12604
  controls?: Control[];
11358
12605
  /**
11359
- * Callback function for handling status changes
12606
+ * Callback function for handling status changes. The status could be 'disabled', 'invalid', 'pending', 'valid'.
11360
12607
  * Default value: null
11361
12608
  */
11362
12609
  onStatusChanges?: any;
@@ -13764,6 +15011,11 @@ export interface GridProperties {
13764
15011
  * Default value: []
13765
15012
  */
13766
15013
  columns?: {label: string, dataField: string}[] | string[] | number | GridColumn[];
15014
+ /**
15015
+ * Context Menu is the drop-down menu displayed after right-clicking a Grid row. It allows you to delete row, edit cell or row depending on the edit mode. The 'contextMenuItemCustom' dataSource option allows you to add custom menu item to the context menu. You can replace the context menu by using the 'selector' property and setting it to ID of a Smart.Menu component.
15016
+ * Default value: [object Object]
15017
+ */
15018
+ contextMenu?: GridContextMenu;
13767
15019
  /**
13768
15020
  * Column Menu is the drop-down menu displayed after clicking the column header's drop-down button, which is displayed when you hover the column header. It allows you to customize column settings. For example: Sort, Filter or Group the Grid by the current column.
13769
15021
  * Default value: [object Object]
@@ -13864,6 +15116,11 @@ export interface GridProperties {
13864
15116
  * Default value: null
13865
15117
  */
13866
15118
  onRender?: any;
15119
+ /**
15120
+ * Callback function() called when the grid has been rendered for first time and bindings are completed. The component is ready.
15121
+ * Default value: null
15122
+ */
15123
+ onLoad?: any;
13867
15124
  /**
13868
15125
  * Callback function(event: KeyboardEvent) called when the grid is on focus and a keyboard key is pressed.
13869
15126
  * Default value: null
@@ -13884,6 +15141,16 @@ export interface GridProperties {
13884
15141
  * Default value: null
13885
15142
  */
13886
15143
  onRowDetailUpdated?: {(index: number, row: GridRow, details: HTMLElement): void};
15144
+ /**
15145
+ * Callback function which is called when a row history is updated. The row history for edits is recorded when the 'storeHistory' property is enabled.
15146
+ * Default value: null
15147
+ */
15148
+ onRowHistory?: {(index: number, row: GridRow, history: any[]): void};
15149
+ /**
15150
+ * Callback function which is called when a row style is updated. The row style can be changed by using the row dialog or the 'setRowStyle' method.
15151
+ * Default value: null
15152
+ */
15153
+ onRowStyle?: {(index: number, row: GridRow, history: any[]): void};
13887
15154
  /**
13888
15155
  * Callback function which is called when a row has been inserted.
13889
15156
  * Default value: null
@@ -13904,6 +15171,16 @@ export interface GridProperties {
13904
15171
  * Default value: null
13905
15172
  */
13906
15173
  onRowUpdated?: {(index: number[], row: GridRow[]): void};
15174
+ /**
15175
+ * Callback function called by the Grid when defined. It is used to get the CSS class applied to a row.
15176
+ * Default value: null
15177
+ */
15178
+ onRowClass?: {(index: number, data: any, row: GridRow[]): void};
15179
+ /**
15180
+ * Callback function called by the Grid when defined. It is used to get the CSS class applied to a cell.
15181
+ * Default value: null
15182
+ */
15183
+ onCellClass?: {(index: number, dataField: string, cellValue: any, data: any, row: GridRow[]): void};
13907
15184
  /**
13908
15185
  * Callback function, which is called when a column has been initialized. This function can be used to customize the column settings.
13909
15186
  * Default value: null
@@ -13924,11 +15201,21 @@ export interface GridProperties {
13924
15201
  * Default value: null
13925
15202
  */
13926
15203
  onColumnUpdated?: {(index: number, column: GridColumn): void};
15204
+ /**
15205
+ * Callback function, which is called when a column has been cloned.
15206
+ * Default value: null
15207
+ */
15208
+ onColumnClone?: {(dataField: string, cloneColumnDataField: string, index: number, duplicateCells: boolean): void};
13927
15209
  /**
13928
15210
  * Callback function, which is called when a command is executed. The name argument is the command's name. The command argument is the command's function. details are built in command arguments passed by the Grid. The handled parameter allows you to cancel built-in command, because when you set it to true the Grid will not execute the default command's behavior.
13929
15211
  * Default value: null
13930
15212
  */
13931
15213
  onCommand?: {(name: string, command: any, details: GridCell, event: Event | KeyboardEvent | PointerEvent, handled: boolean): void};
15214
+ /**
15215
+ * Sets or gets the rows CSS class rules. Different CSS class names are conditionally applied. Example: rowCSSRules: { 'cell-class-1': settings =&gt; settings.data.quantity === 5, 'cell-class-2': settings =&gt; settings.data.quantity &lt; 5, 'cell-class-3': settings =&gt; settings.data.quantity &gt; 5 }. The settings object contains the following properties: index, data, row, api.
15216
+ * Default value: null
15217
+ */
15218
+ rowCSSRules?: any;
13932
15219
  /**
13933
15220
  * Sets or gets the id of the current user. Has to correspond to the id of an item from the users property/array. Depending on the current user, different privileges are enabled. If no current user is set, privileges depend on the element's properties.
13934
15221
  * Default value:
@@ -13939,6 +15226,11 @@ export interface GridProperties {
13939
15226
  * Default value: []
13940
15227
  */
13941
15228
  users?: any[];
15229
+ /**
15230
+ * Sets the grid's image and filter upload settings for the image and attachment columns.
15231
+ * Default value: [object Object]
15232
+ */
15233
+ uploadSettings?: GridUploadSettings;
13942
15234
  /**
13943
15235
  * Describes the paging settings.
13944
15236
  * Default value: [object Object]
@@ -13969,6 +15261,11 @@ export interface GridProperties {
13969
15261
  * Default value: [object Object]
13970
15262
  */
13971
15263
  summaryRow?: GridSummaryRow;
15264
+ /**
15265
+ * Sets the grid's state settings.
15266
+ * Default value: [object Object]
15267
+ */
15268
+ stateSettings?: GridStateSettings;
13972
15269
  /**
13973
15270
  * Describes the settings for the group header.
13974
15271
  * Default value: [object Object]
@@ -14013,13 +15310,15 @@ export interface Grid extends BaseElement, GridProperties {
14013
15310
  /* Get a member by its name */
14014
15311
  [name: string]: any;
14015
15312
  /**
14016
- * This event is triggered, when the edit begins.
14017
- * @param event. The custom event. Custom data event was created with: ev.detail(id, dataField, row, column, cell)
15313
+ * This event is triggered, when the edit begins. After the event occurs, editing starts. If you need to prevent the editing for specific cells, rows or columns, you can call event.preventDefault();.
15314
+ * @param event. The custom event. Custom data event was created with: ev.detail(id, dataField, row, column, cell, data, value)
14018
15315
  * id - The edited row id.
14019
15316
  * dataField - The edited column data field.
14020
15317
  * row - The edited row.
14021
15318
  * column - The edited column.
14022
15319
  * cell - The edited cell.
15320
+ * data - The edited row's data.
15321
+ * value - The edited cell's value.
14023
15322
  */
14024
15323
  onBeginEdit?: ((this: any, ev: Event) => any) | ((this: any, ev: CustomEvent<any>) => any) | null;
14025
15324
  /**
@@ -14122,6 +15421,14 @@ export interface Grid extends BaseElement, GridProperties {
14122
15421
  * comment - The comment object. The comment object has 'text: string', 'id: string', 'userId: string | number', and 'time: date' fields. The 'text' is the comment's text. 'id' is the comment's unique id, 'userId' is the user's id who entered the comment and 'time' is a javascript date object.
14123
15422
  */
14124
15423
  onCommentRemove?: ((this: any, ev: Event) => any) | ((this: any, ev: CustomEvent<any>) => any) | null;
15424
+ /**
15425
+ * This event is triggered, when the user clicks on a context menu item.
15426
+ * @param event. The custom event. Custom data event was created with: ev.detail(id, dataField, command)
15427
+ * id - The row's id.
15428
+ * dataField - The column's data field.
15429
+ * command - Command function.
15430
+ */
15431
+ onContextMenuItemClick?: ((this: any, ev: Event) => any) | ((this: any, ev: CustomEvent<any>) => any) | null;
14125
15432
  /**
14126
15433
  * This event is triggered, when the user starts a row drag.
14127
15434
  * @param event. The custom event. Custom data event was created with: ev.detail(row, id, index, originalEvent)
@@ -14245,12 +15552,14 @@ export interface Grid extends BaseElement, GridProperties {
14245
15552
  onCellDoubleClick?: ((this: any, ev: Event) => any) | ((this: any, ev: CustomEvent<any>) => any) | null;
14246
15553
  /**
14247
15554
  * This event is triggered, when the edit ends.
14248
- * @param event. The custom event. Custom data event was created with: ev.detail(id, dataField, row, column, cell)
15555
+ * @param event. The custom event. Custom data event was created with: ev.detail(id, dataField, row, column, cell, data, value)
14249
15556
  * id - The edited row id.
14250
15557
  * dataField - The edited column data field.
14251
15558
  * row - The edited row.
14252
15559
  * column - The edited column.
14253
15560
  * cell - The edited cell.
15561
+ * data - The edited row's data.
15562
+ * value - The edited cell's value.
14254
15563
  */
14255
15564
  onEndEdit?: ((this: any, ev: Event) => any) | ((this: any, ev: CustomEvent<any>) => any) | null;
14256
15565
  /**
@@ -14324,9 +15633,9 @@ export interface Grid extends BaseElement, GridProperties {
14324
15633
  * Adds a row. When batch editing is enabled, the row is not saved until the batch edit is saved.
14325
15634
  * @param {any} data. row data matching the data source
14326
15635
  * @param {boolean} insertAtBottom?. Determines whether to add the new row to the bottom or top of the collection. The default value is 'true'
14327
- * @param {any} callback?. Sets a callback function, which is called after the new row is added. The callback's argument is the new row.
15636
+ * @param callback?. Sets a callback function, which is called after the new row is added. The callback's argument is the new row.
14328
15637
  */
14329
- addRow(data: any, insertAtBottom?: boolean, callback?: any): void;
15638
+ addRow(data: any, insertAtBottom?: boolean, callback?: {(row: GridRow): void}): void;
14330
15639
  /**
14331
15640
  * Adds a new row and puts it into edit mode. When batch editing is enabled, the row is not saved until the batch edit is saved.
14332
15641
  * @param {string} position?. 'near' or 'far'
@@ -14347,7 +15656,7 @@ export interface Grid extends BaseElement, GridProperties {
14347
15656
  */
14348
15657
  addUnboundRow(count: number, position?: string): boolean;
14349
15658
  /**
14350
- * Adds a filter to a column. This method will apply a filter to the Grid data.
15659
+ * Adds a filter to a column. This method will apply a filter to the Grid data. Example for adding multiple filters to a column: grid.addFilter('lastName', ['CONTAINS "burke"', 'or', 'CONTAINS "peterson"']). Example for adding single filter to a column: grid.addFilter('lastName', 'CONTAINS "burke"'). Example for adding numeric filter: grid.addFilter('quantity', '&lt;= 5')
14351
15660
  * @param {string} dataField. column bound data field. For example, if you have a column with dataField: 'firstName', set 'firstName' here.
14352
15661
  * @param {string} filter. Filter expression like: 'startsWith B'. Example 2: ['contains Andrew or contains Nancy'], Example 3: ['quantity', '&lt;= 3 and &gt;= 8']. Filter conditions which you can use in the expressions: '=', 'EQUAL','&lt;&gt;', 'NOT_EQUAL', '!=', '&lt;', 'LESS_THAN','&gt;', 'GREATER_THAN', '&lt;=', 'LESS_THAN_OR_EQUAL', '&gt;=', 'GREATER_THAN_OR_EQUAL','starts with', 'STARTS_WITH','ends with', 'ENDS_WITH', '', 'EMPTY', 'CONTAINS','DOES_NOT_CONTAIN', 'NULL','NOT_NULL'
14353
15662
  * @param {boolean} refreshFilters?. Set this to false, if you will use multiple 'addFilter' calls. By doing this, you will avoid unnecessary renders.
@@ -14372,6 +15681,11 @@ export interface Grid extends BaseElement, GridProperties {
14372
15681
  * Auto-sizes grid columns. This method will update the <em>width</em> of all Grid columns.
14373
15682
  */
14374
15683
  autoSizeColumns(): void;
15684
+ /**
15685
+ * Auto-sizes grid column. This method will update the <em>width</em> of a Grid column by measuring the cells and column header label width.
15686
+ * @param {string} dataField?. column bound data field. For example, if you have a column with dataField: 'firstName', set 'firstName' here.
15687
+ */
15688
+ autoSizeColumn(dataField?: string): void;
14375
15689
  /**
14376
15690
  * This method returns true, if all rows in the Grid are selected.
14377
15691
  * @returns {boolean}
@@ -14442,9 +15756,9 @@ export interface Grid extends BaseElement, GridProperties {
14442
15756
  /**
14443
15757
  * Delete a row. When batch editing is enabled, the row is not saved until the batch edit is saved.
14444
15758
  * @param {string | number} rowId. row bound id
14445
- * @param {any} callback?. Sets a callback function, which is called after the row is deleted. The callback's argument is the deleted row.
15759
+ * @param callback?. Sets a callback function, which is called after the row is deleted. The callback's argument is the deleted row.
14446
15760
  */
14447
- deleteRow(rowId: string | number, callback?: any): void;
15761
+ deleteRow(rowId: string | number, callback?: {(row: GridRow): void}): void;
14448
15762
  /**
14449
15763
  * Scrolls to a row or cell. This method scrolls to a row or cell, when scrolling is necessary. If pagination is enabled, it will automatically change the page.
14450
15764
  * @param {string | number} rowId. row bound id
@@ -14462,10 +15776,15 @@ export interface Grid extends BaseElement, GridProperties {
14462
15776
  */
14463
15777
  endUpdate(refresh?: boolean): void;
14464
15778
  /**
14465
- * Expands a TreeGrid or Grouping row.
15779
+ * Expands a TreeGrid or Grouping row. For example, if you want to expand the first group, then its second sub grup, then the first sub sub group, you can use: grid.expandRow('0.1.0');
14466
15780
  * @param {string | number} rowId. row bound id
14467
15781
  */
14468
15782
  expandRow(rowId: string | number): void;
15783
+ /**
15784
+ * Expands rows to a given group level. For example 'grid.expandRowsToGroupLevel(1);' means that all groups at the root level will be expanded.
15785
+ * @param {number} level. row group level
15786
+ */
15787
+ expandRowsToGroupLevel(level: number): void;
14469
15788
  /**
14470
15789
  * Expands all TreeGrid or Grouping rows.
14471
15790
  */
@@ -14475,6 +15794,20 @@ export interface Grid extends BaseElement, GridProperties {
14475
15794
  * @param {string} Dataformat. 'xlsx', 'pdf', 'json', 'xml', 'csv', 'tsv', 'html', 'png', 'jpeg'.
14476
15795
  */
14477
15796
  exportData(Dataformat: string): void;
15797
+ /**
15798
+ * Finds entries by using a query and returns an array of row ids. Example: const rows = grid.find('nancy'); returns all rows that have 'nancy' value. Example 2: const rows = grid.find('nancy, davolio'); returns all rows that have 'nancy' and 'davolio' values in the same row. Example 3: const rows = grid.find(5, 'quantity', '>'); returns all rows where the value of the 'quantity' field is > 5.
15799
+ * @param {string} query. Search query
15800
+ * @param {string} dataField?. Column data field.
15801
+ * @param {string} condition?. Conditions which you can use in the expressions: '=', 'EQUAL','&lt;&gt;', 'NOT_EQUAL', '!=', '&lt;', 'LESS_THAN','&gt;', 'GREATER_THAN', '&lt;=', 'LESS_THAN_OR_EQUAL', '&gt;=', 'GREATER_THAN_OR_EQUAL','starts with', 'STARTS_WITH','ends with', 'ENDS_WITH', '', 'EMPTY', 'CONTAINS','DOES_NOT_CONTAIN', 'NULL','NOT_NULL'
15802
+ * @returns {any[]}
15803
+ */
15804
+ find(query: string, dataField?: string, condition?: string): any[];
15805
+ /**
15806
+ * Finds entries by using a query and returns an array of cells. Each cell in the array is also an array in this format: [id, dataField, value]. Example: const cells = grid.findCells('nancy'); returns all cells that have 'nancy' value. Example 2: const cells = grid.findCells('nancy, davolio'); returns all cells that have 'nancy' and 'davolio' values.
15807
+ * @param {string} query. Search query. You can enter multiple search strings, by using ','. Example: 'nancy, davolio'
15808
+ * @returns {any[]}
15809
+ */
15810
+ findCells(query: string): any[];
14478
15811
  /**
14479
15812
  * Navigates to a page, when paging is enabled.
14480
15813
  * @param {number} index. page index
@@ -14496,6 +15829,22 @@ export interface Grid extends BaseElement, GridProperties {
14496
15829
  * Navigates to the last page, when grid paging is enabled.
14497
15830
  */
14498
15831
  lastPage(): void;
15832
+ /**
15833
+ * Focuses and selects a cell or row. The keyboard navigation starts from the focused cell or row. Any previously applied selection will be cleared after calling this method.
15834
+ * @param {string | number} rowId. row bound id
15835
+ * @param {string} dataField?. column bound data field
15836
+ */
15837
+ focusAndSelect(rowId: string | number, dataField?: string): void;
15838
+ /**
15839
+ * Iterates through each row in the grid and calls the callback for each row. This is similar to the forEach method on a JavaScript array. This is called for each row, ignoring grouping, filtering or sorting applied in the Grid.
15840
+ * @param {any} rowCallback. Callback function with a row object as parameter. Example: grid.forEachRow((row) => { console.log(row.id) });
15841
+ */
15842
+ forEachRow(rowCallback: any): void;
15843
+ /**
15844
+ * Similar to forEachRow. Iterates through each row in the grid and calls the callback for each row. This method takes into account filtering and sorting applied to the Grid.
15845
+ * @param {any} rowCallback. Callback function with a row object as parameter. Example: grid.forEachRow((row) => { console.log(row.id) });
15846
+ */
15847
+ forEachRowAfterFilterAndSort(rowCallback: any): void;
14499
15848
  /**
14500
15849
  * Gets the maximum position of the vertical scrollbar. You can use this method in combination with the setVerticalScrollValue to apply a new scroll position.
14501
15850
  * @returns {number}
@@ -14521,6 +15870,11 @@ export interface Grid extends BaseElement, GridProperties {
14521
15870
  * @returns {any}
14522
15871
  */
14523
15872
  getColumns(): any;
15873
+ /**
15874
+ * Gets the editing cell(s), when the grid is editing.
15875
+ * @returns {any[]}
15876
+ */
15877
+ getEditCells(): any[];
14524
15878
  /**
14525
15879
  * Gets the groups array.
14526
15880
  * @returns {any[]}
@@ -14537,10 +15891,20 @@ export interface Grid extends BaseElement, GridProperties {
14537
15891
  */
14538
15892
  getSelection(): any;
14539
15893
  /**
14540
- * Gets the selected row ids.
15894
+ * Gets an Array where each item is an Array of row id and row data. If the Grid is used in virtual mode, the row data parameter is empty object, because the data is loaded on demand.
14541
15895
  * @returns {any[]}
14542
15896
  */
14543
15897
  getSelectedRows(): any[];
15898
+ /**
15899
+ * Gets the selected row ids.
15900
+ * @returns {any[]}
15901
+ */
15902
+ getSelectedRowIds(): any[];
15903
+ /**
15904
+ * Gets the selected row indexes.
15905
+ * @returns {any[]}
15906
+ */
15907
+ getSelectedRowIndexes(): any[];
14544
15908
  /**
14545
15909
  * Gets the selected cells. The method returns an array of cell. Each cell is an array with row id, column data field and cell value.
14546
15910
  * @returns {any[]}
@@ -14562,10 +15926,26 @@ export interface Grid extends BaseElement, GridProperties {
14562
15926
  */
14563
15927
  getViewRows(): any;
14564
15928
  /**
14565
- * Gets a JSON object with the following fields: 'sort', 'filter', 'groups', 'paging', 'selectedCells', 'selectedrows'.
15929
+ * Gets a JSON object with the following fields: 'sort', 'columns', 'expandedRows', 'filter', 'groups', 'paging', 'selectedCells', 'selectedrows'. The 'sort' represents an object which contains the sorted columns. Each key in that json object is the column's dataField item which has sortOrder: string and sortIndex: int properties. The sortOrder could be either 'asc' or 'desc'. Similarly, the filter object contains the filtered columns. Each key in that object is a column data field and each value has 'filters' array property with the applied filters to the column. The 'columns' property contains an array of columns with saved properties such as visible, width and freeze. The 'expandedRows' property contains the indexes of the expanded rows. The 'groups' property contains the grouped column data fields and the selectedCells and selectedRows include information about the cells or rows selection. These depend on the selection mode used in the Grid. The 'paging' object includes the sub-properties 'count', 'index' and 'size' which determine the count of pages, the current page's index and the page size.
14566
15930
  * @returns {any}
14567
15931
  */
14568
15932
  getState(): any;
15933
+ /**
15934
+ * Saves the Grid state and returns a JSON object with the following fields: 'sort', 'columns', 'expandedRows', 'filter', 'groups', 'paging', 'selectedCells', 'selectedrows'. The 'sort' represents an object which contains the sorted columns. Each key in that json object is the column's dataField item which has sortOrder: string and sortIndex: int properties. The sortOrder could be either 'asc' or 'desc'. Similarly, the filter object contains the filtered columns. Each key in that object is a column data field and each value has 'filters' array property with the applied filters to the column. The 'columns' property contains an array of columns with saved properties such as visible, width and freeze. The 'expandedRows' property contains the indexes of the expanded rows. The 'groups' property contains the grouped column data fields and the selectedCells and selectedRows include information about the cells or rows selection. These depend on the selection mode used in the Grid. The 'paging' object includes the sub-properties 'count', 'index' and 'size' which determine the count of pages, the current page's index and the page size.
15935
+ * @param {string} name?. state name
15936
+ * @returns {any}
15937
+ */
15938
+ saveState(name?: string): any;
15939
+ /**
15940
+ * Loads a previously saved Grid state. You can pass a state name when there is a state which was previously saved with the saveState(stateName) method call or a state object returned by the saveState or getState method calls. The state object is required to be a JSON object with the following fields: 'sort', 'columns', 'expandedRows', 'filter', 'groups', 'paging', 'selectedCells', 'selectedrows'. The 'sort' represents an object which contains the sorted columns. Each key in that json object is the column's dataField item which has sortOrder: string and sortIndex: int properties. The sortOrder could be either 'asc' or 'desc'. Similarly, the filter object contains the filtered columns. Each key in that object is a column data field and each value has 'filters' array property with the applied filters to the column. The 'columns' property contains an array of columns with saved properties such as visible, width and freeze. The 'expandedRows' property contains the indexes of the expanded rows. The 'groups' property contains the grouped column data fields and the selectedCells and selectedRows include information about the cells or rows selection. These depend on the selection mode used in the Grid. The 'paging' object includes the sub-properties 'count', 'index' and 'size' which determine the count of pages, the current page's index and the page size.
15941
+ * @param {any} state. state name or state object
15942
+ * @returns {any}
15943
+ */
15944
+ loadState(state: any): any;
15945
+ /**
15946
+ * Resets the Grid state.
15947
+ */
15948
+ resetState(): void;
14569
15949
  /**
14570
15950
  * Gets the changes from the batch edit.
14571
15951
  * @returns
@@ -14578,6 +15958,12 @@ export interface Grid extends BaseElement, GridProperties {
14578
15958
  * @returns {any}
14579
15959
  */
14580
15960
  getCellValue(rowId: string | number, dataField: string): any;
15961
+ /**
15962
+ * Gets a column. Returns a Grid column object.
15963
+ * @param {string} dataField. column bound data field. For example, if you have a column with dataField: 'firstName', set 'firstName' here.
15964
+ * @returns {GridColumn}
15965
+ */
15966
+ getColumn(dataField: string): GridColumn;
14581
15967
  /**
14582
15968
  * Gets a value of a column.
14583
15969
  * @param {string} dataField. column bound data field. For example, if you have a column with dataField: 'firstName', set 'firstName' here.
@@ -14592,6 +15978,18 @@ export interface Grid extends BaseElement, GridProperties {
14592
15978
  * @returns {any}
14593
15979
  */
14594
15980
  getRowProperty(rowId: string | number, propertyName: string): any;
15981
+ /**
15982
+ * Gets a row. Returns a Grid row object.
15983
+ * @param {string | number} rowId. row bound id
15984
+ * @returns {GridRow}
15985
+ */
15986
+ getRow(rowId: string | number): GridRow;
15987
+ /**
15988
+ * Gets a row by its index. Returns a Grid row object.
15989
+ * @param {number} rowIndex. row bound index
15990
+ * @returns {GridRow}
15991
+ */
15992
+ getRowByIndex(rowIndex: number): GridRow;
14595
15993
  /**
14596
15994
  * Gets the Data source data associated to the row.
14597
15995
  * @param {string | number} rowId. row bound id
@@ -14599,11 +15997,11 @@ export interface Grid extends BaseElement, GridProperties {
14599
15997
  */
14600
15998
  getRowData(rowId: string | number): any;
14601
15999
  /**
14602
- * Gets the Row's id.
16000
+ * Gets the Row's id by a row index.
14603
16001
  * @param {number} rowIndex. row index
14604
- * @returns {any}
16002
+ * @returns {string | number}
14605
16003
  */
14606
- getRowId(rowIndex: number): any;
16004
+ getRowId(rowIndex: number): string | number;
14607
16005
  /**
14608
16006
  * Gets whether a column's drop-down menu is opened.
14609
16007
  * @returns {boolean}
@@ -14641,14 +16039,20 @@ export interface Grid extends BaseElement, GridProperties {
14641
16039
  * Inserts a row. When batch editing is enabled, the row is not saved until the batch edit is saved.
14642
16040
  * @param {any} data. row data matching the data source
14643
16041
  * @param {number} index?. Determines the insert index. The default value is the last index.
14644
- * @param {any} callback?. Sets a callback function, which is called after the new row is added. The callback's argument is the new row.
16042
+ * @param callback?. Sets a callback function, which is called after the new row is added. The callback's argument is the new row.
14645
16043
  */
14646
- insertRow(data: any, index?: number, callback?: any): void;
16044
+ insertRow(data: any, index?: number, callback?: {(row: GridRow): void}): void;
14647
16045
  /**
14648
16046
  * Opens a column drop-down menu.
14649
16047
  * @param {string} dataField. column bound data field. For example, if you have a column with dataField: 'firstName', set 'firstName' here.
14650
16048
  */
14651
16049
  openMenu(dataField: string): void;
16050
+ /**
16051
+ * Opens a context menu. Note that context menu should be enabled.
16052
+ * @param {number} left. Left Position.
16053
+ * @param {number} top. Top Position.
16054
+ */
16055
+ openContextMenu(left: number, top: number): void;
14652
16056
  /**
14653
16057
  * Prints the Grid data. The method uses the options of the <em>dataExport</em> property. When printed, the Grid will not display any scrollbars so all rows and columns will be displayed. The grid will auto resize width and height to fit all contents. To customize the printing options, you can use the <em>dataExport</em> property.
14654
16058
  */
@@ -14746,6 +16150,24 @@ export interface Grid extends BaseElement, GridProperties {
14746
16150
  * @param {number[]} rowIndex. Array of row indexes
14747
16151
  */
14748
16152
  selectRowsByIndex(rowIndex: number[]): void;
16153
+ /**
16154
+ * Selects rows by using a query. Example: grid.selectRowsByQuery('nancy'); selects all rows that have 'nancy' value. Example 2: grid.selectRowsByQuery('nancy, davolio'); selects all rows that have 'nancy' and 'davolio' values in the same row. Example 3: grid.selectRowsByQuery(5, 'quantity', '>'); selects all rows where the value of the 'quantity' field is > 5.
16155
+ * @param {string} query. Search query
16156
+ * @param {string} dataField?. Column data field.
16157
+ * @param {string} condition?. Conditions which you can use in the expressions: '=', 'EQUAL','&lt;&gt;', 'NOT_EQUAL', '!=', '&lt;', 'LESS_THAN','&gt;', 'GREATER_THAN', '&lt;=', 'LESS_THAN_OR_EQUAL', '&gt;=', 'GREATER_THAN_OR_EQUAL','starts with', 'STARTS_WITH','ends with', 'ENDS_WITH', '', 'EMPTY', 'CONTAINS','DOES_NOT_CONTAIN', 'NULL','NOT_NULL'
16158
+ */
16159
+ selectRowsByQuery(query: string, dataField?: string, condition?: string): void;
16160
+ /**
16161
+ * Selects multiple cells by their ids and dataFields. Example: grid.selectCells([0, 1, 2], ['firstName', 'quantity', 'date']); - selects the 'firstName', 'quantity' and 'date' cells from the first, second and third rows.
16162
+ * @param {(string | number)[]} rowIds. Array of row ids
16163
+ * @param {string[]} dataFields. Array of data fields.
16164
+ */
16165
+ selectCells(rowIds: (string | number)[], dataFields: string[]): void;
16166
+ /**
16167
+ * Selects cells by using a query. Example: grid.selectCellsByQuery('nancy'); selects all cells that have 'nancy' value. Example 2: grid.selectCellsByQuery('nancy, davolio'); selects all cells that have 'nancy' and 'davolio' values in the same row.
16168
+ * @param {string} query. Search query
16169
+ */
16170
+ selectCellsByQuery(query: string): void;
14749
16171
  /**
14750
16172
  * Sets a new value to a cell.
14751
16173
  * @param {string | number} rowId. row bound id
@@ -14753,6 +16175,11 @@ export interface Grid extends BaseElement, GridProperties {
14753
16175
  * @param {string | number | Date | boolean} value. New Cell value.
14754
16176
  */
14755
16177
  setCellValue(rowId: string | number, dataField: string, value: string | number | Date | boolean): void;
16178
+ /**
16179
+ * Sets new columns to the Grid. The grid will redraw all the column headers, and then redraw all of the rows. By using 'setColumns', the grid will compare the new columns passed as argument to the method with existing columns. The Grid will automatically create new columns, keep old columns if they already exist and remove columns which are not in the 'setColumns' method argument. The benefit of that is that the state of the column like(sort, filter, width or other) will be kept, if the column exsits after the new columns are applied.
16180
+ * @param {GridColumn[]} columns. Columns array.
16181
+ */
16182
+ setColumns(columns: GridColumn[]): void;
14756
16183
  /**
14757
16184
  * Sets a property to a column.
14758
16185
  * @param {string} dataField. column bound data field. For example, if you have a column with dataField: 'firstName', set 'firstName' here.
@@ -14770,16 +16197,16 @@ export interface Grid extends BaseElement, GridProperties {
14770
16197
  /**
14771
16198
  * Sets a style to a row.
14772
16199
  * @param {string | number} rowId. row bound id
14773
- * @param {any} rowStyle. The row style object. The object may have one or all of the following properties: 'background', 'color', 'fontSize', 'fontFamily', 'textDecoration', 'fontStyle', 'fontWeight'.
16200
+ * @param rowStyle. The row style object. The object may have one or all of the following properties: 'background', 'color', 'fontSize', 'fontFamily', 'textDecoration', 'fontStyle', 'fontWeight'.
14774
16201
  */
14775
- setRowStyle(rowId: string | number, rowStyle: any): void;
16202
+ setRowStyle(rowId: string | number, rowStyle: {background?: string, color?: string, fontSize?: string, fontFamily?: string, textDecoration?: string, fontStyle?: string, fontWeight?: string}): void;
14776
16203
  /**
14777
16204
  * Sets a style to a row.
14778
16205
  * @param {string | number} rowId. row bound id
14779
16206
  * @param {string} dataField. Column bound field name.
14780
- * @param {any} rowStyle. The cell style object. The object may have one or all of the following properties: 'background', 'color', 'fontSize', 'fontFamily', 'textDecoration', 'fontStyle', 'fontWeight'.
16207
+ * @param rowStyle. The cell style object. The object may have one or all of the following properties: 'background', 'color', 'fontSize', 'fontFamily', 'textDecoration', 'fontStyle', 'fontWeight'.
14781
16208
  */
14782
- setCellStyle(rowId: string | number, dataField: string, rowStyle: any): void;
16209
+ setCellStyle(rowId: string | number, dataField: string, rowStyle: {background?: string, color?: string, fontSize?: string, fontFamily?: string, textDecoration?: string, fontStyle?: string, fontWeight?: string}): void;
14783
16210
  /**
14784
16211
  * Sets the position of the vertical scrollbar. You can use this method in combination with the getVerticalScrollValue and getVerticalScrollMax.
14785
16212
  * @param {number} value. The new scroll position
@@ -14799,9 +16226,9 @@ export interface Grid extends BaseElement, GridProperties {
14799
16226
  * Updates a row. When batch editing is enabled, the row is not saved until the batch edit is saved.
14800
16227
  * @param {string | number} rowId. row bound id
14801
16228
  * @param {any} data. row data matching the data source
14802
- * @param {any} callback?. Sets a callback function, which is called after the row is updated. The callback's argument is the updated row.
16229
+ * @param callback?. Sets a callback function, which is called after the row is updated. The callback's argument is the updated row.
14803
16230
  */
14804
- updateRow(rowId: string | number, data: any, callback?: any): void;
16231
+ updateRow(rowId: string | number, data: any, callback?: {(row: GridRow): void}): void;
14805
16232
  /**
14806
16233
  * Unselects a row, cell or column.
14807
16234
  * @param {string | number} rowId. row bound id
@@ -14946,6 +16373,11 @@ export interface GridAppearance {
14946
16373
  * Default value: false
14947
16374
  */
14948
16375
  showRowHeader?: boolean;
16376
+ /**
16377
+ * Shows or hides Row headers. In TreeGrid, the non-leaf tree items are displayed as normal rows. If this property is set to true, they are displayed as headers similar to the grouping rendering.
16378
+ * Default value: false
16379
+ */
16380
+ showTreeRowHeader?: boolean;
14949
16381
  /**
14950
16382
  * Shows row indexes in the row header. The showRowHeader property should be true
14951
16383
  * Default value: false
@@ -14976,6 +16408,11 @@ export interface GridAppearance {
14976
16408
  * Default value: true
14977
16409
  */
14978
16410
  showColumnHeaderLines?: boolean;
16411
+ /**
16412
+ * Shows drag icon on the column header when drag is enabled. The icon is displayed when you move the mouse cursor to the column header's left edge.
16413
+ * Default value: false
16414
+ */
16415
+ showColumnHeaderDragIcon?: boolean;
14979
16416
  /**
14980
16417
  * Shows column lines.
14981
16418
  * Default value: true
@@ -14993,12 +16430,12 @@ export interface GridAppearance {
14993
16430
  showColumnGroupsInColumnPanel?: boolean;
14994
16431
  /**
14995
16432
  * Shows filtered column background, when filter is applied.
14996
- * Default value: true
16433
+ * Default value: false
14997
16434
  */
14998
16435
  showFilterColumnBackground?: boolean;
14999
16436
  /**
15000
16437
  * Shows sorted column background, when sorting is applied.
15001
- * Default value: true
16438
+ * Default value: false
15002
16439
  */
15003
16440
  showSortColumnBackground?: boolean;
15004
16441
  /**
@@ -15056,6 +16493,11 @@ export interface GridAppearance {
15056
16493
  * Default value: false
15057
16494
  */
15058
16495
  showVerticalScrollBarOnFixedColumns?: boolean;
16496
+ /**
16497
+ * Shows the today's date as 'Today' vs '7/8/2022'. When the property is set to false, it will display the date.
16498
+ * Default value: true
16499
+ */
16500
+ showTodayDateAsString?: boolean;
15059
16501
  }
15060
16502
 
15061
16503
  /**An object containing settings related to the grid's behavior. */
@@ -15157,7 +16599,7 @@ export interface GridClipboard {
15157
16599
  * Sets or gets a callback on paste.
15158
16600
  * Default value: null
15159
16601
  */
15160
- onPasteValue?: any;
16602
+ onPasteValue?: {(args: {value: any, oldValue: any, dataField: string, id: string | number}): void};
15161
16603
  }
15162
16604
 
15163
16605
  export interface GridColumn {
@@ -15242,15 +16684,20 @@ export interface GridColumn {
15242
16684
  */
15243
16685
  cellsVerticalAlign?: VerticalAlignment | string;
15244
16686
  /**
15245
- * Sets or gets the column's header CSS class name.
16687
+ * Sets or gets the column's header CSS class name. You can apply multiple CSS class names by separating them with space.
15246
16688
  * Default value: ""
15247
16689
  */
15248
16690
  className?: string;
15249
16691
  /**
15250
- * Sets or gets the column's cells CSS class name.
15251
- * Default value: ""
16692
+ * Sets or gets the column's cells CSS class name(s). The property can be used with string and function. You can apply multiple CSS class names by separating them with space or you can return a CSS class name(s) when you use it as a function. The function gets called with the following parameters: index - row's index, dataField - column's data field, cellValue - current cell's value, rowData - current row's data, row - GridRow object. Ex: cellsClassName: (index, dataField, value, rowData, row) => { if (index === 0) { return 'cell-class-1' } }
16693
+ * Default value:
15252
16694
  */
15253
- cellsClassName?: string;
16695
+ cellsClassName?: any;
16696
+ /**
16697
+ * Sets or gets the column's cells CSS class rules. Different CSS class names are conditionally applied. Example: label: 'Quantity', dataField: 'quantity', editor: 'numberInput', cellsClassRules: { 'one': settings => settings.value > 5, 'two': settings => settings.value &lt;5, 'three': settings => settings.value === 3 }. The settings object contains the following properties: index, value, dataField, row, api.
16698
+ * Default value: null
16699
+ */
16700
+ cellsCSSRules?: any;
15254
16701
  /**
15255
16702
  * Sets the name of the column group.
15256
16703
  * Default value: ""
@@ -15282,7 +16729,7 @@ export interface GridColumn {
15282
16729
  */
15283
16730
  element?: HTMLElement;
15284
16731
  /**
15285
- * Sets or gets the column's editor. The property expects 'input', 'autoComplete', 'comboBox', 'dropDownList', 'image', 'numberInput', 'checkBox', 'multiInput', 'multiComboInput', 'checkInput', 'slider', 'dateTimePicker', 'timeInput', 'dateInput', 'dateRangeInput', 'maskedTextBox', 'textArea' or a custom object with 'template' property which defines the editor type, 'settings' property which defines the custom editor's properties, 'onInit(int row, string column, object editor, object rowData): object', 'onRender(int row, string column, object editor, object rowData): object', 'setValue(object value): void' and 'getValue(object value): object' callback functions.
16732
+ * Sets or gets the column's editor. The property expects 'input', 'autoComplete', 'comboBox', 'dropDownList', 'image', 'numberInput', 'checkBox', 'multiInput', 'multiComboInput', 'checkInput', 'slider', 'dateTimePicker', 'timeInput', 'dateInput', 'dateRangeInput', 'maskedTextBox', 'textArea' or a custom object with 'template' property which defines the editor type, 'settings' property which defines the custom editor's properties, 'onInit(int row, string column, object editor, object rowData): void', 'onRender(int row, string column, object editor, object rowData): void', 'setValue(object value): void' and 'getValue(object value): any' callback functions.
15286
16733
  * Default value: null
15287
16734
  */
15288
16735
  editor?: any;
@@ -15305,7 +16752,7 @@ export interface GridColumn {
15305
16752
  * Sets or gets the column's format function.
15306
16753
  * Default value: null
15307
16754
  */
15308
- formatFunction?: any;
16755
+ formatFunction?: {(formatObject: {row?: GridRow, column?: GridColumn, cell?: GridCell, oldValue?: any, value?: any, template?: any}): void};
15309
16756
  /**
15310
16757
  * Sets or gets the column's format settings. You can use any of the build in formatting options or to NumberFormat object like that: 'Intl: { NumberFormat: { style: \'currency\', currency: \'EUR\' }}' or DateTimeFormat object like that: 'Intl: { DateTimeFormat: { dateStyle: \'full\' }}''
15311
16758
  * Default value: [object Object]
@@ -15316,6 +16763,16 @@ export interface GridColumn {
15316
16763
  * Default value: ""
15317
16764
  */
15318
16765
  group?: string;
16766
+ /**
16767
+ * This function allows you to provide custom cell values, which will be displayed in the column's cells. The grid passes 3 arguments to the function - row id, column's dataField and row's data.
16768
+ * Default value: null
16769
+ */
16770
+ getCellValue?: any;
16771
+ /**
16772
+ * Gets the column's filter panel. The function should return HTMLElement which will represent the filter UI panel displayed in the filter menu. The function works in combination with updateFilterPanel
16773
+ * Default value: null
16774
+ */
16775
+ getFilterPanel?: any;
15319
16776
  /**
15320
16777
  * Sets or gets the column's icon. Expects CSS class name.
15321
16778
  * Default value: ""
@@ -15326,11 +16783,21 @@ export interface GridColumn {
15326
16783
  * Default value: ""
15327
16784
  */
15328
16785
  label?: string;
16786
+ /**
16787
+ * Sets or gets the column header's template. The property expects the 'id' of HTMLTemplateElement, HTML string or function which returns html string.
16788
+ * Default value:
16789
+ */
16790
+ labelTemplate?: string | HTMLTemplateElement | HTMLElement | {(label: string): string};
15329
16791
  /**
15330
16792
  * Sets or gets the minimum width.
15331
16793
  * Default value: 30
15332
16794
  */
15333
16795
  minWidth?: number;
16796
+ /**
16797
+ * Sets or gets the column's rowSpan function. Allows you to dynamically span cells.
16798
+ * Default value: null
16799
+ */
16800
+ rowSpan?: {(cellValue: any, rowIndex: number, data: any): number};
15334
16801
  /**
15335
16802
  * Sets or gets the sort order of the column. Accepts: 'asc', 'desc' and null.
15336
16803
  * Default value: null
@@ -15341,6 +16808,11 @@ export interface GridColumn {
15341
16808
  * Default value: null
15342
16809
  */
15343
16810
  sortIndex?: number;
16811
+ /**
16812
+ * Sets or gets a custom 'sortComparator' function. It can be used for implementing custom sorting. Ex: sortComparator: (value1, value2) =&gt; { if (value1 === value2) return 0; return value1 &lt;value2; }
16813
+ * Default value: null
16814
+ */
16815
+ sortComparator?: any;
15344
16816
  /**
15345
16817
  * Sets or gets whether the column's header action drop-down button is displayed. This button opens the column's menu.
15346
16818
  * Default value: true
@@ -15357,35 +16829,117 @@ export interface GridColumn {
15357
16829
  */
15358
16830
  showDescriptionButton?: boolean;
15359
16831
  /**
15360
- * Sets or gets the width. Accepts: 'number', 'px', 'em', 'auto', 'null' values.
15361
- * Default value:
16832
+ * Sets or gets the width. Accepts: 'number', 'px', 'em', 'auto', 'null' values.
16833
+ * Default value:
16834
+ */
16835
+ width?: string | number;
16836
+ /**
16837
+ * Sets or gets the column's template. The property expects the 'id' of HTMLTemplateElement or HTML string which is displayed in the cells. Built-in string values are: 'checkBox', 'switchButton', 'radioButton', 'url', 'email', 'dropdownlist', 'list', 'progress', 'tags', 'autoNumber', 'modifiedBy', 'createdBy', 'createdTime', 'modifiedTime', 'images. For example, when you set the template to 'url', the cells will be render anchor tags. When you set the template property to HTMLTemplateElement you should consider that once a template is rendered, the formatObject.template property stores the rendered template component for further use.
16838
+ * Default value:
16839
+ */
16840
+ template?: any;
16841
+ /**
16842
+ * Sets or gets the column's validation rules. The expected value is an Array of Objects. Each object should have a 'type' property that can be set to 'required', 'min', 'max', 'minLength', 'maxLength', 'email', 'null', 'requiredTrue', 'minData', 'maxDate', 'pattern'. The 'value' property should be set, too. For validation rule types 'required', 'requiredTrue' and 'null' you can skip the 'value' property. Optional property is 'message', which determines the error message.
16843
+ * Default value: null
16844
+ */
16845
+ validationRules?: [] | null;
16846
+ /**
16847
+ * Sets or gets the column's header vertical alignment. Accepts: 'top', 'bottom' and 'center'
16848
+ * Default value: center
16849
+ */
16850
+ verticalAlign?: VerticalAlignment | string;
16851
+ /**
16852
+ * Sets or gets the column summary. The property should be set to an array with the following possible values: 'sum', 'min', 'max', 'avg', 'count', 'median', 'stdev', 'stdevp', 'var', 'varp'.
16853
+ * Default value:
16854
+ */
16855
+ summary?: string[];
16856
+ /**
16857
+ * Updates the column's filter panel. The function works in combination with getFilterPanel
16858
+ * Default value: null
16859
+ */
16860
+ updateFilterPanel?: any;
16861
+ /**
16862
+ * Sets or gets whether the column is visible. Set the property to 'false' to hide the column.
16863
+ * Default value: true
16864
+ */
16865
+ visible?: boolean;
16866
+ }
16867
+
16868
+ /**Context Menu is the drop-down menu displayed after right-clicking a Grid row. It allows you to delete row, edit cell or row depending on the edit mode. The 'contextMenuItemCustom' dataSource option allows you to add custom menu item to the context menu. You can replace the context menu by using the 'selector' property and setting it to ID of a Smart.Menu component. */
16869
+ export interface GridContextMenu {
16870
+ /**
16871
+ * Sets or gets whether the context menu is enabled. If the value is false, the context menu will not be displayed, when user right clicks on a row.
16872
+ * Default value: false
16873
+ */
16874
+ enabled?: boolean;
16875
+ /**
16876
+ * Sets the data sources to the context menu.
16877
+ * Default value: [object Object]
16878
+ */
16879
+ dataSource?: GridContextMenuDataSource;
16880
+ /**
16881
+ * Sets the ID or CSS Class of a Smart.Menu component to be used as a context menu for the Grid.
16882
+ * Default value: ""
16883
+ */
16884
+ selector?: string;
16885
+ /**
16886
+ * Sets the width of the context menu.
16887
+ * Default value: 250
16888
+ */
16889
+ width?: number;
16890
+ /**
16891
+ * Sets the height of the context menu.
16892
+ * Default value: null
16893
+ */
16894
+ height?: number | null;
16895
+ }
16896
+
16897
+ /**Sets the data sources to the context menu. */
16898
+ export interface GridContextMenuDataSource {
16899
+ /**
16900
+ * Describes the delete item.
16901
+ * Default value: [object Object]
15362
16902
  */
15363
- width?: string | number;
16903
+ contextMenuItemDelete?: GridCommand;
15364
16904
  /**
15365
- * Sets or gets the column's template. The property expects the 'id' of HTMLTemplateElement or HTML string which is displayed in the cells. Built-in string values are: 'checkBox', 'switchButton', 'radioButton', 'url', 'email', 'dropdownlist', 'list', 'progress', 'tags', 'autoNumber', 'modifiedBy', 'createdBy', 'createdTime', 'modifiedTime', 'images. For example, when you set the template to 'url', the cells will be render anchor tags. When you set the template property to HTMLTemplateElement you should consider that once a template is rendered, the formatObject.template property stores the rendered template component for further use.
15366
- * Default value:
16905
+ * Describes the edit item.
16906
+ * Default value: [object Object]
15367
16907
  */
15368
- template?: any;
16908
+ contextMenuItemEdit?: GridCommand;
15369
16909
  /**
15370
- * Sets or gets the column's validation rules. The expected value is an Array of Objects. Each object should have a 'type' property that can be set to 'required', 'min', 'max', 'minLength', 'maxLength', 'email', 'null', 'requiredTrue', 'minData', 'maxDate', 'pattern'. The 'value' property should be set, too. For validation rule types 'required', 'requiredTrue' and 'null' you can skip the 'value' property. Optional property is 'message', which determines the error message.
15371
- * Default value: null
16910
+ * Describes the custom item.
16911
+ * Default value: [object Object]
15372
16912
  */
15373
- validationRules?: [] | null;
16913
+ contextMenuItemCustom?: GridCommand;
16914
+ }
16915
+
16916
+ /**Describes the delete item. */
16917
+ export interface GridCommand {
15374
16918
  /**
15375
- * Sets or gets the column's header vertical alignment. Accepts: 'top', 'bottom' and 'center'
15376
- * Default value: center
16919
+ * Sets the command of the context menu item.
16920
+ * Default value: "contextMenuItemDeleteCommand"
15377
16921
  */
15378
- verticalAlign?: VerticalAlignment | string;
16922
+ command?: string;
15379
16923
  /**
15380
- * Sets or gets the column summary. The property should be set to an array with the following possible values: 'sum', 'min', 'max', 'avg', 'count', 'median', 'stdev', 'stdevp', 'var', 'varp'.
15381
- * Default value:
16924
+ * Enables the context menu item.
16925
+ * Default value: true
15382
16926
  */
15383
- summary?: string[];
16927
+ enabled?: boolean;
15384
16928
  /**
15385
- * Sets or gets whether the column is visible. Set the property to 'false' to hide the column.
16929
+ * Sets the visibility of the context menu item.
15386
16930
  * Default value: true
15387
16931
  */
15388
16932
  visible?: boolean;
16933
+ /**
16934
+ * Sets the icon of the context menu item.
16935
+ * Default value: "jqx-icon-delete"
16936
+ */
16937
+ icon?: string;
16938
+ /**
16939
+ * Sets the label of the context menu item.
16940
+ * Default value: ""
16941
+ */
16942
+ label?: string;
15389
16943
  }
15390
16944
 
15391
16945
  /**Column Menu is the drop-down menu displayed after clicking the column header's drop-down button, which is displayed when you hover the column header. It allows you to customize column settings. For example: Sort, Filter or Group the Grid by the current column. */
@@ -15443,7 +16997,7 @@ export interface GridColumnMenuDataSource {
15443
16997
  * Describes the settings of the column menu item duplicate.
15444
16998
  * Default value: [object Object]
15445
16999
  */
15446
- columnMenuItemDuplicate?: GridCommand;
17000
+ columnMenuItemClone?: GridCommand;
15447
17001
  /**
15448
17002
  * Describes the settings of the column menu item insert left.
15449
17003
  * Default value: [object Object]
@@ -15464,6 +17018,11 @@ export interface GridColumnMenuDataSource {
15464
17018
  * Default value: [object Object]
15465
17019
  */
15466
17020
  columnMenuItemSortDesc?: GridCommand;
17021
+ /**
17022
+ * Describes the settings of the column menu item to add sorting.
17023
+ * Default value: [object Object]
17024
+ */
17025
+ columnMenuItemSort?: GridCommand;
15467
17026
  /**
15468
17027
  * Describes the settings of the column menu item remove sort.
15469
17028
  * Default value: [object Object]
@@ -15501,41 +17060,17 @@ export interface GridColumnMenuDataSource {
15501
17060
  columnMenuItemDelete?: GridCommand;
15502
17061
  }
15503
17062
 
15504
- /**Describes the settings of the column menu customize type */
15505
- export interface GridCommand {
15506
- /**
15507
- * Sets the command of the column menu customize type.
15508
- * Default value: "customizeTypeCommand"
15509
- */
15510
- command?: string;
15511
- /**
15512
- * Enables the column menu customize type.
15513
- * Default value: true
15514
- */
15515
- enabled?: boolean;
15516
- /**
15517
- * Sets the visibility of the column menu customize type.
15518
- * Default value: false
15519
- */
15520
- visible?: boolean;
15521
- /**
15522
- * Sets the icon of the column menu customize type.
15523
- * Default value: "jqx-icon-customize"
15524
- */
15525
- icon?: string;
15526
- /**
15527
- * Sets the label of the column menu customize type.
15528
- * Default value: ""
15529
- */
15530
- label?: string;
15531
- }
15532
-
15533
17063
  export interface GridColumnGroup {
15534
17064
  /**
15535
17065
  * Sets the label.
15536
17066
  * Default value: ""
15537
17067
  */
15538
17068
  label?: string;
17069
+ /**
17070
+ * Sets or gets the column header's template. The property expects the 'id' of HTMLTemplateElement, HTML string or function which returns html string.
17071
+ * Default value:
17072
+ */
17073
+ labelTemplate?: string | HTMLTemplateElement | HTMLElement | {(label: string): string};
15539
17074
  /**
15540
17075
  * Sets the align.
15541
17076
  * Default value: center
@@ -15617,7 +17152,7 @@ export interface GridCharting {
15617
17152
  * Sets or gets the chart's container.
15618
17153
  * Default value: null
15619
17154
  */
15620
- appendTo?: any;
17155
+ appendTo?: string | HTMLElement;
15621
17156
  /**
15622
17157
  * Sets or gets the charting dialog.
15623
17158
  * Default value: [object Object]
@@ -15805,12 +17340,12 @@ export interface GridDataSourceSettings {
15805
17340
  */
15806
17341
  mapChar?: string;
15807
17342
  /**
15808
- * Sets the virtual data source function which is called each time the Grid requests data. Demos using 'virtualDataSource' are available on the Grid demos page.
17343
+ * Sets the virtual data source function which is called each time the Grid requests data. Example for calling the callback function with the new data set: resultCallbackFunction({dataSource: data}); Demos using 'virtualDataSource' are available on the Grid demos page. Example: https://www.htmlelements.com/demos/grid/virtualscroll/
15809
17344
  * Default value: null
15810
17345
  */
15811
- virtualDataSource?: any;
17346
+ virtualDataSource?: {(resultCallbackFunction: any, details: DataAdapterVirtualDataSourceDetails): void};
15812
17347
  /**
15813
- * Sets the virtual data source on expand function. This function is called when we load data on demand in Tree or TreeGrid and virtualDataSource in these components is set, too
17348
+ * Sets the virtual data source on expand function. This function is called when we load data on demand in Tree or TreeGrid and virtualDataSource in these components is set, too. Example: https://www.htmlelements.com/demos/grid/virtual-tree-grid/
15814
17349
  * Default value: null
15815
17350
  */
15816
17351
  virtualDataSourceOnExpand?: any;
@@ -16117,6 +17652,11 @@ export interface GridFiltering {
16117
17652
  * Default value: false
16118
17653
  */
16119
17654
  enabled?: boolean;
17655
+ /**
17656
+ * Determines the filtering operator used in the Grid. By default filters are applied with 'and' operator i.e returns a set of rows matching the filter expressions of columnA AND columnB. The other option is to return a set of rows matching the filter expressions of columnA OR columnB. For example: grid.filtering.operator = 'or'; grid.addFilter('lastName', 'contains "davolio"') grid.addFilter('firstName', 'contains "Antoni"'); - that code will apply two filters to the Grid and will return all rows where firstName is 'Antoni' or the lastName is 'Davolio'
17657
+ * Default value: "and"
17658
+ */
17659
+ operator?: string;
16120
17660
  /**
16121
17661
  * An array of filtering conditions to apply to the DataGrid. Each member of the filter array is an array with two members. The first one is the column dataField to apply the filter to. The second one is the filtering condition. Example: [['firstName', 'contains Andrew or contains Nancy'], ['quantity', '&lt;= 3 and &gt;= 8']]. Additional example with filter which we want to apply to a column with filterMenuMode='excel' - [['firstName', 'EQUAL' 'Andrew' or 'EQUAL' 'Antoni' or 'EQUAL' 'Beate']]. Example with a string filter applied to a string column - [['lastName','CONTAINS' 'burke' or 'CONTAINS' 'peterson']]. Filter conditions which you can use in the expressions: '=', 'EQUAL','&lt;&gt;', 'NOT_EQUAL', '!=', '&lt;', 'LESS_THAN','&gt;', 'GREATER_THAN', '&lt;=', 'LESS_THAN_OR_EQUAL', '&gt;=', 'GREATER_THAN_OR_EQUAL','starts with', 'STARTS_WITH','ends with', 'ENDS_WITH', '', 'EMPTY', 'CONTAINS','DOES_NOT_CONTAIN', 'NULL','NOT_NULL'
16122
17662
  * Default value:
@@ -16228,6 +17768,11 @@ export interface GridGrouping {
16228
17768
  * Default value: false
16229
17769
  */
16230
17770
  autoExpandAll?: boolean;
17771
+ /**
17772
+ * Automatically expands all groups to a given level.
17773
+ * Default value: 0
17774
+ */
17775
+ autoExpandToLevel?: number;
16231
17776
  /**
16232
17777
  * Automatically hides all grouped columns.
16233
17778
  * Default value: false
@@ -16239,20 +17784,20 @@ export interface GridGrouping {
16239
17784
  */
16240
17785
  expandMode?: GridGroupingExpandMode | string;
16241
17786
  /**
16242
- * Sets the group render mode. 'basic' mode renders the group headers without taking into account the indent, groupRowHeight and column label properties. 'compact' mode is the same as basic, but also renders the column labels in the group headers. The default mode is 'advanced', which adds indents to groups that depend on the group level.
16243
- * Default value: advanced
17787
+ * Sets or gets the column's format function.
17788
+ * Default value: null
16244
17789
  */
16245
- renderMode?: GridGroupingRenderMode | string;
17790
+ formatFunction?: {(formatObject: {row?: GridRow, column?: GridColumn, cell?: GridCell, value?: any, template?: any}): void};
16246
17791
  /**
16247
17792
  * Sets the group row height.
16248
17793
  * Default value: 50
16249
17794
  */
16250
17795
  groupRowHeight?: string | number;
16251
17796
  /**
16252
- * Sets the indent of the group toggle button.
16253
- * Default value: 16
17797
+ * Sets or gets the data fields to group by.
17798
+ * Default value: []
16254
17799
  */
16255
- toggleButtonIndent?: number;
17800
+ groupBy?: string[];
16256
17801
  /**
16257
17802
  * Sets the indent of the group.
16258
17803
  * Default value: 16
@@ -16263,6 +17808,21 @@ export interface GridGrouping {
16263
17808
  * Default value: [object Object]
16264
17809
  */
16265
17810
  groupBar?: GridGroupingGroupBar;
17811
+ /**
17812
+ * Expands a group in the first grid render. Example: onGroupDefaultExpanded: (dataItem) =&gt;{ return dataItem.label === 'Peppermint Mocha Twist' }
17813
+ * Default value: null
17814
+ */
17815
+ onGroupDefaultExpanded?: any;
17816
+ /**
17817
+ * Sets the group render mode. 'basic' mode renders the group headers without taking into account the indent, groupRowHeight and column label properties. 'compact' mode is the same as basic, but also renders the column labels in the group headers. The default mode is 'advanced', which adds indents to groups that depend on the group level. In 'multipleColumns' mode, each group is displayed in its column.
17818
+ * Default value: advanced
17819
+ */
17820
+ renderMode?: GridGroupingRenderMode | string;
17821
+ /**
17822
+ * Sets the indent of the group toggle button.
17823
+ * Default value: 16
17824
+ */
17825
+ toggleButtonIndent?: number;
16266
17826
  /**
16267
17827
  * Describes the group summary row's settings.
16268
17828
  * Default value: [object Object]
@@ -16303,6 +17863,40 @@ export interface GridGroupingSummaryRow {
16303
17863
  visible?: boolean;
16304
17864
  }
16305
17865
 
17866
+ /**Sets the grid's image and filter upload settings for the image and attachment columns. */
17867
+ export interface GridUploadSettings {
17868
+ /**
17869
+ * Sets or file/image upload url.
17870
+ * Default value: ""
17871
+ */
17872
+ url?: string;
17873
+ /**
17874
+ * Sets or file/image remove url.
17875
+ * Default value: ""
17876
+ */
17877
+ removeUrl?: string;
17878
+ /**
17879
+ * Sets or gets the upload field name. In the backend, you can use this name to access the images data. For example in expressJS, you can use something like that: const images = req['files']['userfile[]'];
17880
+ * Default value: "userfile[]"
17881
+ */
17882
+ name?: string;
17883
+ /**
17884
+ * Additional data to pass to the server. The format should be a JSON string.
17885
+ * Default value: ""
17886
+ */
17887
+ data?: string;
17888
+ /**
17889
+ * Function called when the upload is completed. JSON object with 'files', 'status', 'fileURL' and 'serverResponse' are passed as parameters when the function is called by the Grid.
17890
+ * Default value:
17891
+ */
17892
+ onUploadCompleted?: any;
17893
+ /**
17894
+ * Function called when the upload has failed. JSON object with 'files', 'status' and 'serverResponse' are passed as parameters when the function is called by the Grid.
17895
+ * Default value:
17896
+ */
17897
+ onUploadError?: any;
17898
+ }
17899
+
16306
17900
  /**Describes the paging settings. */
16307
17901
  export interface GridPaging {
16308
17902
  /**
@@ -16320,6 +17914,11 @@ export interface GridPaging {
16320
17914
  * Default value: 10
16321
17915
  */
16322
17916
  pageSize?: number;
17917
+ /**
17918
+ * Sets the number of hierarchical rows per page. For example, displays 2 root groups per page, when grouping is enabled.
17919
+ * Default value: 2
17920
+ */
17921
+ pageHierarchySize?: number;
16323
17922
  /**
16324
17923
  * Sets the start page.
16325
17924
  * Default value: 0
@@ -16523,7 +18122,7 @@ export interface GridRowDetail {
16523
18122
  * Sets the template of the row details.
16524
18123
  * Default value:
16525
18124
  */
16526
- template?: any;
18125
+ template?: string | HTMLTemplateElement;
16527
18126
  /**
16528
18127
  * Sets the visibility of the Column which allows you to dynamically expand/collapse the row details.
16529
18128
  * Default value: true
@@ -16559,6 +18158,40 @@ export interface GridSummaryRow {
16559
18158
  editing?: boolean;
16560
18159
  }
16561
18160
 
18161
+ /**Sets the grid's state settings. */
18162
+ export interface GridStateSettings {
18163
+ /**
18164
+ * Enables or disables auto-save of the Grid's state
18165
+ * Default value: false
18166
+ */
18167
+ autoSave?: boolean;
18168
+ /**
18169
+ * Enables or disables save/load of the grid state.
18170
+ * Default value: true
18171
+ */
18172
+ enabled?: boolean;
18173
+ /**
18174
+ * Sets or gets the current state.
18175
+ * Default value: ""
18176
+ */
18177
+ current?: string;
18178
+ /**
18179
+ * Container which is auto-filled with state objects when you call the saveState method or enable the autoSave of states. Each object has a key which is the state's name and value which is a json with the state's properties.
18180
+ * Default value: null
18181
+ */
18182
+ storage?: any;
18183
+ /**
18184
+ * Function called when the state is changed.
18185
+ * Default value:
18186
+ */
18187
+ onStateChange?: any;
18188
+ /**
18189
+ * Array with state options such as 'sort', 'filter', 'expandedRows', 'paging', 'selectedCells', 'selectedRows', 'group', 'columns'. This property determines which parts of the state would be saved or loaded.
18190
+ * Default value:
18191
+ */
18192
+ options?: string[];
18193
+ }
18194
+
16562
18195
  /**Describes the settings for the group header. */
16563
18196
  export interface GridGroupHeader {
16564
18197
  /**
@@ -16584,12 +18217,12 @@ export interface GridHeader {
16584
18217
  * Sets a template for the header.
16585
18218
  * Default value:
16586
18219
  */
16587
- template?: string | HTMLTemplateElement;
18220
+ template?: string | HTMLTemplateElement | {(element: HTMLElement): void};
16588
18221
  /**
16589
18222
  * This callback function can be used for customization of the Header toolbar. The Toolbar HTML Element is passed as an argument.
16590
18223
  * Default value: null
16591
18224
  */
16592
- onInit?: any;
18225
+ onInit?: {(element: HTMLElement): void};
16593
18226
  /**
16594
18227
  * Determines the buttons displayed in the Grid header. 'columns' displays a button opening the columns chooser panel. 'filter' displays a button opening the filtering panel. 'group' displays a button opening the grouping panel. 'sort' displays a button opening the sorting panel. 'format' displays a button opening the conditional formatting panel. 'search' displays a button opening the search panel.
16595
18228
  * Default value: [ "columns", "filter", "group", "sort", "format", "search" ]
@@ -16608,7 +18241,7 @@ export interface GridFooter {
16608
18241
  * Sets a template for the footer.
16609
18242
  * Default value:
16610
18243
  */
16611
- template?: string | HTMLTemplateElement;
18244
+ template?: string | HTMLTemplateElement | {(element: HTMLElement): void};
16612
18245
  }
16613
18246
 
16614
18247
  export interface GridRow {
@@ -16986,16 +18619,36 @@ export interface GridSorting {
16986
18619
  * Default value:
16987
18620
  */
16988
18621
  sort?: string[];
18622
+ /**
18623
+ * Maintains sorting when user edits data in the sorted column. The feature is useful when you want to apply sort just once and you set the property to false.
18624
+ * Default value: true
18625
+ */
18626
+ maintainSort?: boolean;
16989
18627
  /**
16990
18628
  * Sets the count of allowed sorting columns. When the property value is set to 'many', users can sort data by multiple columns.
16991
18629
  * Default value: one
16992
18630
  */
16993
18631
  mode?: GridSortingMode | string;
18632
+ /**
18633
+ * Sets the command key. The property is used in the multi-column sorting. If commandKey='Control', users will be able to sort by multiple columns only while holding the 'Control' key.
18634
+ * Default value: Default
18635
+ */
18636
+ commandKey?: GridSortingCommandKey | string;
16994
18637
  /**
16995
18638
  * Enables switching between the three sort states: ascending, descending and not sorted.
16996
18639
  * Default value: true
16997
18640
  */
16998
18641
  sortToggleThreeStates?: boolean;
18642
+ /**
18643
+ * Enables switching between the sort states on column click. This is the default behavior.
18644
+ * Default value: true
18645
+ */
18646
+ sortToggleOnClick?: boolean;
18647
+ /**
18648
+ * Enables switching between the sort states on column click and holding down the command key.
18649
+ * Default value: false
18650
+ */
18651
+ sortToggleOnClickAndCommandKey?: boolean;
16999
18652
  }
17000
18653
 
17001
18654
  declare global {
@@ -17046,8 +18699,8 @@ export declare type GridFilteringFilterRowApplyMode = 'auto' | 'click';
17046
18699
  export declare type GridFilteringFilterMenuMode = 'default' | 'excel';
17047
18700
  /**Sets the group expand mode. */
17048
18701
  export declare type GridGroupingExpandMode = 'buttonClick' | 'rowClick';
17049
- /**Sets the group render mode. 'basic' mode renders the group headers without taking into account the indent, groupRowHeight and column label properties. 'compact' mode is the same as basic, but also renders the column labels in the group headers. The default mode is 'advanced', which adds indents to groups that depend on the group level. */
17050
- export declare type GridGroupingRenderMode = 'basic' | 'compact' | 'advanced';
18702
+ /**Sets the group render mode. 'basic' mode renders the group headers without taking into account the indent, groupRowHeight and column label properties. 'compact' mode is the same as basic, but also renders the column labels in the group headers. The default mode is 'advanced', which adds indents to groups that depend on the group level. In 'multipleColumns' mode, each group is displayed in its column. */
18703
+ export declare type GridGroupingRenderMode = 'basic' | 'compact' | 'advanced' | 'multipleColumns';
17051
18704
  /**Sets the ellipsis display mode. */
17052
18705
  export declare type GridPagerAutoEllipsis = 'none' | 'before' | 'after' | 'both';
17053
18706
  /**Sets or gets whether the selection allows you to select 'one', 'many' or a variation of 'many' called 'extended'. 'one' allows you to have only single cell or row selected. 'many' */
@@ -17058,6 +18711,8 @@ export declare type GridSelectionAction = 'none' | 'click' | 'doubleClick';
17058
18711
  export declare type GridSelectionCheckBoxesSelectAllMode = 'none' | 'page' | 'all';
17059
18712
  /**Sets the count of allowed sorting columns. When the property value is set to 'many', users can sort data by multiple columns. */
17060
18713
  export declare type GridSortingMode = 'one' | 'many';
18714
+ /**Sets the command key. The property is used in the multi-column sorting. If commandKey='Control', users will be able to sort by multiple columns only while holding the 'Control' key. */
18715
+ export declare type GridSortingCommandKey = 'Default' | 'Alt' | 'Control' | 'Shift';
17061
18716
  export interface GroupPanelProperties {
17062
18717
  /**
17063
18718
  * Sets or gets the animation mode. Animation is disabled when the property is set to 'none'
@@ -17473,6 +19128,11 @@ export interface KanbanProperties {
17473
19128
  * Default value: true
17474
19129
  */
17475
19130
  allowDrop?: boolean;
19131
+ /**
19132
+ * This property changes the visual appeal of the Kanban columns and tasks. When set to true and the Kanban columns have their 'color' property set, the color is also applied to the tasks and edit dialog.
19133
+ * Default value: false
19134
+ */
19135
+ applyColumnColorToTasks?: boolean;
17476
19136
  /**
17477
19137
  * Enables or disables auto load state from the browser's localStorage. Information about tasks and their position and selected state, filtering, sorting, collapsed columns, as well as the values of the properties taskActions, taskComments, taskDue, taskPriority, taskProgress, taskTags, and taskUserIcon is loaded.
17478
19138
  * Default value: true
@@ -17483,6 +19143,11 @@ export interface KanbanProperties {
17483
19143
  * Default value: false
17484
19144
  */
17485
19145
  autoSaveState?: boolean;
19146
+ /**
19147
+ * Automatically updates the columns height depending on the tasks inside the column. The effect of this property is observed when 'columnColorEntireSurface' is true.
19148
+ * Default value: false
19149
+ */
19150
+ autoColumnHeight?: boolean;
17486
19151
  /**
17487
19152
  * Allows collapsing the card content.
17488
19153
  * Default value: false
@@ -17603,6 +19268,31 @@ export interface KanbanProperties {
17603
19268
  * Default value: * { 'en': { 'addFilter': '+ Add filter', 'and': 'And', 'apply': 'Apply', 'booleanFirst': '☐', 'booleanLast': '☑', 'cancel': 'Cancel', 'CONTAINS': 'contains', 'CONTAINS_CASE_SENSITIVE': 'contains (case sensitive)', 'dateFirst': '1', 'dateLast': '9', 'DOES_NOT_CONTAIN': 'does not contain', 'DOES_NOT_CONTAIN_CASE_SENSITIVE': 'does not contain (case sensitive)', 'EMPTY': 'empty', 'ENDS_WITH': 'ends with', 'ENDS_WITH_CASE_SENSITIVE': 'ends with (case sensitive)', 'EQUAL': 'equal', 'EQUAL_CASE_SENSITIVE': 'equal (case sensitive)', 'filter': 'Filter', 'filteredByMultiple': '%', 'removeComment': 'Remove comment', 'promptColumn': 'Are you sure you want to remove this column?'} }
17604
19269
  */
17605
19270
  messages?: any;
19271
+ /**
19272
+ * Callback function which can be used for customizing the tasks rendering. The Kanban calls it with 2 arguments - task html element and task data.
19273
+ * Default value: null
19274
+ */
19275
+ onTaskRender?: any;
19276
+ /**
19277
+ * Callback function which can be used for customizing the filter items. The function is called with 1 argument - Array of items which will be displayed in the filter drop down. You can modify that array to remove or update items to filter by.
19278
+ * Default value: null
19279
+ */
19280
+ onFilterPrepare?: any;
19281
+ /**
19282
+ * Callback function which can be used for customizing the sort items. The function is called with 1 argument - Array of items which will be displayed in the sort drop down. You can modify that array to remove or update items to sort by.
19283
+ * Default value: null
19284
+ */
19285
+ onSortPrepare?: any;
19286
+ /**
19287
+ * Callback function which can be used for customizing the column header rendering. The Kanban calls it with 3 arguments - column header html element and column data and column data field.
19288
+ * Default value: null
19289
+ */
19290
+ onColumnHeaderRender?: any;
19291
+ /**
19292
+ * Callback function which can be used for customizing the column footer rendering. The Kanban calls it with 3 arguments - column header html element and column data and column data field.
19293
+ * Default value: null
19294
+ */
19295
+ onColumnFooterRender?: any;
17606
19296
  /**
17607
19297
  * Determines selection mode.
17608
19298
  * Default value: zeroOrOne
@@ -17623,6 +19313,11 @@ export interface KanbanProperties {
17623
19313
  * Default value: false
17624
19314
  */
17625
19315
  rightToLeft?: boolean;
19316
+ /**
19317
+ * Sets or gets whether the edit dialog is displayed in readonly mode. In that mode it shows only the task details, but the editing is disabled. However, if comments are enabled, you will be able to add comments in the dialog.
19318
+ * Default value: false
19319
+ */
19320
+ readonly?: boolean;
17626
19321
  /**
17627
19322
  * Describes the swimlanes in the kanban board. Sub-columns are not applicable when swimlanes are present.
17628
19323
  * Default value:
@@ -17648,6 +19343,11 @@ export interface KanbanProperties {
17648
19343
  * Default value: false
17649
19344
  */
17650
19345
  taskActions?: boolean;
19346
+ /**
19347
+ * Represents a callback function which is called when the task actions menu is created. The task actions element is passed as parameter and allows you to customize the menu. Example: (list) => { list.innerHTML = 'Custom Item'; list.onclick = () => { alert('clicked'); }}
19348
+ * Default value: null
19349
+ */
19350
+ taskActionsRendered?: any;
17651
19351
  /**
17652
19352
  * Toggles the visibility of the task comments icon.
17653
19353
  * Default value: false
@@ -17907,7 +19607,14 @@ export interface Kanban extends BaseElement, KanbanProperties {
17907
19607
  * @param event. The custom event. */
17908
19608
  onSort?: ((this: any, ev: Event) => any) | ((this: any, ev: CustomEvent<any>) => any) | null;
17909
19609
  /**
17910
- * This event is triggered when a new task is added.
19610
+ * This event is triggered before a new task is added. You can use the event.detail.value and event.detail.id to customize the new Task before adding it to the Kanban. Example: kanban.onTaskBeforeAdd = (event) => { const data = event.detail.value; const id = event.detail.id; event.detail.id = 'BG12';}
19611
+ * @param event. The custom event. Custom data event was created with: ev.detail(value, id)
19612
+ * value - The task data that is added to the Kanban.
19613
+ * id - The task data id.
19614
+ */
19615
+ onTaskBeforeAdd?: ((this: any, ev: Event) => any) | ((this: any, ev: CustomEvent<any>) => any) | null;
19616
+ /**
19617
+ * This event is triggered when a new task is added. Example: kanban.onTaskAdd = (event) => { const data = event.detail.value; const id = event.detail.id; }
17911
19618
  * @param event. The custom event. Custom data event was created with: ev.detail(value, id)
17912
19619
  * value - The task data that is added to the Kanban.
17913
19620
  * id - The task data id.
@@ -17943,15 +19650,15 @@ export interface Kanban extends BaseElement, KanbanProperties {
17943
19650
  */
17944
19651
  onTaskDoubleClick?: ((this: any, ev: Event) => any) | ((this: any, ev: CustomEvent<any>) => any) | null;
17945
19652
  /**
17946
- * Adds filtering
17947
- * @param {string[]} filters. Filter information
17948
- * @param {string} operator?. Logical operator between the filters of different fields
19653
+ * Adds filtering. Example: const filterGroup = new Smart.FilterGroup(); const filterObject = filterGroup.createFilter('string', 'Italy', 'contains'); filterGroup.addFilter('and', filterObject); kanban.addFilter([['Country', filterGroup]]);
19654
+ * @param {any} filters. Filter information. Example: kanban.addFilter([['Country', filterGroup]]);. Each array item is a sub array with two items - 'dataField' and 'filterGroup' object. The 'dataField' is any valid data field from the data source bound to the Kanban like 'dueDate', 'startDate' or custom fields like 'Country'. Filter conditions which you can use in the expressions: '=', 'EQUAL','&lt;&gt;', 'NOT_EQUAL', '!=', '&lt;', 'LESS_THAN','&gt;', 'GREATER_THAN', '&lt;=', 'LESS_THAN_OR_EQUAL', '&gt;=', 'GREATER_THAN_OR_EQUAL','starts with', 'STARTS_WITH','ends with', 'ENDS_WITH', '', 'EMPTY', 'CONTAINS','DOES_NOT_CONTAIN', 'NULL','NOT_NULL'
19655
+ * @param {string} operator?. Logical operator between the filters of different fields. Possible values are: 'and', 'or'.
17949
19656
  */
17950
- addFilter(filters: string[], operator?: string): void;
19657
+ addFilter(filters: any, operator?: string): void;
17951
19658
  /**
17952
- * Adds sorting
19659
+ * Adds sorting. Example: kanban.addSort(['Country'], 'ascending');
17953
19660
  * @param {[] | string} dataFields. The data field(s) to sort by
17954
- * @param {[] | string} orderBy. The sort direction(s) to sort the data field(s) by
19661
+ * @param {[] | string} orderBy. The sort direction(s) to sort the data field(s) by. Possible values are: 'ascending' and 'descending'.
17955
19662
  */
17956
19663
  addSort(dataFields: [] | string, orderBy: [] | string): void;
17957
19664
  /**
@@ -18224,21 +19931,6 @@ export interface KanbanDataSource {
18224
19931
  * Default value: null
18225
19932
  */
18226
19933
  dueDate?: Date;
18227
- /**
18228
- * Callback function which can be used for customizing the tasks rendering. The Kanban calls it with 2 arguments - task html element and task data.
18229
- * Default value: null
18230
- */
18231
- onTaskRender?: any;
18232
- /**
18233
- * Callback function which can be used for customizing the column header rendering. The Kanban calls it with 3 arguments - column header html element and column data and column data field.
18234
- * Default value: null
18235
- */
18236
- onColumnHeaderRender?: any;
18237
- /**
18238
- * Callback function which can be used for customizing the column footer rendering. The Kanban calls it with 3 arguments - column header html element and column data and column data field.
18239
- * Default value: null
18240
- */
18241
- onColumnFooterRender?: any;
18242
19934
  /**
18243
19935
  * The task's priority.
18244
19936
  * Default value: "normal"
@@ -21642,12 +23334,14 @@ export interface NumberInput extends BaseElement, NumberInputProperties {
21642
23334
  * Returns the value in the desired format.
21643
23335
  * @param {string | number} value. The value to be formatted by the method.
21644
23336
  * @param {any} format?. The object that contains the formatting properties. The argument should contain Intl.NumberFormat valid properties. For example, { style: 'currency', currency: 'EUR' }
23337
+ * @returns {string}
21645
23338
  */
21646
- getFormattedValue(value: string | number, format?: any): void;
23339
+ getFormattedValue(value: string | number, format?: any): string;
21647
23340
  /**
21648
23341
  * Returns the number of the input.
23342
+ * @returns {number}
21649
23343
  */
21650
- getValue(): void;
23344
+ getValue(): number;
21651
23345
  /**
21652
23346
  * Selects the text inside the input or if it is <b>readonly</b> then the element is focused.
21653
23347
  */
@@ -23721,6 +25415,11 @@ export interface QueryBuilderProperties {
23721
25415
  * Default value: change
23722
25416
  */
23723
25417
  applyMode?: QueryBuilderApplyMode | string;
25418
+ /**
25419
+ * When 'applyMode' is set to 'immediately', the default value is applied to the editor's value and the QueryBuilder's value is updated automatically.
25420
+ * Default value: false
25421
+ */
25422
+ autoApplyValue?: boolean;
23724
25423
  /**
23725
25424
  * Determines whether QueryBuilder will automatically prompt the user to enter a condition value when a new condition is created. When 'applyMode' is set to 'immediately', the operation field is automatically populated if empty when the selected condition operator is changed. The input field prompts the user when the operation or operator of the condition is changed.
23726
25425
  * Default value: false
@@ -23940,6 +25639,13 @@ export interface QueryBuilder extends BaseElement, QueryBuilderProperties {
23940
25639
  * value - The value of the selected property.
23941
25640
  */
23942
25641
  onPropertySelected?: ((this: any, ev: Event) => any) | ((this: any, ev: CustomEvent<any>) => any) | null;
25642
+ /**
25643
+ * This event is triggered when the component validates the input values. This happens when you input a new value and focus another component.
25644
+ * @param event. The custom event. Custom data event was created with: ev.detail(oldValue, newValue)
25645
+ * oldValue - Old validation status.
25646
+ * newValue - New validation status.
25647
+ */
25648
+ onValidationChange?: ((this: any, ev: Event) => any) | ((this: any, ev: CustomEvent<any>) => any) | null;
23943
25649
  /**
23944
25650
  * Converts the current value of the element to DynamicLINQ expression.
23945
25651
  * @returns {string}
@@ -24395,6 +26101,16 @@ export interface SchedulerProperties {
24395
26101
  * Default value: 30
24396
26102
  */
24397
26103
  autoScrollStep?: number;
26104
+ /**
26105
+ * Determines whether the all day cells in Day and Week views automatically change their height depending on the events count in these cells.
26106
+ * Default value: false
26107
+ */
26108
+ autoHeightAllDayCells?: boolean;
26109
+ /**
26110
+ * Defines an array of objects with start and end fields, where start and end are Date objects. For example: [{ 'start': '2022-10-25T12:00.000Z', 'end': '2022-10-25T13:00.000Z' }].
26111
+ * Default value:
26112
+ */
26113
+ available?: any;
24398
26114
  /**
24399
26115
  * Determines the color scheme for the event background selector in the event window editor.
24400
26116
  * Default value: #D50000,#E67C73,#F4511E,#F6BF26,#33B679,#0B8043,#039BE5,#3F51B5,#7986CB,#8E24AA,#616161,
@@ -24660,6 +26376,16 @@ export interface SchedulerProperties {
24660
26376
  * Default value: near
24661
26377
  */
24662
26378
  legendPosition?: SchedulerLegendPosition | string;
26379
+ /**
26380
+ * Determines the layout of the legend items.
26381
+ * Default value: auto
26382
+ */
26383
+ legendLayout?: SchedulerLegendLayout | string;
26384
+ /**
26385
+ * Determines the number of items when the legend switches automatically from horizontal list to menu.
26386
+ * Default value: 10
26387
+ */
26388
+ legendLayoutMenuBreakpoint?: number;
24663
26389
  /**
24664
26390
  * Determines the mouse wheel step. When this property is set to a positive number, the scroll step with mouse wheel or trackpad will depend on the property value.
24665
26391
  * Default value: 50
@@ -24745,6 +26471,11 @@ export interface SchedulerProperties {
24745
26471
  * Default value:
24746
26472
  */
24747
26473
  restrictedHours?: any;
26474
+ /**
26475
+ * Defines an array of dates and hours that are not allowed to have events on. Events that overlap restricted Hours or start/end on them will not be displayed. Each array item is an Object and requires 2 fields - date and hours. For example: { date: new Date(2022, 10, 1), hours: [[0, 6], 12, [20, 23]] }. The hours define a range of restricted hours similartly to the restricted hours property, the date defines a date where the restricted hours will be applied.
26476
+ * Default value:
26477
+ */
26478
+ restricted?: any;
24748
26479
  /**
24749
26480
  * Sets or gets the value indicating whether the element is aligned to support locales using right-to-left fonts.
24750
26481
  * Default value: false
@@ -24817,7 +26548,7 @@ export interface SchedulerProperties {
24817
26548
  timeRulerTicks?: boolean;
24818
26549
  /**
24819
26550
  * Determines the timeZone for the element. By default if the local time zone is used if the property is not set.
24820
- * Default value:
26551
+ * Default value: Local
24821
26552
  */
24822
26553
  timeZone?: SchedulerTimeZone | string;
24823
26554
  /**
@@ -24860,6 +26591,11 @@ export interface SchedulerProperties {
24860
26591
  * Default value: menu
24861
26592
  */
24862
26593
  viewSelectorType?: SchedulerViewSelectorType | string;
26594
+ /**
26595
+ * Determines the Start Date rule. The Week and TimelineWeek views start by default from the current date taking into account the firstDayOfWeek property. When this property is set to 'dateCurrent', these views will start from the value of the 'dateCurrent'.
26596
+ * Default value: firstDayOfWeek
26597
+ */
26598
+ viewStartDay?: SchedulerViewStartDay | string;
24863
26599
  /**
24864
26600
  * Determines the format of the week days inside the element.
24865
26601
  * Default value: short
@@ -25167,6 +26903,16 @@ export interface Scheduler extends BaseElement, SchedulerProperties {
25167
26903
  * @param {any} eventObj. An object describing a Scheduler event that is not already present in the element.
25168
26904
  */
25169
26905
  addEvent(eventObj: any): void;
26906
+ /**
26907
+ * Adds a new view. Example: scheduler.addView('week', 'My View', 'myView', false, false, 10); scheduler.setView('myView');
26908
+ * @param {string} type. The view type.
26909
+ * @param {string} label. The view's label displayed in the header.
26910
+ * @param {string} value. The view's value used to identify the view.
26911
+ * @param {boolean} hideWeekend. Determines whether to hide the weekend.
26912
+ * @param {boolean} hideNonworkingWeekdays. Determines whether to hide the non working days.
26913
+ * @param {number} additionalDays. Determines whether to add additional days to the view.
26914
+ */
26915
+ addView(type: string, label: string, value: string, hideWeekend: boolean, hideNonworkingWeekdays: boolean, additionalDays: number): void;
25170
26916
  /**
25171
26917
  * Starts an update operation. This is appropriate when calling multiple methods or set multiple properties at once.
25172
26918
  */
@@ -25184,6 +26930,11 @@ export interface Scheduler extends BaseElement, SchedulerProperties {
25184
26930
  * Ends the update operation. This method will resume the rendering and will refresh the element.
25185
26931
  */
25186
26932
  endUpdate(): void;
26933
+ /**
26934
+ * Returns an array of the start and end view dates.
26935
+ * @returns {Date[]}
26936
+ */
26937
+ getViewDates(): Date[];
25187
26938
  /**
25188
26939
  * Refereshes the Scheduler by recalculating the Scrollbars.
25189
26940
  * @param {boolean} fullRefresh?. If set the Scheduler will be re-rendered completely.
@@ -25238,6 +26989,11 @@ export interface Scheduler extends BaseElement, SchedulerProperties {
25238
26989
  * @param {any[]} state?. An Array containing a valid structure of Scheduler events.
25239
26990
  */
25240
26991
  saveState(state?: any[]): void;
26992
+ /**
26993
+ * Sets the Scheduler's view. Example: scheduler.addView('week', 'My View', 'myView', false, false, 10); scheduler.setView('myView');
26994
+ * @param {string} view?. The view's value. For example: 'day'.
26995
+ */
26996
+ setView(view?: string): void;
25241
26997
  /**
25242
26998
  * Checks whether the Scheduler contains the event.
25243
26999
  * @param {any} eventObj. A Scheduler event object.
@@ -25657,6 +27413,8 @@ export declare type SchedulerHeaderViewPosition = 'far' | 'near';
25657
27413
  export declare type SchedulerLegendLocation = 'footer' | 'header';
25658
27414
  /**Determines the position of the legend. By default it's positioned to the near side but setting it to 'far' will change that. */
25659
27415
  export declare type SchedulerLegendPosition = 'near' | 'far';
27416
+ /**Determines the layout of the legend items. */
27417
+ export declare type SchedulerLegendLayout = null | 'auto' | 'menu';
25660
27418
  /**Determines the minute formatting inside the Scheduler. */
25661
27419
  export declare type MinuteFormat = '2-digit' | 'numeric';
25662
27420
  /**Determines the visibility of the resize handles. */
@@ -25673,17 +27431,12 @@ export declare type SchedulerTimelineDayScale = 'hour' | 'halfHour' | 'quarterHo
25673
27431
  export declare type SchedulerTimeZone = 'Local' | 'Dateline Standard Time' | 'UTC-11' | 'Hawaiteratoran Standard Time' | 'Alaskan Standard Time' | 'Pacific Standard Time (Mexico)' | 'Pacific Standard Time' | 'US Mountain Standard Time' | 'Mountain Standard Time (Mexico)' | 'Mountain Standard Time' | 'Central Standard Time' | 'Central America Standard Time' | 'Canada Central Standard Time' | 'Central Standard Time (Mexico)' | 'SA Pacific Standard Time' | 'Eastern Standard Time' | 'US Eastern Standard Time' | 'Venezuela Standard Time' | 'Atlantic Standard Time' | 'Paraguay Standard Time' | 'Central Brazilian Standard Time' | 'Pacific SA Standard Time' | 'SA Western Standard Time' | 'Newfoundland Standard Time' | 'SA Eastern Standard Time' | 'Argentina Standard Time' | 'E. South America Standard Time' | 'Bahia Standard Time' | 'Montevideo Standard Time' | 'Greenland Standard Time' | 'UTC-02' | 'Mid-Atlantic Standard Time' | 'Azores Standard Time' | 'Cape Verde Standard Time' | 'Morocco Standard Time' | 'UTC' | 'GMT Standard Time' | 'Greenwich Standard Time' | 'Central European Standard Time' | 'Namibia Standard Time' | 'W. Central Africa Standard Time' | 'W. Europe Standard Time' | 'Central Europe Standard Time' | 'Romance Standard Time' | 'FLE Standard Time' | 'South Africa Standard Time' | 'Turkey Standard Time' | 'GTB Standard Time' | 'Libya Standard Time' | 'E. Europe Standard Time' | 'Jordan Standard Time' | 'Middle East Standard Time' | 'Egypt Standard Time' | 'Syria Standard Time' | 'Israel Standard Time' | 'Arab Standard Time' | 'E. Africa Standard Time' | 'Arabic Standard Time' | 'Kaliningrad Standard Time' | 'Iran Standard Time' | 'Mauritius Standard Time' | 'Georgian Standard Time' | 'Caucasus Standard Time' | 'Arabian Standard Time' | 'Azerbaijan Standard Time' | 'Russian Standard Time' | 'Afghanistan Standard Time' | 'Pakistan Standard Time' | 'West Asia Standard Time' | 'India Standard Time' | 'Sri Lanka Standard Time' | 'Nepal Standard Time' | 'Central Asia Standard Time' | 'Bangladesh Standard Time' | 'Ekaterinburg Standard Time' | 'Myanmar Standard Time' | 'SE Asia Standard Time' | 'N. Central Asia Standard Time' | 'Ulaanbaatar Standard Time' | 'China Standard Time' | 'Singapore Standard Time' | 'North Asia Standard Time' | 'Taipei Standard Time' | 'W. Australia Standard Time' | 'Korea Standard Time' | 'North Asia East Standard Time' | 'Tokyo Standard Time' | 'AUS Central Standard Time' | 'Cen. Australia Standard Time' | 'West Pacific Standard Time' | 'Tasmania Standard Time' | 'E. Australia Standard Time' | 'AUS Eastern Standard Time' | 'Yakutsk Standard Time' | 'Vladivostok Standard Time' | 'Central Pacific Standard Time' | 'Magadan Standard Time' | 'Kamchatka Standard Time' | 'Fiji Standard Time' | 'New Zealand Standard Time' | 'UTC+12' | 'Tonga Standard Time' | 'Samoa Standard Time';
25674
27432
  /**Indicates the current Scheduler viewType. Custom views must contain a valid <b>type</b> property that corresponds to one of the view types. This property should not be set. */
25675
27433
  export declare type SchedulerViewType = 'day' | 'week' | 'month' | 'agenda' | 'timelineDay' | 'timelineWeek' | 'timelineMonth';
25676
- /**Determines the viewing date range of the timeline. The property should be set to an array of strings or view objects. When you set it to a string, you should use any of the following: 'day', 'week', 'month', 'agenda', 'timelineDay', 'timelineWeek', 'timelineMonth'. Custom views can be defined as objects instead of strings. The view object should contain the following properties: <b>label</b> - the label for the view.
25677
- <b>value</b> - the value for the view. The value is the unique identifier for the view.
25678
- <b>type</b> - the type of view. The type should be one of the default allowed values for a view.
25679
- <b>hideWeekend</b> - an Optional property that allows to hide the weekend only for this specific view.
25680
- <b>hideNonworkingWeekdays</b> - an Optional property that allows to hide the nonwrking weekdays for this specific view.
25681
- <b>shortcutKey</b> - an Optional property that allows to set a custom shortcut key for the view.
25682
- <b>hideHours</b> - an Optional property applicable only to <b>timelineWeek</b> view that allows to hide the hour cells and only show the day cells.
25683
- */
25684
- export declare type SchedulerViews = 'day' | 'week' | 'month' | 'agenda' | 'timelineDay' | 'timelineWeek' | 'timelineMonth';
27434
+
27435
+ export declare type SchedulerViews = SchedulerViewType[] | object[] | string[];
25685
27436
  /**Determines type of the view selector located in the header of the element. */
25686
27437
  export declare type SchedulerViewSelectorType = 'auto' | 'tabs' | 'menu';
27438
+ /**Determines the Start Date rule. The Week and TimelineWeek views start by default from the current date taking into account the firstDayOfWeek property. When this property is set to 'dateCurrent', these views will start from the value of the 'dateCurrent'. */
27439
+ export declare type SchedulerViewStartDay = 'firstDayOfWeek' | 'dateCurrent';
25687
27440
  /**Determines the format of the week days inside the element. */
25688
27441
  export declare type WeekDayFormat = 'short' | 'long' | 'narrow';
25689
27442
  export interface ScrollBarProperties {
@@ -27288,6 +29041,16 @@ export interface TableProperties {
27288
29041
  * Default value: null
27289
29042
  */
27290
29043
  onInit?: { (): void };
29044
+ /**
29045
+ * A callback function executed after the Table is being initialized.
29046
+ * Default value: null
29047
+ */
29048
+ onLoad?: { (): void };
29049
+ /**
29050
+ * A callback function executed when the Table's update is finished in the endUpdate method.
29051
+ * Default value: null
29052
+ */
29053
+ onUpdateComplete?: { (): void };
27291
29054
  /**
27292
29055
  * Sets or gets the page size (when paging is enabled).
27293
29056
  * Default value: 10
@@ -27499,7 +29262,7 @@ export interface Table extends BaseElement, TableProperties {
27499
29262
  /**
27500
29263
  * Adds a filter to a specific column.
27501
29264
  * @param {string} dataField. The column's data field.
27502
- * @param {any} filter. FilterGroup object.
29265
+ * @param {any} filter. FilterGroup object or a Filter expression. Filter expression like: 'startsWith B'. Example 2: ['contains Andrew or contains Nancy'], Example 3: ['quantity', '&lt;= 3 and &gt;= 8']. Filter conditions which you can use in the expressions: '=', 'EQUAL','&lt;&gt;', 'NOT_EQUAL', '!=', '&lt;', 'LESS_THAN','&gt;', 'GREATER_THAN', '&lt;=', 'LESS_THAN_OR_EQUAL', '&gt;=', 'GREATER_THAN_OR_EQUAL','starts with', 'STARTS_WITH','ends with', 'ENDS_WITH', '', 'EMPTY', 'CONTAINS','DOES_NOT_CONTAIN', 'NULL','NOT_NULL'
27503
29266
  */
27504
29267
  addFilter(dataField: string, filter: any): void;
27505
29268
  /**
@@ -29973,6 +31736,11 @@ export interface TreeProperties {
29973
31736
  * Default value: false
29974
31737
  */
29975
31738
  filterable?: boolean;
31739
+ /**
31740
+ * Applies a filter only after the 'Enter' key is pressed.
31741
+ * Default value: false
31742
+ */
31743
+ filterOnEnter?: boolean;
29976
31744
  /**
29977
31745
  * Sets custom text for placeholder in the filter input.
29978
31746
  * Default value: ""