@mindfusion/dataviews 2.2.0 → 2.2.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.
@@ -0,0 +1,2899 @@
1
+ /// <reference types="../../@mindfusion/common-ui" />
2
+ /// <reference types="../../@mindfusion/controls" />
3
+ /// <reference types="../../@mindfusion/common" />
4
+ declare module "DataViews/jsdv/src/DataType" {
5
+ export default DataType;
6
+ /**
7
+ * @namespace MindFusion.DataViews
8
+ */
9
+ /**
10
+ * Copyright (c) 2022-2025, MindFusion LLC - Bulgaria.
11
+ *
12
+ * This source code is provided to you as part of the MindFusion software components
13
+ * package you have purchased. You may use the source code to trace and/or fix
14
+ * problems or customize the library as needed for your application. To get permission
15
+ * to use the source code in any other way, please contact us at support@mindfusion.dev.
16
+ */
17
+ /**
18
+ * @class A base class for data types.
19
+ */
20
+ class DataType {
21
+ /**
22
+ * Return the sort order of specified values.
23
+ * @param {Object} value1 The first value to compare.
24
+ * @param {Object} value2 The second value to compare.
25
+ * @returns {Number} A negative number if value1 < value2, 0 if values are equal,
26
+ * or a positive number if value1 > value2.
27
+ */
28
+ static sortFunction(value1: any, value2: any): number;
29
+ /**
30
+ * Creates an editor for specified value.
31
+ * @param {DOMElement} element The parent DOM element where editor should be added.
32
+ * @param {String} displayValue The label to display for value.
33
+ * @param {Object} value The value to edit.
34
+ * @param {Object} view The parent control.
35
+ * @returns {DOMElement} The DOM element used to edit the value.
36
+ */
37
+ static createEditor(element: any, displayValue: string, value: any, view: any): any;
38
+ /**
39
+ * Parses value from specified string.
40
+ * @param {String} text Textual representation of the value.
41
+ * @returns {Object} The parsed value.
42
+ */
43
+ static parse(text: string): any;
44
+ /**
45
+ * Determines if values are equal.
46
+ * @param {Object} value1 The first value to compare.
47
+ * @param {Object} value2 The second value to compare.
48
+ * @returns {Boolean} true if values are equal, or false otherwise.
49
+ */
50
+ static equals(value1: any, value2: any): boolean;
51
+ }
52
+ }
53
+ declare module "DataViews/jsdv/src/Enum" {
54
+ /**
55
+ * Specifies a row action.
56
+ */
57
+ export type RowAction = number;
58
+ export namespace RowAction {
59
+ const Select: number;
60
+ const Create: number;
61
+ const Update: number;
62
+ const Delete: number;
63
+ const Command: number;
64
+ const Render: number;
65
+ const Load: number;
66
+ const Expand: number;
67
+ const Collapse: number;
68
+ }
69
+ }
70
+ declare module "DataViews/jsdv/src/StringType" {
71
+ /**
72
+ * @class Provides functionality for grid columns that display string data.
73
+ * @augments DataType
74
+ */
75
+ export class StringType extends DataType {
76
+ static sortFunction(value1: any, value2: any): any;
77
+ static createEditor(element: any, displayValue: any, value: any, view: any): HTMLInputElement;
78
+ static updateValueFromInput(newValue: any, element: any, view: any, row: any, column: any): void;
79
+ static updateCell(view: any, element: any, r: any, c: any, displayValue: any): void;
80
+ static parse(text: any): any;
81
+ static format(value: any, meta: any): any;
82
+ static equals(value1: any, value2: any): boolean;
83
+ static get textAlign(): string;
84
+ }
85
+ import DataType from "DataViews/jsdv/src/DataType";
86
+ }
87
+ declare module "DataViews/jsdv/src/DateType" {
88
+ /**
89
+ * @class Provides functionality for grid columns that display dates.
90
+ * @augments DataType
91
+ */
92
+ export class DateType extends DataType {
93
+ static sortFunction(value1: any, value2: any): number;
94
+ static get customEditor(): DateTimePicker;
95
+ static createEditor(element: any, displayValue: any, value: any, view: any): HTMLInputElement | DateTimePicker;
96
+ static createDefaultEditor(element: any, displayValue: any, value: any, view: any): HTMLInputElement;
97
+ static createCustomEditor(editor: any, options: any, element: any, displayValue: any, value: any, view: any): void;
98
+ static parse(text: any): number;
99
+ static format(value: any, meta: any): any;
100
+ static equals(value1: any, value2: any): boolean;
101
+ }
102
+ import DataType from "DataViews/jsdv/src/DataType";
103
+ import { DateTimePicker } from "@mindfusion/common-ui";
104
+ }
105
+ declare module "DataViews/jsdv/src/DateTimeType" {
106
+ /**
107
+ * @class Provides functionality for grid columns that display date-time values.
108
+ * @augments DataType
109
+ */
110
+ export class DateTimeType {
111
+ static get customEditor(): DateTimePicker;
112
+ static createEditor(element: any, displayValue: any, value: any, view: any): HTMLInputElement | DateTimePicker;
113
+ static createDefaultEditor(element: any, displayValue: any, value: any, view: any): HTMLInputElement;
114
+ static format(value: any, meta: any): any;
115
+ }
116
+ import { DateTimePicker } from "@mindfusion/common-ui";
117
+ }
118
+ declare module "DataViews/jsdv/src/BooleanType" {
119
+ /**
120
+ * @class Provides functionality for grid columns that display boolean data.
121
+ * @augments StringType
122
+ */
123
+ export class BooleanType extends StringType {
124
+ static sortFunction(value1: any, value2: any): number;
125
+ static parse(text: any): boolean;
126
+ static format(value: any, meta: any): string;
127
+ }
128
+ import { StringType } from "DataViews/jsdv/src/StringType";
129
+ }
130
+ declare module "DataViews/jsdv/src/ObjectType" {
131
+ /**
132
+ * @class Provides functionality for grid cells that display expandable objects.
133
+ * @augments DataType
134
+ */
135
+ export class ObjectType extends DataType {
136
+ static sortFunction(value1: any, value2: any): number;
137
+ static createEditor(element: any, displayValue: any, value: any, view: any): HTMLButtonElement;
138
+ static parse(text: any): any;
139
+ static format(value: any, meta: any): any;
140
+ static equals(value1: any, value2: any): boolean;
141
+ }
142
+ import DataType from "DataViews/jsdv/src/DataType";
143
+ }
144
+ declare module "DataViews/jsdv/src/IntegerType" {
145
+ /**
146
+ * @class Provides functionality for grid columns that display integer data.
147
+ * @augments DataType
148
+ */
149
+ export class IntegerType extends DataType {
150
+ static sortFunction(value1: any, value2: any): number;
151
+ static createEditor(element: any, displayValue: any, value: any, view: any): HTMLInputElement;
152
+ static parse(text: any): number;
153
+ static format(value: any, meta: any): string;
154
+ static equals(value1: any, value2: any): boolean;
155
+ static get textAlign(): string;
156
+ }
157
+ import DataType from "DataViews/jsdv/src/DataType";
158
+ }
159
+ declare module "DataViews/jsdv/src/LookupType" {
160
+ /**
161
+ * @class Provides functionality for grid columns that display lookup or value lists.
162
+ * @augments DataType
163
+ */
164
+ export class LookupType extends DataType {
165
+ static sortFunction(value1: any, value2: any): any;
166
+ static get customEditor(): CheckListPicker;
167
+ static createEditor(element: any, displayValue: any, value: any, view: any): HTMLSelectElement | CheckListPicker;
168
+ static createDefaultEditor(element: any, displayValue: any, value: any, view: any): HTMLSelectElement;
169
+ static createCustomEditor(editor: any, options: any, element: any, displayValue: any, value: any, view: any): void;
170
+ static format(value: any, meta: any): any;
171
+ static equals(value1: any, value2: any): boolean;
172
+ }
173
+ import DataType from "DataViews/jsdv/src/DataType";
174
+ import { CheckListPicker } from "@mindfusion/common-ui";
175
+ }
176
+ declare module "DataViews/jsdv/src/RealNumberType" {
177
+ /**
178
+ * @class Provides functionality for grid columns that display real number data.
179
+ * @augments IntegerType
180
+ */
181
+ export class RealNumberType extends IntegerType {
182
+ }
183
+ import { IntegerType } from "DataViews/jsdv/src/IntegerType";
184
+ }
185
+ declare module "DataViews/jsdv/src/DynamicType" {
186
+ /**
187
+ * @class Provides functionality for grid columns that display data of different types.
188
+ * @augments DataType
189
+ */
190
+ export class DynamicType extends DataType {
191
+ static sortFunction(valueObj1: any, valueObj2: any): any;
192
+ static resolveValueType(value: any, meta: any): any;
193
+ static createEditor(element: any, displayValue: any, value: any, view: any): any;
194
+ static parse(text: any): any;
195
+ static format(value: any, meta: any): any;
196
+ static equals(value1: any, value2: any): any;
197
+ static get textAlign(): string;
198
+ static resolveDataTypeCallback(): any;
199
+ static getCellValueCallback(): any;
200
+ static resolveCellMetaDataCallback(): any;
201
+ static formatCellValueCallback(text: any): any;
202
+ }
203
+ import DataType from "DataViews/jsdv/src/DataType";
204
+ }
205
+ declare module "DataViews/jsdv/src/ArrayModel" {
206
+ /**
207
+ * @class Represents a grid model, that uses an array of objects as a backing store.
208
+ */
209
+ export class ArrayModel {
210
+ /**
211
+ * Initializes a new instance of the ArrayModel class.
212
+ * @constructor
213
+ * @param {Array} values The array to use as a backing store.
214
+ * @param {Array} columns The list of display columns.
215
+ * @param {String} [keyField] The name of the unique key field.
216
+ */
217
+ constructor(values: any[], columns: any[], keyField?: string);
218
+ _values: any[];
219
+ _columns: any[];
220
+ _keyField: string;
221
+ _autoKey: string;
222
+ /**
223
+ * Gets the maximum value in the unique key column.
224
+ * @returns {Object} The maximum value.
225
+ */
226
+ getMaxKey(): any;
227
+ /**
228
+ * Gets the key of the specified row.
229
+ * @returns {Object} The key.
230
+ */
231
+ getRowKey(row: any): any;
232
+ /**
233
+ * Gets the row with the specified key.
234
+ * @returns {Number} The row index.
235
+ */
236
+ getKeyRow(key: any): number;
237
+ /**
238
+ * Gets the type of the specified column.
239
+ * @param {Number} column The column index.
240
+ * @returns {DataType} The type.
241
+ */
242
+ columnType(column: number): any;
243
+ /**
244
+ * Gets the name of the specified column.
245
+ * @param {Number} column The column index.
246
+ * @returns {String} The name of the field displayed in this column.
247
+ */
248
+ columnName(column: number): string;
249
+ /**
250
+ * Gets the display text of the specified column.
251
+ * @param {Number} column The column index.
252
+ * @returns {String} The display text.
253
+ */
254
+ columnCaption(column: number): string;
255
+ /**
256
+ * Gets a value, indicating whether the cells in the specified column can be edited.
257
+ * @param {Number} column The column index.
258
+ * @returns {Boolean} True if the cells in this column can be edited, otherwise false.
259
+ */
260
+ columnEditable(column: number): boolean;
261
+ /**
262
+ * Gets a value, indicating whether the specified column can be sorted.
263
+ * @param {Number} column The column index.
264
+ * @returns {Boolean} True if the specified column can be sorted, otherwise false.
265
+ */
266
+ columnSortable(column: number): boolean;
267
+ /**
268
+ * Gets a value, indicating whether the specified column is currently displayed.
269
+ * @param {Number} column The column index.
270
+ * @returns {Boolean} True if the specified column should not be displayed, otherwise false.
271
+ */
272
+ columnHidden(column: number): boolean;
273
+ /**
274
+ * Gets the column meta data object.
275
+ * @param {Number} column The column index.
276
+ * @returns {Map} A Map instance containing the column meta data.
277
+ */
278
+ columnMetaData(column: number): Map<any, any>;
279
+ /**
280
+ * Gets the cell meta data object.
281
+ * @param {Number} row The row index.
282
+ * @param {Number} column The column index.
283
+ * @returns {Map} A Map instance containing the cell meta data.
284
+ */
285
+ cellMetaData(row: number, column: number): Map<any, any>;
286
+ /**
287
+ * Gets the cell data type.
288
+ * @param {Number} row The row index.
289
+ * @param {Number} column The column index.
290
+ * @returns {DataType} The data type of the cell.
291
+ */
292
+ cellDataType(row: number, column: number): any;
293
+ /**
294
+ * Sets a value at the specified position.
295
+ * @param {Number} row The row index.
296
+ * @param {Number} column The column index.
297
+ * @param {Object} value The value.
298
+ */
299
+ setValue(row: number, column: number, value: any): void;
300
+ /**
301
+ * Gets the value at the specified position.
302
+ * @param {Number} row The row index.
303
+ * @param {Number} column The column index.
304
+ * @returns {Object} The value.
305
+ */
306
+ value(row: number, column: number): any;
307
+ /**
308
+ * Gets the display value of the cell in the the specified position.
309
+ * @param {Number} row The row index.
310
+ * @param {Number} column The column index.
311
+ * @returns {String} The display value.
312
+ */
313
+ displayValue(row: number, column: number): string;
314
+ /**
315
+ * Gets the values at the specified row index.
316
+ * @param {Number} row The row index.
317
+ * @returns {Object} An object containing the values at the specified row index.
318
+ */
319
+ getRowData(row: number): any;
320
+ /**
321
+ * Adds a row to the backing array.
322
+ * @param {Object} [rowData] The values to add.
323
+ * @param {Number} [index] The index at which to insert the data.
324
+ * If not specified, the data will be appended to the end of the backing array.
325
+ */
326
+ addRow(rowData?: any, index?: number): number;
327
+ /**
328
+ * Removes the row at the specified index from the backing array.
329
+ * @param {Number} row The row index.
330
+ */
331
+ deleteRow(row: number): void;
332
+ /**
333
+ * Gets the number of array items.
334
+ * @type {Number}
335
+ * @summary The row count.
336
+ */
337
+ get rowCount(): number;
338
+ /**
339
+ * Gets the number of display columns.
340
+ * @type {Number}
341
+ * @summary The column count.
342
+ */
343
+ get columnCount(): number;
344
+ }
345
+ }
346
+ declare module "DataViews/jsdv/src/Command" {
347
+ /**
348
+ * @namespace MindFusion.DataViews
349
+ */
350
+ /**
351
+ * Copyright (c) 2022-2025, MindFusion LLC - Bulgaria.
352
+ *
353
+ * This source code is provided to you as part of the MindFusion software components
354
+ * package you have purchased. You may use the source code to trace and/or fix
355
+ * problems or customize the library as needed for your application. To get permission
356
+ * to use the source code in any other way, please contact us at support@mindfusion.dev.
357
+ */
358
+ /**
359
+ * @class A base class for grid row commands.
360
+ */
361
+ export class Command {
362
+ /**
363
+ * Override this method in a derived class to customize the command controller.
364
+ * @param {Object} [sender] Optional.
365
+ * @param {Object} [args] Optional.
366
+ * @returns {HTMLElement} The controller.
367
+ */
368
+ static createControl(sender?: any, args?: any): HTMLElement;
369
+ /**
370
+ * Gets the command string identifier.
371
+ * @type {String}
372
+ * @summary Override this property in a derived class to set the command string identifier.
373
+ */
374
+ static get commandName(): string;
375
+ /**
376
+ * Gets the event, that will trigger the command action.
377
+ * @type {String}
378
+ * @summary Override this property in a derived class to change the trigger event for the command action.
379
+ */
380
+ static get eventName(): string;
381
+ /**
382
+ * Attaches the handler to the controller.
383
+ * @private
384
+ */
385
+ private static attach;
386
+ }
387
+ }
388
+ declare module "DataViews/jsdv/src/EventArgs" {
389
+ /**
390
+ * @class Specifies data for row action validation events.
391
+ * @augments CancelEventArgs
392
+ */
393
+ export class RowModifyingEventArgs extends CancelEventArgs {
394
+ /**
395
+ * Initializes a new instance of the RowModifyingEventArgs class.
396
+ * @constructor
397
+ * @param {Number} row The index of the row that is being modified.
398
+ * @param {RowAction} action The row action.
399
+ * @param {Object} rowData The row data.
400
+ * @param {Map} oldValues The dictionary of the original field name/value pairs.
401
+ * @param {Map} newValues The dictionary of the new field name/value pairs.
402
+ */
403
+ constructor(row: number, action: RowAction, rowData: any, oldValues: Map<any, any>, newValues: Map<any, any>);
404
+ _row: number;
405
+ _action: number;
406
+ _rowData: any;
407
+ _oldValues: Map<any, any>;
408
+ _newValues: Map<any, any>;
409
+ /**
410
+ * Gets the row that is being modified.
411
+ * @type {Number}
412
+ * @summary The index of the row that is being modified.
413
+ */
414
+ get row(): number;
415
+ /**
416
+ * Gets the row data.
417
+ * @type {Object}
418
+ * @summary An object containing the row data.
419
+ */
420
+ get rowData(): any;
421
+ /**
422
+ * Gets the row action.
423
+ * @type {RowAction}
424
+ * @summary One of the RowAction enumeration values.
425
+ */
426
+ get action(): number;
427
+ /**
428
+ * Gets the dictionary of the original field name/value pairs.
429
+ * @type {Map}
430
+ * @summary The dictionary of the original field name/value pairs.
431
+ */
432
+ get oldValues(): Map<any, any>;
433
+ /**
434
+ * Gets the dictionary of the new field name/value pairs.
435
+ * @type {Map}
436
+ * @summary The dictionary of the new field name/value pairs.
437
+ */
438
+ get newValues(): Map<any, any>;
439
+ }
440
+ /**
441
+ * @class Specifies data for row action notification events.
442
+ * @augments EventArgs
443
+ */
444
+ export class RowModifiedEventArgs extends EventArgs {
445
+ /**
446
+ * Initializes a new instance of the RowModifiedEventArgs class.
447
+ * @constructor
448
+ * @param {Number} row The index of the row that was modified.
449
+ * @param {RowAction} action The row action.
450
+ * @param {Object} rowData The row data.
451
+ * @param {Map} oldValues The dictionary of the original field name/value pairs.
452
+ * @param {Map} newValues The dictionary of the new field name/value pairs.
453
+ */
454
+ constructor(row: number, action: RowAction, rowData: any, oldValues: Map<any, any>, newValues: Map<any, any>);
455
+ _row: number;
456
+ _action: number;
457
+ _rowData: any;
458
+ _oldValues: Map<any, any>;
459
+ _newValues: Map<any, any>;
460
+ /**
461
+ * Gets the row that was modified.
462
+ * @type {Number}
463
+ * @summary The index of the row that was modified.
464
+ */
465
+ get row(): number;
466
+ /**
467
+ * Gets the row data.
468
+ * @type {Object}
469
+ * @summary An object containing the row data.
470
+ */
471
+ get rowData(): any;
472
+ /**
473
+ * Gets the row action.
474
+ * @type {RowAction}
475
+ * @summary One of the RowAction enumeration values.
476
+ */
477
+ get action(): number;
478
+ /**
479
+ * Gets the dictionary of the original field name/value pairs.
480
+ * @type {Map}
481
+ * @summary The dictionary of the original field name/value pairs.
482
+ */
483
+ get oldValues(): Map<any, any>;
484
+ /**
485
+ * Gets the dictionary of the new field name/value pairs.
486
+ * @type {Map}
487
+ * @summary The dictionary of the new field name/value pairs.
488
+ */
489
+ get newValues(): Map<any, any>;
490
+ }
491
+ /**
492
+ * @class Specifies data for the rowCommand event.
493
+ * @augments RowModifyingEventArgs
494
+ */
495
+ export class CommandEventArgs extends RowModifyingEventArgs {
496
+ /**
497
+ * Initializes a new instance of the RowModifiedEventArgs class.
498
+ * @constructor
499
+ * @param {String} commandName The string identifier of the executed command.
500
+ * @param {HTMLElement} control The controller that triggered the command.
501
+ * @param {Number} row The index of the row, for which the command is executed.
502
+ * @param {Object} rowData The row data.
503
+ */
504
+ constructor(commandName: string, control: HTMLElement, row: number, rowData: any);
505
+ _commandName: string;
506
+ _control: HTMLElement;
507
+ /**
508
+ * Gets the string identifier of the executed command.
509
+ * @type {String}
510
+ * @summary The command name.
511
+ */
512
+ get commandName(): string;
513
+ /**
514
+ * Gets the controller that triggered the command.
515
+ * @type {HTMLElement}
516
+ * @summary The HTML control.
517
+ */
518
+ get control(): HTMLElement;
519
+ }
520
+ /**
521
+ * @class Provides data for the cell related validation events.
522
+ * @augments CancelEventArgs
523
+ */
524
+ export class CellValidateEventArgs extends CancelEventArgs {
525
+ /**
526
+ * Initializes a new instance of the CellValidateEventArgs class.
527
+ * @constructor
528
+ * @param {Number} row The row index of the cell.
529
+ * @param {Number} column The column index of the cell.
530
+ */
531
+ constructor(row: number, column: number, value: any, displayValue: any);
532
+ _row: number;
533
+ _column: number;
534
+ _value: any;
535
+ _displayValue: any;
536
+ /**
537
+ * Gets the row of the cell, associated with the event.
538
+ * @type {Number}
539
+ * @summary The row index.
540
+ */
541
+ get row(): number;
542
+ /**
543
+ * Gets the column of the cell, associated with the event.
544
+ * @type {Number}
545
+ * @summary The column index.
546
+ */
547
+ get column(): number;
548
+ /**
549
+ * Gets the column of the cell, associated with the event.
550
+ * @type {Number}
551
+ * @summary The column index.
552
+ */
553
+ get value(): number;
554
+ /**
555
+ * Gets the column of the cell, associated with the event.
556
+ * @returns {Number} The column index.
557
+ */
558
+ get displayValuelu(): number;
559
+ }
560
+ /**
561
+ * @class Provides data for the cell related notification events.
562
+ * @augments EventArgs
563
+ */
564
+ export class CellEventArgs extends EventArgs {
565
+ /**
566
+ * Initializes a new instance of the CellEventArgs class.
567
+ * @constructor
568
+ * @param {Number} row The row index of the cell.
569
+ * @param {Number} column The column index of the cell.
570
+ */
571
+ constructor(row: number, column: number, value: any, displayValue: any);
572
+ _row: number;
573
+ _column: number;
574
+ _value: any;
575
+ _displayValue: any;
576
+ /**
577
+ * Gets the row of the cell, associated with the event.
578
+ * @type {Number}
579
+ * @summary The row index.
580
+ */
581
+ get row(): number;
582
+ /**
583
+ * Gets the column of the cell, associated with the event.
584
+ * @type {Number}
585
+ * @summary The column index.
586
+ */
587
+ get column(): number;
588
+ /**
589
+ * Gets the column of the cell, associated with the event.
590
+ * @returns {Number} The column index.
591
+ */
592
+ get value(): number;
593
+ /**
594
+ * Gets the column of the cell, associated with the event.
595
+ * @returns {Number} The column index.
596
+ */
597
+ get displayValuelu(): number;
598
+ }
599
+ /**
600
+ * @class Provides data for custom draw events.
601
+ * @augments CellEventArgs
602
+ */
603
+ export class CellCustomDrawEventArgs extends CellEventArgs {
604
+ /**
605
+ * Initializes a new instance of the CellCustomDrawEventArgs class.
606
+ * @constructor
607
+ * @param {Number} row The row index of the cell.
608
+ * @param {Number} column The column index of the cell.
609
+ * @param {Node} defaultContent The default content displayed in the cell.
610
+ */
611
+ constructor(row: number, column: number, defaultContent: Node);
612
+ _defaultContent: Node;
613
+ /**
614
+ * Gets the default content, displayed in the cell.
615
+ * @type {Node}
616
+ * @summary The default content.
617
+ */
618
+ get defaultContent(): Node;
619
+ set content(arg: Node);
620
+ /**
621
+ * Gets or sets the new content to be displayed in the cell.
622
+ * @type {Node}
623
+ * @summary The new content.
624
+ */
625
+ get content(): Node;
626
+ _content: Node;
627
+ }
628
+ /**
629
+ * @class Provides data for events raised by dynamic columns.
630
+ * @augments EventArgs
631
+ */
632
+ export class CellResolveEventArgs extends EventArgs {
633
+ /**
634
+ * Initializes a new instance of the CellResolveEventArgs class.
635
+ * @constructor
636
+ * @param {Number} row The row index of the cell.
637
+ * @param {Number} column The column index of the cell.
638
+ * @param {Object} value The cell value.
639
+ * @param {Object} result The data, passed back from the event.
640
+ */
641
+ constructor(row: number, column: number, value: any, result: any);
642
+ _row: number;
643
+ _column: number;
644
+ _value: any;
645
+ _result: any;
646
+ /**
647
+ * Gets the row of the cell, associated with the event.
648
+ * @type {Number}
649
+ * @summary The row index.
650
+ */
651
+ get row(): number;
652
+ /**
653
+ * Gets the column of the cell, associated with the event.
654
+ * @type {Number}
655
+ * @summary The column index.
656
+ */
657
+ get column(): number;
658
+ /**
659
+ * Gets the value of the cell, associated with the event.
660
+ * @returns {Object} The cell value.
661
+ */
662
+ get value(): any;
663
+ set result(arg: any);
664
+ /**
665
+ * Gets or sets the data, passed from the event.
666
+ * @returns {Object} The result.
667
+ */
668
+ get result(): any;
669
+ }
670
+ /**
671
+ * @class Provides data for events raised by the PropertyGrid control.
672
+ * @augments CancelEventArgs
673
+ */
674
+ export class PropertyEventArgs extends CancelEventArgs {
675
+ /**
676
+ * Initializes a new instance of the PropertyEventArgs class.
677
+ * @constructor
678
+ * @param {RowAction} action The action associated with the event.
679
+ * @param {String} propertyName The name of the property.
680
+ * @param {Object} propertyValue The value of the property.
681
+ * @param {Object} oldValue The value of the property.
682
+ * @param {Number} index The index of the object, associated with the event.
683
+ * @param {Map} meta The metaData of the property.
684
+ */
685
+ constructor(action: RowAction, propertyName: string, index: number, propertyValue: any, oldValue: any, newValue: any, meta: Map<any, any>);
686
+ _action: number;
687
+ _propertyName: string;
688
+ _index: number;
689
+ _propertyValue: any;
690
+ _oldValue: any;
691
+ _newValue: any;
692
+ _meta: Map<any, any>;
693
+ /**
694
+ * Gets the action associated with the event.
695
+ * @type {RowAction}
696
+ * @summary One of the RowAction enumeration values.
697
+ */
698
+ get action(): number;
699
+ /**
700
+ * Gets the name of the property.
701
+ * @type {String}
702
+ * @summary The property name.
703
+ */
704
+ get propertyName(): string;
705
+ /**
706
+ * Gets the index of the object associated with the event.
707
+ * @type {Number}
708
+ * @summary The index.
709
+ */
710
+ get index(): number;
711
+ /**
712
+ * Gets the value of the property.
713
+ * @type {Object}
714
+ * @summary The property value.
715
+ */
716
+ get propertyValue(): any;
717
+ /**
718
+ * Gets the old value of the property.
719
+ * @type {Object}
720
+ * @summary The old property value.
721
+ */
722
+ get oldValue(): any;
723
+ set newValue(arg: any);
724
+ /**
725
+ * Gets or sets the new value of the property.
726
+ * @type {Object}
727
+ * @summary The new property value.
728
+ */
729
+ get newValue(): any;
730
+ /**
731
+ * Gets the metaData of the property.
732
+ * @type {Map}
733
+ * @summary The metaData dictionary.
734
+ */
735
+ get meta(): Map<any, any>;
736
+ }
737
+ import { CancelEventArgs } from "@mindfusion/controls";
738
+ import { RowAction } from "DataViews/jsdv/src/Enum";
739
+ import { EventArgs } from "@mindfusion/controls";
740
+ }
741
+ declare module "DataViews/jsdv/src/CommandType" {
742
+ /**
743
+ * @class Provides functionality for command columns.
744
+ */
745
+ export class CommandType {
746
+ static createContent(element: any, view: any): void;
747
+ }
748
+ }
749
+ declare module "DataViews/jsdv/src/CurrencyType" {
750
+ /**
751
+ * @class Provides functionality for grid columns that display currency data.
752
+ * @augments RealNumberType
753
+ */
754
+ export class CurrencyType extends RealNumberType {
755
+ }
756
+ import { RealNumberType } from "DataViews/jsdv/src/RealNumberType";
757
+ }
758
+ declare module "DataViews/jsdv/src/DeleteCommand" {
759
+ /**
760
+ * @class Handles row deletion, triggered by a command grid column.
761
+ */
762
+ export class DeleteCommand extends Command {
763
+ static execute(sender: any, args: any): void;
764
+ }
765
+ import { Command } from "DataViews/jsdv/src/Command";
766
+ }
767
+ declare module "DataViews/jsdv/src/DomRenderer" {
768
+ /**
769
+ * @namespace MindFusion.DataViews
770
+ */
771
+ /**
772
+ * Copyright (c) 2022-2025, MindFusion LLC - Bulgaria.
773
+ *
774
+ * This source code is provided to you as part of the MindFusion software components
775
+ * package you have purchased. You may use the source code to trace and/or fix
776
+ * problems or customize the library as needed for your application. To get permission
777
+ * to use the source code in any other way, please contact us at support@mindfusion.dev.
778
+ */
779
+ /**
780
+ * @class A base class for grid renderers.
781
+ */
782
+ export class DomRenderer {
783
+ set grid(arg: any);
784
+ /**
785
+ * Gets or sets the grid control this renderer is attached to.
786
+ * @type {Grid}
787
+ * @summary The grid control.
788
+ */
789
+ get grid(): any;
790
+ _grid: any;
791
+ /**
792
+ * Gets the array of DOM elements of the visible rows.
793
+ * @type {HTMLCollection}
794
+ * @summary Implement this property in a derived class to provide access to the array of DOM elements of the visible rows.
795
+ */
796
+ get visibleRows(): HTMLCollection;
797
+ /**
798
+ * Gets the array of DOM elements of the visible cells.
799
+ * @type {HTMLCollection}
800
+ * @ summary Implement this property in a derived class to provide access to the array of DOM elements of the visible cells.
801
+ */
802
+ get visibleCells(): HTMLCollection;
803
+ /**
804
+ * Implement this method in a derived class to handle the initial rendering of the grid control.
805
+ */
806
+ renderGrid(): void;
807
+ /**
808
+ * Implement this method in a derived class to handle re-rendering of the grid control.
809
+ */
810
+ invalidate(): void;
811
+ /**
812
+ * Implement this method in a derived class to handle re-rendering of a row range.
813
+ * @param {Number} index The start index of the range.
814
+ * @param {Number} count The length of the range.
815
+ */
816
+ refreshRows(index: number, count: number): void;
817
+ /**
818
+ * Implement this method in a derived class to handle updates of grid cells after inplace-editing.
819
+ * @param {Number} row The row index.
820
+ * @param {Number} column The column index.
821
+ */
822
+ updateCell(row: number, column: number): void;
823
+ /**
824
+ * Implement this method in a derived class to handle row creation.
825
+ */
826
+ onRowCreated(): void;
827
+ /**
828
+ * Implement this method in a derived class to handle row deletion.
829
+ */
830
+ onRowDeleted(): void;
831
+ /**
832
+ * Implement this method in a derived class to handle scrolling.
833
+ */
834
+ onScroll(): void;
835
+ /**
836
+ * Implement this method in a derived class to handle selection.
837
+ */
838
+ onSelect(): void;
839
+ /**
840
+ * Implement this method in a derived class to handle sorting.
841
+ */
842
+ onSort(): void;
843
+ }
844
+ }
845
+ declare module "DataViews/jsdv/src/UIControl" {
846
+ /**
847
+ * @class A base class for UI controls.
848
+ */
849
+ export class UIControl extends Control {
850
+ static get tm(): number[];
851
+ static get ns(): string;
852
+ static get pk(): string;
853
+ }
854
+ import { UIControl as Control } from "@mindfusion/common";
855
+ }
856
+ declare module "DataViews/jsdv/src/ProxyModel" {
857
+ export default ProxyModel;
858
+ class ProxyModel {
859
+ constructor(sourceModel: any);
860
+ sourceModel: any;
861
+ _filter: any;
862
+ _sortedColumn: number;
863
+ _sortAscending: boolean;
864
+ _groupColumn: number;
865
+ indexMap: any[];
866
+ getMaxKey(): any;
867
+ getKeyRow(key: any): any;
868
+ getRowKey(index: any): any;
869
+ columnType(column: any): any;
870
+ columnName(column: any): any;
871
+ columnCaption(column: any): any;
872
+ columnEditable(column: any): any;
873
+ columnSortable(column: any): any;
874
+ columnHidden(column: any): any;
875
+ columnMetaData(column: any): any;
876
+ cellMetaData(row: any, column: any): any;
877
+ cellDataType(row: any, column: any): any;
878
+ setValue(row: any, column: any, value: any): void;
879
+ value(row: any, column: any): any;
880
+ displayValue(row: any, column: any): any;
881
+ getRowData(row: any): any;
882
+ addRow(rowData: any, index: any): number;
883
+ deleteRow(row: any): void;
884
+ get rowCount(): any;
885
+ get columnCount(): any;
886
+ invalidate(): void;
887
+ ensureIndexMap(): void;
888
+ set filter(arg: any);
889
+ get filter(): any;
890
+ set sortedColumn(arg: number);
891
+ get sortedColumn(): number;
892
+ set sortAscending(arg: boolean);
893
+ get sortAscending(): boolean;
894
+ set groupColumn(arg: number);
895
+ get groupColumn(): number;
896
+ isGroupRow(row: any): any;
897
+ }
898
+ }
899
+ declare module "DataViews/jsdv/src/ImageType" {
900
+ /**
901
+ * @class Provides functionality for grid columns that display image data.
902
+ * @augments DataType
903
+ */
904
+ export class ImageType extends DataType {
905
+ static sortFunction(value1: any, value2: any): any;
906
+ static createEditor(element: any, displayValue: any, value: any, view: any): HTMLInputElement | ImagePicker;
907
+ static createDefaultEditor(element: any, displayValue: any, value: any, view: any): HTMLInputElement;
908
+ static updateCell(view: any, element: any, r: any, c: any, displayValue: any): void;
909
+ static createCustomEditor(editor: any, options: any, element: any, displayValue: any, value: any, view: any): void;
910
+ static parse(text: any): any;
911
+ static equals(value1: any, value2: any): boolean;
912
+ static format(value: any, meta: any): string;
913
+ static get textAlign(): string;
914
+ }
915
+ import DataType from "DataViews/jsdv/src/DataType";
916
+ import { ImagePicker } from "@mindfusion/common-ui";
917
+ }
918
+ declare module "DataViews/jsdv/src/GridRenderer" {
919
+ export default GridRenderer;
920
+ /**
921
+ * @class Contains render methods for a grid control.
922
+ */
923
+ class GridRenderer extends DomRenderer {
924
+ repaintId: number;
925
+ draw(): void;
926
+ drawHeader(): HTMLDivElement;
927
+ drawContent(): HTMLDivElement;
928
+ drawRows(): void;
929
+ rowHeight: number;
930
+ rowsHeight: number;
931
+ drawRow(model: any, r: any): HTMLDivElement;
932
+ drawFooter(): HTMLDivElement;
933
+ refreshRow(model: any, r: any): void;
934
+ addSelectedFlag(element: any): void;
935
+ removeSelectedFlag(element: any): void;
936
+ clearSelection(): void;
937
+ updateSelection(): void;
938
+ }
939
+ import { DomRenderer } from "DataViews/jsdv/src/DomRenderer";
940
+ }
941
+ declare module "DataViews/jsdv/src/Selection" {
942
+ export default Selection;
943
+ /**
944
+ * @namespace MindFusion.DataViews
945
+ */
946
+ /**
947
+ * Copyright (c) 2022-2025, MindFusion LLC - Bulgaria.
948
+ *
949
+ * This source code is provided to you as part of the MindFusion software components
950
+ * package you have purchased. You may use the source code to trace and/or fix
951
+ * problems or customize the library as needed for your application. To get permission
952
+ * to use the source code in any other way, please contact us at support@mindfusion.dev.
953
+ */
954
+ /**
955
+ * @class Represents a selection in a grid control.
956
+ */
957
+ class Selection {
958
+ /**
959
+ * Initializes a new instance of the Selection class.
960
+ * @constructor
961
+ * @param {Grid} grid The associated grid control.
962
+ */
963
+ constructor(grid: any);
964
+ _grid: any;
965
+ _cells: any[];
966
+ _rows: any[];
967
+ set cells(arg: any[]);
968
+ /**
969
+ * Gets or sets the array of selected cells.
970
+ * @type {Array}
971
+ * @summary The array of selected cells.
972
+ */
973
+ get cells(): any[];
974
+ _columns: any[];
975
+ set rows(arg: any[]);
976
+ /**
977
+ * Gets or sets the array of selected rows.
978
+ * @type {Array}
979
+ * @summary The array of selected rows.
980
+ */
981
+ get rows(): any[];
982
+ }
983
+ }
984
+ declare module "DataViews/jsdv/src/GridModel" {
985
+ /**
986
+ * @namespace MindFusion.DataViews
987
+ */
988
+ /**
989
+ * Copyright (c) 2022-2025, MindFusion LLC - Bulgaria.
990
+ *
991
+ * This source code is provided to you as part of the MindFusion software components
992
+ * package you have purchased. You may use the source code to trace and/or fix
993
+ * problems or customize the library as needed for your application. To get permission
994
+ * to use the source code in any other way, please contact us at support@mindfusion.dev.
995
+ */
996
+ /**
997
+ * @class The interface for grid models.
998
+ */
999
+ export class GridModel {
1000
+ /**
1001
+ * Gets the key of the specified row.
1002
+ * @returns {Object} The key.
1003
+ */
1004
+ getRowKey(row: any): any;
1005
+ /**
1006
+ * Gets the row with the specified key.
1007
+ * @returns {Number} The row index.
1008
+ */
1009
+ getKeyRow(key: any): number;
1010
+ /**
1011
+ * Gets the type of the specified column.
1012
+ * @param {Number} column The column index.
1013
+ * @returns {DataType} The type.
1014
+ */
1015
+ columnType(column: number): any;
1016
+ /**
1017
+ * Gets the name of the specified column.
1018
+ * @param {Number} column The column index.
1019
+ * @returns {String} The name of the field displayed in this column.
1020
+ */
1021
+ columnName(column: number): string;
1022
+ /**
1023
+ * Gets the display text of the specified column.
1024
+ * @param {Number} column The column index.
1025
+ * @returns {String} The display text.
1026
+ */
1027
+ columnCaption(column: number): string;
1028
+ /**
1029
+ * Gets a value, indicating whether the cells in the specified column can be edited.
1030
+ * @param {Number} column The column index.
1031
+ * @returns {Boolean} True if the cells in this column can be edited, otherwise false.
1032
+ */
1033
+ columnEditable(column: number): boolean;
1034
+ /**
1035
+ * Gets a value, indicating whether the specified column can be sorted.
1036
+ * @param {Number} column The column index.
1037
+ * @returns {Boolean} True if the specified column can be sorted, otherwise false.
1038
+ */
1039
+ columnSortable(column: number): boolean;
1040
+ /**
1041
+ * Gets the column meta data object.
1042
+ * @param {Number} column The column index.
1043
+ * @returns {Map} A Map instance containing the column meta data.
1044
+ */
1045
+ columnMetaData(column: number): Map<any, any>;
1046
+ cellDataType(row: any, column: any): any;
1047
+ /**
1048
+ * Sets a value at the specified position.
1049
+ * @param {Number} row The row index.
1050
+ * @param {Number} column The column index.
1051
+ * @param {Object} value The value.
1052
+ */
1053
+ setValue(row: number, column: number, value: any): void;
1054
+ /**
1055
+ * Gets the value at the specified position.
1056
+ * @param {Number} row The row index.
1057
+ * @param {Number} column The column index.
1058
+ * @returns {Object} The value.
1059
+ */
1060
+ value(row: number, column: number): any;
1061
+ /**
1062
+ * Gets the display value of the cell in the the specified position.
1063
+ * @param {Number} row The row index.
1064
+ * @param {Number} column The column index.
1065
+ * @returns {String} The display value.
1066
+ */
1067
+ displayValue(row: number, column: number): string;
1068
+ /**
1069
+ * Gets the values at the specified row index.
1070
+ * @param {Number} row The row index.
1071
+ * @returns {Object} An object containing the values at the specified row index.
1072
+ */
1073
+ getRowData(row: number): any;
1074
+ /**
1075
+ * Adds a row to the backing store.
1076
+ * @param {Object} [rowData] The values to add.
1077
+ * @param {Number} [index] The index at which to insert the data.
1078
+ * @returns {Number} index The index of the new row.
1079
+ */
1080
+ addRow(rowData?: any, index?: number): number;
1081
+ /**
1082
+ * Removes the row at the specified index from the backing store.
1083
+ * @param {Number} row The row index.
1084
+ */
1085
+ deleteRow(row: number): void;
1086
+ /**
1087
+ * Gets the number of rows in the backing store.
1088
+ * @type {Number}
1089
+ * @summary The row count.
1090
+ */
1091
+ get rowCount(): number;
1092
+ /**
1093
+ * Gets the number of display columns.
1094
+ * @type {Number}
1095
+ * @summary The column count.
1096
+ */
1097
+ get columnCount(): number;
1098
+ }
1099
+ }
1100
+ declare module "DataViews/jsdv/src/GridCell" {
1101
+ /**
1102
+ * @namespace MindFusion.DataViews
1103
+ */
1104
+ /**
1105
+ * Copyright (c) 2022-2025, MindFusion LLC - Bulgaria.
1106
+ *
1107
+ * This source code is provided to you as part of the MindFusion software components
1108
+ * package you have purchased. You may use the source code to trace and/or fix
1109
+ * problems or customize the library as needed for your application. To get permission
1110
+ * to use the source code in any other way, please contact us at support@mindfusion.dev.
1111
+ */
1112
+ /**
1113
+ * @class Represents a data cell in a grid control.
1114
+ */
1115
+ export class GridCell {
1116
+ /**
1117
+ * Initializes a new instance of the GridCell class.
1118
+ * @constructor
1119
+ * @private
1120
+ */
1121
+ private constructor();
1122
+ _parent: any;
1123
+ _row: any;
1124
+ _column: any;
1125
+ _rowKey: any;
1126
+ /**
1127
+ * @private
1128
+ */
1129
+ private focus;
1130
+ /**
1131
+ * @private
1132
+ */
1133
+ private invalidateKey;
1134
+ /**
1135
+ * Gets the row index of this cell.
1136
+ * @type {Number}
1137
+ * @summary The row index.
1138
+ */
1139
+ get row(): number;
1140
+ /**
1141
+ * Gets the column index of this cell.
1142
+ * @type {Number}
1143
+ * @summary The column index.
1144
+ */
1145
+ get column(): number;
1146
+ /**
1147
+ * Gets the DOM element of this cell.
1148
+ * @type {HTMLDivElement}
1149
+ * @summary The DOM element,
1150
+ */
1151
+ get element(): HTMLDivElement;
1152
+ /**
1153
+ * Gets the parent control] of this cell.
1154
+ * @type {Grid}
1155
+ * @summary The parent control.
1156
+ */
1157
+ get parent(): any;
1158
+ }
1159
+ }
1160
+ declare module "DataViews/jsdv/src/Grid" {
1161
+ /**
1162
+ * @class Represents a grid view control.
1163
+ * @augments UIControl
1164
+ */
1165
+ export class Grid extends UIControl {
1166
+ /**
1167
+ * Initializes a new instance of the Grid class.
1168
+ * @constructor
1169
+ * @param {HTMLDivElement} [element] The control's associated Dom element.
1170
+ * @param {Object} [renderer] Optional.
1171
+ */
1172
+ constructor(element?: HTMLDivElement, renderer?: any);
1173
+ _defaultWidth: Unit;
1174
+ _defaultHeight: Unit;
1175
+ _model: any;
1176
+ _proxyModel: ProxyModel;
1177
+ _allowEdit: boolean;
1178
+ _allowAppend: boolean;
1179
+ _allowDelete: boolean;
1180
+ _allowCellSelect: boolean;
1181
+ _allowScroll: boolean;
1182
+ _filter: any;
1183
+ _sortedColumn: number;
1184
+ _sortAscending: boolean;
1185
+ renderer: any;
1186
+ _scrollRow: number;
1187
+ _columnWidths: any[];
1188
+ _rowHeaderWidth: number;
1189
+ _focusedCell: any;
1190
+ _activeEditor: any;
1191
+ _tableShouldFocus: boolean;
1192
+ selection: Selection;
1193
+ queuedEvents: any[];
1194
+ _rowLoading: EventDispatcher;
1195
+ _rowRendered: EventDispatcher;
1196
+ _rowCreating: EventDispatcher;
1197
+ _rowCreated: EventDispatcher;
1198
+ _rowDeleting: EventDispatcher;
1199
+ _rowDeleted: EventDispatcher;
1200
+ _rowUpdating: EventDispatcher;
1201
+ _rowUpdated: EventDispatcher;
1202
+ _rowSelecting: EventDispatcher;
1203
+ _rowSelected: EventDispatcher;
1204
+ _cellSelecting: EventDispatcher;
1205
+ _cellSelected: EventDispatcher;
1206
+ _cellFocusing: EventDispatcher;
1207
+ _cellFocused: EventDispatcher;
1208
+ _customDrawCell: EventDispatcher;
1209
+ _customDrawHeader: EventDispatcher;
1210
+ _rowCommand: EventDispatcher;
1211
+ _resolveCellDataType: EventDispatcher;
1212
+ _resolveCellMetaData: EventDispatcher;
1213
+ _getCellValue: EventDispatcher;
1214
+ _formatCellValue: EventDispatcher;
1215
+ _objectButtonClick: EventDispatcher;
1216
+ _scrollHandler: (e: any) => boolean;
1217
+ mouseWheelHandler: (e: any) => void;
1218
+ get wrapper(): Element;
1219
+ /**
1220
+ * Returns a reference to the grid header DOM element.
1221
+ * @type {HTMLDivElement}
1222
+ * @summary The header element.
1223
+ */
1224
+ get header(): HTMLDivElement;
1225
+ /**
1226
+ * Returns a reference to the grid data table DOM element.
1227
+ * @type {HTMLDivElement}
1228
+ * @summary The data table element.
1229
+ */
1230
+ get dataTable(): HTMLDivElement;
1231
+ /**
1232
+ * Returns the array of DOM elements of the visible rows.
1233
+ * @type {Array}
1234
+ * @summary An array of row DOM elements.
1235
+ * @private
1236
+ */
1237
+ private get visibleRows();
1238
+ /**
1239
+ * Returns the array of DOM elements of the visible cells.
1240
+ * @type {Array}
1241
+ * @summary A two-dimensional array of cell DOM elements.
1242
+ * @private
1243
+ */
1244
+ private get visibleCells();
1245
+ scroll: Element;
1246
+ columnWidthsInterval: number;
1247
+ resizeHandler: (e: any) => void;
1248
+ /**
1249
+ * Called before the grid contents are rendered by the current renderer.
1250
+ * @private
1251
+ */
1252
+ private onBeforeRender;
1253
+ /**
1254
+ * Called after the grid contents are rendered by the current renderer.
1255
+ * @private
1256
+ */
1257
+ private onAfterRender;
1258
+ rowHeight: number;
1259
+ rowsCount: number;
1260
+ stopEvents: boolean;
1261
+ /**
1262
+ * Repaints the grid contents.
1263
+ * @param {Boolean} [selected] True to repaint only the selected rows.
1264
+ */
1265
+ refresh(selected?: boolean): Promise<any>;
1266
+ /**
1267
+ * Sets the focus to the cell at the specified position.
1268
+ * @param {Number} row The cell row.
1269
+ * @param {Number} column The cell column.
1270
+ * @param {Boolean} [moveBackwards] True to move backwards.
1271
+ * @remarks If the cell at the specified position is not editable, the focus is set
1272
+ * to the next editable cell, if such exists.
1273
+ */
1274
+ focusCell(row: number, column: number, moveBackwards?: boolean): void;
1275
+ /**
1276
+ * Selects the cell at the specified position.
1277
+ * @param {Number} row The cell row.
1278
+ * @param {Number} column The cell column.
1279
+ */
1280
+ selectCell(row: number, column: number): void;
1281
+ /**
1282
+ * Selects the rows in the specified range.
1283
+ * @param {Number} index The start index of the range to select.
1284
+ * @param {Number} [count] The length of the range.
1285
+ */
1286
+ selectRows(index: number, count?: number): void;
1287
+ /**
1288
+ * Gets the indices of selected rows.
1289
+ * @type {Array}
1290
+ * @summary An array of indices.
1291
+ */
1292
+ get selectedRowIndices(): any[];
1293
+ /**
1294
+ * Gets the selected cells.
1295
+ * @type {Array}
1296
+ * @summary An array of GridCell instances.
1297
+ */
1298
+ get selectedCells(): any[];
1299
+ /**
1300
+ * Invalidates the current renderer.
1301
+ * @private
1302
+ */
1303
+ private invalidateDom;
1304
+ /**
1305
+ * Repaints a range of rows.
1306
+ * @param {Number} index The start index of the row range to repaint.
1307
+ * @param {Number} [count] The length of the range.
1308
+ */
1309
+ refreshRows(index: number, count?: number): Promise<any>;
1310
+ /**
1311
+ * Adds a row.
1312
+ * @param {Object} rowData The values to add.
1313
+ * @param {Number} [index] Optional.
1314
+ */
1315
+ addRow(rowData: any, index?: number): Promise<any>;
1316
+ /**
1317
+ * Removes a range of rows.
1318
+ * @param {Number} index The start index of the row range to remove.
1319
+ * @param {Number} [count] The length of the range.
1320
+ */
1321
+ removeRows(index: number, count?: number): Promise<any>;
1322
+ /**
1323
+ * Removes a range of rows from the data table starting from the given index.
1324
+ * @param {Number} index The starting row index.
1325
+ * @param {Number} count The length of the range.
1326
+ * @private
1327
+ */
1328
+ private removeRowRange;
1329
+ scrollRangeInvalid: boolean;
1330
+ /**
1331
+ * Sorts by the specified column and sort direction.
1332
+ * @param {Number} index The index of the column to sort by, or null to clear the sorting.
1333
+ * @param {Boolean} [sortAscending] True to sort ascending, otherwise false.
1334
+ */
1335
+ sortByColumn(index: number, sortAscending?: boolean): void;
1336
+ set sortedColumn(arg: number);
1337
+ /**
1338
+ * Gets or sets the index of the column, by which the data is sorted.
1339
+ * @type {Number}
1340
+ * @summary The column index, or -1 if no sorting is applied to the grid.
1341
+ */
1342
+ get sortedColumn(): number;
1343
+ set sortAscending(arg: boolean);
1344
+ /**
1345
+ * Gets or sets a value, indicating whether the sorting is in Ascending order.
1346
+ * @type {Boolean}
1347
+ * @summary True if the sorting is in Ascending order, otherwise false.
1348
+ */
1349
+ get sortAscending(): boolean;
1350
+ /**
1351
+ * Calculates the scroll fix amount.
1352
+ * @private
1353
+ */
1354
+ private calcScrollFix;
1355
+ scrollFixAmount: number;
1356
+ /**
1357
+ * Updates the scroll range based on current rows count and height.
1358
+ * @private
1359
+ */
1360
+ private updateScrollRange;
1361
+ scrollIncrement: number;
1362
+ /**
1363
+ * Sets equal column widths in pixels based on flex calculations.
1364
+ * @private
1365
+ */
1366
+ private initColumnWidths;
1367
+ /**
1368
+ * For internal use only.
1369
+ * @private
1370
+ */
1371
+ private resizeColumn;
1372
+ set model(arg: GridModel);
1373
+ /**
1374
+ * Gets or sets the data model of this grid.
1375
+ * @type {GridModel}
1376
+ * @summary The model.
1377
+ */
1378
+ get model(): GridModel;
1379
+ /**
1380
+ * Refreshes the grid after external modifications to the grid model.
1381
+ */
1382
+ rebind(): void;
1383
+ set scrollRow(arg: number);
1384
+ /**
1385
+ * Gets or sets the index of the first visible row.
1386
+ * @type {Number}
1387
+ * @summary The row index.
1388
+ */
1389
+ get scrollRow(): number;
1390
+ get effectiveModel(): any;
1391
+ ensureProxyModel(): void;
1392
+ set allowEdit(arg: boolean);
1393
+ /**
1394
+ * Gets or sets a value, indicating whether inplace editing is enabled.
1395
+ * @type {Boolean}
1396
+ * @summary True if inplace editing is enabled, otherwise false.
1397
+ */
1398
+ get allowEdit(): boolean;
1399
+ set allowAppend(arg: boolean);
1400
+ /**
1401
+ * Gets or sets a value, indicating whether to show a new empty row at the bottom of the grid and a 'New row' option in the row context menu.
1402
+ * @type {Boolean}
1403
+ * @summary True to show a new row, otherwise false.
1404
+ */
1405
+ get allowAppend(): boolean;
1406
+ set allowDelete(arg: boolean);
1407
+ /**
1408
+ * Gets or sets a value, indicating whether to show a 'Delete row' option in the row context menu.
1409
+ * @type {Boolean}
1410
+ * @summary True to show the option, otherwise false.
1411
+ */
1412
+ get allowDelete(): boolean;
1413
+ set allowCellSelect(arg: boolean);
1414
+ /**
1415
+ * Gets or sets a value, indicating whether single cell selection is enabled.
1416
+ * @type {Boolean}
1417
+ * @summary True if single cell selection is enabled, otherwise false.
1418
+ */
1419
+ get allowCellSelect(): boolean;
1420
+ set allowScroll(arg: boolean);
1421
+ /**
1422
+ * Gets or sets a value, indicating whether scrolling is enabled.
1423
+ * @type {Boolean}
1424
+ * @summary True if inplace scrolling is enabled, otherwise false.
1425
+ */
1426
+ get allowScroll(): boolean;
1427
+ set filter(arg: any);
1428
+ get filter(): any;
1429
+ onScroll(e: any): boolean;
1430
+ headerMouseOver(e: any): void;
1431
+ headerMouseLeave(e: any): void;
1432
+ columnHeaderContextMenu(e: any): void;
1433
+ contextMenu: import("@mindfusion/common-ui").Menu;
1434
+ columnHeaderMouseDown(e: any): void;
1435
+ columnHeaderClicked(e: any): void;
1436
+ set focusedCell(arg: GridCell);
1437
+ /**
1438
+ * Gets the active grid cell.
1439
+ * @type {GridCell}
1440
+ * @summary the cell.
1441
+ */
1442
+ get focusedCell(): GridCell;
1443
+ rowHeaderMouseDown(e: any): void;
1444
+ rowHeaderContextMenu(e: any): void;
1445
+ contextMenuCallback(item: any): void;
1446
+ tableKeyDown(e: any): void;
1447
+ tableKeyUp(e: any): void;
1448
+ tableCellClicked(e: any): void;
1449
+ /**
1450
+ * Gets the cell at the provided coordinates, if it is focusable, or the nearest focusable cell in the specified direction.
1451
+ * @param {Number} row The cell row.
1452
+ * @param {Number} column The cell column.
1453
+ * @param {Boolean} back True to search backwards.
1454
+ * @private
1455
+ */
1456
+ private getFocusableCell;
1457
+ moveFocusedCell(row: any, column: any, back: any): void;
1458
+ moveFocusedCellLeft(): void;
1459
+ moveFocusedCellRight(): void;
1460
+ get focusedItem(): GridCell | {
1461
+ row: any;
1462
+ column: number;
1463
+ };
1464
+ /**
1465
+ * Gets the DOM element of the cell in the specified coordinates.
1466
+ * @param {Number} row The cell row.
1467
+ * @param {Number} column The cell column.
1468
+ * @returns {HTMLDivElement} the cell's DOM element.
1469
+ */
1470
+ getCellElement(row: number, column: number): HTMLDivElement;
1471
+ /**
1472
+ * Gets the DOM element of the specified row.
1473
+ * @param {Number} row The row index.
1474
+ * @returns {HTMLDivElement} the row's DOM element.
1475
+ */
1476
+ getRowElement(row: number): HTMLDivElement;
1477
+ /**
1478
+ * Checks if the row at the specified index is currently visible.
1479
+ * @param {Number} row The row index.
1480
+ * @returns {Boolean} True if the row is visible, otherwise false.
1481
+ */
1482
+ isRowVisible(row: number): boolean;
1483
+ isCellVisible(row: any, column: any): boolean;
1484
+ /**
1485
+ * Scrolls to the specified row.
1486
+ * @param {Number} row The row.
1487
+ * @private
1488
+ */
1489
+ private bringRowIntoView;
1490
+ isRepainting: boolean;
1491
+ /**
1492
+ * Ensures that the specified row is visible.
1493
+ * @param {Number} row The row.
1494
+ */
1495
+ bringIntoView(row: number): Promise<any>;
1496
+ /**
1497
+ * Applies an additional translate transform to the data table when scrolling
1498
+ * to the first or last row, if the row is partly visible.
1499
+ * @param {Number} row The relative row index.
1500
+ * @private
1501
+ */
1502
+ private scrollFix;
1503
+ /**
1504
+ * Checks if the row at the specified index is a group row.
1505
+ * @param {Number} row The row index.
1506
+ * @private
1507
+ */
1508
+ private isGroupRow;
1509
+ /**
1510
+ * Scrolls to the specified row.
1511
+ * @param {Number} row The row index.
1512
+ * @private
1513
+ */
1514
+ private scrollToRow;
1515
+ /**
1516
+ * Disposes the active grid cell editor.
1517
+ */
1518
+ disposeActiveEditor(): void;
1519
+ set activeEditor(arg: any);
1520
+ /**
1521
+ * Gets the active editor.
1522
+ * @type {Object}
1523
+ * @summary The editor.
1524
+ */
1525
+ get activeEditor(): any;
1526
+ /**
1527
+ * Gets the index of the last grid row.
1528
+ * @private
1529
+ */
1530
+ private get lastRowIndex();
1531
+ /**
1532
+ * Gets the height of rows viewport.
1533
+ * @type {Number}
1534
+ * @summary The height.
1535
+ * @private
1536
+ */
1537
+ private get contentHeight();
1538
+ /**
1539
+ * Gets the height of rows viewport minus the horizontal scrollbar height.
1540
+ * @type {Number}
1541
+ * @summary The height.
1542
+ * @private
1543
+ */
1544
+ private get contentClientHeight();
1545
+ set uiThemesPath(arg: string);
1546
+ /**
1547
+ * Gets or sets the path to the control's css themes.
1548
+ * @type {String}
1549
+ * @summary A string specifying the path.
1550
+ * @remarks Only applies to web components.
1551
+ */
1552
+ get uiThemesPath(): string;
1553
+ _uiThemesPath: string;
1554
+ /**
1555
+ * Gets the width of the specified grid column.
1556
+ * @param {Number} column The column index.
1557
+ * @returns {Number} The width in pixels.
1558
+ */
1559
+ getColumnWidth(column: number): number;
1560
+ /**
1561
+ * Sets the width of the specified grid column.
1562
+ * @param {Number} column The column index.
1563
+ * @param {Number} width The width in pixels.
1564
+ */
1565
+ setColumnWidth(column: number, width: number): void;
1566
+ /**
1567
+ * Disposes the current context menu.
1568
+ */
1569
+ disposeContextMenu(): void;
1570
+ /**
1571
+ * Sets selected rows after raising selection events.
1572
+ * @private
1573
+ */
1574
+ private setRowSelection;
1575
+ /**
1576
+ * Gets the row with the specified key.
1577
+ * @param {Object} key The key.
1578
+ * @returns {Number} The row index.
1579
+ */
1580
+ getKeyRow(key: any): number;
1581
+ /**
1582
+ * Gets the key of the row at the specified index.
1583
+ * @param {Number} index The row index.
1584
+ * @returns {Object} The row key.
1585
+ */
1586
+ getRowKey(index: number): any;
1587
+ /**
1588
+ * Recalculates grid's dimensions.
1589
+ * @remarks Use this method to recalculate the grid's dimensions after resizing.
1590
+ */
1591
+ adjust(): void;
1592
+ /**
1593
+ * For internal use only.
1594
+ * @private
1595
+ */
1596
+ private onResize;
1597
+ onMouseWheel(e: any): void;
1598
+ timeStamp: number;
1599
+ /**
1600
+ * Raises the corresponding validation event when a row action is performed.
1601
+ * @private
1602
+ */
1603
+ private onRowValidateAction;
1604
+ /**
1605
+ * Raises the corresponding notification event after a row action is performed.
1606
+ * @private
1607
+ */
1608
+ private onRowAction;
1609
+ onCellAction(row: any, column: any, value: any, displayValue: any): void;
1610
+ /**
1611
+ * Adds an event to the queued events that will be raised after the grid finished repainting.
1612
+ * @private
1613
+ */
1614
+ private queueEvent;
1615
+ /**
1616
+ * Raises all queued events.
1617
+ * @private
1618
+ */
1619
+ private raiseQueuedEvents;
1620
+ /**
1621
+ * Raises the rowCommand event.
1622
+ * @private
1623
+ */
1624
+ private onRowCommand;
1625
+ /**
1626
+ * Raised when a row data is loading.
1627
+ * @event rowLoading
1628
+ * @type {EventDispatcher}
1629
+ * @property {Grid} sender
1630
+ * @property {RowModifyingEventArgs} args
1631
+ */
1632
+ get rowLoading(): EventDispatcher;
1633
+ /**
1634
+ * Raised when a row is rendered.
1635
+ * @event rowRendered
1636
+ * @type {EventDispatcher}
1637
+ * @property {Grid} sender
1638
+ * @property {RowModifiedEventArgs} args
1639
+ */
1640
+ get rowRendered(): EventDispatcher;
1641
+ /**
1642
+ * Raised before a row is selected.
1643
+ * @event rowSelecting
1644
+ * @type {EventDispatcher}
1645
+ * @property {Grid} sender
1646
+ * @property {RowModifyingEventArgs} args
1647
+ */
1648
+ get rowSelecting(): EventDispatcher;
1649
+ /**
1650
+ * Raised when a row is selected.
1651
+ * @event rowSelected
1652
+ * @type {EventDispatcher}
1653
+ * @property {Grid} sender
1654
+ * @property {RowModifiedEventArgs} args
1655
+ */
1656
+ get rowSelected(): EventDispatcher;
1657
+ /**
1658
+ * Raised before a new row is created.
1659
+ * @event rowCreating
1660
+ * @type {EventDispatcher}
1661
+ * @property {Grid} sender
1662
+ * @property {RowModifyingEventArgs} args
1663
+ */
1664
+ get rowCreating(): EventDispatcher;
1665
+ /**
1666
+ * Raised when a new row is created.
1667
+ * @event rowCreated
1668
+ * @type {EventDispatcher}
1669
+ * @property {Grid} sender
1670
+ * @property {RowModifiedEventArgs} args
1671
+ */
1672
+ get rowCreated(): EventDispatcher;
1673
+ /**
1674
+ * Raised before a row is deleted.
1675
+ * @event rowDeleting
1676
+ * @type {EventDispatcher}
1677
+ * @property {Grid} sender
1678
+ * @property {RowModifyingEventArgs} args
1679
+ */
1680
+ get rowDeleting(): EventDispatcher;
1681
+ /**
1682
+ * Raised when a row is deleted.
1683
+ * @event rowDeleted
1684
+ * @type {EventDispatcher}
1685
+ * @property {Grid} sender
1686
+ * @property {RowModifiedEventArgs} args
1687
+ */
1688
+ get rowDeleted(): EventDispatcher;
1689
+ /**
1690
+ * Raised before a row is updated.
1691
+ * @event rowUpdating
1692
+ * @type {EventDispatcher}
1693
+ * @property {Grid} sender
1694
+ * @property {RowModifyingEventArgs} args
1695
+ */
1696
+ get rowUpdating(): EventDispatcher;
1697
+ /**
1698
+ * Raised when a row is updated.
1699
+ * @event rowUpdated
1700
+ * @type {EventDispatcher}
1701
+ * @property {Grid} sender
1702
+ * @property {RowModifiedEventArgs} args
1703
+ */
1704
+ get rowUpdated(): EventDispatcher;
1705
+ /**
1706
+ * Raised before a cell is selected.
1707
+ * @event cellSelecting
1708
+ * @type {EventDispatcher}
1709
+ * @property {Grid} sender
1710
+ * @property {CellEventArgs} args
1711
+ */
1712
+ get cellSelecting(): EventDispatcher;
1713
+ /**
1714
+ * Raises the onCellSelecting event.
1715
+ * @private
1716
+ */
1717
+ private onCellSelecting;
1718
+ /**
1719
+ * Raised when a cell is selected.
1720
+ * @event cellSelected
1721
+ * @type {EventDispatcher}
1722
+ * @property {Grid} sender
1723
+ * @property {CellEventArgs} args
1724
+ */
1725
+ get cellSelected(): EventDispatcher;
1726
+ /**
1727
+ * Raises the cellSelected event.
1728
+ * @private
1729
+ */
1730
+ private onCellSelected;
1731
+ /**
1732
+ * Raised before a cell is focused.
1733
+ * @event cellFocusing
1734
+ * @type {EventDispatcher}
1735
+ * @property {Grid} sender
1736
+ * @property {CellEventArgs} args
1737
+ */
1738
+ get cellFocusing(): EventDispatcher;
1739
+ /**
1740
+ * Raises the cellFocusing event.
1741
+ * @private
1742
+ */
1743
+ private onCellFocusing;
1744
+ /**
1745
+ * Raised when a cell is focused.
1746
+ * @event cellFocused
1747
+ * @type {EventDispatcher}
1748
+ * @property {Grid} sender
1749
+ * @property {CellEventArgs} args
1750
+ */
1751
+ get cellFocused(): EventDispatcher;
1752
+ /**
1753
+ * Raises the cellFocused event.
1754
+ * @private
1755
+ */
1756
+ private onCellFocused;
1757
+ /**
1758
+ * Raises the customDrawCell event.
1759
+ * @private
1760
+ */
1761
+ private onCustomDrawCell;
1762
+ /**
1763
+ * Raised when a cell's contents are about to be rendered, to allow custom drawing.
1764
+ * @event customDrawCell
1765
+ * @type {EventDispatcher}
1766
+ * @property {Grid} sender
1767
+ * @property {CellCustomDrawEventArgs} args
1768
+ */
1769
+ get customDrawCell(): EventDispatcher;
1770
+ /**
1771
+ * Raises the customDrawHeader event.
1772
+ * @private
1773
+ */
1774
+ private onCustomDrawHeader;
1775
+ /**
1776
+ * Raised when a header cell's contents are about to be rendered, to allow custom drawing.
1777
+ * @event customDrawHeader
1778
+ * @type {EventDispatcher}
1779
+ * @property {Grid} sender
1780
+ * @property {CellCustomDrawEventArgs} args
1781
+ */
1782
+ get customDrawHeader(): EventDispatcher;
1783
+ /**
1784
+ * Raised when a command is executed on a row.
1785
+ * @event rowCommand
1786
+ * @type {EventDispatcher}
1787
+ * @property {Grid} sender
1788
+ * @property {RowModifyingEventArgs} args
1789
+ */
1790
+ get rowCommand(): EventDispatcher;
1791
+ /**
1792
+ * Raised when the data type of a cell in a DynamicType column has to be resolved.
1793
+ * @event resolveCellDataType
1794
+ * @type {EventDispatcher}
1795
+ * @property {Grid} sender
1796
+ * @property {CellResolveEventArgs} args
1797
+ */
1798
+ get resolveCellDataType(): EventDispatcher;
1799
+ /**
1800
+ * Raised when the value of a cell in a DynamicType column is retrieved.
1801
+ * @event getCellValue
1802
+ * @type {EventDispatcher}
1803
+ * @property {Grid} sender
1804
+ * @property {CellResolveEventArgs} args
1805
+ */
1806
+ get getCellValue(): EventDispatcher;
1807
+ /**
1808
+ * Raised when the data type of a cell in a DynamicType column has to be resolved.
1809
+ * @event resolveCellDataType
1810
+ * @type {EventDispatcher}
1811
+ * @property {Grid} sender
1812
+ * @property {CellResolveEventArgs} args
1813
+ */
1814
+ get resolveCellMetaData(): EventDispatcher;
1815
+ /**
1816
+ * Raised when the value of a cell in a DynamicType column has to be formatted.
1817
+ * @event formatCellValue
1818
+ * @type {EventDispatcher}
1819
+ * @property {Grid} sender
1820
+ * @property {CellResolveEventArgs} args
1821
+ */
1822
+ get formatCellValue(): EventDispatcher;
1823
+ /**
1824
+ * Raised when an expander button is clicked
1825
+ * @private
1826
+ */
1827
+ private get objectButtonClick();
1828
+ connectedCallback(): void;
1829
+ }
1830
+ import { UIControl } from "DataViews/jsdv/src/UIControl";
1831
+ import { Unit } from "@mindfusion/common";
1832
+ import ProxyModel from "DataViews/jsdv/src/ProxyModel";
1833
+ import Selection from "DataViews/jsdv/src/Selection";
1834
+ import { EventDispatcher } from "@mindfusion/controls";
1835
+ import { GridModel } from "DataViews/jsdv/src/GridModel";
1836
+ import { GridCell } from "DataViews/jsdv/src/GridCell";
1837
+ }
1838
+ declare module "DataViews/jsdv/src/GridColumn" {
1839
+ /**
1840
+ * @class Represents a column in a grid control.
1841
+ */
1842
+ export class GridColumn {
1843
+ /**
1844
+ * Initializes a new instance of the GridColumn class.
1845
+ * @constructor
1846
+ * @param {String} [name] The name of the field, displayed in the column.
1847
+ * @param {DataType} [dataType] The type of the column.
1848
+ * @param {Boolean} [editable] A value indicating whether the cells in this column can be edited.
1849
+ */
1850
+ constructor(name?: string, dataType?: any, editable?: boolean);
1851
+ _name: string;
1852
+ _dataType: any;
1853
+ _metaData: Map<any, any>;
1854
+ _editable: boolean;
1855
+ _sortable: boolean;
1856
+ _hidden: boolean;
1857
+ set name(arg: string);
1858
+ /**
1859
+ * Gets or sets the name of the field, displayed in the column.
1860
+ * @type {String}
1861
+ * @summary The field name.
1862
+ */
1863
+ get name(): string;
1864
+ set dataType(arg: any);
1865
+ /**
1866
+ * Gets or sets the type of this column.
1867
+ * @type {DataType}
1868
+ * @summary The type.
1869
+ */
1870
+ get dataType(): any;
1871
+ set metaData(arg: Map<any, any>);
1872
+ /**
1873
+ * Gets or sets the metadata, associated with this column.
1874
+ * @type {Map}
1875
+ * @summary The metadata.
1876
+ */
1877
+ get metaData(): Map<any, any>;
1878
+ set caption(arg: string);
1879
+ /**
1880
+ * Gets or sets the text, diplayed in the header of this column.
1881
+ * @type {String}
1882
+ * @summary The display text.
1883
+ */
1884
+ get caption(): string;
1885
+ _caption: string;
1886
+ set editable(arg: boolean);
1887
+ /**
1888
+ * Gets or sets a value, indicating whether the cells in this column can be edited.
1889
+ * @type {Boolean}
1890
+ * @summary True if the cells in this column can be edited, otherwise false.
1891
+ */
1892
+ get editable(): boolean;
1893
+ set sortable(arg: boolean);
1894
+ /**
1895
+ * Gets or sets a value, indicating whether this column can be sorted.
1896
+ * @type {Boolean}
1897
+ * @summary True if the column can be sorted, otherwise false.
1898
+ */
1899
+ get sortable(): boolean;
1900
+ set hidden(arg: boolean);
1901
+ /**
1902
+ * Gets or sets a value, indicating whether this column is hidden.
1903
+ * @type {Boolean}
1904
+ * @summary True if the column is hidden, otherwise false.
1905
+ */
1906
+ get hidden(): boolean;
1907
+ }
1908
+ }
1909
+ declare module "DataViews/jsdv/src/PropertyGridModel" {
1910
+ /**
1911
+ * @class Represents the grid model of the PropertyGrid control.
1912
+ * @private
1913
+ */
1914
+ export class PropertyGridModel extends ArrayModel {
1915
+ /**
1916
+ * Initializes a new instance of the PropertyGridModel class.
1917
+ * @constructor
1918
+ * @param {Array} values The array to use as a backing store.
1919
+ * @param {Map} meta The meta data dictionary.
1920
+ */
1921
+ constructor(values: any[], meta: Map<any, any>);
1922
+ }
1923
+ import { ArrayModel } from "DataViews/jsdv/src/ArrayModel";
1924
+ }
1925
+ declare module "DataViews/jsdv/src/CollectionType" {
1926
+ /**
1927
+ * @class Provides functionality for grid cells that display collection objects.
1928
+ * @augments ObjectType
1929
+ */
1930
+ export class CollectionType extends ObjectType {
1931
+ static format(value: any, meta: any): string;
1932
+ }
1933
+ import { ObjectType } from "DataViews/jsdv/src/ObjectType";
1934
+ }
1935
+ declare module "DataViews/jsdv/src/PropertyGridContent" {
1936
+ /**
1937
+ * @class Represents a content grid in a PropertyGrid control.
1938
+ * @augments UIControl
1939
+ */
1940
+ export class PropertyGridContent extends UIControl {
1941
+ /**
1942
+ * Initializes a new instance of the PropertyGridContent class.
1943
+ * @constructor
1944
+ * @param {Object} obj The object whose properties will be shown in the grid.
1945
+ */
1946
+ constructor(obj: any);
1947
+ _defaultWidth: Unit;
1948
+ _defaultHeight: Unit;
1949
+ _selectedObject: any;
1950
+ _model: any;
1951
+ _proxyModel: ProxyModel;
1952
+ _metaData: Map<any, any>;
1953
+ _excludedProperties: string[];
1954
+ _allowEdit: boolean;
1955
+ _allowCellSelect: boolean;
1956
+ _allowScroll: boolean;
1957
+ _filter: any;
1958
+ _sortedColumn: number;
1959
+ _sortAscending: boolean;
1960
+ renderer: GridRenderer;
1961
+ _scrollRow: number;
1962
+ _columnWidths: any[];
1963
+ _rowHeaderWidth: number;
1964
+ _focusedCell: any;
1965
+ _activeEditor: any;
1966
+ _tableShouldFocus: boolean;
1967
+ _searchString: string;
1968
+ _scrollBarSize: number;
1969
+ selection: Selection;
1970
+ queuedEvents: any[];
1971
+ _expandObject: EventDispatcher;
1972
+ _columnSorted: EventDispatcher;
1973
+ _groupingChanged: EventDispatcher;
1974
+ _rowLoading: EventDispatcher;
1975
+ _rowRendered: EventDispatcher;
1976
+ _rowExpanding: EventDispatcher;
1977
+ _rowExpanded: EventDispatcher;
1978
+ _rowCreating: EventDispatcher;
1979
+ _rowCreated: EventDispatcher;
1980
+ _rowDeleting: EventDispatcher;
1981
+ _rowDeleted: EventDispatcher;
1982
+ _rowUpdating: EventDispatcher;
1983
+ _rowUpdated: EventDispatcher;
1984
+ _rowSelecting: EventDispatcher;
1985
+ _rowSelected: EventDispatcher;
1986
+ _cellSelecting: EventDispatcher;
1987
+ _cellSelected: EventDispatcher;
1988
+ _cellFocusing: EventDispatcher;
1989
+ _cellFocused: EventDispatcher;
1990
+ scrollHandler: (e: any) => boolean;
1991
+ mouseWheelHandler: (e: any) => void;
1992
+ get wrapper(): Element;
1993
+ /**
1994
+ * Returns a reference to the grid header DOM element.
1995
+ * @type {HTMLDivElement} The header element.
1996
+ */
1997
+ get header(): HTMLDivElement;
1998
+ /**
1999
+ * Returns a reference to the grid data table DOM element.
2000
+ * @returns {HTMLDivElement} The data table element.
2001
+ */
2002
+ get dataTable(): HTMLDivElement;
2003
+ /**
2004
+ * Returns the array of DOM elements of the visible rows.
2005
+ * @returns {Array} An array of row DOM elements.
2006
+ * @private
2007
+ */
2008
+ private get visibleRows();
2009
+ /**
2010
+ * Returns the array of DOM elements of the visible cells.
2011
+ * @returns {Array} A two-dimensional array of cell DOM elements.
2012
+ * @private
2013
+ */
2014
+ private get visibleCells();
2015
+ rowHeaderMouseDown(e: any): void;
2016
+ set focusedCell(arg: GridCell);
2017
+ /**
2018
+ * Gets the active grid cell.
2019
+ * @type {GridCell}
2020
+ * @summary the cell.
2021
+ */
2022
+ get focusedCell(): GridCell;
2023
+ scroll: Element;
2024
+ resizeHandler: (e: any) => void;
2025
+ /**
2026
+ * Called before the grid contents are rendered by the current renderer.
2027
+ * @private
2028
+ */
2029
+ private onBeforeRender;
2030
+ /**
2031
+ * Called after the grid contents are rendered by the current renderer.
2032
+ * @private
2033
+ */
2034
+ private onAfterRender;
2035
+ rowsCount: number;
2036
+ rowHeight: number;
2037
+ /**
2038
+ * Repaints the grid contents.
2039
+ * @param {Boolean} [selected] True to repaint only the selected rows.
2040
+ */
2041
+ refresh(selected?: boolean): Promise<any>;
2042
+ /**
2043
+ * Sets the focus to the cell at the specified position.
2044
+ * @param {Number} row The cell row.
2045
+ * @param {Number} column The cell column.
2046
+ * @param {Boolean} [moveBackwards] True to move backwards.
2047
+ * @remarks If the cell at the specified position is not editable, the focus is set
2048
+ * to the next editable cell, if such exists.
2049
+ */
2050
+ focusCell(row: number, column: number, moveBackwards?: boolean): void;
2051
+ /**
2052
+ * Selects the cell at the specified position.
2053
+ * @param {Number} row The cell row.
2054
+ * @param {Number} column The cell column.
2055
+ */
2056
+ selectCell(row: number, column: number): void;
2057
+ /**
2058
+ * Selects the rows in the specified range.
2059
+ * @param {Number} index The start index of the range to select.
2060
+ * @param {Number} [count] The length of the range.
2061
+ */
2062
+ selectRows(index: number, count?: number): void;
2063
+ /**
2064
+ * Gets the indices of selected rows.
2065
+ * @returns {Array} An array of indices.
2066
+ */
2067
+ get selectedRowIndices(): any[];
2068
+ /**
2069
+ * Gets the selected cells.
2070
+ * @type {Array}
2071
+ * @summary An array of GridCell instances.
2072
+ */
2073
+ get selectedCells(): any[];
2074
+ /**
2075
+ * Invalidates the current renderer.
2076
+ * @private
2077
+ */
2078
+ private invalidateDom;
2079
+ /**
2080
+ * Repaints a range of rows.
2081
+ * @param {Number} index The start index of the row range to repaint.
2082
+ * @param {Number} [count] The length of the range.
2083
+ */
2084
+ refreshRows(index: number, count?: number): Promise<any>;
2085
+ addRow(): void;
2086
+ removeRowRange(index: any, count: any): void;
2087
+ scrollRangeInvalid: boolean;
2088
+ /**
2089
+ * Sorts by the specified column and sort direction.
2090
+ * @param {Number} index The index of the column to sort by, or null to clear the sorting.
2091
+ * @param {Boolean} [sortAscending] True to sort ascending, otherwise false.
2092
+ */
2093
+ sortByColumn(index: number, sortAscending?: boolean): void;
2094
+ set sortedColumn(arg: number);
2095
+ /**
2096
+ * Gets or sets the index of the column, by which the data is sorted.
2097
+ * @type {Number}
2098
+ * @summary The column index, or -1 if no sorting is applied to the grid.
2099
+ */
2100
+ get sortedColumn(): number;
2101
+ set sortAscending(arg: boolean);
2102
+ /**
2103
+ * Gets or sets a value, indicating whether the sorting is in Ascending order.
2104
+ * @type {Boolean}
2105
+ * @summary True if the sorting is in Ascending order, otherwise false.
2106
+ */
2107
+ get sortAscending(): boolean;
2108
+ /**
2109
+ * Groups by the specified column.
2110
+ * @param {Number} index The index of the column to group by, or null to clear the grouping.
2111
+ */
2112
+ groupByColumn(index: number): void;
2113
+ private set groupColumn(arg);
2114
+ /**
2115
+ * Gets the index of the column, by which the data is grouped.
2116
+ * @returns {Number} The column index, or -1 if no grouping is applied to the grid.
2117
+ * @private
2118
+ */
2119
+ private get groupColumn();
2120
+ /**
2121
+ * Calculates the scroll fix amount.
2122
+ * @private
2123
+ */
2124
+ private calcScrollFix;
2125
+ scrollFixAmount: number;
2126
+ /**
2127
+ * Updates the scroll range based on current rows count and height.
2128
+ * @private
2129
+ */
2130
+ private updateScrollRange;
2131
+ scrollIncrement: number;
2132
+ /**
2133
+ * Sets equal column widths in pixels based on flex calculations.
2134
+ * @private
2135
+ */
2136
+ private initColumnWidths;
2137
+ /**
2138
+ * For internal use only.
2139
+ * @private
2140
+ */
2141
+ private resizeColumn;
2142
+ set model(arg: any);
2143
+ /**
2144
+ * Gets or sets the effective data model of this grid.
2145
+ * @type {GridModel}
2146
+ * @summary The model.
2147
+ */
2148
+ get model(): any;
2149
+ getAllPropertyDescriptors(obj: any): any;
2150
+ set selectedObject(arg: any);
2151
+ get selectedObject(): any;
2152
+ generateData(values: any): void;
2153
+ /**
2154
+ * Sets the metadata, associated with this grid.
2155
+ * @param {Map} value The metadata.
2156
+ */
2157
+ set metaData(arg: Map<any, any>);
2158
+ /**
2159
+ * Gets the metadata, associated with this grid.
2160
+ * @returns {Map} The metadata.
2161
+ */
2162
+ get metaData(): Map<any, any>;
2163
+ /**
2164
+ * Gets a value indicating whether to enumerate the properties that don't have setters.
2165
+ * @type {Boolean}
2166
+ * @summary True to enumerate read-only properties, otherwise false.
2167
+ */
2168
+ get showAllProperties(): boolean;
2169
+ /**
2170
+ * Gets a value indicating whether to enumerate the properties that don't have setters.
2171
+ * @type {Boolean}
2172
+ * @summary True to enumerate read-only properties, otherwise false.
2173
+ */
2174
+ get showReadonlyProperties(): boolean;
2175
+ /**
2176
+ * Gets a value indicating whether properties that don't have setters can be edited.
2177
+ * @type {Boolean}
2178
+ * @summary True if read-only properties can be edited, otherwise false.
2179
+ */
2180
+ get editReadonlyProperties(): boolean;
2181
+ /**
2182
+ * Refreshes the grid after external modifications to the grid model.
2183
+ */
2184
+ rebind(): void;
2185
+ set scrollRow(arg: number);
2186
+ /**
2187
+ * Gets or sets the index of the first visible row.
2188
+ * @type {Number}
2189
+ * @summary The row index.
2190
+ */
2191
+ get scrollRow(): number;
2192
+ get effectiveModel(): any;
2193
+ ensureProxyModel(): void;
2194
+ set allowEdit(arg: boolean);
2195
+ /**
2196
+ * Gets or sets a value, indicating whether inplace editing is enabled.
2197
+ * @type {Boolean}
2198
+ * @summary True if inplace editing is enabled, otherwise false.
2199
+ */
2200
+ get allowEdit(): boolean;
2201
+ set allowCellSelect(arg: boolean);
2202
+ /**
2203
+ * Gets or sets a value, indicating whether single cell selection is enabled.
2204
+ * @type {Boolean}
2205
+ * @summary True if single cell selection is enabled, otherwise false.
2206
+ */
2207
+ get allowCellSelect(): boolean;
2208
+ set allowScroll(arg: boolean);
2209
+ /**
2210
+ * Gets or sets a value, indicating whether scrolling is enabled.
2211
+ * @type {Boolean}
2212
+ * @summary True if inplace scrolling is enabled, otherwise false.
2213
+ */
2214
+ get allowScroll(): boolean;
2215
+ set filter(arg: any);
2216
+ get filter(): any;
2217
+ _groupColumn: any;
2218
+ onScroll(e: any): boolean;
2219
+ headerMouseOver(e: any): void;
2220
+ headerMouseLeave(e: any): void;
2221
+ columnHeaderMouseDown(e: any): void;
2222
+ rowHeaderContextMenu(e: any, selection: any): void;
2223
+ contextMenu: import("@mindfusion/common-ui").Menu;
2224
+ contextMenuCallback(item: any): void;
2225
+ /**
2226
+ * Disposes the current context menu.
2227
+ */
2228
+ disposeContextMenu(): void;
2229
+ tableKeyDown(e: any): void;
2230
+ _clearSearchTimeout: number;
2231
+ autoSearch(searchString: any): void;
2232
+ tableKeyUp(e: any): void;
2233
+ tableCellClicked(e: any): void;
2234
+ getNextFocusableRow(row: any, back: any): any;
2235
+ /**
2236
+ * Gets the cell at the provided coordinates, if it is focusable, or the nearest focusable cell in the specified direction.
2237
+ * @param {Number} row The cell row.
2238
+ * @param {Number} column The cell column.
2239
+ * @param {Boolean} back True to search backwards.
2240
+ * @private
2241
+ */
2242
+ private getFocusableCell;
2243
+ moveFocusedCell(row: any, column: any, back: any): void;
2244
+ moveFocusedCellLeft(): void;
2245
+ moveFocusedCellRight(): void;
2246
+ get focusedItem(): GridCell | {
2247
+ row: any;
2248
+ column: number;
2249
+ };
2250
+ get firstFocusableColumn(): number;
2251
+ get lastFocusableColumn(): number;
2252
+ /**
2253
+ * Gets the DOM element of the cell in the specified coordinates.
2254
+ * @param {Number} row The cell row.
2255
+ * @param {Number} column The cell column.
2256
+ * @returns {HTMLDivElement} the cell's DOM element.
2257
+ */
2258
+ getCellElement(row: number, column: number): HTMLDivElement;
2259
+ /**
2260
+ * Gets the DOM element of the specified row.
2261
+ * @param {Number} row The row index.
2262
+ * @returns {HTMLDivElement} the row's DOM element.
2263
+ */
2264
+ getRowElement(row: number): HTMLDivElement;
2265
+ /**
2266
+ * Checks if the row at the specified index is currently visible.
2267
+ * @param {Number} row The row index.
2268
+ * @returns {Boolean} True if the row is visible, otherwise false.
2269
+ */
2270
+ isRowVisible(row: number): boolean;
2271
+ isCellVisible(row: any, column: any): boolean;
2272
+ /**
2273
+ * Scrolls to the specified row.
2274
+ * @param {Number} row The row.
2275
+ * @private
2276
+ */
2277
+ private bringRowIntoView;
2278
+ isRepainting: boolean;
2279
+ /**
2280
+ * Ensures that the specified row is visible.
2281
+ * @param {Number} row The row.
2282
+ */
2283
+ bringIntoView(row: number): Promise<any>;
2284
+ /**
2285
+ * Applies an additional translate transform to the data table when scrolling
2286
+ * to the first or last row, if the row is partly visible.
2287
+ * @param {Number} row The relative row index.
2288
+ * @private
2289
+ */
2290
+ private scrollFix;
2291
+ /**
2292
+ * Checks if the row at the specified index is a group row.
2293
+ * @param {Number} row The row index.
2294
+ * @private
2295
+ */
2296
+ private isGroupRow;
2297
+ /**
2298
+ * Scrolls to the specified row.
2299
+ * @param {Number} row The row index.
2300
+ * @private
2301
+ */
2302
+ private scrollToRow;
2303
+ /**
2304
+ * Disposes the active grid cell editor.
2305
+ */
2306
+ disposeActiveEditor(): void;
2307
+ set activeEditor(arg: any);
2308
+ /**
2309
+ * Gets the active editor.
2310
+ * @type {Object}
2311
+ * @summary The editor.
2312
+ */
2313
+ get activeEditor(): any;
2314
+ /**
2315
+ * Gets the index of the last grid row.
2316
+ * @private
2317
+ */
2318
+ private get lastRowIndex();
2319
+ /**
2320
+ * Gets the height of rows viewport.
2321
+ * @type {Number}
2322
+ * @summary The height.
2323
+ * @private
2324
+ */
2325
+ private get contentHeight();
2326
+ /**
2327
+ * Gets the height of rows viewport minus the horizontal scrollbar height.
2328
+ * @type {Number}
2329
+ * @summary The height.
2330
+ * @private
2331
+ */
2332
+ private get contentClientHeight();
2333
+ get parent(): any;
2334
+ /**
2335
+ * Gets the width of the specified grid column.
2336
+ * @param {Number} column The column index.
2337
+ * @returns {Number} The width in pixels.
2338
+ */
2339
+ getColumnWidth(column: number): number;
2340
+ /**
2341
+ * Sets the width of the first grid column.
2342
+ * @param {Number} width The width in pixels.
2343
+ */
2344
+ setColumnWidth(width: number): void;
2345
+ /**
2346
+ * Sets selected rows after raising selection events.
2347
+ * @private
2348
+ */
2349
+ private setRowSelection;
2350
+ /**
2351
+ * Gets the row with the specified key.
2352
+ * @param {Object} key The key.
2353
+ * @returns {Number} The row index.
2354
+ */
2355
+ getKeyRow(key: any): number;
2356
+ /**
2357
+ * Gets the key of the row at the specified index.
2358
+ * @param {Number} index The row index.
2359
+ * @returns {Object} The row key.
2360
+ */
2361
+ getRowKey(index: number): any;
2362
+ /**
2363
+ * Recalculates grid's dimensions.
2364
+ * @remarks Use this method to recalculate the grid's dimensions after resizing.
2365
+ */
2366
+ adjust(): void;
2367
+ /**
2368
+ * For internal use only.
2369
+ * @private
2370
+ */
2371
+ private onResize;
2372
+ onMouseWheel(e: any): void;
2373
+ timeStamp: number;
2374
+ /**
2375
+ * Raises the corresponding validation event when a row action is performed.
2376
+ * @private
2377
+ */
2378
+ private onRowValidateAction;
2379
+ /**
2380
+ * Raises the corresponding notification event after a row action is performed.
2381
+ * @private
2382
+ */
2383
+ private onRowAction;
2384
+ onCellAction(row: any, column: any): void;
2385
+ /**
2386
+ * Raised when a column is sorted.
2387
+ * @event columnSorted
2388
+ * @type {EventDispatcher}
2389
+ * @property {PropertyGridContent} sender
2390
+ * @property {Object} args
2391
+ */
2392
+ get columnSorted(): EventDispatcher;
2393
+ /**
2394
+ * Raised when a column is sorted.
2395
+ * @event groupingChanged
2396
+ * @type {EventDispatcher}
2397
+ * @property {PropertyGridContent} sender
2398
+ * @property {Object} args
2399
+ */
2400
+ get groupingChanged(): EventDispatcher;
2401
+ /**
2402
+ * Raised when a row data is loading.
2403
+ * @event rowLoading
2404
+ * @type {EventDispatcher}
2405
+ * @property {PropertyGridContent} sender
2406
+ * @property {RowModifyingEventArgs} args
2407
+ */
2408
+ get rowLoading(): EventDispatcher;
2409
+ /**
2410
+ * Raised when a row is rendered.
2411
+ * @event rowRendered
2412
+ * @type {EventDispatcher}
2413
+ * @property {PropertyGridContent} sender
2414
+ * @property {RowModifiedEventArgs} args
2415
+ */
2416
+ get rowRendered(): EventDispatcher;
2417
+ /**
2418
+ * Raised before a row is selected.
2419
+ * @event rowSelecting
2420
+ * @type {EventDispatcher}
2421
+ * @property {PropertyGridContent} sender
2422
+ * @property {RowModifyingEventArgs} args
2423
+ */
2424
+ get rowSelecting(): EventDispatcher;
2425
+ /**
2426
+ * Raised when a row is selected.
2427
+ * @event rowSelected
2428
+ * @type {EventDispatcher}
2429
+ * @property {PropertyGridContent} sender
2430
+ * @property {RowModifiedEventArgs} args
2431
+ */
2432
+ get rowSelected(): EventDispatcher;
2433
+ /**
2434
+ * Raised before a row is expanded.
2435
+ * @event rowExpanding
2436
+ * @type {EventDispatcher}
2437
+ * @property {PropertyGridContent} sender
2438
+ * @property {RowModifyingEventArgs} args
2439
+ */
2440
+ get rowExpanding(): EventDispatcher;
2441
+ /**
2442
+ * Raised when a row is expanded.
2443
+ * @event rowExpanded
2444
+ * @type {EventDispatcher}
2445
+ * @property {PropertyGridContent} sender
2446
+ * @property {RowModifiedEventArgs} args
2447
+ */
2448
+ get rowExpanded(): EventDispatcher;
2449
+ /**
2450
+ * Raised before a new row is created.
2451
+ * @event rowCreating
2452
+ * @type {EventDispatcher}
2453
+ * @property {PropertyGridContent} sender
2454
+ * @property {RowModifyingEventArgs} args
2455
+ */
2456
+ get rowCreating(): EventDispatcher;
2457
+ /**
2458
+ * Raised when a new row is created.
2459
+ * @event rowCreated
2460
+ * @type {EventDispatcher}
2461
+ * @property {PropertyGridContent} sender
2462
+ * @property {RowModifiedEventArgs} args
2463
+ */
2464
+ get rowCreated(): EventDispatcher;
2465
+ /**
2466
+ * Raised before a row is deleted.
2467
+ * @event rowDeleting
2468
+ * @type {EventDispatcher}
2469
+ * @property {PropertyGridContent} sender
2470
+ * @property {RowModifyingEventArgs} args
2471
+ */
2472
+ get rowDeleting(): EventDispatcher;
2473
+ /**
2474
+ * Raised when a row is deleted.
2475
+ * @event rowDeleted
2476
+ * @type {EventDispatcher}
2477
+ * @property {PropertyGridContent} sender
2478
+ * @property {RowModifiedEventArgs} args
2479
+ */
2480
+ get rowDeleted(): EventDispatcher;
2481
+ /**
2482
+ * Raised before a row is updated.
2483
+ * @event rowUpdating
2484
+ * @type {EventDispatcher}
2485
+ * @property {PropertyGridContent} sender
2486
+ * @property {RowModifyingEventArgs} args
2487
+ */
2488
+ get rowUpdating(): EventDispatcher;
2489
+ /**
2490
+ * Raised when a row is updated.
2491
+ * @event rowUpdated
2492
+ * @type {EventDispatcher}
2493
+ * @property {PropertyGridContent} sender
2494
+ * @property {RowModifiedEventArgs} args
2495
+ */
2496
+ get rowUpdated(): EventDispatcher;
2497
+ /**
2498
+ * Raised before a cell is selected.
2499
+ * @event cellSelecting
2500
+ * @type {EventDispatcher}
2501
+ * @property {PropertyGridContent} sender
2502
+ * @property {CellEventArgs} args
2503
+ */
2504
+ get cellSelecting(): EventDispatcher;
2505
+ /**
2506
+ * Raises the onCellSelecting event.
2507
+ * @private
2508
+ */
2509
+ private onCellSelecting;
2510
+ /**
2511
+ * Raised when a cell is selected.
2512
+ * @event cellSelected
2513
+ * @type {EventDispatcher}
2514
+ * @property {Grid} sender
2515
+ * @property {CellEventArgs} args
2516
+ */
2517
+ get cellSelected(): EventDispatcher;
2518
+ /**
2519
+ * Raises the cellSelected event.
2520
+ * @private
2521
+ */
2522
+ private onCellSelected;
2523
+ onCellFocusing(cell: any): boolean;
2524
+ onCellFocused(): void;
2525
+ onRowRender(row: any): void;
2526
+ cellReadonly(row: any, column: any): boolean;
2527
+ onCustomDrawHeader(row: any, column: any, defaultContent: any): any;
2528
+ onCustomDrawCell(row: any, column: any, defaultContent: any): any;
2529
+ }
2530
+ import { UIControl } from "DataViews/jsdv/src/UIControl";
2531
+ import { Unit } from "@mindfusion/common";
2532
+ import ProxyModel from "DataViews/jsdv/src/ProxyModel";
2533
+ import GridRenderer from "DataViews/jsdv/src/GridRenderer";
2534
+ import Selection from "DataViews/jsdv/src/Selection";
2535
+ import { EventDispatcher } from "@mindfusion/controls";
2536
+ import { GridCell } from "DataViews/jsdv/src/GridCell";
2537
+ }
2538
+ declare module "DataViews/jsdv/src/PropertyGridPage" {
2539
+ /**
2540
+ * @class Represents a page in a PropertyGrid control.
2541
+ * @augments ListItem
2542
+ * @private
2543
+ */
2544
+ export class PropertyGridPage extends ListItem {
2545
+ /**
2546
+ * Initializes a new instance of the PropertyGridPage class.
2547
+ * @constructor
2548
+ * @param {String} propertyName The property name.
2549
+ * @param {Number} index The index of the oject within its collection.
2550
+ * @param {Object} obj The object which properties will be shown in the page.
2551
+ * @param {Map} meta The meta data dictionary, associated with this object.
2552
+ * @param {Boolean} main Indicates whether this page is the control's main page.
2553
+ */
2554
+ constructor(propertyName: string, index: number, obj: any, meta: Map<any, any>, main: boolean);
2555
+ _propertyName: string;
2556
+ _propertyIndex: number;
2557
+ _selectedObject: any;
2558
+ _mainPage: boolean;
2559
+ _collectionPage: boolean;
2560
+ content: PropertyGridContent;
2561
+ headers: ToolStripItem[];
2562
+ footers: ToolStripItem[];
2563
+ }
2564
+ import { ListItem } from "@mindfusion/common-ui";
2565
+ import { PropertyGridContent } from "DataViews/jsdv/src/PropertyGridContent";
2566
+ import { ToolStripItem } from "@mindfusion/common-ui";
2567
+ }
2568
+ declare module "DataViews/jsdv/src/PropertyGrid" {
2569
+ /**
2570
+ * @class Provides a user interface for browsing and editing the properties of an object.
2571
+ * @augments UIControl
2572
+ */
2573
+ export class PropertyGrid extends UIControl {
2574
+ /**
2575
+ * Initializes a new instance of the PropertyGrid class.
2576
+ * @constructor
2577
+ * @param {HTMLDivElement} [element] The control's associated Dom element.
2578
+ */
2579
+ constructor(element?: HTMLDivElement);
2580
+ _defaultWidth: Unit;
2581
+ _defaultHeight: Unit;
2582
+ header: ToolStrip;
2583
+ footer: ToolStrip;
2584
+ _metaData: Map<any, any>;
2585
+ _allowSort: boolean;
2586
+ _sortAscending: boolean;
2587
+ _grouped: boolean;
2588
+ _showAllProperties: boolean;
2589
+ _showReadonlyProperties: boolean;
2590
+ _editReadonlyProperties: boolean;
2591
+ _defaultCategoryName: string;
2592
+ _currentProperty: string;
2593
+ _currentIndex: number;
2594
+ _rowLoading: EventDispatcher;
2595
+ _rowRendered: EventDispatcher;
2596
+ _currentObjectChanging: EventDispatcher;
2597
+ _currentObjectChanged: EventDispatcher;
2598
+ _propertyValueChanging: EventDispatcher;
2599
+ _propertyValueChanged: EventDispatcher;
2600
+ _resolveCellDataType: EventDispatcher;
2601
+ _formatCellValue: EventDispatcher;
2602
+ _headerButtonClick: (sender: any, args: any) => void;
2603
+ _footerButtonClick: (sender: any, args: any) => void;
2604
+ _rowValidateActionHandler: (sender: any, args: any) => void;
2605
+ _rowActionHandler: (sender: any, args: any) => void;
2606
+ _cellSelectHandler: (sender: any, args: any) => void;
2607
+ _sortedHandler: (sender: any, args: any) => void;
2608
+ getContent(): any;
2609
+ beforeAddItem(item: any, index: any): void;
2610
+ /**
2611
+ * ListContainer.detachItem override.
2612
+ * @private
2613
+ */
2614
+ private detachItem;
2615
+ /**
2616
+ * ListContainer.attachItem override.
2617
+ * @private
2618
+ */
2619
+ private attachItem;
2620
+ /**
2621
+ * ListContainer._addItem override.
2622
+ * @private
2623
+ */
2624
+ private _addItem;
2625
+ private set selectedItem(arg);
2626
+ /**
2627
+ * Gets or sets the current PropertyGridPage.
2628
+ * @type {PropertyGridPage}
2629
+ * @private
2630
+ */
2631
+ private get selectedItem();
2632
+ /**
2633
+ * ListContainer._removeItem override.
2634
+ * @private
2635
+ */
2636
+ private _removeItem;
2637
+ /**
2638
+ * @private
2639
+ */
2640
+ private getTabToSelect;
2641
+ /**
2642
+ * Refreshes the grid after external modifications to the selected object.
2643
+ */
2644
+ rebind(): void;
2645
+ /**
2646
+ * Expands the specified property.
2647
+ * @param {String} propertyName The name of the property to expand.
2648
+ * @param {Number} [index] The index of the object, if that object is within a collection property.
2649
+ * @remarks Expands a property of the currently selected object.
2650
+ */
2651
+ expandProperty(propertyName: string, index?: number): Promise<any>;
2652
+ /**
2653
+ * Collapses the specified property.
2654
+ * @param {String} propertyName The name of the property to collapse.
2655
+ * @param {Number} [index] The index of the object, if that object is within a collection property.
2656
+ * @remarks Collapses a property of the currently selected object.
2657
+ */
2658
+ collapseProperty(propertyName: string, index?: number): void;
2659
+ /**
2660
+ * Closes the specified page.
2661
+ * @private
2662
+ */
2663
+ private closeItem;
2664
+ set selectedObject(arg: any);
2665
+ /**
2666
+ * Gets or sets the object whose properties can be edited by this control.
2667
+ * @type {Object}
2668
+ * @summary The object to edit.
2669
+ */
2670
+ get selectedObject(): any;
2671
+ _selectedObject: any;
2672
+ /**
2673
+ * Gets the object whose properties are currently displayed by this control.
2674
+ * @type {Object}
2675
+ * @summary The object whose properties are currently displayed.
2676
+ */
2677
+ get currentObject(): any;
2678
+ /**
2679
+ * Gets the name of the selected property.
2680
+ * @type {String}
2681
+ * @summary The selected property name.
2682
+ */
2683
+ get currentProperty(): string;
2684
+ /**
2685
+ * Gets the index of the currently selected object, if that object is within a collection property.
2686
+ * @type {Number}
2687
+ * @summary The index of the current object within the collection, or -1.
2688
+ */
2689
+ get currentIndex(): number;
2690
+ set metaData(arg: Map<any, any>);
2691
+ /**
2692
+ * Gets or sets the meta data dictionary, associated with this control.
2693
+ * @type {Map}
2694
+ * @summary The meta data dictionary.
2695
+ */
2696
+ get metaData(): Map<any, any>;
2697
+ set showAllProperties(arg: boolean);
2698
+ /**
2699
+ * Gets or sets a value indicating whether to enumerate the properties, that are not included in the meta data dictionary.
2700
+ * @type {Boolean}
2701
+ * @summary True to enumerate all properties, otherwise false.
2702
+ */
2703
+ get showAllProperties(): boolean;
2704
+ set showReadonlyProperties(arg: boolean);
2705
+ /**
2706
+ * Gets or sets a value indicating whether to enumerate the properties that don't have setters.
2707
+ * @type {Boolean}
2708
+ * @summary True to enumerate read-only properties, otherwise false.
2709
+ */
2710
+ get showReadonlyProperties(): boolean;
2711
+ set editReadonlyProperties(arg: boolean);
2712
+ /**
2713
+ * Gets or sets a value indicating whether properties that don't have setters can be edited.
2714
+ * @type {Boolean}
2715
+ * @summary True if read-only properties can be edited, otherwise false.
2716
+ */
2717
+ get editReadonlyProperties(): boolean;
2718
+ set allowEdit(arg: boolean);
2719
+ /**
2720
+ * Gets or sets a value, indicating whether inplace editing is enabled.
2721
+ * @type {Boolean}
2722
+ * @summary True if inplace editing is enabled, otherwise false.
2723
+ */
2724
+ get allowEdit(): boolean;
2725
+ _allowEdit: any;
2726
+ set allowCellSelect(arg: boolean);
2727
+ /**
2728
+ * Gets or sets a value, indicating whether single cell selection is enabled.
2729
+ * @type {Boolean}
2730
+ * @summary True if single cell selection is enabled, otherwise false.
2731
+ */
2732
+ get allowCellSelect(): boolean;
2733
+ _allowCellSelect: any;
2734
+ set allowScroll(arg: boolean);
2735
+ /**
2736
+ * Gets or sets a value, indicating whether scrolling is enabled.
2737
+ * @type {Boolean}
2738
+ * @summary True if scrolling is enabled, otherwise false.
2739
+ */
2740
+ get allowScroll(): boolean;
2741
+ _allowScroll: any;
2742
+ _selectedItem: PropertyGridPage;
2743
+ set uiThemesPath(arg: string);
2744
+ /**
2745
+ * Gets or sets the path to the control's css themes.
2746
+ * @type {String}
2747
+ * @summary A string specifying the path.
2748
+ * @remarks Only applies to web components.
2749
+ */
2750
+ get uiThemesPath(): string;
2751
+ _uiThemesPath: string;
2752
+ set allowDrag(arg: boolean);
2753
+ /**
2754
+ * ListContainer.allowDrag override.
2755
+ * @type {Boolean}
2756
+ * @summary false - not applicable.
2757
+ */
2758
+ get allowDrag(): boolean;
2759
+ set allowDrop(arg: boolean);
2760
+ /**
2761
+ * ListContainer.allowDrop override.
2762
+ * @type {Boolean}
2763
+ * @summary false - not applicable.
2764
+ */
2765
+ get allowDrop(): boolean;
2766
+ set acceptDrop(arg: any);
2767
+ /**
2768
+ * ListContainer.acceptDrop override.
2769
+ * @type {ListItem}
2770
+ * @summary null - not applicable.
2771
+ */
2772
+ get acceptDrop(): any;
2773
+ /**
2774
+ * Raised when a row data is loading.
2775
+ * @event rowLoading
2776
+ * @type {EventDispatcher}
2777
+ * @property {PropertyGrid} sender
2778
+ * @property {PropertyEventArgs} args
2779
+ */
2780
+ get rowLoading(): EventDispatcher;
2781
+ /**
2782
+ * Raised when a row is rendered.
2783
+ * @event rowRendered
2784
+ * @type {EventDispatcher}
2785
+ * @property {PropertyGrid} sender
2786
+ * @property {PropertyEventArgs} args
2787
+ */
2788
+ get rowRendered(): EventDispatcher;
2789
+ /**
2790
+ * Raised when the current object is changing.
2791
+ * @event currentObjectChanging
2792
+ * @type {EventDispatcher}
2793
+ * @property {PropertyGrid} sender
2794
+ * @property {PropertyEventArgs} args
2795
+ */
2796
+ get currentObjectChanging(): EventDispatcher;
2797
+ /**
2798
+ * Raised when the current object is changed.
2799
+ * @event currentObjectChanged
2800
+ * @type {EventDispatcher}
2801
+ * @property {PropertyGrid} sender
2802
+ * @property {PropertyEventArgs} args
2803
+ */
2804
+ get currentObjectChanged(): EventDispatcher;
2805
+ /**
2806
+ * Raised when a property value is changing.
2807
+ * @event propertyValueChanging
2808
+ * @type {EventDispatcher}
2809
+ * @property {PropertyGrid} sender
2810
+ * @property {PropertyEventArgs} args
2811
+ */
2812
+ get propertyValueChanging(): EventDispatcher;
2813
+ /**
2814
+ * Raised when a property value is changed.
2815
+ * @event propertyValueChanged
2816
+ * @type {EventDispatcher}
2817
+ * @property {PropertyGrid} sender
2818
+ * @property {PropertyEventArgs} args
2819
+ */
2820
+ get propertyValueChanged(): EventDispatcher;
2821
+ /**
2822
+ * Handles the click event in the header toolstrip.
2823
+ * @private
2824
+ */
2825
+ private onHeaderButtonClick;
2826
+ /**
2827
+ * Handles the click event in the footer toolstrip.
2828
+ * @private
2829
+ */
2830
+ private onFooterButtonClick;
2831
+ /**
2832
+ * Handles a validating row action event in the grid.
2833
+ * @private
2834
+ */
2835
+ private onRowValidateAction;
2836
+ /**
2837
+ * Handles a row action event in the grid.
2838
+ * @private
2839
+ */
2840
+ private onRowAction;
2841
+ /**
2842
+ * Handles a cell select event in the grid.
2843
+ * @private
2844
+ */
2845
+ private onCellSelect;
2846
+ onSort(sender: any, args: any): void;
2847
+ /**
2848
+ * onItemsChanging override.
2849
+ * @protected
2850
+ */
2851
+ protected onItemsChanging(sender: any, args: any): void;
2852
+ connectedCallback(): void;
2853
+ }
2854
+ import { UIControl } from "DataViews/jsdv/src/UIControl";
2855
+ import { Unit } from "@mindfusion/common";
2856
+ import { ToolStrip } from "@mindfusion/common-ui";
2857
+ import { EventDispatcher } from "@mindfusion/controls";
2858
+ import { PropertyGridPage } from "DataViews/jsdv/src/PropertyGridPage";
2859
+ }
2860
+ declare module "DataViews/jsdv/src/WebComponents" {
2861
+ /**
2862
+ * @class Implements registration of web components.
2863
+ */
2864
+ export class WebComponents {
2865
+ /**
2866
+ * Registers the controls in the package as web components.
2867
+ */
2868
+ static register(): void;
2869
+ }
2870
+ }
2871
+ declare module "@mindfusion/dataviews" {
2872
+ export { ArrayModel } from "DataViews/jsdv/src/ArrayModel";
2873
+ export { Command } from "DataViews/jsdv/src/Command";
2874
+ export { CommandType } from "DataViews/jsdv/src/CommandType";
2875
+ export { CurrencyType } from "DataViews/jsdv/src/CurrencyType";
2876
+ export { DateTimeType } from "DataViews/jsdv/src/DateTimeType";
2877
+ export { DateType } from "DataViews/jsdv/src/DateType";
2878
+ export { DeleteCommand } from "DataViews/jsdv/src/DeleteCommand";
2879
+ export { DomRenderer } from "DataViews/jsdv/src/DomRenderer";
2880
+ import { RowAction } from "DataViews/jsdv/src/Enum";
2881
+ import { CellCustomDrawEventArgs, CellEventArgs, CellValidateEventArgs, CommandEventArgs, RowModifiedEventArgs, RowModifyingEventArgs } from "DataViews/jsdv/src/EventArgs";
2882
+ export { RowAction, CellCustomDrawEventArgs, CellEventArgs, CellValidateEventArgs, CommandEventArgs, RowModifiedEventArgs, RowModifyingEventArgs };
2883
+ export { Grid } from "DataViews/jsdv/src/Grid";
2884
+ export { GridCell } from "DataViews/jsdv/src/GridCell";
2885
+ export { GridColumn } from "DataViews/jsdv/src/GridColumn";
2886
+ export { GridModel } from "DataViews/jsdv/src/GridModel";
2887
+ export { ImageType } from "DataViews/jsdv/src/ImageType";
2888
+ export { IntegerType } from "DataViews/jsdv/src/IntegerType";
2889
+ export { LookupType } from "DataViews/jsdv/src/LookupType";
2890
+ export { RealNumberType } from "DataViews/jsdv/src/RealNumberType";
2891
+ export { StringType } from "DataViews/jsdv/src/StringType";
2892
+ export { UIControl } from "DataViews/jsdv/src/UIControl";
2893
+ export { PropertyGrid } from "DataViews/jsdv/src/PropertyGrid";
2894
+ export { DynamicType } from "DataViews/jsdv/src/DynamicType";
2895
+ export { BooleanType } from "DataViews/jsdv/src/BooleanType";
2896
+ export { ObjectType } from "DataViews/jsdv/src/ObjectType";
2897
+ export { CollectionType } from "DataViews/jsdv/src/CollectionType";
2898
+ export { WebComponents } from "DataViews/jsdv/src/WebComponents";
2899
+ }