@smart-webcomponents-angular/phoneinput 15.1.5 → 19.0.8

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
package/index.d.ts CHANGED
@@ -1901,6 +1901,16 @@ export interface BarcodeProperties {
1901
1901
  * Default value: ""
1902
1902
  */
1903
1903
  value?: string;
1904
+ /**
1905
+ * Sets or gets the width of the barcode. If the width is set to 0, the width of the barcode is calculated automatically.
1906
+ * Default value: 0
1907
+ */
1908
+ width?: number;
1909
+ /**
1910
+ * Sets or gets the height of the barcode. If the height is set to 0, the height of the barcode is calculated automatically.
1911
+ * Default value: 0
1912
+ */
1913
+ height?: number;
1904
1914
  }
1905
1915
  /**
1906
1916
  Barcodes encodes text value in a specific pattern.
@@ -2359,6 +2369,11 @@ export interface CalendarProperties {
2359
2369
  * Default value: false
2360
2370
  */
2361
2371
  disableAutoNavigation?: boolean;
2372
+ /**
2373
+ * Enables or disables the Calendar mouse wheel behavior.
2374
+ * Default value: false
2375
+ */
2376
+ disableMouseWheel?: boolean;
2362
2377
  /**
2363
2378
  * Determines the date view of the calendar when calendarMode is set to 'default'
2364
2379
  * Default value: month
@@ -7185,6 +7200,11 @@ export interface ComboBox extends BaseElement, ComboBoxProperties {
7185
7200
  * @returns {Node}
7186
7201
  */
7187
7202
  appendChild<T extends Node>(node: Node): T;
7203
+ /**
7204
+ * Adds a new item(s).
7205
+ * @param {any} item. Describes the properties of the item that will be inserted. You can also pass an array of items.
7206
+ */
7207
+ add(item: any): void;
7188
7208
  /**
7189
7209
  * Removes all items from the drop down list.
7190
7210
  */
@@ -7197,6 +7217,10 @@ export interface ComboBox extends BaseElement, ComboBoxProperties {
7197
7217
  * Closes the dropDown list.
7198
7218
  */
7199
7219
  close(): void;
7220
+ /**
7221
+ * Performs a data bind. This can be used to refresh the data source.
7222
+ */
7223
+ dataBind(): void;
7200
7224
  /**
7201
7225
  * Ensures the desired item is visible by scrolling to it.
7202
7226
  * @param {HTMLElement | string} item. A list item or value of the desired item to be visible.
@@ -7211,7 +7235,7 @@ export interface ComboBox extends BaseElement, ComboBoxProperties {
7211
7235
  /**
7212
7236
  * Inserts a new item at a specified position.
7213
7237
  * @param {number} position. The position where the item must be inserted.
7214
- * @param {any} item. Describes the properties of the item that will be inserted.
7238
+ * @param {any} item. Describes the properties of the item that will be inserted. You can also pass an array of items.
7215
7239
  */
7216
7240
  insert(position: number, item: any): void;
7217
7241
  /**
@@ -7945,6 +7969,11 @@ export interface DateInputProperties {
7945
7969
  * Default value: 500
7946
7970
  */
7947
7971
  autoCloseDelay?: number;
7972
+ /**
7973
+ * Determines the calendar properties to be set to the popup calendar.
7974
+ * Default value: null
7975
+ */
7976
+ calendarProperties?: any;
7948
7977
  /**
7949
7978
  * Determines the format of the dates displayed in the input. Accepts valid ECMAScript Internationalization API format. Intl.DateTimeFormat is used to format date strings in JavaScript. By default the date format is 'numeric'. The default value is: { day: 'numeric', month: 'numeric', year: 'numeric' }
7950
7979
  * Default value: { day: 'numeric', month: 'numeric', year: 'numeric' }
@@ -8778,7 +8807,7 @@ export interface DockingLayoutProperties {
8778
8807
  */
8779
8808
  closedItems?: any;
8780
8809
  /**
8781
- * Determines the structure of the element. This property represents an array of objects that define the hierarchy of the items inside the element and their specific settings. Each object must have a type attribute that defines it's behavior. Three types of objects are allowed: LayoutGroup - Represents a group of items (Splitter). Used when the user wants more than one DockingLayout item in a single container. Properties: orientation - A string value indicating the orientation of the Splitter group. Possible values: 'horizontal', 'vertical'. size - A string | number value indicating the size of the Splitter group. items - An array of LayoutPanel object definitions. resizeMode - A string indicating the resize mode. Possible values: 'none', 'adjacent', 'end', 'proportional'. resizeStep - A nummeric value that determines the step of resizing. liveResize - Determines if splitter resizing happens while dragging or not. LayoutPanel - Represents a DockingLayout item (TabsWindow). LayoutPanels can have one or many items (TabItem). Properties: id - the ID of the LayoutPanel. autoHide - a boolean property that determines if the LayoutPanel is autoHidden. autoHidePosition - determines the autoHide position of the item if 'autoHide' property is set. Possible values: 'top', 'bottom', 'left', 'right'. dropPosition - Determines the possible positions for the item at which a new item can be dropped as a result of dragging. Possible values: 'top', 'bottom', 'left', 'right', 'center', 'header', 'layout-top', 'layout-bottom', 'layout-left', 'layout-right'. Positions with the 'layout' prefix reflect on LayoutPanelItems that are children of the LayoutPanel. label - the Label of the LayoutPanel window. tabPosition - Determines the position of the Tab labels inside the LayoutPanel. layout - determines the DockingLayout owner of the LayoutPanel. Accepts a string indicating the ID of a DockingLayout on the page or a direct reference to it. headerButtons - an Array of strings that define the buttons in the header section of the DockingLayout item. tabCloseButtons - a boolean property that Enables or disables the close buttons inside each Tab item label inside the DockingLayout item. tabOverflow - same as 'overflow' property of jqxTabs. It defines the overflow mode of the labels of the Tab items inside a DockingLayout item.selectionMode - the same as jqxTabs selection modes. Applies to Tab items inside a DockingLayout item. tabResize - the same as 'resize' property of jqxTabs. Allows resizing the Tab labels inside the DockingLayout item. locked - Locks the size of the item and does not allow resizing. max - sets the maximum size of the item. min - sets the minimum size of the item size - sets the size of the item. items - an array of objects. Each object defines the structure of a LayoutPanelItem. LayoutPanelItem - Represents a LayoutPanel item (TabItem). Properties: id - the ID of the Tab item. label - a string representing the label of the Tab item. content - represents the content of the Tab item. Can be anything. selected - determines if the item is selected. By default the first added item to the LayoutPanel is automatically selected. draggable - a boolean property that allows to disable the dragging of the Tab item.
8810
+ * Determines the structure of the element. This property represents an array of objects that define the hierarchy of the items inside the element and their specific settings. Each object must have a type attribute that defines it's behavior. Three types of objects are allowed: LayoutGroup - Represents a group of items (Splitter). Used when the user wants more than one DockingLayout item in a single container. Properties: orientation - A string value indicating the orientation of the Splitter group. Possible values: 'horizontal', 'vertical'. size - A string | number value indicating the size of the Splitter group. items - An array of LayoutPanel object definitions. resizeMode - A string indicating the resize mode. Possible values: 'none', 'adjacent', 'end', 'proportional'. resizeStep - A nummeric value that determines the step of resizing. liveResize - Determines if splitter resizing happens while dragging or not. LayoutPanel - Represents a DockingLayout item (TabsWindow). LayoutPanels can have one or many items (TabItem). Properties: id - the ID of the LayoutPanel. autoHide - a boolean property that determines if the LayoutPanel is autoHidden. autoHidePosition - determines the autoHide position of the item if 'autoHide' property is set. Possible values: 'top', 'bottom', 'left', 'right'. dropPosition - Determines the possible positions for the item at which a new item can be dropped as a result of dragging. Possible values: 'top', 'bottom', 'left', 'right', 'center', 'header', 'layout-top', 'layout-bottom', 'layout-left', 'layout-right'. Positions with the 'layout' prefix reflect on LayoutPanelItems that are children of the LayoutPanel. label - the Label of the LayoutPanel window. tabPosition - Determines the position of the Tab labels inside the LayoutPanel. layout - determines the DockingLayout owner of the LayoutPanel. Accepts a string indicating the ID of a DockingLayout on the page or a direct reference to it. headerButtons - an Array of strings that define the buttons in the header section of the DockingLayout item. Possible values for the array are empty array like this [] or an array with any of the following items: 'close', 'autoHide'. tabCloseButtons - a boolean property that Enables or disables the close buttons inside each Tab item label inside the DockingLayout item. tabOverflow - same as 'overflow' property of jqxTabs. It defines the overflow mode of the labels of the Tab items inside a DockingLayout item.selectionMode - the same as jqxTabs selection modes. Applies to Tab items inside a DockingLayout item. tabResize - the same as 'resize' property of jqxTabs. Allows resizing the Tab labels inside the DockingLayout item. locked - Locks the size of the item and does not allow resizing. max - sets the maximum size of the item. min - sets the minimum size of the item size - sets the size of the item. items - an array of objects. Each object defines the structure of a LayoutPanelItem. LayoutPanelItem - Represents a LayoutPanel item (TabItem). Properties: id - the ID of the Tab item. label - a string representing the label of the Tab item. content - represents the content of the Tab item. Can be anything. selected - determines if the item is selected. By default the first added item to the LayoutPanel is automatically selected. draggable - a boolean property that allows to disable the dragging of the Tab item.
8782
8811
  * Default value:
8783
8812
  */
8784
8813
  layout?: any;
@@ -9337,11 +9366,6 @@ declare global {
9337
9366
  }
9338
9367
 
9339
9368
  export interface DropDownListProperties {
9340
- /**
9341
- * Sets or gets the animation mode. Animation is disabled when the property is set to 'none'
9342
- * Default value: advanced
9343
- */
9344
- animation?: Animation | string;
9345
9369
  /**
9346
9370
  * Used only when dropDownOpenMode is set to 'auto'. Determines the delay before the opened drop down closes if the pointer is not over the element.
9347
9371
  * Default value: 100
@@ -9442,6 +9466,11 @@ export interface DropDownListProperties {
9442
9466
  * Default value: startsWithIgnoreCase
9443
9467
  */
9444
9468
  filterMode?: FilterMode | string;
9469
+ /**
9470
+ * A callback that should return a condition that will be used for custom item filtering. Used in conjunction with filterMode 'custom'
9471
+ * Default value: null
9472
+ */
9473
+ filterCallback?: any;
9445
9474
  /**
9446
9475
  * If enabled, the items will be grouped by their first letter. Can't be applied if the dataSource already contains groups.
9447
9476
  * Default value: false
@@ -9719,6 +9748,11 @@ export interface DropDownList extends BaseElement, DropDownListProperties {
9719
9748
  * @returns {Node}
9720
9749
  */
9721
9750
  appendChild<T extends Node>(node: Node): T;
9751
+ /**
9752
+ * Adds a new item(s).
9753
+ * @param {any} item. Describes the properties of the item that will be inserted. You can also pass an array of items.
9754
+ */
9755
+ add(item: any): void;
9722
9756
  /**
9723
9757
  * Removes all items from the drop down list.
9724
9758
  */
@@ -9731,6 +9765,10 @@ export interface DropDownList extends BaseElement, DropDownListProperties {
9731
9765
  * Closes the dropDown list.
9732
9766
  */
9733
9767
  close(): void;
9768
+ /**
9769
+ * Performs a data bind. This can be used to refresh the data source.
9770
+ */
9771
+ dataBind(): void;
9734
9772
  /**
9735
9773
  * Ensures the desired item is visible by scrolling to it.
9736
9774
  * @param {HTMLElement | string} item. A list item or value of the desired item to be visible.
@@ -10433,6 +10471,11 @@ export interface Editor extends BaseElement, EditorProperties {
10433
10471
  * instance - The toast item that is the target of the operation.
10434
10472
  */
10435
10473
  onMessageOpen?: ((this: any, ev: Event) => any) | ((this: any, ev: CustomEvent<any>) => any) | null;
10474
+ /**
10475
+ * Adds a new Toolbar item. Example: editor.addToolbarItem({ name: &#039;customButton2&#039;, width: 100, template: &#039;&lt;smart-button&gt;Button2&lt;/smart-button&gt;&#039; })
10476
+ * @param {any} itemName. The toolbar item to be added
10477
+ */
10478
+ addToolbarItem(itemName: any): void;
10436
10479
  /**
10437
10480
  * Blurs the content of the Editor.
10438
10481
  */
@@ -10499,6 +10542,12 @@ export interface Editor extends BaseElement, EditorProperties {
10499
10542
  * Hides the last shown message.
10500
10543
  */
10501
10544
  hideLastMessage(): void;
10545
+ /**
10546
+ * Inserts a new Toolbar item. Example: editor.insertToolbarItem({ name: &#039;customButton2&#039;, width: 100, template: &#039;&lt;smart-button&gt;Button2&lt;/smart-button&gt;&#039; })
10547
+ * @param {any} itemName. The toolbar item to be added
10548
+ * @param {number} index. The toolbar item's index
10549
+ */
10550
+ insertToolbarItem(itemName: any, index: number): void;
10502
10551
  /**
10503
10552
  * Shows a custom message inside the Editor.
10504
10553
  * @param {string} message. The text message to be displayed.
@@ -10538,6 +10587,11 @@ export interface Editor extends BaseElement, EditorProperties {
10538
10587
  * @param {boolean} value?. Determines whether to enter or leave split mode. By default the argument is not passed and the mode is toggled.
10539
10588
  */
10540
10589
  previewMode(value?: boolean): void;
10590
+ /**
10591
+ * Removes a Toolbar item. Example: editor.removeToolbarItem(0)
10592
+ * @param {number} index. The toolbar item's index
10593
+ */
10594
+ removeToolbarItem(index: number): void;
10541
10595
  /**
10542
10596
  * Sets Editor into Full Screen Mode. If enabled the Editor is positioned above the page content and fills the screen.
10543
10597
  * @param {boolean} value?. Determines whether to enter or leave split mode. By default the argument is not passed and the mode is toggled.
@@ -13288,6 +13342,11 @@ export interface GanttChartProperties {
13288
13342
  * Default value: false
13289
13343
  */
13290
13344
  columnResizeFeedback?: boolean;
13345
+ /**
13346
+ * Gantt's current time. By default it is the today's date.
13347
+ * Default value:
13348
+ */
13349
+ currentTime?: string | Date;
13291
13350
  /**
13292
13351
  * Enables/Disables the current time indicator. Current time indicator shows the current time in the appropriate view cells.
13293
13352
  * Default value: false
@@ -13383,6 +13442,11 @@ export interface GanttChartProperties {
13383
13442
  * Default value: false
13384
13443
  */
13385
13444
  filterRow?: boolean;
13445
+ /**
13446
+ * Determines the view start day. Sunday is 0, Monday is 1, Saturday is 6. By default it's Sunday.
13447
+ * Default value: -1
13448
+ */
13449
+ firstDayOfWeek?: number;
13386
13450
  /**
13387
13451
  * Groups the tasks inside the Task timeline according to the resources they are assigned to. Unassigned tasks are placed in a default group labeled 'Unassigned'.
13388
13452
  * Default value: false
@@ -13399,15 +13463,20 @@ export interface GanttChartProperties {
13399
13463
  */
13400
13464
  hideDateMarkers?: boolean;
13401
13465
  /**
13402
- * By default the Timeline has a two level header - timeline details and timeline header. This property hides the header details container( the top container ).
13466
+ * By default the Timeline has a three level header - timeline details, timeline second details and timeline header. This property hides the header container( the bottom container ).
13403
13467
  * Default value: false
13404
13468
  */
13405
- hideTimelineHeaderDetails?: boolean;
13469
+ hideTimelineHeader?: boolean;
13406
13470
  /**
13407
- * Shows the selection column of the Task/Resource Table. When applied a checkbox column is displayed that allows to select tasks/resources.
13471
+ * By default the Timeline has a three level header - timeline details, timeline second details and timeline header. This property hides the header details container( the top container ).
13408
13472
  * Default value: false
13409
13473
  */
13410
- showSelectionColumn?: boolean;
13474
+ hideTimelineHeaderDetails?: boolean;
13475
+ /**
13476
+ * By default the Timeline has a three level header - timeline details and timeline header. This property hides the second header details container( the middle container ).
13477
+ * Default value: true
13478
+ */
13479
+ hideTimelineSecondHeaderDetails?: boolean;
13411
13480
  /**
13412
13481
  * Hides the Resource panel regardless of the resources availability By default the Resource panel is visible if resources are added to the GanttChart. This property allows to hide the Resource panel permanently.
13413
13482
  * Default value: false
@@ -13468,6 +13537,11 @@ export interface GanttChartProperties {
13468
13537
  * Default value: short
13469
13538
  */
13470
13539
  monthFormat?: MonthFormat | string;
13540
+ /**
13541
+ * Determines the scale in Month view.
13542
+ * Default value: week
13543
+ */
13544
+ monthScale?: MonthScale | string;
13471
13545
  /**
13472
13546
  * Determines the nonworking days of the week from 0 to 6, where 0 is the first day of the week and 6 is the last day. Nonworking days will be displayed with colored cells inside the timeline and will not affect the dateEnd of the tasks unless the adjustToNonworkingTime property is enabled.
13473
13547
  * Default value:
@@ -13478,6 +13552,21 @@ export interface GanttChartProperties {
13478
13552
  * Default value:
13479
13553
  */
13480
13554
  nonworkingHours?: number[] | number[][];
13555
+ /**
13556
+ * A function that can be used to completly customize the task element. The function has five arguments: task - the task object.segment - the task current segment object. If the task has only one segment, the task object is passed again.taskElement - the task's html element.segmentElement - the task's segment html element.labelElement - the task's segment label html element.
13557
+ * Default value: null
13558
+ */
13559
+ onTaskRender?: any;
13560
+ /**
13561
+ * A function that can be used to completly customize the task element. The function has two arguments: task - the task object.taskElement - the task's html element.
13562
+ * Default value: null
13563
+ */
13564
+ taskFormatFunction?: any;
13565
+ /**
13566
+ * A function that can be used to completly customize the tooltip. The function has three arguments: tooltipObject - the tooltip object.event - the event that triggered the tooltip.content - the tooltip's label element.
13567
+ * Default value: null
13568
+ */
13569
+ tooltipFormatFunction?: any;
13481
13570
  /**
13482
13571
  * A function that can be used to completly customize the popup Window that is used to interact width tasks by changing their properties. The function as three arguments: target - the target popup Window that is about to be opened.type - the type of the window. The type determines the purpose of the window. Three possible values: 'task' (task editing), 'confirm' ( confirmation window), 'connection' (used when deleting a connection between tasks). item - the connection/task object that is the target of the window.
13483
13572
  * Default value: null
@@ -13493,6 +13582,11 @@ export interface GanttChartProperties {
13493
13582
  * Default value: null
13494
13583
  */
13495
13584
  progressLabelFormatFunction?: any;
13585
+ /**
13586
+ * Determines the format of the dates the timeline header when they represent quarters.
13587
+ * Default value: short
13588
+ */
13589
+ quarterFormat?: QuarterFormat | string;
13496
13590
  /**
13497
13591
  * A getter that returns a flat structure as an array of all resources inside the element.
13498
13592
  * Default value: null
@@ -13563,11 +13657,21 @@ export interface GanttChartProperties {
13563
13657
  * Default value:
13564
13658
  */
13565
13659
  selectedResourceIds?: number[] | string[];
13660
+ /**
13661
+ * Sets or gets the selection mode. Only applicable when selection is enabled.
13662
+ * Default value: many
13663
+ */
13664
+ selectionMode?: GanttChartSelectionMode | string;
13566
13665
  /**
13567
13666
  * Enables/Disables the current time shader. If enabled all cells that represent past time will be shaded.
13568
13667
  * Default value: false
13569
13668
  */
13570
13669
  shadeUntilCurrentTime?: boolean;
13670
+ /**
13671
+ * Shows the selection column of the Task/Resource Table. When applied a checkbox column is displayed that allows to select tasks/resources.
13672
+ * Default value: false
13673
+ */
13674
+ showSelectionColumn?: boolean;
13571
13675
  /**
13572
13676
  * Determines whether the baselnes of the tasks are visible or not. Baselines are defined via the 'planned' attribute on the task objects of the dataSource property.
13573
13677
  * Default value: false
@@ -14105,6 +14209,11 @@ export interface GanttChart extends BaseElement, GanttChartProperties {
14105
14209
  * @param {string} content?. Allows to set a custom content for the Tooltip.
14106
14210
  */
14107
14211
  showTooltip(target: HTMLElement, content?: string): void;
14212
+ /**
14213
+ * Scrolls to a date.
14214
+ * @param {Date} date. The date to scroll to.
14215
+ */
14216
+ scrollToDate(date: Date): void;
14108
14217
  /**
14109
14218
  * Saves the current settings of the element to LocalStorage. <strong>Requires an id to be set to the element.</strong>
14110
14219
  * @param {any[]} state?. An Array containing a valid structure of Gantt Chart tasks.
@@ -14400,6 +14509,11 @@ export interface GanttChartTask {
14400
14509
  * Default value: null
14401
14510
  */
14402
14511
  formatFunction?: any;
14512
+ /**
14513
+ * Project, Task or Milestone format function. The function gets passed the following arguments: task, segment, taskElement, segmentElement, labelElement. task - the task object.segment - the task current segment object. If the task has only one segment, the task object is passed again.taskElement - the task's html element.segmentElement - the task's segment html element.labelElement - the task's segment label html element.
14514
+ * Default value: null
14515
+ */
14516
+ onRender?: any;
14403
14517
  /**
14404
14518
  * Project, Task or Milestone max start date.
14405
14519
  * Default value:
@@ -14662,10 +14776,16 @@ export declare type GanttDayFormat = '2-digit' | 'numeric' | 'long' | 'short' |
14662
14776
  export declare type Duration = 'day' | 'hour' | 'minute' | 'second' | 'milisecond';
14663
14777
  /**Determines the format of the dates inside the timeline header when they represent hours. */
14664
14778
  export declare type HourFormat = 'default' | '2-digit' | 'numeric';
14779
+ /**Determines the scale in Month view. */
14780
+ export declare type MonthScale = 'day' | 'week';
14781
+ /**Determines the format of the dates the timeline header when they represent quarters. */
14782
+ export declare type QuarterFormat = 'numeric' | 'long' | 'short';
14665
14783
  /**Determines how the capacity of the resources will be visualized inside the resource timeline. By default, the capacity is measured in hours depending on the <b>view</b> property of the element. */
14666
14784
  export declare type GanttChartResourceTimelineMode = 'diagram' | 'histogram' | 'custom';
14667
14785
  /**Determines how the resources will be displayed inside the resource Timeline. */
14668
14786
  export declare type GanttChartResourceTimelineView = 'hours' | 'tasks' | 'custom';
14787
+ /**Sets or gets the selection mode. Only applicable when selection is enabled. */
14788
+ export declare type GanttChartSelectionMode = 'one' | 'many' | 'extended';
14669
14789
  /**Determines whether the GanttChart can be sorted by one, more then one or no columns. */
14670
14790
  export declare type GanttChartSortMode = 'none' | 'one' | 'many';
14671
14791
  /**Project, Task or Milestone type. Possible values are 'project', 'milestone' and 'task' */
@@ -14676,7 +14796,7 @@ month - the timeline shows the days of the month.
14676
14796
  year - the timeline shows the months of the year.
14677
14797
  resource - displays the current tasks by grouping them according to the resources they have assigned. The unassigned tasks will be placed in a separate group called 'Unassigned'.
14678
14798
  <br /> The timeline has a header section that contains the labels of each cell according to the date inside them. The header is splitted in two sections in order to give a more detailed information of the dates. */
14679
- export declare type GanttChartView = 'day' | 'week' | 'month' | 'year';
14799
+ export declare type GanttChartView = 'day' | 'week' | 'month' | 'quarter' | 'year';
14680
14800
  /**Determines the format of the dates inside the timeline header when they represent weeks. */
14681
14801
  export declare type WeekFormat = 'long' | 'numeric';
14682
14802
  export interface GaugeProperties {
@@ -15007,15 +15127,15 @@ export interface GridProperties {
15007
15127
  */
15008
15128
  behavior?: GridBehavior;
15009
15129
  /**
15010
- * An object containing settings related to the grid's layout.
15011
- * Default value: [object Object]
15130
+ * Sets or gets the id of the current user. Has to correspond to the id of an item from the users property/array. Depending on the current user, different privileges are enabled. If no current user is set, privileges depend on the element's properties.
15131
+ * Default value:
15012
15132
  */
15013
- layout?: GridLayout;
15133
+ currentUser?: string | number;
15014
15134
  /**
15015
- * Sets or gets the language. Used in conjunction with the property messages.
15016
- * Default value: "en"
15135
+ * Describes the column header settings.
15136
+ * Default value: [object Object]
15017
15137
  */
15018
- locale?: string;
15138
+ columnHeader?: GridColumnHeader;
15019
15139
  /**
15020
15140
  * The clipboard property is used to enable/disable clipboard operations with Ctrl+C, Ctrl+X and Ctrl+V keyboard navigations..
15021
15141
  * Default value: [object Object]
@@ -15041,6 +15161,11 @@ export interface GridProperties {
15041
15161
  * Default value:
15042
15162
  */
15043
15163
  columnGroups?: GridColumnGroup[];
15164
+ /**
15165
+ *
15166
+ * Default value: false
15167
+ */
15168
+ dropDownMode?: boolean;
15044
15169
  /**
15045
15170
  * Sets or gets details about conditional formatting to be applied to the Grid's cells.
15046
15171
  * Default value: null
@@ -15081,11 +15206,41 @@ export interface GridProperties {
15081
15206
  * Default value: [object Object]
15082
15207
  */
15083
15208
  filtering?: GridFiltering;
15209
+ /**
15210
+ * Describes the footer settings of the grid.
15211
+ * Default value: [object Object]
15212
+ */
15213
+ footer?: GridFooter;
15214
+ /**
15215
+ * Sets or gets whether Excel-like formulas can be passed as cell values. Formulas are always preceded by the = sign and are re-evaluated when cell values are changed. This feature depends on the third-party free plug-in formula-parser (the file formula-parser.min.js has to be referenced).
15216
+ * Default value: false
15217
+ */
15218
+ formulas?: boolean;
15084
15219
  /**
15085
15220
  * Describes the grid's grouping settings.
15086
15221
  * Default value: [object Object]
15087
15222
  */
15088
15223
  grouping?: GridGrouping;
15224
+ /**
15225
+ * Describes the settings for the group header.
15226
+ * Default value: [object Object]
15227
+ */
15228
+ groupHeader?: GridGroupHeader;
15229
+ /**
15230
+ * Describes the header settings of the grid.
15231
+ * Default value: [object Object]
15232
+ */
15233
+ header?: GridHeader;
15234
+ /**
15235
+ * An object containing settings related to the grid's layout.
15236
+ * Default value: [object Object]
15237
+ */
15238
+ layout?: GridLayout;
15239
+ /**
15240
+ * Sets or gets the language. Used in conjunction with the property messages.
15241
+ * Default value: "en"
15242
+ */
15243
+ locale?: string;
15089
15244
  /**
15090
15245
  * Sets the messages values.
15091
15246
  * Default value: * [object Object]
@@ -15106,6 +15261,16 @@ export interface GridProperties {
15106
15261
  * Default value: null
15107
15262
  */
15108
15263
  onCellRender?: {(cell: GridCell): void};
15264
+ /**
15265
+ * Callback function, which is called when a cell edit starts. If you return false, the edit will be canceled.
15266
+ * Default value: null
15267
+ */
15268
+ onCellBeginEdit?: {(id: string, dataField: string, value: any): boolean};
15269
+ /**
15270
+ * Callback function, which is called when a cell edit ends. It is used along with the 'editing.readOnlyEdit' property when it is set to true and the purpose of this function is to update the Grid cell after editing.
15271
+ * Default value: null
15272
+ */
15273
+ onCellEditRequest?: {(id: string, dataField: string, value: any, oldValue: any, data: any): void};
15109
15274
  /**
15110
15275
  * Callback function() called before the grid has been initialized and the Grid's Virtual DOM is not created.
15111
15276
  * Default value: null
@@ -15226,26 +15391,6 @@ export interface GridProperties {
15226
15391
  * Default value: null
15227
15392
  */
15228
15393
  onCommand?: {(name: string, command: any, details: GridCell, event: Event | KeyboardEvent | PointerEvent, handled: boolean): void};
15229
- /**
15230
- * Sets or gets the rows CSS class rules. Different CSS class names are conditionally applied. Example: rowCSSRules: { 'cell-class-1': settings =&gt; settings.data.quantity === 5, 'cell-class-2': settings =&gt; settings.data.quantity &lt; 5, 'cell-class-3': settings =&gt; settings.data.quantity &gt; 5 }. The settings object contains the following properties: index, data, row, api.
15231
- * Default value: null
15232
- */
15233
- rowCSSRules?: any;
15234
- /**
15235
- * Sets or gets the id of the current user. Has to correspond to the id of an item from the users property/array. Depending on the current user, different privileges are enabled. If no current user is set, privileges depend on the element's properties.
15236
- * Default value:
15237
- */
15238
- currentUser?: string | number;
15239
- /**
15240
- * Sets the grid users. Expects an array with 'id', 'name' and optionally 'color' and 'image' properties.
15241
- * Default value: []
15242
- */
15243
- users?: any[];
15244
- /**
15245
- * Sets the grid's image and filter upload settings for the image and attachment columns.
15246
- * Default value: [object Object]
15247
- */
15248
- uploadSettings?: GridUploadSettings;
15249
15394
  /**
15250
15395
  * Describes the paging settings.
15251
15396
  * Default value: [object Object]
@@ -15261,16 +15406,26 @@ export interface GridProperties {
15261
15406
  * Default value: [object Object]
15262
15407
  */
15263
15408
  rowDetail?: GridRowDetail;
15409
+ /**
15410
+ * Sets or gets the rows CSS class rules. Different CSS class names are conditionally applied. Example: rowCSSRules: { 'cell-class-1': settings =&gt; settings.data.quantity === 5, 'cell-class-2': settings =&gt; settings.data.quantity &lt; 5, 'cell-class-3': settings =&gt; settings.data.quantity &gt; 5 }. The settings object contains the following properties: index, data, row, api.
15411
+ * Default value: null
15412
+ */
15413
+ rowCSSRules?: any;
15414
+ /**
15415
+ * Sets or gets the value indicating whether the element is aligned to support locales using right-to-left fonts.
15416
+ * Default value: false
15417
+ */
15418
+ rightToLeft?: boolean;
15419
+ /**
15420
+ * The rows property is used to describe all rows displayed in the grid.
15421
+ * Default value:
15422
+ */
15423
+ rows?: GridRow[];
15264
15424
  /**
15265
15425
  * Sets the scroll mode settings.
15266
15426
  * Default value: physical
15267
15427
  */
15268
15428
  scrolling?: Scrolling | string;
15269
- /**
15270
- * Describes the column header settings.
15271
- * Default value: [object Object]
15272
- */
15273
- columnHeader?: GridColumnHeader;
15274
15429
  /**
15275
15430
  * Describes the summary row settings.
15276
15431
  * Default value: [object Object]
@@ -15282,40 +15437,30 @@ export interface GridProperties {
15282
15437
  */
15283
15438
  stateSettings?: GridStateSettings;
15284
15439
  /**
15285
- * Describes the settings for the group header.
15286
- * Default value: [object Object]
15287
- */
15288
- groupHeader?: GridGroupHeader;
15289
- /**
15290
- * Describes the header settings of the grid.
15440
+ * Describes the selection settings.
15291
15441
  * Default value: [object Object]
15292
15442
  */
15293
- header?: GridHeader;
15443
+ selection?: GridSelection;
15294
15444
  /**
15295
- * Describes the footer settings of the grid.
15445
+ * Describes sorting settings.
15296
15446
  * Default value: [object Object]
15297
15447
  */
15298
- footer?: GridFooter;
15299
- /**
15300
- * Sets or gets the value indicating whether the element is aligned to support locales using right-to-left fonts.
15301
- * Default value: false
15302
- */
15303
- rightToLeft?: boolean;
15448
+ sorting?: GridSorting;
15304
15449
  /**
15305
- * The rows property is used to describe all rows displayed in the grid.
15306
- * Default value:
15450
+ * Sets the grid users. Expects an array with 'id', 'name' and optionally 'color' and 'image' properties.
15451
+ * Default value: []
15307
15452
  */
15308
- rows?: GridRow[];
15453
+ users?: any[];
15309
15454
  /**
15310
- * Describes the selection settings.
15455
+ * Sets the grid's image and filter upload settings for the image and attachment columns.
15311
15456
  * Default value: [object Object]
15312
15457
  */
15313
- selection?: GridSelection;
15458
+ uploadSettings?: GridUploadSettings;
15314
15459
  /**
15315
- * Describes sorting settings.
15316
- * Default value: [object Object]
15460
+ * Sets the current data view. The possible values are 'grid', 'kanban' and 'card'.
15461
+ * Default value: "grid"
15317
15462
  */
15318
- sorting?: GridSorting;
15463
+ view?: string;
15319
15464
  }
15320
15465
  /**
15321
15466
  Data Grid UI Component that covers everything from paging, sorting, grouping, filtering, and editing to row and column virtualization, right-to-left layout, export to Excel and PDF and Accessibility.
@@ -15390,6 +15535,15 @@ export interface Grid extends BaseElement, GridProperties {
15390
15535
  * originalEvent - The origianl Event object.
15391
15536
  */
15392
15537
  onColumnDragStart?: ((this: any, ev: Event) => any) | ((this: any, ev: CustomEvent<any>) => any) | null;
15538
+ /**
15539
+ * This event is triggered, when a column property is changed.
15540
+ * @param event. The custom event. Custom data event was created with: ev.detail(column, propertyName, oldValue, value)
15541
+ * column - The resized column.
15542
+ * propertyName - The changed property's name.
15543
+ * oldValue - The old value(s) of the column.
15544
+ * value - The new value(s) of the column.
15545
+ */
15546
+ onColumnChange?: ((this: any, ev: Event) => any) | ((this: any, ev: CustomEvent<any>) => any) | null;
15393
15547
  /**
15394
15548
  * This event is triggered, when the user drags a column.
15395
15549
  * @param event. The custom event. Custom data event was created with: ev.detail(column, dataField, index, data, originalEvent)
@@ -15503,10 +15657,11 @@ export interface Grid extends BaseElement, GridProperties {
15503
15657
  onRowCollapse?: ((this: any, ev: Event) => any) | ((this: any, ev: CustomEvent<any>) => any) | null;
15504
15658
  /**
15505
15659
  * This event is triggered, when the user clicks on a row of the grid.
15506
- * @param event. The custom event. Custom data event was created with: ev.detail(row, originalEvent, id, isRightClick, pageX, pageY)
15660
+ * @param event. The custom event. Custom data event was created with: ev.detail(row, originalEvent, id, data, isRightClick, pageX, pageY)
15507
15661
  * row - The clicked row.
15508
15662
  * originalEvent - The original event object, which is 'pointer', 'touch' or 'mouse' Event object, depending on the device type and web browser
15509
15663
  * id - Gets the row id.
15664
+ * data - Gets the row data.
15510
15665
  * isRightClick - Gets whether the pointing device's right button is clicked.
15511
15666
  * pageX - Gets the click's X position.
15512
15667
  * pageY - Gets the click's Y position.
@@ -15514,10 +15669,11 @@ export interface Grid extends BaseElement, GridProperties {
15514
15669
  onRowClick?: ((this: any, ev: Event) => any) | ((this: any, ev: CustomEvent<any>) => any) | null;
15515
15670
  /**
15516
15671
  * This event is triggered, when the user double clicks on a row of the grid.
15517
- * @param event. The custom event. Custom data event was created with: ev.detail(row, originalEvent, id, isRightClick, pageX, pageY)
15672
+ * @param event. The custom event. Custom data event was created with: ev.detail(row, originalEvent, id, data, isRightClick, pageX, pageY)
15518
15673
  * row - The double-clicked row.
15519
15674
  * originalEvent - The original event object, which is 'pointer', 'touch' or 'mouse' Event object, depending on the device type and web browser
15520
15675
  * id - Gets the row id.
15676
+ * data - Gets the row data.
15521
15677
  * isRightClick - Gets whether the pointing device's right button is clicked.
15522
15678
  * pageX - Gets the click's X position.
15523
15679
  * pageY - Gets the click's Y position.
@@ -15543,11 +15699,12 @@ export interface Grid extends BaseElement, GridProperties {
15543
15699
  onRowStarred?: ((this: any, ev: Event) => any) | ((this: any, ev: CustomEvent<any>) => any) | null;
15544
15700
  /**
15545
15701
  * This event is triggered, when the user clicks on a cell of the grid.
15546
- * @param event. The custom event. Custom data event was created with: ev.detail(cell, originalEvent, id, dataField, isRightClick, pageX, pageY)
15702
+ * @param event. The custom event. Custom data event was created with: ev.detail(cell, originalEvent, id, dataField, value, isRightClick, pageX, pageY)
15547
15703
  * cell - The clicked cell.
15548
15704
  * originalEvent - The original event object, which is 'pointer', 'touch' or 'mouse' Event object, depending on the device type and web browser
15549
15705
  * id - Gets the row id.
15550
15706
  * dataField - Gets the column dataField.
15707
+ * value - Gets the cell value.
15551
15708
  * isRightClick - Gets whether the pointing device's right button is clicked.
15552
15709
  * pageX - Gets the click's X position.
15553
15710
  * pageY - Gets the click's Y position.
@@ -15555,11 +15712,12 @@ export interface Grid extends BaseElement, GridProperties {
15555
15712
  onCellClick?: ((this: any, ev: Event) => any) | ((this: any, ev: CustomEvent<any>) => any) | null;
15556
15713
  /**
15557
15714
  * This event is triggered, when the user double clicks on a cell of the grid.
15558
- * @param event. The custom event. Custom data event was created with: ev.detail(cell, originalEvent, id, dataField, isRightClick, pageX, pageY)
15715
+ * @param event. The custom event. Custom data event was created with: ev.detail(cell, originalEvent, id, dataField, value, isRightClick, pageX, pageY)
15559
15716
  * cell - The double-clicked cell.
15560
15717
  * originalEvent - The original event object, which is 'pointer', 'touch' or 'mouse' Event object, depending on the device type and web browser
15561
15718
  * id - Gets the row id.
15562
15719
  * dataField - Gets the column dataField.
15720
+ * value - Gets the cell value.
15563
15721
  * isRightClick - Gets whether the pointing device's right button is clicked.
15564
15722
  * pageX - Gets the click's X position.
15565
15723
  * pageY - Gets the click's Y position.
@@ -15807,8 +15965,10 @@ export interface Grid extends BaseElement, GridProperties {
15807
15965
  /**
15808
15966
  * Exports the Grid data to .XLSX, .PDF, .JSON, .XML, .CSV, .TSV, .HTML, .JPEG or .PNG. The method uses the options of the <em>dataExport</em> property.
15809
15967
  * @param {string} Dataformat. 'xlsx', 'pdf', 'json', 'xml', 'csv', 'tsv', 'html', 'png', 'jpeg'.
15968
+ * @param {any} callback?. A callback that allows to format the exported data based on a condition. For additional details, refer to the Smart Export Documentation.
15969
+ * @param {any} dataCallback?. A callback that allows to change the exported data.
15810
15970
  */
15811
- exportData(Dataformat: string): void;
15971
+ exportData(Dataformat: string, callback?: any, dataCallback?: any): void;
15812
15972
  /**
15813
15973
  * Finds entries by using a query and returns an array of row ids. Example: const rows = grid.find('nancy'); returns all rows that have 'nancy' value. Example 2: const rows = grid.find('nancy, davolio'); returns all rows that have 'nancy' and 'davolio' values in the same row. Example 3: const rows = grid.find(5, 'quantity', '>'); returns all rows where the value of the 'quantity' field is > 5.
15814
15974
  * @param {string} query. Search query
@@ -15823,6 +15983,12 @@ export interface Grid extends BaseElement, GridProperties {
15823
15983
  * @returns {any[]}
15824
15984
  */
15825
15985
  findCells(query: string): any[];
15986
+ /**
15987
+ * Filter by all columns. This method works like a global filter and applies a filter to all grid columns.
15988
+ * @param {string} query. Filter query to filter by.
15989
+ * @param {string} dataType?. Optionally filter by a specific data type like 'string', 'boolean', 'date', 'number'.
15990
+ */
15991
+ filterBy(query: string, dataType?: string): void;
15826
15992
  /**
15827
15993
  * Navigates to a page, when paging is enabled.
15828
15994
  * @param {number} index. page index
@@ -15945,22 +16111,6 @@ export interface Grid extends BaseElement, GridProperties {
15945
16111
  * @returns {any}
15946
16112
  */
15947
16113
  getState(): any;
15948
- /**
15949
- * Saves the Grid state and returns a JSON object with the following fields: 'sort', 'columns', 'expandedRows', 'filter', 'groups', 'paging', 'selectedCells', 'selectedrows'. The 'sort' represents an object which contains the sorted columns. Each key in that json object is the column's dataField item which has sortOrder: string and sortIndex: int properties. The sortOrder could be either 'asc' or 'desc'. Similarly, the filter object contains the filtered columns. Each key in that object is a column data field and each value has 'filters' array property with the applied filters to the column. The 'columns' property contains an array of columns with saved properties such as visible, width and freeze. The 'expandedRows' property contains the indexes of the expanded rows. The 'groups' property contains the grouped column data fields and the selectedCells and selectedRows include information about the cells or rows selection. These depend on the selection mode used in the Grid. The 'paging' object includes the sub-properties 'count', 'index' and 'size' which determine the count of pages, the current page's index and the page size.
15950
- * @param {string} name?. state name
15951
- * @returns {any}
15952
- */
15953
- saveState(name?: string): any;
15954
- /**
15955
- * Loads a previously saved Grid state. You can pass a state name when there is a state which was previously saved with the saveState(stateName) method call or a state object returned by the saveState or getState method calls. The state object is required to be a JSON object with the following fields: 'sort', 'columns', 'expandedRows', 'filter', 'groups', 'paging', 'selectedCells', 'selectedrows'. The 'sort' represents an object which contains the sorted columns. Each key in that json object is the column's dataField item which has sortOrder: string and sortIndex: int properties. The sortOrder could be either 'asc' or 'desc'. Similarly, the filter object contains the filtered columns. Each key in that object is a column data field and each value has 'filters' array property with the applied filters to the column. The 'columns' property contains an array of columns with saved properties such as visible, width and freeze. The 'expandedRows' property contains the indexes of the expanded rows. The 'groups' property contains the grouped column data fields and the selectedCells and selectedRows include information about the cells or rows selection. These depend on the selection mode used in the Grid. The 'paging' object includes the sub-properties 'count', 'index' and 'size' which determine the count of pages, the current page's index and the page size.
15956
- * @param {any} state. state name or state object
15957
- * @returns {any}
15958
- */
15959
- loadState(state: any): any;
15960
- /**
15961
- * Resets the Grid state.
15962
- */
15963
- resetState(): void;
15964
16114
  /**
15965
16115
  * Gets the changes from the batch edit.
15966
16116
  * @returns
@@ -16057,6 +16207,12 @@ export interface Grid extends BaseElement, GridProperties {
16057
16207
  * @param callback?. Sets a callback function, which is called after the new row is added. The callback's argument is the new row.
16058
16208
  */
16059
16209
  insertRow(data: any, index?: number, callback?: {(row: GridRow): void}): void;
16210
+ /**
16211
+ * Loads a previously saved Grid state. You can pass a state name when there is a state which was previously saved with the saveState(stateName) method call or a state object returned by the saveState or getState method calls. The state object is required to be a JSON object with the following fields: 'sort', 'columns', 'expandedRows', 'filter', 'groups', 'paging', 'selectedCells', 'selectedrows'. The 'sort' represents an object which contains the sorted columns. Each key in that json object is the column's dataField item which has sortOrder: string and sortIndex: int properties. The sortOrder could be either 'asc' or 'desc'. Similarly, the filter object contains the filtered columns. Each key in that object is a column data field and each value has 'filters' array property with the applied filters to the column. The 'columns' property contains an array of columns with saved properties such as visible, width and freeze. The 'expandedRows' property contains the indexes of the expanded rows. The 'groups' property contains the grouped column data fields and the selectedCells and selectedRows include information about the cells or rows selection. These depend on the selection mode used in the Grid. The 'paging' object includes the sub-properties 'count', 'index' and 'size' which determine the count of pages, the current page's index and the page size.
16212
+ * @param {any} state. state name or state object
16213
+ * @returns {any}
16214
+ */
16215
+ loadState(state: any): any;
16060
16216
  /**
16061
16217
  * Opens a column drop-down menu.
16062
16218
  * @param {string} dataField. column bound data field. For example, if you have a column with dataField: 'firstName', set 'firstName' here.
@@ -16068,6 +16224,14 @@ export interface Grid extends BaseElement, GridProperties {
16068
16224
  * @param {number} top. Top Position.
16069
16225
  */
16070
16226
  openContextMenu(left: number, top: number): void;
16227
+ /**
16228
+ * Opens the Grid when the 'dropDownMode' property is true.
16229
+ */
16230
+ openDropDown(): void;
16231
+ /**
16232
+ * Closes the Grid when the 'dropDownMode' property is true.
16233
+ */
16234
+ closeDropDown(): void;
16071
16235
  /**
16072
16236
  * Prints the Grid data. The method uses the options of the <em>dataExport</em> property. When printed, the Grid will not display any scrollbars so all rows and columns will be displayed. The grid will auto resize width and height to fit all contents. To customize the printing options, you can use the <em>dataExport</em> property.
16073
16237
  */
@@ -16084,6 +16248,10 @@ export interface Grid extends BaseElement, GridProperties {
16084
16248
  * Refreshes the grid cells in view. The method is useful for live-updates of cell values.
16085
16249
  */
16086
16250
  refreshView(): void;
16251
+ /**
16252
+ * Resets the Grid state.
16253
+ */
16254
+ resetState(): void;
16087
16255
  /**
16088
16256
  * Removes a column filter.
16089
16257
  * @param {string} dataField. column bound data field. For example, if you have a column with dataField: 'firstName', set 'firstName' here.
@@ -16115,6 +16283,12 @@ export interface Grid extends BaseElement, GridProperties {
16115
16283
  * @param {boolean} insertAfter?. Determines whether to insert the first column after the reference column.
16116
16284
  */
16117
16285
  reorderColumns(dataField: string | number, referenceDataField: string | number, insertAfter?: boolean): void;
16286
+ /**
16287
+ * Saves the Grid state and returns a JSON object with the following fields: 'sort', 'columns', 'expandedRows', 'filter', 'groups', 'paging', 'selectedCells', 'selectedrows'. The 'sort' represents an object which contains the sorted columns. Each key in that json object is the column's dataField item which has sortOrder: string and sortIndex: int properties. The sortOrder could be either 'asc' or 'desc'. Similarly, the filter object contains the filtered columns. Each key in that object is a column data field and each value has 'filters' array property with the applied filters to the column. The 'columns' property contains an array of columns with saved properties such as visible, width and freeze. The 'expandedRows' property contains the indexes of the expanded rows. The 'groups' property contains the grouped column data fields and the selectedCells and selectedRows include information about the cells or rows selection. These depend on the selection mode used in the Grid. The 'paging' object includes the sub-properties 'count', 'index' and 'size' which determine the count of pages, the current page's index and the page size.
16288
+ * @param {string} name?. state name
16289
+ * @returns {any}
16290
+ */
16291
+ saveState(name?: string): any;
16118
16292
  /**
16119
16293
  * Sorts the Grid by a data field. This method will add or remove sorting, when sorting is enabled. To remove the sorting, use 'null' for the sortOrder parameter.
16120
16294
  * @param {string} dataField. column bound data field. For example, if you have a column with dataField: 'firstName', set 'firstName' here.
@@ -16222,6 +16396,11 @@ export interface Grid extends BaseElement, GridProperties {
16222
16396
  * @param rowStyle. The cell style object. The object may have one or all of the following properties: 'background', 'color', 'fontSize', 'fontFamily', 'textDecoration', 'fontStyle', 'fontWeight'.
16223
16397
  */
16224
16398
  setCellStyle(rowId: string | number, dataField: string, rowStyle: {background?: string, color?: string, fontSize?: string, fontFamily?: string, textDecoration?: string, fontStyle?: string, fontWeight?: string}): void;
16399
+ /**
16400
+ * Sets the label of the Grid when the 'dropDownMode' property is true.
16401
+ * @param {string} label. The label to be displayed in the dropdown button.
16402
+ */
16403
+ setDropDownLabel(label: string): void;
16225
16404
  /**
16226
16405
  * Sets the position of the vertical scrollbar. You can use this method in combination with the getVerticalScrollValue and getVerticalScrollMax.
16227
16406
  * @param {number} value. The new scroll position
@@ -16238,10 +16417,17 @@ export interface Grid extends BaseElement, GridProperties {
16238
16417
  */
16239
16418
  showDetail(rowId: string | number): void;
16240
16419
  /**
16241
- * Updates a row. When batch editing is enabled, the row is not saved until the batch edit is saved.
16420
+ * Shows an overlay message below a cell. This method can be used for onboarding tips or in scenarios when you want to display custom messages to the user.
16242
16421
  * @param {string | number} rowId. row bound id
16243
- * @param {any} data. row data matching the data source
16244
- * @param callback?. Sets a callback function, which is called after the row is updated. The callback's argument is the updated row.
16422
+ * @param {string} dataField. column bound data field. For example, if you have a column with dataField: 'firstName', set 'firstName' here.
16423
+ * @param {string} value. The message to be shown below the cell
16424
+ */
16425
+ showCellMessage(rowId: string | number, dataField: string, value: string): void;
16426
+ /**
16427
+ * Updates a row. When batch editing is enabled, the row is not saved until the batch edit is saved.
16428
+ * @param {string | number} rowId. row bound id
16429
+ * @param {any} data. row data matching the data source
16430
+ * @param callback?. Sets a callback function, which is called after the row is updated. The callback's argument is the updated row.
16245
16431
  */
16246
16432
  updateRow(rowId: string | number, data: any, callback?: {(row: GridRow): void}): void;
16247
16433
  /**
@@ -16438,6 +16624,16 @@ export interface GridAppearance {
16438
16624
  * Default value: true
16439
16625
  */
16440
16626
  showRowLines?: boolean;
16627
+ /**
16628
+ * Shows lines between columns in column groups.
16629
+ * Default value: true
16630
+ */
16631
+ showColumnGroupLines?: boolean;
16632
+ /**
16633
+ * Shows lines between cells in column groups.
16634
+ * Default value: true
16635
+ */
16636
+ showColumnGroupCellLines?: boolean;
16441
16637
  /**
16442
16638
  * Shows column groups in the Hide columns panel. Column groups and columns are shown in a tree-like structure. When the property is set to false, the column groups are not displayed and the column labels contain the column group name.
16443
16639
  * Default value: false
@@ -16459,10 +16655,10 @@ export interface GridAppearance {
16459
16655
  */
16460
16656
  showFrozenColumnBackground?: boolean;
16461
16657
  /**
16462
- * Shows filtered row background, when the Grid has frozen rows.
16463
- * Default value: true
16658
+ * Shows the selection on top of all other styles.
16659
+ * Default value: false
16464
16660
  */
16465
- showFrozenRowBackground?: boolean;
16661
+ showSelectionOnTop?: boolean;
16466
16662
  /**
16467
16663
  * Shows column sort button.
16468
16664
  * Default value: true
@@ -16542,6 +16738,11 @@ export interface GridBehavior {
16542
16738
  * Default value: false
16543
16739
  */
16544
16740
  allowColumnFreeze?: boolean;
16741
+ /**
16742
+ * Determines whether the scrolling with mouse wheel is enabled.
16743
+ * Default value: true
16744
+ */
16745
+ allowMouseWheel?: boolean;
16545
16746
  /**
16546
16747
  * Sets the column resize mode. split resize mode 'grows' or 'shrinks' the resize element's size and 'shrinks' or 'grows' the next sibling element's size. growAndShrink resize mode 'grows' or 'shrinks' the resize element's size
16547
16748
  * Default value: none
@@ -16554,48 +16755,13 @@ export interface GridBehavior {
16554
16755
  rowResizeMode?: GridResizeMode | string;
16555
16756
  }
16556
16757
 
16557
- /**An object containing settings related to the grid's layout. */
16558
- export interface GridLayout {
16559
- /**
16560
- * Enables or disables the Cells Value wrapping. When the property is true, cell value can wrap in multiple lines.
16561
- * Default value: false
16562
- */
16563
- allowCellsWrap?: boolean;
16564
- /**
16565
- * Automatically sets width to any new Column which does not have its 'width' property set.
16566
- * Default value: false
16567
- */
16568
- autoSizeNewColumn?: boolean;
16569
- /**
16570
- * Sets the width of the auto-generated Grid columns.
16571
- * Default value: null
16572
- */
16573
- autoGenerateColumnWidth?: string | number | null;
16574
- /**
16575
- * Sets the width of the Grid columns.
16576
- * Default value: null
16577
- */
16578
- columnWidth?: string | number | null;
16579
- /**
16580
- * Sets the height of the Grid columns.
16581
- * Default value: null
16582
- */
16583
- columnHeight?: string | number | null;
16584
- /**
16585
- * Sets the minimum height of the Grid columns.
16586
- * Default value: 30
16587
- */
16588
- columnMinHeight?: number;
16589
- /**
16590
- * Sets the minimum height of the Grid rows.
16591
- * Default value: 30
16592
- */
16593
- rowMinHeight?: number;
16758
+ /**Describes the column header settings. */
16759
+ export interface GridColumnHeader {
16594
16760
  /**
16595
- * Sets the height of the Grid rows. The property can be set to null, auto or a number.
16596
- * Default value: null
16761
+ * Sets the column header visibility.
16762
+ * Default value: true
16597
16763
  */
16598
- rowHeight?: string | number | null;
16764
+ visible?: boolean;
16599
16765
  }
16600
16766
 
16601
16767
  /**The <em>clipboard</em> property is used to enable/disable clipboard operations with Ctrl+C, Ctrl+X and Ctrl+V keyboard navigations.. */
@@ -16644,10 +16810,10 @@ export interface GridColumn {
16644
16810
  */
16645
16811
  allowSelect?: boolean | null;
16646
16812
  /**
16647
- * Sets or gets whether the column can be edited.
16813
+ * Sets or gets whether the column can be edited. The property can be 'boolean' i.e accept true and false values. To dynamically determine which cells are editable, a callback function can be supplied to the 'allowEdit' property. For example: allowEdit: (id, dataField, value, data) => { return value === 'Cappuccino'; }
16648
16814
  * Default value: true
16649
16815
  */
16650
- allowEdit?: boolean;
16816
+ allowEdit?: any;
16651
16817
  /**
16652
16818
  * Sets or gets whether the column can be sorted.
16653
16819
  * Default value: true
@@ -16678,6 +16844,11 @@ export interface GridColumn {
16678
16844
  * Default value: true
16679
16845
  */
16680
16846
  allowNull?: boolean;
16847
+ /**
16848
+ * Sets or gets the cell's height in card view mode.
16849
+ * Default value: false
16850
+ */
16851
+ cardHeight?: number;
16681
16852
  /**
16682
16853
  * Sets or gets the column's cells format. This property is used for applying a formatting to the cell values. Number format strings: 'd' - decimal numbers.'f' - floating-point numbers.'n' - integer numbers.'c' - currency numbers.'p' - percentage numbers.For adding decimal places to the numbers, add a number after the formatting striFor example: 'c3' displays a number in this format $25.256Built-in Date formats:// short date pattern'd' - 'M/d/yyyy',// long date pattern'D' - 'dddd, MMMM dd, yyyy',// short time pattern't' - 'h:mm tt',// long time pattern'T' - 'h:mm:ss tt',// long date, short time pattern'f' - 'dddd, MMMM dd, yyyy h:mm tt',// long date, long time pattern'F' - 'dddd, MMMM dd, yyyy h:mm:ss tt',// month/day pattern'M' - 'MMMM dd',// month/year pattern'Y' - 'yyyy MMMM',// S is a sortable format that does not vary by culture'S' - 'yyyy'-'MM'-'dd'T'HH':'mm':'ss'Date format strings:'d'-the day of the month;'dd'-the day of the month'ddd'-the abbreviated name of the day of the week'dddd'- the full name of the day of the week'h'-the hour, using a 12-hour clock from 1 to 12'hh'-the hour, using a 12-hour clock from 01 to 12'H'-the hour, using a 24-hour clock from 0 to 23'HH'- the hour, using a 24-hour clock from 00 to 23'm'-the minute, from 0 through 59'mm'-the minutes,from 00 though59'M'- the month, from 1 through 12'MM'- the month, from 01 through 12'MMM'-the abbreviated name of the month'MMMM'-the full name of the month's'-the second, from 0 through 59'ss'-the second, from 00 through 59't'- the first character of the AM/PM designator'tt'-the AM/PM designator'y'- the year, from 0 to 99'yy'- the year, from 00 to 99'yyy'-the year, with a minimum of three digits'yyyy'-the year as a four-digit number;'yyyyy'-the year as a four-digit number.
16683
16854
  * Default value: ""
@@ -16738,6 +16909,11 @@ export interface GridColumn {
16738
16909
  * Default value: ""
16739
16910
  */
16740
16911
  description?: string;
16912
+ /**
16913
+ * Sets or gets custom data object related to the column.
16914
+ * Default value: null
16915
+ */
16916
+ dataSet?: any;
16741
16917
  /**
16742
16918
  * Gets the HTML Element. The property returns null when the Column is not in the View.
16743
16919
  * Default value: null
@@ -16763,6 +16939,11 @@ export interface GridColumn {
16763
16939
  * Default value: default
16764
16940
  */
16765
16941
  filterMenuMode?: GridColumnFilterMenuMode | string;
16942
+ /**
16943
+ * Sets or gets the column's filter editor. The value is an object with the following possible options: template: string, condition: string, onInit: any - callback function for init purposes, min: number, max: number, minLength: number, maxLength: number
16944
+ * Default value: null
16945
+ */
16946
+ filterEditor?: any;
16766
16947
  /**
16767
16948
  * Sets or gets the column's format function.
16768
16949
  * Default value: null
@@ -16773,6 +16954,11 @@ export interface GridColumn {
16773
16954
  * Default value: [object Object]
16774
16955
  */
16775
16956
  formatSettings?: any;
16957
+ /**
16958
+ * Sets or gets the column's formula. The formula you set will be applied to all cells. Example: COL(Name) & '-' & COL(Price) or IF(COL(Price) * COL(Quantity) > 5, 'Yes', 'No')
16959
+ * Default value: ""
16960
+ */
16961
+ formula?: string;
16776
16962
  /**
16777
16963
  * Sets or gets the column's group.
16778
16964
  * Default value: ""
@@ -16813,6 +16999,16 @@ export interface GridColumn {
16813
16999
  * Default value: null
16814
17000
  */
16815
17001
  rowSpan?: {(cellValue: any, rowIndex: number, data: any): number};
17002
+ /**
17003
+ * Sets or gets the relation id in the dataSourceSettings.relations. The 'relationField' property should be set.
17004
+ * Default value: ""
17005
+ */
17006
+ relationId?: string;
17007
+ /**
17008
+ * Sets or gets the relation field in the dataSourceSettings.relations. The 'relationId' property should be set.
17009
+ * Default value: ""
17010
+ */
17011
+ relationField?: string;
16816
17012
  /**
16817
17013
  * Sets or gets the sort order of the column. Accepts: 'asc', 'desc' and null.
16818
17014
  * Default value: null
@@ -16849,10 +17045,15 @@ export interface GridColumn {
16849
17045
  */
16850
17046
  width?: string | number;
16851
17047
  /**
16852
- * Sets or gets the column's template. The property expects the 'id' of HTMLTemplateElement or HTML string which is displayed in the cells. Built-in string values are: 'checkBox', 'switchButton', 'radioButton', 'url', 'email', 'dropdownlist', 'list', 'progress', 'tags', 'autoNumber', 'modifiedBy', 'createdBy', 'createdTime', 'modifiedTime', 'images. For example, when you set the template to 'url', the cells will be render anchor tags. When you set the template property to HTMLTemplateElement you should consider that once a template is rendered, the formatObject.template property stores the rendered template component for further use.
17048
+ * Sets or gets the column's template. The property expects the 'id' of HTMLTemplateElement or HTML string which is displayed in the cells. Built-in string values are: 'checkBox', 'switchButton', 'url', 'email', 'dropdownlist', 'list', 'progress', 'tags', 'autoNumber', 'modifiedBy', 'createdBy', 'createdTime', 'modifiedTime', 'images', 'checklist', 'attachments', 'sparklines', 'richText', 'color', 'rating', 'duration', 'startDate', 'dueDates'. For example, when you set the template to 'url', the cells will be render anchor tags. When you set the template property to HTMLTemplateElement you should consider that once a template is rendered, the formatObject.template property stores the rendered template component for further use.
16853
17049
  * Default value:
16854
17050
  */
16855
17051
  template?: any;
17052
+ /**
17053
+ * Sets or gets additional settings related to the column's template. For example, when the template is 'sparklines', the templateSettings could be an object which defines has 'type' - 'bar', 'column', 'line' or 'pie'. If you want to apply a custom color, you can add the 'colorFunction: function(value) { } and return a custom color as a 'hex' string or a 'tooltipFormatFunction: function(value) {}' which returns a formatted tooltip string. Additional properties are 'min', 'max', 'gap' and 'strokeWidth'.
17054
+ * Default value: null
17055
+ */
17056
+ templateSettings?: any;
16856
17057
  /**
16857
17058
  * Sets or gets the column's validation rules. The expected value is an Array of Objects. Each object should have a 'type' property that can be set to 'required', 'min', 'max', 'minLength', 'maxLength', 'email', 'null', 'requiredTrue', 'minData', 'maxDate', 'pattern'. The 'value' property should be set, too. For validation rule types 'required', 'requiredTrue' and 'null' you can skip the 'value' property. Optional property is 'message', which determines the error message.
16858
17059
  * Default value: null
@@ -16887,6 +17088,11 @@ export interface GridContextMenu {
16887
17088
  * Default value: false
16888
17089
  */
16889
17090
  enabled?: boolean;
17091
+ /**
17092
+ * Sets an array of custom context menu items to be displayed in the context menu.
17093
+ * Default value: null
17094
+ */
17095
+ customContextMenuItems?: any[];
16890
17096
  /**
16891
17097
  * Sets the data sources to the context menu.
16892
17098
  * Default value: [object Object]
@@ -17354,6 +17560,11 @@ export interface GridDataSourceSettings {
17354
17560
  * Default value: "."
17355
17561
  */
17356
17562
  mapChar?: string;
17563
+ /**
17564
+ * Sets or gets the Grid relations. The property expects an array of objects. Each object should have '{id: string, label: string, columns: GridColumn[], dataSource: any}'. Once you have the relations defined, when you create a column, you can set 'relationId' and 'relationField'. This will automatically define a new column editor based on the relation settings.
17565
+ * Default value: null
17566
+ */
17567
+ relations?: any;
17357
17568
  /**
17358
17569
  * Sets the virtual data source function which is called each time the Grid requests data. Example for calling the callback function with the new data set: resultCallbackFunction({dataSource: data}); Demos using 'virtualDataSource' are available on the Grid demos page. Example: https://www.htmlelements.com/demos/grid/virtualscroll/
17359
17570
  * Default value: null
@@ -17416,6 +17627,11 @@ export interface GridEditing {
17416
17627
  * Default value: click
17417
17628
  */
17418
17629
  action?: GridEditingAction | string;
17630
+ /**
17631
+ * Read Only Edit is a mode in the grid whereby Cell Editing will not update the data inside the grid. Instead the grid invokes the 'onCellEditRequest' function allowing the application to process the update request.
17632
+ * Default value: false
17633
+ */
17634
+ readOnlyEdit?: boolean;
17419
17635
  /**
17420
17636
  * Describes command keys.
17421
17637
  * Default value: [object Object]
@@ -17766,6 +17982,20 @@ export interface GridFilteringFilterBuilder {
17766
17982
  height?: number | null;
17767
17983
  }
17768
17984
 
17985
+ /**Describes the footer settings of the grid. */
17986
+ export interface GridFooter {
17987
+ /**
17988
+ * Sets the footer visibility.
17989
+ * Default value: false
17990
+ */
17991
+ visible?: boolean;
17992
+ /**
17993
+ * Sets a template for the footer.
17994
+ * Default value:
17995
+ */
17996
+ template?: string | HTMLTemplateElement | {(element: HTMLElement): void};
17997
+ }
17998
+
17769
17999
  /**Describes the grid's grouping settings. */
17770
18000
  export interface GridGrouping {
17771
18001
  /**
@@ -17878,38 +18108,141 @@ export interface GridGroupingSummaryRow {
17878
18108
  visible?: boolean;
17879
18109
  }
17880
18110
 
17881
- /**Sets the grid's image and filter upload settings for the image and attachment columns. */
17882
- export interface GridUploadSettings {
18111
+ /**Describes the settings for the group header. */
18112
+ export interface GridGroupHeader {
17883
18113
  /**
17884
- * Sets or file/image upload url.
17885
- * Default value: ""
18114
+ * Sets the visibility of the group header.
18115
+ * Default value: false
17886
18116
  */
17887
- url?: string;
18117
+ visible?: boolean;
17888
18118
  /**
17889
- * Sets or file/image remove url.
17890
- * Default value: ""
18119
+ * Sets a template for the group header.
18120
+ * Default value:
17891
18121
  */
17892
- removeUrl?: string;
18122
+ template?: string | HTMLTemplateElement;
18123
+ }
18124
+
18125
+ /**Describes the header settings of the grid. */
18126
+ export interface GridHeader {
17893
18127
  /**
17894
- * Sets or gets the upload field name. In the backend, you can use this name to access the images data. For example in expressJS, you can use something like that: const images = req['files']['userfile[]'];
17895
- * Default value: "userfile[]"
18128
+ * Sets the header visibility.
18129
+ * Default value: false
17896
18130
  */
17897
- name?: string;
18131
+ visible?: boolean;
17898
18132
  /**
17899
- * Additional data to pass to the server. The format should be a JSON string.
17900
- * Default value: ""
18133
+ * Sets a template for the header.
18134
+ * Default value:
17901
18135
  */
17902
- data?: string;
18136
+ template?: string | HTMLTemplateElement | {(element: HTMLElement): void};
17903
18137
  /**
17904
- * Function called when the upload is completed. JSON object with 'files', 'status', 'fileURL' and 'serverResponse' are passed as parameters when the function is called by the Grid.
17905
- * Default value:
18138
+ * This callback function can be used for customization of the Header toolbar. The Toolbar HTML Element is passed as an argument.
18139
+ * Default value: null
17906
18140
  */
17907
- onUploadCompleted?: any;
18141
+ onInit?: {(element: HTMLElement): void};
17908
18142
  /**
17909
- * Function called when the upload has failed. JSON object with 'files', 'status' and 'serverResponse' are passed as parameters when the function is called by the Grid.
17910
- * Default value:
18143
+ * Determines the buttons displayed in the Grid header. 'columns' displays a button opening the columns chooser panel. 'filter' displays a button opening the filtering panel. 'group' displays a button opening the grouping panel. 'sort' displays a button opening the sorting panel. 'format' displays a button opening the conditional formatting panel. 'search' displays a button opening the search panel. 'colors' displays a button with colors options for formatting.
18144
+ * Default value: [ "columns", "filter", "group", "sort", "format", "search" ]
17911
18145
  */
17912
- onUploadError?: any;
18146
+ buttons?: string[];
18147
+ /**
18148
+ * Sets the search command type.
18149
+ * Default value: search
18150
+ */
18151
+ searchCommand?: GridHeaderSearchCommand | string;
18152
+ /**
18153
+ * Custom toolbar button. Allows you to add a custom button to the toolbar.
18154
+ * Default value: [object Object]
18155
+ */
18156
+ customButton?: GridCommand;
18157
+ }
18158
+
18159
+ /**An object containing settings related to the grid's layout. */
18160
+ export interface GridLayout {
18161
+ /**
18162
+ * Enables or disables the Cells Value wrapping. When the property is true, cell value can wrap in multiple lines.
18163
+ * Default value: false
18164
+ */
18165
+ allowCellsWrap?: boolean;
18166
+ /**
18167
+ * Automatically sets width to any new Column which does not have its 'width' property set.
18168
+ * Default value: false
18169
+ */
18170
+ autoSizeNewColumn?: boolean;
18171
+ /**
18172
+ * Sets the min width of the new column.
18173
+ * Default value: 250
18174
+ */
18175
+ autoSizeNewColumnMinWidth?: number;
18176
+ /**
18177
+ * Automatically sets the height of the Grid.
18178
+ * Default value: false
18179
+ */
18180
+ autoHeight?: boolean;
18181
+ /**
18182
+ * Automatically sets the width of the Grid. All columns should have a 'width' property set to a number in order to use this feature.
18183
+ * Default value: false
18184
+ */
18185
+ autoWidth?: boolean;
18186
+ /**
18187
+ * Sets the width of the auto-generated Grid columns.
18188
+ * Default value: null
18189
+ */
18190
+ autoGenerateColumnWidth?: string | number | null;
18191
+ /**
18192
+ * Sets the width of the Grid columns.
18193
+ * Default value: null
18194
+ */
18195
+ columnWidth?: string | number | null;
18196
+ /**
18197
+ * Sets the height of the Grid columns.
18198
+ * Default value: null
18199
+ */
18200
+ columnHeight?: string | number | null;
18201
+ /**
18202
+ * Sets the minimum height of the Grid columns.
18203
+ * Default value: 30
18204
+ */
18205
+ columnMinHeight?: number;
18206
+ /**
18207
+ * Sets the minimum width of a card in card view.
18208
+ * Default value: 250
18209
+ */
18210
+ cardMinWidth?: number;
18211
+ /**
18212
+ * Sets the cards per row.
18213
+ * Default value: null
18214
+ */
18215
+ cardsPerRow?: number;
18216
+ /**
18217
+ * Sets whether cards are vertically oriented. In this layout mode, the column label is displayed above the column value
18218
+ * Default value: false
18219
+ */
18220
+ cardVertical?: boolean;
18221
+ /**
18222
+ * Sets the width of the Grid when displayed in a drop-down mode.
18223
+ * Default value: 700
18224
+ */
18225
+ dropDownWidth?: number;
18226
+ /**
18227
+ * Sets the height of the Grid when displayed in a drop-down mode.
18228
+ * Default value: 500
18229
+ */
18230
+ dropDownHeight?: number;
18231
+ /**
18232
+ * Sets the minimum height of the Grid rows.
18233
+ * Default value: 30
18234
+ */
18235
+ rowMinHeight?: number;
18236
+ /**
18237
+ * Sets the height of the Grid rows. The property can be set to null, auto or a number.
18238
+ * Default value: null
18239
+ */
18240
+ rowHeight?: string | number | null;
18241
+ /**
18242
+ * Sets the width of the view bar.
18243
+ * Default value: 250
18244
+ */
18245
+ viewBarWidth?: number;
17913
18246
  }
17914
18247
 
17915
18248
  /**Describes the paging settings. */
@@ -18150,131 +18483,22 @@ export interface GridRowDetail {
18150
18483
  dialog?: Dialog;
18151
18484
  }
18152
18485
 
18153
- /**Describes the column header settings. */
18154
- export interface GridColumnHeader {
18486
+ export interface GridRow {
18155
18487
  /**
18156
- * Sets the column header visibility.
18488
+ * Sets or gets the row can be expanded or collapsed.
18157
18489
  * Default value: true
18158
18490
  */
18159
- visible?: boolean;
18160
- }
18161
-
18162
- /**Describes the summary row settings. */
18163
- export interface GridSummaryRow {
18491
+ allowToggle?: boolean;
18164
18492
  /**
18165
- * Sets the summary row visibility.
18166
- * Default value: false
18493
+ * Sets or gets the row can be resized.
18494
+ * Default value: true
18167
18495
  */
18168
- visible?: boolean;
18496
+ allowResize?: boolean;
18169
18497
  /**
18170
- * Sets the summary row editor. When you point over a summary row cell, an editor is displayed and you will be able to dynamically change the summary type.
18171
- * Default value: false
18498
+ * Sets or gets the row can be selected.
18499
+ * Default value: true
18172
18500
  */
18173
- editing?: boolean;
18174
- }
18175
-
18176
- /**Sets the grid's state settings. */
18177
- export interface GridStateSettings {
18178
- /**
18179
- * Enables or disables auto-save of the Grid's state
18180
- * Default value: false
18181
- */
18182
- autoSave?: boolean;
18183
- /**
18184
- * Enables or disables save/load of the grid state.
18185
- * Default value: true
18186
- */
18187
- enabled?: boolean;
18188
- /**
18189
- * Sets or gets the current state.
18190
- * Default value: ""
18191
- */
18192
- current?: string;
18193
- /**
18194
- * Container which is auto-filled with state objects when you call the saveState method or enable the autoSave of states. Each object has a key which is the state's name and value which is a json with the state's properties.
18195
- * Default value: null
18196
- */
18197
- storage?: any;
18198
- /**
18199
- * Function called when the state is changed.
18200
- * Default value:
18201
- */
18202
- onStateChange?: any;
18203
- /**
18204
- * Array with state options such as 'sort', 'filter', 'expandedRows', 'paging', 'selectedCells', 'selectedRows', 'group', 'columns'. This property determines which parts of the state would be saved or loaded.
18205
- * Default value:
18206
- */
18207
- options?: string[];
18208
- }
18209
-
18210
- /**Describes the settings for the group header. */
18211
- export interface GridGroupHeader {
18212
- /**
18213
- * Sets the visibility of the group header.
18214
- * Default value: false
18215
- */
18216
- visible?: boolean;
18217
- /**
18218
- * Sets a template for the group header.
18219
- * Default value:
18220
- */
18221
- template?: string | HTMLTemplateElement;
18222
- }
18223
-
18224
- /**Describes the header settings of the grid. */
18225
- export interface GridHeader {
18226
- /**
18227
- * Sets the header visibility.
18228
- * Default value: false
18229
- */
18230
- visible?: boolean;
18231
- /**
18232
- * Sets a template for the header.
18233
- * Default value:
18234
- */
18235
- template?: string | HTMLTemplateElement | {(element: HTMLElement): void};
18236
- /**
18237
- * This callback function can be used for customization of the Header toolbar. The Toolbar HTML Element is passed as an argument.
18238
- * Default value: null
18239
- */
18240
- onInit?: {(element: HTMLElement): void};
18241
- /**
18242
- * Determines the buttons displayed in the Grid header. 'columns' displays a button opening the columns chooser panel. 'filter' displays a button opening the filtering panel. 'group' displays a button opening the grouping panel. 'sort' displays a button opening the sorting panel. 'format' displays a button opening the conditional formatting panel. 'search' displays a button opening the search panel.
18243
- * Default value: [ "columns", "filter", "group", "sort", "format", "search" ]
18244
- */
18245
- buttons?: string[];
18246
- }
18247
-
18248
- /**Describes the footer settings of the grid. */
18249
- export interface GridFooter {
18250
- /**
18251
- * Sets the footer visibility.
18252
- * Default value: false
18253
- */
18254
- visible?: boolean;
18255
- /**
18256
- * Sets a template for the footer.
18257
- * Default value:
18258
- */
18259
- template?: string | HTMLTemplateElement | {(element: HTMLElement): void};
18260
- }
18261
-
18262
- export interface GridRow {
18263
- /**
18264
- * Sets or gets the row can be expanded or collapsed.
18265
- * Default value: true
18266
- */
18267
- allowToggle?: boolean;
18268
- /**
18269
- * Sets or gets the row can be resized.
18270
- * Default value: true
18271
- */
18272
- allowResize?: boolean;
18273
- /**
18274
- * Sets or gets the row can be selected.
18275
- * Default value: true
18276
- */
18277
- allowSelect?: boolean | null;
18501
+ allowSelect?: boolean | null;
18278
18502
  /**
18279
18503
  * Sets or gets the row can be checked. This property is used when the Grid is in Tree Grid or Grouped mode.
18280
18504
  * Default value: true
@@ -18515,6 +18739,59 @@ export interface GridCell {
18515
18739
  setStyle?: {(value: any): void};
18516
18740
  }
18517
18741
 
18742
+ /**Describes the summary row settings. */
18743
+ export interface GridSummaryRow {
18744
+ /**
18745
+ * Sets the summary row visibility.
18746
+ * Default value: false
18747
+ */
18748
+ visible?: boolean;
18749
+ /**
18750
+ * Sets the summary row editor. When you point over a summary row cell, an editor is displayed and you will be able to dynamically change the summary type.
18751
+ * Default value: false
18752
+ */
18753
+ editing?: boolean;
18754
+ }
18755
+
18756
+ /**Sets the grid's state settings. */
18757
+ export interface GridStateSettings {
18758
+ /**
18759
+ * Enables or disables auto-save of the Grid's state
18760
+ * Default value: false
18761
+ */
18762
+ autoSave?: boolean;
18763
+ /**
18764
+ * Enables or disables auto-load of the Grid's state on page reload.
18765
+ * Default value: false
18766
+ */
18767
+ autoLoad?: boolean;
18768
+ /**
18769
+ * Enables or disables save/load of the grid state.
18770
+ * Default value: true
18771
+ */
18772
+ enabled?: boolean;
18773
+ /**
18774
+ * Sets or gets the current state.
18775
+ * Default value: ""
18776
+ */
18777
+ current?: string;
18778
+ /**
18779
+ * Container which is auto-filled with state objects when you call the saveState method or enable the autoSave of states. Each object has a key which is the state's name and value which is a json with the state's properties.
18780
+ * Default value: null
18781
+ */
18782
+ storage?: any;
18783
+ /**
18784
+ * Function called when the state is changed.
18785
+ * Default value:
18786
+ */
18787
+ onStateChange?: any;
18788
+ /**
18789
+ * Array with state options such as 'sort', 'filter', 'expandedRows', 'paging', 'selectedCells', 'selectedRows', 'group', 'columns'. This property determines which parts of the state would be saved or loaded.
18790
+ * Default value:
18791
+ */
18792
+ options?: string[];
18793
+ }
18794
+
18518
18795
  /**Describes the selection settings. */
18519
18796
  export interface GridSelection {
18520
18797
  /**
@@ -18666,6 +18943,40 @@ export interface GridSorting {
18666
18943
  sortToggleOnClickAndCommandKey?: boolean;
18667
18944
  }
18668
18945
 
18946
+ /**Sets the grid's image and filter upload settings for the image and attachment columns. */
18947
+ export interface GridUploadSettings {
18948
+ /**
18949
+ * Sets or file/image upload url.
18950
+ * Default value: ""
18951
+ */
18952
+ url?: string;
18953
+ /**
18954
+ * Sets or file/image remove url.
18955
+ * Default value: ""
18956
+ */
18957
+ removeUrl?: string;
18958
+ /**
18959
+ * Sets or gets the upload field name. In the backend, you can use this name to access the images data. For example in expressJS, you can use something like that: const images = req['files']['userfile[]'];
18960
+ * Default value: "userfile[]"
18961
+ */
18962
+ name?: string;
18963
+ /**
18964
+ * Additional data to pass to the server. The format should be a JSON string.
18965
+ * Default value: ""
18966
+ */
18967
+ data?: string;
18968
+ /**
18969
+ * Function called when the upload is completed. JSON object with 'files', 'status', 'fileURL' and 'serverResponse' are passed as parameters when the function is called by the Grid.
18970
+ * Default value:
18971
+ */
18972
+ onUploadCompleted?: any;
18973
+ /**
18974
+ * Function called when the upload has failed. JSON object with 'files', 'status' and 'serverResponse' are passed as parameters when the function is called by the Grid.
18975
+ * Default value:
18976
+ */
18977
+ onUploadError?: any;
18978
+ }
18979
+
18669
18980
  declare global {
18670
18981
  interface Document {
18671
18982
  createElement(tagName: "smart-grid"): Grid;
@@ -18716,6 +19027,8 @@ export declare type GridFilteringFilterMenuMode = 'default' | 'excel';
18716
19027
  export declare type GridGroupingExpandMode = 'buttonClick' | 'rowClick';
18717
19028
  /**Sets the group render mode. 'basic' mode renders the group headers without taking into account the indent, groupRowHeight and column label properties. 'compact' mode is the same as basic, but also renders the column labels in the group headers. The default mode is 'advanced', which adds indents to groups that depend on the group level. In 'multipleColumns' mode, each group is displayed in its column. */
18718
19029
  export declare type GridGroupingRenderMode = 'basic' | 'compact' | 'advanced' | 'multipleColumns';
19030
+ /**Sets the search command type. */
19031
+ export declare type GridHeaderSearchCommand = 'search' | 'filter';
18719
19032
  /**Sets the ellipsis display mode. */
18720
19033
  export declare type GridPagerAutoEllipsis = 'none' | 'before' | 'after' | 'both';
18721
19034
  /**Sets or gets whether the selection allows you to select 'one', 'many' or a variation of 'many' called 'extended'. 'one' allows you to have only single cell or row selected. 'many' */
@@ -19143,6 +19456,11 @@ export interface KanbanProperties {
19143
19456
  * Default value: true
19144
19457
  */
19145
19458
  allowDrop?: boolean;
19459
+ /**
19460
+ * Allows the dropping of tasks placeholder. When you drag a task over another task it will make an empty space for the task.
19461
+ * Default value: false
19462
+ */
19463
+ allowDropPlaceholder?: boolean;
19146
19464
  /**
19147
19465
  * This property changes the visual appeal of the Kanban columns and tasks. When set to true and the Kanban columns have their 'color' property set, the color is also applied to the tasks and edit dialog.
19148
19466
  * Default value: false
@@ -19253,6 +19571,11 @@ export interface KanbanProperties {
19253
19571
  * Default value: false
19254
19572
  */
19255
19573
  editable?: boolean;
19574
+ /**
19575
+ * Determines the edit behavior. It could be either singleClick or doubleClick. The dialog edit window is by default opened when user double clicks on a Kanban task.
19576
+ * Default value: doubleClick
19577
+ */
19578
+ editMode?: KanbanEditMode | string;
19256
19579
  /**
19257
19580
  * Sets or gets the format string of the "Due date" label and the "Start date" and "Due date" editors.
19258
19581
  * Default value: "d"
@@ -19764,10 +20087,10 @@ export interface Kanban extends BaseElement, KanbanProperties {
19764
20087
  */
19765
20088
  getSelectedTasks(id: number): any;
19766
20089
  /**
19767
- * Gets the Kanban's state.
19768
- * @returns
20090
+ * Gets the Kanban's state. Returns an object with the following type: { collapsed: {}, dataSource: [], filtering: { filters: [], operator: string }, selection: { selected: [], selectionStart?: number | string, selectionInColumn: string, swimlane: string }, sorting: { dataFields: [], dataTypes: [], orderBy: [] }, tabs: [], visibility: { taskActions: boolean, taskComments: boolean, taskDue: boolean, taskPriority: boolean, taskProgress: boolean, taskTags: boolean, taskUserIcon: boolean } }
20091
+ * @returns {any}
19769
20092
  */
19770
- getState(): { collapsed: {}, dataSource: [], filtering: { filters: [], operator: string }, selection: { selected: [], selectionStart: number | string, selectionInColumn: string, swimlane: string }, sorting: { dataFields: [], dataTypes: [], orderBy: [] }, tabs: [], visibility: { taskActions: boolean, taskComments: boolean, taskDue: boolean, taskPriority: boolean, taskProgress: boolean, taskTags: boolean, taskUserIcon: boolean } };
20093
+ getState(): any;
19771
20094
  /**
19772
20095
  * Loads the Kanban's state.
19773
20096
  * @param state?. An object returned by one of the methods getState or saveState. If not passed, gets saved state from the browser's localStorage.
@@ -20078,6 +20401,8 @@ export declare type KanbanAddNewButtonDisplayMode = 'top' | 'bottom' | 'both';
20078
20401
  export declare type KanbanColumnOrientation = 'vertical' | 'horizontal';
20079
20402
  /**Determines the column edit behavior. With the 'header' option, edit starts on double click on the column's label. In 'menu' mode, edit is allowed from the 'columnActions' menu. In 'headerAndMenu' option, column editing includes both options. */
20080
20403
  export declare type KanbanColumnEditMode = 'header' | 'menu' | 'headerAndMenu';
20404
+ /**Determines the edit behavior. It could be either singleClick or doubleClick. The dialog edit window is by default opened when user double clicks on a Kanban task. */
20405
+ export declare type KanbanEditMode = 'doubleClick' | 'singleClick';
20081
20406
  /**Sets or gets the header position. The header contains the Customize, Filter, Sort, and Search buttons. */
20082
20407
  export declare type KanbanHeaderPosition = 'none' | 'top' | 'bottom';
20083
20408
  /**Sets or gets the way column hierarchy is represented. */
@@ -20870,6 +21195,11 @@ export interface ListBox extends BaseElement, ListBoxProperties {
20870
21195
  * @returns {Node}
20871
21196
  */
20872
21197
  appendChild<T extends Node>(node: Node): T;
21198
+ /**
21199
+ * Adds a new item(s).
21200
+ * @param {any} item. Describes the properties of the item that will be inserted. You can also pass an array of items.
21201
+ */
21202
+ add(item: any): void;
20873
21203
  /**
20874
21204
  * Removes all items from the listBox.
20875
21205
  */
@@ -20878,6 +21208,10 @@ export interface ListBox extends BaseElement, ListBoxProperties {
20878
21208
  * Unselects all items.
20879
21209
  */
20880
21210
  clearSelection(): void;
21211
+ /**
21212
+ * Performs a data bind. This can be used to refresh the data source.
21213
+ */
21214
+ dataBind(): void;
20881
21215
  /**
20882
21216
  * Ensures the target item is visible by scrolling to it.
20883
21217
  * @param {HTMLElement | string} item. A list item or value of the desired item to be visible.
@@ -25315,6 +25649,11 @@ export interface QRcodeProperties {
25315
25649
  * Default value: "H"
25316
25650
  */
25317
25651
  errorLevel?: string;
25652
+ /**
25653
+ * Sets color to the transparent parts of the embedded image. Background remains transparent if set to empty string.
25654
+ * Default value: ""
25655
+ */
25656
+ imageBackgroundColor?: string;
25318
25657
  /**
25319
25658
  * Sets the height of the embedded image.
25320
25659
  * Default value: 15
@@ -25375,6 +25714,16 @@ export interface QRcodeProperties {
25375
25714
  * Default value: ""
25376
25715
  */
25377
25716
  value?: string;
25717
+ /**
25718
+ * Sets or gets the width of the QR Code. If the width is set to 0, the width of the QR Code is calculated automatically.
25719
+ * Default value: 0
25720
+ */
25721
+ width?: number;
25722
+ /**
25723
+ * Sets or gets the height of the QR Code. If the height is set to 0, the height of the QR Code is calculated automatically.
25724
+ * Default value: 0
25725
+ */
25726
+ height?: number;
25378
25727
  }
25379
25728
  /**
25380
25729
  QR Codes encode text values in a two-dimensional pattern.
@@ -25892,238 +26241,660 @@ export interface RadioButton extends BaseElement, RadioButtonProperties {
25892
26241
  * oldValue - A boolean value indicating the previous state of the button ( checked or not ).
25893
26242
  * changeType - A string flag indicating whether the change event was triggered via API or an event.
25894
26243
  */
25895
- onChange: ((this: any, ev: Event) => any) | null;
26244
+ onChange: ((this: any, ev: Event) => any) | null;
26245
+ /**
26246
+ * This event is triggered when the widget is checked.
26247
+ * @param event. The custom event. Custom data event was created with: ev.detail(changeType)
26248
+ * changeType - A string flag indicating whether the change event was triggered via API or an event.
26249
+ */
26250
+ onCheckValue?: ((this: any, ev: Event) => any) | ((this: any, ev: CustomEvent<any>) => any) | null;
26251
+ /**
26252
+ * This event is triggered when the widget is unchecked.
26253
+ * @param event. The custom event. Custom data event was created with: ev.detail(changeType)
26254
+ * changeType - A string flag indicating whether the change event was triggered via API or an event.
26255
+ */
26256
+ onUncheckValue?: ((this: any, ev: Event) => any) | ((this: any, ev: CustomEvent<any>) => any) | null;
26257
+ }
26258
+
26259
+ declare global {
26260
+ interface Document {
26261
+ createElement(tagName: "smart-radio-button"): RadioButton;
26262
+ querySelector(selectors: "smart-radio-button"): RadioButton | null;
26263
+ querySelectorAll(selectors: "smart-radio-button"): NodeListOf<RadioButton>;
26264
+ getElementsByTagName(qualifiedName: "smart-radio-button"): HTMLCollectionOf<RadioButton>;
26265
+ getElementsByName(elementName: "smart-radio-button"): NodeListOf<RadioButton>;
26266
+ }
26267
+ }
26268
+
26269
+ export interface RatingProperties {
26270
+ /**
26271
+ * Sets or gets the animation mode. Animation is disabled when the property is set to 'none'
26272
+ * Default value: advanced
26273
+ */
26274
+ animation?: Animation | string;
26275
+ /**
26276
+ * Disables the interaction with the element.
26277
+ * Default value: false
26278
+ */
26279
+ disabled?: boolean;
26280
+ /**
26281
+ * Sets or gets the language. Used in conjunction with the property messages.
26282
+ * Default value: "en"
26283
+ */
26284
+ locale?: string;
26285
+ /**
26286
+ * Callback used to customize the format of the messages that are returned from the Localization Module.
26287
+ * Default value: null
26288
+ */
26289
+ localizeFormatFunction?: any;
26290
+ /**
26291
+ * Determines the number of stars that will be displayed.
26292
+ * Default value:
26293
+ */
26294
+ max?: number;
26295
+ /**
26296
+ * Sets or gets an object specifying strings used in the element that can be localized. Used in conjunction with the property locale.
26297
+ * Default value: * {
26298
+ * "en": {
26299
+ * "propertyUnknownType": "'' property is with undefined 'type' member!",
26300
+ * "propertyInvalidValue": "Invalid '!",
26301
+ * "propertyInvalidValueType": "Invalid '!",
26302
+ * "elementNotInDOM": "Element does not exist in DOM! Please, add the element to the DOM, before invoking a method.",
26303
+ * "moduleUndefined": "Module is undefined.",
26304
+ * "missingReference": ".",
26305
+ * "htmlTemplateNotSuported": ": Browser doesn't support HTMLTemplate elements.",
26306
+ * "invalidTemplate": "' property accepts a string that must match the id of an HTMLTemplate element from the DOM."
26307
+ * }
26308
+ * }
26309
+ */
26310
+ messages?: any;
26311
+ /**
26312
+ * The name of the element. Used when submiting data inside a Form.
26313
+ * Default value: ""
26314
+ */
26315
+ name?: string;
26316
+ /**
26317
+ * Sets or gets the value indicating whether the element is aligned to support locales using right-to-left fonts.
26318
+ * Default value: false
26319
+ */
26320
+ rightToLeft?: boolean;
26321
+ /**
26322
+ * Determines the theme. Theme defines the look of the element
26323
+ * Default value: ""
26324
+ */
26325
+ theme?: string;
26326
+ /**
26327
+ * If is set to true, the element cannot be focused.
26328
+ * Default value: false
26329
+ */
26330
+ unfocusable?: boolean;
26331
+ /**
26332
+ * Determines the number of stars that will be marked as active.
26333
+ * Default value:
26334
+ */
26335
+ value?: number;
26336
+ }
26337
+ /**
26338
+ Rating allows you to input a rating. It is broadly used in applications with reviews.
26339
+ */
26340
+ export interface Rating extends BaseElement, RatingProperties {
26341
+
26342
+ /* Get a member by its name */
26343
+ [name: string]: any;
26344
+ /**
26345
+ * This event is triggered when the value of the slider is changed.
26346
+ * @param event. The custom event. Custom data event was created with: ev.detail(value, oldValue)
26347
+ * value - A numeric value indicating the scroll position.
26348
+ * oldValue - A numeric value indicating the previous scroll position.
26349
+ */
26350
+ onChange: ((this: any, ev: Event) => any) | null;
26351
+ /**
26352
+ * Get the value of the rating.
26353
+ * @returns {number}
26354
+ */
26355
+ getValue(): number;
26356
+ /**
26357
+ * Sets the value of the rating.
26358
+ * @param {number} value. Sets the value of the rating
26359
+ */
26360
+ setValue(value: number): void;
26361
+ }
26362
+
26363
+ declare global {
26364
+ interface Document {
26365
+ createElement(tagName: "smart-rating"): Rating;
26366
+ querySelector(selectors: "smart-rating"): Rating | null;
26367
+ querySelectorAll(selectors: "smart-rating"): NodeListOf<Rating>;
26368
+ getElementsByTagName(qualifiedName: "smart-rating"): HTMLCollectionOf<Rating>;
26369
+ getElementsByName(elementName: "smart-rating"): NodeListOf<Rating>;
26370
+ }
26371
+ }
26372
+
26373
+ export interface RepeatButtonProperties {
26374
+ /**
26375
+ * Sets or gets the animation mode. Animation is disabled when the property is set to 'none'
26376
+ * Default value: advanced
26377
+ */
26378
+ animation?: Animation | string;
26379
+ /**
26380
+ * Sets the click mode of the button.
26381
+ * Default value: release
26382
+ */
26383
+ clickMode?: ClickMode | string;
26384
+ /**
26385
+ * Sets the delay between repeats in miliseconds.
26386
+ * Default value: 50
26387
+ */
26388
+ delay?: number;
26389
+ /**
26390
+ * Enables or disables the ratio button.
26391
+ * Default value: false
26392
+ */
26393
+ disabled?: boolean;
26394
+ /**
26395
+ * Sets a delay before the first repeat iteration in miliseconds.
26396
+ * Default value: 150
26397
+ */
26398
+ initialDelay?: number;
26399
+ /**
26400
+ * Sets the inner HTML of the element.
26401
+ * Default value: """"
26402
+ */
26403
+ innerHTML: string;
26404
+ /**
26405
+ * Sets or gets the language. Used in conjunction with the property messages.
26406
+ * Default value: "en"
26407
+ */
26408
+ locale?: string;
26409
+ /**
26410
+ * Callback, related to localization module.
26411
+ * Default value: null
26412
+ */
26413
+ localizeFormatFunction?: any;
26414
+ /**
26415
+ * Sets an object with string values, related to the different states of passwords strength.
26416
+ * Default value: * {
26417
+ * "en": {
26418
+ * "propertyUnknownType": "'' property is with undefined 'type' member!",
26419
+ * "propertyInvalidValue": "Invalid '!",
26420
+ * "propertyInvalidValueType": "Invalid '!",
26421
+ * "elementNotInDOM": "Element does not exist in DOM! Please, add the element to the DOM, before invoking a method.",
26422
+ * "moduleUndefined": "Module is undefined.",
26423
+ * "missingReference": ".",
26424
+ * "htmlTemplateNotSuported": ": Browser doesn't support HTMLTemplate elements.",
26425
+ * "invalidTemplate": "' property accepts a string that must match the id of an HTMLTemplate element from the DOM."
26426
+ * }
26427
+ * }
26428
+ */
26429
+ messages?: any;
26430
+ /**
26431
+ * Sets or gets the widget's name.
26432
+ * Default value: """"
26433
+ */
26434
+ name?: string;
26435
+ /**
26436
+ * If the custom element is readonly, it cannot be interacted with.
26437
+ * Default value: false
26438
+ */
26439
+ readonly?: boolean;
26440
+ /**
26441
+ * Determines the theme. Theme defines the look of the element
26442
+ * Default value: ""
26443
+ */
26444
+ theme?: string;
26445
+ /**
26446
+ * If is set to true, the element cannot be focused.
26447
+ * Default value: false
26448
+ */
26449
+ unfocusable?: boolean;
26450
+ /**
26451
+ * Sets or gets the widget's value.
26452
+ * Default value: """"
26453
+ */
26454
+ value?: string;
26455
+ }
26456
+ /**
26457
+ RepatButton provides press-and-hold functionality and it is an ideal UI component for allowing end-users to control an increasing or decreasing value.
26458
+ */
26459
+ export interface RepeatButton extends BaseElement, RepeatButtonProperties {
26460
+
26461
+ /* Get a member by its name */
26462
+ [name: string]: any;
26463
+ /**
26464
+ * This event is triggered when the element is clicked.
26465
+ * @param event. The custom event. */
26466
+ onClick: ((this: any, ev: Event) => any) | null;
26467
+ }
26468
+
26469
+ declare global {
26470
+ interface Document {
26471
+ createElement(tagName: "smart-repeat-button"): RepeatButton;
26472
+ querySelector(selectors: "smart-repeat-button"): RepeatButton | null;
26473
+ querySelectorAll(selectors: "smart-repeat-button"): NodeListOf<RepeatButton>;
26474
+ getElementsByTagName(qualifiedName: "smart-repeat-button"): HTMLCollectionOf<RepeatButton>;
26475
+ getElementsByName(elementName: "smart-repeat-button"): NodeListOf<RepeatButton>;
26476
+ }
26477
+ }
26478
+
26479
+ export interface RibbonProperties {
26480
+ /**
26481
+ * Determines whether the ribbon is collapsible.
26482
+ * Default value: false
26483
+ */
26484
+ collapsible?: any;
26485
+ /**
26486
+ * Determines the tab items of the ribbon.
26487
+ * Default value:
26488
+ */
26489
+ dataSource?: any;
26490
+ /**
26491
+ * Sets or gets the value indicating whether the element is disabled.
26492
+ * Default value: false
26493
+ */
26494
+ disabled?: boolean;
26495
+ /**
26496
+ * Determines the file menu options of the ribbon.
26497
+ * Default value: undefined
26498
+ */
26499
+ fileMenu?: RibbonFileMenu;
26500
+ /**
26501
+ * Determines the locale of the ribbon.
26502
+ * Default value: "en"
26503
+ */
26504
+ locale?: string;
26505
+ /**
26506
+ * Determines the messages of the ribbon
26507
+ * Default value: * [object Object]
26508
+ */
26509
+ messages?: any;
26510
+ /**
26511
+ * Sets or gets the value indicating whether the element is aligned to support locales using right-to-left fonts.
26512
+ * Default value: false
26513
+ */
26514
+ rightToLeft?: boolean;
26515
+ /**
26516
+ * Determines the selected tab.
26517
+ * Default value: 0
26518
+ */
26519
+ selectedTab?: any;
26520
+ }
26521
+ /**
26522
+ Ribbon is a navigation control that allows you to organize your application's commands in a tabbed interface.
26523
+ */
26524
+ export interface Ribbon extends BaseElement, RibbonProperties {
26525
+
26526
+ /* Get a member by its name */
26527
+ [name: string]: any;
26528
+ /**
26529
+ * This event is triggered when the ribbon is collapsed.
26530
+ * @param event. The custom event. */
26531
+ onCollapse?: ((this: any, ev: Event) => any) | ((this: any, ev: CustomEvent<any>) => any) | null;
26532
+ /**
26533
+ * This event is triggered when the ribbon is collapsing. The event can be canceled by calling event.preventDefault() in the event handler function.
26534
+ * @param event. The custom event. */
26535
+ onCollapsing?: ((this: any, ev: Event) => any) | ((this: any, ev: CustomEvent<any>) => any) | null;
26536
+ /**
26537
+ * This event is triggered when the dialog launcher is clicked.
26538
+ * @param event. The custom event. Custom data event was created with: ev.detail(groupLabel, groupId)
26539
+ * groupLabel - The label of the dialog launcher's ribbon group.
26540
+ * groupId - The id of the dialog launcher's ribbon group.
26541
+ */
26542
+ onDialogLauncherClick?: ((this: any, ev: Event) => any) | ((this: any, ev: CustomEvent<any>) => any) | null;
26543
+ /**
26544
+ * This event is triggered when the ribbon is expanded.
26545
+ * @param event. The custom event. */
26546
+ onExpand?: ((this: any, ev: Event) => any) | ((this: any, ev: CustomEvent<any>) => any) | null;
26547
+ /**
26548
+ * This event is triggered when the ribbon is expanding. The event can be canceled by calling event.preventDefault() in the event handler function.
26549
+ * @param event. The custom event. */
26550
+ onExpanding?: ((this: any, ev: Event) => any) | ((this: any, ev: CustomEvent<any>) => any) | null;
26551
+ /**
26552
+ * This event is triggered when the file menu button is clicked.
26553
+ * @param event. The custom event. */
26554
+ onFileButtonClick?: ((this: any, ev: Event) => any) | ((this: any, ev: CustomEvent<any>) => any) | null;
26555
+ /**
26556
+ * This event is triggered when the file menu is opened.
26557
+ * @param event. The custom event. */
26558
+ onFileMenuOpen?: ((this: any, ev: Event) => any) | ((this: any, ev: CustomEvent<any>) => any) | null;
26559
+ /**
26560
+ * This event is triggered when the file menu is closed.
26561
+ * @param event. The custom event. */
26562
+ onFileMenuClose?: ((this: any, ev: Event) => any) | ((this: any, ev: CustomEvent<any>) => any) | null;
26563
+ /**
26564
+ * This event is triggered when a file menu item is clicked.
26565
+ * @param event. The custom event. Custom data event was created with: ev.detail(item)
26566
+ * item - The file menu item.
26567
+ */
26568
+ onFileMenuItemClick?: ((this: any, ev: Event) => any) | ((this: any, ev: CustomEvent<any>) => any) | null;
26569
+ /**
26570
+ * This event is triggered when the tab selection is changed.
26571
+ * @param event. The custom event. Custom data event was created with: ev.detail(oldIndex, index)
26572
+ * oldIndex - The previous tab index.
26573
+ * index - The new index of the selected tab.
26574
+ */
26575
+ onSelect?: ((this: any, ev: Event) => any) | ((this: any, ev: CustomEvent<any>) => any) | null;
26576
+ /**
26577
+ * This event is triggered when the tab selection is changing. The event can be canceled by calling event.preventDefault() in the event handler function.
26578
+ * @param event. The custom event. Custom data event was created with: ev.detail(oldIndex, index)
26579
+ * oldIndex - The previous tab index.
26580
+ * index - The new index of the selected tab.
26581
+ */
26582
+ onSelecting?: ((this: any, ev: Event) => any) | ((this: any, ev: CustomEvent<any>) => any) | null;
26583
+ /**
26584
+ * Adds a new ribbon tab to the ribbon. The tab can be added as an object, HTMLElement or id to an HTMLElement.
26585
+ * @param {any} tab. The ribbon tab to be added.
26586
+ */
26587
+ addTab(tab: any): void;
26588
+ /**
26589
+ * Adds a new group to a ribbon tab. The group can be added as an object, HTMLElement or id to an HTMLElement.
26590
+ * @param {any} tab. The id, index or HTMLElement of the parent ribbon tab.
26591
+ * @param {any} group. The ribbon group to be added.
26592
+ */
26593
+ addGroup(tab: any, group: any): void;
26594
+ /**
26595
+ * Adds a new ribbon item to a ribbon group. The item can be added as an object, HTMLElement or id to an HTMLElement.
26596
+ * @param {string | number | HTMLElement} tab. The id, index or HTMLElement of the parent ribbon tab.
26597
+ * @param {string | HTMLElement} group. The id or HTMLElement of the parent ribbon group.
26598
+ * @param {any} item. The ribbon item to be added.
26599
+ */
26600
+ addItem(tab: string | number | HTMLElement, group: string | HTMLElement, item: any): void;
26601
+ /**
26602
+ * Collapses the ribbon.
26603
+ */
26604
+ collapse(): void;
26605
+ /**
26606
+ * Expands the ribbon.
26607
+ */
26608
+ expand(): void;
26609
+ /**
26610
+ * Removes a ribbon tab from the ribbon.
26611
+ * @param {string | number} ribbonTab. The id or index of the ribbon tab to be removed.
26612
+ */
26613
+ removeTab(ribbonTab: string | number): void;
25896
26614
  /**
25897
- * This event is triggered when the widget is checked.
25898
- * @param event. The custom event. Custom data event was created with: ev.detail(changeType)
25899
- * changeType - A string flag indicating whether the change event was triggered via API or an event.
26615
+ * Removes a ribbon group from a ribbon tab.
26616
+ * @param {string | number} ribbonTabIndex?. The id or index of the parent ribbon tab.
26617
+ * @param {string | number} ribbonGroup?. The id or index of the ribbon group to be removed.
25900
26618
  */
25901
- onCheckValue?: ((this: any, ev: Event) => any) | ((this: any, ev: CustomEvent<any>) => any) | null;
26619
+ removeGroup(ribbonTabIndex?: string | number, ribbonGroup?: string | number): void;
25902
26620
  /**
25903
- * This event is triggered when the widget is unchecked.
25904
- * @param event. The custom event. Custom data event was created with: ev.detail(changeType)
25905
- * changeType - A string flag indicating whether the change event was triggered via API or an event.
26621
+ * Removes a ribbon item from a ribbon group.
26622
+ * @param {string | number} ribbonTabIndex?. The id or index of the parent ribbon tab.
26623
+ * @param {string | number} ribbonGroup?. The id or index of the parent ribbon group.
26624
+ * @param {string | number} ribbonItem?. The id or index of the ribbon item to be removed.
25906
26625
  */
25907
- onUncheckValue?: ((this: any, ev: Event) => any) | ((this: any, ev: CustomEvent<any>) => any) | null;
25908
- }
25909
-
25910
- declare global {
25911
- interface Document {
25912
- createElement(tagName: "smart-radio-button"): RadioButton;
25913
- querySelector(selectors: "smart-radio-button"): RadioButton | null;
25914
- querySelectorAll(selectors: "smart-radio-button"): NodeListOf<RadioButton>;
25915
- getElementsByTagName(qualifiedName: "smart-radio-button"): HTMLCollectionOf<RadioButton>;
25916
- getElementsByName(elementName: "smart-radio-button"): NodeListOf<RadioButton>;
25917
- }
26626
+ removeItem(ribbonTabIndex?: string | number, ribbonGroup?: string | number, ribbonItem?: string | number): void;
26627
+ /**
26628
+ * Selects a ribbon tab.
26629
+ * @param {string | number} ribbonTabIndex. The index of the ribbon tab to be selected.
26630
+ */
26631
+ selectTab(ribbonTabIndex: string | number): void;
25918
26632
  }
25919
26633
 
25920
- export interface RatingProperties {
26634
+ /**Determines the file menu options of the ribbon. */
26635
+ export interface RibbonFileMenu {
25921
26636
  /**
25922
- * Sets or gets the animation mode. Animation is disabled when the property is set to 'none'
25923
- * Default value: advanced
26637
+ * Determines whether the file button is enabled.
26638
+ * Default value: true
25924
26639
  */
25925
- animation?: Animation | string;
26640
+ enabled?: boolean;
25926
26641
  /**
25927
- * Disables the interaction with the element.
25928
- * Default value: false
26642
+ * Determines the data source that will be loaded to the FileMenu.
26643
+ * Default value:
25929
26644
  */
25930
- disabled?: boolean;
26645
+ items?: any;
25931
26646
  /**
25932
- * Sets or gets the language. Used in conjunction with the property messages.
25933
- * Default value: "en"
26647
+ * Determines the position of the file menu.
26648
+ * Default value: left
25934
26649
  */
25935
- locale?: string;
26650
+ position?: RibbonFileMenuPosition | string;
25936
26651
  /**
25937
- * Callback used to customize the format of the messages that are returned from the Localization Module.
25938
- * Default value: null
26652
+ * Determines the label of the file menu.
26653
+ * Default value: "File"
25939
26654
  */
25940
- localizeFormatFunction?: any;
26655
+ label?: string;
25941
26656
  /**
25942
- * Determines the number of stars that will be displayed.
25943
- * Default value:
26657
+ * Determines the tooltip of the file menu.
26658
+ * Default value: ""
25944
26659
  */
25945
- max?: number;
26660
+ tooltip?: string;
25946
26661
  /**
25947
- * Sets or gets an object specifying strings used in the element that can be localized. Used in conjunction with the property locale.
25948
- * Default value: * {
25949
- * "en": {
25950
- * "propertyUnknownType": "'' property is with undefined 'type' member!",
25951
- * "propertyInvalidValue": "Invalid '!",
25952
- * "propertyInvalidValueType": "Invalid '!",
25953
- * "elementNotInDOM": "Element does not exist in DOM! Please, add the element to the DOM, before invoking a method.",
25954
- * "moduleUndefined": "Module is undefined.",
25955
- * "missingReference": ".",
25956
- * "htmlTemplateNotSuported": ": Browser doesn't support HTMLTemplate elements.",
25957
- * "invalidTemplate": "' property accepts a string that must match the id of an HTMLTemplate element from the DOM."
25958
- * }
25959
- * }
26662
+ * Determines the template of the file menu. Accepts HTMLTemplateElement, an id of an HTMLTemplateElement or a Function.
26663
+ * Default value: ""
25960
26664
  */
25961
- messages?: any;
26665
+ template?: string;
25962
26666
  /**
25963
- * The name of the element. Used when submiting data inside a Form.
26667
+ * Determines the type of the file menu.
26668
+ * Default value: dropDown
26669
+ */
26670
+ type?: RibbonFileMenuType | string;
26671
+ /**
26672
+ * Determines the icon of the file menu.
25964
26673
  * Default value: ""
25965
26674
  */
25966
- name?: string;
26675
+ icon?: string;
26676
+ }
26677
+
26678
+ declare global {
26679
+ interface Document {
26680
+ createElement(tagName: "smart-ribbon"): Ribbon;
26681
+ querySelector(selectors: "smart-ribbon"): Ribbon | null;
26682
+ querySelectorAll(selectors: "smart-ribbon"): NodeListOf<Ribbon>;
26683
+ getElementsByTagName(qualifiedName: "smart-ribbon"): HTMLCollectionOf<Ribbon>;
26684
+ getElementsByName(elementName: "smart-ribbon"): NodeListOf<Ribbon>;
26685
+ }
26686
+ }
26687
+
26688
+ /**Determines the position of the file menu. */
26689
+ export declare type RibbonFileMenuPosition = 'left' | 'right';
26690
+ /**Determines the type of the file menu. */
26691
+ export declare type RibbonFileMenuType = 'dropDown' | 'button';
26692
+ export interface RibbonGroupProperties {
25967
26693
  /**
25968
- * Sets or gets the value indicating whether the element is aligned to support locales using right-to-left fonts.
25969
- * Default value: false
26694
+ * Determines the label of the ribbon group.
26695
+ * Default value: ""
25970
26696
  */
25971
- rightToLeft?: boolean;
26697
+ label?: string;
25972
26698
  /**
25973
- * Determines the theme. Theme defines the look of the element
26699
+ * Determines the icon of the ribbon group.
25974
26700
  * Default value: ""
25975
26701
  */
25976
- theme?: string;
26702
+ icon?: string;
25977
26703
  /**
25978
- * If is set to true, the element cannot be focused.
25979
- * Default value: false
26704
+ * Determines the class of the ribbon group.
26705
+ * Default value: ""
25980
26706
  */
25981
- unfocusable?: boolean;
26707
+ cssClass?: string;
25982
26708
  /**
25983
- * Determines the number of stars that will be marked as active.
26709
+ * Determines the ribbon items of the ribbon group.
25984
26710
  * Default value:
25985
26711
  */
25986
- value?: number;
26712
+ ribbonItems?: any;
26713
+ /**
26714
+ * Determines the direction of the ribbon group.
26715
+ * Default value: horizontal
26716
+ */
26717
+ direction?: RibbonGroupDirection | string;
26718
+ /**
26719
+ * Determines the settings of the dialog launcher of the ribbon group.
26720
+ * Default value: [object Object]
26721
+ */
26722
+ dialogLauncher?: RibbonGroupDialogLauncher;
26723
+ /**
26724
+ * Determines the size, below which the ribbon group will be wrapped.
26725
+ * Default value: undefined
26726
+ */
26727
+ wrapSize?: RibbonGroupWrapSize | string;
25987
26728
  }
25988
26729
  /**
25989
- Rating allows you to input a rating. It is broadly used in applications with reviews.
26730
+ Defines a ribbon group.
25990
26731
  */
25991
- export interface Rating extends BaseElement, RatingProperties {
26732
+ export interface RibbonGroup extends BaseElement, RibbonGroupProperties {
25992
26733
 
25993
26734
  /* Get a member by its name */
25994
26735
  [name: string]: any;
26736
+ }
26737
+
26738
+ /**Determines the settings of the dialog launcher of the ribbon group. */
26739
+ export interface RibbonGroupDialogLauncher {
25995
26740
  /**
25996
- * This event is triggered when the value of the slider is changed.
25997
- * @param event. The custom event. Custom data event was created with: ev.detail(value, oldValue)
25998
- * value - A numeric value indicating the scroll position.
25999
- * oldValue - A numeric value indicating the previous scroll position.
26000
- */
26001
- onChange: ((this: any, ev: Event) => any) | null;
26002
- /**
26003
- * Get the value of the rating.
26004
- * @returns {number}
26741
+ * Determines whether the dialog launcher is enabled.
26742
+ * Default value: false
26005
26743
  */
26006
- getValue(): number;
26744
+ enabled?: boolean;
26007
26745
  /**
26008
- * Sets the value of the rating.
26009
- * @param {number} value. Sets the value of the rating
26746
+ * Determines the tooltip of the dialog launcher.
26747
+ * Default value: ""
26010
26748
  */
26011
- setValue(value: number): void;
26749
+ tooltip?: string;
26012
26750
  }
26013
26751
 
26014
26752
  declare global {
26015
26753
  interface Document {
26016
- createElement(tagName: "smart-rating"): Rating;
26017
- querySelector(selectors: "smart-rating"): Rating | null;
26018
- querySelectorAll(selectors: "smart-rating"): NodeListOf<Rating>;
26019
- getElementsByTagName(qualifiedName: "smart-rating"): HTMLCollectionOf<Rating>;
26020
- getElementsByName(elementName: "smart-rating"): NodeListOf<Rating>;
26754
+ createElement(tagName: "smart-ribbon-group"): RibbonGroup;
26755
+ querySelector(selectors: "smart-ribbon-group"): RibbonGroup | null;
26756
+ querySelectorAll(selectors: "smart-ribbon-group"): NodeListOf<RibbonGroup>;
26757
+ getElementsByTagName(qualifiedName: "smart-ribbon-group"): HTMLCollectionOf<RibbonGroup>;
26758
+ getElementsByName(elementName: "smart-ribbon-group"): NodeListOf<RibbonGroup>;
26021
26759
  }
26022
26760
  }
26023
26761
 
26024
- export interface RepeatButtonProperties {
26762
+ /**Determines the direction of the ribbon group. */
26763
+ export declare type RibbonGroupDirection = 'horizontal' | 'vertical';
26764
+ /**Determines the size, below which the ribbon group will be wrapped. */
26765
+ export declare type RibbonGroupWrapSize = 'iconOnly' | 'verySmall' | 'small' | 'normal' | 'large' | 'none';
26766
+ export interface RibbonItemProperties {
26025
26767
  /**
26026
- * Sets or gets the animation mode. Animation is disabled when the property is set to 'none'
26027
- * Default value: advanced
26768
+ * Determines whether the ribbon item is disabled.
26769
+ * Default value: false
26028
26770
  */
26029
- animation?: Animation | string;
26771
+ disabled?: boolean;
26030
26772
  /**
26031
- * Sets the click mode of the button.
26032
- * Default value: release
26773
+ * Determines the label of the ribbon item.
26774
+ * Default value: ""
26033
26775
  */
26034
- clickMode?: ClickMode | string;
26776
+ label?: string;
26035
26777
  /**
26036
- * Sets the delay between repeats in miliseconds.
26037
- * Default value: 50
26778
+ * Determines the type of the ribbon item.
26779
+ * Default value: button
26038
26780
  */
26039
- delay?: number;
26781
+ type?: RibbonItemType | string;
26040
26782
  /**
26041
- * Enables or disables the ratio button.
26042
- * Default value: false
26783
+ * Determines the template of the ribbon item. Accepts HTMLTemplateElement, an id of an HTMLTemplateElement or a Function.
26784
+ * Default value: ""
26043
26785
  */
26044
- disabled?: boolean;
26786
+ template?: string;
26045
26787
  /**
26046
- * Sets a delay before the first repeat iteration in miliseconds.
26047
- * Default value: 150
26788
+ * Determines the size of the ribbon item.
26789
+ * Default value: normal
26048
26790
  */
26049
- initialDelay?: number;
26791
+ size?: RibbonItemSize | string;
26050
26792
  /**
26051
- * Sets the inner HTML of the element.
26052
- * Default value: """"
26793
+ *
26794
+ * Default value: null
26053
26795
  */
26054
- innerHTML: string;
26796
+ sizeChanged?: any;
26055
26797
  /**
26056
- * Sets or gets the language. Used in conjunction with the property messages.
26057
- * Default value: "en"
26798
+ * Determines the allowed sizes of the ribbon item.
26799
+ * Default value:
26058
26800
  */
26059
- locale?: string;
26801
+ allowedSizes?: any;
26060
26802
  /**
26061
- * Callback, related to localization module.
26803
+ * Determines the icon of the ribbon item.
26804
+ * Default value: ""
26805
+ */
26806
+ icon?: string;
26807
+ /**
26808
+ * Determines the settings of the ribbon item. The settings will be applied as properties if the ribbon item is set to a Smart Element.
26809
+ * Default value: [object Object]
26810
+ */
26811
+ settings?: RibbonItemSettings;
26812
+ /**
26813
+ * Determines the class of the ribbon item.
26814
+ * Default value: ""
26815
+ */
26816
+ cssClass?: string;
26817
+ /**
26818
+ * Sets a click event handler for the ribbon item.
26062
26819
  * Default value: null
26063
26820
  */
26064
- localizeFormatFunction?: any;
26821
+ onItemClick?: any;
26065
26822
  /**
26066
- * Sets an object with string values, related to the different states of passwords strength.
26067
- * Default value: * {
26068
- * "en": {
26069
- * "propertyUnknownType": "'' property is with undefined 'type' member!",
26070
- * "propertyInvalidValue": "Invalid '!",
26071
- * "propertyInvalidValueType": "Invalid '!",
26072
- * "elementNotInDOM": "Element does not exist in DOM! Please, add the element to the DOM, before invoking a method.",
26073
- * "moduleUndefined": "Module is undefined.",
26074
- * "missingReference": ".",
26075
- * "htmlTemplateNotSuported": ": Browser doesn't support HTMLTemplate elements.",
26076
- * "invalidTemplate": "' property accepts a string that must match the id of an HTMLTemplate element from the DOM."
26077
- * }
26078
- * }
26823
+ * Sets a change event handler for the ribbon item.
26824
+ * Default value: null
26079
26825
  */
26080
- messages?: any;
26826
+ onItemChange?: any;
26081
26827
  /**
26082
- * Sets or gets the widget's name.
26083
- * Default value: """"
26828
+ * Determines the tooltip of the ribbon item.
26829
+ * Default value: ""
26084
26830
  */
26085
- name?: string;
26831
+ tooltip?: string;
26832
+ }
26833
+ /**
26834
+ Defines a ribbon item.
26835
+ */
26836
+ export interface RibbonItem extends BaseElement, RibbonItemProperties {
26837
+
26838
+ /* Get a member by its name */
26839
+ [name: string]: any;
26840
+ }
26841
+
26842
+ /**Determines the settings of the ribbon item. The settings will be applied as properties if the ribbon item is set to a Smart Element. */
26843
+ export interface RibbonItemSettings {
26844
+ }
26845
+
26846
+ declare global {
26847
+ interface Document {
26848
+ createElement(tagName: "smart-ribbon-item"): RibbonItem;
26849
+ querySelector(selectors: "smart-ribbon-item"): RibbonItem | null;
26850
+ querySelectorAll(selectors: "smart-ribbon-item"): NodeListOf<RibbonItem>;
26851
+ getElementsByTagName(qualifiedName: "smart-ribbon-item"): HTMLCollectionOf<RibbonItem>;
26852
+ getElementsByName(elementName: "smart-ribbon-item"): NodeListOf<RibbonItem>;
26853
+ }
26854
+ }
26855
+
26856
+ /**Determines the type of the ribbon item. */
26857
+ export declare type RibbonItemType = 'separator' | 'button' | 'toggleButton' | 'multiSplitButton' | 'dropDownButton' | 'input' | 'custom';
26858
+ /**Determines the size of the ribbon item. */
26859
+ export declare type RibbonItemSize = 'iconOnly' | 'small' | 'verySmall' | 'normal' | 'large';
26860
+ export interface RibbonTabProperties {
26086
26861
  /**
26087
- * If the custom element is readonly, it cannot be interacted with.
26862
+ * Determines whether the tab item is disabled.
26088
26863
  * Default value: false
26089
26864
  */
26090
- readonly?: boolean;
26865
+ disabled?: boolean;
26091
26866
  /**
26092
- * Determines the theme. Theme defines the look of the element
26867
+ * Determines the label of the tab item.
26093
26868
  * Default value: ""
26094
26869
  */
26095
- theme?: string;
26870
+ label?: string;
26096
26871
  /**
26097
- * If is set to true, the element cannot be focused.
26872
+ * Determines whether the tab item is selected.
26098
26873
  * Default value: false
26099
26874
  */
26100
- unfocusable?: boolean;
26875
+ selected?: boolean;
26101
26876
  /**
26102
- * Sets or gets the widget's value.
26103
- * Default value: """"
26877
+ * Determines the ribbon group of the tab item
26878
+ * Default value: undefined
26104
26879
  */
26105
- value?: string;
26880
+ ribbonGroups?: any;
26106
26881
  }
26107
26882
  /**
26108
- RepatButton provides press-and-hold functionality and it is an ideal UI component for allowing end-users to control an increasing or decreasing value.
26883
+ Defines a ribbon tab.
26109
26884
  */
26110
- export interface RepeatButton extends BaseElement, RepeatButtonProperties {
26885
+ export interface RibbonTab extends BaseElement, RibbonTabProperties {
26111
26886
 
26112
26887
  /* Get a member by its name */
26113
26888
  [name: string]: any;
26114
- /**
26115
- * This event is triggered when the element is clicked.
26116
- * @param event. The custom event. */
26117
- onClick: ((this: any, ev: Event) => any) | null;
26118
26889
  }
26119
26890
 
26120
26891
  declare global {
26121
26892
  interface Document {
26122
- createElement(tagName: "smart-repeat-button"): RepeatButton;
26123
- querySelector(selectors: "smart-repeat-button"): RepeatButton | null;
26124
- querySelectorAll(selectors: "smart-repeat-button"): NodeListOf<RepeatButton>;
26125
- getElementsByTagName(qualifiedName: "smart-repeat-button"): HTMLCollectionOf<RepeatButton>;
26126
- getElementsByName(elementName: "smart-repeat-button"): NodeListOf<RepeatButton>;
26893
+ createElement(tagName: "smart-ribbon-tab"): RibbonTab;
26894
+ querySelector(selectors: "smart-ribbon-tab"): RibbonTab | null;
26895
+ querySelectorAll(selectors: "smart-ribbon-tab"): NodeListOf<RibbonTab>;
26896
+ getElementsByTagName(qualifiedName: "smart-ribbon-tab"): HTMLCollectionOf<RibbonTab>;
26897
+ getElementsByName(elementName: "smart-ribbon-tab"): NodeListOf<RibbonTab>;
26127
26898
  }
26128
26899
  }
26129
26900
 
@@ -26148,6 +26919,11 @@ export interface SchedulerProperties {
26148
26919
  * Default value: #D50000,#E67C73,#F4511E,#F6BF26,#33B679,#0B8043,#039BE5,#3F51B5,#7986CB,#8E24AA,#616161,
26149
26920
  */
26150
26921
  colorScheme?: string[];
26922
+ /**
26923
+ * Determines the current time of the Scheduler to use for the current time indicator functionality. By default the current time is Today.
26924
+ * Default value: new Date()
26925
+ */
26926
+ currentTime?: string | Date;
26151
26927
  /**
26152
26928
  * Enables/Disables the current time indicator. Current time indicator shows the current time in the appropriate view cells.
26153
26929
  * Default value: false
@@ -26504,7 +27280,7 @@ export interface SchedulerProperties {
26504
27280
  */
26505
27281
  restrictedHours?: any;
26506
27282
  /**
26507
- * Defines an array of dates and hours that are not allowed to have events on. Events that overlap restricted Hours or start/end on them will not be displayed. Each array item is an Object and requires 2 fields - date and hours. For example: { date: new Date(2022, 10, 1), hours: [[0, 6], 12, [20, 23]] }. The hours define a range of restricted hours similartly to the restricted hours property, the date defines a date where the restricted hours will be applied.
27283
+ * Defines an array of dates and hours that are not allowed to have events on. Events that overlap restricted Hours or start/end on them will not be displayed. Each array item is an Object and requires 2 fields - date and hours. For example: { date: new Date(2023, 10, 1), hours: [[0, 6], 12, [20, 23]] }. The hours define a range of restricted hours similartly to the restricted hours property, the date defines a date where the restricted hours will be applied.
26508
27284
  * Default value:
26509
27285
  */
26510
27286
  restricted?: any;
@@ -26975,9 +27751,10 @@ export interface Scheduler extends BaseElement, SchedulerProperties {
26975
27751
  /**
26976
27752
  * Exports the events from the Scheduler.
26977
27753
  * @param {string} dataFormat. Determines the format of the exported file. The following values are available: <ul><li><b>pdf</b></li><li><b>xlsx</b></li><li><b>html</b></li><li><b>iCal</b></li></ul>
26978
- * @param {any} callback?. A callback that allows to format the exported data based on a condition. For additional details, refer ro the Smart Export Documentation.
27754
+ * @param {any} callback?. A callback that allows to format the exported data based on a condition. For additional details, refer to the Smart Export Documentation.
27755
+ * @param {any} dataCallback?. A callback that allows to change the exported data.
26979
27756
  */
26980
- exportData(dataFormat: string, callback?: any): void;
27757
+ exportData(dataFormat: string, callback?: any, dataCallback?: any): void;
26981
27758
  /**
26982
27759
  * Returns a JSON representation of the events inside the Scheduler.
26983
27760
  * @returns {any}
@@ -29087,7 +29864,7 @@ export interface TableProperties {
29087
29864
  * Sets or gets the page size (when paging is enabled).
29088
29865
  * Default value: 10
29089
29866
  */
29090
- pageSize?: TablePageSize | string;
29867
+ pageSize?: number;
29091
29868
  /**
29092
29869
  * Sets or gets the current (zero-based) page index (when paging is enabled).
29093
29870
  * Default value: 0
@@ -29108,6 +29885,11 @@ export interface TableProperties {
29108
29885
  * Default value: "null"
29109
29886
  */
29110
29887
  rowDetailTemplate?: string;
29888
+ /**
29889
+ * Sets or gets a callback function with 3 arguments - column, filterConditions, filterInputTemplateString. The function should return the new filter input.
29890
+ * Default value: null
29891
+ */
29892
+ onFilterRowInput?: any;
29111
29893
  /**
29112
29894
  * Sets or gets an array of the Table's selected row's ids.
29113
29895
  * Default value:
@@ -29463,6 +30245,10 @@ export interface Table extends BaseElement, TableProperties {
29463
30245
  * @param {string | number} row. The id of the cell's row.
29464
30246
  */
29465
30247
  removeRow(row: string | number): void;
30248
+ /**
30249
+ * Resets the Table's state. Information about columns, expanded rows, selected rows, applied fitering, grouping, and sorted columns is cleared, based on the value of the <strong>stateSettings</strong> property.
30250
+ */
30251
+ resetState(): void;
29466
30252
  /**
29467
30253
  * Saves the Table's state. Information about columns, expanded rows, selected rows, applied fitering, grouping, and sorted columns is saved, based on the value of the <strong>stateSettings</strong> property.
29468
30254
  * @returns {any}
@@ -29821,8 +30607,6 @@ export declare type TableDataSourceSettingsDataSourceType = 'array' | 'json' | '
29821
30607
  export declare type TableEditMode = 'cell' | 'row';
29822
30608
  /**Sets or gets the behavior when loading column settings either via autoLoadState or loadState. Applicable only when stateSettings contains 'columns'. */
29823
30609
  export declare type TableLoadColumnStateBehavior = 'implementationOnly' | 'intersection' | 'stateOnly';
29824
- /**Sets or gets the page size (when paging is enabled). */
29825
- export declare type TablePageSize = '10' | '25' | '50';
29826
30610
  /**Sets or gets the selection mode. Only applicable when selection is enabled. */
29827
30611
  export declare type TableSelectionMode = 'one' | 'many' | 'extended';
29828
30612
  /**Determines the sorting mode of the Table. */
@@ -30492,11 +31276,21 @@ export interface TextAreaProperties {
30492
31276
  * Default value: false
30493
31277
  */
30494
31278
  readonly?: boolean;
31279
+ /**
31280
+ * Determines whether ot not the user can resize the Textarea.
31281
+ * Default value: none
31282
+ */
31283
+ resize?: TextAreaResize | string;
30495
31284
  /**
30496
31285
  * Sets or gets the value indicating whether the element is aligned to support locales using right-to-left fonts.
30497
31286
  * Default value: false
30498
31287
  */
30499
31288
  rightToLeft?: boolean;
31289
+ /**
31290
+ * Enables or disables the rich text formatting.
31291
+ * Default value: false
31292
+ */
31293
+ richText?: boolean;
30500
31294
  /**
30501
31295
  * Determines whether the items are sorted alphabetically or not
30502
31296
  * Default value: false
@@ -30522,6 +31316,11 @@ export interface TextAreaProperties {
30522
31316
  * Default value: false
30523
31317
  */
30524
31318
  unfocusable?: boolean;
31319
+ /**
31320
+ * Sets the TextArea users. Expects an array of objects. Each object should have an id and name properties. When you press the 'at' key, you can enter an user from a dropdown.
31321
+ * Default value: []
31322
+ */
31323
+ users?: any[];
30525
31324
  /**
30526
31325
  * Sets or gets the value of the element.
30527
31326
  * Default value: ""
@@ -30559,6 +31358,11 @@ export interface TextArea extends BaseElement, TextAreaProperties {
30559
31358
  * Ensures that the active ( selected ) item is always visible.
30560
31359
  */
30561
31360
  ensureVisible(): void;
31361
+ /**
31362
+ * Returns an array of users mentioned in the Textarea's value.
31363
+ * @returns {any[]}
31364
+ */
31365
+ getMentions(): any[];
30562
31366
  /**
30563
31367
  * Opens the drop down.
30564
31368
  */
@@ -30581,6 +31385,8 @@ declare global {
30581
31385
 
30582
31386
  /**Determines the auto complete query mode. This property also determines the matching algorithm for the autocomplete operation. */
30583
31387
  export declare type TextAreaQueryMode = 'contains' | 'containsIgnoreCase' | 'doesNotContain' | 'doesNotContainIgnoreCase' | 'equals' | 'equalsIgnoreCase' | 'startsWith' | 'startsWithIgnoreCase' | 'endsWith' | 'endsWithIgnoreCase';
31388
+ /**Determines whether ot not the user can resize the Textarea. */
31389
+ export declare type TextAreaResize = 'none' | 'horizontal' | 'vertical' | 'both';
30584
31390
  export interface TextBoxProperties {
30585
31391
  /**
30586
31392
  * Sets or gets the animation mode. Animation is disabled when the property is set to 'none'
@@ -32013,6 +32819,12 @@ export interface Tree extends BaseElement, TreeProperties {
32013
32819
  * children - the children of the jqx-tree-items-group to be expanded
32014
32820
  */
32015
32821
  onExpanding?: ((this: any, ev: Event) => any) | ((this: any, ev: CustomEvent<any>) => any) | null;
32822
+ /**
32823
+ * This event is triggered when selection in jqx-tree is changed.
32824
+ * @param event. The custom event. Custom data event was created with: ev.detail(value)
32825
+ * value - The filter input value.
32826
+ */
32827
+ onFilterChange?: ((this: any, ev: Event) => any) | ((this: any, ev: CustomEvent<any>) => any) | null;
32016
32828
  /**
32017
32829
  * This event is triggered when the Tree has been scrolled to the bottom.
32018
32830
  * @param event. The custom event. */
@@ -32089,6 +32901,11 @@ export interface Tree extends BaseElement, TreeProperties {
32089
32901
  * @returns {HTMLElement}
32090
32902
  */
32091
32903
  getItem(id: string): HTMLElement;
32904
+ /**
32905
+ * Gets the applied filter.
32906
+ * @returns {string}
32907
+ */
32908
+ getFilter(): string;
32092
32909
  /**
32093
32910
  * Gets the selected values. If value is not defined, returns the selected labels.
32094
32911
  * @returns {string[]}