@smart-webcomponents-angular/window 24.0.16 → 25.5.5

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
@@ -2027,7 +2027,7 @@ export interface BreadcrumbProperties {
2027
2027
  */
2028
2028
  disabled?: boolean;
2029
2029
  /**
2030
- * Defines the template used to render each breadcrumb item. This property accepts either the ID of an '' element (as a string) or a reference to an actual 'HTMLTemplateElement'. When specified, the template determines the structure and content of each breadcrumb item. If set to 'null', the default rendering is used and no custom template is applied.
2030
+ * Defines the template used to render each breadcrumb item. This property accepts either the ID of an '<template>' element (as a string) or a reference to an actual 'HTMLTemplateElement'. When specified, the template determines the structure and content of each breadcrumb item. If set to 'null', the default rendering is used and no custom template is applied.
2031
2031
  * Default value: null
2032
2032
  */
2033
2033
  itemTemplate?: any;
@@ -2436,7 +2436,7 @@ export interface CalendarProperties {
2436
2436
  */
2437
2437
  firstDayOfWeek?: number;
2438
2438
  /**
2439
- * Defines a custom footer template for the component. You can provide either the ID of an existing '' element in the DOM, or pass a direct reference to an 'HTMLTemplateElement'. The specified template will be used to render the footer section of the component.
2439
+ * Defines a custom footer template for the component. You can provide either the ID of an existing '<template>' element in the DOM, or pass a direct reference to an 'HTMLTemplateElement'. The specified template will be used to render the footer section of the component.
2440
2440
  * Default value: null
2441
2441
  */
2442
2442
  footerTemplate?: any;
@@ -2466,7 +2466,7 @@ export interface CalendarProperties {
2466
2466
  */
2467
2467
  importantDates?: string[] | Date[];
2468
2468
  /**
2469
- * Defines a template for displaying important dates. This property accepts either the ID of an HTML '' element present in the DOM, or a direct reference to that template element. The specified template will be used to render each important date in the component.
2469
+ * Defines a template for displaying important dates. This property accepts either the ID of an HTML '<template>' element present in the DOM, or a direct reference to that template element. The specified template will be used to render each important date in the component.
2470
2470
  * Default value: null
2471
2471
  */
2472
2472
  importantDatesTemplate?: any;
@@ -2607,7 +2607,7 @@ export interface CalendarProperties {
2607
2607
  */
2608
2608
  tooltipPosition?: TooltipPosition | string;
2609
2609
  /**
2610
- * Defines the template used for the tooltip's content. You can provide either the ID of an existing '' element in the DOM or a direct reference to an HTMLTemplateElement. The tooltip will render its content based on the markup and structure defined within the specified template.
2610
+ * Defines the template used for the tooltip's content. You can provide either the ID of an existing '<template>' element in the DOM or a direct reference to an HTMLTemplateElement. The tooltip will render its content based on the markup and structure defined within the specified template.
2611
2611
  * Default value: null
2612
2612
  */
2613
2613
  tooltipTemplate?: any;
@@ -2768,7 +2768,7 @@ export interface CardProperties {
2768
2768
  */
2769
2769
  disabled?: boolean;
2770
2770
  /**
2771
- * Specifies a custom card template for rendering card content. The template can be provided either as a string representing the ID of an '' element present in the DOM, or as a direct reference to an HTMLTemplateElement. Within the template’s HTML content, you may include one or more property placeholders using the double curly braces syntax. During rendering, each placeholder will be dynamically replaced with the corresponding property value from the associated 'dataSource' object. If you set this property using a template ID, the expected type is a string.
2771
+ * Specifies a custom card template for rendering card content. The template can be provided either as a string representing the ID of an '<template>' element present in the DOM, or as a direct reference to an HTMLTemplateElement. Within the template’s HTML content, you may include one or more property placeholders using the double curly braces syntax. During rendering, each placeholder will be dynamically replaced with the corresponding property value from the associated 'dataSource' object. If you set this property using a template ID, the expected type is a string.
2772
2772
  * Default value: null
2773
2773
  */
2774
2774
  itemTemplate?: any;
@@ -5802,7 +5802,7 @@ export interface ChipProperties {
5802
5802
  */
5803
5803
  disabled?: boolean;
5804
5804
  /**
5805
- * Specifies a custom template for the chip component. The template can be provided either as a string representing the ID of an existing '' element in the DOM, or as a direct reference to an 'HTMLTemplateElement' instance. This allows developers to define and reuse custom chip layouts within the application.
5805
+ * Specifies a custom template for the chip component. The template can be provided either as a string representing the ID of an existing '<template>' element in the DOM, or as a direct reference to an 'HTMLTemplateElement' instance. This allows developers to define and reuse custom chip layouts within the application.
5806
5806
  * Default value: null
5807
5807
  */
5808
5808
  itemTemplate?: any;
@@ -6474,7 +6474,7 @@ export interface ColorPickerProperties {
6474
6474
  */
6475
6475
  disableUndo?: boolean;
6476
6476
  /**
6477
- * Defines the parent container in which the dropDown (popup) will be rendered. Accepts a CSS selector string, an element ID, or the literal value 'body'. This setting is helpful when the dropDown’s visibility is affected by CSS properties (such as overflow or z-index) applied to its parent elements. Specify 'body' to attach the dropDown directly to the element for maximum visibility. Example: 'body'.
6477
+ * Defines the parent container in which the dropDown (popup) will be rendered. Accepts a CSS selector string, an element ID, or the literal value 'body'. This setting is helpful when the dropDown’s visibility is affected by CSS properties (such as overflow or z-index) applied to its parent elements. Specify 'body' to attach the dropDown directly to the document body element for maximum visibility. Example: 'body'.
6478
6478
  * Default value: "body"
6479
6479
  */
6480
6480
  dropDownAppendTo?: string;
@@ -7087,7 +7087,7 @@ export interface ComboBoxProperties {
7087
7087
  */
7088
7088
  itemMeasureMode?: ListItemMeasureMode | string;
7089
7089
  /**
7090
- * A getter method that retrieves and returns an array containing all list ('') elements currently present within the dropdown menu. This allows you to easily access and manipulate every item displayed in the dropdown.
7090
+ * A getter method that retrieves and returns an array containing all list ('li') elements currently present within the dropdown menu. This allows you to easily access and manipulate every item displayed in the dropdown.
7091
7091
  * Default value:
7092
7092
  */
7093
7093
  items?: {label: string, value: string}[];
@@ -8657,7 +8657,7 @@ export interface DateTimePickerProperties {
8657
8657
  */
8658
8658
  importantDates?: string[] | Date[];
8659
8659
  /**
8660
- * Defines the template used to display important dates within the calendar pop-up. This property accepts either the ID of an existing '' element or a direct reference to an 'HTMLTemplateElement' in the DOM. The specified template determines how important dates are rendered inside the calendar interface, allowing for custom formatting and content.
8660
+ * Defines the template used to display important dates within the calendar pop-up. This property accepts either the ID of an existing '<template>' element or a direct reference to an 'HTMLTemplateElement' in the DOM. The specified template determines how important dates are rendered inside the calendar interface, allowing for custom formatting and content.
8661
8661
  * Default value: null
8662
8662
  */
8663
8663
  importantDatesTemplate?: string | HTMLTemplateElement;
@@ -8791,7 +8791,7 @@ export interface DateTimePickerProperties {
8791
8791
  */
8792
8792
  tooltipPosition?: TooltipPosition | string;
8793
8793
  /**
8794
- * Defines a custom template for the tooltip content displayed in the calendar pop-up. This property accepts either the ID of an HTML element or a direct reference to an HTMLTemplateElement. The specified template will be used to render the tooltip, allowing for customized layout and content in the calendar interface.
8794
+ * Defines a custom template for the tooltip content displayed in the calendar pop-up. This property accepts either the ID of an HTML <template> element or a direct reference to an HTMLTemplateElement. The specified template will be used to render the tooltip, allowing for customized layout and content in the calendar interface.
8795
8795
  * Default value: null
8796
8796
  */
8797
8797
  tooltipTemplate?: string | HTMLTemplateElement;
@@ -9683,7 +9683,7 @@ export interface DropDownListProperties {
9683
9683
  */
9684
9684
  itemMeasureMode?: ListItemMeasureMode | string;
9685
9685
  /**
9686
- * A getter that retrieves and returns an array containing all list item elements ('') currently present within the dropdown menu. This allows easy access to each item for further processing or manipulation.
9686
+ * A getter that retrieves and returns an array containing all list item elements ('li') currently present within the dropdown menu. This allows easy access to each item for further processing or manipulation.
9687
9687
  * Default value:
9688
9688
  */
9689
9689
  items?: any;
@@ -14355,6 +14355,11 @@ export interface GanttChart extends BaseElement, GanttChartProperties {
14355
14355
  * @param {boolean} fullRefresh?. If set the GanttChart will be re-rendered completely.
14356
14356
  */
14357
14357
  refresh(fullRefresh?: boolean): void;
14358
+ /**
14359
+ * Collapses all rows.
14360
+ * @returns {any}
14361
+ */
14362
+ collapseAllRows(): any;
14358
14363
  /**
14359
14364
  * Ensures that the specified task element is brought into view within the scrollable container by automatically scrolling the page or container if necessary, so the task is fully visible to the user.
14360
14365
  * @param {string | number} taskId. The id of the target Task.
@@ -14371,6 +14376,11 @@ export interface GanttChart extends BaseElement, GanttChartProperties {
14371
14376
  * @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.
14372
14377
  */
14373
14378
  exportData(dataFormat: string, callback?: any): void;
14379
+ /**
14380
+ * Expands all rows.
14381
+ * @returns {any}
14382
+ */
14383
+ expandAllRows(): any;
14374
14384
  /**
14375
14385
  * Retrieves a complete list of all current connections. The returned value is an array of objects, where each object represents a single connection and includes comprehensive metadata about that connection. Each connection object contains the following properties:<br/><br/>- **id**: A unique identifier for the connection.<br/>- **type**: The type or category of the connection (e.g., dependency, sequential, etc.).<br/>- **startTaskId**: The unique identifier of the task where the connection originates.<br/>- **endTaskId**: The unique identifier of the task where the connection terminates.<br/>- **startIndex**: The index position within the start task from which the connection begins (useful for tasks with multiple connection points).<br/>- **endIndex**: The index position within the end task where the connection attaches.<br/>- **lag**: The lag time, typically in milliseconds or a project-specific unit, representing any delay between the linked tasks.<br/><br/>This structure provides all necessary details for understanding the relationship and timing between connected tasks.
14376
14386
  * @returns {any}
@@ -15473,10 +15483,20 @@ export interface GridProperties {
15473
15483
  */
15474
15484
  columnGroups?: GridColumnGroup[];
15475
15485
  /**
15476
- *
15486
+ * Enables or disables the dropdown mode for the component. When true, the component displays as a dropdown instead of a standard input or list.
15477
15487
  * Default value: false
15478
15488
  */
15479
15489
  dropDownMode?: boolean;
15490
+ /**
15491
+ * Determines whether the dropdown mode allows text input. When true, users can type in the dropdown field; otherwise, selection is restricted to the provided list items.
15492
+ * Default value: false
15493
+ */
15494
+ dropDownModeInput?: boolean;
15495
+ /**
15496
+ * Specifies the data field or property to display in dropdown mode. This is the field from the data source that will be shown as the dropdown options.
15497
+ * Default value: ""
15498
+ */
15499
+ dropDownModeDataField?: string;
15480
15500
  /**
15481
15501
  * Defines or retrieves the rules and settings for conditional formatting applied to the Grid's cells, allowing you to customize cell appearance (such as background color, font style, or icons) based on specific conditions or cell values.
15482
15502
  * Default value: null
@@ -15506,7 +15526,7 @@ export interface GridProperties {
15506
15526
  * Configures the grid’s data source when the dataSource property is assigned either a JavaScript array (for local data) or a URL (for remote data). This setting determines how the grid retrieves and displays its data, supporting both direct array binding and remote data fetching via HTTP requests.
15507
15527
  * Default value: [object Object]
15508
15528
  */
15509
- dataSourceSettings?: GridDataSourceSettings;
15529
+ dataSourceSettings?: any;
15510
15530
  /**
15511
15531
  * Provides comprehensive configuration options for controlling the grid's editing behavior, including enabling or disabling editing features, specifying editing modes (such as inline, popup, or batch), setting validation rules, and customizing editors for specific columns.
15512
15532
  * Default value: [object Object]
@@ -15558,7 +15578,7 @@ export interface GridProperties {
15558
15578
  */
15559
15579
  locale?: string;
15560
15580
  /**
15561
- * 'Key Handling:' You can customize how key presses are handled by defining key mappings within the configuration. For each key (e.g., '"Enter"'), you can assign:- 'Another key as the value' (e.g., '"Enter": "Tab"'): When the specified key is pressed, it will be treated as if the mapped key was pressed instead.- 'A predefined action' (e.g., ''copy'', ''copyPrev'', ''copyNext'', ''delete''): When the key is pressed, the associated action will be executed.- 'A custom function': Assign a function as the value to execute custom logic whenever the key is pressed.This allows you to remap keys, trigger built-in actions, or define entirely custom behaviors based on key events in your application.
15581
+ * 'Key Handling:' You can customize how key presses are handled by defining key map within the configuration. For each key (e.g., '"Enter"'), you can assign:- 'Another key as the value' (e.g., '"Enter": "Tab"'): When the specified key is pressed, it will be treated as if the mapped key was pressed instead.- 'A predefined action' (e.g., ''copy'', ''copyPrev'', ''copyNext'', ''delete''): When the key is pressed, the associated action will be executed.- 'A custom function': Assign a function as the value to execute custom logic whenever the key is pressed.This allows you to remap keys, trigger built-in actions, or define entirely custom behaviors based on key events in your application.
15562
15582
  * Default value: null
15563
15583
  */
15564
15584
  keys?: any;
@@ -16133,8 +16153,9 @@ export interface Grid extends BaseElement, GridProperties {
16133
16153
  * @param {any} data. An object representing the row data, matching the structure of the grid's data source.
16134
16154
  * @param {boolean} insertAtBottom?. Determines whether the new row is added at the bottom (true) or top (false) of the grid. Defaults to true.
16135
16155
  * @param callback?. A callback function invoked after the row is successfully added. Receives the newly added row as an argument.
16156
+ * @returns {any}
16136
16157
  */
16137
- addRow(data: any, insertAtBottom?: boolean, callback?: {(row: GridRow): void}): void;
16158
+ addRow(data: any, insertAtBottom?: boolean, callback?: {(row: GridRow): void}): any;
16138
16159
  /**
16139
16160
  * Inserts a new row into the grid and automatically activates edit mode for that row, allowing users to begin entering data right away. If batch editing is enabled, any changes made will be temporarily stored and will not be saved to the data source until the batch edit session is explicitly committed. This helps prevent partial or unsaved changes from being applied before the user finalizes all edits in the session.
16140
16161
  * @param {string} position?. Specifies the position where the new row will be added. Acceptable values are 'near' (top) or 'far' (bottom).
@@ -16486,6 +16507,12 @@ export interface Grid extends BaseElement, GridProperties {
16486
16507
  * @returns {GridRow}
16487
16508
  */
16488
16509
  getRowByIndex(rowIndex: number): GridRow;
16510
+ /**
16511
+ * Returns the Grid row object by its HTML Element, allowing access to all data and properties associated with that specific row.
16512
+ * @param {any} rowElement. The row's element.
16513
+ * @returns {GridRow}
16514
+ */
16515
+ getRowByElement(rowElement: any): GridRow;
16489
16516
  /**
16490
16517
  * Fetches the original data source object directly linked to the given row ID, allowing access to all underlying data fields for that specific row as stored in the source dataset.
16491
16518
  * @param {string | number} rowId. The unique identifier of the row.
@@ -16531,13 +16558,41 @@ export interface Grid extends BaseElement, GridProperties {
16531
16558
  * @param {string} className?. Optional CSS class name for custom highlight styling.
16532
16559
  */
16533
16560
  highlightRow(rowId: string | number, className?: string): void;
16561
+ /**
16562
+ * Emphasizes a specific cell within the grid, identified by its row ID and column data field.
16563
+ * @param {string | number} rowId. The unique identifier of the row containing the cell.
16564
+ * @param {string} dataField. The data field name of the column.
16565
+ */
16566
+ flashCell(rowId: string | number, dataField: string): void;
16567
+ /**
16568
+ * Enhances visibility of the table row corresponding to the provided row ID by applying a flash effect.
16569
+ * @param {string | number} rowId. The unique identifier of the row to highlight.
16570
+ */
16571
+ flashRow(rowId: string | number): void;
16534
16572
  /**
16535
16573
  * Adds a new row to the grid using the provided data object. If batch editing mode is active, the row will be added only as a pending change and will not be permanently committed to the data source until the batch is saved. You may optionally specify the index at which the new row should be inserted; if omitted, the row will be added at the default position (usually at the end). Additionally, you can provide a callback function that will be executed after the row has been successfully added to the grid.
16536
16574
  * @param {any} data. The data object for the new row, matching the grid's data source schema.
16537
16575
  * @param {number} index?. The zero-based index at which to insert the new row. Defaults to the last position if omitted.
16538
16576
  * @param callback?. Optional callback function executed after the row is inserted, receiving the newly added row object.
16577
+ * @returns {any}
16539
16578
  */
16540
- insertRow(data: any, index?: number, callback?: {(row: GridRow): void}): void;
16579
+ insertRow(data: any, index?: number, callback?: {(row: GridRow): void}): any;
16580
+ /**
16581
+ * Adds a new row to the grid using the provided data object. If batch editing mode is active, the row will be added only as a pending change and will not be permanently committed to the data source until the batch is saved. You may optionally specify the index at which the new row should be inserted; if omitted, the row will be added at the default position (usually at the end). Additionally, you can provide a callback function that will be executed after the row has been successfully added to the grid.
16582
+ * @param {any} data. The data object for the new row, matching the grid's data source schema.
16583
+ * @param {any} row?. The Grid row after which the new row will be added.
16584
+ * @param callback?. Optional callback function executed after the row is inserted, receiving the newly added row object.
16585
+ * @returns {any}
16586
+ */
16587
+ insertRowAfter(data: any, row?: any, callback?: {(row: GridRow): void}): any;
16588
+ /**
16589
+ * Adds a new row to the grid using the provided data object. If batch editing mode is active, the row will be added only as a pending change and will not be permanently committed to the data source until the batch is saved. You may optionally specify the index at which the new row should be inserted; if omitted, the row will be added at the default position (usually at the end). Additionally, you can provide a callback function that will be executed after the row has been successfully added to the grid.
16590
+ * @param {any} data. The data object for the new row, matching the grid's data source schema.
16591
+ * @param {any} row?. The Grid row before which the new row will be added.
16592
+ * @param callback?. Optional callback function executed after the row is inserted, receiving the newly added row object.
16593
+ * @returns {any}
16594
+ */
16595
+ insertRowBefore(data: any, row?: any, callback?: {(row: GridRow): void}): any;
16541
16596
  /**
16542
16597
  * Restored a previously saved grid state by accepting either the name of the saved state or a state object. The state object can include detailed settings such as current sorting and filtering criteria, column visibility and order, expanded or collapsed row status, grouping configurations, paging information (such as current page and page size), and selected rows. This allows the grid to be reconfigured exactly as it was when the state was saved, providing a consistent user experience across sessions.
16543
16598
  * @param {any} state. A state name (string) previously saved or a state object representing the grid configuration to load.
@@ -16747,7 +16802,14 @@ export interface Grid extends BaseElement, GridProperties {
16747
16802
  */
16748
16803
  closeSidePanel(): void;
16749
16804
  /**
16750
- * Displays the Grid's side panel, providing access to additional settings, filters, and customization options related to the Grid's content and layout.
16805
+ * Displays the Grid's side panel, and displays Element in it. This is useful if you have HTML Element on a page and want to move it and display it as a Side panel of the Grid.
16806
+ * @param {any} content. This is the content which will be displayed in the side panel. It can be String, HTML Element, HTML Template Element or Component
16807
+ * @param {number} width?. This is the width of the side panel
16808
+ * @param {any} callback?. Function called when the panel is opened. It can be used for dynamically showing content and initializing it.
16809
+ */
16810
+ openSidePanel(content: any, width?: number, callback?: any): void;
16811
+ /**
16812
+ * Displays the Grid's side panel showing custom content in it. It creates a clone of the content and displays it.
16751
16813
  * @param {any} content. This is the content which will be displayed in the side panel. It can be String, HTML Element, HTML Template Element or Component
16752
16814
  * @param {number} width?. This is the width of the side panel
16753
16815
  * @param {any} callback?. Function called when the panel is opened. It can be used for dynamically showing content and initializing it.
@@ -17093,6 +17155,16 @@ export interface GridAi {
17093
17155
  * Default value: ""
17094
17156
  */
17095
17157
  key?: string;
17158
+ /**
17159
+ * Sets or gets the AI Assistant's prompts.
17160
+ * Default value: []
17161
+ */
17162
+ prompts?: any[];
17163
+ /**
17164
+ * Sets or gets the AI Assistant's prompts variables which will be replaced in the AI prompts. Ex: promptVariables: [{ name: 'review', dataField: 'review' }, { name: 'rating', dataField: 'rating' } ]
17165
+ * Default value: []
17166
+ */
17167
+ promptVariables?: any[];
17096
17168
  }
17097
17169
 
17098
17170
  /**An object that defines configuration options controlling the grid’s behavior, such as layout properties, sorting and filtering capabilities, selection modes, and responsiveness settings. */
@@ -17273,6 +17345,11 @@ export interface GridColumn {
17273
17345
  * Default value: null
17274
17346
  */
17275
17347
  cellsCSSRules?: any;
17348
+ /**
17349
+ * Sets or gets whether the column is collapsed.
17350
+ * Default value: false
17351
+ */
17352
+ collapsed?: boolean;
17276
17353
  /**
17277
17354
  * Sets or gets the column's cells renderer function for custom html rendering in the cells. For more advanced scenarios use formatFunction or template, but for simple html rendering, you can use this.
17278
17355
  * Default value: null
@@ -17308,6 +17385,11 @@ export interface GridColumn {
17308
17385
  * Default value: null
17309
17386
  */
17310
17387
  dataSet?: any;
17388
+ /**
17389
+ * Sets or gets which columns will be expanded/collapsed when the column is collapsible. The property expects an array of data fields.
17390
+ * Default value:
17391
+ */
17392
+ detailColumns?: any[];
17311
17393
  /**
17312
17394
  * Gets the HTML Element. The property returns null when the Column is not in the View.
17313
17395
  * Default value: null
@@ -17325,9 +17407,9 @@ export interface GridColumn {
17325
17407
  freeze?: Position | string;
17326
17408
  /**
17327
17409
  * Sets or gets the filter of the column. Example: ['contains Andrew or contains Nancy']. Example with numeric filter ['quantity', '&lt;= 3 and &gt;= 8']. Additional example with filter which we want to apply to a column with filterMenuMode='excel' - ['EQUAL' 'Andrew' or 'EQUAL' 'Antoni' or 'EQUAL' 'Beate']. Example with a string filter applied to a string column - ['CONTAINS' 'burke' or 'CONTAINS' 'peterson']. Filter conditions which you can use in the expressions: '=', 'EQUAL','&lt;&gt;', 'NOT_EQUAL', '!=', '&lt;', 'LESS_THAN','&gt;', 'GREATER_THAN', '&lt;=', 'LESS_THAN_OR_EQUAL', '&gt;=', 'GREATER_THAN_OR_EQUAL','starts with', 'STARTS_WITH','ends with', 'ENDS_WITH', '', 'EMPTY', 'CONTAINS','DOES_NOT_CONTAIN', 'NULL','NOT_NULL'
17328
- * Default value: ""
17410
+ * Default value:
17329
17411
  */
17330
- filter?: string;
17412
+ filter?: any;
17331
17413
  /**
17332
17414
  * Sets or gets the filter menu mode of the column. In 'basic' mode, a single input is displayed in the filter menu. In 'default' mode, two input options are available for more precise filtering. In 'excel' mode, checked list with unique values is displayed.
17333
17415
  * Default value: default
@@ -17383,11 +17465,21 @@ export interface GridColumn {
17383
17465
  * Default value:
17384
17466
  */
17385
17467
  labelTemplate?: string | HTMLTemplateElement | HTMLElement | {(label: string): string};
17468
+ /**
17469
+ * Sets or gets the column header's template function. The property expects a function(element) { } which can be used to set up the column's header label.
17470
+ * Default value: null
17471
+ */
17472
+ headerTemplate?: HTMLElement;
17386
17473
  /**
17387
17474
  * Sets or gets the minimum width.
17388
17475
  * Default value: 30
17389
17476
  */
17390
17477
  minWidth?: number;
17478
+ /**
17479
+ * Sets or gets the column's click handler.
17480
+ * Default value: null
17481
+ */
17482
+ onClick?: {(event: any, rowId: string | number, dataField: string, cellValue: any, rowData: any, cellElement: any): string};
17391
17483
  /**
17392
17484
  * Sets or gets the column's rowSpan function. Allows you to dynamically span cells.
17393
17485
  * Default value: null
@@ -17443,6 +17535,16 @@ export interface GridColumn {
17443
17535
  * Default value:
17444
17536
  */
17445
17537
  width?: string | number;
17538
+ /**
17539
+ * Sets or gets the column's tooltip.
17540
+ * Default value: ""
17541
+ */
17542
+ tooltip?: string;
17543
+ /**
17544
+ * Sets or gets the column's tooltip renderer which renders tooltips for the column cells. (rowId, dataField, cellValue, formattedValue, data)
17545
+ * Default value: null
17546
+ */
17547
+ tooltipRenderer?: any;
17446
17548
  /**
17447
17549
  * 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.
17448
17550
  * Default value:
@@ -17696,6 +17798,11 @@ export interface GridColumnGroup {
17696
17798
  * Default value: center
17697
17799
  */
17698
17800
  align?: HorizontalAlignment | string;
17801
+ /**
17802
+ * Sets whether the column group can be collapsed.
17803
+ * Default value: false
17804
+ */
17805
+ collapsible?: boolean;
17699
17806
  /**
17700
17807
  * Sets the name of the column group.
17701
17808
  * Default value: ""
@@ -17935,6 +18042,11 @@ export interface GridDataExport {
17935
18042
  * Default value: false
17936
18043
  */
17937
18044
  freezeHeader?: boolean;
18045
+ /**
18046
+ * Determines whether the pinned columns remains fixed (frozen) at the left of the worksheet when the data is exported to Excel. If enabled, users can scroll through the exported data while still viewing the pinned column.
18047
+ * Default value: false
18048
+ */
18049
+ freezeColumns?: boolean;
17938
18050
  /**
17939
18051
  * Determines if formulas in the exported Excel file will be automatically converted to their corresponding calculated values. When enabled, all formulas are replaced with their results in the export; when disabled, original formulas are preserved in the Excel sheet.
17940
18052
  * Default value: true
@@ -17950,103 +18062,11 @@ export interface GridDataExport {
17950
18062
  * Default value: false
17951
18063
  */
17952
18064
  exportAsTable?: boolean;
17953
- }
17954
-
17955
- /**Configures the grid’s data source when the <em>dataSource</em> property is assigned either a JavaScript array (for local data) or a URL (for remote data). This setting determines how the grid retrieves and displays its data, supporting both direct array binding and remote data fetching via HTTP requests. */
17956
- export interface GridDataSourceSettings {
17957
- /**
17958
- * Specifies whether a column should be automatically generated by the system (such as for identity or timestamp fields). When set, the column’s value will be created by the database or application rather than provided manually. This property can be read to determine if the column is currently set to auto-generate its values, or written to enable or disable automatic generation.
17959
- * Default value: false
17960
- */
17961
- autoGenerateColumns?: boolean;
17962
18065
  /**
17963
- * Specifies the name of the data field—such as 'children' or 'items'—that contains nested child items within each object in the data source. When this property is set, the dataAdapter searches for this specified field in each item while processing the data. If the field is present, the dataAdapter treats the data as hierarchical and automatically constructs a hierarchical data structure, allowing for nested or tree-like representations. This property can be both retrieved (get) and updated (set) as needed.
17964
- * Default value: ""
17965
- */
17966
- childrenDataField?: string;
17967
- /**
17968
- * Sets or retrieves the root element used for XML data binding. This property specifies the top-level XML element that serves as the entry point for mapping XML data to objects, or for serializing objects to XML.
17969
- * Default value: blackList
17970
- */
17971
- sanitizeHTML?: GridDataSourceSettingsSanitizeHTML | string;
17972
- /**
17973
- * Gets or sets the root element used for XML data binding, which serves as the primary node for mapping XML data to object structures or vice versa.
17974
- * Default value: ""
17975
- */
17976
- root?: string;
17977
- /**
17978
- * Gets or sets the XML binding record, which defines the mapping between XML data and the corresponding data structure in the application. Use this property to retrieve the current binding configuration or to assign a new XML binding record for data serialization and deserialization operations.
17979
- * Default value: ""
17980
- */
17981
- record?: string;
17982
- /**
17983
- * Specifies or retrieves the fields used to group the data. When set, this property determines which data fields will be used to organize the dataset into groups, allowing for aggregation or categorization based on the specified fields.
17984
- * Default value: []
17985
- */
17986
- groupBy?: string[];
17987
- /**
17988
- * Defines or retrieves the schema that describes the structure of the loaded data, including both the field names and their corresponding data types. For example: ['id: number', 'firstName: string', 'lastName: string'] specifies that the data has three fields—id as a number, firstName as a string, and lastName as a string. This property ensures that the data adheres to the expected format for processing and validation.
17989
- * Default value: null
17990
- */
17991
- dataFields?: GridDataSourceSettingsDataField[];
17992
- /**
17993
- * Specifies or retrieves the type of data source being used, allowing you to define or query the data source format (such as JSON, XML, or a database connection).
17994
- * Default value: array
17995
- */
17996
- dataSourceType?: GridDataSourceSettingsDataSourceType | string;
17997
- /**
17998
- * Sets or retrieves the unique identifier (ID) associated with the dataAdapter instance. This ID can be used to distinguish between multiple dataAdapters in your application and for referencing or managing them programmatically.
17999
- * Default value: ""
18000
- */
18001
- id?: string;
18002
- /**
18003
- * Specifies the data field that uniquely identifies each item in the hierarchy, typically using the 'id' field. This property works in conjunction with the parentDataField property, which defines the field that refers to the parent item's identifier (commonly 'parentId'). Together, these fields establish the hierarchical structure by linking each child item to its parent. This property can be used to both set and retrieve the key field used for building the hierarchy.
18004
- * Default value: ""
18005
- */
18006
- keyDataField?: string;
18007
- /**
18008
- * Specifies the data field that identifies the parent node for each item in a hierarchical data structure. This property is used together with the keyDataField property to establish relationships between items—typically, keyDataField refers to the unique identifier of an item (commonly the 'id' field), while the parentDataField references the identifier of the item's parent (often the 'parentId' field). This setup allows the component to construct the hierarchy by linking each item to its parent based on matching key and parent values.
18009
- * Default value: ""
18010
- */
18011
- parentDataField?: string;
18012
- /**
18013
- * Updates the value of the 'mapChar' field within the record, assigning it a specified character or string. This field typically stores data related to mapping or identification purposes within the record object.
18014
- * Default value: "."
18015
- */
18016
- mapChar?: string;
18017
- /**
18018
- * Controls the grid’s relational data configuration. This property accepts an array of relation definition objects, where each object must include the following fields: - 'id' *(string)*: A unique identifier for the relation. - 'label' *(string)*: A descriptive name for the relation, used for display purposes. - 'columns' *(GridColumn[])*: An array of grid column definitions associated with this relation. - 'dataSource' *(any)*: The data source from which related records are retrieved (e.g., an array, function, or external API endpoint).Once you have defined the grid relations, you can reference them in individual column configurations by specifying the 'relationId' (to link the column to a relation) and 'relationField' (to indicate which field from the related data to use). When these properties are set, the grid will automatically generate an appropriate column editor (such as a dropdown or lookup field) that leverages the provided relation settings, streamlining data entry and ensuring data consistency.
18019
- * Default value: null
18020
- */
18021
- relations?: any;
18022
- /**
18023
- * Defines the virtual data source function, which is invoked by the Grid every time it needs to fetch data—such as when the user scrolls or sorts. This function should use the provided parameters to retrieve or generate the required data, and then pass the results back to the Grid by calling the callback function with the new data set. For example: resultCallbackFunction({dataSource: data}); This approach enables efficient data loading for large datasets by fetching only the necessary records as needed (virtual scrolling). For a working example, refer to the Grid demos page: https://www.htmlelements.com/demos/grid/virtualscroll/
18024
- * Default value: null
18025
- */
18026
- virtualDataSource?: {(resultCallbackFunction: any, details: DataAdapterVirtualDataSourceDetails): void};
18027
- /**
18028
- * Enhances the virtual data source during node expansion in Tree and TreeGrid components. When these components are configured with a virtualDataSource, this function is triggered each time a node is expanded and additional data needs to be loaded on demand. It enables efficient, real-time loading of child node data only as needed, supporting large data sets without preloading the entire hierarchy. For implementation details and a live demonstration, see: https://www.htmlelements.com/demos/grid/virtual-tree-grid/
18066
+ * Specifies whether the data should be exported as an Excel protected sheet. You can set a password by setting an object like this: { password: 'secret'}
18029
18067
  * Default value: null
18030
18068
  */
18031
- virtualDataSourceOnExpand?: any;
18032
- }
18033
-
18034
- export interface GridDataSourceSettingsDataField {
18035
- /**
18036
- * Sets the dataField name.
18037
- * Default value: ""
18038
- */
18039
- name?: string;
18040
- /**
18041
- * Sets the dataField mapping path. For nested mapping, use '.'. Example: 'name.firstName'.
18042
- * Default value: ""
18043
- */
18044
- map?: string;
18045
- /**
18046
- * Sets the dataField type.
18047
- * Default value: string
18048
- */
18049
- dataType?: GridDataSourceSettingsDataFieldDataType | string;
18069
+ protectSheet?: any;
18050
18070
  }
18051
18071
 
18052
18072
  /**Provides comprehensive configuration options for controlling the grid's editing behavior, including enabling or disabling editing features, specifying editing modes (such as inline, popup, or batch), setting validation rules, and customizing editors for specific columns. */
@@ -18061,6 +18081,11 @@ export interface GridEditing {
18061
18081
  * Default value: false
18062
18082
  */
18063
18083
  allowColumnHeaderEdit?: boolean;
18084
+ /**
18085
+ * Shows a Calendar or Spin Buttons when you hover an editable Date or Number Cells.
18086
+ * Default value: false
18087
+ */
18088
+ allowDynamicButtons?: any;
18064
18089
  /**
18065
18090
  * Automatically reapplies any previously set column filters and sort orders after an edit is made, ensuring that user-defined table views remain consistent and uninterrupted following data modifications.
18066
18091
  * Default value: true
@@ -18071,6 +18096,11 @@ export interface GridEditing {
18071
18096
  * Default value: true
18072
18097
  */
18073
18098
  allowListOpenOnContentClick?: boolean;
18099
+ /**
18100
+ * This feature sets the Input's caret position by the mouse click which activates the Input editor.
18101
+ * Default value: false
18102
+ */
18103
+ caretPosition?: boolean;
18074
18104
  /**
18075
18105
  * Allows users to modify or update existing content directly within the interface. This feature typically provides editing controls, such as input fields or rich text editors, enabling seamless changes to data or text as needed.
18076
18106
  * Default value: false
@@ -18092,7 +18122,7 @@ export interface GridEditing {
18092
18122
  */
18093
18123
  readOnlyEdit?: boolean;
18094
18124
  /**
18095
- * Provides detailed definitions and mappings for command keyboard shortcuts, specifying the key combinations used to trigger various actions within an application or system.
18125
+ * Provides detailed definitions for command keyboard shortcuts, specifying the key combinations used to trigger various actions within an application or system.
18096
18126
  * Default value: [object Object]
18097
18127
  */
18098
18128
  commandKeys?: GridEditingCommandKeys;
@@ -18138,7 +18168,7 @@ export interface GridEditing {
18138
18168
  deleteDialog?: Dialog;
18139
18169
  }
18140
18170
 
18141
- /**Provides detailed definitions and mappings for command keyboard shortcuts, specifying the key combinations used to trigger various actions within an application or system. */
18171
+ /**Provides detailed definitions for command keyboard shortcuts, specifying the key combinations used to trigger various actions within an application or system. */
18142
18172
  export interface GridEditingCommandKeys {
18143
18173
  /**
18144
18174
  * Provides details about the keyboard shortcut or key binding assigned to trigger the edit command within the application. This property specifies which key or key combination the user can press to activate editing functionality.
@@ -18351,7 +18381,7 @@ export interface GridFiltering {
18351
18381
  * An array specifying the filtering conditions to be applied to the DataGrid. Each element in the 'filter' array represents a single filter and is itself an array with two elements:1. 'Column dataField:' The name of the column to which the filter will be applied.2. 'Filter condition(s):' A string or expression that defines the criteria to filter the column’s data. This can include a condition or multiple conditions combined using logical operators such as 'or' and 'and'.'Example 1:' To search for rows where the "firstName" column contains 'Andrew' or 'Nancy', and the "quantity" column is either less than or equal to 3 or greater than or equal to 8:'''js[ ['firstName', 'contains Andrew or contains Nancy'], ['quantity', '= 8']]''''Example 2:' For columns configured with 'filterMenuMode: "excel"', you can express multiple "equals" conditions:'''js[ ['firstName', 'EQUAL Andrew or EQUAL Antoni or EQUAL Beate']]''''Example 3:' To filter a string column for values containing either 'burke' or 'peterson':'''js[ ['lastName', 'CONTAINS burke or CONTAINS peterson']]''''Supported filter operators:' You may use a variety of filter operators and keywords within filter expressions. Common operators include:- Equality: '=', 'EQUAL'- Inequality: '!=', '- Comparison: '', 'GREATER_THAN', '=', 'GREATER_THAN_OR_EQUAL'- String matching: 'CONTAINS', 'DOES_NOT_CONTAIN', 'STARTS_WITH', 'ENDS_WITH'- Special: 'EMPTY', 'NULL', 'NOT_NULL'Multiple conditions can be combined in a single expression with logical operators ('and', 'or'). This flexible structure enables complex filtering based on your DataGrid’s current columns and data types.
18352
18382
  * Default value:
18353
18383
  */
18354
- filter?: any[];
18384
+ filter?: any;
18355
18385
  /**
18356
18386
  * Provides detailed configuration options for the filter row, including its appearance, behavior, available filter types, and display settings. This allows developers to customize how the filter row is shown and how users interact with filtering features in the component.
18357
18387
  * Default value: [object Object]
@@ -18602,7 +18632,7 @@ export interface GridHeader {
18602
18632
  * Specifies which action buttons are shown in the Grid header. The available options are:- ''columns'': Displays a button that opens the columns chooser panel, allowing users to show or hide grid columns.- ''filter'': Displays a button that opens the filtering panel, enabling users to apply filters to grid data.- ''group'': Displays a button that opens the grouping panel, allowing users to group data by specific columns.- ''sort'': Displays a button that opens the sorting panel, letting users sort grid data by one or more columns.- ''format'': Displays a button that opens the conditional formatting panel, providing options to format cells based on specific conditions.- ''search'': Displays a button that opens the search panel, enabling users to search within the grid data.- ''colors'': Displays a button that opens a color options panel, allowing users to customize color formatting for the grid.Include one or more of these options in an array to control the set of action buttons visible in the Grid header.
18603
18633
  * Default value: [ "columns", "filter", "group", "sort", "format", "search" ]
18604
18634
  */
18605
- buttons?: string[];
18635
+ buttons?: any;
18606
18636
  /**
18607
18637
  * Specifies the type of search command to be executed, determining how the search operation is performed (e.g., basic, advanced, or filtered search). This setting influences the logic and options available during the search process.
18608
18638
  * Default value: search
@@ -19457,19 +19487,13 @@ export declare type GridClipboardAutoFillMode = 'none' | 'copy' | 'fillSeries';
19457
19487
  /**Sets or retrieves the position of the checkbox selection column within a table or grid, allowing you to specify whether the checkbox column appears at the start (left) or end (right) of the columns. */
19458
19488
  export declare type Position = 'near' | 'far';
19459
19489
  /**Sets or gets the filter menu mode of the column. In 'basic' mode, a single input is displayed in the filter menu. In 'default' mode, two input options are available for more precise filtering. In 'excel' mode, checked list with unique values is displayed. */
19460
- export declare type GridColumnFilterMenuMode = 'basic' | 'default' | 'excel';
19490
+ export declare type GridColumnFilterMenuMode = 'basic' | 'default' | 'excel' | 'multi';
19461
19491
  /**Sets or gets the sort order of the column. Accepts: 'asc', 'desc', 'none' and null. */
19462
19492
  export declare type GridColumnSortOrder = 'asc' | 'desc' | 'none';
19463
19493
  /**The formatting condition. */
19464
19494
  export declare type GridConditionalFormattingCondition = 'between' | 'equal' | 'greaterThan' | 'lessThan' | 'notEqual';
19465
19495
  /**Specifies the orientation of the page (portrait or landscape) when exporting the document to PDF format. This setting determines how the content is laid out on each PDF page. */
19466
19496
  export declare type GridDataExportPageOrientation = 'landscape' | 'portrait';
19467
- /**Sets or retrieves the root element used for XML data binding. This property specifies the top-level XML element that serves as the entry point for mapping XML data to objects, or for serializing objects to XML. */
19468
- export declare type GridDataSourceSettingsSanitizeHTML = 'all' | 'blackList' | 'none';
19469
- /**Sets the dataField type. */
19470
- export declare type GridDataSourceSettingsDataFieldDataType = 'string' | 'date' | 'boolean' | 'number' | 'array' | 'any';
19471
- /**Specifies or retrieves the type of data source being used, allowing you to define or query the data source format (such as JSON, XML, or a database connection). */
19472
- export declare type GridDataSourceSettingsDataSourceType = 'array' | 'json' | 'xml' | 'csv' | 'tsv';
19473
19497
  /**Specifies the method by which the editing mode is activated, such as through a single click, double click, or keyboard action. */
19474
19498
  export declare type GridEditingAction = 'none' | 'click' | 'doubleClick';
19475
19499
  /**Defines the content or label displayed within the buttons of the command column, such as text, icons, or custom HTML elements. This determines what users see and interact with in each command button cell. */
@@ -20012,6 +20036,11 @@ export interface KanbanProperties {
20012
20036
  * Default value:
20013
20037
  */
20014
20038
  currentUser?: string | number;
20039
+ /**
20040
+ * Controls whether a confirm dialog is displayed when a task is dragged and dropped to a new position
20041
+ * Default value: false
20042
+ */
20043
+ confirmDialog?: boolean;
20015
20044
  /**
20016
20045
  * Controls whether the default dialog for adding or removing tasks or comments is enabled or disabled. When set to true, the dialog will not appear, allowing for custom handling of these actions. When set to false, the standard dialog will be shown as usual. This property can be used to either retrieve the current setting (get) or define its behavior (set).
20017
20046
  * Default value: false
@@ -20033,7 +20062,7 @@ export interface KanbanProperties {
20033
20062
  */
20034
20063
  dataSource?: KanbanDataSource[];
20035
20064
  /**
20036
- * Specifies how the Kanban board's default fields (e.g., title, status, assignee) correspond to the fields in your data source. Use this mapping only if your data source uses field names that differ from the Kanban's expected keywords. If the field names already match, this mapping is optional. Note that only certain default fields support custom mapping; not all default mappings can be overridden.
20065
+ * Specifies how the Kanban board's default fields (e.g., title, status, assignee) correspond to the fields in your data source. Use this mapping only if your data source uses field names that differ from the Kanban's expected keywords. If the field names already match, this mapping is optional. Note that only certain default fields support custom mapping; not all default map can be overridden.
20037
20066
  * Default value: { checklist: 'checklist', color: 'color', comments: 'comments', dueDate: 'dueDate', id: 'id', priority: 'priority', progress: 'progress', startDate: 'startDate', status: 'status', swimlane: 'swimlane', tags: 'tags', text: 'text', userId: 'userId'. createdUserId: 'createdUserId', createdDate: 'createdDate', updatedUserId: 'updatedUserId', updatedDate: 'updatedDate' }
20038
20067
  */
20039
20068
  dataSourceMap?: { checklist: string; color: string; comments: string; dueDate: string; id: string; priority: string; progress: string; startDate: string; status: string; swimlane: string; tags: string; text: string; userId: string; createdUserId: string; upDatedUserId: string; createdDate: Date; upDatedDate: Date;};
@@ -20223,7 +20252,7 @@ export interface KanbanProperties {
20223
20252
  */
20224
20253
  taskUserIcon?: boolean;
20225
20254
  /**
20226
- * Specifies the template to use for rendering task text. This property accepts multiple value types:- A string starting with #, which references the id of a element on the page. The contents of this element will be used as the template.- A string containing HTML or template markup, which will be parsed and applied directly to the task text.- A function, which receives the task text (or a template) as input and returns the modified text or template to be used.This property can be both set to define the template for future tasks, or retrieved to access the currently applied template.
20255
+ * Specifies the template to use for rendering task text. This property accepts multiple value types:- A string starting with #, which references the id of a template element on the page. The contents of this element will be used as the template.- A string containing HTML or template markup, which will be parsed and applied directly to the task text.- A function, which receives the task text (or a template) as input and returns the modified text or template to be used.This property can be both set to define the template for future tasks, or retrieved to access the currently applied template.
20227
20256
  * Default value: null
20228
20257
  */
20229
20258
  textTemplate?: any;
@@ -20375,11 +20404,12 @@ export interface Kanban extends BaseElement, KanbanProperties {
20375
20404
  onCommentUpdate?: ((this: any, ev: Event) => any) | ((this: any, ev: CustomEvent<any>) => any) | null;
20376
20405
  /**
20377
20406
  * This event is triggered when a task is dropped onto a target element within the DOM during a drag-and-drop operation. It allows developers to handle the completion of a drag action by responding to where the task is released. To prevent the default drop behavior—such as moving the element or initiating a browser action—you can call event.preventDefault() within the event handler. This enables you to implement custom logic for handling dropped tasks, such as updating data models, modifying the UI, or triggering other application-specific actions."
20378
- * @param event. The custom event. Custom data event was created with: ev.detail(container, data, item, items, originalEvent, previousContainer, target)
20407
+ * @param event. The custom event. Custom data event was created with: ev.detail(container, data, item, items, confirmDrop, originalEvent, previousContainer, target)
20379
20408
  * container - the Kanban the dragged task(s) is dropped to
20380
20409
  * data - an object with additional drag details
20381
20410
  * item - the task that is dragged; if multiple tasks are dragged, this is the task that has been clicked when initiating the drag operation
20382
20411
  * items - an array with all dragged tasks
20412
+ * confirmDrop - parameter which you can set to a function. When this is defined, the DROP operation is confirmed once this function is called. Otherwise, the drop is canceled. This feature can be combined with the Kanban's getConfirmDialog(label, content, callbackFn) method or with a custom confirm dialog.
20383
20413
  * originalEvent - the original, browser, event that initiates the drag operation
20384
20414
  * previousContainer - the Kanban the dragged item(s) is dragged from
20385
20415
  * target - the element the dragged tasks are dropped to
@@ -20512,6 +20542,14 @@ export interface Kanban extends BaseElement, KanbanProperties {
20512
20542
  * Removes any currently selected items or cards within the Kanban board, ensuring that no items remain selected. This action resets the selection state of the Kanban component.
20513
20543
  */
20514
20544
  clearSelection(): void;
20545
+ /**
20546
+ * Create an instance of the Window component which is used as a confirm dialog. It gets 3 arguments, label, content and confirm function.
20547
+ * @param {string} label. The label shown in the header of the window. For example: Confirm move.
20548
+ * @param {string} content. The label shown in the content of the window. For example: Are you sure you want to move this task?
20549
+ * @param {any} confirmFn. The function called when the OK button is clicked.
20550
+ * @returns {any}
20551
+ */
20552
+ getConfirmDialog(label: string, content: string, confirmFn: any): any;
20515
20553
  /**
20516
20554
  * Conceals a specific column within a Kanban board, making its contents and tasks temporarily invisible to users without deleting any data. This action helps declutter the board or focus attention on other columns. The hidden column can typically be shown again through board settings or controls.
20517
20555
  * @param {number | string} column. The index or dataField of the column to hide
@@ -21530,6 +21568,11 @@ export interface ListBoxProperties {
21530
21568
  * Default value: false
21531
21569
  */
21532
21570
  rightToLeft?: boolean;
21571
+ /**
21572
+ * Controls whether the select all item is displayed when Checkboxes are enabled.
21573
+ * Default value: false
21574
+ */
21575
+ selectAll?: boolean;
21533
21576
  /**
21534
21577
  * Gets or sets the selected indexes. The selected indexes property is an array containing the numerical indexes of the items that are currently selected. Assigning an array of indexes will update the selection to match those items; retrieving this property returns the array of currently selected item indexes.
21535
21578
  * Default value:
@@ -21724,6 +21767,11 @@ export interface ListBox extends BaseElement, ListBoxProperties {
21724
21767
  * @returns {{label: string, value: string}[]}
21725
21768
  */
21726
21769
  getItems(): {label: string, value: string}[];
21770
+ /**
21771
+ * Returns an array of the selected values.
21772
+ * @returns {any[]}
21773
+ */
21774
+ getSelectedValues(): any[];
21727
21775
  /**
21728
21776
  * Inserts a new item into the collection at the specified index, shifting existing items at and after that position one place to the right. The index determines the position in the array or list where the new item will be placed.
21729
21777
  * @param {number} index. The index where the item must be inserted.
@@ -23580,7 +23628,7 @@ export interface MultilineTextBoxProperties {
23580
23628
  */
23581
23629
  autoFocus?: boolean;
23582
23630
  /**
23583
- * The cols attribute sets the visible width (measured in average character columns) of a textarea input field in a form. Its value must be a positive integer, determining how many characters are visible in a single row. If the cols attribute is not provided, the textarea defaults to displaying 20 character columns in width. Note: The cols attribute is not applicable to elements; it is specific to elements.
23631
+ * The cols attribute sets the visible width (measured in average character columns) of a textarea input field in a form. Its value must be a positive integer, determining how many characters are visible in a single row. If the cols attribute is not provided, the textarea defaults to displaying 20 character columns in width. Note: The cols attribute is not applicable to Input elements; it is specific to Textarea elements.
23584
23632
  * Default value: 20
23585
23633
  */
23586
23634
  cols?: number;
@@ -23600,7 +23648,7 @@ export interface MultilineTextBoxProperties {
23600
23648
  */
23601
23649
  enterKeyBehavior?: MultilineTextBoxEnterKeyBehavior | string;
23602
23650
  /**
23603
- * Specifies the form element with which this element is associated, known as its "form owner." The value of this attribute must be the ID of an existing element within the same HTML document. This allows input or button elements to be associated with a form, even if they are not nested inside the form tag itself.
23651
+ * Specifies the form element with which this element is associated, known as its "form owner." The value of this attribute must be the ID of an existing Form element within the same HTML document. This allows input or button elements to be associated with a form, even if they are not nested inside the form tag itself.
23604
23652
  * Default value: ""
23605
23653
  */
23606
23654
  form?: string;
@@ -27722,7 +27770,7 @@ export interface SchedulerProperties {
27722
27770
  */
27723
27771
  groupOrientation?: SchedulerGroupOrientation | string;
27724
27772
  /**
27725
- * Enhances customization for group cell headers by allowing you to define how each group cell is rendered within the header section. You can specify one of the following as the template:- 'HTMLTemplateElement': Supply an HTML '' element that will be applied to all group header cells. Within your template, you can use property bindings that correspond to properties of the group cell object. These bindings will be automatically populated with the respective values for each cell.- 'Template ID (String)': Provide the 'id' attribute of an existing HTML '' element. The identified template will be used for rendering all group header cells.- 'Custom Function': Specify a function that will be called for each group cell. The function will receive two parameters: - 'cellContent': A DOM element that acts as a container for the group cell’s content. - 'cellObj': The data object associated with the current group cell.This approach gives you full flexibility to display custom content, styles, and data for group header cells according to your requirements. If you use an HTMLTemplateElement, you can leverage dynamic property bindings that map directly to the properties of each group cell’s data object.
27773
+ * Enhances customization for group cell headers by allowing you to define how each group cell is rendered within the header section. You can specify one of the following as the template:- 'HTMLTemplateElement': Supply an HTML '&lt;template&gt;' element that will be applied to all group header cells. Within your template, you can use property bindings that correspond to properties of the group cell object. These bindings will be automatically populated with the respective values for each cell.- 'Template ID (String)': Provide the 'id' attribute of an existing HTML '&lt;template&gt;' element. The identified template will be used for rendering all group header cells.- 'Custom Function': Specify a function that will be called for each group cell. The function will receive two parameters: - 'cellContent': A DOM element that acts as a container for the group cell’s content. - 'cellObj': The data object associated with the current group cell.This approach gives you full flexibility to display custom content, styles, and data for group header cells according to your requirements. If you use an HTMLTemplateElement, you can leverage dynamic property bindings that map directly to the properties of each group cell’s data object.
27726
27774
  * Default value: null
27727
27775
  */
27728
27776
  groupTemplate?: any;
@@ -30379,12 +30427,12 @@ export interface TableProperties {
30379
30427
  */
30380
30428
  filterOperator?: boolean;
30381
30429
  /**
30382
- * Gets or sets the ID of an HTML element to be used as a custom filter template. This allows you to define and apply your own filter UI by referencing the specified template’s ID.
30430
+ * Gets or sets the ID of an HTML &lt;template&gt; element to be used as a custom filter template. This allows you to define and apply your own filter UI by referencing the specified template’s ID.
30383
30431
  * Default value: "null"
30384
30432
  */
30385
30433
  filterTemplate?: string;
30386
30434
  /**
30387
- * Specifies or retrieves the ID of an HTML '' element whose content will be used to render the footer row(s) of the component. This allows you to define custom footer layouts using template markup and apply them dynamically by referencing the template's ID.
30435
+ * Specifies or retrieves the ID of an HTML '&lt;template&gt;' element whose content will be used to render the footer row(s) of the component. This allows you to define custom footer layouts using template markup and apply them dynamically by referencing the template's ID.
30388
30436
  * Default value: "null"
30389
30437
  */
30390
30438
  footerRow?: string;
@@ -30439,7 +30487,7 @@ export interface TableProperties {
30439
30487
  */
30440
30488
  unlockKey?: string;
30441
30489
  /**
30442
- * Specifies or retrieves the currently selected language code (e.g., "en", "fr", "es") for localization purposes. This property works together with the messages property to determine which set of localized messages should be displayed or used by the application. Adjusting this property changes which language mappings from messages are active.
30490
+ * Specifies or retrieves the currently selected language code (e.g., "en", "fr", "es") for localization purposes. This property works together with the messages property to determine which set of localized messages should be displayed or used by the application. Adjusting this property changes which language map from messages are active.
30443
30491
  * Default value: "en"
30444
30492
  */
30445
30493
  locale?: string;
@@ -32000,7 +32048,7 @@ export interface TextAreaProperties {
32000
32048
  */
32001
32049
  unfocusable?: boolean;
32002
32050
  /**
32003
- * Defines the list of users available for mentioning in the TextArea component. Expects an array where each element is an object containing both id and name properties (e.g., { id: string | number, name: string }). When users type the '@' character, a dropdown appears, allowing them to select a user from this array to mention within the TextArea.
32051
+ * Defines the list of users available for mentioning in the TextArea component. Expects an array where each element is an object containing both id and name properties (e.g., { id: string | number, name: string }). When users type the at symbol, a dropdown appears, allowing them to select a user from this array to mention within the TextArea.
32004
32052
  * Default value: []
32005
32053
  */
32006
32054
  users?: any[];
@@ -33333,6 +33381,21 @@ export interface TreeProperties {
33333
33381
  * Default value: false
33334
33382
  */
33335
33383
  dropDownMode?: boolean;
33384
+ /**
33385
+ *
33386
+ * Default value: null
33387
+ */
33388
+ dropDownSelectTemplate?: any;
33389
+ /**
33390
+ *
33391
+ * Default value: label
33392
+ */
33393
+ dropDownSelectionMode?: TreeDropDownSelectionMode | string;
33394
+ /**
33395
+ *
33396
+ * Default value: "→"
33397
+ */
33398
+ dropDownSelectionPathSymbol?: string;
33336
33399
  /**
33337
33400
  * Specifies the width, in pixels, of the Tree component when it appears within a drop-down interface. Adjusting this value controls how wide the drop-down Tree is rendered, allowing for customization to fit various layouts or content requirements.
33338
33401
  * Default value: 300
@@ -33790,6 +33853,8 @@ declare global {
33790
33853
  }
33791
33854
  }
33792
33855
 
33856
+
33857
+ export declare type TreeDropDownSelectionMode = 'label' | 'path';
33793
33858
  /**Specifies how TreeItemGroups within the Tree expand or collapse, controlling whether multiple groups can be expanded simultaneously, only one group can be expanded at a time, or all groups are collapsed by default. This setting defines the expand/collapse interaction pattern for grouped items in the Tree structure. */
33794
33859
  export declare type TreeExpandMode = 'multiple' | 'single';
33795
33860
  /**Specifies whether to display a traditional scrollbar or to use scroll buttons for navigating content when the element’s content exceeds its visible area. This setting controls the user’s method of scrolling in overflow situations. */
@@ -33810,6 +33875,11 @@ export interface TreeItemProperties {
33810
33875
  * Default value: false
33811
33876
  */
33812
33877
  disabled?: boolean;
33878
+ /**
33879
+ *
33880
+ * Default value: false
33881
+ */
33882
+ disableDrag?: boolean;
33813
33883
  /**
33814
33884
  *
33815
33885
  * Default value:
@@ -33871,6 +33941,11 @@ export interface TreeItemsGroupProperties {
33871
33941
  * Default value: false
33872
33942
  */
33873
33943
  disabled?: boolean;
33944
+ /**
33945
+ *
33946
+ * Default value: false
33947
+ */
33948
+ disableDrag?: boolean;
33874
33949
  /**
33875
33950
  *
33876
33951
  * Default value: false