@smart-webcomponents-angular/columnpanel 15.0.2 → 22.0.2

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
package/index.d.ts CHANGED
@@ -114,6 +114,11 @@ export interface ThreeDChartProperties {
114
114
  * Default value: "#ffffff"
115
115
  */
116
116
  lightColor?: string;
117
+ /**
118
+ * Sets or gets the unlockKey which unlocks the product.
119
+ * Default value: ""
120
+ */
121
+ unlockKey?: string;
117
122
  /**
118
123
  * Sets or gets the locale. Used in conjunction with the property messages.
119
124
  * Default value: "en"
@@ -169,6 +174,11 @@ export interface ThreeDChartProperties {
169
174
  * Default value: null
170
175
  */
171
176
  toolTipFormatFunction?: {(value?: any, index?: number, series?: any): string};
177
+ /**
178
+ * Tooltip data formatting settings for the values in the serie.
179
+ * Default value: [object Object]
180
+ */
181
+ toolTipFormatSettings?: ThreeDChartFormatSettings;
172
182
  /**
173
183
  * Tooltip line color. By default it is set to the hovered item's color
174
184
  * Default value: null
@@ -1273,6 +1283,11 @@ export interface AccordionProperties {
1273
1283
  * Default value: singleFitHeight
1274
1284
  */
1275
1285
  expandMode?: AccordionExpandMode | string;
1286
+ /**
1287
+ * Sets or gets the unlockKey which unlocks the product.
1288
+ * Default value: ""
1289
+ */
1290
+ unlockKey?: string;
1276
1291
  /**
1277
1292
  * Sets or gets the language. Used in conjunction with the property messages.
1278
1293
  * Default value: "en"
@@ -1554,6 +1569,11 @@ export interface ArrayProperties {
1554
1569
  * Default value: 50
1555
1570
  */
1556
1571
  indexerWidth?: number;
1572
+ /**
1573
+ * Sets or gets the unlockKey which unlocks the product.
1574
+ * Default value: ""
1575
+ */
1576
+ unlockKey?: string;
1557
1577
  /**
1558
1578
  * Sets or gets the language. Used in conjunction with the property messages.
1559
1579
  * Default value: "en"
@@ -1896,6 +1916,16 @@ export interface BarcodeProperties {
1896
1916
  * Default value: ""
1897
1917
  */
1898
1918
  value?: string;
1919
+ /**
1920
+ * Sets or gets the width of the barcode. If the width is set to 0, the width of the barcode is calculated automatically.
1921
+ * Default value: 0
1922
+ */
1923
+ width?: number;
1924
+ /**
1925
+ * Sets or gets the height of the barcode. If the height is set to 0, the height of the barcode is calculated automatically.
1926
+ * Default value: 0
1927
+ */
1928
+ height?: number;
1899
1929
  }
1900
1930
  /**
1901
1931
  Barcodes encodes text value in a specific pattern.
@@ -1995,6 +2025,11 @@ export interface BreadcrumbProperties {
1995
2025
  * Default value: null
1996
2026
  */
1997
2027
  itemTemplate?: any;
2028
+ /**
2029
+ * Sets or gets the unlockKey which unlocks the product.
2030
+ * Default value: ""
2031
+ */
2032
+ unlockKey?: string;
1998
2033
  /**
1999
2034
  * Sets or gets the language. Used in conjunction with the property messages.
2000
2035
  * Default value: "en"
@@ -2118,6 +2153,11 @@ export interface ButtonProperties {
2118
2153
  * Default value: """"
2119
2154
  */
2120
2155
  innerHTML: string;
2156
+ /**
2157
+ * Sets or gets the unlockKey which unlocks the product.
2158
+ * Default value: ""
2159
+ */
2160
+ unlockKey?: string;
2121
2161
  /**
2122
2162
  * Sets or gets the language. Used in conjunction with the property messages.
2123
2163
  * Default value: "en"
@@ -2226,6 +2266,11 @@ export interface ButtonGroupProperties {
2226
2266
  * Default value: false
2227
2267
  */
2228
2268
  disabled?: boolean;
2269
+ /**
2270
+ * Sets or gets the unlockKey which unlocks the product.
2271
+ * Default value: ""
2272
+ */
2273
+ unlockKey?: string;
2229
2274
  /**
2230
2275
  * Sets or gets the language. Used in conjunction with the property messages.
2231
2276
  * Default value: "en"
@@ -2354,6 +2399,11 @@ export interface CalendarProperties {
2354
2399
  * Default value: false
2355
2400
  */
2356
2401
  disableAutoNavigation?: boolean;
2402
+ /**
2403
+ * Enables or disables the Calendar mouse wheel behavior.
2404
+ * Default value: false
2405
+ */
2406
+ disableMouseWheel?: boolean;
2357
2407
  /**
2358
2408
  * Determines the date view of the calendar when calendarMode is set to 'default'
2359
2409
  * Default value: month
@@ -2414,6 +2464,11 @@ export interface CalendarProperties {
2414
2464
  * Default value: null
2415
2465
  */
2416
2466
  importantDatesTemplate?: any;
2467
+ /**
2468
+ * Sets or gets the unlockKey which unlocks the product.
2469
+ * Default value: ""
2470
+ */
2471
+ unlockKey?: string;
2417
2472
  /**
2418
2473
  * Determines the language of the Calendar.
2419
2474
  * Default value: "en"
@@ -2711,6 +2766,11 @@ export interface CardProperties {
2711
2766
  * Default value: null
2712
2767
  */
2713
2768
  itemTemplate?: any;
2769
+ /**
2770
+ * Sets or gets the unlockKey which unlocks the product.
2771
+ * Default value: ""
2772
+ */
2773
+ unlockKey?: string;
2714
2774
  /**
2715
2775
  * Sets or gets the language. Used in conjunction with the property messages.
2716
2776
  * Default value: "en"
@@ -2854,6 +2914,11 @@ export interface CardViewProperties {
2854
2914
  * Default value: none
2855
2915
  */
2856
2916
  headerPosition?: CardViewHeaderPosition | string;
2917
+ /**
2918
+ * Sets or gets the unlockKey which unlocks the product.
2919
+ * Default value: ""
2920
+ */
2921
+ unlockKey?: string;
2857
2922
  /**
2858
2923
  * Sets or gets the locale. Used in conjunction with the property messages.
2859
2924
  * Default value: "en"
@@ -3300,6 +3365,11 @@ export interface CarouselProperties {
3300
3365
  * Default value: false
3301
3366
  */
3302
3367
  keyboard?: boolean;
3368
+ /**
3369
+ * Sets or gets the unlockKey which unlocks the product.
3370
+ * Default value: ""
3371
+ */
3372
+ unlockKey?: string;
3303
3373
  /**
3304
3374
  * Sets or gets the language. Used in conjunction with the property messages.
3305
3375
  * Default value: "en"
@@ -3542,6 +3612,11 @@ export interface ChartProperties {
3542
3612
  * Default value: [object Object]
3543
3613
  */
3544
3614
  legendLayout?: any;
3615
+ /**
3616
+ * Sets or gets the unlockKey which unlocks the product.
3617
+ * Default value: ""
3618
+ */
3619
+ unlockKey?: string;
3545
3620
  /**
3546
3621
  * Sets or gets the locale. Used in conjunction with the property messages.
3547
3622
  * Default value: "en"
@@ -5361,6 +5436,11 @@ export interface CheckBoxProperties {
5361
5436
  * Default value: """"
5362
5437
  */
5363
5438
  innerHTML: string;
5439
+ /**
5440
+ * Sets or gets the unlockKey which unlocks the product.
5441
+ * Default value: ""
5442
+ */
5443
+ unlockKey?: string;
5364
5444
  /**
5365
5445
  * Sets or gets the language. Used in conjunction with the property messages.
5366
5446
  * Default value: "en"
@@ -5505,6 +5585,11 @@ export interface CheckInputProperties {
5505
5585
  * Default value: 8
5506
5586
  */
5507
5587
  items?: number;
5588
+ /**
5589
+ * Sets or gets the unlockKey which unlocks the product.
5590
+ * Default value: ""
5591
+ */
5592
+ unlockKey?: string;
5508
5593
  /**
5509
5594
  * Sets or gets the language. Used in conjunction with the property messages.
5510
5595
  * Default value: "en"
@@ -5692,6 +5777,11 @@ export interface ChipProperties {
5692
5777
  * Default value: null
5693
5778
  */
5694
5779
  itemTemplate?: any;
5780
+ /**
5781
+ * Sets or gets the unlockKey which unlocks the product.
5782
+ * Default value: ""
5783
+ */
5784
+ unlockKey?: string;
5695
5785
  /**
5696
5786
  * Sets or gets the language. Used in conjunction with the property messages.
5697
5787
  * Default value: "en"
@@ -5788,6 +5878,11 @@ export interface CircularProgressBarProperties {
5788
5878
  * Default value: false
5789
5879
  */
5790
5880
  inverted?: boolean;
5881
+ /**
5882
+ * Sets or gets the unlockKey which unlocks the product.
5883
+ * Default value: ""
5884
+ */
5885
+ unlockKey?: string;
5791
5886
  /**
5792
5887
  * Sets or gets the language. Used in conjunction with the property messages.
5793
5888
  * Default value: "en"
@@ -5924,6 +6019,11 @@ export interface ColorInputProperties {
5924
6019
  * Default value: 8
5925
6020
  */
5926
6021
  items?: number;
6022
+ /**
6023
+ * Sets or gets the unlockKey which unlocks the product.
6024
+ * Default value: ""
6025
+ */
6026
+ unlockKey?: string;
5927
6027
  /**
5928
6028
  * Sets or gets the language. Used in conjunction with the property messages.
5929
6029
  * Default value: "en"
@@ -6151,6 +6251,11 @@ export interface ColorPanelProperties {
6151
6251
  * Default value: false
6152
6252
  */
6153
6253
  inverted?: boolean;
6254
+ /**
6255
+ * Sets or gets the unlockKey which unlocks the product.
6256
+ * Default value: ""
6257
+ */
6258
+ unlockKey?: string;
6154
6259
  /**
6155
6260
  * Sets or gets the language. Used in conjunction with the property messages.
6156
6261
  * Default value: "en"
@@ -6439,6 +6544,11 @@ export interface ColorPickerProperties {
6439
6544
  * Default value: ""
6440
6545
  */
6441
6546
  label?: string;
6547
+ /**
6548
+ * Sets or gets the unlockKey which unlocks the product.
6549
+ * Default value: ""
6550
+ */
6551
+ unlockKey?: string;
6442
6552
  /**
6443
6553
  * Sets or gets the language. Used in conjunction with the property messages.
6444
6554
  * Default value: "en"
@@ -6664,6 +6774,11 @@ export interface ColumnPanelProperties {
6664
6774
  * Default value: false
6665
6775
  */
6666
6776
  disabled?: boolean;
6777
+ /**
6778
+ * Sets or gets the unlockKey which unlocks the product.
6779
+ * Default value: ""
6780
+ */
6781
+ unlockKey?: string;
6667
6782
  /**
6668
6783
  * Sets or gets the language. Used in conjunction with the property messages.
6669
6784
  * Default value: "en"
@@ -6967,6 +7082,11 @@ export interface ComboBoxProperties {
6967
7082
  * Default value: center
6968
7083
  */
6969
7084
  loadingIndicatorPosition?: VerticalAlignment | string;
7085
+ /**
7086
+ * Sets or gets the unlockKey which unlocks the product.
7087
+ * Default value: ""
7088
+ */
7089
+ unlockKey?: string;
6970
7090
  /**
6971
7091
  * Sets or gets the language. Used in conjunction with the property messages.
6972
7092
  * Default value: "en"
@@ -7180,6 +7300,11 @@ export interface ComboBox extends BaseElement, ComboBoxProperties {
7180
7300
  * @returns {Node}
7181
7301
  */
7182
7302
  appendChild<T extends Node>(node: Node): T;
7303
+ /**
7304
+ * Adds a new item(s).
7305
+ * @param {any} item. Describes the properties of the item that will be inserted. You can also pass an array of items.
7306
+ */
7307
+ add(item: any): void;
7183
7308
  /**
7184
7309
  * Removes all items from the drop down list.
7185
7310
  */
@@ -7192,6 +7317,10 @@ export interface ComboBox extends BaseElement, ComboBoxProperties {
7192
7317
  * Closes the dropDown list.
7193
7318
  */
7194
7319
  close(): void;
7320
+ /**
7321
+ * Performs a data bind. This can be used to refresh the data source.
7322
+ */
7323
+ dataBind(): void;
7195
7324
  /**
7196
7325
  * Ensures the desired item is visible by scrolling to it.
7197
7326
  * @param {HTMLElement | string} item. A list item or value of the desired item to be visible.
@@ -7206,7 +7335,7 @@ export interface ComboBox extends BaseElement, ComboBoxProperties {
7206
7335
  /**
7207
7336
  * Inserts a new item at a specified position.
7208
7337
  * @param {number} position. The position where the item must be inserted.
7209
- * @param {any} item. Describes the properties of the item that will be inserted.
7338
+ * @param {any} item. Describes the properties of the item that will be inserted. You can also pass an array of items.
7210
7339
  */
7211
7340
  insert(position: number, item: any): void;
7212
7341
  /**
@@ -7444,6 +7573,11 @@ export interface CustomizationDialogProperties {
7444
7573
  * Default value: apply,close
7445
7574
  */
7446
7575
  headerButtons?: string[];
7576
+ /**
7577
+ * Sets or gets the unlockKey which unlocks the product.
7578
+ * Default value: ""
7579
+ */
7580
+ unlockKey?: string;
7447
7581
  /**
7448
7582
  * Sets or gets the language. Used in conjunction with the property messages.
7449
7583
  * Default value: "en"
@@ -7940,6 +8074,11 @@ export interface DateInputProperties {
7940
8074
  * Default value: 500
7941
8075
  */
7942
8076
  autoCloseDelay?: number;
8077
+ /**
8078
+ * Determines the calendar properties to be set to the popup calendar.
8079
+ * Default value: null
8080
+ */
8081
+ calendarProperties?: any;
7943
8082
  /**
7944
8083
  * 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' }
7945
8084
  * Default value: { day: 'numeric', month: 'numeric', year: 'numeric' }
@@ -7976,179 +8115,189 @@ export interface DateInputProperties {
7976
8115
  */
7977
8116
  inputPurpose?: string;
7978
8117
  /**
7979
- * Sets or gets the language. Used in conjunction with the property messages.
7980
- * Default value: "en"
7981
- */
7982
- locale?: string;
7983
- /**
7984
- * Callback used to customize the format of the messages that are returned from the Localization Module.
7985
- * Default value: null
7986
- */
7987
- localizeFormatFunction?: any;
7988
- /**
7989
- * Determines the max date for the Calendar displayed inside the popup.
7990
- * Default value: new Date(2100, 1, 1)
7991
- */
7992
- max?: any;
7993
- /**
7994
- * Sets or gets an object specifying strings used in the widget that can be localized. Used in conjunction with the property locale.
7995
- * Default value: * {
7996
- * "en": {
7997
- * "propertyUnknownType": "'' property is with undefined 'type' member!",
7998
- * "propertyInvalidValue": "Invalid '!",
7999
- * "propertyInvalidValueType": "Invalid '!",
8000
- * "elementNotInDOM": "Element does not exist in DOM! Please, add the element to the DOM, before invoking a method.",
8001
- * "moduleUndefined": "Module is undefined.",
8002
- * "missingReference": ".",
8003
- * "htmlTemplateNotSuported": ": Browser doesn't support HTMLTemplate elements.",
8004
- * "invalidTemplate": "' property accepts a string that must match the id of an HTMLTemplate element from the DOM.",
8005
- * "invalidNode": "."
8006
- * }
8007
- * }
8008
- */
8009
- messages?: any;
8010
- /**
8011
- * Determines the min date for the Calendar displayed inside the popup.
8012
- * Default value: new Date(1900, 1, 1)
8013
- */
8014
- min?: any;
8015
- /**
8016
- * Sets or gets the name attribute for the element. Name is used when submiting data inside an HTML form.
8017
- * Default value: ""
8018
- */
8019
- name?: string;
8020
- /**
8021
- * Determines whether the drop down is opened or not.
8022
- * Default value: false
8023
- */
8024
- opened?: boolean;
8025
- /**
8026
- * Determines the placeholder of the input.
8118
+ * Sets or gets the unlockKey which unlocks the product.
8027
8119
  * Default value: ""
8028
8120
  */
8029
- placeholder?: string;
8030
- /**
8031
- * Determines whether ot not the user can enter text inside the input. if dropDownButtonPosition is set to 'left' or 'right' then readonly determines whether the element acts as a ComboBox or a DropDownList if a dataSource is provided.
8032
- * Default value: false
8033
- */
8034
- readonly?: boolean;
8035
- /**
8036
- * Sets or gets the value indicating whether the element is aligned to support locales using right-to-left fonts.
8037
- * Default value: false
8038
- */
8039
- rightToLeft?: boolean;
8040
- /**
8041
- * Determines the theme for the element. Themes define the look of the elements.
8042
- * Default value: ""
8043
- */
8044
- theme?: string;
8045
- /**
8046
- * If is set to true, the element cannot be focused.
8047
- * Default value: false
8048
- */
8049
- unfocusable?: boolean;
8050
- /**
8051
- * Sets or gets the value of the element. Expected value is: Date string, Date object or null.
8052
- * Default value:
8053
- */
8054
- value?: any;
8055
- }
8056
- /**
8057
- DateInput specifies an input field where the user can enter a date. It also has a popup with a Calendar that allows to pick a date.
8058
- */
8059
- export interface DateInput extends BaseElement, DateInputProperties {
8060
-
8061
- /* Get a member by its name */
8062
- [name: string]: any;
8063
- /**
8064
- * This event is triggered when the selection is changed.
8065
- * @param event. The custom event. Custom data event was created with: ev.detail(label, oldLabel, oldValue, value)
8066
- * label - The label of the new selected item.
8067
- * oldLabel - The label of the item that was previously selected before the event was triggered.
8068
- * oldValue - The value of the item that was previously selected before the event was triggered.
8069
- * value - The value of the new selected item.
8070
- */
8071
- onChange: ((this: any, ev: Event) => any) | null;
8072
- /**
8073
- * Closes the drop down.
8074
- */
8075
- close(): void;
8076
- /**
8077
- * Opens the drop down.
8078
- */
8079
- open(): void;
8080
- /**
8081
- * Selects the text inside the input or if it is <b>readonly</b> then the element is focused.
8082
- */
8083
- select(): void;
8084
- /**
8085
- * Returns the value in the desired format.
8086
- * @param {string | Date} value. The value to be formatted by the method.
8087
- * @param {any} format?. The object that contains the formatting properties. The argument should contain Intl.DateTimeFormat valid properties.
8088
- */
8089
- getFormattedValue(value: string | Date, format?: any): void;
8090
- /**
8091
- * Returns the date of the input.
8092
- */
8093
- getValue(): void;
8094
- /**
8095
- * Sets the date of the input.
8096
- * @param {string | Date} value. The value to be set.
8097
- */
8098
- setValue(value: string | Date): void;
8099
- }
8100
-
8101
- declare global {
8102
- interface Document {
8103
- createElement(tagName: "smart-date-input"): DateInput;
8104
- querySelector(selectors: "smart-date-input"): DateInput | null;
8105
- querySelectorAll(selectors: "smart-date-input"): NodeListOf<DateInput>;
8106
- getElementsByTagName(qualifiedName: "smart-date-input"): HTMLCollectionOf<DateInput>;
8107
- getElementsByName(elementName: "smart-date-input"): NodeListOf<DateInput>;
8108
- }
8109
- }
8110
-
8111
- export interface DateRangeInputProperties {
8112
- /**
8113
- * Sets or gets the animation mode. Animation is disabled when the property is set to 'none'
8114
- * Default value: advanced
8115
- */
8116
- animation?: Animation | string;
8117
- /**
8118
- * Determines the format of the dates displayed in the input. Accepts valid ECMAScript Internationalization API format. By default the date format is determined by the 'locale' property. Intl.DateTimeFormat is used to format date strings in JavaScript
8119
- * Default value: {"day": "numeric", "month": "numeric", "year": "numeric" }
8120
- */
8121
- dateFormat?: DateRangeFormat;
8122
- /**
8123
- * Enables or disables the element.
8124
- * Default value: false
8125
- */
8126
- disabled?: boolean;
8127
- /**
8128
- * Determines the position of the drop down button.
8129
- * Default value: right
8130
- */
8131
- dropDownButtonPosition?: DropDownButtonPosition | string;
8132
- /**
8133
- * Sets the height of the drop down. By default it's set to an empty string. In this case the height of the drop down is controlled by a CSS variable.
8134
- * Default value:
8135
- */
8136
- dropDownHeight?: string | number;
8137
- /**
8138
- * Sets the width of the drop down. By default it's set to an empty string. In this case the width of the drop down is controlled by a CSS variable.
8139
- * Default value:
8140
- */
8141
- dropDownWidth?: string | number;
8142
- /**
8143
- * Determines whether the 'Today/Clear' icons will be visible or not.
8144
- * Default value: false
8145
- */
8146
- icons?: boolean;
8147
- /**
8148
- * Sets the purpose of the input and what, if any, permission the user agent has to provide automated assistance in filling out the element's input when in a form, as well as guidance to the browser as to the type of information expected in the element. This value corresponds to the standard HTML autocomplete attribute and can be set to values such as 'on', 'name', 'organization', 'street-address', etc.
8149
- * Default value: "off"
8150
- */
8151
- inputPurpose?: string;
8121
+ unlockKey?: string;
8122
+ /**
8123
+ * Sets or gets the language. Used in conjunction with the property messages.
8124
+ * Default value: "en"
8125
+ */
8126
+ locale?: string;
8127
+ /**
8128
+ * Callback used to customize the format of the messages that are returned from the Localization Module.
8129
+ * Default value: null
8130
+ */
8131
+ localizeFormatFunction?: any;
8132
+ /**
8133
+ * Determines the max date for the Calendar displayed inside the popup.
8134
+ * Default value: new Date(2100, 1, 1)
8135
+ */
8136
+ max?: any;
8137
+ /**
8138
+ * Sets or gets an object specifying strings used in the widget that can be localized. Used in conjunction with the property locale.
8139
+ * Default value: * {
8140
+ * "en": {
8141
+ * "propertyUnknownType": "'' property is with undefined 'type' member!",
8142
+ * "propertyInvalidValue": "Invalid '!",
8143
+ * "propertyInvalidValueType": "Invalid '!",
8144
+ * "elementNotInDOM": "Element does not exist in DOM! Please, add the element to the DOM, before invoking a method.",
8145
+ * "moduleUndefined": "Module is undefined.",
8146
+ * "missingReference": ".",
8147
+ * "htmlTemplateNotSuported": ": Browser doesn't support HTMLTemplate elements.",
8148
+ * "invalidTemplate": "' property accepts a string that must match the id of an HTMLTemplate element from the DOM.",
8149
+ * "invalidNode": "."
8150
+ * }
8151
+ * }
8152
+ */
8153
+ messages?: any;
8154
+ /**
8155
+ * Determines the min date for the Calendar displayed inside the popup.
8156
+ * Default value: new Date(1900, 1, 1)
8157
+ */
8158
+ min?: any;
8159
+ /**
8160
+ * Sets or gets the name attribute for the element. Name is used when submiting data inside an HTML form.
8161
+ * Default value: ""
8162
+ */
8163
+ name?: string;
8164
+ /**
8165
+ * Determines whether the drop down is opened or not.
8166
+ * Default value: false
8167
+ */
8168
+ opened?: boolean;
8169
+ /**
8170
+ * Determines the placeholder of the input.
8171
+ * Default value: ""
8172
+ */
8173
+ placeholder?: string;
8174
+ /**
8175
+ * Determines whether ot not the user can enter text inside the input. if dropDownButtonPosition is set to 'left' or 'right' then readonly determines whether the element acts as a ComboBox or a DropDownList if a dataSource is provided.
8176
+ * Default value: false
8177
+ */
8178
+ readonly?: boolean;
8179
+ /**
8180
+ * Sets or gets the value indicating whether the element is aligned to support locales using right-to-left fonts.
8181
+ * Default value: false
8182
+ */
8183
+ rightToLeft?: boolean;
8184
+ /**
8185
+ * Determines the theme for the element. Themes define the look of the elements.
8186
+ * Default value: ""
8187
+ */
8188
+ theme?: string;
8189
+ /**
8190
+ * If is set to true, the element cannot be focused.
8191
+ * Default value: false
8192
+ */
8193
+ unfocusable?: boolean;
8194
+ /**
8195
+ * Sets or gets the value of the element. Expected value is: Date string, Date object or null.
8196
+ * Default value:
8197
+ */
8198
+ value?: any;
8199
+ }
8200
+ /**
8201
+ DateInput specifies an input field where the user can enter a date. It also has a popup with a Calendar that allows to pick a date.
8202
+ */
8203
+ export interface DateInput extends BaseElement, DateInputProperties {
8204
+
8205
+ /* Get a member by its name */
8206
+ [name: string]: any;
8207
+ /**
8208
+ * This event is triggered when the selection is changed.
8209
+ * @param event. The custom event. Custom data event was created with: ev.detail(label, oldLabel, oldValue, value)
8210
+ * label - The label of the new selected item.
8211
+ * oldLabel - The label of the item that was previously selected before the event was triggered.
8212
+ * oldValue - The value of the item that was previously selected before the event was triggered.
8213
+ * value - The value of the new selected item.
8214
+ */
8215
+ onChange: ((this: any, ev: Event) => any) | null;
8216
+ /**
8217
+ * Closes the drop down.
8218
+ */
8219
+ close(): void;
8220
+ /**
8221
+ * Opens the drop down.
8222
+ */
8223
+ open(): void;
8224
+ /**
8225
+ * Selects the text inside the input or if it is <b>readonly</b> then the element is focused.
8226
+ */
8227
+ select(): void;
8228
+ /**
8229
+ * Returns the value in the desired format.
8230
+ * @param {string | Date} value. The value to be formatted by the method.
8231
+ * @param {any} format?. The object that contains the formatting properties. The argument should contain Intl.DateTimeFormat valid properties.
8232
+ */
8233
+ getFormattedValue(value: string | Date, format?: any): void;
8234
+ /**
8235
+ * Returns the date of the input.
8236
+ */
8237
+ getValue(): void;
8238
+ /**
8239
+ * Sets the date of the input.
8240
+ * @param {string | Date} value. The value to be set.
8241
+ */
8242
+ setValue(value: string | Date): void;
8243
+ }
8244
+
8245
+ declare global {
8246
+ interface Document {
8247
+ createElement(tagName: "smart-date-input"): DateInput;
8248
+ querySelector(selectors: "smart-date-input"): DateInput | null;
8249
+ querySelectorAll(selectors: "smart-date-input"): NodeListOf<DateInput>;
8250
+ getElementsByTagName(qualifiedName: "smart-date-input"): HTMLCollectionOf<DateInput>;
8251
+ getElementsByName(elementName: "smart-date-input"): NodeListOf<DateInput>;
8252
+ }
8253
+ }
8254
+
8255
+ export interface DateRangeInputProperties {
8256
+ /**
8257
+ * Sets or gets the animation mode. Animation is disabled when the property is set to 'none'
8258
+ * Default value: advanced
8259
+ */
8260
+ animation?: Animation | string;
8261
+ /**
8262
+ * Determines the format of the dates displayed in the input. Accepts valid ECMAScript Internationalization API format. By default the date format is determined by the 'locale' property. Intl.DateTimeFormat is used to format date strings in JavaScript
8263
+ * Default value: {"day": "numeric", "month": "numeric", "year": "numeric" }
8264
+ */
8265
+ dateFormat?: DateRangeFormat;
8266
+ /**
8267
+ * Enables or disables the element.
8268
+ * Default value: false
8269
+ */
8270
+ disabled?: boolean;
8271
+ /**
8272
+ * Determines the position of the drop down button.
8273
+ * Default value: right
8274
+ */
8275
+ dropDownButtonPosition?: DropDownButtonPosition | string;
8276
+ /**
8277
+ * Sets the height of the drop down. By default it's set to an empty string. In this case the height of the drop down is controlled by a CSS variable.
8278
+ * Default value:
8279
+ */
8280
+ dropDownHeight?: string | number;
8281
+ /**
8282
+ * Sets the width of the drop down. By default it's set to an empty string. In this case the width of the drop down is controlled by a CSS variable.
8283
+ * Default value:
8284
+ */
8285
+ dropDownWidth?: string | number;
8286
+ /**
8287
+ * Determines whether the 'Today/Clear' icons will be visible or not.
8288
+ * Default value: false
8289
+ */
8290
+ icons?: boolean;
8291
+ /**
8292
+ * Sets the purpose of the input and what, if any, permission the user agent has to provide automated assistance in filling out the element's input when in a form, as well as guidance to the browser as to the type of information expected in the element. This value corresponds to the standard HTML autocomplete attribute and can be set to values such as 'on', 'name', 'organization', 'street-address', etc.
8293
+ * Default value: "off"
8294
+ */
8295
+ inputPurpose?: string;
8296
+ /**
8297
+ * Sets or gets the unlockKey which unlocks the product.
8298
+ * Default value: ""
8299
+ */
8300
+ unlockKey?: string;
8152
8301
  /**
8153
8302
  * Sets or gets the language. Used in conjunction with the property messages.
8154
8303
  * Default value: "en"
@@ -8493,6 +8642,11 @@ export interface DateTimePickerProperties {
8493
8642
  * Default value: ""
8494
8643
  */
8495
8644
  label?: string;
8645
+ /**
8646
+ * Sets or gets the unlockKey which unlocks the product.
8647
+ * Default value: ""
8648
+ */
8649
+ unlockKey?: string;
8496
8650
  /**
8497
8651
  * Sets or gets the locale that determines what language is used to localize the labels inside the DateTimePicker.
8498
8652
  * Default value: "en"
@@ -8773,7 +8927,7 @@ export interface DockingLayoutProperties {
8773
8927
  */
8774
8928
  closedItems?: any;
8775
8929
  /**
8776
- * 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.
8930
+ * 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.
8777
8931
  * Default value:
8778
8932
  */
8779
8933
  layout?: any;
@@ -8782,6 +8936,11 @@ export interface DockingLayoutProperties {
8782
8936
  * Default value: false
8783
8937
  */
8784
8938
  liveResize?: boolean;
8939
+ /**
8940
+ * Sets or gets the unlockKey which unlocks the product.
8941
+ * Default value: ""
8942
+ */
8943
+ unlockKey?: string;
8785
8944
  /**
8786
8945
  * Sets or gets the language. Used in conjunction with the property messages.
8787
8946
  * Default value: "en"
@@ -9169,6 +9328,11 @@ export interface DropDownButtonProperties {
9169
9328
  * Default value: ""
9170
9329
  */
9171
9330
  label?: string;
9331
+ /**
9332
+ * Sets or gets the unlockKey which unlocks the product.
9333
+ * Default value: ""
9334
+ */
9335
+ unlockKey?: string;
9172
9336
  /**
9173
9337
  * Sets or gets the language. Used in conjunction with the property messages.
9174
9338
  * Default value: "en"
@@ -9332,11 +9496,6 @@ declare global {
9332
9496
  }
9333
9497
 
9334
9498
  export interface DropDownListProperties {
9335
- /**
9336
- * Sets or gets the animation mode. Animation is disabled when the property is set to 'none'
9337
- * Default value: advanced
9338
- */
9339
- animation?: Animation | string;
9340
9499
  /**
9341
9500
  * 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.
9342
9501
  * Default value: 100
@@ -9437,6 +9596,11 @@ export interface DropDownListProperties {
9437
9596
  * Default value: startsWithIgnoreCase
9438
9597
  */
9439
9598
  filterMode?: FilterMode | string;
9599
+ /**
9600
+ * A callback that should return a condition that will be used for custom item filtering. Used in conjunction with filterMode 'custom'
9601
+ * Default value: null
9602
+ */
9603
+ filterCallback?: any;
9440
9604
  /**
9441
9605
  * If enabled, the items will be grouped by their first letter. Can't be applied if the dataSource already contains groups.
9442
9606
  * Default value: false
@@ -9507,6 +9671,11 @@ export interface DropDownListProperties {
9507
9671
  * Default value: center
9508
9672
  */
9509
9673
  loadingIndicatorPosition?: VerticalAlignment | string;
9674
+ /**
9675
+ * Sets or gets the unlockKey which unlocks the product.
9676
+ * Default value: ""
9677
+ */
9678
+ unlockKey?: string;
9510
9679
  /**
9511
9680
  * Sets or gets the language. Used in conjunction with the property messages.
9512
9681
  * Default value: "en"
@@ -9714,6 +9883,11 @@ export interface DropDownList extends BaseElement, DropDownListProperties {
9714
9883
  * @returns {Node}
9715
9884
  */
9716
9885
  appendChild<T extends Node>(node: Node): T;
9886
+ /**
9887
+ * Adds a new item(s).
9888
+ * @param {any} item. Describes the properties of the item that will be inserted. You can also pass an array of items.
9889
+ */
9890
+ add(item: any): void;
9717
9891
  /**
9718
9892
  * Removes all items from the drop down list.
9719
9893
  */
@@ -9726,6 +9900,10 @@ export interface DropDownList extends BaseElement, DropDownListProperties {
9726
9900
  * Closes the dropDown list.
9727
9901
  */
9728
9902
  close(): void;
9903
+ /**
9904
+ * Performs a data bind. This can be used to refresh the data source.
9905
+ */
9906
+ dataBind(): void;
9729
9907
  /**
9730
9908
  * Ensures the desired item is visible by scrolling to it.
9731
9909
  * @param {HTMLElement | string} item. A list item or value of the desired item to be visible.
@@ -9909,6 +10087,11 @@ export interface EditorProperties {
9909
10087
  * Default value: [object Object]
9910
10088
  */
9911
10089
  iframeSettings?: EditorIframeSettings;
10090
+ /**
10091
+ * Sets or gets the unlockKey which unlocks the product.
10092
+ * Default value: ""
10093
+ */
10094
+ unlockKey?: string;
9912
10095
  /**
9913
10096
  * Sets or gets the language. Used in conjunction with the property messages.
9914
10097
  * Default value: "en"
@@ -10428,6 +10611,11 @@ export interface Editor extends BaseElement, EditorProperties {
10428
10611
  * instance - The toast item that is the target of the operation.
10429
10612
  */
10430
10613
  onMessageOpen?: ((this: any, ev: Event) => any) | ((this: any, ev: CustomEvent<any>) => any) | null;
10614
+ /**
10615
+ * 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; })
10616
+ * @param {any} itemName. The toolbar item to be added
10617
+ */
10618
+ addToolbarItem(itemName: any): void;
10431
10619
  /**
10432
10620
  * Blurs the content of the Editor.
10433
10621
  */
@@ -10494,6 +10682,12 @@ export interface Editor extends BaseElement, EditorProperties {
10494
10682
  * Hides the last shown message.
10495
10683
  */
10496
10684
  hideLastMessage(): void;
10685
+ /**
10686
+ * 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; })
10687
+ * @param {any} itemName. The toolbar item to be added
10688
+ * @param {number} index. The toolbar item's index
10689
+ */
10690
+ insertToolbarItem(itemName: any, index: number): void;
10497
10691
  /**
10498
10692
  * Shows a custom message inside the Editor.
10499
10693
  * @param {string} message. The text message to be displayed.
@@ -10533,6 +10727,11 @@ export interface Editor extends BaseElement, EditorProperties {
10533
10727
  * @param {boolean} value?. Determines whether to enter or leave split mode. By default the argument is not passed and the mode is toggled.
10534
10728
  */
10535
10729
  previewMode(value?: boolean): void;
10730
+ /**
10731
+ * Removes a Toolbar item. Example: editor.removeToolbarItem(0)
10732
+ * @param {number} index. The toolbar item's index
10733
+ */
10734
+ removeToolbarItem(index: number): void;
10536
10735
  /**
10537
10736
  * Sets Editor into Full Screen Mode. If enabled the Editor is positioned above the page content and fills the screen.
10538
10737
  * @param {boolean} value?. Determines whether to enter or leave split mode. By default the argument is not passed and the mode is toggled.
@@ -10821,6 +11020,11 @@ export interface ElementProperties {
10821
11020
  * Default value: false
10822
11021
  */
10823
11022
  isRendered?: boolean;
11023
+ /**
11024
+ * Sets or gets the unlockKey which unlocks the product.
11025
+ * Default value: ""
11026
+ */
11027
+ unlockKey?: string;
10824
11028
  /**
10825
11029
  * Sets or gets the language. Used in conjunction with the property messages.
10826
11030
  * Default value: "en"
@@ -11004,6 +11208,11 @@ export interface FileUploadProperties {
11004
11208
  * Default value: null
11005
11209
  */
11006
11210
  itemTemplate?: any;
11211
+ /**
11212
+ * Sets or gets the unlockKey which unlocks the product.
11213
+ * Default value: ""
11214
+ */
11215
+ unlockKey?: string;
11007
11216
  /**
11008
11217
  * Sets or gets the language. Used in conjunction with the property messages.
11009
11218
  * Default value: "en"
@@ -11268,6 +11477,11 @@ export interface FilterBuilderProperties {
11268
11477
  * Default value: { '=': '=', '<>': '<>', '>': '>', '>=': '>=', '<': '<', '<=': '<=', 'startswith': 'a|bc', 'endswith': 'ab|c', 'contains': 'abc', 'notcontains': '!abc', 'isblank': 'o', 'isnotblank': '*'}
11269
11478
  */
11270
11479
  icons?: FilterBuilderIcons;
11480
+ /**
11481
+ * Sets or gets the unlockKey which unlocks the product.
11482
+ * Default value: ""
11483
+ */
11484
+ unlockKey?: string;
11271
11485
  /**
11272
11486
  * Sets or gets the language. Used in conjunction with the property messages.
11273
11487
  * Default value: "en"
@@ -12451,6 +12665,11 @@ export interface FilterPanelProperties {
12451
12665
  * Default value: "d"
12452
12666
  */
12453
12667
  formatString?: string;
12668
+ /**
12669
+ * Sets or gets the unlockKey which unlocks the product.
12670
+ * Default value: ""
12671
+ */
12672
+ unlockKey?: string;
12454
12673
  /**
12455
12674
  * Sets or gets the language. Used in conjunction with the property messages.
12456
12675
  * Default value: "en"
@@ -12606,12 +12825,12 @@ export interface FormProperties {
12606
12825
  * Callback function for handling status changes. The status could be 'disabled', 'invalid', 'pending', 'valid'.
12607
12826
  * Default value: null
12608
12827
  */
12609
- onStatusChanges?: any;
12828
+ onStatusChanges?: {(value: string): void};
12610
12829
  /**
12611
- * Callback function for handling value changes
12830
+ * Callback function for handling value changes. The function argument is the form's value as a JSON object.
12612
12831
  * Default value: null
12613
12832
  */
12614
- onValueChanges?: any;
12833
+ onValueChanges?: {(value: any): void};
12615
12834
  /**
12616
12835
  * Sets or Gets the labels position.
12617
12836
  * Default value: left
@@ -13025,21 +13244,31 @@ export interface FormGroupProperties {
13025
13244
  * Default value: 1
13026
13245
  */
13027
13246
  columns?: number;
13247
+ /**
13248
+ * Sets the Form control data field. The control's inner input's name is set to the dataField value and in the FormGroup it is accessible through the dataField value.
13249
+ * Default value: ""
13250
+ */
13251
+ dataField?: string;
13252
+ /**
13253
+ * Gets or Sets the Form control's label.
13254
+ * Default value: ""
13255
+ */
13256
+ label?: string;
13028
13257
  /**
13029
13258
  *
13030
13259
  * Default value: null
13031
13260
  */
13032
13261
  controls?: Control[];
13033
13262
  /**
13034
- * Callback function for handling status changes
13263
+ * Callback function for handling status changes. The function argument is a string which could be: 'valid', 'invalid', 'disabled', 'pending'
13035
13264
  * Default value: null
13036
13265
  */
13037
- onStatusChanges?: any;
13266
+ onStatusChanges?: {(value: string): void};
13038
13267
  /**
13039
- * Callback function for handling value changes
13268
+ * Callback function for handling value changes. The function argument is the form's value as a JSON object.
13040
13269
  * Default value: null
13041
13270
  */
13042
- onValueChanges?: any;
13271
+ onValueChanges?: {(value: any): void};
13043
13272
  /**
13044
13273
  * Sets or Gets the labels position.
13045
13274
  * Default value: left
@@ -13273,6 +13502,11 @@ export interface GanttChartProperties {
13273
13502
  * Default value: false
13274
13503
  */
13275
13504
  columnResizeFeedback?: boolean;
13505
+ /**
13506
+ * Gantt's current time. By default it is the today's date.
13507
+ * Default value:
13508
+ */
13509
+ currentTime?: string | Date;
13276
13510
  /**
13277
13511
  * Enables/Disables the current time indicator. Current time indicator shows the current time in the appropriate view cells.
13278
13512
  * Default value: false
@@ -13368,6 +13602,11 @@ export interface GanttChartProperties {
13368
13602
  * Default value: false
13369
13603
  */
13370
13604
  filterRow?: boolean;
13605
+ /**
13606
+ * Determines the view start day. Sunday is 0, Monday is 1, Saturday is 6. By default it's Sunday.
13607
+ * Default value: -1
13608
+ */
13609
+ firstDayOfWeek?: number;
13371
13610
  /**
13372
13611
  * 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'.
13373
13612
  * Default value: false
@@ -13384,15 +13623,20 @@ export interface GanttChartProperties {
13384
13623
  */
13385
13624
  hideDateMarkers?: boolean;
13386
13625
  /**
13387
- * By default the Timeline has a two level header - timeline details and timeline header. This property hides the header details container( the top container ).
13626
+ * 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 ).
13388
13627
  * Default value: false
13389
13628
  */
13390
- hideTimelineHeaderDetails?: boolean;
13629
+ hideTimelineHeader?: boolean;
13391
13630
  /**
13392
- * Shows the selection column of the Task/Resource Table. When applied a checkbox column is displayed that allows to select tasks/resources.
13631
+ * 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 ).
13393
13632
  * Default value: false
13394
13633
  */
13395
- showSelectionColumn?: boolean;
13634
+ hideTimelineHeaderDetails?: boolean;
13635
+ /**
13636
+ * 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 ).
13637
+ * Default value: true
13638
+ */
13639
+ hideTimelineSecondHeaderDetails?: boolean;
13396
13640
  /**
13397
13641
  * 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.
13398
13642
  * Default value: false
@@ -13428,6 +13672,11 @@ export interface GanttChartProperties {
13428
13672
  * Default value: false
13429
13673
  */
13430
13674
  keyboardNavigation?: boolean;
13675
+ /**
13676
+ * Sets or gets the unlockKey which unlocks the product.
13677
+ * Default value: ""
13678
+ */
13679
+ unlockKey?: string;
13431
13680
  /**
13432
13681
  * Determines the language of the GanttChart.
13433
13682
  * Default value: "en"
@@ -13453,6 +13702,11 @@ export interface GanttChartProperties {
13453
13702
  * Default value: short
13454
13703
  */
13455
13704
  monthFormat?: MonthFormat | string;
13705
+ /**
13706
+ * Determines the scale in Month view.
13707
+ * Default value: week
13708
+ */
13709
+ monthScale?: MonthScale | string;
13456
13710
  /**
13457
13711
  * 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.
13458
13712
  * Default value:
@@ -13463,6 +13717,21 @@ export interface GanttChartProperties {
13463
13717
  * Default value:
13464
13718
  */
13465
13719
  nonworkingHours?: number[] | number[][];
13720
+ /**
13721
+ * 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.
13722
+ * Default value: null
13723
+ */
13724
+ onTaskRender?: any;
13725
+ /**
13726
+ * 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.
13727
+ * Default value: null
13728
+ */
13729
+ taskFormatFunction?: any;
13730
+ /**
13731
+ * 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.
13732
+ * Default value: null
13733
+ */
13734
+ tooltipFormatFunction?: any;
13466
13735
  /**
13467
13736
  * 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.
13468
13737
  * Default value: null
@@ -13478,6 +13747,11 @@ export interface GanttChartProperties {
13478
13747
  * Default value: null
13479
13748
  */
13480
13749
  progressLabelFormatFunction?: any;
13750
+ /**
13751
+ * Determines the format of the dates the timeline header when they represent quarters.
13752
+ * Default value: short
13753
+ */
13754
+ quarterFormat?: QuarterFormat | string;
13481
13755
  /**
13482
13756
  * A getter that returns a flat structure as an array of all resources inside the element.
13483
13757
  * Default value: null
@@ -13548,11 +13822,21 @@ export interface GanttChartProperties {
13548
13822
  * Default value:
13549
13823
  */
13550
13824
  selectedResourceIds?: number[] | string[];
13825
+ /**
13826
+ * Sets or gets the selection mode. Only applicable when selection is enabled.
13827
+ * Default value: many
13828
+ */
13829
+ selectionMode?: GanttChartSelectionMode | string;
13551
13830
  /**
13552
13831
  * Enables/Disables the current time shader. If enabled all cells that represent past time will be shaded.
13553
13832
  * Default value: false
13554
13833
  */
13555
13834
  shadeUntilCurrentTime?: boolean;
13835
+ /**
13836
+ * Shows the selection column of the Task/Resource Table. When applied a checkbox column is displayed that allows to select tasks/resources.
13837
+ * Default value: false
13838
+ */
13839
+ showSelectionColumn?: boolean;
13556
13840
  /**
13557
13841
  * 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.
13558
13842
  * Default value: false
@@ -14090,6 +14374,11 @@ export interface GanttChart extends BaseElement, GanttChartProperties {
14090
14374
  * @param {string} content?. Allows to set a custom content for the Tooltip.
14091
14375
  */
14092
14376
  showTooltip(target: HTMLElement, content?: string): void;
14377
+ /**
14378
+ * Scrolls to a date.
14379
+ * @param {Date} date. The date to scroll to.
14380
+ */
14381
+ scrollToDate(date: Date): void;
14093
14382
  /**
14094
14383
  * Saves the current settings of the element to LocalStorage. <strong>Requires an id to be set to the element.</strong>
14095
14384
  * @param {any[]} state?. An Array containing a valid structure of Gantt Chart tasks.
@@ -14385,6 +14674,11 @@ export interface GanttChartTask {
14385
14674
  * Default value: null
14386
14675
  */
14387
14676
  formatFunction?: any;
14677
+ /**
14678
+ * 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.
14679
+ * Default value: null
14680
+ */
14681
+ onRender?: any;
14388
14682
  /**
14389
14683
  * Project, Task or Milestone max start date.
14390
14684
  * Default value:
@@ -14647,10 +14941,16 @@ export declare type GanttDayFormat = '2-digit' | 'numeric' | 'long' | 'short' |
14647
14941
  export declare type Duration = 'day' | 'hour' | 'minute' | 'second' | 'milisecond';
14648
14942
  /**Determines the format of the dates inside the timeline header when they represent hours. */
14649
14943
  export declare type HourFormat = 'default' | '2-digit' | 'numeric';
14944
+ /**Determines the scale in Month view. */
14945
+ export declare type MonthScale = 'day' | 'week';
14946
+ /**Determines the format of the dates the timeline header when they represent quarters. */
14947
+ export declare type QuarterFormat = 'numeric' | 'long' | 'short';
14650
14948
  /**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. */
14651
14949
  export declare type GanttChartResourceTimelineMode = 'diagram' | 'histogram' | 'custom';
14652
14950
  /**Determines how the resources will be displayed inside the resource Timeline. */
14653
14951
  export declare type GanttChartResourceTimelineView = 'hours' | 'tasks' | 'custom';
14952
+ /**Sets or gets the selection mode. Only applicable when selection is enabled. */
14953
+ export declare type GanttChartSelectionMode = 'one' | 'many' | 'extended';
14654
14954
  /**Determines whether the GanttChart can be sorted by one, more then one or no columns. */
14655
14955
  export declare type GanttChartSortMode = 'none' | 'one' | 'many';
14656
14956
  /**Project, Task or Milestone type. Possible values are 'project', 'milestone' and 'task' */
@@ -14661,7 +14961,7 @@ month - the timeline shows the days of the month.
14661
14961
  year - the timeline shows the months of the year.
14662
14962
  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'.
14663
14963
  <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. */
14664
- export declare type GanttChartView = 'day' | 'week' | 'month' | 'year';
14964
+ export declare type GanttChartView = 'day' | 'week' | 'month' | 'quarter' | 'year';
14665
14965
  /**Determines the format of the dates inside the timeline header when they represent weeks. */
14666
14966
  export declare type WeekFormat = 'long' | 'numeric';
14667
14967
  export interface GaugeProperties {
@@ -14750,6 +15050,11 @@ export interface GaugeProperties {
14750
15050
  * Default value: all
14751
15051
  */
14752
15052
  labelsVisibility?: LabelsVisibility | string;
15053
+ /**
15054
+ * Sets or gets the unlockKey which unlocks the product.
15055
+ * Default value: ""
15056
+ */
15057
+ unlockKey?: string;
14753
15058
  /**
14754
15059
  * Sets or gets the locale. Used in conjunction with the property messages.
14755
15060
  * Default value: "en"
@@ -14992,15 +15297,15 @@ export interface GridProperties {
14992
15297
  */
14993
15298
  behavior?: GridBehavior;
14994
15299
  /**
14995
- * An object containing settings related to the grid's layout.
14996
- * Default value: [object Object]
15300
+ * 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.
15301
+ * Default value:
14997
15302
  */
14998
- layout?: GridLayout;
15303
+ currentUser?: string | number;
14999
15304
  /**
15000
- * Sets or gets the language. Used in conjunction with the property messages.
15001
- * Default value: "en"
15305
+ * Describes the column header settings.
15306
+ * Default value: [object Object]
15002
15307
  */
15003
- locale?: string;
15308
+ columnHeader?: GridColumnHeader;
15004
15309
  /**
15005
15310
  * The clipboard property is used to enable/disable clipboard operations with Ctrl+C, Ctrl+X and Ctrl+V keyboard navigations..
15006
15311
  * Default value: [object Object]
@@ -15026,6 +15331,11 @@ export interface GridProperties {
15026
15331
  * Default value:
15027
15332
  */
15028
15333
  columnGroups?: GridColumnGroup[];
15334
+ /**
15335
+ *
15336
+ * Default value: false
15337
+ */
15338
+ dropDownMode?: boolean;
15029
15339
  /**
15030
15340
  * Sets or gets details about conditional formatting to be applied to the Grid's cells.
15031
15341
  * Default value: null
@@ -15066,11 +15376,51 @@ export interface GridProperties {
15066
15376
  * Default value: [object Object]
15067
15377
  */
15068
15378
  filtering?: GridFiltering;
15379
+ /**
15380
+ * Describes the footer settings of the grid.
15381
+ * Default value: [object Object]
15382
+ */
15383
+ footer?: GridFooter;
15384
+ /**
15385
+ * 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).
15386
+ * Default value: false
15387
+ */
15388
+ formulas?: boolean;
15069
15389
  /**
15070
15390
  * Describes the grid's grouping settings.
15071
15391
  * Default value: [object Object]
15072
15392
  */
15073
15393
  grouping?: GridGrouping;
15394
+ /**
15395
+ * Describes the settings for the group header.
15396
+ * Default value: [object Object]
15397
+ */
15398
+ groupHeader?: GridGroupHeader;
15399
+ /**
15400
+ * Describes the header settings of the grid.
15401
+ * Default value: [object Object]
15402
+ */
15403
+ header?: GridHeader;
15404
+ /**
15405
+ * An object containing settings related to the grid's layout.
15406
+ * Default value: [object Object]
15407
+ */
15408
+ layout?: GridLayout;
15409
+ /**
15410
+ * Sets or gets the unlockKey which unlocks the product.
15411
+ * Default value: ""
15412
+ */
15413
+ unlockKey?: string;
15414
+ /**
15415
+ * Sets or gets the language. Used in conjunction with the property messages.
15416
+ * Default value: "en"
15417
+ */
15418
+ locale?: string;
15419
+ /**
15420
+ * Keys handling. You can define a key like "Enter": "Tab" or set a function as a value. When the key is pressed, it will be mapped to the other key, action such as 'copy', 'copyPrev', 'copyNext' or 'delete' or just a function defined in your document.
15421
+ * Default value: null
15422
+ */
15423
+ keys?: any;
15074
15424
  /**
15075
15425
  * Sets the messages values.
15076
15426
  * Default value: * [object Object]
@@ -15091,6 +15441,21 @@ export interface GridProperties {
15091
15441
  * Default value: null
15092
15442
  */
15093
15443
  onCellRender?: {(cell: GridCell): void};
15444
+ /**
15445
+ * Callback function, which is called when a cell edit starts. If you return false, the edit will be canceled.
15446
+ * Default value: null
15447
+ */
15448
+ onCellBeginEdit?: {(id: string, dataField: string, value: any): boolean};
15449
+ /**
15450
+ * 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.
15451
+ * Default value: null
15452
+ */
15453
+ onCellEditRequest?: {(id: string, dataField: string, value: any, oldValue: any, data: any): void};
15454
+ /**
15455
+ * Callback function, which is called when a cell value is changed.
15456
+ * Default value: null
15457
+ */
15458
+ onCellValueChanged?: {(id: string, dataField: string, value: any): boolean};
15094
15459
  /**
15095
15460
  * Callback function() called before the grid has been initialized and the Grid's Virtual DOM is not created.
15096
15461
  * Default value: null
@@ -15211,26 +15576,6 @@ export interface GridProperties {
15211
15576
  * Default value: null
15212
15577
  */
15213
15578
  onCommand?: {(name: string, command: any, details: GridCell, event: Event | KeyboardEvent | PointerEvent, handled: boolean): void};
15214
- /**
15215
- * Sets or gets the rows CSS class rules. Different CSS class names are conditionally applied. Example: rowCSSRules: { 'cell-class-1': settings =&gt; settings.data.quantity === 5, 'cell-class-2': settings =&gt; settings.data.quantity &lt; 5, 'cell-class-3': settings =&gt; settings.data.quantity &gt; 5 }. The settings object contains the following properties: index, data, row, api.
15216
- * Default value: null
15217
- */
15218
- rowCSSRules?: any;
15219
- /**
15220
- * Sets or gets the id of the current user. Has to correspond to the id of an item from the users property/array. Depending on the current user, different privileges are enabled. If no current user is set, privileges depend on the element's properties.
15221
- * Default value:
15222
- */
15223
- currentUser?: string | number;
15224
- /**
15225
- * Sets the grid users. Expects an array with 'id', 'name' and optionally 'color' and 'image' properties.
15226
- * Default value: []
15227
- */
15228
- users?: any[];
15229
- /**
15230
- * Sets the grid's image and filter upload settings for the image and attachment columns.
15231
- * Default value: [object Object]
15232
- */
15233
- uploadSettings?: GridUploadSettings;
15234
15579
  /**
15235
15580
  * Describes the paging settings.
15236
15581
  * Default value: [object Object]
@@ -15246,16 +15591,26 @@ export interface GridProperties {
15246
15591
  * Default value: [object Object]
15247
15592
  */
15248
15593
  rowDetail?: GridRowDetail;
15594
+ /**
15595
+ * 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.
15596
+ * Default value: null
15597
+ */
15598
+ rowCSSRules?: any;
15599
+ /**
15600
+ * Sets or gets the value indicating whether the element is aligned to support locales using right-to-left fonts.
15601
+ * Default value: false
15602
+ */
15603
+ rightToLeft?: boolean;
15604
+ /**
15605
+ * The rows property is used to describe all rows displayed in the grid.
15606
+ * Default value:
15607
+ */
15608
+ rows?: GridRow[];
15249
15609
  /**
15250
15610
  * Sets the scroll mode settings.
15251
15611
  * Default value: physical
15252
15612
  */
15253
15613
  scrolling?: Scrolling | string;
15254
- /**
15255
- * Describes the column header settings.
15256
- * Default value: [object Object]
15257
- */
15258
- columnHeader?: GridColumnHeader;
15259
15614
  /**
15260
15615
  * Describes the summary row settings.
15261
15616
  * Default value: [object Object]
@@ -15267,40 +15622,30 @@ export interface GridProperties {
15267
15622
  */
15268
15623
  stateSettings?: GridStateSettings;
15269
15624
  /**
15270
- * Describes the settings for the group header.
15271
- * Default value: [object Object]
15272
- */
15273
- groupHeader?: GridGroupHeader;
15274
- /**
15275
- * Describes the header settings of the grid.
15625
+ * Describes the selection settings.
15276
15626
  * Default value: [object Object]
15277
15627
  */
15278
- header?: GridHeader;
15628
+ selection?: GridSelection;
15279
15629
  /**
15280
- * Describes the footer settings of the grid.
15630
+ * Describes sorting settings.
15281
15631
  * Default value: [object Object]
15282
15632
  */
15283
- footer?: GridFooter;
15284
- /**
15285
- * Sets or gets the value indicating whether the element is aligned to support locales using right-to-left fonts.
15286
- * Default value: false
15287
- */
15288
- rightToLeft?: boolean;
15633
+ sorting?: GridSorting;
15289
15634
  /**
15290
- * The rows property is used to describe all rows displayed in the grid.
15291
- * Default value:
15635
+ * Sets the grid users. Expects an array with 'id', 'name' and optionally 'color' and 'image' properties.
15636
+ * Default value: []
15292
15637
  */
15293
- rows?: GridRow[];
15638
+ users?: any[];
15294
15639
  /**
15295
- * Describes the selection settings.
15640
+ * Sets the grid's image and filter upload settings for the image and attachment columns.
15296
15641
  * Default value: [object Object]
15297
15642
  */
15298
- selection?: GridSelection;
15643
+ uploadSettings?: GridUploadSettings;
15299
15644
  /**
15300
- * Describes sorting settings.
15301
- * Default value: [object Object]
15645
+ * Sets the current data view. The possible values are 'grid', 'kanban' and 'card'.
15646
+ * Default value: "grid"
15302
15647
  */
15303
- sorting?: GridSorting;
15648
+ view?: string;
15304
15649
  }
15305
15650
  /**
15306
15651
  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.
@@ -15375,6 +15720,15 @@ export interface Grid extends BaseElement, GridProperties {
15375
15720
  * originalEvent - The origianl Event object.
15376
15721
  */
15377
15722
  onColumnDragStart?: ((this: any, ev: Event) => any) | ((this: any, ev: CustomEvent<any>) => any) | null;
15723
+ /**
15724
+ * This event is triggered, when a column property is changed.
15725
+ * @param event. The custom event. Custom data event was created with: ev.detail(column, propertyName, oldValue, value)
15726
+ * column - The resized column.
15727
+ * propertyName - The changed property's name.
15728
+ * oldValue - The old value(s) of the column.
15729
+ * value - The new value(s) of the column.
15730
+ */
15731
+ onColumnChange?: ((this: any, ev: Event) => any) | ((this: any, ev: CustomEvent<any>) => any) | null;
15378
15732
  /**
15379
15733
  * This event is triggered, when the user drags a column.
15380
15734
  * @param event. The custom event. Custom data event was created with: ev.detail(column, dataField, index, data, originalEvent)
@@ -15488,10 +15842,11 @@ export interface Grid extends BaseElement, GridProperties {
15488
15842
  onRowCollapse?: ((this: any, ev: Event) => any) | ((this: any, ev: CustomEvent<any>) => any) | null;
15489
15843
  /**
15490
15844
  * This event is triggered, when the user clicks on a row of the grid.
15491
- * @param event. The custom event. Custom data event was created with: ev.detail(row, originalEvent, id, isRightClick, pageX, pageY)
15845
+ * @param event. The custom event. Custom data event was created with: ev.detail(row, originalEvent, id, data, isRightClick, pageX, pageY)
15492
15846
  * row - The clicked row.
15493
15847
  * originalEvent - The original event object, which is 'pointer', 'touch' or 'mouse' Event object, depending on the device type and web browser
15494
15848
  * id - Gets the row id.
15849
+ * data - Gets the row data.
15495
15850
  * isRightClick - Gets whether the pointing device's right button is clicked.
15496
15851
  * pageX - Gets the click's X position.
15497
15852
  * pageY - Gets the click's Y position.
@@ -15499,10 +15854,11 @@ export interface Grid extends BaseElement, GridProperties {
15499
15854
  onRowClick?: ((this: any, ev: Event) => any) | ((this: any, ev: CustomEvent<any>) => any) | null;
15500
15855
  /**
15501
15856
  * This event is triggered, when the user double clicks on a row of the grid.
15502
- * @param event. The custom event. Custom data event was created with: ev.detail(row, originalEvent, id, isRightClick, pageX, pageY)
15857
+ * @param event. The custom event. Custom data event was created with: ev.detail(row, originalEvent, id, data, isRightClick, pageX, pageY)
15503
15858
  * row - The double-clicked row.
15504
15859
  * originalEvent - The original event object, which is 'pointer', 'touch' or 'mouse' Event object, depending on the device type and web browser
15505
15860
  * id - Gets the row id.
15861
+ * data - Gets the row data.
15506
15862
  * isRightClick - Gets whether the pointing device's right button is clicked.
15507
15863
  * pageX - Gets the click's X position.
15508
15864
  * pageY - Gets the click's Y position.
@@ -15528,11 +15884,12 @@ export interface Grid extends BaseElement, GridProperties {
15528
15884
  onRowStarred?: ((this: any, ev: Event) => any) | ((this: any, ev: CustomEvent<any>) => any) | null;
15529
15885
  /**
15530
15886
  * This event is triggered, when the user clicks on a cell of the grid.
15531
- * @param event. The custom event. Custom data event was created with: ev.detail(cell, originalEvent, id, dataField, isRightClick, pageX, pageY)
15887
+ * @param event. The custom event. Custom data event was created with: ev.detail(cell, originalEvent, id, dataField, value, isRightClick, pageX, pageY)
15532
15888
  * cell - The clicked cell.
15533
15889
  * originalEvent - The original event object, which is 'pointer', 'touch' or 'mouse' Event object, depending on the device type and web browser
15534
15890
  * id - Gets the row id.
15535
15891
  * dataField - Gets the column dataField.
15892
+ * value - Gets the cell value.
15536
15893
  * isRightClick - Gets whether the pointing device's right button is clicked.
15537
15894
  * pageX - Gets the click's X position.
15538
15895
  * pageY - Gets the click's Y position.
@@ -15540,11 +15897,12 @@ export interface Grid extends BaseElement, GridProperties {
15540
15897
  onCellClick?: ((this: any, ev: Event) => any) | ((this: any, ev: CustomEvent<any>) => any) | null;
15541
15898
  /**
15542
15899
  * This event is triggered, when the user double clicks on a cell of the grid.
15543
- * @param event. The custom event. Custom data event was created with: ev.detail(cell, originalEvent, id, dataField, isRightClick, pageX, pageY)
15900
+ * @param event. The custom event. Custom data event was created with: ev.detail(cell, originalEvent, id, dataField, value, isRightClick, pageX, pageY)
15544
15901
  * cell - The double-clicked cell.
15545
15902
  * originalEvent - The original event object, which is 'pointer', 'touch' or 'mouse' Event object, depending on the device type and web browser
15546
15903
  * id - Gets the row id.
15547
15904
  * dataField - Gets the column dataField.
15905
+ * value - Gets the cell value.
15548
15906
  * isRightClick - Gets whether the pointing device's right button is clicked.
15549
15907
  * pageX - Gets the click's X position.
15550
15908
  * pageY - Gets the click's Y position.
@@ -15792,8 +16150,10 @@ export interface Grid extends BaseElement, GridProperties {
15792
16150
  /**
15793
16151
  * 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.
15794
16152
  * @param {string} Dataformat. 'xlsx', 'pdf', 'json', 'xml', 'csv', 'tsv', 'html', 'png', 'jpeg'.
16153
+ * @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.
16154
+ * @param {any} dataCallback?. A callback that allows to change the exported data.
15795
16155
  */
15796
- exportData(Dataformat: string): void;
16156
+ exportData(Dataformat: string, callback?: any, dataCallback?: any): void;
15797
16157
  /**
15798
16158
  * Finds entries by using a query and returns an array of row ids. Example: const rows = grid.find('nancy'); returns all rows that have 'nancy' value. Example 2: const rows = grid.find('nancy, davolio'); returns all rows that have 'nancy' and 'davolio' values in the same row. Example 3: const rows = grid.find(5, 'quantity', '>'); returns all rows where the value of the 'quantity' field is > 5.
15799
16159
  * @param {string} query. Search query
@@ -15808,6 +16168,12 @@ export interface Grid extends BaseElement, GridProperties {
15808
16168
  * @returns {any[]}
15809
16169
  */
15810
16170
  findCells(query: string): any[];
16171
+ /**
16172
+ * Filter by all columns. This method works like a global filter and applies a filter to all grid columns.
16173
+ * @param {string} query. Filter query to filter by.
16174
+ * @param {string} dataType?. Optionally filter by a specific data type like 'string', 'boolean', 'date', 'number'.
16175
+ */
16176
+ filterBy(query: string, dataType?: string): void;
15811
16177
  /**
15812
16178
  * Navigates to a page, when paging is enabled.
15813
16179
  * @param {number} index. page index
@@ -15930,22 +16296,6 @@ export interface Grid extends BaseElement, GridProperties {
15930
16296
  * @returns {any}
15931
16297
  */
15932
16298
  getState(): any;
15933
- /**
15934
- * Saves the Grid state and returns a JSON object with the following fields: 'sort', 'columns', 'expandedRows', 'filter', 'groups', 'paging', 'selectedCells', 'selectedrows'. The 'sort' represents an object which contains the sorted columns. Each key in that json object is the column's dataField item which has sortOrder: string and sortIndex: int properties. The sortOrder could be either 'asc' or 'desc'. Similarly, the filter object contains the filtered columns. Each key in that object is a column data field and each value has 'filters' array property with the applied filters to the column. The 'columns' property contains an array of columns with saved properties such as visible, width and freeze. The 'expandedRows' property contains the indexes of the expanded rows. The 'groups' property contains the grouped column data fields and the selectedCells and selectedRows include information about the cells or rows selection. These depend on the selection mode used in the Grid. The 'paging' object includes the sub-properties 'count', 'index' and 'size' which determine the count of pages, the current page's index and the page size.
15935
- * @param {string} name?. state name
15936
- * @returns {any}
15937
- */
15938
- saveState(name?: string): any;
15939
- /**
15940
- * Loads a previously saved Grid state. You can pass a state name when there is a state which was previously saved with the saveState(stateName) method call or a state object returned by the saveState or getState method calls. The state object is required to be a JSON object with the following fields: 'sort', 'columns', 'expandedRows', 'filter', 'groups', 'paging', 'selectedCells', 'selectedrows'. The 'sort' represents an object which contains the sorted columns. Each key in that json object is the column's dataField item which has sortOrder: string and sortIndex: int properties. The sortOrder could be either 'asc' or 'desc'. Similarly, the filter object contains the filtered columns. Each key in that object is a column data field and each value has 'filters' array property with the applied filters to the column. The 'columns' property contains an array of columns with saved properties such as visible, width and freeze. The 'expandedRows' property contains the indexes of the expanded rows. The 'groups' property contains the grouped column data fields and the selectedCells and selectedRows include information about the cells or rows selection. These depend on the selection mode used in the Grid. The 'paging' object includes the sub-properties 'count', 'index' and 'size' which determine the count of pages, the current page's index and the page size.
15941
- * @param {any} state. state name or state object
15942
- * @returns {any}
15943
- */
15944
- loadState(state: any): any;
15945
- /**
15946
- * Resets the Grid state.
15947
- */
15948
- resetState(): void;
15949
16299
  /**
15950
16300
  * Gets the changes from the batch edit.
15951
16301
  * @returns
@@ -16042,6 +16392,12 @@ export interface Grid extends BaseElement, GridProperties {
16042
16392
  * @param callback?. Sets a callback function, which is called after the new row is added. The callback's argument is the new row.
16043
16393
  */
16044
16394
  insertRow(data: any, index?: number, callback?: {(row: GridRow): void}): void;
16395
+ /**
16396
+ * 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.
16397
+ * @param {any} state. state name or state object
16398
+ * @returns {any}
16399
+ */
16400
+ loadState(state: any): any;
16045
16401
  /**
16046
16402
  * Opens a column drop-down menu.
16047
16403
  * @param {string} dataField. column bound data field. For example, if you have a column with dataField: 'firstName', set 'firstName' here.
@@ -16053,6 +16409,14 @@ export interface Grid extends BaseElement, GridProperties {
16053
16409
  * @param {number} top. Top Position.
16054
16410
  */
16055
16411
  openContextMenu(left: number, top: number): void;
16412
+ /**
16413
+ * Opens the Grid when the 'dropDownMode' property is true.
16414
+ */
16415
+ openDropDown(): void;
16416
+ /**
16417
+ * Closes the Grid when the 'dropDownMode' property is true.
16418
+ */
16419
+ closeDropDown(): void;
16056
16420
  /**
16057
16421
  * 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.
16058
16422
  */
@@ -16069,6 +16433,10 @@ export interface Grid extends BaseElement, GridProperties {
16069
16433
  * Refreshes the grid cells in view. The method is useful for live-updates of cell values.
16070
16434
  */
16071
16435
  refreshView(): void;
16436
+ /**
16437
+ * Resets the Grid state.
16438
+ */
16439
+ resetState(): void;
16072
16440
  /**
16073
16441
  * Removes a column filter.
16074
16442
  * @param {string} dataField. column bound data field. For example, if you have a column with dataField: 'firstName', set 'firstName' here.
@@ -16100,6 +16468,12 @@ export interface Grid extends BaseElement, GridProperties {
16100
16468
  * @param {boolean} insertAfter?. Determines whether to insert the first column after the reference column.
16101
16469
  */
16102
16470
  reorderColumns(dataField: string | number, referenceDataField: string | number, insertAfter?: boolean): void;
16471
+ /**
16472
+ * 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.
16473
+ * @param {string} name?. state name
16474
+ * @returns {any}
16475
+ */
16476
+ saveState(name?: string): any;
16103
16477
  /**
16104
16478
  * 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.
16105
16479
  * @param {string} dataField. column bound data field. For example, if you have a column with dataField: 'firstName', set 'firstName' here.
@@ -16207,6 +16581,11 @@ export interface Grid extends BaseElement, GridProperties {
16207
16581
  * @param rowStyle. The cell style object. The object may have one or all of the following properties: 'background', 'color', 'fontSize', 'fontFamily', 'textDecoration', 'fontStyle', 'fontWeight'.
16208
16582
  */
16209
16583
  setCellStyle(rowId: string | number, dataField: string, rowStyle: {background?: string, color?: string, fontSize?: string, fontFamily?: string, textDecoration?: string, fontStyle?: string, fontWeight?: string}): void;
16584
+ /**
16585
+ * Sets the label of the Grid when the 'dropDownMode' property is true.
16586
+ * @param {string} label. The label to be displayed in the dropdown button.
16587
+ */
16588
+ setDropDownLabel(label: string): void;
16210
16589
  /**
16211
16590
  * Sets the position of the vertical scrollbar. You can use this method in combination with the getVerticalScrollValue and getVerticalScrollMax.
16212
16591
  * @param {number} value. The new scroll position
@@ -16222,6 +16601,13 @@ export interface Grid extends BaseElement, GridProperties {
16222
16601
  * @param {string | number} rowId. row bound id
16223
16602
  */
16224
16603
  showDetail(rowId: string | number): void;
16604
+ /**
16605
+ * 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.
16606
+ * @param {string | number} rowId. row bound id
16607
+ * @param {string} dataField. column bound data field. For example, if you have a column with dataField: 'firstName', set 'firstName' here.
16608
+ * @param {string} value. The message to be shown below the cell
16609
+ */
16610
+ showCellMessage(rowId: string | number, dataField: string, value: string): void;
16225
16611
  /**
16226
16612
  * Updates a row. When batch editing is enabled, the row is not saved until the batch edit is saved.
16227
16613
  * @param {string | number} rowId. row bound id
@@ -16423,6 +16809,16 @@ export interface GridAppearance {
16423
16809
  * Default value: true
16424
16810
  */
16425
16811
  showRowLines?: boolean;
16812
+ /**
16813
+ * Shows lines between columns in column groups.
16814
+ * Default value: true
16815
+ */
16816
+ showColumnGroupLines?: boolean;
16817
+ /**
16818
+ * Shows lines between cells in column groups.
16819
+ * Default value: true
16820
+ */
16821
+ showColumnGroupCellLines?: boolean;
16426
16822
  /**
16427
16823
  * 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.
16428
16824
  * Default value: false
@@ -16444,10 +16840,10 @@ export interface GridAppearance {
16444
16840
  */
16445
16841
  showFrozenColumnBackground?: boolean;
16446
16842
  /**
16447
- * Shows filtered row background, when the Grid has frozen rows.
16448
- * Default value: true
16843
+ * Shows the selection on top of all other styles.
16844
+ * Default value: false
16449
16845
  */
16450
- showFrozenRowBackground?: boolean;
16846
+ showSelectionOnTop?: boolean;
16451
16847
  /**
16452
16848
  * Shows column sort button.
16453
16849
  * Default value: true
@@ -16527,6 +16923,11 @@ export interface GridBehavior {
16527
16923
  * Default value: false
16528
16924
  */
16529
16925
  allowColumnFreeze?: boolean;
16926
+ /**
16927
+ * Determines whether the scrolling with mouse wheel is enabled.
16928
+ * Default value: true
16929
+ */
16930
+ allowMouseWheel?: boolean;
16530
16931
  /**
16531
16932
  * 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
16532
16933
  * Default value: none
@@ -16539,48 +16940,13 @@ export interface GridBehavior {
16539
16940
  rowResizeMode?: GridResizeMode | string;
16540
16941
  }
16541
16942
 
16542
- /**An object containing settings related to the grid's layout. */
16543
- export interface GridLayout {
16544
- /**
16545
- * Enables or disables the Cells Value wrapping. When the property is true, cell value can wrap in multiple lines.
16546
- * Default value: false
16547
- */
16548
- allowCellsWrap?: boolean;
16549
- /**
16550
- * Automatically sets width to any new Column which does not have its 'width' property set.
16551
- * Default value: false
16552
- */
16553
- autoSizeNewColumn?: boolean;
16554
- /**
16555
- * Sets the width of the auto-generated Grid columns.
16556
- * Default value: null
16557
- */
16558
- autoGenerateColumnWidth?: string | number | null;
16559
- /**
16560
- * Sets the width of the Grid columns.
16561
- * Default value: null
16562
- */
16563
- columnWidth?: string | number | null;
16564
- /**
16565
- * Sets the height of the Grid columns.
16566
- * Default value: null
16567
- */
16568
- columnHeight?: string | number | null;
16569
- /**
16570
- * Sets the minimum height of the Grid columns.
16571
- * Default value: 30
16572
- */
16573
- columnMinHeight?: number;
16574
- /**
16575
- * Sets the minimum height of the Grid rows.
16576
- * Default value: 30
16577
- */
16578
- rowMinHeight?: number;
16943
+ /**Describes the column header settings. */
16944
+ export interface GridColumnHeader {
16579
16945
  /**
16580
- * Sets the height of the Grid rows. The property can be set to null, auto or a number.
16581
- * Default value: null
16946
+ * Sets the column header visibility.
16947
+ * Default value: true
16582
16948
  */
16583
- rowHeight?: string | number | null;
16949
+ visible?: boolean;
16584
16950
  }
16585
16951
 
16586
16952
  /**The <em>clipboard</em> property is used to enable/disable clipboard operations with Ctrl+C, Ctrl+X and Ctrl+V keyboard navigations.. */
@@ -16590,6 +16956,11 @@ export interface GridClipboard {
16590
16956
  * Default value: true
16591
16957
  */
16592
16958
  enabled?: boolean;
16959
+ /**
16960
+ * Sets or gets whether the copy the column headers to the clipboard.
16961
+ * Default value: false
16962
+ */
16963
+ copyHeadersToClipboard?: boolean;
16593
16964
  /**
16594
16965
  * Sets or gets whether the copy-pasted values will be auto-filled by using automatic pattern detection. This is used in the Drag&Drop Multiple Cells selection. none does nothing. copy just copies the cells. 'fillSeries' detects and automatically fills the values. For example, if the selection has '1, 2' and the possible positions are more, the pasted values would be '1, 2, 3, 4, etc.
16595
16966
  * Default value: fillSeries
@@ -16629,10 +17000,10 @@ export interface GridColumn {
16629
17000
  */
16630
17001
  allowSelect?: boolean | null;
16631
17002
  /**
16632
- * Sets or gets whether the column can be edited.
17003
+ * 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'; }
16633
17004
  * Default value: true
16634
17005
  */
16635
- allowEdit?: boolean;
17006
+ allowEdit?: any;
16636
17007
  /**
16637
17008
  * Sets or gets whether the column can be sorted.
16638
17009
  * Default value: true
@@ -16663,6 +17034,11 @@ export interface GridColumn {
16663
17034
  * Default value: true
16664
17035
  */
16665
17036
  allowNull?: boolean;
17037
+ /**
17038
+ * Sets or gets the cell's height in card view mode.
17039
+ * Default value: 0
17040
+ */
17041
+ cardHeight?: number;
16666
17042
  /**
16667
17043
  * 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.
16668
17044
  * Default value: ""
@@ -16723,6 +17099,11 @@ export interface GridColumn {
16723
17099
  * Default value: ""
16724
17100
  */
16725
17101
  description?: string;
17102
+ /**
17103
+ * Sets or gets custom data object related to the column.
17104
+ * Default value: null
17105
+ */
17106
+ dataSet?: any;
16726
17107
  /**
16727
17108
  * Gets the HTML Element. The property returns null when the Column is not in the View.
16728
17109
  * Default value: null
@@ -16748,6 +17129,11 @@ export interface GridColumn {
16748
17129
  * Default value: default
16749
17130
  */
16750
17131
  filterMenuMode?: GridColumnFilterMenuMode | string;
17132
+ /**
17133
+ * 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
17134
+ * Default value: null
17135
+ */
17136
+ filterEditor?: any;
16751
17137
  /**
16752
17138
  * Sets or gets the column's format function.
16753
17139
  * Default value: null
@@ -16758,6 +17144,11 @@ export interface GridColumn {
16758
17144
  * Default value: [object Object]
16759
17145
  */
16760
17146
  formatSettings?: any;
17147
+ /**
17148
+ * 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')
17149
+ * Default value: ""
17150
+ */
17151
+ formula?: string;
16761
17152
  /**
16762
17153
  * Sets or gets the column's group.
16763
17154
  * Default value: ""
@@ -16799,10 +17190,20 @@ export interface GridColumn {
16799
17190
  */
16800
17191
  rowSpan?: {(cellValue: any, rowIndex: number, data: any): number};
16801
17192
  /**
16802
- * Sets or gets the sort order of the column. Accepts: 'asc', 'desc' and null.
16803
- * Default value: null
17193
+ * Sets or gets the relation id in the dataSourceSettings.relations. The 'relationField' property should be set.
17194
+ * Default value: ""
16804
17195
  */
16805
- sortOrder?: GridColumnSortOrder | null | string;
17196
+ relationId?: string;
17197
+ /**
17198
+ * Sets or gets the relation field in the dataSourceSettings.relations. The 'relationId' property should be set.
17199
+ * Default value: ""
17200
+ */
17201
+ relationField?: string;
17202
+ /**
17203
+ * Sets or gets the sort order of the column. Accepts: 'asc', 'desc', 'none' and null.
17204
+ * Default value: none
17205
+ */
17206
+ sortOrder?: GridColumnSortOrder | string;
16806
17207
  /**
16807
17208
  * Sets or gets the sort index of the column. Accepts an integer value. This property can be used to get or set the column's sort index when sorting mode is 'many'.
16808
17209
  * Default value: null
@@ -16834,10 +17235,15 @@ export interface GridColumn {
16834
17235
  */
16835
17236
  width?: string | number;
16836
17237
  /**
16837
- * Sets or gets the column's template. The property expects the 'id' of HTMLTemplateElement or HTML string which is displayed in the cells. Built-in string values are: 'checkBox', 'switchButton', 'radioButton', 'url', 'email', 'dropdownlist', 'list', 'progress', 'tags', 'autoNumber', 'modifiedBy', 'createdBy', 'createdTime', 'modifiedTime', 'images. For example, when you set the template to 'url', the cells will be render anchor tags. When you set the template property to HTMLTemplateElement you should consider that once a template is rendered, the formatObject.template property stores the rendered template component for further use.
17238
+ * 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.
16838
17239
  * Default value:
16839
17240
  */
16840
17241
  template?: any;
17242
+ /**
17243
+ * 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'.
17244
+ * Default value: null
17245
+ */
17246
+ templateSettings?: any;
16841
17247
  /**
16842
17248
  * Sets or gets the column's validation rules. The expected value is an Array of Objects. Each object should have a 'type' property that can be set to 'required', 'min', 'max', 'minLength', 'maxLength', 'email', 'null', 'requiredTrue', 'minData', 'maxDate', 'pattern'. The 'value' property should be set, too. For validation rule types 'required', 'requiredTrue' and 'null' you can skip the 'value' property. Optional property is 'message', which determines the error message.
16843
17249
  * Default value: null
@@ -16872,6 +17278,11 @@ export interface GridContextMenu {
16872
17278
  * Default value: false
16873
17279
  */
16874
17280
  enabled?: boolean;
17281
+ /**
17282
+ * Sets an array of custom context menu items to be displayed in the context menu.
17283
+ * Default value: null
17284
+ */
17285
+ customContextMenuItems?: any[];
16875
17286
  /**
16876
17287
  * Sets the data sources to the context menu.
16877
17288
  * Default value: [object Object]
@@ -17275,6 +17686,61 @@ export interface GridDataExport {
17275
17686
  * Default value: null
17276
17687
  */
17277
17688
  rowIds?: {(): void};
17689
+ /**
17690
+ * An array of custom rows to add before the Grid rows.
17691
+ * Default value: null
17692
+ */
17693
+ headerContent?: any;
17694
+ /**
17695
+ * An array of custom rows to add after the Grid rows.
17696
+ * Default value: null
17697
+ */
17698
+ footerContent?: any;
17699
+ /**
17700
+ * A function which allows you to add images to the cells in Export to Excel. The following params are passed: (index, dataField, value, values). It should return an object like this: return { image: { id: 'myImage' + index, base64: value, imageType: 'jpeg', width: 20, height: 11, position: { offsetX: 10 + (25 * values.indexOf(value)), offsetY: 5.5 } } };
17701
+ * Default value: null
17702
+ */
17703
+ addImageToCell?: any;
17704
+ /**
17705
+ * A function which allows you to set the height of the rows in the Export to Excel. The function gets the row index as parameter and should return its height as a number.
17706
+ * Default value: null
17707
+ */
17708
+ setRowHeight?: any;
17709
+ /**
17710
+ * A function which allows you to return additonal data to the Excel export to export into multiple sheets.
17711
+ * Default value: null
17712
+ */
17713
+ getSpreadsheets?: any;
17714
+ /**
17715
+ * A function which allows you to export a styled data grid to Excel.
17716
+ * Default value: true
17717
+ */
17718
+ exportStyles?: boolean;
17719
+ /**
17720
+ * A function which allows you to format cells before export. (index, dataField, value) are the params. It should return the formatted value.
17721
+ * Default value: null
17722
+ */
17723
+ cellFormatFunction?: any;
17724
+ /**
17725
+ * Sets whether the header is frozen when Export to Excel.
17726
+ * Default value: false
17727
+ */
17728
+ freezeHeader?: boolean;
17729
+ /**
17730
+ * Sets whether to auto-convert the formulas in the Excel export.
17731
+ * Default value: true
17732
+ */
17733
+ autoConvertFormulas?: boolean;
17734
+ /**
17735
+ * Sets whether to export only the selected cells or rows when Export to Excel.
17736
+ * Default value: false
17737
+ */
17738
+ onlySelected?: boolean;
17739
+ /**
17740
+ * Sets whether to export it as Excel Table when Export to Excel
17741
+ * Default value: false
17742
+ */
17743
+ exportAsTable?: boolean;
17278
17744
  }
17279
17745
 
17280
17746
  /**Sets the grid's data source settings when the <em>dataSource</em> property is set to an Array or URL. */
@@ -17339,6 +17805,11 @@ export interface GridDataSourceSettings {
17339
17805
  * Default value: "."
17340
17806
  */
17341
17807
  mapChar?: string;
17808
+ /**
17809
+ * 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.
17810
+ * Default value: null
17811
+ */
17812
+ relations?: any;
17342
17813
  /**
17343
17814
  * 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/
17344
17815
  * Default value: null
@@ -17386,6 +17857,11 @@ export interface GridEditing {
17386
17857
  * Default value: true
17387
17858
  */
17388
17859
  autoUpdateFilterAndSort?: boolean;
17860
+ /**
17861
+ * Automatically opens a drop-down editor not only when the arrow button is clicked, but also when you click an item from it.
17862
+ * Default value: true
17863
+ */
17864
+ allowListOpenOnContentClick?: boolean;
17389
17865
  /**
17390
17866
  * Enables editing.
17391
17867
  * Default value: false
@@ -17401,6 +17877,11 @@ export interface GridEditing {
17401
17877
  * Default value: click
17402
17878
  */
17403
17879
  action?: GridEditingAction | string;
17880
+ /**
17881
+ * 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.
17882
+ * Default value: false
17883
+ */
17884
+ readOnlyEdit?: boolean;
17404
17885
  /**
17405
17886
  * Describes command keys.
17406
17887
  * Default value: [object Object]
@@ -17751,6 +18232,20 @@ export interface GridFilteringFilterBuilder {
17751
18232
  height?: number | null;
17752
18233
  }
17753
18234
 
18235
+ /**Describes the footer settings of the grid. */
18236
+ export interface GridFooter {
18237
+ /**
18238
+ * Sets the footer visibility.
18239
+ * Default value: false
18240
+ */
18241
+ visible?: boolean;
18242
+ /**
18243
+ * Sets a template for the footer.
18244
+ * Default value:
18245
+ */
18246
+ template?: string | HTMLTemplateElement | {(element: HTMLElement): void};
18247
+ }
18248
+
17754
18249
  /**Describes the grid's grouping settings. */
17755
18250
  export interface GridGrouping {
17756
18251
  /**
@@ -17863,38 +18358,141 @@ export interface GridGroupingSummaryRow {
17863
18358
  visible?: boolean;
17864
18359
  }
17865
18360
 
17866
- /**Sets the grid's image and filter upload settings for the image and attachment columns. */
17867
- export interface GridUploadSettings {
18361
+ /**Describes the settings for the group header. */
18362
+ export interface GridGroupHeader {
17868
18363
  /**
17869
- * Sets or file/image upload url.
17870
- * Default value: ""
18364
+ * Sets the visibility of the group header.
18365
+ * Default value: false
17871
18366
  */
17872
- url?: string;
18367
+ visible?: boolean;
17873
18368
  /**
17874
- * Sets or file/image remove url.
17875
- * Default value: ""
18369
+ * Sets a template for the group header.
18370
+ * Default value:
17876
18371
  */
17877
- removeUrl?: string;
18372
+ template?: string | HTMLTemplateElement;
18373
+ }
18374
+
18375
+ /**Describes the header settings of the grid. */
18376
+ export interface GridHeader {
17878
18377
  /**
17879
- * Sets or gets the upload field name. In the backend, you can use this name to access the images data. For example in expressJS, you can use something like that: const images = req['files']['userfile[]'];
17880
- * Default value: "userfile[]"
18378
+ * Sets the header visibility.
18379
+ * Default value: false
17881
18380
  */
17882
- name?: string;
18381
+ visible?: boolean;
17883
18382
  /**
17884
- * Additional data to pass to the server. The format should be a JSON string.
17885
- * Default value: ""
18383
+ * Sets a template for the header.
18384
+ * Default value:
17886
18385
  */
17887
- data?: string;
18386
+ template?: string | HTMLTemplateElement | {(element: HTMLElement): void};
17888
18387
  /**
17889
- * Function called when the upload is completed. JSON object with 'files', 'status', 'fileURL' and 'serverResponse' are passed as parameters when the function is called by the Grid.
17890
- * Default value:
18388
+ * This callback function can be used for customization of the Header toolbar. The Toolbar HTML Element is passed as an argument.
18389
+ * Default value: null
17891
18390
  */
17892
- onUploadCompleted?: any;
18391
+ onInit?: {(element: HTMLElement): void};
17893
18392
  /**
17894
- * Function called when the upload has failed. JSON object with 'files', 'status' and 'serverResponse' are passed as parameters when the function is called by the Grid.
17895
- * Default value:
18393
+ * 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.
18394
+ * Default value: [ "columns", "filter", "group", "sort", "format", "search" ]
17896
18395
  */
17897
- onUploadError?: any;
18396
+ buttons?: string[];
18397
+ /**
18398
+ * Sets the search command type.
18399
+ * Default value: search
18400
+ */
18401
+ searchCommand?: GridHeaderSearchCommand | string;
18402
+ /**
18403
+ * Custom toolbar button. Allows you to add a custom button to the toolbar.
18404
+ * Default value: [object Object]
18405
+ */
18406
+ customButton?: GridCommand;
18407
+ }
18408
+
18409
+ /**An object containing settings related to the grid's layout. */
18410
+ export interface GridLayout {
18411
+ /**
18412
+ * Enables or disables the Cells Value wrapping. When the property is true, cell value can wrap in multiple lines.
18413
+ * Default value: false
18414
+ */
18415
+ allowCellsWrap?: boolean;
18416
+ /**
18417
+ * Automatically sets width to any new Column which does not have its 'width' property set.
18418
+ * Default value: false
18419
+ */
18420
+ autoSizeNewColumn?: boolean;
18421
+ /**
18422
+ * Sets the min width of the new column.
18423
+ * Default value: 250
18424
+ */
18425
+ autoSizeNewColumnMinWidth?: number;
18426
+ /**
18427
+ * Automatically sets the height of the Grid.
18428
+ * Default value: false
18429
+ */
18430
+ autoHeight?: boolean;
18431
+ /**
18432
+ * Automatically sets the width of the Grid. All columns should have a 'width' property set to a number in order to use this feature.
18433
+ * Default value: false
18434
+ */
18435
+ autoWidth?: boolean;
18436
+ /**
18437
+ * Sets the width of the auto-generated Grid columns.
18438
+ * Default value: null
18439
+ */
18440
+ autoGenerateColumnWidth?: string | number | null;
18441
+ /**
18442
+ * Sets the width of the Grid columns.
18443
+ * Default value: null
18444
+ */
18445
+ columnWidth?: string | number | null;
18446
+ /**
18447
+ * Sets the height of the Grid columns.
18448
+ * Default value: null
18449
+ */
18450
+ columnHeight?: string | number | null;
18451
+ /**
18452
+ * Sets the minimum height of the Grid columns.
18453
+ * Default value: 30
18454
+ */
18455
+ columnMinHeight?: number;
18456
+ /**
18457
+ * Sets the minimum width of a card in card view.
18458
+ * Default value: 250
18459
+ */
18460
+ cardMinWidth?: number;
18461
+ /**
18462
+ * Sets the cards per row.
18463
+ * Default value: null
18464
+ */
18465
+ cardsPerRow?: number;
18466
+ /**
18467
+ * Sets whether cards are vertically oriented. In this layout mode, the column label is displayed above the column value
18468
+ * Default value: false
18469
+ */
18470
+ cardVertical?: boolean;
18471
+ /**
18472
+ * Sets the width of the Grid when displayed in a drop-down mode.
18473
+ * Default value: 700
18474
+ */
18475
+ dropDownWidth?: number;
18476
+ /**
18477
+ * Sets the height of the Grid when displayed in a drop-down mode.
18478
+ * Default value: 500
18479
+ */
18480
+ dropDownHeight?: number;
18481
+ /**
18482
+ * Sets the minimum height of the Grid rows.
18483
+ * Default value: 30
18484
+ */
18485
+ rowMinHeight?: number;
18486
+ /**
18487
+ * Sets the height of the Grid rows. The property can be set to null, auto or a number.
18488
+ * Default value: null
18489
+ */
18490
+ rowHeight?: string | number | null;
18491
+ /**
18492
+ * Sets the width of the view bar.
18493
+ * Default value: 250
18494
+ */
18495
+ viewBarWidth?: number;
17898
18496
  }
17899
18497
 
17900
18498
  /**Describes the paging settings. */
@@ -18135,115 +18733,6 @@ export interface GridRowDetail {
18135
18733
  dialog?: Dialog;
18136
18734
  }
18137
18735
 
18138
- /**Describes the column header settings. */
18139
- export interface GridColumnHeader {
18140
- /**
18141
- * Sets the column header visibility.
18142
- * Default value: true
18143
- */
18144
- visible?: boolean;
18145
- }
18146
-
18147
- /**Describes the summary row settings. */
18148
- export interface GridSummaryRow {
18149
- /**
18150
- * Sets the summary row visibility.
18151
- * Default value: false
18152
- */
18153
- visible?: boolean;
18154
- /**
18155
- * 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.
18156
- * Default value: false
18157
- */
18158
- editing?: boolean;
18159
- }
18160
-
18161
- /**Sets the grid's state settings. */
18162
- export interface GridStateSettings {
18163
- /**
18164
- * Enables or disables auto-save of the Grid's state
18165
- * Default value: false
18166
- */
18167
- autoSave?: boolean;
18168
- /**
18169
- * Enables or disables save/load of the grid state.
18170
- * Default value: true
18171
- */
18172
- enabled?: boolean;
18173
- /**
18174
- * Sets or gets the current state.
18175
- * Default value: ""
18176
- */
18177
- current?: string;
18178
- /**
18179
- * Container which is auto-filled with state objects when you call the saveState method or enable the autoSave of states. Each object has a key which is the state's name and value which is a json with the state's properties.
18180
- * Default value: null
18181
- */
18182
- storage?: any;
18183
- /**
18184
- * Function called when the state is changed.
18185
- * Default value:
18186
- */
18187
- onStateChange?: any;
18188
- /**
18189
- * Array with state options such as 'sort', 'filter', 'expandedRows', 'paging', 'selectedCells', 'selectedRows', 'group', 'columns'. This property determines which parts of the state would be saved or loaded.
18190
- * Default value:
18191
- */
18192
- options?: string[];
18193
- }
18194
-
18195
- /**Describes the settings for the group header. */
18196
- export interface GridGroupHeader {
18197
- /**
18198
- * Sets the visibility of the group header.
18199
- * Default value: false
18200
- */
18201
- visible?: boolean;
18202
- /**
18203
- * Sets a template for the group header.
18204
- * Default value:
18205
- */
18206
- template?: string | HTMLTemplateElement;
18207
- }
18208
-
18209
- /**Describes the header settings of the grid. */
18210
- export interface GridHeader {
18211
- /**
18212
- * Sets the header visibility.
18213
- * Default value: false
18214
- */
18215
- visible?: boolean;
18216
- /**
18217
- * Sets a template for the header.
18218
- * Default value:
18219
- */
18220
- template?: string | HTMLTemplateElement | {(element: HTMLElement): void};
18221
- /**
18222
- * This callback function can be used for customization of the Header toolbar. The Toolbar HTML Element is passed as an argument.
18223
- * Default value: null
18224
- */
18225
- onInit?: {(element: HTMLElement): void};
18226
- /**
18227
- * Determines the buttons displayed in the Grid header. 'columns' displays a button opening the columns chooser panel. 'filter' displays a button opening the filtering panel. 'group' displays a button opening the grouping panel. 'sort' displays a button opening the sorting panel. 'format' displays a button opening the conditional formatting panel. 'search' displays a button opening the search panel.
18228
- * Default value: [ "columns", "filter", "group", "sort", "format", "search" ]
18229
- */
18230
- buttons?: string[];
18231
- }
18232
-
18233
- /**Describes the footer settings of the grid. */
18234
- export interface GridFooter {
18235
- /**
18236
- * Sets the footer visibility.
18237
- * Default value: false
18238
- */
18239
- visible?: boolean;
18240
- /**
18241
- * Sets a template for the footer.
18242
- * Default value:
18243
- */
18244
- template?: string | HTMLTemplateElement | {(element: HTMLElement): void};
18245
- }
18246
-
18247
18736
  export interface GridRow {
18248
18737
  /**
18249
18738
  * Sets or gets the row can be expanded or collapsed.
@@ -18500,6 +18989,59 @@ export interface GridCell {
18500
18989
  setStyle?: {(value: any): void};
18501
18990
  }
18502
18991
 
18992
+ /**Describes the summary row settings. */
18993
+ export interface GridSummaryRow {
18994
+ /**
18995
+ * Sets the summary row visibility.
18996
+ * Default value: false
18997
+ */
18998
+ visible?: boolean;
18999
+ /**
19000
+ * 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.
19001
+ * Default value: false
19002
+ */
19003
+ editing?: boolean;
19004
+ }
19005
+
19006
+ /**Sets the grid's state settings. */
19007
+ export interface GridStateSettings {
19008
+ /**
19009
+ * Enables or disables auto-save of the Grid's state
19010
+ * Default value: false
19011
+ */
19012
+ autoSave?: boolean;
19013
+ /**
19014
+ * Enables or disables auto-load of the Grid's state on page reload.
19015
+ * Default value: false
19016
+ */
19017
+ autoLoad?: boolean;
19018
+ /**
19019
+ * Enables or disables save/load of the grid state.
19020
+ * Default value: true
19021
+ */
19022
+ enabled?: boolean;
19023
+ /**
19024
+ * Sets or gets the current state.
19025
+ * Default value: ""
19026
+ */
19027
+ current?: string;
19028
+ /**
19029
+ * 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.
19030
+ * Default value: null
19031
+ */
19032
+ storage?: any;
19033
+ /**
19034
+ * Function called when the state is changed.
19035
+ * Default value:
19036
+ */
19037
+ onStateChange?: any;
19038
+ /**
19039
+ * 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.
19040
+ * Default value:
19041
+ */
19042
+ options?: string[];
19043
+ }
19044
+
18503
19045
  /**Describes the selection settings. */
18504
19046
  export interface GridSelection {
18505
19047
  /**
@@ -18651,6 +19193,40 @@ export interface GridSorting {
18651
19193
  sortToggleOnClickAndCommandKey?: boolean;
18652
19194
  }
18653
19195
 
19196
+ /**Sets the grid's image and filter upload settings for the image and attachment columns. */
19197
+ export interface GridUploadSettings {
19198
+ /**
19199
+ * Sets or file/image upload url.
19200
+ * Default value: ""
19201
+ */
19202
+ url?: string;
19203
+ /**
19204
+ * Sets or file/image remove url.
19205
+ * Default value: ""
19206
+ */
19207
+ removeUrl?: string;
19208
+ /**
19209
+ * 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[]'];
19210
+ * Default value: "userfile[]"
19211
+ */
19212
+ name?: string;
19213
+ /**
19214
+ * Additional data to pass to the server. The format should be a JSON string.
19215
+ * Default value: ""
19216
+ */
19217
+ data?: string;
19218
+ /**
19219
+ * 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.
19220
+ * Default value:
19221
+ */
19222
+ onUploadCompleted?: any;
19223
+ /**
19224
+ * 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.
19225
+ * Default value:
19226
+ */
19227
+ onUploadError?: any;
19228
+ }
19229
+
18654
19230
  declare global {
18655
19231
  interface Document {
18656
19232
  createElement(tagName: "smart-grid"): Grid;
@@ -18673,8 +19249,8 @@ export declare type GridClipboardAutoFillMode = 'none' | 'copy' | 'fillSeries';
18673
19249
  export declare type Position = 'near' | 'far';
18674
19250
  /**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. */
18675
19251
  export declare type GridColumnFilterMenuMode = 'basic' | 'default' | 'excel';
18676
- /**Sets or gets the sort order of the column. Accepts: 'asc', 'desc' and null. */
18677
- export declare type GridColumnSortOrder = 'asc' | 'desc' | null;
19252
+ /**Sets or gets the sort order of the column. Accepts: 'asc', 'desc', 'none' and null. */
19253
+ export declare type GridColumnSortOrder = 'asc' | 'desc' | 'none';
18678
19254
  /**The formatting condition. */
18679
19255
  export declare type GridConditionalFormattingCondition = 'between' | 'equal' | 'greaterThan' | 'lessThan' | 'notEqual';
18680
19256
  /**Sets the page orientation, when exporting to PDF. */
@@ -18701,6 +19277,8 @@ export declare type GridFilteringFilterMenuMode = 'default' | 'excel';
18701
19277
  export declare type GridGroupingExpandMode = 'buttonClick' | 'rowClick';
18702
19278
  /**Sets the group render mode. 'basic' mode renders the group headers without taking into account the indent, groupRowHeight and column label properties. 'compact' mode is the same as basic, but also renders the column labels in the group headers. The default mode is 'advanced', which adds indents to groups that depend on the group level. In 'multipleColumns' mode, each group is displayed in its column. */
18703
19279
  export declare type GridGroupingRenderMode = 'basic' | 'compact' | 'advanced' | 'multipleColumns';
19280
+ /**Sets the search command type. */
19281
+ export declare type GridHeaderSearchCommand = 'search' | 'filter';
18704
19282
  /**Sets the ellipsis display mode. */
18705
19283
  export declare type GridPagerAutoEllipsis = 'none' | 'before' | 'after' | 'both';
18706
19284
  /**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' */
@@ -18734,6 +19312,11 @@ export interface GroupPanelProperties {
18734
19312
  * Default value: false
18735
19313
  */
18736
19314
  disabled?: boolean;
19315
+ /**
19316
+ * Sets or gets the unlockKey which unlocks the product.
19317
+ * Default value: ""
19318
+ */
19319
+ unlockKey?: string;
18737
19320
  /**
18738
19321
  * Sets or gets the language. Used in conjunction with the property messages.
18739
19322
  * Default value: "en"
@@ -18863,6 +19446,11 @@ export interface InputProperties {
18863
19446
  * Default value: none
18864
19447
  */
18865
19448
  dropDownButtonPosition?: DropDownButtonPosition | string;
19449
+ /**
19450
+ * Determines the position of the drop down when opened.
19451
+ * Default value: auto
19452
+ */
19453
+ dropDownOpenPosition?: DropDownOpenPosition | string;
18866
19454
  /**
18867
19455
  * Sets the height of the drop down. By default it's set to an empty string. In this case the height of the drop down is controlled by a CSS variable.
18868
19456
  * Default value:
@@ -18883,6 +19471,11 @@ export interface InputProperties {
18883
19471
  * Default value: 8
18884
19472
  */
18885
19473
  items?: number;
19474
+ /**
19475
+ * Sets or gets the unlockKey which unlocks the product.
19476
+ * Default value: ""
19477
+ */
19478
+ unlockKey?: string;
18886
19479
  /**
18887
19480
  * Sets or gets the language. Used in conjunction with the property messages.
18888
19481
  * Default value: "en"
@@ -19075,6 +19668,8 @@ declare global {
19075
19668
  }
19076
19669
  }
19077
19670
 
19671
+ /**Determines the position of the drop down when opened. */
19672
+ export declare type DropDownOpenPosition = 'auto' | 'top' | 'bottom';
19078
19673
  /**Determines the auto complete query mode. This property also determines the matching algorithm for the autocomplete operation. */
19079
19674
  export declare type InputQueryMode = 'contains' | 'containsIgnoreCase' | 'doesNotContain' | 'doesNotContainIgnoreCase' | 'equals' | 'equalsIgnoreCase' | 'startsWith' | 'startsWithIgnoreCase' | 'endsWith' | 'endsWithIgnoreCase';
19080
19675
  export interface KanbanProperties {
@@ -19128,6 +19723,11 @@ export interface KanbanProperties {
19128
19723
  * Default value: true
19129
19724
  */
19130
19725
  allowDrop?: boolean;
19726
+ /**
19727
+ * Allows the dropping of tasks placeholder. When you drag a task over another task it will make an empty space for the task.
19728
+ * Default value: false
19729
+ */
19730
+ allowDropPlaceholder?: boolean;
19131
19731
  /**
19132
19732
  * This property changes the visual appeal of the Kanban columns and tasks. When set to true and the Kanban columns have their 'color' property set, the color is also applied to the tasks and edit dialog.
19133
19733
  * Default value: false
@@ -19238,6 +19838,11 @@ export interface KanbanProperties {
19238
19838
  * Default value: false
19239
19839
  */
19240
19840
  editable?: boolean;
19841
+ /**
19842
+ * 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.
19843
+ * Default value: doubleClick
19844
+ */
19845
+ editMode?: KanbanEditMode | string;
19241
19846
  /**
19242
19847
  * Sets or gets the format string of the "Due date" label and the "Start date" and "Due date" editors.
19243
19848
  * Default value: "d"
@@ -19258,6 +19863,11 @@ export interface KanbanProperties {
19258
19863
  * Default value: columns
19259
19864
  */
19260
19865
  hierarchy?: KanbanHierarchy | string;
19866
+ /**
19867
+ * Sets or gets the unlockKey which unlocks the product.
19868
+ * Default value: ""
19869
+ */
19870
+ unlockKey?: string;
19261
19871
  /**
19262
19872
  * Sets or gets the locale. Used in conjunction with the property messages.
19263
19873
  * Default value: "en"
@@ -19749,10 +20359,10 @@ export interface Kanban extends BaseElement, KanbanProperties {
19749
20359
  */
19750
20360
  getSelectedTasks(id: number): any;
19751
20361
  /**
19752
- * Gets the Kanban's state.
19753
- * @returns
20362
+ * 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 } }
20363
+ * @returns {any}
19754
20364
  */
19755
- 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 } };
20365
+ getState(): any;
19756
20366
  /**
19757
20367
  * Loads the Kanban's state.
19758
20368
  * @param state?. An object returned by one of the methods getState or saveState. If not passed, gets saved state from the browser's localStorage.
@@ -20063,6 +20673,8 @@ export declare type KanbanAddNewButtonDisplayMode = 'top' | 'bottom' | 'both';
20063
20673
  export declare type KanbanColumnOrientation = 'vertical' | 'horizontal';
20064
20674
  /**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. */
20065
20675
  export declare type KanbanColumnEditMode = 'header' | 'menu' | 'headerAndMenu';
20676
+ /**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. */
20677
+ export declare type KanbanEditMode = 'doubleClick' | 'singleClick';
20066
20678
  /**Sets or gets the header position. The header contains the Customize, Filter, Sort, and Search buttons. */
20067
20679
  export declare type KanbanHeaderPosition = 'none' | 'top' | 'bottom';
20068
20680
  /**Sets or gets the way column hierarchy is represented. */
@@ -20094,6 +20706,11 @@ export interface LayoutProperties {
20094
20706
  * Default value: null
20095
20707
  */
20096
20708
  dataSource?: any;
20709
+ /**
20710
+ * Sets or gets the unlockKey which unlocks the product.
20711
+ * Default value: ""
20712
+ */
20713
+ unlockKey?: string;
20097
20714
  /**
20098
20715
  * Sets or gets the language. Used in conjunction with the property messages.
20099
20716
  * Default value: "en"
@@ -20392,6 +21009,11 @@ export interface LedProperties {
20392
21009
  * Default value: null
20393
21010
  */
20394
21011
  indeterminateTemplate?: any;
21012
+ /**
21013
+ * Sets or gets the unlockKey which unlocks the product.
21014
+ * Default value: ""
21015
+ */
21016
+ unlockKey?: string;
20395
21017
  /**
20396
21018
  * Sets or gets the language. Used in conjunction with the property messages.
20397
21019
  * Default value: "en"
@@ -20643,6 +21265,11 @@ export interface ListBoxProperties {
20643
21265
  * Default value: center
20644
21266
  */
20645
21267
  loadingIndicatorPosition?: VerticalAlignment | string;
21268
+ /**
21269
+ * Sets or gets the unlockKey which unlocks the product.
21270
+ * Default value: ""
21271
+ */
21272
+ unlockKey?: string;
20646
21273
  /**
20647
21274
  * Sets or gets the language. Used in conjunction with the property messages.
20648
21275
  * Default value: "en"
@@ -20855,6 +21482,11 @@ export interface ListBox extends BaseElement, ListBoxProperties {
20855
21482
  * @returns {Node}
20856
21483
  */
20857
21484
  appendChild<T extends Node>(node: Node): T;
21485
+ /**
21486
+ * Adds a new item(s).
21487
+ * @param {any} item. Describes the properties of the item that will be inserted. You can also pass an array of items.
21488
+ */
21489
+ add(item: any): void;
20858
21490
  /**
20859
21491
  * Removes all items from the listBox.
20860
21492
  */
@@ -20863,6 +21495,10 @@ export interface ListBox extends BaseElement, ListBoxProperties {
20863
21495
  * Unselects all items.
20864
21496
  */
20865
21497
  clearSelection(): void;
21498
+ /**
21499
+ * Performs a data bind. This can be used to refresh the data source.
21500
+ */
21501
+ dataBind(): void;
20866
21502
  /**
20867
21503
  * Ensures the target item is visible by scrolling to it.
20868
21504
  * @param {HTMLElement | string} item. A list item or value of the desired item to be visible.
@@ -21158,6 +21794,11 @@ export interface ListMenuProperties {
21158
21794
  * Default value: center
21159
21795
  */
21160
21796
  loadingIndicatorPosition?: VerticalAlignment | string;
21797
+ /**
21798
+ * Sets or gets the unlockKey which unlocks the product.
21799
+ * Default value: ""
21800
+ */
21801
+ unlockKey?: string;
21161
21802
  /**
21162
21803
  * Sets or gets the language. Used in conjunction with the property messages.
21163
21804
  * Default value: "en"
@@ -21458,6 +22099,11 @@ export interface MaskedTextBoxProperties {
21458
22099
  * Default value: ""
21459
22100
  */
21460
22101
  label?: string;
22102
+ /**
22103
+ * Sets or gets the unlockKey which unlocks the product.
22104
+ * Default value: ""
22105
+ */
22106
+ unlockKey?: string;
21461
22107
  /**
21462
22108
  * Sets or gets the language. Used in conjunction with the property messages.
21463
22109
  * Default value: "en"
@@ -21710,6 +22356,11 @@ export interface MenuProperties {
21710
22356
  * Default value: "items"
21711
22357
  */
21712
22358
  itemsMember?: string;
22359
+ /**
22360
+ * Sets or gets the unlockKey which unlocks the product.
22361
+ * Default value: ""
22362
+ */
22363
+ unlockKey?: string;
21713
22364
  /**
21714
22365
  * Sets or gets the language. Used in conjunction with the property messages.
21715
22366
  * Default value: "en"
@@ -22121,6 +22772,11 @@ export interface MultiColumnFilterPanelProperties {
22121
22772
  * Default value: "Value"
22122
22773
  */
22123
22774
  editorPlaceholder?: string;
22775
+ /**
22776
+ * Sets or gets the unlockKey which unlocks the product.
22777
+ * Default value: ""
22778
+ */
22779
+ unlockKey?: string;
22124
22780
  /**
22125
22781
  * Sets or gets the language. Used in conjunction with the property messages.
22126
22782
  * Default value: "en"
@@ -22292,6 +22948,11 @@ export interface MultiComboInputProperties {
22292
22948
  * Default value: 8
22293
22949
  */
22294
22950
  items?: number;
22951
+ /**
22952
+ * Sets or gets the unlockKey which unlocks the product.
22953
+ * Default value: ""
22954
+ */
22955
+ unlockKey?: string;
22295
22956
  /**
22296
22957
  * Sets or gets the language. Used in conjunction with the property messages.
22297
22958
  * Default value: "en"
@@ -22514,6 +23175,11 @@ export interface MultiInputProperties {
22514
23175
  * Default value: 8
22515
23176
  */
22516
23177
  items?: number;
23178
+ /**
23179
+ * Sets or gets the unlockKey which unlocks the product.
23180
+ * Default value: ""
23181
+ */
23182
+ unlockKey?: string;
22517
23183
  /**
22518
23184
  * Sets or gets the language. Used in conjunction with the property messages.
22519
23185
  * Default value: "en"
@@ -22744,6 +23410,11 @@ export interface MultilineTextBoxProperties {
22744
23410
  * Default value: ""
22745
23411
  */
22746
23412
  label?: string;
23413
+ /**
23414
+ * Sets or gets the unlockKey which unlocks the product.
23415
+ * Default value: ""
23416
+ */
23417
+ unlockKey?: string;
22747
23418
  /**
22748
23419
  * Sets or gets the language. Used in conjunction with the property messages.
22749
23420
  * Default value: "en"
@@ -23030,6 +23701,11 @@ export interface MultiSplitButtonProperties {
23030
23701
  * Default value: center
23031
23702
  */
23032
23703
  loadingIndicatorPosition?: VerticalAlignment | string;
23704
+ /**
23705
+ * Sets or gets the unlockKey which unlocks the product.
23706
+ * Default value: ""
23707
+ */
23708
+ unlockKey?: string;
23033
23709
  /**
23034
23710
  * Sets or gets the language. Used in conjunction with the property messages.
23035
23711
  * Default value: "en"
@@ -23231,6 +23907,11 @@ export interface NumberInputProperties {
23231
23907
  * Default value: "off"
23232
23908
  */
23233
23909
  inputPurpose?: string;
23910
+ /**
23911
+ * Sets or gets the unlockKey which unlocks the product.
23912
+ * Default value: ""
23913
+ */
23914
+ unlockKey?: string;
23234
23915
  /**
23235
23916
  * Sets or gets the language. Used in conjunction with the property messages.
23236
23917
  * Default value: "en"
@@ -23414,6 +24095,11 @@ export interface NumericTextBoxProperties {
23414
24095
  * Default value: false
23415
24096
  */
23416
24097
  leadingZeros?: boolean;
24098
+ /**
24099
+ * Sets or gets the unlockKey which unlocks the product.
24100
+ * Default value: ""
24101
+ */
24102
+ unlockKey?: string;
23417
24103
  /**
23418
24104
  * Sets or gets the language. Used in conjunction with the property messages.
23419
24105
  * Default value: "en"
@@ -23668,6 +24354,11 @@ export interface PagerProperties {
23668
24354
  * Default value: false
23669
24355
  */
23670
24356
  disabled?: boolean;
24357
+ /**
24358
+ * Sets or gets the unlockKey which unlocks the product.
24359
+ * Default value: ""
24360
+ */
24361
+ unlockKey?: string;
23671
24362
  /**
23672
24363
  * Sets or gets the language. Used in conjunction with the property messages.
23673
24364
  * Default value: "en"
@@ -23852,6 +24543,11 @@ export interface PasswordInputProperties {
23852
24543
  * Default value: false
23853
24544
  */
23854
24545
  disabled?: boolean;
24546
+ /**
24547
+ * Sets or gets the unlockKey which unlocks the product.
24548
+ * Default value: ""
24549
+ */
24550
+ unlockKey?: string;
23855
24551
  /**
23856
24552
  * Sets or gets the language. Used in conjunction with the property messages.
23857
24553
  * Default value: "en"
@@ -23988,6 +24684,11 @@ export interface PasswordTextBoxProperties {
23988
24684
  * Default value: ""
23989
24685
  */
23990
24686
  label?: string;
24687
+ /**
24688
+ * Sets or gets the unlockKey which unlocks the product.
24689
+ * Default value: ""
24690
+ */
24691
+ unlockKey?: string;
23991
24692
  /**
23992
24693
  * Sets or gets the language. Used in conjunction with the property messages.
23993
24694
  * Default value: "en"
@@ -24237,6 +24938,11 @@ export interface PathProperties {
24237
24938
  * Default value: ""
24238
24939
  */
24239
24940
  label?: string;
24941
+ /**
24942
+ * Sets or gets the unlockKey which unlocks the product.
24943
+ * Default value: ""
24944
+ */
24945
+ unlockKey?: string;
24240
24946
  /**
24241
24947
  * Sets or gets the language. Used in conjunction with the property messages.
24242
24948
  * Default value: "en"
@@ -24413,6 +25119,11 @@ export interface PhoneInputProperties {
24413
25119
  * Default value: * [object Object]
24414
25120
  */
24415
25121
  messages?: any;
25122
+ /**
25123
+ * Sets or gets the unlockKey which unlocks the product.
25124
+ * Default value: ""
25125
+ */
25126
+ unlockKey?: string;
24416
25127
  /**
24417
25128
  * Sets or gets the name attribute for the element. Name is used when submiting data inside an HTML form.
24418
25129
  * Default value: ""
@@ -24670,6 +25381,11 @@ export interface PivotTableProperties {
24670
25381
  * Default value: false
24671
25382
  */
24672
25383
  keyboardNavigation?: boolean;
25384
+ /**
25385
+ * Sets or gets the unlockKey which unlocks the product.
25386
+ * Default value: ""
25387
+ */
25388
+ unlockKey?: string;
24673
25389
  /**
24674
25390
  * Sets or gets the language. Used in conjunction with the property messages.
24675
25391
  * Default value: "en"
@@ -24700,6 +25416,21 @@ export interface PivotTableProperties {
24700
25416
  * Default value: null
24701
25417
  */
24702
25418
  onInit?: { (): void };
25419
+ /**
25420
+ * Sets or gets the page size (when paging is enabled).
25421
+ * Default value: 10
25422
+ */
25423
+ pageSize?: PivotTablePageSize | string;
25424
+ /**
25425
+ * Sets or gets the current (zero-based) page index (when paging is enabled).
25426
+ * Default value: 0
25427
+ */
25428
+ pageIndex?: number;
25429
+ /**
25430
+ * Sets or gets whether paging is enabled.
25431
+ * Default value: false
25432
+ */
25433
+ paging?: boolean;
24703
25434
  /**
24704
25435
  * Sets or gets the value indicating whether the element is aligned to support locales using right-to-left fonts.
24705
25436
  * Default value: false
@@ -25044,6 +25775,8 @@ export declare type PivotTableDesignerPosition = 'near' | 'far';
25044
25775
  export declare type PivotTableDrillDownDataExport = null | 'xlsx' | 'pdf' | 'html' | 'json' | 'csv' | 'tsv' | 'xml';
25045
25776
  /**Sets or gets the way row nesting (based on rowGroup columns) is displayed. */
25046
25777
  export declare type PivotTableGroupLayout = 'classic' | 'default';
25778
+ /**Sets or gets the page size (when paging is enabled). */
25779
+ export declare type PivotTablePageSize = '10' | '25' | '50';
25047
25780
  /**Sets or gets the position of row total columns (shown when rowTotals is enabled). */
25048
25781
  export declare type PivotTableRowTotalsPosition = 'near' | 'far';
25049
25782
  /**Sets or gets the selection mode. Only applicable when selection is enabled. */
@@ -25071,6 +25804,11 @@ export interface PowerButtonProperties {
25071
25804
  * Default value: false
25072
25805
  */
25073
25806
  disabled?: boolean;
25807
+ /**
25808
+ * Sets or gets the unlockKey which unlocks the product.
25809
+ * Default value: ""
25810
+ */
25811
+ unlockKey?: string;
25074
25812
  /**
25075
25813
  * Sets or gets the language. Used in conjunction with the property messages.
25076
25814
  * Default value: "en"
@@ -25172,6 +25910,11 @@ export interface ProgressBarProperties {
25172
25910
  * Default value: null
25173
25911
  */
25174
25912
  formatFunction?: {(value: number): string};
25913
+ /**
25914
+ * Sets or gets the unlockKey which unlocks the product.
25915
+ * Default value: ""
25916
+ */
25917
+ unlockKey?: string;
25175
25918
  /**
25176
25919
  * Sets or gets the language. Used in conjunction with the property messages.
25177
25920
  * Default value: "en"
@@ -25283,6 +26026,11 @@ export interface QRcodeProperties {
25283
26026
  * Default value: "H"
25284
26027
  */
25285
26028
  errorLevel?: string;
26029
+ /**
26030
+ * Sets color to the transparent parts of the embedded image. Background remains transparent if set to empty string.
26031
+ * Default value: ""
26032
+ */
26033
+ imageBackgroundColor?: string;
25286
26034
  /**
25287
26035
  * Sets the height of the embedded image.
25288
26036
  * Default value: 15
@@ -25343,6 +26091,16 @@ export interface QRcodeProperties {
25343
26091
  * Default value: ""
25344
26092
  */
25345
26093
  value?: string;
26094
+ /**
26095
+ * 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.
26096
+ * Default value: 0
26097
+ */
26098
+ width?: number;
26099
+ /**
26100
+ * 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.
26101
+ * Default value: 0
26102
+ */
26103
+ height?: number;
25346
26104
  }
25347
26105
  /**
25348
26106
  QR Codes encode text values in a two-dimensional pattern.
@@ -25470,6 +26228,11 @@ export interface QueryBuilderProperties {
25470
26228
  * Default value: { '=': 'equals', '<>': 'notequals', '>': 'greaterthan', '>=': 'greaterthanorequal', '<': 'lessthan', '<=': 'lessthanorequal', 'startswith': 'startswith', 'endswith': 'endswith', 'contains': 'contains', 'notcontains': 'notcontains', 'isblank': 'isblank', 'isnotblank': 'isnotblank' }
25471
26229
  */
25472
26230
  icons?: any;
26231
+ /**
26232
+ * Sets or gets the unlockKey which unlocks the product.
26233
+ * Default value: ""
26234
+ */
26235
+ unlockKey?: string;
25473
26236
  /**
25474
26237
  * Sets or gets the language. Used in conjunction with the property messages.
25475
26238
  * Default value: "en"
@@ -25789,6 +26552,11 @@ export interface RadioButtonProperties {
25789
26552
  * Default value: """"
25790
26553
  */
25791
26554
  innerHTML: string;
26555
+ /**
26556
+ * Sets or gets the unlockKey which unlocks the product.
26557
+ * Default value: ""
26558
+ */
26559
+ unlockKey?: string;
25792
26560
  /**
25793
26561
  * Sets or gets the language. Used in conjunction with the property messages.
25794
26562
  * Default value: "en"
@@ -25896,6 +26664,11 @@ export interface RatingProperties {
25896
26664
  * Default value: false
25897
26665
  */
25898
26666
  disabled?: boolean;
26667
+ /**
26668
+ * Sets or gets the unlockKey which unlocks the product.
26669
+ * Default value: ""
26670
+ */
26671
+ unlockKey?: string;
25899
26672
  /**
25900
26673
  * Sets or gets the language. Used in conjunction with the property messages.
25901
26674
  * Default value: "en"
@@ -26020,6 +26793,11 @@ export interface RepeatButtonProperties {
26020
26793
  * Default value: """"
26021
26794
  */
26022
26795
  innerHTML: string;
26796
+ /**
26797
+ * Sets or gets the unlockKey which unlocks the product.
26798
+ * Default value: ""
26799
+ */
26800
+ unlockKey?: string;
26023
26801
  /**
26024
26802
  * Sets or gets the language. Used in conjunction with the property messages.
26025
26803
  * Default value: "en"
@@ -26095,6 +26873,433 @@ declare global {
26095
26873
  }
26096
26874
  }
26097
26875
 
26876
+ export interface RibbonProperties {
26877
+ /**
26878
+ * Determines whether the ribbon is collapsible.
26879
+ * Default value: false
26880
+ */
26881
+ collapsible?: any;
26882
+ /**
26883
+ * Determines the tab items of the ribbon.
26884
+ * Default value:
26885
+ */
26886
+ dataSource?: any;
26887
+ /**
26888
+ * Sets or gets the value indicating whether the element is disabled.
26889
+ * Default value: false
26890
+ */
26891
+ disabled?: boolean;
26892
+ /**
26893
+ * Determines the file menu options of the ribbon.
26894
+ * Default value: undefined
26895
+ */
26896
+ fileMenu?: RibbonFileMenu;
26897
+ /**
26898
+ * Sets or gets the unlockKey which unlocks the product.
26899
+ * Default value: ""
26900
+ */
26901
+ unlockKey?: string;
26902
+ /**
26903
+ * Determines the locale of the ribbon.
26904
+ * Default value: "en"
26905
+ */
26906
+ locale?: string;
26907
+ /**
26908
+ * Determines the messages of the ribbon
26909
+ * Default value: * [object Object]
26910
+ */
26911
+ messages?: any;
26912
+ /**
26913
+ * Sets or gets the value indicating whether the element is aligned to support locales using right-to-left fonts.
26914
+ * Default value: false
26915
+ */
26916
+ rightToLeft?: boolean;
26917
+ /**
26918
+ * Determines the selected tab.
26919
+ * Default value: 0
26920
+ */
26921
+ selectedTab?: any;
26922
+ }
26923
+ /**
26924
+ Ribbon is a navigation control that allows you to organize your application's commands in a tabbed interface.
26925
+ */
26926
+ export interface Ribbon extends BaseElement, RibbonProperties {
26927
+
26928
+ /* Get a member by its name */
26929
+ [name: string]: any;
26930
+ /**
26931
+ * This event is triggered when the ribbon is collapsed.
26932
+ * @param event. The custom event. */
26933
+ onCollapse?: ((this: any, ev: Event) => any) | ((this: any, ev: CustomEvent<any>) => any) | null;
26934
+ /**
26935
+ * This event is triggered when the ribbon is collapsing. The event can be canceled by calling event.preventDefault() in the event handler function.
26936
+ * @param event. The custom event. */
26937
+ onCollapsing?: ((this: any, ev: Event) => any) | ((this: any, ev: CustomEvent<any>) => any) | null;
26938
+ /**
26939
+ * This event is triggered when the dialog launcher is clicked.
26940
+ * @param event. The custom event. Custom data event was created with: ev.detail(groupLabel, groupId)
26941
+ * groupLabel - The label of the dialog launcher's ribbon group.
26942
+ * groupId - The id of the dialog launcher's ribbon group.
26943
+ */
26944
+ onDialogLauncherClick?: ((this: any, ev: Event) => any) | ((this: any, ev: CustomEvent<any>) => any) | null;
26945
+ /**
26946
+ * This event is triggered when the ribbon is expanded.
26947
+ * @param event. The custom event. */
26948
+ onExpand?: ((this: any, ev: Event) => any) | ((this: any, ev: CustomEvent<any>) => any) | null;
26949
+ /**
26950
+ * This event is triggered when the ribbon is expanding. The event can be canceled by calling event.preventDefault() in the event handler function.
26951
+ * @param event. The custom event. */
26952
+ onExpanding?: ((this: any, ev: Event) => any) | ((this: any, ev: CustomEvent<any>) => any) | null;
26953
+ /**
26954
+ * This event is triggered when the file menu button is clicked.
26955
+ * @param event. The custom event. */
26956
+ onFileButtonClick?: ((this: any, ev: Event) => any) | ((this: any, ev: CustomEvent<any>) => any) | null;
26957
+ /**
26958
+ * This event is triggered when the file menu is opened.
26959
+ * @param event. The custom event. */
26960
+ onFileMenuOpen?: ((this: any, ev: Event) => any) | ((this: any, ev: CustomEvent<any>) => any) | null;
26961
+ /**
26962
+ * This event is triggered when the file menu is closed.
26963
+ * @param event. The custom event. */
26964
+ onFileMenuClose?: ((this: any, ev: Event) => any) | ((this: any, ev: CustomEvent<any>) => any) | null;
26965
+ /**
26966
+ * This event is triggered when a file menu item is clicked.
26967
+ * @param event. The custom event. Custom data event was created with: ev.detail(item)
26968
+ * item - The file menu item.
26969
+ */
26970
+ onFileMenuItemClick?: ((this: any, ev: Event) => any) | ((this: any, ev: CustomEvent<any>) => any) | null;
26971
+ /**
26972
+ * This event is triggered when the tab selection is changed.
26973
+ * @param event. The custom event. Custom data event was created with: ev.detail(oldIndex, index)
26974
+ * oldIndex - The previous tab index.
26975
+ * index - The new index of the selected tab.
26976
+ */
26977
+ onSelect?: ((this: any, ev: Event) => any) | ((this: any, ev: CustomEvent<any>) => any) | null;
26978
+ /**
26979
+ * This event is triggered when the tab selection is changing. The event can be canceled by calling event.preventDefault() in the event handler function.
26980
+ * @param event. The custom event. Custom data event was created with: ev.detail(oldIndex, index)
26981
+ * oldIndex - The previous tab index.
26982
+ * index - The new index of the selected tab.
26983
+ */
26984
+ onSelecting?: ((this: any, ev: Event) => any) | ((this: any, ev: CustomEvent<any>) => any) | null;
26985
+ /**
26986
+ * Adds a new ribbon tab to the ribbon. The tab can be added as an object, HTMLElement or id to an HTMLElement.
26987
+ * @param {any} tab. The ribbon tab to be added.
26988
+ */
26989
+ addTab(tab: any): void;
26990
+ /**
26991
+ * Adds a new group to a ribbon tab. The group can be added as an object, HTMLElement or id to an HTMLElement.
26992
+ * @param {any} tab. The id, index or HTMLElement of the parent ribbon tab.
26993
+ * @param {any} group. The ribbon group to be added.
26994
+ */
26995
+ addGroup(tab: any, group: any): void;
26996
+ /**
26997
+ * Adds a new ribbon item to a ribbon group. The item can be added as an object, HTMLElement or id to an HTMLElement.
26998
+ * @param {string | number | HTMLElement} tab. The id, index or HTMLElement of the parent ribbon tab.
26999
+ * @param {string | HTMLElement} group. The id or HTMLElement of the parent ribbon group.
27000
+ * @param {any} item. The ribbon item to be added.
27001
+ */
27002
+ addItem(tab: string | number | HTMLElement, group: string | HTMLElement, item: any): void;
27003
+ /**
27004
+ * Collapses the ribbon.
27005
+ */
27006
+ collapse(): void;
27007
+ /**
27008
+ * Expands the ribbon.
27009
+ */
27010
+ expand(): void;
27011
+ /**
27012
+ * Removes a ribbon tab from the ribbon.
27013
+ * @param {string | number} ribbonTab. The id or index of the ribbon tab to be removed.
27014
+ */
27015
+ removeTab(ribbonTab: string | number): void;
27016
+ /**
27017
+ * Removes a ribbon group from a ribbon tab.
27018
+ * @param {string | number} ribbonTabIndex?. The id or index of the parent ribbon tab.
27019
+ * @param {string | number} ribbonGroup?. The id or index of the ribbon group to be removed.
27020
+ */
27021
+ removeGroup(ribbonTabIndex?: string | number, ribbonGroup?: string | number): void;
27022
+ /**
27023
+ * Removes a ribbon item from a ribbon group.
27024
+ * @param {string | number} ribbonTabIndex?. The id or index of the parent ribbon tab.
27025
+ * @param {string | number} ribbonGroup?. The id or index of the parent ribbon group.
27026
+ * @param {string | number} ribbonItem?. The id or index of the ribbon item to be removed.
27027
+ */
27028
+ removeItem(ribbonTabIndex?: string | number, ribbonGroup?: string | number, ribbonItem?: string | number): void;
27029
+ /**
27030
+ * Selects a ribbon tab.
27031
+ * @param {string | number} ribbonTabIndex. The index of the ribbon tab to be selected.
27032
+ */
27033
+ selectTab(ribbonTabIndex: string | number): void;
27034
+ }
27035
+
27036
+ /**Determines the file menu options of the ribbon. */
27037
+ export interface RibbonFileMenu {
27038
+ /**
27039
+ * Determines whether the file button is enabled.
27040
+ * Default value: true
27041
+ */
27042
+ enabled?: boolean;
27043
+ /**
27044
+ * Determines the data source that will be loaded to the FileMenu.
27045
+ * Default value:
27046
+ */
27047
+ items?: any;
27048
+ /**
27049
+ * Determines the position of the file menu.
27050
+ * Default value: left
27051
+ */
27052
+ position?: RibbonFileMenuPosition | string;
27053
+ /**
27054
+ * Determines the label of the file menu.
27055
+ * Default value: "File"
27056
+ */
27057
+ label?: string;
27058
+ /**
27059
+ * Determines the tooltip of the file menu.
27060
+ * Default value: ""
27061
+ */
27062
+ tooltip?: string;
27063
+ /**
27064
+ * Determines the template of the file menu. Accepts HTMLTemplateElement, an id of an HTMLTemplateElement or a Function.
27065
+ * Default value: ""
27066
+ */
27067
+ template?: string;
27068
+ /**
27069
+ * Determines the type of the file menu.
27070
+ * Default value: dropDown
27071
+ */
27072
+ type?: RibbonFileMenuType | string;
27073
+ /**
27074
+ * Determines the icon of the file menu.
27075
+ * Default value: ""
27076
+ */
27077
+ icon?: string;
27078
+ }
27079
+
27080
+ declare global {
27081
+ interface Document {
27082
+ createElement(tagName: "smart-ribbon"): Ribbon;
27083
+ querySelector(selectors: "smart-ribbon"): Ribbon | null;
27084
+ querySelectorAll(selectors: "smart-ribbon"): NodeListOf<Ribbon>;
27085
+ getElementsByTagName(qualifiedName: "smart-ribbon"): HTMLCollectionOf<Ribbon>;
27086
+ getElementsByName(elementName: "smart-ribbon"): NodeListOf<Ribbon>;
27087
+ }
27088
+ }
27089
+
27090
+ /**Determines the position of the file menu. */
27091
+ export declare type RibbonFileMenuPosition = 'left' | 'right';
27092
+ /**Determines the type of the file menu. */
27093
+ export declare type RibbonFileMenuType = 'dropDown' | 'button';
27094
+ export interface RibbonGroupProperties {
27095
+ /**
27096
+ * Determines the label of the ribbon group.
27097
+ * Default value: ""
27098
+ */
27099
+ label?: string;
27100
+ /**
27101
+ * Determines the icon of the ribbon group.
27102
+ * Default value: ""
27103
+ */
27104
+ icon?: string;
27105
+ /**
27106
+ * Determines the class of the ribbon group.
27107
+ * Default value: ""
27108
+ */
27109
+ cssClass?: string;
27110
+ /**
27111
+ * Determines the ribbon items of the ribbon group.
27112
+ * Default value:
27113
+ */
27114
+ ribbonItems?: any;
27115
+ /**
27116
+ * Determines the direction of the ribbon group.
27117
+ * Default value: horizontal
27118
+ */
27119
+ direction?: RibbonGroupDirection | string;
27120
+ /**
27121
+ * Determines the settings of the dialog launcher of the ribbon group.
27122
+ * Default value: [object Object]
27123
+ */
27124
+ dialogLauncher?: RibbonGroupDialogLauncher;
27125
+ /**
27126
+ * Determines the size, below which the ribbon group will be wrapped.
27127
+ * Default value: undefined
27128
+ */
27129
+ wrapSize?: RibbonGroupWrapSize | string;
27130
+ }
27131
+ /**
27132
+ Defines a ribbon group.
27133
+ */
27134
+ export interface RibbonGroup extends BaseElement, RibbonGroupProperties {
27135
+
27136
+ /* Get a member by its name */
27137
+ [name: string]: any;
27138
+ }
27139
+
27140
+ /**Determines the settings of the dialog launcher of the ribbon group. */
27141
+ export interface RibbonGroupDialogLauncher {
27142
+ /**
27143
+ * Determines whether the dialog launcher is enabled.
27144
+ * Default value: false
27145
+ */
27146
+ enabled?: boolean;
27147
+ /**
27148
+ * Determines the tooltip of the dialog launcher.
27149
+ * Default value: ""
27150
+ */
27151
+ tooltip?: string;
27152
+ }
27153
+
27154
+ declare global {
27155
+ interface Document {
27156
+ createElement(tagName: "smart-ribbon-group"): RibbonGroup;
27157
+ querySelector(selectors: "smart-ribbon-group"): RibbonGroup | null;
27158
+ querySelectorAll(selectors: "smart-ribbon-group"): NodeListOf<RibbonGroup>;
27159
+ getElementsByTagName(qualifiedName: "smart-ribbon-group"): HTMLCollectionOf<RibbonGroup>;
27160
+ getElementsByName(elementName: "smart-ribbon-group"): NodeListOf<RibbonGroup>;
27161
+ }
27162
+ }
27163
+
27164
+ /**Determines the direction of the ribbon group. */
27165
+ export declare type RibbonGroupDirection = 'horizontal' | 'vertical';
27166
+ /**Determines the size, below which the ribbon group will be wrapped. */
27167
+ export declare type RibbonGroupWrapSize = 'iconOnly' | 'verySmall' | 'small' | 'normal' | 'large' | 'none';
27168
+ export interface RibbonItemProperties {
27169
+ /**
27170
+ * Determines whether the ribbon item is disabled.
27171
+ * Default value: false
27172
+ */
27173
+ disabled?: boolean;
27174
+ /**
27175
+ * Determines the label of the ribbon item.
27176
+ * Default value: ""
27177
+ */
27178
+ label?: string;
27179
+ /**
27180
+ * Determines the type of the ribbon item.
27181
+ * Default value: button
27182
+ */
27183
+ type?: RibbonItemType | string;
27184
+ /**
27185
+ * Determines the template of the ribbon item. Accepts HTMLTemplateElement, an id of an HTMLTemplateElement or a Function.
27186
+ * Default value: ""
27187
+ */
27188
+ template?: string;
27189
+ /**
27190
+ * Determines the size of the ribbon item.
27191
+ * Default value: normal
27192
+ */
27193
+ size?: RibbonItemSize | string;
27194
+ /**
27195
+ *
27196
+ * Default value: null
27197
+ */
27198
+ sizeChanged?: any;
27199
+ /**
27200
+ * Determines the allowed sizes of the ribbon item.
27201
+ * Default value:
27202
+ */
27203
+ allowedSizes?: any;
27204
+ /**
27205
+ * Determines the icon of the ribbon item.
27206
+ * Default value: ""
27207
+ */
27208
+ icon?: string;
27209
+ /**
27210
+ * Determines the settings of the ribbon item. The settings will be applied as properties if the ribbon item is set to a Smart Element.
27211
+ * Default value: [object Object]
27212
+ */
27213
+ settings?: RibbonItemSettings;
27214
+ /**
27215
+ * Determines the class of the ribbon item.
27216
+ * Default value: ""
27217
+ */
27218
+ cssClass?: string;
27219
+ /**
27220
+ * Sets a click event handler for the ribbon item.
27221
+ * Default value: null
27222
+ */
27223
+ onItemClick?: any;
27224
+ /**
27225
+ * Sets a change event handler for the ribbon item.
27226
+ * Default value: null
27227
+ */
27228
+ onItemChange?: any;
27229
+ /**
27230
+ * Determines the tooltip of the ribbon item.
27231
+ * Default value: ""
27232
+ */
27233
+ tooltip?: string;
27234
+ }
27235
+ /**
27236
+ Defines a ribbon item.
27237
+ */
27238
+ export interface RibbonItem extends BaseElement, RibbonItemProperties {
27239
+
27240
+ /* Get a member by its name */
27241
+ [name: string]: any;
27242
+ }
27243
+
27244
+ /**Determines the settings of the ribbon item. The settings will be applied as properties if the ribbon item is set to a Smart Element. */
27245
+ export interface RibbonItemSettings {
27246
+ }
27247
+
27248
+ declare global {
27249
+ interface Document {
27250
+ createElement(tagName: "smart-ribbon-item"): RibbonItem;
27251
+ querySelector(selectors: "smart-ribbon-item"): RibbonItem | null;
27252
+ querySelectorAll(selectors: "smart-ribbon-item"): NodeListOf<RibbonItem>;
27253
+ getElementsByTagName(qualifiedName: "smart-ribbon-item"): HTMLCollectionOf<RibbonItem>;
27254
+ getElementsByName(elementName: "smart-ribbon-item"): NodeListOf<RibbonItem>;
27255
+ }
27256
+ }
27257
+
27258
+ /**Determines the type of the ribbon item. */
27259
+ export declare type RibbonItemType = 'separator' | 'button' | 'toggleButton' | 'multiSplitButton' | 'dropDownButton' | 'input' | 'custom';
27260
+ /**Determines the size of the ribbon item. */
27261
+ export declare type RibbonItemSize = 'iconOnly' | 'small' | 'verySmall' | 'normal' | 'large';
27262
+ export interface RibbonTabProperties {
27263
+ /**
27264
+ * Determines whether the tab item is disabled.
27265
+ * Default value: false
27266
+ */
27267
+ disabled?: boolean;
27268
+ /**
27269
+ * Determines the label of the tab item.
27270
+ * Default value: ""
27271
+ */
27272
+ label?: string;
27273
+ /**
27274
+ * Determines whether the tab item is selected.
27275
+ * Default value: false
27276
+ */
27277
+ selected?: boolean;
27278
+ /**
27279
+ * Determines the ribbon group of the tab item
27280
+ * Default value: undefined
27281
+ */
27282
+ ribbonGroups?: any;
27283
+ }
27284
+ /**
27285
+ Defines a ribbon tab.
27286
+ */
27287
+ export interface RibbonTab extends BaseElement, RibbonTabProperties {
27288
+
27289
+ /* Get a member by its name */
27290
+ [name: string]: any;
27291
+ }
27292
+
27293
+ declare global {
27294
+ interface Document {
27295
+ createElement(tagName: "smart-ribbon-tab"): RibbonTab;
27296
+ querySelector(selectors: "smart-ribbon-tab"): RibbonTab | null;
27297
+ querySelectorAll(selectors: "smart-ribbon-tab"): NodeListOf<RibbonTab>;
27298
+ getElementsByTagName(qualifiedName: "smart-ribbon-tab"): HTMLCollectionOf<RibbonTab>;
27299
+ getElementsByName(elementName: "smart-ribbon-tab"): NodeListOf<RibbonTab>;
27300
+ }
27301
+ }
27302
+
26098
27303
  export interface SchedulerProperties {
26099
27304
  /**
26100
27305
  * Determines the scroll speed while dragging an event.
@@ -26116,6 +27321,11 @@ export interface SchedulerProperties {
26116
27321
  * Default value: #D50000,#E67C73,#F4511E,#F6BF26,#33B679,#0B8043,#039BE5,#3F51B5,#7986CB,#8E24AA,#616161,
26117
27322
  */
26118
27323
  colorScheme?: string[];
27324
+ /**
27325
+ * Determines the current time of the Scheduler to use for the current time indicator functionality. By default the current time is Today.
27326
+ * Default value: new Date()
27327
+ */
27328
+ currentTime?: string | Date;
26119
27329
  /**
26120
27330
  * Enables/Disables the current time indicator. Current time indicator shows the current time in the appropriate view cells.
26121
27331
  * Default value: false
@@ -26396,6 +27606,11 @@ export interface SchedulerProperties {
26396
27606
  * Default value: auto
26397
27607
  */
26398
27608
  horizontalScrollBarVisibility?: HorizontalScrollBarVisibility | string;
27609
+ /**
27610
+ * Sets or gets the unlockKey which unlocks the product.
27611
+ * Default value: ""
27612
+ */
27613
+ unlockKey?: string;
26399
27614
  /**
26400
27615
  * Determines the language of the Scheduler.
26401
27616
  * Default value: "en"
@@ -26472,7 +27687,7 @@ export interface SchedulerProperties {
26472
27687
  */
26473
27688
  restrictedHours?: any;
26474
27689
  /**
26475
- * Defines an array of dates and hours that are not allowed to have events on. Events that overlap restricted Hours or start/end on them will not be displayed. Each array item is an Object and requires 2 fields - date and hours. For example: { date: new Date(2022, 10, 1), hours: [[0, 6], 12, [20, 23]] }. The hours define a range of restricted hours similartly to the restricted hours property, the date defines a date where the restricted hours will be applied.
27690
+ * 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.
26476
27691
  * Default value:
26477
27692
  */
26478
27693
  restricted?: any;
@@ -26943,9 +28158,10 @@ export interface Scheduler extends BaseElement, SchedulerProperties {
26943
28158
  /**
26944
28159
  * Exports the events from the Scheduler.
26945
28160
  * @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>
26946
- * @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.
28161
+ * @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.
28162
+ * @param {any} dataCallback?. A callback that allows to change the exported data.
26947
28163
  */
26948
- exportData(dataFormat: string, callback?: any): void;
28164
+ exportData(dataFormat: string, callback?: any, dataCallback?: any): void;
26949
28165
  /**
26950
28166
  * Returns a JSON representation of the events inside the Scheduler.
26951
28167
  * @returns {any}
@@ -27455,6 +28671,11 @@ export interface ScrollBarProperties {
27455
28671
  * Default value: 100
27456
28672
  */
27457
28673
  largeStep?: number;
28674
+ /**
28675
+ * Sets or gets the unlockKey which unlocks the product.
28676
+ * Default value: ""
28677
+ */
28678
+ unlockKey?: string;
27458
28679
  /**
27459
28680
  * Sets or gets the language. Used in conjunction with the property messages.
27460
28681
  * Default value: "en"
@@ -27630,6 +28851,11 @@ export interface SliderProperties {
27630
28851
  * Default value: all
27631
28852
  */
27632
28853
  labelsVisibility?: LabelsVisibility | string;
28854
+ /**
28855
+ * Sets or gets the unlockKey which unlocks the product.
28856
+ * Default value: ""
28857
+ */
28858
+ unlockKey?: string;
27633
28859
  /**
27634
28860
  * Sets or gets the locale. Used in conjunction with the property messages.
27635
28861
  * Default value: "en"
@@ -27884,6 +29110,11 @@ export interface SortableProperties {
27884
29110
  * Default value: null
27885
29111
  */
27886
29112
  items?: string | null;
29113
+ /**
29114
+ * Sets or gets the unlockKey which unlocks the product.
29115
+ * Default value: ""
29116
+ */
29117
+ unlockKey?: string;
27887
29118
  /**
27888
29119
  * Sets or gets the language. Used in conjunction with the property messages.
27889
29120
  * Default value: "en"
@@ -27984,6 +29215,11 @@ export interface SortPanelProperties {
27984
29215
  * Default value: false
27985
29216
  */
27986
29217
  disabled?: boolean;
29218
+ /**
29219
+ * Sets or gets the unlockKey which unlocks the product.
29220
+ * Default value: ""
29221
+ */
29222
+ unlockKey?: string;
27987
29223
  /**
27988
29224
  * Sets or gets the language. Used in conjunction with the property messages.
27989
29225
  * Default value: "en"
@@ -28098,6 +29334,11 @@ export interface SplitterProperties {
28098
29334
  * Default value: false
28099
29335
  */
28100
29336
  keepProportionsOnResize?: boolean;
29337
+ /**
29338
+ * Sets or gets the unlockKey which unlocks the product.
29339
+ * Default value: ""
29340
+ */
29341
+ unlockKey?: string;
28101
29342
  /**
28102
29343
  * Sets or gets the language. Used in conjunction with the property messages.
28103
29344
  * Default value: "en"
@@ -28453,6 +29694,11 @@ export interface SwitchButtonProperties {
28453
29694
  * Default value: false
28454
29695
  */
28455
29696
  inverted?: boolean;
29697
+ /**
29698
+ * Sets or gets the unlockKey which unlocks the product.
29699
+ * Default value: ""
29700
+ */
29701
+ unlockKey?: string;
28456
29702
  /**
28457
29703
  * Sets or gets the language. Used in conjunction with the property messages.
28458
29704
  * Default value: "en"
@@ -28961,6 +30207,11 @@ export interface TableProperties {
28961
30207
  * Default value: implementationOnly
28962
30208
  */
28963
30209
  loadColumnStateBehavior?: TableLoadColumnStateBehavior | string;
30210
+ /**
30211
+ * Sets or gets the unlockKey which unlocks the product.
30212
+ * Default value: ""
30213
+ */
30214
+ unlockKey?: string;
28964
30215
  /**
28965
30216
  * Sets or gets the language. Used in conjunction with the property messages.
28966
30217
  * Default value: "en"
@@ -29055,7 +30306,7 @@ export interface TableProperties {
29055
30306
  * Sets or gets the page size (when paging is enabled).
29056
30307
  * Default value: 10
29057
30308
  */
29058
- pageSize?: TablePageSize | string;
30309
+ pageSize?: number;
29059
30310
  /**
29060
30311
  * Sets or gets the current (zero-based) page index (when paging is enabled).
29061
30312
  * Default value: 0
@@ -29076,6 +30327,11 @@ export interface TableProperties {
29076
30327
  * Default value: "null"
29077
30328
  */
29078
30329
  rowDetailTemplate?: string;
30330
+ /**
30331
+ * Sets or gets a callback function with 3 arguments - column, filterConditions, filterInputTemplateString. The function should return the new filter input.
30332
+ * Default value: null
30333
+ */
30334
+ onFilterRowInput?: any;
29079
30335
  /**
29080
30336
  * Sets or gets an array of the Table's selected row's ids.
29081
30337
  * Default value:
@@ -29431,6 +30687,10 @@ export interface Table extends BaseElement, TableProperties {
29431
30687
  * @param {string | number} row. The id of the cell's row.
29432
30688
  */
29433
30689
  removeRow(row: string | number): void;
30690
+ /**
30691
+ * 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.
30692
+ */
30693
+ resetState(): void;
29434
30694
  /**
29435
30695
  * 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.
29436
30696
  * @returns {any}
@@ -29789,8 +31049,6 @@ export declare type TableDataSourceSettingsDataSourceType = 'array' | 'json' | '
29789
31049
  export declare type TableEditMode = 'cell' | 'row';
29790
31050
  /**Sets or gets the behavior when loading column settings either via autoLoadState or loadState. Applicable only when stateSettings contains 'columns'. */
29791
31051
  export declare type TableLoadColumnStateBehavior = 'implementationOnly' | 'intersection' | 'stateOnly';
29792
- /**Sets or gets the page size (when paging is enabled). */
29793
- export declare type TablePageSize = '10' | '25' | '50';
29794
31052
  /**Sets or gets the selection mode. Only applicable when selection is enabled. */
29795
31053
  export declare type TableSelectionMode = 'one' | 'many' | 'extended';
29796
31054
  /**Determines the sorting mode of the Table. */
@@ -29846,6 +31104,11 @@ export interface TabsProperties {
29846
31104
  * Default value: false
29847
31105
  */
29848
31106
  enableMouseWheelAction?: boolean;
31107
+ /**
31108
+ * Sets or gets the unlockKey which unlocks the product.
31109
+ * Default value: ""
31110
+ */
31111
+ unlockKey?: string;
29849
31112
  /**
29850
31113
  * Sets or gets the locale. Used in conjunction with the property messages.
29851
31114
  * Default value: "en"
@@ -30149,6 +31412,11 @@ export interface TankProperties {
30149
31412
  * Default value: all
30150
31413
  */
30151
31414
  labelsVisibility?: LabelsVisibility | string;
31415
+ /**
31416
+ * Sets or gets the unlockKey which unlocks the product.
31417
+ * Default value: ""
31418
+ */
31419
+ unlockKey?: string;
30152
31420
  /**
30153
31421
  * Sets or gets the locale. Used in conjunction with the property messages.
30154
31422
  * Default value: "en"
@@ -30398,6 +31666,11 @@ export interface TextAreaProperties {
30398
31666
  * Default value: 8
30399
31667
  */
30400
31668
  items?: number;
31669
+ /**
31670
+ * Sets or gets the unlockKey which unlocks the product.
31671
+ * Default value: ""
31672
+ */
31673
+ unlockKey?: string;
30401
31674
  /**
30402
31675
  * Sets or gets the language. Used in conjunction with the property messages.
30403
31676
  * Default value: "en"
@@ -30460,11 +31733,21 @@ export interface TextAreaProperties {
30460
31733
  * Default value: false
30461
31734
  */
30462
31735
  readonly?: boolean;
31736
+ /**
31737
+ * Determines whether ot not the user can resize the Textarea.
31738
+ * Default value: none
31739
+ */
31740
+ resize?: TextAreaResize | string;
30463
31741
  /**
30464
31742
  * Sets or gets the value indicating whether the element is aligned to support locales using right-to-left fonts.
30465
31743
  * Default value: false
30466
31744
  */
30467
31745
  rightToLeft?: boolean;
31746
+ /**
31747
+ * Enables or disables the rich text formatting.
31748
+ * Default value: false
31749
+ */
31750
+ richText?: boolean;
30468
31751
  /**
30469
31752
  * Determines whether the items are sorted alphabetically or not
30470
31753
  * Default value: false
@@ -30490,6 +31773,11 @@ export interface TextAreaProperties {
30490
31773
  * Default value: false
30491
31774
  */
30492
31775
  unfocusable?: boolean;
31776
+ /**
31777
+ * 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.
31778
+ * Default value: []
31779
+ */
31780
+ users?: any[];
30493
31781
  /**
30494
31782
  * Sets or gets the value of the element.
30495
31783
  * Default value: ""
@@ -30527,6 +31815,11 @@ export interface TextArea extends BaseElement, TextAreaProperties {
30527
31815
  * Ensures that the active ( selected ) item is always visible.
30528
31816
  */
30529
31817
  ensureVisible(): void;
31818
+ /**
31819
+ * Returns an array of users mentioned in the Textarea's value.
31820
+ * @returns {any[]}
31821
+ */
31822
+ getMentions(): any[];
30530
31823
  /**
30531
31824
  * Opens the drop down.
30532
31825
  */
@@ -30549,6 +31842,8 @@ declare global {
30549
31842
 
30550
31843
  /**Determines the auto complete query mode. This property also determines the matching algorithm for the autocomplete operation. */
30551
31844
  export declare type TextAreaQueryMode = 'contains' | 'containsIgnoreCase' | 'doesNotContain' | 'doesNotContainIgnoreCase' | 'equals' | 'equalsIgnoreCase' | 'startsWith' | 'startsWithIgnoreCase' | 'endsWith' | 'endsWithIgnoreCase';
31845
+ /**Determines whether ot not the user can resize the Textarea. */
31846
+ export declare type TextAreaResize = 'none' | 'horizontal' | 'vertical' | 'both';
30552
31847
  export interface TextBoxProperties {
30553
31848
  /**
30554
31849
  * Sets or gets the animation mode. Animation is disabled when the property is set to 'none'
@@ -30720,6 +32015,11 @@ export interface TextBoxProperties {
30720
32015
  * Default value: center
30721
32016
  */
30722
32017
  loadingIndicatorPosition?: VerticalAlignment | string;
32018
+ /**
32019
+ * Sets or gets the unlockKey which unlocks the product.
32020
+ * Default value: ""
32021
+ */
32022
+ unlockKey?: string;
30723
32023
  /**
30724
32024
  * Sets or gets the language. Used in conjunction with the property messages.
30725
32025
  * Default value: "en"
@@ -30907,6 +32207,11 @@ export interface TimeInputProperties {
30907
32207
  * Default value: "off"
30908
32208
  */
30909
32209
  inputPurpose?: string;
32210
+ /**
32211
+ * Sets or gets the unlockKey which unlocks the product.
32212
+ * Default value: ""
32213
+ */
32214
+ unlockKey?: string;
30910
32215
  /**
30911
32216
  * Sets or gets the language. Used in conjunction with the property messages.
30912
32217
  * Default value: "en"
@@ -31046,6 +32351,62 @@ declare global {
31046
32351
  export declare type TimeFormatHour = 'numeric' | '2-digit';
31047
32352
  /**Minute format. */
31048
32353
  export declare type TimeFormatMinute = 'numeric' | '2-digit';
32354
+ export interface TimelineProperties {
32355
+ /**
32356
+ * Sets or gets whether the Timeline is with auto width in horizontal mode.
32357
+ * Default value: false
32358
+ */
32359
+ autoWidth?: boolean;
32360
+ /**
32361
+ * Sets or gets whether the items can be collapsed.
32362
+ * Default value: true
32363
+ */
32364
+ collapsible?: boolean;
32365
+ /**
32366
+ * Sets or gets whether the Timeline is disabled.
32367
+ * Default value: false
32368
+ */
32369
+ disabled?: boolean;
32370
+ /**
32371
+ * Sets or gets whether the Timeline is horizontal.
32372
+ * Default value: false
32373
+ */
32374
+ horizontal?: boolean;
32375
+ /**
32376
+ * Sets or gets position. The possible values are 'near', 'far' and 'both'.
32377
+ * Default value: "both"
32378
+ */
32379
+ position?: string;
32380
+ /**
32381
+ * Sets or gets the items. Each item should be an object. The object has the following properties: date: date, description: string, subtitle: string, css: string, dotCSS: string, title: string and icon: string. Example: [{ date: 'May 15, 2024', description: 'Flight: Reserving airline tickets', subtitle: 'May 15, 2024', title: 'Flight Reservation', icon: 'material-icons flight', dotCSS: '' }]
32382
+ * Default value: []
32383
+ */
32384
+ dataSource?: any[];
32385
+ }
32386
+ /**
32387
+ Displays a timeline with events.
32388
+ */
32389
+ export interface Timeline extends BaseElement, TimelineProperties {
32390
+
32391
+ /* Get a member by its name */
32392
+ [name: string]: any;
32393
+ /**
32394
+ * Re-renders the timeline.
32395
+ * @returns {any}
32396
+ */
32397
+ render(): any;
32398
+ }
32399
+
32400
+ declare global {
32401
+ interface Document {
32402
+ createElement(tagName: "smart-timeline"): Timeline;
32403
+ querySelector(selectors: "smart-timeline"): Timeline | null;
32404
+ querySelectorAll(selectors: "smart-timeline"): NodeListOf<Timeline>;
32405
+ getElementsByTagName(qualifiedName: "smart-timeline"): HTMLCollectionOf<Timeline>;
32406
+ getElementsByName(elementName: "smart-timeline"): NodeListOf<Timeline>;
32407
+ }
32408
+ }
32409
+
31049
32410
  export interface TimePickerProperties {
31050
32411
  /**
31051
32412
  * Sets or gets the animation mode. Animation is disabled when the property is set to 'none'
@@ -31077,6 +32438,11 @@ export interface TimePickerProperties {
31077
32438
  * Default value: 12-hour
31078
32439
  */
31079
32440
  format?: TimePickerFormat | string;
32441
+ /**
32442
+ * Sets or gets the unlockKey which unlocks the product.
32443
+ * Default value: ""
32444
+ */
32445
+ unlockKey?: string;
31080
32446
  /**
31081
32447
  * Sets or gets the language. Used in conjunction with the property messages.
31082
32448
  * Default value: "en"
@@ -31235,6 +32601,11 @@ export interface ToastProperties {
31235
32601
  * Default value: "null"
31236
32602
  */
31237
32603
  itemTemplate?: string;
32604
+ /**
32605
+ * Sets or gets the unlockKey which unlocks the product.
32606
+ * Default value: ""
32607
+ */
32608
+ unlockKey?: string;
31238
32609
  /**
31239
32610
  * Sets or gets the language. Used in conjunction with the property messages.
31240
32611
  * Default value: "en"
@@ -31404,6 +32775,11 @@ export interface ToggleButtonProperties {
31404
32775
  * Default value: """"
31405
32776
  */
31406
32777
  innerHTML: string;
32778
+ /**
32779
+ * Sets or gets the unlockKey which unlocks the product.
32780
+ * Default value: ""
32781
+ */
32782
+ unlockKey?: string;
31407
32783
  /**
31408
32784
  * Sets or gets the language. Used in conjunction with the property messages.
31409
32785
  * Default value: "en"
@@ -31531,6 +32907,11 @@ export interface TooltipProperties {
31531
32907
  * Default value: 0,0
31532
32908
  */
31533
32909
  offset?: number[];
32910
+ /**
32911
+ * Sets or gets the unlockKey which unlocks the product.
32912
+ * Default value: ""
32913
+ */
32914
+ unlockKey?: string;
31534
32915
  /**
31535
32916
  * Sets or gets the language. Used in conjunction with the property messages.
31536
32917
  * Default value: "en"
@@ -31776,6 +33157,11 @@ export interface TreeProperties {
31776
33157
  * Default value: center
31777
33158
  */
31778
33159
  loadingIndicatorPosition?: VerticalAlignment | string;
33160
+ /**
33161
+ * Sets or gets the unlockKey which unlocks the product.
33162
+ * Default value: ""
33163
+ */
33164
+ unlockKey?: string;
31779
33165
  /**
31780
33166
  * Sets or gets the locale. Used in conjunction with the property messages.
31781
33167
  * Default value: "en"
@@ -31981,6 +33367,12 @@ export interface Tree extends BaseElement, TreeProperties {
31981
33367
  * children - the children of the jqx-tree-items-group to be expanded
31982
33368
  */
31983
33369
  onExpanding?: ((this: any, ev: Event) => any) | ((this: any, ev: CustomEvent<any>) => any) | null;
33370
+ /**
33371
+ * This event is triggered when selection in jqx-tree is changed.
33372
+ * @param event. The custom event. Custom data event was created with: ev.detail(value)
33373
+ * value - The filter input value.
33374
+ */
33375
+ onFilterChange?: ((this: any, ev: Event) => any) | ((this: any, ev: CustomEvent<any>) => any) | null;
31984
33376
  /**
31985
33377
  * This event is triggered when the Tree has been scrolled to the bottom.
31986
33378
  * @param event. The custom event. */
@@ -32057,6 +33449,11 @@ export interface Tree extends BaseElement, TreeProperties {
32057
33449
  * @returns {HTMLElement}
32058
33450
  */
32059
33451
  getItem(id: string): HTMLElement;
33452
+ /**
33453
+ * Gets the applied filter.
33454
+ * @returns {string}
33455
+ */
33456
+ getFilter(): string;
32060
33457
  /**
32061
33458
  * Gets the selected values. If value is not defined, returns the selected labels.
32062
33459
  * @returns {string[]}
@@ -32508,6 +33905,11 @@ export interface WindowProperties {
32508
33905
  * Default value: null
32509
33906
  */
32510
33907
  layout?: any;
33908
+ /**
33909
+ * Sets or gets the unlockKey which unlocks the product.
33910
+ * Default value: ""
33911
+ */
33912
+ unlockKey?: string;
32511
33913
  /**
32512
33914
  * Sets or gets the language. Used in conjunction with the property messages.
32513
33915
  * Default value: "en"