@smart-webcomponents-angular/toast 13.1.70 → 16.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/common/runtime.js +6 -1
- package/esm2020/toast/smart.toast.mjs +1 -1
- package/fesm2015/smart-webcomponents-angular-toast.mjs.map +1 -1
- package/fesm2020/smart-webcomponents-angular-toast.mjs.map +1 -1
- package/images/load.gif +0 -0
- package/index.d.ts +2110 -174
- package/package.json +18 -24
- package/source/modules/smart.toast.js +2 -2
- package/source/smart.button.js +2 -2
- package/source/smart.element.js +3 -3
- package/source/smart.toast.js +3 -3
- package/styles/font/smart-icons.eot +0 -0
- package/styles/font/smart-icons.svg +43 -1
- package/styles/font/smart-icons.ttf +0 -0
- package/styles/font/smart-icons.woff +0 -0
- package/styles/font/smart-icons.woff2 +0 -0
- package/styles/smart.base.css +2 -2
- package/styles/smart.common.css +1 -1
- package/toast/smart-webcomponents-angular-toast.d.ts +1 -1
- package/demo/angular.json +0 -126
- package/demo/package.json +0 -52
- package/demo/src/app/app.component.css +0 -0
- package/demo/src/app/app.component.html +0 -2
- package/demo/src/assets/fonts.css +0 -13
- package/demo/src/assets/styles.css +0 -12
- package/demo/src/index.html +0 -42
- package/demo/src/tsconfig.app.json +0 -15
- package/demo/src/tsconfig.json +0 -23
- package/start.js +0 -5
package/index.d.ts
CHANGED
|
@@ -1,6 +1,1257 @@
|
|
|
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 data formatting settings for the values in the serie.
|
|
174
|
+
* Default value: [object Object]
|
|
175
|
+
*/
|
|
176
|
+
toolTipFormatSettings?: ThreeDChartFormatSettings;
|
|
177
|
+
/**
|
|
178
|
+
* Tooltip line color. By default it is set to the hovered item's color
|
|
179
|
+
* Default value: null
|
|
180
|
+
*/
|
|
181
|
+
toolTipLineColor?: string | null;
|
|
182
|
+
/**
|
|
183
|
+
* An object with settings about the Chart's y-axis (value axis).
|
|
184
|
+
* Default value: [object Object]
|
|
185
|
+
*/
|
|
186
|
+
valueAxis?: ThreeDChartValueAxis;
|
|
187
|
+
/**
|
|
188
|
+
* Sets the Chart's xAxis.
|
|
189
|
+
* Default value: [object Object]
|
|
190
|
+
*/
|
|
191
|
+
xAxis?: ThreeDChartXAxis;
|
|
192
|
+
/**
|
|
193
|
+
* Sets the Chart's zAxis.
|
|
194
|
+
* Default value: [object Object]
|
|
195
|
+
*/
|
|
196
|
+
zAxis?: ThreeDChartZAxis;
|
|
197
|
+
}
|
|
198
|
+
/**
|
|
199
|
+
3D Chart is a feature-complete interactive WebGL 3D graph library that answers the data visualization needs of any modern web app.
|
|
200
|
+
*/
|
|
201
|
+
export interface ThreeDChart extends BaseElement, ThreeDChartProperties {
|
|
202
|
+
|
|
203
|
+
/* Get a member by its name */
|
|
204
|
+
[name: string]: any;
|
|
205
|
+
/**
|
|
206
|
+
* The event is raised when the user clicks on a chart element.
|
|
207
|
+
* @param event. The custom event. Custom data event was created with: ev.detail(itemIndex, serieIndex, groupIndex)
|
|
208
|
+
* itemIndex - The item index of the item.
|
|
209
|
+
* serieIndex - The serie index of the item.
|
|
210
|
+
* groupIndex - The group index of the item.
|
|
211
|
+
*/
|
|
212
|
+
onItemClick?: ((this: any, ev: Event) => any) | ((this: any, ev: CustomEvent<any>) => any) | null;
|
|
213
|
+
/**
|
|
214
|
+
* The event is raised when a chart element is shown.
|
|
215
|
+
* @param event. The custom event. Custom data event was created with: ev.detail(itemIndex, serieIndex, groupIndex)
|
|
216
|
+
* itemIndex - The item index of the item.
|
|
217
|
+
* serieIndex - The serie index of the item.
|
|
218
|
+
* groupIndex - The group index of the item.
|
|
219
|
+
*/
|
|
220
|
+
onShow?: ((this: any, ev: Event) => any) | ((this: any, ev: CustomEvent<any>) => any) | null;
|
|
221
|
+
/**
|
|
222
|
+
* The event is raised when a chart element is hidden.
|
|
223
|
+
* @param event. The custom event. Custom data event was created with: ev.detail(itemIndex, serieIndex, groupIndex)
|
|
224
|
+
* itemIndex - The item index of the item.
|
|
225
|
+
* serieIndex - The serie index of the item.
|
|
226
|
+
* groupIndex - The group index of the item.
|
|
227
|
+
*/
|
|
228
|
+
onHide?: ((this: any, ev: Event) => any) | ((this: any, ev: CustomEvent<any>) => any) | null;
|
|
229
|
+
/**
|
|
230
|
+
* The event is raised when a chart element is selected.
|
|
231
|
+
* @param event. The custom event. Custom data event was created with: ev.detail(itemIndex, serieIndex, groupIndex)
|
|
232
|
+
* itemIndex - The item index of the item.
|
|
233
|
+
* serieIndex - The serie index of the item.
|
|
234
|
+
* groupIndex - The group index of the item.
|
|
235
|
+
*/
|
|
236
|
+
onSelect?: ((this: any, ev: Event) => any) | ((this: any, ev: CustomEvent<any>) => any) | null;
|
|
237
|
+
/**
|
|
238
|
+
* The event is raised when a chart element is unselected.
|
|
239
|
+
* @param event. The custom event. Custom data event was created with: ev.detail(itemIndex, serieIndex, groupIndex)
|
|
240
|
+
* itemIndex - The item index of the item.
|
|
241
|
+
* serieIndex - The serie index of the item.
|
|
242
|
+
* groupIndex - The group index of the item.
|
|
243
|
+
*/
|
|
244
|
+
onUnselect?: ((this: any, ev: Event) => any) | ((this: any, ev: CustomEvent<any>) => any) | null;
|
|
245
|
+
/**
|
|
246
|
+
* The event is raised after the chart's range selector position changes and after the chart ends rendering.
|
|
247
|
+
* @param event. The custom event. Custom data event was created with: ev.detail(minValue, maxValue)
|
|
248
|
+
* minValue - The start value of the range selector.
|
|
249
|
+
* maxValue - The end value of the range selector.
|
|
250
|
+
*/
|
|
251
|
+
onRangeSelectionChanged?: ((this: any, ev: Event) => any) | ((this: any, ev: CustomEvent<any>) => any) | null;
|
|
252
|
+
/**
|
|
253
|
+
* 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.
|
|
254
|
+
* @param event. The custom event. Custom data event was created with: ev.detail(minValue, maxValue, oldMinValue, oldMaxValue)
|
|
255
|
+
* minValue - The start value of the range selector.
|
|
256
|
+
* maxValue - The end value of the range selector.
|
|
257
|
+
* oldMinValue - The previous start value of the range selector.
|
|
258
|
+
* oldMaxValue - The previous end value of the range selector.
|
|
259
|
+
*/
|
|
260
|
+
onRangeSelectionChanging?: ((this: any, ev: Event) => any) | ((this: any, ev: CustomEvent<any>) => any) | null;
|
|
261
|
+
/**
|
|
262
|
+
* The event is raised when the chart begins rendering.
|
|
263
|
+
* @param event. The custom event. */
|
|
264
|
+
onRefreshBegin?: ((this: any, ev: Event) => any) | ((this: any, ev: CustomEvent<any>) => any) | null;
|
|
265
|
+
/**
|
|
266
|
+
* The event is raised when the chart finishes rendering.
|
|
267
|
+
* @param event. The custom event. */
|
|
268
|
+
onRefreshEnd?: ((this: any, ev: Event) => any) | ((this: any, ev: CustomEvent<any>) => any) | null;
|
|
269
|
+
/**
|
|
270
|
+
* The event is raised when the chart begins resizing.
|
|
271
|
+
* @param event. The custom event. */
|
|
272
|
+
onResizeBegin?: ((this: any, ev: Event) => any) | ((this: any, ev: CustomEvent<any>) => any) | null;
|
|
273
|
+
/**
|
|
274
|
+
* The event is raised when the chart finishes resizing.
|
|
275
|
+
* @param event. The custom event. */
|
|
276
|
+
onResizeEnd?: ((this: any, ev: Event) => any) | ((this: any, ev: CustomEvent<any>) => any) | null;
|
|
277
|
+
/**
|
|
278
|
+
* Adds a new color sheme. If a scheme with the same name already exists, the method will update its colors.
|
|
279
|
+
* @param {string} schemeName. The name of the custom color scheme.
|
|
280
|
+
* @param {any[]} colorsArray. An array of color values.
|
|
281
|
+
*/
|
|
282
|
+
addColorScheme(schemeName: string, colorsArray: any[]): void;
|
|
283
|
+
/**
|
|
284
|
+
* Begins an update of the chart. The chart will not be rendered until the endUpdate method is called.
|
|
285
|
+
*/
|
|
286
|
+
beginUpdate(): void;
|
|
287
|
+
/**
|
|
288
|
+
* Ends an update of the chart. The chart will be rendered after the endUpdate method is called.
|
|
289
|
+
* @param {boolean} refresh?. If set to true, the chart will complete a full refresh.
|
|
290
|
+
*/
|
|
291
|
+
endUpdate(refresh?: boolean): void;
|
|
292
|
+
/**
|
|
293
|
+
* Returns the colors of a color scheme by name. If the scheme doesn't exist the method returns undefined.
|
|
294
|
+
* @param {string} schemeName. The name of the color scheme.
|
|
295
|
+
* @returns {any[]}
|
|
296
|
+
*/
|
|
297
|
+
getColorScheme(schemeName: string): any[];
|
|
298
|
+
/**
|
|
299
|
+
* Gets the item with the specified indexes.
|
|
300
|
+
* @param {number | null} groupIndex?. Series group index.
|
|
301
|
+
* @param {number | null} serieIndex?. Series index.
|
|
302
|
+
* @param {number | null} itemIndex?. Item (data point) index.
|
|
303
|
+
* @returns {any}
|
|
304
|
+
*/
|
|
305
|
+
getItemByIndexes(groupIndex?: number | null, serieIndex?: number | null, itemIndex?: number | null): any;
|
|
306
|
+
/**
|
|
307
|
+
* Gets an arrat of the items with the specified indexes. Leaving an index null will return all items that match the other indexes.
|
|
308
|
+
* @param {number | null} groupIndex?. Series group index.
|
|
309
|
+
* @param {number | null} serieIndex?. Series index.
|
|
310
|
+
* @param {number | null} itemIndex?. Item (data point) index.
|
|
311
|
+
* @returns {any}
|
|
312
|
+
*/
|
|
313
|
+
getItemsByIndexes(groupIndex?: number | null, serieIndex?: number | null, itemIndex?: number | null): any;
|
|
314
|
+
/**
|
|
315
|
+
* Gets the indexes of the hidden series.
|
|
316
|
+
* @returns {{ groupIndex: number, serieIndex: number, itemIndex: number }[]}
|
|
317
|
+
*/
|
|
318
|
+
getHidden(): { groupIndex: number, serieIndex: number, itemIndex: number }[];
|
|
319
|
+
/**
|
|
320
|
+
* Gets the selected items.
|
|
321
|
+
* @returns {any[]}
|
|
322
|
+
*/
|
|
323
|
+
getSelection(): any[];
|
|
324
|
+
/**
|
|
325
|
+
* Gets the rendered values of the valueAxis labels.
|
|
326
|
+
* @returns {any}
|
|
327
|
+
*/
|
|
328
|
+
getValueAxisLabels(): any;
|
|
329
|
+
/**
|
|
330
|
+
* Gets the rendered values of the xAxis labels.
|
|
331
|
+
* @returns {any}
|
|
332
|
+
*/
|
|
333
|
+
getXAxisLabels(): any;
|
|
334
|
+
/**
|
|
335
|
+
* Gets the rendered values of the zAxis labels.
|
|
336
|
+
* @returns {any}
|
|
337
|
+
*/
|
|
338
|
+
getZAxisLabels(): any;
|
|
339
|
+
/**
|
|
340
|
+
* Hides all items of a chart group.
|
|
341
|
+
* @param {number} groupIndex. Series group index.
|
|
342
|
+
*/
|
|
343
|
+
hideGroup(groupIndex: number): void;
|
|
344
|
+
/**
|
|
345
|
+
* Hides a chart item.
|
|
346
|
+
* @param {number} groupIndex. Series group index.
|
|
347
|
+
* @param {number} serieIndex. Series index.
|
|
348
|
+
* @param {number} itemIndex?. Item (data point) index.
|
|
349
|
+
*/
|
|
350
|
+
hideItem(groupIndex: number, serieIndex: number, itemIndex?: number): void;
|
|
351
|
+
/**
|
|
352
|
+
* Hides all items of a chart serie.
|
|
353
|
+
* @param {number} groupIndex. Series group index.
|
|
354
|
+
* @param {number} serieIndex. Series index.
|
|
355
|
+
*/
|
|
356
|
+
hideSerie(groupIndex: number, serieIndex: number): void;
|
|
357
|
+
/**
|
|
358
|
+
* Refreshes the content of the chart element after a property or data update.
|
|
359
|
+
*/
|
|
360
|
+
refresh(): void;
|
|
361
|
+
/**
|
|
362
|
+
* Removes an existing color scheme. If the scheme does not exist, the method has no effect.
|
|
363
|
+
* @param {string} schemeName. The name of the custom color scheme.
|
|
364
|
+
*/
|
|
365
|
+
removeColorScheme(schemeName: string): void;
|
|
366
|
+
/**
|
|
367
|
+
* Exports the chart's content as JPEG image.
|
|
368
|
+
* @param {string} fileName?. File name.
|
|
369
|
+
* @param {boolean} includeLegend?. Sets whether the legend will be part of the saved file.
|
|
370
|
+
* @param {boolean} includeCaption?. Sets whether the caption will be part of the saved file.
|
|
371
|
+
*/
|
|
372
|
+
saveAsJPEG(fileName?: string, includeLegend?: boolean, includeCaption?: boolean): void;
|
|
373
|
+
/**
|
|
374
|
+
* Exports the chart's content as PNG image.
|
|
375
|
+
* @param {string} fileName?. File name.
|
|
376
|
+
* @param {boolean} includeLegend?. Sets whether the legend will be part of the saved file.
|
|
377
|
+
* @param {boolean} includeCaption?. Sets whether the caption will be part of the saved file.
|
|
378
|
+
*/
|
|
379
|
+
saveAsPNG(fileName?: string, includeLegend?: boolean, includeCaption?: boolean): void;
|
|
380
|
+
/**
|
|
381
|
+
* Exports the chart's content as PDF file.
|
|
382
|
+
* @param {string} fileName?. File name.
|
|
383
|
+
* @param {boolean} includeLegend?. Sets whether the legend will be part of the saved file.
|
|
384
|
+
* @param {boolean} includeCaption?. Sets whether the caption will be part of the saved file.
|
|
385
|
+
*/
|
|
386
|
+
saveAsPDF(fileName?: string, includeLegend?: boolean, includeCaption?: boolean): void;
|
|
387
|
+
/**
|
|
388
|
+
* Selects a chart item. If selectionMode is 'one', the previous item will be unselected.
|
|
389
|
+
* @param {number} groupIndex. Series group index.
|
|
390
|
+
* @param {number} serieIndex. Series index.
|
|
391
|
+
* @param {number} itemIndex?. Item (data point) index.
|
|
392
|
+
*/
|
|
393
|
+
selectItem(groupIndex: number, serieIndex: number, itemIndex?: number): void;
|
|
394
|
+
/**
|
|
395
|
+
* Shows all items of a chart group.
|
|
396
|
+
* @param {number} groupIndex. Series group index.
|
|
397
|
+
*/
|
|
398
|
+
showGroup(groupIndex: number): void;
|
|
399
|
+
/**
|
|
400
|
+
* Shows a chart item.
|
|
401
|
+
* @param {number} groupIndex. Series group index.
|
|
402
|
+
* @param {number} serieIndex. Series index.
|
|
403
|
+
* @param {number} itemIndex?. Item (data point) index.
|
|
404
|
+
*/
|
|
405
|
+
showItem(groupIndex: number, serieIndex: number, itemIndex?: number): void;
|
|
406
|
+
/**
|
|
407
|
+
* Shows all items of a chart serie.
|
|
408
|
+
* @param {number} groupIndex. Series group index.
|
|
409
|
+
* @param {number} serieIndex. Series index.
|
|
410
|
+
*/
|
|
411
|
+
showSerie(groupIndex: number, serieIndex: number): void;
|
|
412
|
+
/**
|
|
413
|
+
* Sets the camera position to its position during the initialization.
|
|
414
|
+
*/
|
|
415
|
+
setDefaultPosition(): void;
|
|
416
|
+
/**
|
|
417
|
+
* Sets the camera mode. Different camera modes change the control actions of the mouse. Available modes are 'zoom', 'pan' and 'default'.
|
|
418
|
+
* @param {string} mode. Camera mode.
|
|
419
|
+
*/
|
|
420
|
+
setCameraMode(mode: string): void;
|
|
421
|
+
/**
|
|
422
|
+
* Sets the camera position.
|
|
423
|
+
* @param {number} x. X coordinate.
|
|
424
|
+
* @param {number} y. Y coordinate.
|
|
425
|
+
* @param {number} z. Z coordinate.
|
|
426
|
+
* @param {boolean} animation?. Animation Enabled
|
|
427
|
+
*/
|
|
428
|
+
setCameraPosition(x: number, y: number, z: number, animation?: boolean): void;
|
|
429
|
+
/**
|
|
430
|
+
* Sets the camera zoom.
|
|
431
|
+
* @param {number} level. Zoom level.
|
|
432
|
+
* @param {boolean} animation?. Animation Enabled
|
|
433
|
+
*/
|
|
434
|
+
setCameraZoom(level: number, animation?: boolean): void;
|
|
435
|
+
/**
|
|
436
|
+
* Unelects a chart item.
|
|
437
|
+
* @param {number} groupIndex. Series group index.
|
|
438
|
+
* @param {number} serieIndex. Series index.
|
|
439
|
+
* @param {number} itemIndex?. Item (data point) index.
|
|
440
|
+
*/
|
|
441
|
+
unselectItem(groupIndex: number, serieIndex: number, itemIndex?: number): void;
|
|
442
|
+
/**
|
|
443
|
+
* 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.
|
|
444
|
+
*/
|
|
445
|
+
update(): void;
|
|
446
|
+
}
|
|
447
|
+
|
|
448
|
+
/**Sets the camera's position. The property must be set to an {x, y, z} object. */
|
|
449
|
+
export interface ThreeDChartCameraPosition {
|
|
450
|
+
/**
|
|
451
|
+
* Sets the camera's x position. This is the left-right axis
|
|
452
|
+
* Default value: 5
|
|
453
|
+
*/
|
|
454
|
+
x?: number;
|
|
455
|
+
/**
|
|
456
|
+
* Sets the camera's y position. This is the up-down axis
|
|
457
|
+
* Default value: 20
|
|
458
|
+
*/
|
|
459
|
+
y?: number;
|
|
460
|
+
/**
|
|
461
|
+
* Sets the camera's z position. This is the forward-backward axis
|
|
462
|
+
* Default value: 55
|
|
463
|
+
*/
|
|
464
|
+
z?: number;
|
|
465
|
+
}
|
|
466
|
+
|
|
467
|
+
export interface ThreeDChartSeriesGroup {
|
|
468
|
+
/**
|
|
469
|
+
* Optional color bands dislayed in the chart's plot area.
|
|
470
|
+
* Default value: null
|
|
471
|
+
*/
|
|
472
|
+
bands?: ThreeDChartBand[];
|
|
473
|
+
/**
|
|
474
|
+
* Determines the data source of the serie
|
|
475
|
+
* Default value: null
|
|
476
|
+
*/
|
|
477
|
+
dataSource?: any;
|
|
478
|
+
/**
|
|
479
|
+
* Sets the Z-axis width of the series group. Can be set as number or percetage of the slot's width.
|
|
480
|
+
* Default value: 2
|
|
481
|
+
*/
|
|
482
|
+
depth?: number | string;
|
|
483
|
+
/**
|
|
484
|
+
* Callback function used to format series labels.
|
|
485
|
+
* Default value: null
|
|
486
|
+
*/
|
|
487
|
+
formatFunction?: {(value?: any, index?: number, series?: any): string};
|
|
488
|
+
/**
|
|
489
|
+
* Object describing the format settings of series labels.
|
|
490
|
+
* Default value: [object Object]
|
|
491
|
+
*/
|
|
492
|
+
formatSettings?: ThreeDChartFormatSettings;
|
|
493
|
+
/**
|
|
494
|
+
* Sets the opacity of the series group.
|
|
495
|
+
* Default value: 1
|
|
496
|
+
*/
|
|
497
|
+
opacity?: number;
|
|
498
|
+
/**
|
|
499
|
+
* An array of chart series.
|
|
500
|
+
* Default value:
|
|
501
|
+
*/
|
|
502
|
+
series?: ThreeDChartSeriesGroupSerie[];
|
|
503
|
+
/**
|
|
504
|
+
* When showLabels is set to true, the chart will render pie labels.
|
|
505
|
+
* Default value: true
|
|
506
|
+
*/
|
|
507
|
+
showLabels?: boolean;
|
|
508
|
+
/**
|
|
509
|
+
* The start angle (in degrees) of the polar coordinate system. Applicable to polar and spider charts only.
|
|
510
|
+
* Default value: 0
|
|
511
|
+
*/
|
|
512
|
+
startAngle?: number;
|
|
513
|
+
/**
|
|
514
|
+
* 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
|
|
515
|
+
* Default value: column
|
|
516
|
+
*/
|
|
517
|
+
type?: ThreeDChartType | string;
|
|
518
|
+
/**
|
|
519
|
+
* Sets the Y-axis width of the series group. Used to set the thickness of the line series
|
|
520
|
+
* Default value: 2
|
|
521
|
+
*/
|
|
522
|
+
verticalWidth?: number;
|
|
523
|
+
/**
|
|
524
|
+
* Sets the X-axis width of the series group. Can be set as number or percetage of the slot's width.
|
|
525
|
+
* Default value: 2
|
|
526
|
+
*/
|
|
527
|
+
width?: number | string;
|
|
528
|
+
}
|
|
529
|
+
|
|
530
|
+
export interface ThreeDChartBand {
|
|
531
|
+
/**
|
|
532
|
+
* Color used to fill the area between the minValue and the maxValue.
|
|
533
|
+
* Default value: null
|
|
534
|
+
*/
|
|
535
|
+
color?: string | null;
|
|
536
|
+
/**
|
|
537
|
+
* Band line color.
|
|
538
|
+
* Default value: null
|
|
539
|
+
*/
|
|
540
|
+
lineColor?: string | null;
|
|
541
|
+
/**
|
|
542
|
+
* Band line width.
|
|
543
|
+
* Default value: null
|
|
544
|
+
*/
|
|
545
|
+
lineWidth?: string | number | null;
|
|
546
|
+
/**
|
|
547
|
+
* End value of the color band.
|
|
548
|
+
* Default value: NaN
|
|
549
|
+
*/
|
|
550
|
+
maxValue?: any;
|
|
551
|
+
/**
|
|
552
|
+
* Start value of the color band.
|
|
553
|
+
* Default value: NaN
|
|
554
|
+
*/
|
|
555
|
+
minValue?: any;
|
|
556
|
+
/**
|
|
557
|
+
* Fraction indicating the fill opacity.
|
|
558
|
+
* Default value: 1
|
|
559
|
+
*/
|
|
560
|
+
opacity?: number;
|
|
561
|
+
}
|
|
562
|
+
|
|
563
|
+
/**Object describing the format settings of series labels. */
|
|
564
|
+
export interface ThreeDChartFormatSettings {
|
|
565
|
+
/**
|
|
566
|
+
* Optional date format string. This property is applicable only when displaying Date objects.
|
|
567
|
+
* Default value: null
|
|
568
|
+
*/
|
|
569
|
+
dateFormat?: string | null;
|
|
570
|
+
/**
|
|
571
|
+
* Decimal places of numeric values.
|
|
572
|
+
* Default value: null
|
|
573
|
+
*/
|
|
574
|
+
decimalPlaces?: number | null;
|
|
575
|
+
/**
|
|
576
|
+
* A symbol used to mark the border between the integer and fractional parts of a number. The default value is inherited from localization.decimalSeparator.
|
|
577
|
+
* Default value: null
|
|
578
|
+
*/
|
|
579
|
+
decimalSeparator?: string | null;
|
|
580
|
+
/**
|
|
581
|
+
* A boolean value indicating whether to display negative numbers in brackets.
|
|
582
|
+
* Default value: false
|
|
583
|
+
*/
|
|
584
|
+
negativeWithBrackets?: boolean;
|
|
585
|
+
/**
|
|
586
|
+
* Text to prepend to the value.
|
|
587
|
+
* Default value: ""
|
|
588
|
+
*/
|
|
589
|
+
prefix?: string;
|
|
590
|
+
/**
|
|
591
|
+
* Text to append to the value
|
|
592
|
+
* Default value: ""
|
|
593
|
+
*/
|
|
594
|
+
sufix?: string;
|
|
595
|
+
/**
|
|
596
|
+
* A symbol used to mark the border between thousands, millions, billions, etc. The default value is inherited from localization.thousandsSeparator.
|
|
597
|
+
* Default value: null
|
|
598
|
+
*/
|
|
599
|
+
thousandsSeparator?: string | null;
|
|
600
|
+
}
|
|
601
|
+
|
|
602
|
+
export interface ThreeDChartSeriesGroupSerie {
|
|
603
|
+
/**
|
|
604
|
+
* 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.
|
|
605
|
+
* Default value: null
|
|
606
|
+
*/
|
|
607
|
+
colorFunction?: any;
|
|
608
|
+
/**
|
|
609
|
+
* Name of the field in the data source.
|
|
610
|
+
* Default value: "null"
|
|
611
|
+
*/
|
|
612
|
+
dataField?: string;
|
|
613
|
+
/**
|
|
614
|
+
* Data field used in candlestcik and ohlc series.
|
|
615
|
+
* Default value: "null"
|
|
616
|
+
*/
|
|
617
|
+
dataFieldClose?: string;
|
|
618
|
+
/**
|
|
619
|
+
* Data field used in candlestcik and ohlc series.
|
|
620
|
+
* Default value: "null"
|
|
621
|
+
*/
|
|
622
|
+
dataFieldHigh?: string;
|
|
623
|
+
/**
|
|
624
|
+
* Data field used in candlestcik and ohlc series.
|
|
625
|
+
* Default value: "null"
|
|
626
|
+
*/
|
|
627
|
+
dataFieldLow?: string;
|
|
628
|
+
/**
|
|
629
|
+
* Data field used in candlestcik and ohlc series.
|
|
630
|
+
* Default value: "null"
|
|
631
|
+
*/
|
|
632
|
+
dataFieldOpen?: string;
|
|
633
|
+
/**
|
|
634
|
+
* Data field used in in range column series as a start data field.
|
|
635
|
+
* Default value: "null"
|
|
636
|
+
*/
|
|
637
|
+
dataFieldFrom?: string;
|
|
638
|
+
/**
|
|
639
|
+
* Data field used in range column series as an end data field.
|
|
640
|
+
* Default value: "null"
|
|
641
|
+
*/
|
|
642
|
+
dataFieldTo?: string;
|
|
643
|
+
/**
|
|
644
|
+
* Data field used in bubble series.
|
|
645
|
+
* Default value: "null"
|
|
646
|
+
*/
|
|
647
|
+
radiusDataField?: string;
|
|
648
|
+
/**
|
|
649
|
+
* Name to display for this serie.
|
|
650
|
+
* Default value: "null"
|
|
651
|
+
*/
|
|
652
|
+
displayText?: string;
|
|
653
|
+
/**
|
|
654
|
+
* Name to display for candlestick and ohlc series.
|
|
655
|
+
* Default value: "null"
|
|
656
|
+
*/
|
|
657
|
+
displayTextClose?: string;
|
|
658
|
+
/**
|
|
659
|
+
* Name to display for candlestick and ohlc series.
|
|
660
|
+
* Default value: "null"
|
|
661
|
+
*/
|
|
662
|
+
displayTextHigh?: string;
|
|
663
|
+
/**
|
|
664
|
+
* Name to display for candlestick and ohlc series.
|
|
665
|
+
* Default value: "null"
|
|
666
|
+
*/
|
|
667
|
+
displayTextLow?: string;
|
|
668
|
+
/**
|
|
669
|
+
* Name to display for candlestick and ohlc series.
|
|
670
|
+
* Default value: "null"
|
|
671
|
+
*/
|
|
672
|
+
displayTextOpen?: string;
|
|
673
|
+
/**
|
|
674
|
+
* Callback function used to format the labels.
|
|
675
|
+
* Default value: null
|
|
676
|
+
*/
|
|
677
|
+
formatFunction?: {(value?: any, index?: number, series?: any): string};
|
|
678
|
+
/**
|
|
679
|
+
* Object describing the format settings of the labels.
|
|
680
|
+
* Default value: [object Object]
|
|
681
|
+
*/
|
|
682
|
+
formatSettings?: ThreeDChartFormatSettings;
|
|
683
|
+
/**
|
|
684
|
+
* Specifies the summary of the series group.
|
|
685
|
+
* Default value: ""
|
|
686
|
+
*/
|
|
687
|
+
summary?: string;
|
|
688
|
+
/**
|
|
689
|
+
* Maximum angle in a pie, donut, polar and spider series.
|
|
690
|
+
* Default value: 360
|
|
691
|
+
*/
|
|
692
|
+
endAngle?: number;
|
|
693
|
+
/**
|
|
694
|
+
* Initial angle in pie and donut series.
|
|
695
|
+
* Default value: 0
|
|
696
|
+
*/
|
|
697
|
+
initialAngle?: number;
|
|
698
|
+
/**
|
|
699
|
+
* Inner radius of donut series in pixels or percents.
|
|
700
|
+
* Default value: 0
|
|
701
|
+
*/
|
|
702
|
+
innerRadius?: number;
|
|
703
|
+
/**
|
|
704
|
+
* Object describing the labels properties of the axis.
|
|
705
|
+
* Default value: undefined
|
|
706
|
+
*/
|
|
707
|
+
labels?: ThreeDChartLabels;
|
|
708
|
+
/**
|
|
709
|
+
* Fill color of the legend box. The default value is inherited from the serie's color.
|
|
710
|
+
* Default value: null
|
|
711
|
+
*/
|
|
712
|
+
legendFillColor?: string | null;
|
|
713
|
+
/**
|
|
714
|
+
* Legend data formatting function for the values in the serie.
|
|
715
|
+
* Default value: null
|
|
716
|
+
*/
|
|
717
|
+
legendFormatFunction?: any;
|
|
718
|
+
/**
|
|
719
|
+
* Legend data formatting settings for the values in the serie.
|
|
720
|
+
* Default value: [object Object]
|
|
721
|
+
*/
|
|
722
|
+
legendFormatSettings?: ThreeDChartFormatSettings;
|
|
723
|
+
/**
|
|
724
|
+
* Line color of the legend box. The default value is inherited from the serie's color.
|
|
725
|
+
* Default value: null
|
|
726
|
+
*/
|
|
727
|
+
legendLineColor?: string | null;
|
|
728
|
+
/**
|
|
729
|
+
* Line color for the serie.
|
|
730
|
+
* Default value: null
|
|
731
|
+
*/
|
|
732
|
+
lineColor?: string | null;
|
|
733
|
+
/**
|
|
734
|
+
* Line color for the serie when selected.
|
|
735
|
+
* Default value: null
|
|
736
|
+
*/
|
|
737
|
+
lineColorSelected?: string | null;
|
|
738
|
+
/**
|
|
739
|
+
* Line color for the marker symbols in serie.
|
|
740
|
+
* Default value: null
|
|
741
|
+
*/
|
|
742
|
+
lineColorSymbol?: string | null;
|
|
743
|
+
/**
|
|
744
|
+
* Determines the line tickness of the items in this serie.
|
|
745
|
+
* Default value: null
|
|
746
|
+
*/
|
|
747
|
+
lineWidth?: string | null | number;
|
|
748
|
+
/**
|
|
749
|
+
* Determines the line tickness of the items in this serie when selected.
|
|
750
|
+
* Default value: null
|
|
751
|
+
*/
|
|
752
|
+
lineWidthSelected?: string | null | number;
|
|
753
|
+
/**
|
|
754
|
+
* Min radius of bubble series in pixels or percents.
|
|
755
|
+
* Default value: null
|
|
756
|
+
*/
|
|
757
|
+
minRadius?: string | null | number;
|
|
758
|
+
/**
|
|
759
|
+
* Max radius of bubble series in pixels or percents.
|
|
760
|
+
* Default value: null
|
|
761
|
+
*/
|
|
762
|
+
maxRadius?: string | null | number;
|
|
763
|
+
/**
|
|
764
|
+
* Determines the opacity of the items in this serie.
|
|
765
|
+
* Default value: 1
|
|
766
|
+
*/
|
|
767
|
+
opacity?: number;
|
|
768
|
+
/**
|
|
769
|
+
* Outer radius of pie and donut series in pixels or percents.
|
|
770
|
+
* Default value: null
|
|
771
|
+
*/
|
|
772
|
+
radius?: number | null;
|
|
773
|
+
/**
|
|
774
|
+
* Radius change on selection of pie and donut series in pixels or percents.
|
|
775
|
+
* Default value: null
|
|
776
|
+
*/
|
|
777
|
+
selectedRadiusChange?: number | null;
|
|
778
|
+
/**
|
|
779
|
+
* Minimum angle in a pie, donut, polar and spider series.
|
|
780
|
+
* Default value: 0
|
|
781
|
+
*/
|
|
782
|
+
startAngle?: number;
|
|
783
|
+
/**
|
|
784
|
+
* Determines the size of the symbol element.
|
|
785
|
+
* Default value: null
|
|
786
|
+
*/
|
|
787
|
+
symbolSize?: number;
|
|
788
|
+
/**
|
|
789
|
+
* Determines the size of the symbol element. This property is applicable to line and area series only.
|
|
790
|
+
* Default value: null
|
|
791
|
+
*/
|
|
792
|
+
symbolSizeSelected?: number;
|
|
793
|
+
/**
|
|
794
|
+
* Determines the symbol type displayed for the data points in the serie. This parameter is applicable to line, area, scatter and bubble series only.
|
|
795
|
+
* Default value: none
|
|
796
|
+
*/
|
|
797
|
+
symbolType?: ThreeDChartSymbolType | string;
|
|
798
|
+
/**
|
|
799
|
+
* Determines the tooltip's background.
|
|
800
|
+
* Default value: null
|
|
801
|
+
*/
|
|
802
|
+
toolTipBackground?: string | null;
|
|
803
|
+
/**
|
|
804
|
+
* Determines the tooltip's CSS class name.
|
|
805
|
+
* Default value: null
|
|
806
|
+
*/
|
|
807
|
+
toolTipClass?: string | null;
|
|
808
|
+
/**
|
|
809
|
+
* Tooltip data formatting function for the values in the serie.
|
|
810
|
+
* Default value: null
|
|
811
|
+
*/
|
|
812
|
+
toolTipFormatFunction?: {(value?: any, index?: number, series?: any): string};
|
|
813
|
+
/**
|
|
814
|
+
* Tooltip data formatting settings for the values in the serie.
|
|
815
|
+
* Default value: [object Object]
|
|
816
|
+
*/
|
|
817
|
+
toolTipFormatSettings?: ThreeDChartFormatSettings;
|
|
818
|
+
/**
|
|
819
|
+
* Determines the tooltip's border lines color.
|
|
820
|
+
* Default value: null
|
|
821
|
+
*/
|
|
822
|
+
toolTipLineColor?: string | null;
|
|
823
|
+
/**
|
|
824
|
+
* Determines whether to use color gradients.
|
|
825
|
+
* Default value: false
|
|
826
|
+
*/
|
|
827
|
+
useGradientColors?: boolean;
|
|
828
|
+
}
|
|
829
|
+
|
|
830
|
+
/**Object describing the labels properties of the axis. */
|
|
831
|
+
export interface ThreeDChartLabels {
|
|
832
|
+
/**
|
|
833
|
+
* Text rotation angle.
|
|
834
|
+
* Default value: 0
|
|
835
|
+
*/
|
|
836
|
+
angle?: number;
|
|
837
|
+
/**
|
|
838
|
+
* Callback function used to format the labels.
|
|
839
|
+
* Default value: null
|
|
840
|
+
*/
|
|
841
|
+
formatFunction?: {(value?: any, index?: number, series?: any): string};
|
|
842
|
+
/**
|
|
843
|
+
* Object describing the format settings of the labels.
|
|
844
|
+
* Default value: [object Object]
|
|
845
|
+
*/
|
|
846
|
+
formatSettings?: ThreeDChartFormatSettings;
|
|
847
|
+
/**
|
|
848
|
+
* Labels offset.
|
|
849
|
+
* Default value: [object Object]
|
|
850
|
+
*/
|
|
851
|
+
offset?: ThreeDChartOffset;
|
|
852
|
+
/**
|
|
853
|
+
* Radius of the labels in pie/donut series.
|
|
854
|
+
* Default value: null
|
|
855
|
+
*/
|
|
856
|
+
radius?: number | null;
|
|
857
|
+
/**
|
|
858
|
+
* Interval steps between label placements (multiples of the axis unit interval).
|
|
859
|
+
* Default value: null
|
|
860
|
+
*/
|
|
861
|
+
step?: number | null;
|
|
862
|
+
/**
|
|
863
|
+
* Sets the interval between the labels.
|
|
864
|
+
* Default value: null
|
|
865
|
+
*/
|
|
866
|
+
unitInterval?: number;
|
|
867
|
+
/**
|
|
868
|
+
* Possible values: true, false, 'custom'.Determines the visibility of labels. When 'custom' is set, displays only custom values/offsets from the labels.custom array.
|
|
869
|
+
* Default value: true
|
|
870
|
+
*/
|
|
871
|
+
visible?: boolean | string;
|
|
872
|
+
}
|
|
873
|
+
|
|
874
|
+
/**Labels offset. */
|
|
875
|
+
export interface ThreeDChartOffset {
|
|
876
|
+
/**
|
|
877
|
+
* Horizontal offset.
|
|
878
|
+
* Default value: 0
|
|
879
|
+
*/
|
|
880
|
+
x?: number | null;
|
|
881
|
+
/**
|
|
882
|
+
* Vertical offset.
|
|
883
|
+
* Default value: 0
|
|
884
|
+
*/
|
|
885
|
+
y?: number | null;
|
|
886
|
+
/**
|
|
887
|
+
* Horizontal offset on Z-axis.
|
|
888
|
+
* Default value: 0
|
|
889
|
+
*/
|
|
890
|
+
z?: number | null;
|
|
891
|
+
}
|
|
892
|
+
|
|
893
|
+
/**Sets the padding of the chart's title (caption). */
|
|
894
|
+
export interface ThreeDChartPadding {
|
|
895
|
+
/**
|
|
896
|
+
* Bottom padding.
|
|
897
|
+
* Default value: 10
|
|
898
|
+
*/
|
|
899
|
+
bottom?: number;
|
|
900
|
+
/**
|
|
901
|
+
* Left padding.
|
|
902
|
+
* Default value: 5
|
|
903
|
+
*/
|
|
904
|
+
left?: number;
|
|
905
|
+
/**
|
|
906
|
+
* Right padding.
|
|
907
|
+
* Default value: 5
|
|
908
|
+
*/
|
|
909
|
+
right?: number;
|
|
910
|
+
/**
|
|
911
|
+
* Top padding.
|
|
912
|
+
* Default value: 5
|
|
913
|
+
*/
|
|
914
|
+
top?: number;
|
|
915
|
+
}
|
|
916
|
+
|
|
917
|
+
/**An object with settings about the Chart's y-axis (value axis). */
|
|
918
|
+
export interface ThreeDChartValueAxis {
|
|
919
|
+
/**
|
|
920
|
+
* Sets the baseline value for the axis.
|
|
921
|
+
* Default value: 0
|
|
922
|
+
*/
|
|
923
|
+
baselineValue?: any;
|
|
924
|
+
/**
|
|
925
|
+
* Sets the text displayed on the axis.
|
|
926
|
+
* Default value: null
|
|
927
|
+
*/
|
|
928
|
+
displayText?: string | null;
|
|
929
|
+
/**
|
|
930
|
+
* Custom function to format the displayed values along the axis.
|
|
931
|
+
* Default value: null
|
|
932
|
+
*/
|
|
933
|
+
formatFunction?: {(value?: any): string};
|
|
934
|
+
/**
|
|
935
|
+
* Settings used to format the displayed values along the axis.
|
|
936
|
+
* Default value: [object Object]
|
|
937
|
+
*/
|
|
938
|
+
formatSettings?: ThreeDChartFormatSettings;
|
|
939
|
+
/**
|
|
940
|
+
* Object describing the grid lines properties of the valueAxis.
|
|
941
|
+
* Default value: [object Object]
|
|
942
|
+
*/
|
|
943
|
+
gridLines?: ThreeDChartLines;
|
|
944
|
+
/**
|
|
945
|
+
* Object describing the labels properties of the axis.
|
|
946
|
+
* Default value: [object Object]
|
|
947
|
+
*/
|
|
948
|
+
labels?: ThreeDChartLabels;
|
|
949
|
+
/**
|
|
950
|
+
* Determines whether to use logarithmic scale.
|
|
951
|
+
* Default value: false
|
|
952
|
+
*/
|
|
953
|
+
logarithmicScale?: boolean;
|
|
954
|
+
/**
|
|
955
|
+
* Base for logarithmic scale.
|
|
956
|
+
* Default value: 10
|
|
957
|
+
*/
|
|
958
|
+
logarithmicScaleBase?: number;
|
|
959
|
+
/**
|
|
960
|
+
* Sets the maximum value of the valueAxis.
|
|
961
|
+
* Default value: NaN
|
|
962
|
+
*/
|
|
963
|
+
maxValue?: any;
|
|
964
|
+
/**
|
|
965
|
+
* Sets the minimum value of the valueAxis.
|
|
966
|
+
* Default value: NaN
|
|
967
|
+
*/
|
|
968
|
+
minValue?: any;
|
|
969
|
+
/**
|
|
970
|
+
* Sets the interval between the units.
|
|
971
|
+
* Default value: null
|
|
972
|
+
*/
|
|
973
|
+
unitInterval?: number | null;
|
|
974
|
+
/**
|
|
975
|
+
* Shows or hides the valueAxis.
|
|
976
|
+
* Default value: true
|
|
977
|
+
*/
|
|
978
|
+
visible?: boolean;
|
|
979
|
+
}
|
|
980
|
+
|
|
981
|
+
/**Object describing the grid lines properties of the valueAxis. */
|
|
982
|
+
export interface ThreeDChartLines {
|
|
983
|
+
/**
|
|
984
|
+
* Color of the grid lines.
|
|
985
|
+
* Default value: ""
|
|
986
|
+
*/
|
|
987
|
+
color?: string;
|
|
988
|
+
/**
|
|
989
|
+
* Interval steps between grid line placements (multiples of the axis unit interval).
|
|
990
|
+
* Default value: null
|
|
991
|
+
*/
|
|
992
|
+
step?: number | null;
|
|
993
|
+
/**
|
|
994
|
+
* 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.
|
|
995
|
+
* Default value: true
|
|
996
|
+
*/
|
|
997
|
+
visible?: boolean | string;
|
|
998
|
+
}
|
|
999
|
+
|
|
1000
|
+
/**Sets the Chart's xAxis. */
|
|
1001
|
+
export interface ThreeDChartXAxis {
|
|
1002
|
+
/**
|
|
1003
|
+
* Points to a data field in the data source.
|
|
1004
|
+
* Default value: ""
|
|
1005
|
+
*/
|
|
1006
|
+
dataField?: string;
|
|
1007
|
+
/**
|
|
1008
|
+
* Optional custom xAxis display text.
|
|
1009
|
+
* Default value: null
|
|
1010
|
+
*/
|
|
1011
|
+
displayText?: string | null;
|
|
1012
|
+
/**
|
|
1013
|
+
* Specifies whether the values are displayed in reverse order.
|
|
1014
|
+
* Default value: false
|
|
1015
|
+
*/
|
|
1016
|
+
flip?: boolean;
|
|
1017
|
+
/**
|
|
1018
|
+
* Custom function to format the displayed values along the axis.
|
|
1019
|
+
* Default value: null
|
|
1020
|
+
*/
|
|
1021
|
+
formatFunction?: {(value?: any, index?: number, series?: any): string};
|
|
1022
|
+
/**
|
|
1023
|
+
* Settings used to format the displayed values along the axis.
|
|
1024
|
+
* Default value: [object Object]
|
|
1025
|
+
*/
|
|
1026
|
+
formatSettings?: ThreeDChartFormatSettings;
|
|
1027
|
+
/**
|
|
1028
|
+
* Object describing the grid lines properties of the xAxis.
|
|
1029
|
+
* Default value: [object Object]
|
|
1030
|
+
*/
|
|
1031
|
+
gridLines?: ThreeDChartLines;
|
|
1032
|
+
/**
|
|
1033
|
+
* Object describing the labels properties of the axis.
|
|
1034
|
+
* Default value: [object Object]
|
|
1035
|
+
*/
|
|
1036
|
+
labels?: ThreeDChartLabels;
|
|
1037
|
+
/**
|
|
1038
|
+
* Determines whether to use logarithmic scale.
|
|
1039
|
+
* Default value: false
|
|
1040
|
+
*/
|
|
1041
|
+
logarithmicScale?: boolean;
|
|
1042
|
+
/**
|
|
1043
|
+
* Base for logarithmic scale.
|
|
1044
|
+
* Default value: 10
|
|
1045
|
+
*/
|
|
1046
|
+
logarithmicScaleBase?: number;
|
|
1047
|
+
/**
|
|
1048
|
+
* Sets the maximum value of the xAxis.
|
|
1049
|
+
* Default value: NaN
|
|
1050
|
+
*/
|
|
1051
|
+
maxValue?: any;
|
|
1052
|
+
/**
|
|
1053
|
+
* Sets the minimum value of the xAxis.
|
|
1054
|
+
* Default value: NaN
|
|
1055
|
+
*/
|
|
1056
|
+
minValue?: any;
|
|
1057
|
+
/**
|
|
1058
|
+
* Definition of a range selector on the xAxis. The range selector itself is also an instance of smart-chart.
|
|
1059
|
+
* Default value: [object Object]
|
|
1060
|
+
*/
|
|
1061
|
+
rangeSelector?: ThreeDChartRangeSelector;
|
|
1062
|
+
/**
|
|
1063
|
+
* 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.
|
|
1064
|
+
* Default value: auto
|
|
1065
|
+
*/
|
|
1066
|
+
type?: ThreeDChartXAxisType | string;
|
|
1067
|
+
/**
|
|
1068
|
+
* Sets the interval between the units.
|
|
1069
|
+
* Default value: null
|
|
1070
|
+
*/
|
|
1071
|
+
unitInterval?: number | null;
|
|
1072
|
+
/**
|
|
1073
|
+
* Shows or hides the xAxis.
|
|
1074
|
+
* Default value: true
|
|
1075
|
+
*/
|
|
1076
|
+
visible?: boolean;
|
|
1077
|
+
}
|
|
1078
|
+
|
|
1079
|
+
/**Definition of a range selector on the xAxis. The range selector itself is also an instance of ${namespace.toLowerCase()}-chart. */
|
|
1080
|
+
export interface ThreeDChartRangeSelector {
|
|
1081
|
+
/**
|
|
1082
|
+
* Sets the color of the range selector chart. If null, it will be set to the same color as the chart
|
|
1083
|
+
* Default value: null
|
|
1084
|
+
*/
|
|
1085
|
+
color?: string | null;
|
|
1086
|
+
/**
|
|
1087
|
+
* Callback function used to format the values.
|
|
1088
|
+
* Default value: null
|
|
1089
|
+
*/
|
|
1090
|
+
formatFunction?: {(value?: any, index?: number, series?: any): string};
|
|
1091
|
+
/**
|
|
1092
|
+
* Chart Format Settings
|
|
1093
|
+
* Default value: null
|
|
1094
|
+
*/
|
|
1095
|
+
formatSettings?: any;
|
|
1096
|
+
/**
|
|
1097
|
+
* Object describing the labels properties of the axis.
|
|
1098
|
+
* Default value: [object Object]
|
|
1099
|
+
*/
|
|
1100
|
+
labels?: ThreeDChartLabels;
|
|
1101
|
+
/**
|
|
1102
|
+
* Sets the opacity of the range selector chart.
|
|
1103
|
+
* Default value: 1
|
|
1104
|
+
*/
|
|
1105
|
+
opacity?: number;
|
|
1106
|
+
/**
|
|
1107
|
+
* Sets the range selector chart type
|
|
1108
|
+
* Default value: area
|
|
1109
|
+
*/
|
|
1110
|
+
serieType?: ThreeDChartRangeSelectorSerieType | string;
|
|
1111
|
+
/**
|
|
1112
|
+
* Shows or hides the range selector.
|
|
1113
|
+
* Default value: false
|
|
1114
|
+
*/
|
|
1115
|
+
visible?: boolean;
|
|
1116
|
+
}
|
|
1117
|
+
|
|
1118
|
+
/**Sets the Chart's zAxis. */
|
|
1119
|
+
export interface ThreeDChartZAxis {
|
|
1120
|
+
/**
|
|
1121
|
+
* Points to a data field in the data source.
|
|
1122
|
+
* Default value: ""
|
|
1123
|
+
*/
|
|
1124
|
+
dataField?: string;
|
|
1125
|
+
/**
|
|
1126
|
+
* Optional custom zAxis display text.
|
|
1127
|
+
* Default value: null
|
|
1128
|
+
*/
|
|
1129
|
+
displayText?: string | null;
|
|
1130
|
+
/**
|
|
1131
|
+
* Specifies whether the values are displayed in reverse order.
|
|
1132
|
+
* Default value: false
|
|
1133
|
+
*/
|
|
1134
|
+
flip?: boolean;
|
|
1135
|
+
/**
|
|
1136
|
+
* Custom function to format the displayed values along the axis.
|
|
1137
|
+
* Default value: null
|
|
1138
|
+
*/
|
|
1139
|
+
formatFunction?: {(value?: any, index?: number, series?: any): string};
|
|
1140
|
+
/**
|
|
1141
|
+
* Settings used to format the displayed values along the axis.
|
|
1142
|
+
* Default value: [object Object]
|
|
1143
|
+
*/
|
|
1144
|
+
formatSettings?: ThreeDChartFormatSettings;
|
|
1145
|
+
/**
|
|
1146
|
+
* Object describing the grid lines properties of the zAxis.
|
|
1147
|
+
* Default value: [object Object]
|
|
1148
|
+
*/
|
|
1149
|
+
gridLines?: ThreeDChartLines;
|
|
1150
|
+
/**
|
|
1151
|
+
* Object describing the labels properties of the axis.
|
|
1152
|
+
* Default value: [object Object]
|
|
1153
|
+
*/
|
|
1154
|
+
labels?: ThreeDChartLabels;
|
|
1155
|
+
/**
|
|
1156
|
+
* Determines whether to use logarithmic scale.
|
|
1157
|
+
* Default value: false
|
|
1158
|
+
*/
|
|
1159
|
+
logarithmicScale?: boolean;
|
|
1160
|
+
/**
|
|
1161
|
+
* Base for logarithmic scale.
|
|
1162
|
+
* Default value: 10
|
|
1163
|
+
*/
|
|
1164
|
+
logarithmicScaleBase?: number;
|
|
1165
|
+
/**
|
|
1166
|
+
* Sets the maximum value of the zAxis.
|
|
1167
|
+
* Default value: NaN
|
|
1168
|
+
*/
|
|
1169
|
+
maxValue?: any;
|
|
1170
|
+
/**
|
|
1171
|
+
* Sets the minimum value of the zAxis.
|
|
1172
|
+
* Default value: NaN
|
|
1173
|
+
*/
|
|
1174
|
+
minValue?: any;
|
|
1175
|
+
/**
|
|
1176
|
+
* Sets the interval between the units.
|
|
1177
|
+
* Default value: null
|
|
1178
|
+
*/
|
|
1179
|
+
unitInterval?: number | null;
|
|
1180
|
+
/**
|
|
1181
|
+
* Shows or hides the zAxis.
|
|
1182
|
+
* Default value: true
|
|
1183
|
+
*/
|
|
1184
|
+
visible?: boolean;
|
|
1185
|
+
}
|
|
1
1186
|
|
|
2
|
-
|
|
1187
|
+
declare global {
|
|
1188
|
+
interface Document {
|
|
1189
|
+
createElement(tagName: "smart-3d-chart"): ThreeDChart;
|
|
1190
|
+
querySelector(selectors: "smart-3d-chart"): ThreeDChart | null;
|
|
1191
|
+
querySelectorAll(selectors: "smart-3d-chart"): NodeListOf<ThreeDChart>;
|
|
1192
|
+
getElementsByTagName(qualifiedName: "smart-3d-chart"): HTMLCollectionOf<ThreeDChart>;
|
|
1193
|
+
getElementsByName(elementName: "smart-3d-chart"): NodeListOf<ThreeDChart>;
|
|
1194
|
+
}
|
|
1195
|
+
}
|
|
3
1196
|
|
|
1197
|
+
/**Sets or gets the animation mode. Animation is disabled when the property is set to 'none'. */
|
|
1198
|
+
export declare type Animation = 'none' | 'simple' | 'advanced';
|
|
1199
|
+
/**Sets the chart's color pallete. jqxChart suppports 32 color schemes from 'scheme01' to 'scheme32'. */
|
|
1200
|
+
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';
|
|
1201
|
+
/**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 */
|
|
1202
|
+
export declare type ThreeDChartLegendIndex = 'auto' | 'serie' | 'group';
|
|
1203
|
+
/**Determines the selection mode. */
|
|
1204
|
+
export declare type ThreeDChartSelectionMode = 'none' | 'single' | 'multiple';
|
|
1205
|
+
/**Determines the symbol type displayed for the data points in the serie. This parameter is applicable to line, area, scatter and bubble series only. */
|
|
1206
|
+
export declare type ThreeDChartSymbolType = 'none' | 'circle' | 'square' | 'diamond' | 'triangle_up' | 'triangle_down' | 'triangle_left' | 'triangle_right';
|
|
1207
|
+
/**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
|
|
1208
|
+
'stackedcolumn' - stacked column series
|
|
1209
|
+
'stackedcolumn100' - percentage stacked columns
|
|
1210
|
+
'rangecolumn' - floating column between two values
|
|
1211
|
+
'waterfall' - waterfall series
|
|
1212
|
+
'stackedwaterfall' - stacked waterfall series
|
|
1213
|
+
'line' - simple straight lines connecting the value points
|
|
1214
|
+
'stackedline' - stacked lines
|
|
1215
|
+
'stackedline100' - percentage stacked lines
|
|
1216
|
+
'spline' - smooth lines connecting the value points
|
|
1217
|
+
'stackedspline' - smooth stacked lines
|
|
1218
|
+
'stackedspline100' - percentage stacked smooth lines
|
|
1219
|
+
'stepline' - step line
|
|
1220
|
+
'stackedstepline' - stacked step line
|
|
1221
|
+
'stackedstepline100' - percentage stacked step line
|
|
1222
|
+
'area' - area connecting the value points with straight lines
|
|
1223
|
+
'stackedarea' - stacked area with straight lines between the points
|
|
1224
|
+
'stackedarea100' - percentage stacked area with straight lines between the points
|
|
1225
|
+
'rangearea' - floating area between pairs of value points
|
|
1226
|
+
'splinearea' - smooth area connecting the value points
|
|
1227
|
+
'stackedsplinearea' - stacked smooth area connecting the value points
|
|
1228
|
+
'stackedsplinearea100' - percentage stacked smooth area
|
|
1229
|
+
'splinerangearea' - smooth floating area between pairs of value points
|
|
1230
|
+
'steprangearea' - step area between pairs of value points
|
|
1231
|
+
'stackedsplineara' - smooth stacked area
|
|
1232
|
+
'steparea' - step area connecting the value points
|
|
1233
|
+
'stackedsteparea' - step stacked area
|
|
1234
|
+
'stackedsteparea100' - percentage stacked step area
|
|
1235
|
+
'pie' - circular chart divided into sectors, illustrating proportion
|
|
1236
|
+
'donut' - chart divided into circular sectors with different inner and outer radius
|
|
1237
|
+
'scatter' - data is displayed as a collection of points
|
|
1238
|
+
'stackedscatter' - data is displayed as a collection of points and the values are stacked
|
|
1239
|
+
'stackedscatter100' - data is displayed as a collection of points and the values are percentage stacked
|
|
1240
|
+
'bubble' - data is displayed as a collection of bubbles
|
|
1241
|
+
'stackedbubble' - data is displayed as a collection of bubbles and the values are stacked
|
|
1242
|
+
'stackedbubble100' - data is displayed as a collection of bubbles and the values are percentage stacked
|
|
1243
|
+
'candlestick' - display candlestick series using open, high, low, close data points
|
|
1244
|
+
'ohlc' - display OHLC series using open, high, low, close data points
|
|
1245
|
+
*/
|
|
1246
|
+
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';
|
|
1247
|
+
/**Sets the range selector chart type */
|
|
1248
|
+
export declare type ThreeDChartRangeSelectorSerieType = 'line' | 'area';
|
|
1249
|
+
/**The type of the axis. 'auto' - automatically detects and switches to 'basic', 'linear' or 'date'.
|
|
1250
|
+
'date' - when displaying dates.
|
|
1251
|
+
'basic' - displays all data points sequentially.
|
|
1252
|
+
'linear' - linear arrangement by the value of the xAxis data field.
|
|
1253
|
+
*/
|
|
1254
|
+
export declare type ThreeDChartXAxisType = 'auto' | 'date' | 'basic' | 'linear';
|
|
4
1255
|
export interface AccordionProperties {
|
|
5
1256
|
/**
|
|
6
1257
|
* Sets or gets the animation mode. Animation is disabled when the property is set to 'none'
|
|
@@ -184,8 +1435,6 @@ declare global {
|
|
|
184
1435
|
}
|
|
185
1436
|
}
|
|
186
1437
|
|
|
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
1438
|
/**Sets or gets the expand mode. Expand mode determines how the items will expand or collapse. */
|
|
190
1439
|
export declare type AccordionExpandMode = 'single' | 'singleFitHeight' | 'multiple' | 'toggle' | 'none';
|
|
191
1440
|
export interface AccordionItemProperties {
|
|
@@ -652,6 +1901,16 @@ export interface BarcodeProperties {
|
|
|
652
1901
|
* Default value: ""
|
|
653
1902
|
*/
|
|
654
1903
|
value?: string;
|
|
1904
|
+
/**
|
|
1905
|
+
* Sets or gets the width of the barcode. If the width is set to 0, the width of the barcode is calculated automatically.
|
|
1906
|
+
* Default value: 0
|
|
1907
|
+
*/
|
|
1908
|
+
width?: number;
|
|
1909
|
+
/**
|
|
1910
|
+
* Sets or gets the height of the barcode. If the height is set to 0, the height of the barcode is calculated automatically.
|
|
1911
|
+
* Default value: 0
|
|
1912
|
+
*/
|
|
1913
|
+
height?: number;
|
|
655
1914
|
}
|
|
656
1915
|
/**
|
|
657
1916
|
Barcodes encodes text value in a specific pattern.
|
|
@@ -5755,6 +7014,11 @@ export interface ComboBoxProperties {
|
|
|
5755
7014
|
* Default value: 2
|
|
5756
7015
|
*/
|
|
5757
7016
|
minLength?: number;
|
|
7017
|
+
/**
|
|
7018
|
+
* Determines the maximum number of characters inside the input.
|
|
7019
|
+
* Default value: -1
|
|
7020
|
+
*/
|
|
7021
|
+
maxLength?: number;
|
|
5758
7022
|
/**
|
|
5759
7023
|
* Sets or gets the name attribute for the element. Name is used when submiting HTML forms.
|
|
5760
7024
|
* Default value: ""
|
|
@@ -6681,11 +7945,6 @@ export declare type DataAdapterVirtualDataSourceOnExpandDetailsAction = 'sort' |
|
|
|
6681
7945
|
/**Request action type */
|
|
6682
7946
|
export declare type DataAdapterVirtualDataSourceDetailsAction = 'sort' | 'filter' | 'dataBind' | 'scroll' | 'group' | 'expand' | 'pageIndexChange' | 'pageSizeChange';
|
|
6683
7947
|
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
7948
|
/**
|
|
6690
7949
|
* Determines whether the calendar button pop-up will be closed automatically when date or time is selected through it.
|
|
6691
7950
|
* Default value: false
|
|
@@ -6700,7 +7959,7 @@ export interface DateInputProperties {
|
|
|
6700
7959
|
* 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
7960
|
* Default value: { day: 'numeric', month: 'numeric', year: 'numeric' }
|
|
6702
7961
|
*/
|
|
6703
|
-
dateTimeFormat?:
|
|
7962
|
+
dateTimeFormat?: any;
|
|
6704
7963
|
/**
|
|
6705
7964
|
* Enables or disables the element.
|
|
6706
7965
|
* Default value: false
|
|
@@ -6721,6 +7980,11 @@ export interface DateInputProperties {
|
|
|
6721
7980
|
* Default value:
|
|
6722
7981
|
*/
|
|
6723
7982
|
dropDownWidth?: string | number;
|
|
7983
|
+
/**
|
|
7984
|
+
* 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.
|
|
7985
|
+
* Default value: ""
|
|
7986
|
+
*/
|
|
7987
|
+
formatString?: string;
|
|
6724
7988
|
/**
|
|
6725
7989
|
* 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
7990
|
* Default value: "off"
|
|
@@ -6849,25 +8113,6 @@ export interface DateInput extends BaseElement, DateInputProperties {
|
|
|
6849
8113
|
setValue(value: string | Date): void;
|
|
6850
8114
|
}
|
|
6851
8115
|
|
|
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
8116
|
declare global {
|
|
6872
8117
|
interface Document {
|
|
6873
8118
|
createElement(tagName: "smart-date-input"): DateInput;
|
|
@@ -6878,12 +8123,6 @@ declare global {
|
|
|
6878
8123
|
}
|
|
6879
8124
|
}
|
|
6880
8125
|
|
|
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
8126
|
export interface DateRangeInputProperties {
|
|
6888
8127
|
/**
|
|
6889
8128
|
* Sets or gets the animation mode. Animation is disabled when the property is set to 'none'
|
|
@@ -7220,7 +8459,7 @@ export interface DateTimePickerProperties {
|
|
|
7220
8459
|
*/
|
|
7221
8460
|
footer?: boolean;
|
|
7222
8461
|
/**
|
|
7223
|
-
* Determines the pattern that is used to display the value in.
|
|
8462
|
+
* 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
8463
|
* Default value: "dd-MMM-yy HH:mm:ss.fff"
|
|
7225
8464
|
*/
|
|
7226
8465
|
formatString?: string;
|
|
@@ -8213,6 +9452,11 @@ export interface DropDownListProperties {
|
|
|
8213
9452
|
* Default value: startsWithIgnoreCase
|
|
8214
9453
|
*/
|
|
8215
9454
|
filterMode?: FilterMode | string;
|
|
9455
|
+
/**
|
|
9456
|
+
* A callback that should return a condition that will be used for custom item filtering. Used in conjunction with filterMode 'custom'
|
|
9457
|
+
* Default value: null
|
|
9458
|
+
*/
|
|
9459
|
+
filterCallback?: any;
|
|
8216
9460
|
/**
|
|
8217
9461
|
* If enabled, the items will be grouped by their first letter. Can't be applied if the dataSource already contains groups.
|
|
8218
9462
|
* Default value: false
|
|
@@ -8595,6 +9839,11 @@ export interface EditorProperties {
|
|
|
8595
9839
|
* Default value: null
|
|
8596
9840
|
*/
|
|
8597
9841
|
charCountFormatFunction?: any;
|
|
9842
|
+
/**
|
|
9843
|
+
* Sets or gets whether files will be automatically uploaded after selection.
|
|
9844
|
+
* Default value: false
|
|
9845
|
+
*/
|
|
9846
|
+
autoUpload?: boolean;
|
|
8598
9847
|
/**
|
|
8599
9848
|
* Determines the content filtering settings.
|
|
8600
9849
|
* Default value: [object Object]
|
|
@@ -8942,6 +10191,16 @@ export interface EditorProperties {
|
|
|
8942
10191
|
* Default value: 100
|
|
8943
10192
|
*/
|
|
8944
10193
|
splitModeRefreshTimeout?: number;
|
|
10194
|
+
/**
|
|
10195
|
+
* 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.
|
|
10196
|
+
* Default value: ""
|
|
10197
|
+
*/
|
|
10198
|
+
uploadUrl?: string;
|
|
10199
|
+
/**
|
|
10200
|
+
* 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.
|
|
10201
|
+
* Default value: ""
|
|
10202
|
+
*/
|
|
10203
|
+
removeUrl?: string;
|
|
8945
10204
|
/**
|
|
8946
10205
|
* Determines the theme. Theme defines the look of the element
|
|
8947
10206
|
* Default value: ""
|
|
@@ -9146,7 +10405,7 @@ export interface Editor extends BaseElement, EditorProperties {
|
|
|
9146
10405
|
onDialogClosing?: ((this: any, ev: Event) => any) | ((this: any, ev: CustomEvent<any>) => any) | null;
|
|
9147
10406
|
/**
|
|
9148
10407
|
* 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)
|
|
10408
|
+
* @param event. The custom event. Custom data event was created with: ev.detail(target, item, filename, type, size, index, status, serverResponse)
|
|
9150
10409
|
* target - The file upload element that is the target of the operation.
|
|
9151
10410
|
* item - The toolbar item that is the target of the operation.
|
|
9152
10411
|
* filename - The name of the uploaded file.
|
|
@@ -9154,11 +10413,12 @@ export interface Editor extends BaseElement, EditorProperties {
|
|
|
9154
10413
|
* size - The size of the uploaded file.
|
|
9155
10414
|
* index - The index of the uploaded file.
|
|
9156
10415
|
* status - The status of the uploaded file. Whether there was an error or success.
|
|
10416
|
+
* serverResponse - The response of the remote server.
|
|
9157
10417
|
*/
|
|
9158
10418
|
onImageUploadSuccess?: ((this: any, ev: Event) => any) | ((this: any, ev: CustomEvent<any>) => any) | null;
|
|
9159
10419
|
/**
|
|
9160
10420
|
* 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)
|
|
10421
|
+
* @param event. The custom event. Custom data event was created with: ev.detail(target, item, filename, type, size, index, status, serverResponse)
|
|
9162
10422
|
* target - The file upload element that is the target of the operation.
|
|
9163
10423
|
* item - The toolbar item that is the target of the operation.
|
|
9164
10424
|
* filename - The name of the canceled file.
|
|
@@ -9166,6 +10426,7 @@ export interface Editor extends BaseElement, EditorProperties {
|
|
|
9166
10426
|
* size - The size of the canceled file.
|
|
9167
10427
|
* index - The index of the canceled file.
|
|
9168
10428
|
* status - The status of the uploaded file. Whether there was an error or success.
|
|
10429
|
+
* serverResponse - The response of the remote server.
|
|
9169
10430
|
*/
|
|
9170
10431
|
onImageUploadFailed?: ((this: any, ev: Event) => any) | ((this: any, ev: CustomEvent<any>) => any) | null;
|
|
9171
10432
|
/**
|
|
@@ -9187,6 +10448,11 @@ export interface Editor extends BaseElement, EditorProperties {
|
|
|
9187
10448
|
* instance - The toast item that is the target of the operation.
|
|
9188
10449
|
*/
|
|
9189
10450
|
onMessageOpen?: ((this: any, ev: Event) => any) | ((this: any, ev: CustomEvent<any>) => any) | null;
|
|
10451
|
+
/**
|
|
10452
|
+
* Adds a new Toolbar item. Example: editor.addToolbarItem({ name: 'customButton2', width: 100, template: '<smart-button>Button2</smart-button>' })
|
|
10453
|
+
* @param {any} itemName. The toolbar item to be added
|
|
10454
|
+
*/
|
|
10455
|
+
addToolbarItem(itemName: any): void;
|
|
9190
10456
|
/**
|
|
9191
10457
|
* Blurs the content of the Editor.
|
|
9192
10458
|
*/
|
|
@@ -9253,6 +10519,12 @@ export interface Editor extends BaseElement, EditorProperties {
|
|
|
9253
10519
|
* Hides the last shown message.
|
|
9254
10520
|
*/
|
|
9255
10521
|
hideLastMessage(): void;
|
|
10522
|
+
/**
|
|
10523
|
+
* Inserts a new Toolbar item. Example: editor.insertToolbarItem({ name: 'customButton2', width: 100, template: '<smart-button>Button2</smart-button>' })
|
|
10524
|
+
* @param {any} itemName. The toolbar item to be added
|
|
10525
|
+
* @param {number} index. The toolbar item's index
|
|
10526
|
+
*/
|
|
10527
|
+
insertToolbarItem(itemName: any, index: number): void;
|
|
9256
10528
|
/**
|
|
9257
10529
|
* Shows a custom message inside the Editor.
|
|
9258
10530
|
* @param {string} message. The text message to be displayed.
|
|
@@ -9292,6 +10564,11 @@ export interface Editor extends BaseElement, EditorProperties {
|
|
|
9292
10564
|
* @param {boolean} value?. Determines whether to enter or leave split mode. By default the argument is not passed and the mode is toggled.
|
|
9293
10565
|
*/
|
|
9294
10566
|
previewMode(value?: boolean): void;
|
|
10567
|
+
/**
|
|
10568
|
+
* Removes a Toolbar item. Example: editor.removeToolbarItem(0)
|
|
10569
|
+
* @param {number} index. The toolbar item's index
|
|
10570
|
+
*/
|
|
10571
|
+
removeToolbarItem(index: number): void;
|
|
9295
10572
|
/**
|
|
9296
10573
|
* Sets Editor into Full Screen Mode. If enabled the Editor is positioned above the page content and fills the screen.
|
|
9297
10574
|
* @param {boolean} value?. Determines whether to enter or leave split mode. By default the argument is not passed and the mode is toggled.
|
|
@@ -9673,7 +10950,7 @@ declare global {
|
|
|
9673
10950
|
}
|
|
9674
10951
|
}
|
|
9675
10952
|
|
|
9676
|
-
export interface BaseElement extends
|
|
10953
|
+
export interface BaseElement extends HTMLElement, ElementProperties {
|
|
9677
10954
|
/**
|
|
9678
10955
|
* This event is triggered when the element is resized.
|
|
9679
10956
|
* @param event. The custom event. */
|
|
@@ -9850,6 +11127,11 @@ export interface FileUploadProperties {
|
|
|
9850
11127
|
* Default value: false
|
|
9851
11128
|
*/
|
|
9852
11129
|
unfocusable?: boolean;
|
|
11130
|
+
/**
|
|
11131
|
+
* 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.
|
|
11132
|
+
* Default value: ""
|
|
11133
|
+
*/
|
|
11134
|
+
removeUrl?: string;
|
|
9853
11135
|
/**
|
|
9854
11136
|
* Gets the file upload value.
|
|
9855
11137
|
* Default value: null
|
|
@@ -9888,12 +11170,13 @@ export interface FileUpload extends BaseElement, FileUploadProperties {
|
|
|
9888
11170
|
onUploadCanceled?: ((this: any, ev: Event) => any) | ((this: any, ev: CustomEvent<any>) => any) | null;
|
|
9889
11171
|
/**
|
|
9890
11172
|
* 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)
|
|
11173
|
+
* @param event. The custom event. Custom data event was created with: ev.detail(filename, type, size, index, status, serverResponse)
|
|
9892
11174
|
* filename - The name of the canceled file.
|
|
9893
11175
|
* type - The type of the canceled file.
|
|
9894
11176
|
* size - The size of the canceled file.
|
|
9895
11177
|
* index - The index of the canceled file.
|
|
9896
11178
|
* status - The status of the uploaded file. Whether there was an error or success.
|
|
11179
|
+
* serverResponse - The response of the remote server.
|
|
9897
11180
|
*/
|
|
9898
11181
|
onUploadCompleted?: ((this: any, ev: Event) => any) | ((this: any, ev: CustomEvent<any>) => any) | null;
|
|
9899
11182
|
/**
|
|
@@ -11356,15 +12639,15 @@ export interface FormProperties {
|
|
|
11356
12639
|
*/
|
|
11357
12640
|
controls?: Control[];
|
|
11358
12641
|
/**
|
|
11359
|
-
* Callback function for handling status changes
|
|
12642
|
+
* Callback function for handling status changes. The status could be 'disabled', 'invalid', 'pending', 'valid'.
|
|
11360
12643
|
* Default value: null
|
|
11361
12644
|
*/
|
|
11362
|
-
onStatusChanges?:
|
|
12645
|
+
onStatusChanges?: {(value: string): void};
|
|
11363
12646
|
/**
|
|
11364
|
-
* Callback function for handling value changes
|
|
12647
|
+
* Callback function for handling value changes. The function argument is the form's value as a JSON object.
|
|
11365
12648
|
* Default value: null
|
|
11366
12649
|
*/
|
|
11367
|
-
onValueChanges?: any;
|
|
12650
|
+
onValueChanges?: {(value: any): void};
|
|
11368
12651
|
/**
|
|
11369
12652
|
* Sets or Gets the labels position.
|
|
11370
12653
|
* Default value: left
|
|
@@ -11778,21 +13061,31 @@ export interface FormGroupProperties {
|
|
|
11778
13061
|
* Default value: 1
|
|
11779
13062
|
*/
|
|
11780
13063
|
columns?: number;
|
|
13064
|
+
/**
|
|
13065
|
+
* Sets the Form control data field. The control's inner input's name is set to the dataField value and in the FormGroup it is accessible through the dataField value.
|
|
13066
|
+
* Default value: ""
|
|
13067
|
+
*/
|
|
13068
|
+
dataField?: string;
|
|
13069
|
+
/**
|
|
13070
|
+
* Gets or Sets the Form control's label.
|
|
13071
|
+
* Default value: ""
|
|
13072
|
+
*/
|
|
13073
|
+
label?: string;
|
|
11781
13074
|
/**
|
|
11782
13075
|
*
|
|
11783
13076
|
* Default value: null
|
|
11784
13077
|
*/
|
|
11785
13078
|
controls?: Control[];
|
|
11786
13079
|
/**
|
|
11787
|
-
* Callback function for handling status changes
|
|
13080
|
+
* Callback function for handling status changes. The function argument is a string which could be: 'valid', 'invalid', 'disabled', 'pending'
|
|
11788
13081
|
* Default value: null
|
|
11789
13082
|
*/
|
|
11790
|
-
onStatusChanges?:
|
|
13083
|
+
onStatusChanges?: {(value: string): void};
|
|
11791
13084
|
/**
|
|
11792
|
-
* Callback function for handling value changes
|
|
13085
|
+
* Callback function for handling value changes. The function argument is the form's value as a JSON object.
|
|
11793
13086
|
* Default value: null
|
|
11794
13087
|
*/
|
|
11795
|
-
onValueChanges?: any;
|
|
13088
|
+
onValueChanges?: {(value: any): void};
|
|
11796
13089
|
/**
|
|
11797
13090
|
* Sets or Gets the labels position.
|
|
11798
13091
|
* Default value: left
|
|
@@ -12026,6 +13319,11 @@ export interface GanttChartProperties {
|
|
|
12026
13319
|
* Default value: false
|
|
12027
13320
|
*/
|
|
12028
13321
|
columnResizeFeedback?: boolean;
|
|
13322
|
+
/**
|
|
13323
|
+
* Gantt's current time. By default it is the today's date.
|
|
13324
|
+
* Default value:
|
|
13325
|
+
*/
|
|
13326
|
+
currentTime?: string | Date;
|
|
12029
13327
|
/**
|
|
12030
13328
|
* Enables/Disables the current time indicator. Current time indicator shows the current time in the appropriate view cells.
|
|
12031
13329
|
* Default value: false
|
|
@@ -12121,6 +13419,11 @@ export interface GanttChartProperties {
|
|
|
12121
13419
|
* Default value: false
|
|
12122
13420
|
*/
|
|
12123
13421
|
filterRow?: boolean;
|
|
13422
|
+
/**
|
|
13423
|
+
* Determines the view start day. Sunday is 0, Monday is 1, Saturday is 6. By default it's Sunday.
|
|
13424
|
+
* Default value: -1
|
|
13425
|
+
*/
|
|
13426
|
+
firstDayOfWeek?: number;
|
|
12124
13427
|
/**
|
|
12125
13428
|
* Groups the tasks inside the Task timeline according to the resources they are assigned to. Unassigned tasks are placed in a default group labeled 'Unassigned'.
|
|
12126
13429
|
* Default value: false
|
|
@@ -12137,10 +13440,20 @@ export interface GanttChartProperties {
|
|
|
12137
13440
|
*/
|
|
12138
13441
|
hideDateMarkers?: boolean;
|
|
12139
13442
|
/**
|
|
12140
|
-
* By default the Timeline has a
|
|
13443
|
+
* By default the Timeline has a three level header - timeline details, timeline second details and timeline header. This property hides the header container( the bottom container ).
|
|
13444
|
+
* Default value: false
|
|
13445
|
+
*/
|
|
13446
|
+
hideTimelineHeader?: boolean;
|
|
13447
|
+
/**
|
|
13448
|
+
* By default the Timeline has a three level header - timeline details, timeline second details and timeline header. This property hides the header details container( the top container ).
|
|
12141
13449
|
* Default value: false
|
|
12142
13450
|
*/
|
|
12143
13451
|
hideTimelineHeaderDetails?: boolean;
|
|
13452
|
+
/**
|
|
13453
|
+
* By default the Timeline has a three level header - timeline details and timeline header. This property hides the second header details container( the middle container ).
|
|
13454
|
+
* Default value: true
|
|
13455
|
+
*/
|
|
13456
|
+
hideTimelineSecondHeaderDetails?: boolean;
|
|
12144
13457
|
/**
|
|
12145
13458
|
* Shows the selection column of the Task/Resource Table. When applied a checkbox column is displayed that allows to select tasks/resources.
|
|
12146
13459
|
* Default value: false
|
|
@@ -12206,6 +13519,11 @@ export interface GanttChartProperties {
|
|
|
12206
13519
|
* Default value: short
|
|
12207
13520
|
*/
|
|
12208
13521
|
monthFormat?: MonthFormat | string;
|
|
13522
|
+
/**
|
|
13523
|
+
* Determines the scale in Month view.
|
|
13524
|
+
* Default value: week
|
|
13525
|
+
*/
|
|
13526
|
+
monthScale?: MonthScale | string;
|
|
12209
13527
|
/**
|
|
12210
13528
|
* Determines the nonworking days of the week from 0 to 6, where 0 is the first day of the week and 6 is the last day. Nonworking days will be displayed with colored cells inside the timeline and will not affect the dateEnd of the tasks unless the adjustToNonworkingTime property is enabled.
|
|
12211
13529
|
* Default value:
|
|
@@ -12216,6 +13534,11 @@ export interface GanttChartProperties {
|
|
|
12216
13534
|
* Default value:
|
|
12217
13535
|
*/
|
|
12218
13536
|
nonworkingHours?: number[] | number[][];
|
|
13537
|
+
/**
|
|
13538
|
+
* A function that can be used to completly customize the task element. The function has five arguments: task - the task object.segment - the task current segment object. If the task has only one segment, the task object is passed again.taskElement - the task's html element.segmentElement - the task's segment html element.labelElement - the task's segment label html element.
|
|
13539
|
+
* Default value: null
|
|
13540
|
+
*/
|
|
13541
|
+
onTaskRender?: any;
|
|
12219
13542
|
/**
|
|
12220
13543
|
* A function that can be used to completly customize the popup Window that is used to interact width tasks by changing their properties. The function as three arguments: target - the target popup Window that is about to be opened.type - the type of the window. The type determines the purpose of the window. Three possible values: 'task' (task editing), 'confirm' ( confirmation window), 'connection' (used when deleting a connection between tasks). item - the connection/task object that is the target of the window.
|
|
12221
13544
|
* Default value: null
|
|
@@ -12231,6 +13554,11 @@ export interface GanttChartProperties {
|
|
|
12231
13554
|
* Default value: null
|
|
12232
13555
|
*/
|
|
12233
13556
|
progressLabelFormatFunction?: any;
|
|
13557
|
+
/**
|
|
13558
|
+
* Determines the format of the dates the timeline header when they represent quarters.
|
|
13559
|
+
* Default value: short
|
|
13560
|
+
*/
|
|
13561
|
+
quarterFormat?: QuarterFormat | string;
|
|
12234
13562
|
/**
|
|
12235
13563
|
* A getter that returns a flat structure as an array of all resources inside the element.
|
|
12236
13564
|
* Default value: null
|
|
@@ -13138,6 +14466,11 @@ export interface GanttChartTask {
|
|
|
13138
14466
|
* Default value: null
|
|
13139
14467
|
*/
|
|
13140
14468
|
formatFunction?: any;
|
|
14469
|
+
/**
|
|
14470
|
+
* Project, Task or Milestone format function. The function gets passed the following arguments: task, segment, taskElement, segmentElement, labelElement. task - the task object.segment - the task current segment object. If the task has only one segment, the task object is passed again.taskElement - the task's html element.segmentElement - the task's segment html element.labelElement - the task's segment label html element.
|
|
14471
|
+
* Default value: null
|
|
14472
|
+
*/
|
|
14473
|
+
onRender?: any;
|
|
13141
14474
|
/**
|
|
13142
14475
|
* Project, Task or Milestone max start date.
|
|
13143
14476
|
* Default value:
|
|
@@ -13400,6 +14733,10 @@ export declare type GanttDayFormat = '2-digit' | 'numeric' | 'long' | 'short' |
|
|
|
13400
14733
|
export declare type Duration = 'day' | 'hour' | 'minute' | 'second' | 'milisecond';
|
|
13401
14734
|
/**Determines the format of the dates inside the timeline header when they represent hours. */
|
|
13402
14735
|
export declare type HourFormat = 'default' | '2-digit' | 'numeric';
|
|
14736
|
+
/**Determines the scale in Month view. */
|
|
14737
|
+
export declare type MonthScale = 'day' | 'week';
|
|
14738
|
+
/**Determines the format of the dates the timeline header when they represent quarters. */
|
|
14739
|
+
export declare type QuarterFormat = 'numeric' | 'long' | 'short';
|
|
13403
14740
|
/**Determines how the capacity of the resources will be visualized inside the resource timeline. By default, the capacity is measured in hours depending on the <b>view</b> property of the element. */
|
|
13404
14741
|
export declare type GanttChartResourceTimelineMode = 'diagram' | 'histogram' | 'custom';
|
|
13405
14742
|
/**Determines how the resources will be displayed inside the resource Timeline. */
|
|
@@ -13414,7 +14751,7 @@ month - the timeline shows the days of the month.
|
|
|
13414
14751
|
year - the timeline shows the months of the year.
|
|
13415
14752
|
resource - displays the current tasks by grouping them according to the resources they have assigned. The unassigned tasks will be placed in a separate group called 'Unassigned'.
|
|
13416
14753
|
<br /> The timeline has a header section that contains the labels of each cell according to the date inside them. The header is splitted in two sections in order to give a more detailed information of the dates. */
|
|
13417
|
-
export declare type GanttChartView = 'day' | 'week' | 'month' | 'year';
|
|
14754
|
+
export declare type GanttChartView = 'day' | 'week' | 'month' | 'quarter' | 'year';
|
|
13418
14755
|
/**Determines the format of the dates inside the timeline header when they represent weeks. */
|
|
13419
14756
|
export declare type WeekFormat = 'long' | 'numeric';
|
|
13420
14757
|
export interface GaugeProperties {
|
|
@@ -13764,6 +15101,11 @@ export interface GridProperties {
|
|
|
13764
15101
|
* Default value: []
|
|
13765
15102
|
*/
|
|
13766
15103
|
columns?: {label: string, dataField: string}[] | string[] | number | GridColumn[];
|
|
15104
|
+
/**
|
|
15105
|
+
* 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.
|
|
15106
|
+
* Default value: [object Object]
|
|
15107
|
+
*/
|
|
15108
|
+
contextMenu?: GridContextMenu;
|
|
13767
15109
|
/**
|
|
13768
15110
|
* 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
15111
|
* Default value: [object Object]
|
|
@@ -13864,6 +15206,11 @@ export interface GridProperties {
|
|
|
13864
15206
|
* Default value: null
|
|
13865
15207
|
*/
|
|
13866
15208
|
onRender?: any;
|
|
15209
|
+
/**
|
|
15210
|
+
* Callback function() called when the grid has been rendered for first time and bindings are completed. The component is ready.
|
|
15211
|
+
* Default value: null
|
|
15212
|
+
*/
|
|
15213
|
+
onLoad?: any;
|
|
13867
15214
|
/**
|
|
13868
15215
|
* Callback function(event: KeyboardEvent) called when the grid is on focus and a keyboard key is pressed.
|
|
13869
15216
|
* Default value: null
|
|
@@ -13884,6 +15231,16 @@ export interface GridProperties {
|
|
|
13884
15231
|
* Default value: null
|
|
13885
15232
|
*/
|
|
13886
15233
|
onRowDetailUpdated?: {(index: number, row: GridRow, details: HTMLElement): void};
|
|
15234
|
+
/**
|
|
15235
|
+
* Callback function which is called when a row history is updated. The row history for edits is recorded when the 'storeHistory' property is enabled.
|
|
15236
|
+
* Default value: null
|
|
15237
|
+
*/
|
|
15238
|
+
onRowHistory?: {(index: number, row: GridRow, history: any[]): void};
|
|
15239
|
+
/**
|
|
15240
|
+
* 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.
|
|
15241
|
+
* Default value: null
|
|
15242
|
+
*/
|
|
15243
|
+
onRowStyle?: {(index: number, row: GridRow, history: any[]): void};
|
|
13887
15244
|
/**
|
|
13888
15245
|
* Callback function which is called when a row has been inserted.
|
|
13889
15246
|
* Default value: null
|
|
@@ -13904,6 +15261,16 @@ export interface GridProperties {
|
|
|
13904
15261
|
* Default value: null
|
|
13905
15262
|
*/
|
|
13906
15263
|
onRowUpdated?: {(index: number[], row: GridRow[]): void};
|
|
15264
|
+
/**
|
|
15265
|
+
* Callback function called by the Grid when defined. It is used to get the CSS class applied to a row.
|
|
15266
|
+
* Default value: null
|
|
15267
|
+
*/
|
|
15268
|
+
onRowClass?: {(index: number, data: any, row: GridRow[]): void};
|
|
15269
|
+
/**
|
|
15270
|
+
* Callback function called by the Grid when defined. It is used to get the CSS class applied to a cell.
|
|
15271
|
+
* Default value: null
|
|
15272
|
+
*/
|
|
15273
|
+
onCellClass?: {(index: number, dataField: string, cellValue: any, data: any, row: GridRow[]): void};
|
|
13907
15274
|
/**
|
|
13908
15275
|
* Callback function, which is called when a column has been initialized. This function can be used to customize the column settings.
|
|
13909
15276
|
* Default value: null
|
|
@@ -13924,11 +15291,21 @@ export interface GridProperties {
|
|
|
13924
15291
|
* Default value: null
|
|
13925
15292
|
*/
|
|
13926
15293
|
onColumnUpdated?: {(index: number, column: GridColumn): void};
|
|
15294
|
+
/**
|
|
15295
|
+
* Callback function, which is called when a column has been cloned.
|
|
15296
|
+
* Default value: null
|
|
15297
|
+
*/
|
|
15298
|
+
onColumnClone?: {(dataField: string, cloneColumnDataField: string, index: number, duplicateCells: boolean): void};
|
|
13927
15299
|
/**
|
|
13928
15300
|
* 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
15301
|
* Default value: null
|
|
13930
15302
|
*/
|
|
13931
15303
|
onCommand?: {(name: string, command: any, details: GridCell, event: Event | KeyboardEvent | PointerEvent, handled: boolean): void};
|
|
15304
|
+
/**
|
|
15305
|
+
* Sets or gets the rows CSS class rules. Different CSS class names are conditionally applied. Example: rowCSSRules: { 'cell-class-1': settings => settings.data.quantity === 5, 'cell-class-2': settings => settings.data.quantity < 5, 'cell-class-3': settings => settings.data.quantity > 5 }. The settings object contains the following properties: index, data, row, api.
|
|
15306
|
+
* Default value: null
|
|
15307
|
+
*/
|
|
15308
|
+
rowCSSRules?: any;
|
|
13932
15309
|
/**
|
|
13933
15310
|
* 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
15311
|
* Default value:
|
|
@@ -13939,6 +15316,11 @@ export interface GridProperties {
|
|
|
13939
15316
|
* Default value: []
|
|
13940
15317
|
*/
|
|
13941
15318
|
users?: any[];
|
|
15319
|
+
/**
|
|
15320
|
+
* Sets the grid's image and filter upload settings for the image and attachment columns.
|
|
15321
|
+
* Default value: [object Object]
|
|
15322
|
+
*/
|
|
15323
|
+
uploadSettings?: GridUploadSettings;
|
|
13942
15324
|
/**
|
|
13943
15325
|
* Describes the paging settings.
|
|
13944
15326
|
* Default value: [object Object]
|
|
@@ -13969,6 +15351,11 @@ export interface GridProperties {
|
|
|
13969
15351
|
* Default value: [object Object]
|
|
13970
15352
|
*/
|
|
13971
15353
|
summaryRow?: GridSummaryRow;
|
|
15354
|
+
/**
|
|
15355
|
+
* Sets the grid's state settings.
|
|
15356
|
+
* Default value: [object Object]
|
|
15357
|
+
*/
|
|
15358
|
+
stateSettings?: GridStateSettings;
|
|
13972
15359
|
/**
|
|
13973
15360
|
* Describes the settings for the group header.
|
|
13974
15361
|
* Default value: [object Object]
|
|
@@ -14013,13 +15400,15 @@ export interface Grid extends BaseElement, GridProperties {
|
|
|
14013
15400
|
/* Get a member by its name */
|
|
14014
15401
|
[name: string]: any;
|
|
14015
15402
|
/**
|
|
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)
|
|
15403
|
+
* 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();.
|
|
15404
|
+
* @param event. The custom event. Custom data event was created with: ev.detail(id, dataField, row, column, cell, data, value)
|
|
14018
15405
|
* id - The edited row id.
|
|
14019
15406
|
* dataField - The edited column data field.
|
|
14020
15407
|
* row - The edited row.
|
|
14021
15408
|
* column - The edited column.
|
|
14022
15409
|
* cell - The edited cell.
|
|
15410
|
+
* data - The edited row's data.
|
|
15411
|
+
* value - The edited cell's value.
|
|
14023
15412
|
*/
|
|
14024
15413
|
onBeginEdit?: ((this: any, ev: Event) => any) | ((this: any, ev: CustomEvent<any>) => any) | null;
|
|
14025
15414
|
/**
|
|
@@ -14122,6 +15511,14 @@ export interface Grid extends BaseElement, GridProperties {
|
|
|
14122
15511
|
* 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
15512
|
*/
|
|
14124
15513
|
onCommentRemove?: ((this: any, ev: Event) => any) | ((this: any, ev: CustomEvent<any>) => any) | null;
|
|
15514
|
+
/**
|
|
15515
|
+
* This event is triggered, when the user clicks on a context menu item.
|
|
15516
|
+
* @param event. The custom event. Custom data event was created with: ev.detail(id, dataField, command)
|
|
15517
|
+
* id - The row's id.
|
|
15518
|
+
* dataField - The column's data field.
|
|
15519
|
+
* command - Command function.
|
|
15520
|
+
*/
|
|
15521
|
+
onContextMenuItemClick?: ((this: any, ev: Event) => any) | ((this: any, ev: CustomEvent<any>) => any) | null;
|
|
14125
15522
|
/**
|
|
14126
15523
|
* This event is triggered, when the user starts a row drag.
|
|
14127
15524
|
* @param event. The custom event. Custom data event was created with: ev.detail(row, id, index, originalEvent)
|
|
@@ -14245,12 +15642,14 @@ export interface Grid extends BaseElement, GridProperties {
|
|
|
14245
15642
|
onCellDoubleClick?: ((this: any, ev: Event) => any) | ((this: any, ev: CustomEvent<any>) => any) | null;
|
|
14246
15643
|
/**
|
|
14247
15644
|
* 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)
|
|
15645
|
+
* @param event. The custom event. Custom data event was created with: ev.detail(id, dataField, row, column, cell, data, value)
|
|
14249
15646
|
* id - The edited row id.
|
|
14250
15647
|
* dataField - The edited column data field.
|
|
14251
15648
|
* row - The edited row.
|
|
14252
15649
|
* column - The edited column.
|
|
14253
15650
|
* cell - The edited cell.
|
|
15651
|
+
* data - The edited row's data.
|
|
15652
|
+
* value - The edited cell's value.
|
|
14254
15653
|
*/
|
|
14255
15654
|
onEndEdit?: ((this: any, ev: Event) => any) | ((this: any, ev: CustomEvent<any>) => any) | null;
|
|
14256
15655
|
/**
|
|
@@ -14324,9 +15723,9 @@ export interface Grid extends BaseElement, GridProperties {
|
|
|
14324
15723
|
* Adds a row. When batch editing is enabled, the row is not saved until the batch edit is saved.
|
|
14325
15724
|
* @param {any} data. row data matching the data source
|
|
14326
15725
|
* @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
|
|
15726
|
+
* @param callback?. Sets a callback function, which is called after the new row is added. The callback's argument is the new row.
|
|
14328
15727
|
*/
|
|
14329
|
-
addRow(data: any, insertAtBottom?: boolean, callback?:
|
|
15728
|
+
addRow(data: any, insertAtBottom?: boolean, callback?: {(row: GridRow): void}): void;
|
|
14330
15729
|
/**
|
|
14331
15730
|
* 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
15731
|
* @param {string} position?. 'near' or 'far'
|
|
@@ -14347,7 +15746,7 @@ export interface Grid extends BaseElement, GridProperties {
|
|
|
14347
15746
|
*/
|
|
14348
15747
|
addUnboundRow(count: number, position?: string): boolean;
|
|
14349
15748
|
/**
|
|
14350
|
-
* Adds a filter to a column. This method will apply a filter to the Grid data.
|
|
15749
|
+
* 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', '<= 5')
|
|
14351
15750
|
* @param {string} dataField. column bound data field. For example, if you have a column with dataField: 'firstName', set 'firstName' here.
|
|
14352
15751
|
* @param {string} filter. Filter expression like: 'startsWith B'. Example 2: ['contains Andrew or contains Nancy'], Example 3: ['quantity', '<= 3 and >= 8']. Filter conditions which you can use in the expressions: '=', 'EQUAL','<>', 'NOT_EQUAL', '!=', '<', 'LESS_THAN','>', 'GREATER_THAN', '<=', 'LESS_THAN_OR_EQUAL', '>=', 'GREATER_THAN_OR_EQUAL','starts with', 'STARTS_WITH','ends with', 'ENDS_WITH', '', 'EMPTY', 'CONTAINS','DOES_NOT_CONTAIN', 'NULL','NOT_NULL'
|
|
14353
15752
|
* @param {boolean} refreshFilters?. Set this to false, if you will use multiple 'addFilter' calls. By doing this, you will avoid unnecessary renders.
|
|
@@ -14372,6 +15771,11 @@ export interface Grid extends BaseElement, GridProperties {
|
|
|
14372
15771
|
* Auto-sizes grid columns. This method will update the <em>width</em> of all Grid columns.
|
|
14373
15772
|
*/
|
|
14374
15773
|
autoSizeColumns(): void;
|
|
15774
|
+
/**
|
|
15775
|
+
* 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.
|
|
15776
|
+
* @param {string} dataField?. column bound data field. For example, if you have a column with dataField: 'firstName', set 'firstName' here.
|
|
15777
|
+
*/
|
|
15778
|
+
autoSizeColumn(dataField?: string): void;
|
|
14375
15779
|
/**
|
|
14376
15780
|
* This method returns true, if all rows in the Grid are selected.
|
|
14377
15781
|
* @returns {boolean}
|
|
@@ -14442,9 +15846,9 @@ export interface Grid extends BaseElement, GridProperties {
|
|
|
14442
15846
|
/**
|
|
14443
15847
|
* Delete a row. When batch editing is enabled, the row is not saved until the batch edit is saved.
|
|
14444
15848
|
* @param {string | number} rowId. row bound id
|
|
14445
|
-
* @param
|
|
15849
|
+
* @param callback?. Sets a callback function, which is called after the row is deleted. The callback's argument is the deleted row.
|
|
14446
15850
|
*/
|
|
14447
|
-
deleteRow(rowId: string | number, callback?:
|
|
15851
|
+
deleteRow(rowId: string | number, callback?: {(row: GridRow): void}): void;
|
|
14448
15852
|
/**
|
|
14449
15853
|
* 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
15854
|
* @param {string | number} rowId. row bound id
|
|
@@ -14462,10 +15866,15 @@ export interface Grid extends BaseElement, GridProperties {
|
|
|
14462
15866
|
*/
|
|
14463
15867
|
endUpdate(refresh?: boolean): void;
|
|
14464
15868
|
/**
|
|
14465
|
-
* Expands a TreeGrid or Grouping row.
|
|
15869
|
+
* 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
15870
|
* @param {string | number} rowId. row bound id
|
|
14467
15871
|
*/
|
|
14468
15872
|
expandRow(rowId: string | number): void;
|
|
15873
|
+
/**
|
|
15874
|
+
* Expands rows to a given group level. For example 'grid.expandRowsToGroupLevel(1);' means that all groups at the root level will be expanded.
|
|
15875
|
+
* @param {number} level. row group level
|
|
15876
|
+
*/
|
|
15877
|
+
expandRowsToGroupLevel(level: number): void;
|
|
14469
15878
|
/**
|
|
14470
15879
|
* Expands all TreeGrid or Grouping rows.
|
|
14471
15880
|
*/
|
|
@@ -14475,6 +15884,20 @@ export interface Grid extends BaseElement, GridProperties {
|
|
|
14475
15884
|
* @param {string} Dataformat. 'xlsx', 'pdf', 'json', 'xml', 'csv', 'tsv', 'html', 'png', 'jpeg'.
|
|
14476
15885
|
*/
|
|
14477
15886
|
exportData(Dataformat: string): void;
|
|
15887
|
+
/**
|
|
15888
|
+
* 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.
|
|
15889
|
+
* @param {string} query. Search query
|
|
15890
|
+
* @param {string} dataField?. Column data field.
|
|
15891
|
+
* @param {string} condition?. Conditions which you can use in the expressions: '=', 'EQUAL','<>', 'NOT_EQUAL', '!=', '<', 'LESS_THAN','>', 'GREATER_THAN', '<=', 'LESS_THAN_OR_EQUAL', '>=', 'GREATER_THAN_OR_EQUAL','starts with', 'STARTS_WITH','ends with', 'ENDS_WITH', '', 'EMPTY', 'CONTAINS','DOES_NOT_CONTAIN', 'NULL','NOT_NULL'
|
|
15892
|
+
* @returns {any[]}
|
|
15893
|
+
*/
|
|
15894
|
+
find(query: string, dataField?: string, condition?: string): any[];
|
|
15895
|
+
/**
|
|
15896
|
+
* 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.
|
|
15897
|
+
* @param {string} query. Search query. You can enter multiple search strings, by using ','. Example: 'nancy, davolio'
|
|
15898
|
+
* @returns {any[]}
|
|
15899
|
+
*/
|
|
15900
|
+
findCells(query: string): any[];
|
|
14478
15901
|
/**
|
|
14479
15902
|
* Navigates to a page, when paging is enabled.
|
|
14480
15903
|
* @param {number} index. page index
|
|
@@ -14496,6 +15919,22 @@ export interface Grid extends BaseElement, GridProperties {
|
|
|
14496
15919
|
* Navigates to the last page, when grid paging is enabled.
|
|
14497
15920
|
*/
|
|
14498
15921
|
lastPage(): void;
|
|
15922
|
+
/**
|
|
15923
|
+
* 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.
|
|
15924
|
+
* @param {string | number} rowId. row bound id
|
|
15925
|
+
* @param {string} dataField?. column bound data field
|
|
15926
|
+
*/
|
|
15927
|
+
focusAndSelect(rowId: string | number, dataField?: string): void;
|
|
15928
|
+
/**
|
|
15929
|
+
* 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.
|
|
15930
|
+
* @param {any} rowCallback. Callback function with a row object as parameter. Example: grid.forEachRow((row) => { console.log(row.id) });
|
|
15931
|
+
*/
|
|
15932
|
+
forEachRow(rowCallback: any): void;
|
|
15933
|
+
/**
|
|
15934
|
+
* 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.
|
|
15935
|
+
* @param {any} rowCallback. Callback function with a row object as parameter. Example: grid.forEachRow((row) => { console.log(row.id) });
|
|
15936
|
+
*/
|
|
15937
|
+
forEachRowAfterFilterAndSort(rowCallback: any): void;
|
|
14499
15938
|
/**
|
|
14500
15939
|
* 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
15940
|
* @returns {number}
|
|
@@ -14521,6 +15960,11 @@ export interface Grid extends BaseElement, GridProperties {
|
|
|
14521
15960
|
* @returns {any}
|
|
14522
15961
|
*/
|
|
14523
15962
|
getColumns(): any;
|
|
15963
|
+
/**
|
|
15964
|
+
* Gets the editing cell(s), when the grid is editing.
|
|
15965
|
+
* @returns {any[]}
|
|
15966
|
+
*/
|
|
15967
|
+
getEditCells(): any[];
|
|
14524
15968
|
/**
|
|
14525
15969
|
* Gets the groups array.
|
|
14526
15970
|
* @returns {any[]}
|
|
@@ -14537,10 +15981,20 @@ export interface Grid extends BaseElement, GridProperties {
|
|
|
14537
15981
|
*/
|
|
14538
15982
|
getSelection(): any;
|
|
14539
15983
|
/**
|
|
14540
|
-
* Gets the
|
|
15984
|
+
* 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
15985
|
* @returns {any[]}
|
|
14542
15986
|
*/
|
|
14543
15987
|
getSelectedRows(): any[];
|
|
15988
|
+
/**
|
|
15989
|
+
* Gets the selected row ids.
|
|
15990
|
+
* @returns {any[]}
|
|
15991
|
+
*/
|
|
15992
|
+
getSelectedRowIds(): any[];
|
|
15993
|
+
/**
|
|
15994
|
+
* Gets the selected row indexes.
|
|
15995
|
+
* @returns {any[]}
|
|
15996
|
+
*/
|
|
15997
|
+
getSelectedRowIndexes(): any[];
|
|
14544
15998
|
/**
|
|
14545
15999
|
* 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
16000
|
* @returns {any[]}
|
|
@@ -14562,10 +16016,26 @@ export interface Grid extends BaseElement, GridProperties {
|
|
|
14562
16016
|
*/
|
|
14563
16017
|
getViewRows(): any;
|
|
14564
16018
|
/**
|
|
14565
|
-
* Gets a JSON object with the following fields: 'sort', 'filter', 'groups', 'paging', 'selectedCells', 'selectedrows'.
|
|
16019
|
+
* 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
16020
|
* @returns {any}
|
|
14567
16021
|
*/
|
|
14568
16022
|
getState(): any;
|
|
16023
|
+
/**
|
|
16024
|
+
* 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.
|
|
16025
|
+
* @param {string} name?. state name
|
|
16026
|
+
* @returns {any}
|
|
16027
|
+
*/
|
|
16028
|
+
saveState(name?: string): any;
|
|
16029
|
+
/**
|
|
16030
|
+
* 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.
|
|
16031
|
+
* @param {any} state. state name or state object
|
|
16032
|
+
* @returns {any}
|
|
16033
|
+
*/
|
|
16034
|
+
loadState(state: any): any;
|
|
16035
|
+
/**
|
|
16036
|
+
* Resets the Grid state.
|
|
16037
|
+
*/
|
|
16038
|
+
resetState(): void;
|
|
14569
16039
|
/**
|
|
14570
16040
|
* Gets the changes from the batch edit.
|
|
14571
16041
|
* @returns
|
|
@@ -14578,6 +16048,12 @@ export interface Grid extends BaseElement, GridProperties {
|
|
|
14578
16048
|
* @returns {any}
|
|
14579
16049
|
*/
|
|
14580
16050
|
getCellValue(rowId: string | number, dataField: string): any;
|
|
16051
|
+
/**
|
|
16052
|
+
* Gets a column. Returns a Grid column object.
|
|
16053
|
+
* @param {string} dataField. column bound data field. For example, if you have a column with dataField: 'firstName', set 'firstName' here.
|
|
16054
|
+
* @returns {GridColumn}
|
|
16055
|
+
*/
|
|
16056
|
+
getColumn(dataField: string): GridColumn;
|
|
14581
16057
|
/**
|
|
14582
16058
|
* Gets a value of a column.
|
|
14583
16059
|
* @param {string} dataField. column bound data field. For example, if you have a column with dataField: 'firstName', set 'firstName' here.
|
|
@@ -14592,6 +16068,18 @@ export interface Grid extends BaseElement, GridProperties {
|
|
|
14592
16068
|
* @returns {any}
|
|
14593
16069
|
*/
|
|
14594
16070
|
getRowProperty(rowId: string | number, propertyName: string): any;
|
|
16071
|
+
/**
|
|
16072
|
+
* Gets a row. Returns a Grid row object.
|
|
16073
|
+
* @param {string | number} rowId. row bound id
|
|
16074
|
+
* @returns {GridRow}
|
|
16075
|
+
*/
|
|
16076
|
+
getRow(rowId: string | number): GridRow;
|
|
16077
|
+
/**
|
|
16078
|
+
* Gets a row by its index. Returns a Grid row object.
|
|
16079
|
+
* @param {number} rowIndex. row bound index
|
|
16080
|
+
* @returns {GridRow}
|
|
16081
|
+
*/
|
|
16082
|
+
getRowByIndex(rowIndex: number): GridRow;
|
|
14595
16083
|
/**
|
|
14596
16084
|
* Gets the Data source data associated to the row.
|
|
14597
16085
|
* @param {string | number} rowId. row bound id
|
|
@@ -14599,11 +16087,11 @@ export interface Grid extends BaseElement, GridProperties {
|
|
|
14599
16087
|
*/
|
|
14600
16088
|
getRowData(rowId: string | number): any;
|
|
14601
16089
|
/**
|
|
14602
|
-
* Gets the Row's id.
|
|
16090
|
+
* Gets the Row's id by a row index.
|
|
14603
16091
|
* @param {number} rowIndex. row index
|
|
14604
|
-
* @returns {
|
|
16092
|
+
* @returns {string | number}
|
|
14605
16093
|
*/
|
|
14606
|
-
getRowId(rowIndex: number):
|
|
16094
|
+
getRowId(rowIndex: number): string | number;
|
|
14607
16095
|
/**
|
|
14608
16096
|
* Gets whether a column's drop-down menu is opened.
|
|
14609
16097
|
* @returns {boolean}
|
|
@@ -14641,14 +16129,20 @@ export interface Grid extends BaseElement, GridProperties {
|
|
|
14641
16129
|
* Inserts a row. When batch editing is enabled, the row is not saved until the batch edit is saved.
|
|
14642
16130
|
* @param {any} data. row data matching the data source
|
|
14643
16131
|
* @param {number} index?. Determines the insert index. The default value is the last index.
|
|
14644
|
-
* @param
|
|
16132
|
+
* @param callback?. Sets a callback function, which is called after the new row is added. The callback's argument is the new row.
|
|
14645
16133
|
*/
|
|
14646
|
-
insertRow(data: any, index?: number, callback?:
|
|
16134
|
+
insertRow(data: any, index?: number, callback?: {(row: GridRow): void}): void;
|
|
14647
16135
|
/**
|
|
14648
16136
|
* Opens a column drop-down menu.
|
|
14649
16137
|
* @param {string} dataField. column bound data field. For example, if you have a column with dataField: 'firstName', set 'firstName' here.
|
|
14650
16138
|
*/
|
|
14651
16139
|
openMenu(dataField: string): void;
|
|
16140
|
+
/**
|
|
16141
|
+
* Opens a context menu. Note that context menu should be enabled.
|
|
16142
|
+
* @param {number} left. Left Position.
|
|
16143
|
+
* @param {number} top. Top Position.
|
|
16144
|
+
*/
|
|
16145
|
+
openContextMenu(left: number, top: number): void;
|
|
14652
16146
|
/**
|
|
14653
16147
|
* 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
16148
|
*/
|
|
@@ -14746,6 +16240,24 @@ export interface Grid extends BaseElement, GridProperties {
|
|
|
14746
16240
|
* @param {number[]} rowIndex. Array of row indexes
|
|
14747
16241
|
*/
|
|
14748
16242
|
selectRowsByIndex(rowIndex: number[]): void;
|
|
16243
|
+
/**
|
|
16244
|
+
* 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.
|
|
16245
|
+
* @param {string} query. Search query
|
|
16246
|
+
* @param {string} dataField?. Column data field.
|
|
16247
|
+
* @param {string} condition?. Conditions which you can use in the expressions: '=', 'EQUAL','<>', 'NOT_EQUAL', '!=', '<', 'LESS_THAN','>', 'GREATER_THAN', '<=', 'LESS_THAN_OR_EQUAL', '>=', 'GREATER_THAN_OR_EQUAL','starts with', 'STARTS_WITH','ends with', 'ENDS_WITH', '', 'EMPTY', 'CONTAINS','DOES_NOT_CONTAIN', 'NULL','NOT_NULL'
|
|
16248
|
+
*/
|
|
16249
|
+
selectRowsByQuery(query: string, dataField?: string, condition?: string): void;
|
|
16250
|
+
/**
|
|
16251
|
+
* 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.
|
|
16252
|
+
* @param {(string | number)[]} rowIds. Array of row ids
|
|
16253
|
+
* @param {string[]} dataFields. Array of data fields.
|
|
16254
|
+
*/
|
|
16255
|
+
selectCells(rowIds: (string | number)[], dataFields: string[]): void;
|
|
16256
|
+
/**
|
|
16257
|
+
* 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.
|
|
16258
|
+
* @param {string} query. Search query
|
|
16259
|
+
*/
|
|
16260
|
+
selectCellsByQuery(query: string): void;
|
|
14749
16261
|
/**
|
|
14750
16262
|
* Sets a new value to a cell.
|
|
14751
16263
|
* @param {string | number} rowId. row bound id
|
|
@@ -14753,6 +16265,11 @@ export interface Grid extends BaseElement, GridProperties {
|
|
|
14753
16265
|
* @param {string | number | Date | boolean} value. New Cell value.
|
|
14754
16266
|
*/
|
|
14755
16267
|
setCellValue(rowId: string | number, dataField: string, value: string | number | Date | boolean): void;
|
|
16268
|
+
/**
|
|
16269
|
+
* 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.
|
|
16270
|
+
* @param {GridColumn[]} columns. Columns array.
|
|
16271
|
+
*/
|
|
16272
|
+
setColumns(columns: GridColumn[]): void;
|
|
14756
16273
|
/**
|
|
14757
16274
|
* Sets a property to a column.
|
|
14758
16275
|
* @param {string} dataField. column bound data field. For example, if you have a column with dataField: 'firstName', set 'firstName' here.
|
|
@@ -14770,16 +16287,16 @@ export interface Grid extends BaseElement, GridProperties {
|
|
|
14770
16287
|
/**
|
|
14771
16288
|
* Sets a style to a row.
|
|
14772
16289
|
* @param {string | number} rowId. row bound id
|
|
14773
|
-
* @param
|
|
16290
|
+
* @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
16291
|
*/
|
|
14775
|
-
setRowStyle(rowId: string | number, rowStyle:
|
|
16292
|
+
setRowStyle(rowId: string | number, rowStyle: {background?: string, color?: string, fontSize?: string, fontFamily?: string, textDecoration?: string, fontStyle?: string, fontWeight?: string}): void;
|
|
14776
16293
|
/**
|
|
14777
16294
|
* Sets a style to a row.
|
|
14778
16295
|
* @param {string | number} rowId. row bound id
|
|
14779
16296
|
* @param {string} dataField. Column bound field name.
|
|
14780
|
-
* @param
|
|
16297
|
+
* @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
16298
|
*/
|
|
14782
|
-
setCellStyle(rowId: string | number, dataField: string, rowStyle:
|
|
16299
|
+
setCellStyle(rowId: string | number, dataField: string, rowStyle: {background?: string, color?: string, fontSize?: string, fontFamily?: string, textDecoration?: string, fontStyle?: string, fontWeight?: string}): void;
|
|
14783
16300
|
/**
|
|
14784
16301
|
* Sets the position of the vertical scrollbar. You can use this method in combination with the getVerticalScrollValue and getVerticalScrollMax.
|
|
14785
16302
|
* @param {number} value. The new scroll position
|
|
@@ -14799,9 +16316,9 @@ export interface Grid extends BaseElement, GridProperties {
|
|
|
14799
16316
|
* Updates a row. When batch editing is enabled, the row is not saved until the batch edit is saved.
|
|
14800
16317
|
* @param {string | number} rowId. row bound id
|
|
14801
16318
|
* @param {any} data. row data matching the data source
|
|
14802
|
-
* @param
|
|
16319
|
+
* @param callback?. Sets a callback function, which is called after the row is updated. The callback's argument is the updated row.
|
|
14803
16320
|
*/
|
|
14804
|
-
updateRow(rowId: string | number, data: any, callback?:
|
|
16321
|
+
updateRow(rowId: string | number, data: any, callback?: {(row: GridRow): void}): void;
|
|
14805
16322
|
/**
|
|
14806
16323
|
* Unselects a row, cell or column.
|
|
14807
16324
|
* @param {string | number} rowId. row bound id
|
|
@@ -14946,6 +16463,11 @@ export interface GridAppearance {
|
|
|
14946
16463
|
* Default value: false
|
|
14947
16464
|
*/
|
|
14948
16465
|
showRowHeader?: boolean;
|
|
16466
|
+
/**
|
|
16467
|
+
* 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.
|
|
16468
|
+
* Default value: false
|
|
16469
|
+
*/
|
|
16470
|
+
showTreeRowHeader?: boolean;
|
|
14949
16471
|
/**
|
|
14950
16472
|
* Shows row indexes in the row header. The showRowHeader property should be true
|
|
14951
16473
|
* Default value: false
|
|
@@ -14976,6 +16498,11 @@ export interface GridAppearance {
|
|
|
14976
16498
|
* Default value: true
|
|
14977
16499
|
*/
|
|
14978
16500
|
showColumnHeaderLines?: boolean;
|
|
16501
|
+
/**
|
|
16502
|
+
* 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.
|
|
16503
|
+
* Default value: false
|
|
16504
|
+
*/
|
|
16505
|
+
showColumnHeaderDragIcon?: boolean;
|
|
14979
16506
|
/**
|
|
14980
16507
|
* Shows column lines.
|
|
14981
16508
|
* Default value: true
|
|
@@ -14986,6 +16513,16 @@ export interface GridAppearance {
|
|
|
14986
16513
|
* Default value: true
|
|
14987
16514
|
*/
|
|
14988
16515
|
showRowLines?: boolean;
|
|
16516
|
+
/**
|
|
16517
|
+
* Shows lines between columns in column groups.
|
|
16518
|
+
* Default value: true
|
|
16519
|
+
*/
|
|
16520
|
+
showColumnGroupLines?: boolean;
|
|
16521
|
+
/**
|
|
16522
|
+
* Shows lines between cells in column groups.
|
|
16523
|
+
* Default value: true
|
|
16524
|
+
*/
|
|
16525
|
+
showColumnGroupCellLines?: boolean;
|
|
14989
16526
|
/**
|
|
14990
16527
|
* Shows column groups in the Hide columns panel. Column groups and columns are shown in a tree-like structure. When the property is set to false, the column groups are not displayed and the column labels contain the column group name.
|
|
14991
16528
|
* Default value: false
|
|
@@ -14993,12 +16530,12 @@ export interface GridAppearance {
|
|
|
14993
16530
|
showColumnGroupsInColumnPanel?: boolean;
|
|
14994
16531
|
/**
|
|
14995
16532
|
* Shows filtered column background, when filter is applied.
|
|
14996
|
-
* Default value:
|
|
16533
|
+
* Default value: false
|
|
14997
16534
|
*/
|
|
14998
16535
|
showFilterColumnBackground?: boolean;
|
|
14999
16536
|
/**
|
|
15000
16537
|
* Shows sorted column background, when sorting is applied.
|
|
15001
|
-
* Default value:
|
|
16538
|
+
* Default value: false
|
|
15002
16539
|
*/
|
|
15003
16540
|
showSortColumnBackground?: boolean;
|
|
15004
16541
|
/**
|
|
@@ -15007,10 +16544,10 @@ export interface GridAppearance {
|
|
|
15007
16544
|
*/
|
|
15008
16545
|
showFrozenColumnBackground?: boolean;
|
|
15009
16546
|
/**
|
|
15010
|
-
* Shows
|
|
15011
|
-
* Default value:
|
|
16547
|
+
* Shows the selection on top of all other styles.
|
|
16548
|
+
* Default value: false
|
|
15012
16549
|
*/
|
|
15013
|
-
|
|
16550
|
+
showSelectionOnTop?: boolean;
|
|
15014
16551
|
/**
|
|
15015
16552
|
* Shows column sort button.
|
|
15016
16553
|
* Default value: true
|
|
@@ -15056,6 +16593,11 @@ export interface GridAppearance {
|
|
|
15056
16593
|
* Default value: false
|
|
15057
16594
|
*/
|
|
15058
16595
|
showVerticalScrollBarOnFixedColumns?: boolean;
|
|
16596
|
+
/**
|
|
16597
|
+
* Shows the today's date as 'Today' vs '7/8/2022'. When the property is set to false, it will display the date.
|
|
16598
|
+
* Default value: true
|
|
16599
|
+
*/
|
|
16600
|
+
showTodayDateAsString?: boolean;
|
|
15059
16601
|
}
|
|
15060
16602
|
|
|
15061
16603
|
/**An object containing settings related to the grid's behavior. */
|
|
@@ -15157,7 +16699,7 @@ export interface GridClipboard {
|
|
|
15157
16699
|
* Sets or gets a callback on paste.
|
|
15158
16700
|
* Default value: null
|
|
15159
16701
|
*/
|
|
15160
|
-
onPasteValue?: any;
|
|
16702
|
+
onPasteValue?: {(args: {value: any, oldValue: any, dataField: string, id: string | number}): void};
|
|
15161
16703
|
}
|
|
15162
16704
|
|
|
15163
16705
|
export interface GridColumn {
|
|
@@ -15242,15 +16784,20 @@ export interface GridColumn {
|
|
|
15242
16784
|
*/
|
|
15243
16785
|
cellsVerticalAlign?: VerticalAlignment | string;
|
|
15244
16786
|
/**
|
|
15245
|
-
* Sets or gets the column's header CSS class name.
|
|
16787
|
+
* Sets or gets the column's header CSS class name. You can apply multiple CSS class names by separating them with space.
|
|
15246
16788
|
* Default value: ""
|
|
15247
16789
|
*/
|
|
15248
16790
|
className?: string;
|
|
15249
16791
|
/**
|
|
15250
|
-
* Sets or gets the column's cells CSS class name.
|
|
15251
|
-
* Default value:
|
|
16792
|
+
* 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' } }
|
|
16793
|
+
* Default value:
|
|
16794
|
+
*/
|
|
16795
|
+
cellsClassName?: any;
|
|
16796
|
+
/**
|
|
16797
|
+
* 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 <5, 'three': settings => settings.value === 3 }. The settings object contains the following properties: index, value, dataField, row, api.
|
|
16798
|
+
* Default value: null
|
|
15252
16799
|
*/
|
|
15253
|
-
|
|
16800
|
+
cellsCSSRules?: any;
|
|
15254
16801
|
/**
|
|
15255
16802
|
* Sets the name of the column group.
|
|
15256
16803
|
* Default value: ""
|
|
@@ -15282,7 +16829,7 @@ export interface GridColumn {
|
|
|
15282
16829
|
*/
|
|
15283
16830
|
element?: HTMLElement;
|
|
15284
16831
|
/**
|
|
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):
|
|
16832
|
+
* 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
16833
|
* Default value: null
|
|
15287
16834
|
*/
|
|
15288
16835
|
editor?: any;
|
|
@@ -15301,11 +16848,16 @@ export interface GridColumn {
|
|
|
15301
16848
|
* Default value: default
|
|
15302
16849
|
*/
|
|
15303
16850
|
filterMenuMode?: GridColumnFilterMenuMode | string;
|
|
16851
|
+
/**
|
|
16852
|
+
* Sets or gets the column's filter editor. The value is an object with the following possible options: template: string, condition: string, onInit: any - callback function for init purposes, min: number, max: number, minLength: number, maxLength: number
|
|
16853
|
+
* Default value: null
|
|
16854
|
+
*/
|
|
16855
|
+
filterEditor?: any;
|
|
15304
16856
|
/**
|
|
15305
16857
|
* Sets or gets the column's format function.
|
|
15306
16858
|
* Default value: null
|
|
15307
16859
|
*/
|
|
15308
|
-
formatFunction?: any;
|
|
16860
|
+
formatFunction?: {(formatObject: {row?: GridRow, column?: GridColumn, cell?: GridCell, oldValue?: any, value?: any, template?: any}): void};
|
|
15309
16861
|
/**
|
|
15310
16862
|
* 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
16863
|
* Default value: [object Object]
|
|
@@ -15316,6 +16868,16 @@ export interface GridColumn {
|
|
|
15316
16868
|
* Default value: ""
|
|
15317
16869
|
*/
|
|
15318
16870
|
group?: string;
|
|
16871
|
+
/**
|
|
16872
|
+
* 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.
|
|
16873
|
+
* Default value: null
|
|
16874
|
+
*/
|
|
16875
|
+
getCellValue?: any;
|
|
16876
|
+
/**
|
|
16877
|
+
* 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
|
|
16878
|
+
* Default value: null
|
|
16879
|
+
*/
|
|
16880
|
+
getFilterPanel?: any;
|
|
15319
16881
|
/**
|
|
15320
16882
|
* Sets or gets the column's icon. Expects CSS class name.
|
|
15321
16883
|
* Default value: ""
|
|
@@ -15326,11 +16888,21 @@ export interface GridColumn {
|
|
|
15326
16888
|
* Default value: ""
|
|
15327
16889
|
*/
|
|
15328
16890
|
label?: string;
|
|
16891
|
+
/**
|
|
16892
|
+
* Sets or gets the column header's template. The property expects the 'id' of HTMLTemplateElement, HTML string or function which returns html string.
|
|
16893
|
+
* Default value:
|
|
16894
|
+
*/
|
|
16895
|
+
labelTemplate?: string | HTMLTemplateElement | HTMLElement | {(label: string): string};
|
|
15329
16896
|
/**
|
|
15330
16897
|
* Sets or gets the minimum width.
|
|
15331
16898
|
* Default value: 30
|
|
15332
16899
|
*/
|
|
15333
16900
|
minWidth?: number;
|
|
16901
|
+
/**
|
|
16902
|
+
* Sets or gets the column's rowSpan function. Allows you to dynamically span cells.
|
|
16903
|
+
* Default value: null
|
|
16904
|
+
*/
|
|
16905
|
+
rowSpan?: {(cellValue: any, rowIndex: number, data: any): number};
|
|
15334
16906
|
/**
|
|
15335
16907
|
* Sets or gets the sort order of the column. Accepts: 'asc', 'desc' and null.
|
|
15336
16908
|
* Default value: null
|
|
@@ -15341,6 +16913,11 @@ export interface GridColumn {
|
|
|
15341
16913
|
* Default value: null
|
|
15342
16914
|
*/
|
|
15343
16915
|
sortIndex?: number;
|
|
16916
|
+
/**
|
|
16917
|
+
* Sets or gets a custom 'sortComparator' function. It can be used for implementing custom sorting. Ex: sortComparator: (value1, value2) => { if (value1 === value2) return 0; return value1 <value2; }
|
|
16918
|
+
* Default value: null
|
|
16919
|
+
*/
|
|
16920
|
+
sortComparator?: any;
|
|
15344
16921
|
/**
|
|
15345
16922
|
* Sets or gets whether the column's header action drop-down button is displayed. This button opens the column's menu.
|
|
15346
16923
|
* Default value: true
|
|
@@ -15381,6 +16958,11 @@ export interface GridColumn {
|
|
|
15381
16958
|
* Default value:
|
|
15382
16959
|
*/
|
|
15383
16960
|
summary?: string[];
|
|
16961
|
+
/**
|
|
16962
|
+
* Updates the column's filter panel. The function works in combination with getFilterPanel
|
|
16963
|
+
* Default value: null
|
|
16964
|
+
*/
|
|
16965
|
+
updateFilterPanel?: any;
|
|
15384
16966
|
/**
|
|
15385
16967
|
* Sets or gets whether the column is visible. Set the property to 'false' to hide the column.
|
|
15386
16968
|
* Default value: true
|
|
@@ -15388,6 +16970,83 @@ export interface GridColumn {
|
|
|
15388
16970
|
visible?: boolean;
|
|
15389
16971
|
}
|
|
15390
16972
|
|
|
16973
|
+
/**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. */
|
|
16974
|
+
export interface GridContextMenu {
|
|
16975
|
+
/**
|
|
16976
|
+
* 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.
|
|
16977
|
+
* Default value: false
|
|
16978
|
+
*/
|
|
16979
|
+
enabled?: boolean;
|
|
16980
|
+
/**
|
|
16981
|
+
* Sets the data sources to the context menu.
|
|
16982
|
+
* Default value: [object Object]
|
|
16983
|
+
*/
|
|
16984
|
+
dataSource?: GridContextMenuDataSource;
|
|
16985
|
+
/**
|
|
16986
|
+
* Sets the ID or CSS Class of a Smart.Menu component to be used as a context menu for the Grid.
|
|
16987
|
+
* Default value: ""
|
|
16988
|
+
*/
|
|
16989
|
+
selector?: string;
|
|
16990
|
+
/**
|
|
16991
|
+
* Sets the width of the context menu.
|
|
16992
|
+
* Default value: 250
|
|
16993
|
+
*/
|
|
16994
|
+
width?: number;
|
|
16995
|
+
/**
|
|
16996
|
+
* Sets the height of the context menu.
|
|
16997
|
+
* Default value: null
|
|
16998
|
+
*/
|
|
16999
|
+
height?: number | null;
|
|
17000
|
+
}
|
|
17001
|
+
|
|
17002
|
+
/**Sets the data sources to the context menu. */
|
|
17003
|
+
export interface GridContextMenuDataSource {
|
|
17004
|
+
/**
|
|
17005
|
+
* Describes the delete item.
|
|
17006
|
+
* Default value: [object Object]
|
|
17007
|
+
*/
|
|
17008
|
+
contextMenuItemDelete?: GridCommand;
|
|
17009
|
+
/**
|
|
17010
|
+
* Describes the edit item.
|
|
17011
|
+
* Default value: [object Object]
|
|
17012
|
+
*/
|
|
17013
|
+
contextMenuItemEdit?: GridCommand;
|
|
17014
|
+
/**
|
|
17015
|
+
* Describes the custom item.
|
|
17016
|
+
* Default value: [object Object]
|
|
17017
|
+
*/
|
|
17018
|
+
contextMenuItemCustom?: GridCommand;
|
|
17019
|
+
}
|
|
17020
|
+
|
|
17021
|
+
/**Describes the delete item. */
|
|
17022
|
+
export interface GridCommand {
|
|
17023
|
+
/**
|
|
17024
|
+
* Sets the command of the context menu item.
|
|
17025
|
+
* Default value: "contextMenuItemDeleteCommand"
|
|
17026
|
+
*/
|
|
17027
|
+
command?: string;
|
|
17028
|
+
/**
|
|
17029
|
+
* Enables the context menu item.
|
|
17030
|
+
* Default value: true
|
|
17031
|
+
*/
|
|
17032
|
+
enabled?: boolean;
|
|
17033
|
+
/**
|
|
17034
|
+
* Sets the visibility of the context menu item.
|
|
17035
|
+
* Default value: true
|
|
17036
|
+
*/
|
|
17037
|
+
visible?: boolean;
|
|
17038
|
+
/**
|
|
17039
|
+
* Sets the icon of the context menu item.
|
|
17040
|
+
* Default value: "jqx-icon-delete"
|
|
17041
|
+
*/
|
|
17042
|
+
icon?: string;
|
|
17043
|
+
/**
|
|
17044
|
+
* Sets the label of the context menu item.
|
|
17045
|
+
* Default value: ""
|
|
17046
|
+
*/
|
|
17047
|
+
label?: string;
|
|
17048
|
+
}
|
|
17049
|
+
|
|
15391
17050
|
/**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. */
|
|
15392
17051
|
export interface GridColumnMenu {
|
|
15393
17052
|
/**
|
|
@@ -15443,7 +17102,7 @@ export interface GridColumnMenuDataSource {
|
|
|
15443
17102
|
* Describes the settings of the column menu item duplicate.
|
|
15444
17103
|
* Default value: [object Object]
|
|
15445
17104
|
*/
|
|
15446
|
-
|
|
17105
|
+
columnMenuItemClone?: GridCommand;
|
|
15447
17106
|
/**
|
|
15448
17107
|
* Describes the settings of the column menu item insert left.
|
|
15449
17108
|
* Default value: [object Object]
|
|
@@ -15464,6 +17123,11 @@ export interface GridColumnMenuDataSource {
|
|
|
15464
17123
|
* Default value: [object Object]
|
|
15465
17124
|
*/
|
|
15466
17125
|
columnMenuItemSortDesc?: GridCommand;
|
|
17126
|
+
/**
|
|
17127
|
+
* Describes the settings of the column menu item to add sorting.
|
|
17128
|
+
* Default value: [object Object]
|
|
17129
|
+
*/
|
|
17130
|
+
columnMenuItemSort?: GridCommand;
|
|
15467
17131
|
/**
|
|
15468
17132
|
* Describes the settings of the column menu item remove sort.
|
|
15469
17133
|
* Default value: [object Object]
|
|
@@ -15488,46 +17152,17 @@ export interface GridColumnMenuDataSource {
|
|
|
15488
17152
|
* Describes the settings of the column menu item group by.
|
|
15489
17153
|
* Default value: [object Object]
|
|
15490
17154
|
*/
|
|
15491
|
-
columnMenuItemRemoveGroupBy?: GridCommand;
|
|
15492
|
-
/**
|
|
15493
|
-
* Describes the settings of the column menu item hide.
|
|
15494
|
-
* Default value: [object Object]
|
|
15495
|
-
*/
|
|
15496
|
-
columnMenuItemHide?: GridCommand;
|
|
15497
|
-
/**
|
|
15498
|
-
* Describes the settings of the column menu item delete.
|
|
15499
|
-
* Default value: [object Object]
|
|
15500
|
-
*/
|
|
15501
|
-
columnMenuItemDelete?: GridCommand;
|
|
15502
|
-
}
|
|
15503
|
-
|
|
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;
|
|
17155
|
+
columnMenuItemRemoveGroupBy?: GridCommand;
|
|
15521
17156
|
/**
|
|
15522
|
-
*
|
|
15523
|
-
* Default value:
|
|
17157
|
+
* Describes the settings of the column menu item hide.
|
|
17158
|
+
* Default value: [object Object]
|
|
15524
17159
|
*/
|
|
15525
|
-
|
|
17160
|
+
columnMenuItemHide?: GridCommand;
|
|
15526
17161
|
/**
|
|
15527
|
-
*
|
|
15528
|
-
* Default value:
|
|
17162
|
+
* Describes the settings of the column menu item delete.
|
|
17163
|
+
* Default value: [object Object]
|
|
15529
17164
|
*/
|
|
15530
|
-
|
|
17165
|
+
columnMenuItemDelete?: GridCommand;
|
|
15531
17166
|
}
|
|
15532
17167
|
|
|
15533
17168
|
export interface GridColumnGroup {
|
|
@@ -15536,6 +17171,11 @@ export interface GridColumnGroup {
|
|
|
15536
17171
|
* Default value: ""
|
|
15537
17172
|
*/
|
|
15538
17173
|
label?: string;
|
|
17174
|
+
/**
|
|
17175
|
+
* Sets or gets the column header's template. The property expects the 'id' of HTMLTemplateElement, HTML string or function which returns html string.
|
|
17176
|
+
* Default value:
|
|
17177
|
+
*/
|
|
17178
|
+
labelTemplate?: string | HTMLTemplateElement | HTMLElement | {(label: string): string};
|
|
15539
17179
|
/**
|
|
15540
17180
|
* Sets the align.
|
|
15541
17181
|
* Default value: center
|
|
@@ -15617,7 +17257,7 @@ export interface GridCharting {
|
|
|
15617
17257
|
* Sets or gets the chart's container.
|
|
15618
17258
|
* Default value: null
|
|
15619
17259
|
*/
|
|
15620
|
-
appendTo?:
|
|
17260
|
+
appendTo?: string | HTMLElement;
|
|
15621
17261
|
/**
|
|
15622
17262
|
* Sets or gets the charting dialog.
|
|
15623
17263
|
* Default value: [object Object]
|
|
@@ -15805,12 +17445,12 @@ export interface GridDataSourceSettings {
|
|
|
15805
17445
|
*/
|
|
15806
17446
|
mapChar?: string;
|
|
15807
17447
|
/**
|
|
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.
|
|
17448
|
+
* 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
17449
|
* Default value: null
|
|
15810
17450
|
*/
|
|
15811
|
-
virtualDataSource?: any;
|
|
17451
|
+
virtualDataSource?: {(resultCallbackFunction: any, details: DataAdapterVirtualDataSourceDetails): void};
|
|
15812
17452
|
/**
|
|
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
|
|
17453
|
+
* 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
17454
|
* Default value: null
|
|
15815
17455
|
*/
|
|
15816
17456
|
virtualDataSourceOnExpand?: any;
|
|
@@ -16117,6 +17757,11 @@ export interface GridFiltering {
|
|
|
16117
17757
|
* Default value: false
|
|
16118
17758
|
*/
|
|
16119
17759
|
enabled?: boolean;
|
|
17760
|
+
/**
|
|
17761
|
+
* 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'
|
|
17762
|
+
* Default value: "and"
|
|
17763
|
+
*/
|
|
17764
|
+
operator?: string;
|
|
16120
17765
|
/**
|
|
16121
17766
|
* 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', '<= 3 and >= 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','<>', 'NOT_EQUAL', '!=', '<', 'LESS_THAN','>', 'GREATER_THAN', '<=', 'LESS_THAN_OR_EQUAL', '>=', 'GREATER_THAN_OR_EQUAL','starts with', 'STARTS_WITH','ends with', 'ENDS_WITH', '', 'EMPTY', 'CONTAINS','DOES_NOT_CONTAIN', 'NULL','NOT_NULL'
|
|
16122
17767
|
* Default value:
|
|
@@ -16228,6 +17873,11 @@ export interface GridGrouping {
|
|
|
16228
17873
|
* Default value: false
|
|
16229
17874
|
*/
|
|
16230
17875
|
autoExpandAll?: boolean;
|
|
17876
|
+
/**
|
|
17877
|
+
* Automatically expands all groups to a given level.
|
|
17878
|
+
* Default value: 0
|
|
17879
|
+
*/
|
|
17880
|
+
autoExpandToLevel?: number;
|
|
16231
17881
|
/**
|
|
16232
17882
|
* Automatically hides all grouped columns.
|
|
16233
17883
|
* Default value: false
|
|
@@ -16239,20 +17889,20 @@ export interface GridGrouping {
|
|
|
16239
17889
|
*/
|
|
16240
17890
|
expandMode?: GridGroupingExpandMode | string;
|
|
16241
17891
|
/**
|
|
16242
|
-
* Sets
|
|
16243
|
-
* Default value:
|
|
17892
|
+
* Sets or gets the column's format function.
|
|
17893
|
+
* Default value: null
|
|
16244
17894
|
*/
|
|
16245
|
-
|
|
17895
|
+
formatFunction?: {(formatObject: {row?: GridRow, column?: GridColumn, cell?: GridCell, value?: any, template?: any}): void};
|
|
16246
17896
|
/**
|
|
16247
17897
|
* Sets the group row height.
|
|
16248
17898
|
* Default value: 50
|
|
16249
17899
|
*/
|
|
16250
17900
|
groupRowHeight?: string | number;
|
|
16251
17901
|
/**
|
|
16252
|
-
* Sets the
|
|
16253
|
-
* Default value:
|
|
17902
|
+
* Sets or gets the data fields to group by.
|
|
17903
|
+
* Default value: []
|
|
16254
17904
|
*/
|
|
16255
|
-
|
|
17905
|
+
groupBy?: string[];
|
|
16256
17906
|
/**
|
|
16257
17907
|
* Sets the indent of the group.
|
|
16258
17908
|
* Default value: 16
|
|
@@ -16263,6 +17913,21 @@ export interface GridGrouping {
|
|
|
16263
17913
|
* Default value: [object Object]
|
|
16264
17914
|
*/
|
|
16265
17915
|
groupBar?: GridGroupingGroupBar;
|
|
17916
|
+
/**
|
|
17917
|
+
* Expands a group in the first grid render. Example: onGroupDefaultExpanded: (dataItem) =>{ return dataItem.label === 'Peppermint Mocha Twist' }
|
|
17918
|
+
* Default value: null
|
|
17919
|
+
*/
|
|
17920
|
+
onGroupDefaultExpanded?: any;
|
|
17921
|
+
/**
|
|
17922
|
+
* 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.
|
|
17923
|
+
* Default value: advanced
|
|
17924
|
+
*/
|
|
17925
|
+
renderMode?: GridGroupingRenderMode | string;
|
|
17926
|
+
/**
|
|
17927
|
+
* Sets the indent of the group toggle button.
|
|
17928
|
+
* Default value: 16
|
|
17929
|
+
*/
|
|
17930
|
+
toggleButtonIndent?: number;
|
|
16266
17931
|
/**
|
|
16267
17932
|
* Describes the group summary row's settings.
|
|
16268
17933
|
* Default value: [object Object]
|
|
@@ -16303,6 +17968,40 @@ export interface GridGroupingSummaryRow {
|
|
|
16303
17968
|
visible?: boolean;
|
|
16304
17969
|
}
|
|
16305
17970
|
|
|
17971
|
+
/**Sets the grid's image and filter upload settings for the image and attachment columns. */
|
|
17972
|
+
export interface GridUploadSettings {
|
|
17973
|
+
/**
|
|
17974
|
+
* Sets or file/image upload url.
|
|
17975
|
+
* Default value: ""
|
|
17976
|
+
*/
|
|
17977
|
+
url?: string;
|
|
17978
|
+
/**
|
|
17979
|
+
* Sets or file/image remove url.
|
|
17980
|
+
* Default value: ""
|
|
17981
|
+
*/
|
|
17982
|
+
removeUrl?: string;
|
|
17983
|
+
/**
|
|
17984
|
+
* 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[]'];
|
|
17985
|
+
* Default value: "userfile[]"
|
|
17986
|
+
*/
|
|
17987
|
+
name?: string;
|
|
17988
|
+
/**
|
|
17989
|
+
* Additional data to pass to the server. The format should be a JSON string.
|
|
17990
|
+
* Default value: ""
|
|
17991
|
+
*/
|
|
17992
|
+
data?: string;
|
|
17993
|
+
/**
|
|
17994
|
+
* 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.
|
|
17995
|
+
* Default value:
|
|
17996
|
+
*/
|
|
17997
|
+
onUploadCompleted?: any;
|
|
17998
|
+
/**
|
|
17999
|
+
* 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.
|
|
18000
|
+
* Default value:
|
|
18001
|
+
*/
|
|
18002
|
+
onUploadError?: any;
|
|
18003
|
+
}
|
|
18004
|
+
|
|
16306
18005
|
/**Describes the paging settings. */
|
|
16307
18006
|
export interface GridPaging {
|
|
16308
18007
|
/**
|
|
@@ -16320,6 +18019,11 @@ export interface GridPaging {
|
|
|
16320
18019
|
* Default value: 10
|
|
16321
18020
|
*/
|
|
16322
18021
|
pageSize?: number;
|
|
18022
|
+
/**
|
|
18023
|
+
* Sets the number of hierarchical rows per page. For example, displays 2 root groups per page, when grouping is enabled.
|
|
18024
|
+
* Default value: 2
|
|
18025
|
+
*/
|
|
18026
|
+
pageHierarchySize?: number;
|
|
16323
18027
|
/**
|
|
16324
18028
|
* Sets the start page.
|
|
16325
18029
|
* Default value: 0
|
|
@@ -16523,7 +18227,7 @@ export interface GridRowDetail {
|
|
|
16523
18227
|
* Sets the template of the row details.
|
|
16524
18228
|
* Default value:
|
|
16525
18229
|
*/
|
|
16526
|
-
template?:
|
|
18230
|
+
template?: string | HTMLTemplateElement;
|
|
16527
18231
|
/**
|
|
16528
18232
|
* Sets the visibility of the Column which allows you to dynamically expand/collapse the row details.
|
|
16529
18233
|
* Default value: true
|
|
@@ -16559,6 +18263,45 @@ export interface GridSummaryRow {
|
|
|
16559
18263
|
editing?: boolean;
|
|
16560
18264
|
}
|
|
16561
18265
|
|
|
18266
|
+
/**Sets the grid's state settings. */
|
|
18267
|
+
export interface GridStateSettings {
|
|
18268
|
+
/**
|
|
18269
|
+
* Enables or disables auto-save of the Grid's state
|
|
18270
|
+
* Default value: false
|
|
18271
|
+
*/
|
|
18272
|
+
autoSave?: boolean;
|
|
18273
|
+
/**
|
|
18274
|
+
* Enables or disables auto-load of the Grid's state on page reload.
|
|
18275
|
+
* Default value: false
|
|
18276
|
+
*/
|
|
18277
|
+
autoLoad?: boolean;
|
|
18278
|
+
/**
|
|
18279
|
+
* Enables or disables save/load of the grid state.
|
|
18280
|
+
* Default value: true
|
|
18281
|
+
*/
|
|
18282
|
+
enabled?: boolean;
|
|
18283
|
+
/**
|
|
18284
|
+
* Sets or gets the current state.
|
|
18285
|
+
* Default value: ""
|
|
18286
|
+
*/
|
|
18287
|
+
current?: string;
|
|
18288
|
+
/**
|
|
18289
|
+
* 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.
|
|
18290
|
+
* Default value: null
|
|
18291
|
+
*/
|
|
18292
|
+
storage?: any;
|
|
18293
|
+
/**
|
|
18294
|
+
* Function called when the state is changed.
|
|
18295
|
+
* Default value:
|
|
18296
|
+
*/
|
|
18297
|
+
onStateChange?: any;
|
|
18298
|
+
/**
|
|
18299
|
+
* 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.
|
|
18300
|
+
* Default value:
|
|
18301
|
+
*/
|
|
18302
|
+
options?: string[];
|
|
18303
|
+
}
|
|
18304
|
+
|
|
16562
18305
|
/**Describes the settings for the group header. */
|
|
16563
18306
|
export interface GridGroupHeader {
|
|
16564
18307
|
/**
|
|
@@ -16584,12 +18327,12 @@ export interface GridHeader {
|
|
|
16584
18327
|
* Sets a template for the header.
|
|
16585
18328
|
* Default value:
|
|
16586
18329
|
*/
|
|
16587
|
-
template?: string | HTMLTemplateElement;
|
|
18330
|
+
template?: string | HTMLTemplateElement | {(element: HTMLElement): void};
|
|
16588
18331
|
/**
|
|
16589
18332
|
* This callback function can be used for customization of the Header toolbar. The Toolbar HTML Element is passed as an argument.
|
|
16590
18333
|
* Default value: null
|
|
16591
18334
|
*/
|
|
16592
|
-
onInit?:
|
|
18335
|
+
onInit?: {(element: HTMLElement): void};
|
|
16593
18336
|
/**
|
|
16594
18337
|
* 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
18338
|
* Default value: [ "columns", "filter", "group", "sort", "format", "search" ]
|
|
@@ -16608,7 +18351,7 @@ export interface GridFooter {
|
|
|
16608
18351
|
* Sets a template for the footer.
|
|
16609
18352
|
* Default value:
|
|
16610
18353
|
*/
|
|
16611
|
-
template?: string | HTMLTemplateElement;
|
|
18354
|
+
template?: string | HTMLTemplateElement | {(element: HTMLElement): void};
|
|
16612
18355
|
}
|
|
16613
18356
|
|
|
16614
18357
|
export interface GridRow {
|
|
@@ -16986,16 +18729,36 @@ export interface GridSorting {
|
|
|
16986
18729
|
* Default value:
|
|
16987
18730
|
*/
|
|
16988
18731
|
sort?: string[];
|
|
18732
|
+
/**
|
|
18733
|
+
* 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.
|
|
18734
|
+
* Default value: true
|
|
18735
|
+
*/
|
|
18736
|
+
maintainSort?: boolean;
|
|
16989
18737
|
/**
|
|
16990
18738
|
* Sets the count of allowed sorting columns. When the property value is set to 'many', users can sort data by multiple columns.
|
|
16991
18739
|
* Default value: one
|
|
16992
18740
|
*/
|
|
16993
18741
|
mode?: GridSortingMode | string;
|
|
18742
|
+
/**
|
|
18743
|
+
* 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.
|
|
18744
|
+
* Default value: Default
|
|
18745
|
+
*/
|
|
18746
|
+
commandKey?: GridSortingCommandKey | string;
|
|
16994
18747
|
/**
|
|
16995
18748
|
* Enables switching between the three sort states: ascending, descending and not sorted.
|
|
16996
18749
|
* Default value: true
|
|
16997
18750
|
*/
|
|
16998
18751
|
sortToggleThreeStates?: boolean;
|
|
18752
|
+
/**
|
|
18753
|
+
* Enables switching between the sort states on column click. This is the default behavior.
|
|
18754
|
+
* Default value: true
|
|
18755
|
+
*/
|
|
18756
|
+
sortToggleOnClick?: boolean;
|
|
18757
|
+
/**
|
|
18758
|
+
* Enables switching between the sort states on column click and holding down the command key.
|
|
18759
|
+
* Default value: false
|
|
18760
|
+
*/
|
|
18761
|
+
sortToggleOnClickAndCommandKey?: boolean;
|
|
16999
18762
|
}
|
|
17000
18763
|
|
|
17001
18764
|
declare global {
|
|
@@ -17046,8 +18809,8 @@ export declare type GridFilteringFilterRowApplyMode = 'auto' | 'click';
|
|
|
17046
18809
|
export declare type GridFilteringFilterMenuMode = 'default' | 'excel';
|
|
17047
18810
|
/**Sets the group expand mode. */
|
|
17048
18811
|
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';
|
|
18812
|
+
/**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. */
|
|
18813
|
+
export declare type GridGroupingRenderMode = 'basic' | 'compact' | 'advanced' | 'multipleColumns';
|
|
17051
18814
|
/**Sets the ellipsis display mode. */
|
|
17052
18815
|
export declare type GridPagerAutoEllipsis = 'none' | 'before' | 'after' | 'both';
|
|
17053
18816
|
/**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 +18821,8 @@ export declare type GridSelectionAction = 'none' | 'click' | 'doubleClick';
|
|
|
17058
18821
|
export declare type GridSelectionCheckBoxesSelectAllMode = 'none' | 'page' | 'all';
|
|
17059
18822
|
/**Sets the count of allowed sorting columns. When the property value is set to 'many', users can sort data by multiple columns. */
|
|
17060
18823
|
export declare type GridSortingMode = 'one' | 'many';
|
|
18824
|
+
/**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. */
|
|
18825
|
+
export declare type GridSortingCommandKey = 'Default' | 'Alt' | 'Control' | 'Shift';
|
|
17061
18826
|
export interface GroupPanelProperties {
|
|
17062
18827
|
/**
|
|
17063
18828
|
* Sets or gets the animation mode. Animation is disabled when the property is set to 'none'
|
|
@@ -17473,6 +19238,11 @@ export interface KanbanProperties {
|
|
|
17473
19238
|
* Default value: true
|
|
17474
19239
|
*/
|
|
17475
19240
|
allowDrop?: boolean;
|
|
19241
|
+
/**
|
|
19242
|
+
* 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.
|
|
19243
|
+
* Default value: false
|
|
19244
|
+
*/
|
|
19245
|
+
applyColumnColorToTasks?: boolean;
|
|
17476
19246
|
/**
|
|
17477
19247
|
* 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
19248
|
* Default value: true
|
|
@@ -17483,6 +19253,11 @@ export interface KanbanProperties {
|
|
|
17483
19253
|
* Default value: false
|
|
17484
19254
|
*/
|
|
17485
19255
|
autoSaveState?: boolean;
|
|
19256
|
+
/**
|
|
19257
|
+
* Automatically updates the columns height depending on the tasks inside the column. The effect of this property is observed when 'columnColorEntireSurface' is true.
|
|
19258
|
+
* Default value: false
|
|
19259
|
+
*/
|
|
19260
|
+
autoColumnHeight?: boolean;
|
|
17486
19261
|
/**
|
|
17487
19262
|
* Allows collapsing the card content.
|
|
17488
19263
|
* Default value: false
|
|
@@ -17603,6 +19378,31 @@ export interface KanbanProperties {
|
|
|
17603
19378
|
* 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
19379
|
*/
|
|
17605
19380
|
messages?: any;
|
|
19381
|
+
/**
|
|
19382
|
+
* Callback function which can be used for customizing the tasks rendering. The Kanban calls it with 2 arguments - task html element and task data.
|
|
19383
|
+
* Default value: null
|
|
19384
|
+
*/
|
|
19385
|
+
onTaskRender?: any;
|
|
19386
|
+
/**
|
|
19387
|
+
* 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.
|
|
19388
|
+
* Default value: null
|
|
19389
|
+
*/
|
|
19390
|
+
onFilterPrepare?: any;
|
|
19391
|
+
/**
|
|
19392
|
+
* 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.
|
|
19393
|
+
* Default value: null
|
|
19394
|
+
*/
|
|
19395
|
+
onSortPrepare?: any;
|
|
19396
|
+
/**
|
|
19397
|
+
* 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.
|
|
19398
|
+
* Default value: null
|
|
19399
|
+
*/
|
|
19400
|
+
onColumnHeaderRender?: any;
|
|
19401
|
+
/**
|
|
19402
|
+
* 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.
|
|
19403
|
+
* Default value: null
|
|
19404
|
+
*/
|
|
19405
|
+
onColumnFooterRender?: any;
|
|
17606
19406
|
/**
|
|
17607
19407
|
* Determines selection mode.
|
|
17608
19408
|
* Default value: zeroOrOne
|
|
@@ -17623,6 +19423,11 @@ export interface KanbanProperties {
|
|
|
17623
19423
|
* Default value: false
|
|
17624
19424
|
*/
|
|
17625
19425
|
rightToLeft?: boolean;
|
|
19426
|
+
/**
|
|
19427
|
+
* 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.
|
|
19428
|
+
* Default value: false
|
|
19429
|
+
*/
|
|
19430
|
+
readonly?: boolean;
|
|
17626
19431
|
/**
|
|
17627
19432
|
* Describes the swimlanes in the kanban board. Sub-columns are not applicable when swimlanes are present.
|
|
17628
19433
|
* Default value:
|
|
@@ -17648,6 +19453,11 @@ export interface KanbanProperties {
|
|
|
17648
19453
|
* Default value: false
|
|
17649
19454
|
*/
|
|
17650
19455
|
taskActions?: boolean;
|
|
19456
|
+
/**
|
|
19457
|
+
* 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'); }}
|
|
19458
|
+
* Default value: null
|
|
19459
|
+
*/
|
|
19460
|
+
taskActionsRendered?: any;
|
|
17651
19461
|
/**
|
|
17652
19462
|
* Toggles the visibility of the task comments icon.
|
|
17653
19463
|
* Default value: false
|
|
@@ -17907,7 +19717,14 @@ export interface Kanban extends BaseElement, KanbanProperties {
|
|
|
17907
19717
|
* @param event. The custom event. */
|
|
17908
19718
|
onSort?: ((this: any, ev: Event) => any) | ((this: any, ev: CustomEvent<any>) => any) | null;
|
|
17909
19719
|
/**
|
|
17910
|
-
* This event is triggered
|
|
19720
|
+
* 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';}
|
|
19721
|
+
* @param event. The custom event. Custom data event was created with: ev.detail(value, id)
|
|
19722
|
+
* value - The task data that is added to the Kanban.
|
|
19723
|
+
* id - The task data id.
|
|
19724
|
+
*/
|
|
19725
|
+
onTaskBeforeAdd?: ((this: any, ev: Event) => any) | ((this: any, ev: CustomEvent<any>) => any) | null;
|
|
19726
|
+
/**
|
|
19727
|
+
* 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
19728
|
* @param event. The custom event. Custom data event was created with: ev.detail(value, id)
|
|
17912
19729
|
* value - The task data that is added to the Kanban.
|
|
17913
19730
|
* id - The task data id.
|
|
@@ -17943,15 +19760,15 @@ export interface Kanban extends BaseElement, KanbanProperties {
|
|
|
17943
19760
|
*/
|
|
17944
19761
|
onTaskDoubleClick?: ((this: any, ev: Event) => any) | ((this: any, ev: CustomEvent<any>) => any) | null;
|
|
17945
19762
|
/**
|
|
17946
|
-
* Adds filtering
|
|
17947
|
-
* @param {
|
|
17948
|
-
* @param {string} operator?. Logical operator between the filters of different fields
|
|
19763
|
+
* Adds filtering. Example: const filterGroup = new Smart.FilterGroup(); const filterObject = filterGroup.createFilter('string', 'Italy', 'contains'); filterGroup.addFilter('and', filterObject); kanban.addFilter([['Country', filterGroup]]);
|
|
19764
|
+
* @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','<>', 'NOT_EQUAL', '!=', '<', 'LESS_THAN','>', 'GREATER_THAN', '<=', 'LESS_THAN_OR_EQUAL', '>=', 'GREATER_THAN_OR_EQUAL','starts with', 'STARTS_WITH','ends with', 'ENDS_WITH', '', 'EMPTY', 'CONTAINS','DOES_NOT_CONTAIN', 'NULL','NOT_NULL'
|
|
19765
|
+
* @param {string} operator?. Logical operator between the filters of different fields. Possible values are: 'and', 'or'.
|
|
17949
19766
|
*/
|
|
17950
|
-
addFilter(filters:
|
|
19767
|
+
addFilter(filters: any, operator?: string): void;
|
|
17951
19768
|
/**
|
|
17952
|
-
* Adds sorting
|
|
19769
|
+
* Adds sorting. Example: kanban.addSort(['Country'], 'ascending');
|
|
17953
19770
|
* @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
|
|
19771
|
+
* @param {[] | string} orderBy. The sort direction(s) to sort the data field(s) by. Possible values are: 'ascending' and 'descending'.
|
|
17955
19772
|
*/
|
|
17956
19773
|
addSort(dataFields: [] | string, orderBy: [] | string): void;
|
|
17957
19774
|
/**
|
|
@@ -18042,10 +19859,10 @@ export interface Kanban extends BaseElement, KanbanProperties {
|
|
|
18042
19859
|
*/
|
|
18043
19860
|
getSelectedTasks(id: number): any;
|
|
18044
19861
|
/**
|
|
18045
|
-
* Gets the Kanban's state.
|
|
18046
|
-
* @returns
|
|
19862
|
+
* Gets the Kanban's state. Returns an object with the following type: { collapsed: {}, dataSource: [], filtering: { filters: [], operator: string }, selection: { selected: [], selectionStart?: number | string, selectionInColumn: string, swimlane: string }, sorting: { dataFields: [], dataTypes: [], orderBy: [] }, tabs: [], visibility: { taskActions: boolean, taskComments: boolean, taskDue: boolean, taskPriority: boolean, taskProgress: boolean, taskTags: boolean, taskUserIcon: boolean } }
|
|
19863
|
+
* @returns {any}
|
|
18047
19864
|
*/
|
|
18048
|
-
getState():
|
|
19865
|
+
getState(): any;
|
|
18049
19866
|
/**
|
|
18050
19867
|
* Loads the Kanban's state.
|
|
18051
19868
|
* @param state?. An object returned by one of the methods getState or saveState. If not passed, gets saved state from the browser's localStorage.
|
|
@@ -18224,21 +20041,6 @@ export interface KanbanDataSource {
|
|
|
18224
20041
|
* Default value: null
|
|
18225
20042
|
*/
|
|
18226
20043
|
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
20044
|
/**
|
|
18243
20045
|
* The task's priority.
|
|
18244
20046
|
* Default value: "normal"
|
|
@@ -21642,12 +23444,14 @@ export interface NumberInput extends BaseElement, NumberInputProperties {
|
|
|
21642
23444
|
* Returns the value in the desired format.
|
|
21643
23445
|
* @param {string | number} value. The value to be formatted by the method.
|
|
21644
23446
|
* @param {any} format?. The object that contains the formatting properties. The argument should contain Intl.NumberFormat valid properties. For example, { style: 'currency', currency: 'EUR' }
|
|
23447
|
+
* @returns {string}
|
|
21645
23448
|
*/
|
|
21646
|
-
getFormattedValue(value: string | number, format?: any):
|
|
23449
|
+
getFormattedValue(value: string | number, format?: any): string;
|
|
21647
23450
|
/**
|
|
21648
23451
|
* Returns the number of the input.
|
|
23452
|
+
* @returns {number}
|
|
21649
23453
|
*/
|
|
21650
|
-
getValue():
|
|
23454
|
+
getValue(): number;
|
|
21651
23455
|
/**
|
|
21652
23456
|
* Selects the text inside the input or if it is <b>readonly</b> then the element is focused.
|
|
21653
23457
|
*/
|
|
@@ -23006,6 +24810,21 @@ export interface PivotTableProperties {
|
|
|
23006
24810
|
* Default value: null
|
|
23007
24811
|
*/
|
|
23008
24812
|
onInit?: { (): void };
|
|
24813
|
+
/**
|
|
24814
|
+
* Sets or gets the page size (when paging is enabled).
|
|
24815
|
+
* Default value: 10
|
|
24816
|
+
*/
|
|
24817
|
+
pageSize?: PivotTablePageSize | string;
|
|
24818
|
+
/**
|
|
24819
|
+
* Sets or gets the current (zero-based) page index (when paging is enabled).
|
|
24820
|
+
* Default value: 0
|
|
24821
|
+
*/
|
|
24822
|
+
pageIndex?: number;
|
|
24823
|
+
/**
|
|
24824
|
+
* Sets or gets whether paging is enabled.
|
|
24825
|
+
* Default value: false
|
|
24826
|
+
*/
|
|
24827
|
+
paging?: boolean;
|
|
23009
24828
|
/**
|
|
23010
24829
|
* Sets or gets the value indicating whether the element is aligned to support locales using right-to-left fonts.
|
|
23011
24830
|
* Default value: false
|
|
@@ -23350,6 +25169,8 @@ export declare type PivotTableDesignerPosition = 'near' | 'far';
|
|
|
23350
25169
|
export declare type PivotTableDrillDownDataExport = null | 'xlsx' | 'pdf' | 'html' | 'json' | 'csv' | 'tsv' | 'xml';
|
|
23351
25170
|
/**Sets or gets the way row nesting (based on rowGroup columns) is displayed. */
|
|
23352
25171
|
export declare type PivotTableGroupLayout = 'classic' | 'default';
|
|
25172
|
+
/**Sets or gets the page size (when paging is enabled). */
|
|
25173
|
+
export declare type PivotTablePageSize = '10' | '25' | '50';
|
|
23353
25174
|
/**Sets or gets the position of row total columns (shown when rowTotals is enabled). */
|
|
23354
25175
|
export declare type PivotTableRowTotalsPosition = 'near' | 'far';
|
|
23355
25176
|
/**Sets or gets the selection mode. Only applicable when selection is enabled. */
|
|
@@ -23589,6 +25410,11 @@ export interface QRcodeProperties {
|
|
|
23589
25410
|
* Default value: "H"
|
|
23590
25411
|
*/
|
|
23591
25412
|
errorLevel?: string;
|
|
25413
|
+
/**
|
|
25414
|
+
* Sets color to the transparent parts of the embedded image. Background remains transparent if set to empty string.
|
|
25415
|
+
* Default value: ""
|
|
25416
|
+
*/
|
|
25417
|
+
imageBackgroundColor?: string;
|
|
23592
25418
|
/**
|
|
23593
25419
|
* Sets the height of the embedded image.
|
|
23594
25420
|
* Default value: 15
|
|
@@ -23649,6 +25475,16 @@ export interface QRcodeProperties {
|
|
|
23649
25475
|
* Default value: ""
|
|
23650
25476
|
*/
|
|
23651
25477
|
value?: string;
|
|
25478
|
+
/**
|
|
25479
|
+
* Sets or gets the width of the QR Code. If the width is set to 0, the width of the QR Code is calculated automatically.
|
|
25480
|
+
* Default value: 0
|
|
25481
|
+
*/
|
|
25482
|
+
width?: number;
|
|
25483
|
+
/**
|
|
25484
|
+
* Sets or gets the height of the QR Code. If the height is set to 0, the height of the QR Code is calculated automatically.
|
|
25485
|
+
* Default value: 0
|
|
25486
|
+
*/
|
|
25487
|
+
height?: number;
|
|
23652
25488
|
}
|
|
23653
25489
|
/**
|
|
23654
25490
|
QR Codes encode text values in a two-dimensional pattern.
|
|
@@ -23721,6 +25557,11 @@ export interface QueryBuilderProperties {
|
|
|
23721
25557
|
* Default value: change
|
|
23722
25558
|
*/
|
|
23723
25559
|
applyMode?: QueryBuilderApplyMode | string;
|
|
25560
|
+
/**
|
|
25561
|
+
* When 'applyMode' is set to 'immediately', the default value is applied to the editor's value and the QueryBuilder's value is updated automatically.
|
|
25562
|
+
* Default value: false
|
|
25563
|
+
*/
|
|
25564
|
+
autoApplyValue?: boolean;
|
|
23724
25565
|
/**
|
|
23725
25566
|
* 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
25567
|
* Default value: false
|
|
@@ -23940,6 +25781,13 @@ export interface QueryBuilder extends BaseElement, QueryBuilderProperties {
|
|
|
23940
25781
|
* value - The value of the selected property.
|
|
23941
25782
|
*/
|
|
23942
25783
|
onPropertySelected?: ((this: any, ev: Event) => any) | ((this: any, ev: CustomEvent<any>) => any) | null;
|
|
25784
|
+
/**
|
|
25785
|
+
* This event is triggered when the component validates the input values. This happens when you input a new value and focus another component.
|
|
25786
|
+
* @param event. The custom event. Custom data event was created with: ev.detail(oldValue, newValue)
|
|
25787
|
+
* oldValue - Old validation status.
|
|
25788
|
+
* newValue - New validation status.
|
|
25789
|
+
*/
|
|
25790
|
+
onValidationChange?: ((this: any, ev: Event) => any) | ((this: any, ev: CustomEvent<any>) => any) | null;
|
|
23943
25791
|
/**
|
|
23944
25792
|
* Converts the current value of the element to DynamicLINQ expression.
|
|
23945
25793
|
* @returns {string}
|
|
@@ -24395,11 +26243,26 @@ export interface SchedulerProperties {
|
|
|
24395
26243
|
* Default value: 30
|
|
24396
26244
|
*/
|
|
24397
26245
|
autoScrollStep?: number;
|
|
26246
|
+
/**
|
|
26247
|
+
* Determines whether the all day cells in Day and Week views automatically change their height depending on the events count in these cells.
|
|
26248
|
+
* Default value: false
|
|
26249
|
+
*/
|
|
26250
|
+
autoHeightAllDayCells?: boolean;
|
|
26251
|
+
/**
|
|
26252
|
+
* 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' }].
|
|
26253
|
+
* Default value:
|
|
26254
|
+
*/
|
|
26255
|
+
available?: any;
|
|
24398
26256
|
/**
|
|
24399
26257
|
* Determines the color scheme for the event background selector in the event window editor.
|
|
24400
26258
|
* Default value: #D50000,#E67C73,#F4511E,#F6BF26,#33B679,#0B8043,#039BE5,#3F51B5,#7986CB,#8E24AA,#616161,
|
|
24401
26259
|
*/
|
|
24402
26260
|
colorScheme?: string[];
|
|
26261
|
+
/**
|
|
26262
|
+
* Determines the current time of the Scheduler to use for the current time indicator functionality. By default the current time is Today.
|
|
26263
|
+
* Default value: new Date()
|
|
26264
|
+
*/
|
|
26265
|
+
currentTime?: string | Date;
|
|
24403
26266
|
/**
|
|
24404
26267
|
* Enables/Disables the current time indicator. Current time indicator shows the current time in the appropriate view cells.
|
|
24405
26268
|
* Default value: false
|
|
@@ -24660,6 +26523,16 @@ export interface SchedulerProperties {
|
|
|
24660
26523
|
* Default value: near
|
|
24661
26524
|
*/
|
|
24662
26525
|
legendPosition?: SchedulerLegendPosition | string;
|
|
26526
|
+
/**
|
|
26527
|
+
* Determines the layout of the legend items.
|
|
26528
|
+
* Default value: auto
|
|
26529
|
+
*/
|
|
26530
|
+
legendLayout?: SchedulerLegendLayout | string;
|
|
26531
|
+
/**
|
|
26532
|
+
* Determines the number of items when the legend switches automatically from horizontal list to menu.
|
|
26533
|
+
* Default value: 10
|
|
26534
|
+
*/
|
|
26535
|
+
legendLayoutMenuBreakpoint?: number;
|
|
24663
26536
|
/**
|
|
24664
26537
|
* 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
26538
|
* Default value: 50
|
|
@@ -24745,6 +26618,11 @@ export interface SchedulerProperties {
|
|
|
24745
26618
|
* Default value:
|
|
24746
26619
|
*/
|
|
24747
26620
|
restrictedHours?: any;
|
|
26621
|
+
/**
|
|
26622
|
+
* 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(2023, 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.
|
|
26623
|
+
* Default value:
|
|
26624
|
+
*/
|
|
26625
|
+
restricted?: any;
|
|
24748
26626
|
/**
|
|
24749
26627
|
* Sets or gets the value indicating whether the element is aligned to support locales using right-to-left fonts.
|
|
24750
26628
|
* Default value: false
|
|
@@ -24817,7 +26695,7 @@ export interface SchedulerProperties {
|
|
|
24817
26695
|
timeRulerTicks?: boolean;
|
|
24818
26696
|
/**
|
|
24819
26697
|
* Determines the timeZone for the element. By default if the local time zone is used if the property is not set.
|
|
24820
|
-
* Default value:
|
|
26698
|
+
* Default value: Local
|
|
24821
26699
|
*/
|
|
24822
26700
|
timeZone?: SchedulerTimeZone | string;
|
|
24823
26701
|
/**
|
|
@@ -24860,6 +26738,11 @@ export interface SchedulerProperties {
|
|
|
24860
26738
|
* Default value: menu
|
|
24861
26739
|
*/
|
|
24862
26740
|
viewSelectorType?: SchedulerViewSelectorType | string;
|
|
26741
|
+
/**
|
|
26742
|
+
* 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'.
|
|
26743
|
+
* Default value: firstDayOfWeek
|
|
26744
|
+
*/
|
|
26745
|
+
viewStartDay?: SchedulerViewStartDay | string;
|
|
24863
26746
|
/**
|
|
24864
26747
|
* Determines the format of the week days inside the element.
|
|
24865
26748
|
* Default value: short
|
|
@@ -25167,6 +27050,16 @@ export interface Scheduler extends BaseElement, SchedulerProperties {
|
|
|
25167
27050
|
* @param {any} eventObj. An object describing a Scheduler event that is not already present in the element.
|
|
25168
27051
|
*/
|
|
25169
27052
|
addEvent(eventObj: any): void;
|
|
27053
|
+
/**
|
|
27054
|
+
* Adds a new view. Example: scheduler.addView('week', 'My View', 'myView', false, false, 10); scheduler.setView('myView');
|
|
27055
|
+
* @param {string} type. The view type.
|
|
27056
|
+
* @param {string} label. The view's label displayed in the header.
|
|
27057
|
+
* @param {string} value. The view's value used to identify the view.
|
|
27058
|
+
* @param {boolean} hideWeekend. Determines whether to hide the weekend.
|
|
27059
|
+
* @param {boolean} hideNonworkingWeekdays. Determines whether to hide the non working days.
|
|
27060
|
+
* @param {number} additionalDays. Determines whether to add additional days to the view.
|
|
27061
|
+
*/
|
|
27062
|
+
addView(type: string, label: string, value: string, hideWeekend: boolean, hideNonworkingWeekdays: boolean, additionalDays: number): void;
|
|
25170
27063
|
/**
|
|
25171
27064
|
* Starts an update operation. This is appropriate when calling multiple methods or set multiple properties at once.
|
|
25172
27065
|
*/
|
|
@@ -25184,6 +27077,11 @@ export interface Scheduler extends BaseElement, SchedulerProperties {
|
|
|
25184
27077
|
* Ends the update operation. This method will resume the rendering and will refresh the element.
|
|
25185
27078
|
*/
|
|
25186
27079
|
endUpdate(): void;
|
|
27080
|
+
/**
|
|
27081
|
+
* Returns an array of the start and end view dates.
|
|
27082
|
+
* @returns {Date[]}
|
|
27083
|
+
*/
|
|
27084
|
+
getViewDates(): Date[];
|
|
25187
27085
|
/**
|
|
25188
27086
|
* Refereshes the Scheduler by recalculating the Scrollbars.
|
|
25189
27087
|
* @param {boolean} fullRefresh?. If set the Scheduler will be re-rendered completely.
|
|
@@ -25238,6 +27136,11 @@ export interface Scheduler extends BaseElement, SchedulerProperties {
|
|
|
25238
27136
|
* @param {any[]} state?. An Array containing a valid structure of Scheduler events.
|
|
25239
27137
|
*/
|
|
25240
27138
|
saveState(state?: any[]): void;
|
|
27139
|
+
/**
|
|
27140
|
+
* Sets the Scheduler's view. Example: scheduler.addView('week', 'My View', 'myView', false, false, 10); scheduler.setView('myView');
|
|
27141
|
+
* @param {string} view?. The view's value. For example: 'day'.
|
|
27142
|
+
*/
|
|
27143
|
+
setView(view?: string): void;
|
|
25241
27144
|
/**
|
|
25242
27145
|
* Checks whether the Scheduler contains the event.
|
|
25243
27146
|
* @param {any} eventObj. A Scheduler event object.
|
|
@@ -25657,6 +27560,8 @@ export declare type SchedulerHeaderViewPosition = 'far' | 'near';
|
|
|
25657
27560
|
export declare type SchedulerLegendLocation = 'footer' | 'header';
|
|
25658
27561
|
/**Determines the position of the legend. By default it's positioned to the near side but setting it to 'far' will change that. */
|
|
25659
27562
|
export declare type SchedulerLegendPosition = 'near' | 'far';
|
|
27563
|
+
/**Determines the layout of the legend items. */
|
|
27564
|
+
export declare type SchedulerLegendLayout = null | 'auto' | 'menu';
|
|
25660
27565
|
/**Determines the minute formatting inside the Scheduler. */
|
|
25661
27566
|
export declare type MinuteFormat = '2-digit' | 'numeric';
|
|
25662
27567
|
/**Determines the visibility of the resize handles. */
|
|
@@ -25673,17 +27578,12 @@ export declare type SchedulerTimelineDayScale = 'hour' | 'halfHour' | 'quarterHo
|
|
|
25673
27578
|
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
27579
|
/**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
27580
|
export declare type SchedulerViewType = 'day' | 'week' | 'month' | 'agenda' | 'timelineDay' | 'timelineWeek' | 'timelineMonth';
|
|
25676
|
-
|
|
25677
|
-
|
|
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';
|
|
27581
|
+
|
|
27582
|
+
export declare type SchedulerViews = SchedulerViewType[] | object[] | string[];
|
|
25685
27583
|
/**Determines type of the view selector located in the header of the element. */
|
|
25686
27584
|
export declare type SchedulerViewSelectorType = 'auto' | 'tabs' | 'menu';
|
|
27585
|
+
/**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'. */
|
|
27586
|
+
export declare type SchedulerViewStartDay = 'firstDayOfWeek' | 'dateCurrent';
|
|
25687
27587
|
/**Determines the format of the week days inside the element. */
|
|
25688
27588
|
export declare type WeekDayFormat = 'short' | 'long' | 'narrow';
|
|
25689
27589
|
export interface ScrollBarProperties {
|
|
@@ -27288,6 +29188,16 @@ export interface TableProperties {
|
|
|
27288
29188
|
* Default value: null
|
|
27289
29189
|
*/
|
|
27290
29190
|
onInit?: { (): void };
|
|
29191
|
+
/**
|
|
29192
|
+
* A callback function executed after the Table is being initialized.
|
|
29193
|
+
* Default value: null
|
|
29194
|
+
*/
|
|
29195
|
+
onLoad?: { (): void };
|
|
29196
|
+
/**
|
|
29197
|
+
* A callback function executed when the Table's update is finished in the endUpdate method.
|
|
29198
|
+
* Default value: null
|
|
29199
|
+
*/
|
|
29200
|
+
onUpdateComplete?: { (): void };
|
|
27291
29201
|
/**
|
|
27292
29202
|
* Sets or gets the page size (when paging is enabled).
|
|
27293
29203
|
* Default value: 10
|
|
@@ -27499,7 +29409,7 @@ export interface Table extends BaseElement, TableProperties {
|
|
|
27499
29409
|
/**
|
|
27500
29410
|
* Adds a filter to a specific column.
|
|
27501
29411
|
* @param {string} dataField. The column's data field.
|
|
27502
|
-
* @param {any} filter. FilterGroup object.
|
|
29412
|
+
* @param {any} filter. FilterGroup object or a Filter expression. Filter expression like: 'startsWith B'. Example 2: ['contains Andrew or contains Nancy'], Example 3: ['quantity', '<= 3 and >= 8']. Filter conditions which you can use in the expressions: '=', 'EQUAL','<>', 'NOT_EQUAL', '!=', '<', 'LESS_THAN','>', 'GREATER_THAN', '<=', 'LESS_THAN_OR_EQUAL', '>=', 'GREATER_THAN_OR_EQUAL','starts with', 'STARTS_WITH','ends with', 'ENDS_WITH', '', 'EMPTY', 'CONTAINS','DOES_NOT_CONTAIN', 'NULL','NOT_NULL'
|
|
27503
29413
|
*/
|
|
27504
29414
|
addFilter(dataField: string, filter: any): void;
|
|
27505
29415
|
/**
|
|
@@ -27668,6 +29578,10 @@ export interface Table extends BaseElement, TableProperties {
|
|
|
27668
29578
|
* @param {string | number} row. The id of the cell's row.
|
|
27669
29579
|
*/
|
|
27670
29580
|
removeRow(row: string | number): void;
|
|
29581
|
+
/**
|
|
29582
|
+
* Resets the Table's state. Information about columns, expanded rows, selected rows, applied fitering, grouping, and sorted columns is cleared, based on the value of the <strong>stateSettings</strong> property.
|
|
29583
|
+
*/
|
|
29584
|
+
resetState(): void;
|
|
27671
29585
|
/**
|
|
27672
29586
|
* Saves the Table's state. Information about columns, expanded rows, selected rows, applied fitering, grouping, and sorted columns is saved, based on the value of the <strong>stateSettings</strong> property.
|
|
27673
29587
|
* @returns {any}
|
|
@@ -28697,6 +30611,11 @@ export interface TextAreaProperties {
|
|
|
28697
30611
|
* Default value: false
|
|
28698
30612
|
*/
|
|
28699
30613
|
readonly?: boolean;
|
|
30614
|
+
/**
|
|
30615
|
+
* Determines whether ot not the user can resize the Textarea.
|
|
30616
|
+
* Default value: none
|
|
30617
|
+
*/
|
|
30618
|
+
resize?: TextAreaResize | string;
|
|
28700
30619
|
/**
|
|
28701
30620
|
* Sets or gets the value indicating whether the element is aligned to support locales using right-to-left fonts.
|
|
28702
30621
|
* Default value: false
|
|
@@ -28727,6 +30646,11 @@ export interface TextAreaProperties {
|
|
|
28727
30646
|
* Default value: false
|
|
28728
30647
|
*/
|
|
28729
30648
|
unfocusable?: boolean;
|
|
30649
|
+
/**
|
|
30650
|
+
* Sets the TextArea users. Expects an array of objects. Each object should have an id and name properties. When you press the 'at' key, you can enter an user from a dropdown.
|
|
30651
|
+
* Default value: []
|
|
30652
|
+
*/
|
|
30653
|
+
users?: any[];
|
|
28730
30654
|
/**
|
|
28731
30655
|
* Sets or gets the value of the element.
|
|
28732
30656
|
* Default value: ""
|
|
@@ -28764,6 +30688,11 @@ export interface TextArea extends BaseElement, TextAreaProperties {
|
|
|
28764
30688
|
* Ensures that the active ( selected ) item is always visible.
|
|
28765
30689
|
*/
|
|
28766
30690
|
ensureVisible(): void;
|
|
30691
|
+
/**
|
|
30692
|
+
* Returns an array of users mentioned in the Textarea's value.
|
|
30693
|
+
* @returns {any[]}
|
|
30694
|
+
*/
|
|
30695
|
+
getMentions(): any[];
|
|
28767
30696
|
/**
|
|
28768
30697
|
* Opens the drop down.
|
|
28769
30698
|
*/
|
|
@@ -28786,6 +30715,8 @@ declare global {
|
|
|
28786
30715
|
|
|
28787
30716
|
/**Determines the auto complete query mode. This property also determines the matching algorithm for the autocomplete operation. */
|
|
28788
30717
|
export declare type TextAreaQueryMode = 'contains' | 'containsIgnoreCase' | 'doesNotContain' | 'doesNotContainIgnoreCase' | 'equals' | 'equalsIgnoreCase' | 'startsWith' | 'startsWithIgnoreCase' | 'endsWith' | 'endsWithIgnoreCase';
|
|
30718
|
+
/**Determines whether ot not the user can resize the Textarea. */
|
|
30719
|
+
export declare type TextAreaResize = 'none' | 'horizontal' | 'vertical' | 'both';
|
|
28789
30720
|
export interface TextBoxProperties {
|
|
28790
30721
|
/**
|
|
28791
30722
|
* Sets or gets the animation mode. Animation is disabled when the property is set to 'none'
|
|
@@ -29973,6 +31904,11 @@ export interface TreeProperties {
|
|
|
29973
31904
|
* Default value: false
|
|
29974
31905
|
*/
|
|
29975
31906
|
filterable?: boolean;
|
|
31907
|
+
/**
|
|
31908
|
+
* Applies a filter only after the 'Enter' key is pressed.
|
|
31909
|
+
* Default value: false
|
|
31910
|
+
*/
|
|
31911
|
+
filterOnEnter?: boolean;
|
|
29976
31912
|
/**
|
|
29977
31913
|
* Sets custom text for placeholder in the filter input.
|
|
29978
31914
|
* Default value: ""
|