@smart-webcomponents-angular/window 16.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/esm2020/window/smart.element.mjs +16 -3
- package/esm2020/window/smart.window.mjs +15 -4
- package/fesm2015/smart-webcomponents-angular-window.mjs +28 -5
- package/fesm2015/smart-webcomponents-angular-window.mjs.map +1 -1
- package/fesm2020/smart-webcomponents-angular-window.mjs +28 -5
- package/fesm2020/smart-webcomponents-angular-window.mjs.map +1 -1
- package/index.d.ts +1730 -496
- package/package.json +21 -17
- package/source/modules/smart.window.js +2 -2
- package/source/smart.button.js +3 -3
- package/source/smart.combobox.js +3 -3
- package/source/smart.dropdownlist.js +3 -3
- package/source/smart.element.js +3 -3
- package/source/smart.listbox.js +3 -3
- package/source/smart.multilinetextbox.js +2 -2
- package/source/smart.progressbar.js +2 -2
- package/source/smart.scrollbar.js +2 -2
- package/source/smart.textbox.js +3 -3
- package/source/smart.window.js +3 -3
- package/styles/font/smart-icons.eot +0 -0
- package/styles/font/smart-icons.svg +25 -1
- package/styles/font/smart-icons.ttf +0 -0
- package/styles/font/smart-icons.woff +0 -0
- package/styles/font/smart-icons.woff2 +0 -0
- package/styles/smart.base.css +2 -2
- package/styles/smart.common.css +1 -1
- package/styles/smart.window.css +2 -2
- package/window/smart.element.d.ts +6 -2
- package/window/smart.window.d.ts +4 -1
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"
|
|
@@ -1278,6 +1283,11 @@ export interface AccordionProperties {
|
|
|
1278
1283
|
* Default value: singleFitHeight
|
|
1279
1284
|
*/
|
|
1280
1285
|
expandMode?: AccordionExpandMode | string;
|
|
1286
|
+
/**
|
|
1287
|
+
* Sets or gets the unlockKey which unlocks the product.
|
|
1288
|
+
* Default value: ""
|
|
1289
|
+
*/
|
|
1290
|
+
unlockKey?: string;
|
|
1281
1291
|
/**
|
|
1282
1292
|
* Sets or gets the language. Used in conjunction with the property messages.
|
|
1283
1293
|
* Default value: "en"
|
|
@@ -1559,6 +1569,11 @@ export interface ArrayProperties {
|
|
|
1559
1569
|
* Default value: 50
|
|
1560
1570
|
*/
|
|
1561
1571
|
indexerWidth?: number;
|
|
1572
|
+
/**
|
|
1573
|
+
* Sets or gets the unlockKey which unlocks the product.
|
|
1574
|
+
* Default value: ""
|
|
1575
|
+
*/
|
|
1576
|
+
unlockKey?: string;
|
|
1562
1577
|
/**
|
|
1563
1578
|
* Sets or gets the language. Used in conjunction with the property messages.
|
|
1564
1579
|
* Default value: "en"
|
|
@@ -2010,6 +2025,11 @@ export interface BreadcrumbProperties {
|
|
|
2010
2025
|
* Default value: null
|
|
2011
2026
|
*/
|
|
2012
2027
|
itemTemplate?: any;
|
|
2028
|
+
/**
|
|
2029
|
+
* Sets or gets the unlockKey which unlocks the product.
|
|
2030
|
+
* Default value: ""
|
|
2031
|
+
*/
|
|
2032
|
+
unlockKey?: string;
|
|
2013
2033
|
/**
|
|
2014
2034
|
* Sets or gets the language. Used in conjunction with the property messages.
|
|
2015
2035
|
* Default value: "en"
|
|
@@ -2133,6 +2153,11 @@ export interface ButtonProperties {
|
|
|
2133
2153
|
* Default value: """"
|
|
2134
2154
|
*/
|
|
2135
2155
|
innerHTML: string;
|
|
2156
|
+
/**
|
|
2157
|
+
* Sets or gets the unlockKey which unlocks the product.
|
|
2158
|
+
* Default value: ""
|
|
2159
|
+
*/
|
|
2160
|
+
unlockKey?: string;
|
|
2136
2161
|
/**
|
|
2137
2162
|
* Sets or gets the language. Used in conjunction with the property messages.
|
|
2138
2163
|
* Default value: "en"
|
|
@@ -2241,6 +2266,11 @@ export interface ButtonGroupProperties {
|
|
|
2241
2266
|
* Default value: false
|
|
2242
2267
|
*/
|
|
2243
2268
|
disabled?: boolean;
|
|
2269
|
+
/**
|
|
2270
|
+
* Sets or gets the unlockKey which unlocks the product.
|
|
2271
|
+
* Default value: ""
|
|
2272
|
+
*/
|
|
2273
|
+
unlockKey?: string;
|
|
2244
2274
|
/**
|
|
2245
2275
|
* Sets or gets the language. Used in conjunction with the property messages.
|
|
2246
2276
|
* Default value: "en"
|
|
@@ -2369,6 +2399,11 @@ export interface CalendarProperties {
|
|
|
2369
2399
|
* Default value: false
|
|
2370
2400
|
*/
|
|
2371
2401
|
disableAutoNavigation?: boolean;
|
|
2402
|
+
/**
|
|
2403
|
+
* Enables or disables the Calendar mouse wheel behavior.
|
|
2404
|
+
* Default value: false
|
|
2405
|
+
*/
|
|
2406
|
+
disableMouseWheel?: boolean;
|
|
2372
2407
|
/**
|
|
2373
2408
|
* Determines the date view of the calendar when calendarMode is set to 'default'
|
|
2374
2409
|
* Default value: month
|
|
@@ -2429,6 +2464,11 @@ export interface CalendarProperties {
|
|
|
2429
2464
|
* Default value: null
|
|
2430
2465
|
*/
|
|
2431
2466
|
importantDatesTemplate?: any;
|
|
2467
|
+
/**
|
|
2468
|
+
* Sets or gets the unlockKey which unlocks the product.
|
|
2469
|
+
* Default value: ""
|
|
2470
|
+
*/
|
|
2471
|
+
unlockKey?: string;
|
|
2432
2472
|
/**
|
|
2433
2473
|
* Determines the language of the Calendar.
|
|
2434
2474
|
* Default value: "en"
|
|
@@ -2726,6 +2766,11 @@ export interface CardProperties {
|
|
|
2726
2766
|
* Default value: null
|
|
2727
2767
|
*/
|
|
2728
2768
|
itemTemplate?: any;
|
|
2769
|
+
/**
|
|
2770
|
+
* Sets or gets the unlockKey which unlocks the product.
|
|
2771
|
+
* Default value: ""
|
|
2772
|
+
*/
|
|
2773
|
+
unlockKey?: string;
|
|
2729
2774
|
/**
|
|
2730
2775
|
* Sets or gets the language. Used in conjunction with the property messages.
|
|
2731
2776
|
* Default value: "en"
|
|
@@ -2869,6 +2914,11 @@ export interface CardViewProperties {
|
|
|
2869
2914
|
* Default value: none
|
|
2870
2915
|
*/
|
|
2871
2916
|
headerPosition?: CardViewHeaderPosition | string;
|
|
2917
|
+
/**
|
|
2918
|
+
* Sets or gets the unlockKey which unlocks the product.
|
|
2919
|
+
* Default value: ""
|
|
2920
|
+
*/
|
|
2921
|
+
unlockKey?: string;
|
|
2872
2922
|
/**
|
|
2873
2923
|
* Sets or gets the locale. Used in conjunction with the property messages.
|
|
2874
2924
|
* Default value: "en"
|
|
@@ -3315,6 +3365,11 @@ export interface CarouselProperties {
|
|
|
3315
3365
|
* Default value: false
|
|
3316
3366
|
*/
|
|
3317
3367
|
keyboard?: boolean;
|
|
3368
|
+
/**
|
|
3369
|
+
* Sets or gets the unlockKey which unlocks the product.
|
|
3370
|
+
* Default value: ""
|
|
3371
|
+
*/
|
|
3372
|
+
unlockKey?: string;
|
|
3318
3373
|
/**
|
|
3319
3374
|
* Sets or gets the language. Used in conjunction with the property messages.
|
|
3320
3375
|
* Default value: "en"
|
|
@@ -3557,6 +3612,11 @@ export interface ChartProperties {
|
|
|
3557
3612
|
* Default value: [object Object]
|
|
3558
3613
|
*/
|
|
3559
3614
|
legendLayout?: any;
|
|
3615
|
+
/**
|
|
3616
|
+
* Sets or gets the unlockKey which unlocks the product.
|
|
3617
|
+
* Default value: ""
|
|
3618
|
+
*/
|
|
3619
|
+
unlockKey?: string;
|
|
3560
3620
|
/**
|
|
3561
3621
|
* Sets or gets the locale. Used in conjunction with the property messages.
|
|
3562
3622
|
* Default value: "en"
|
|
@@ -5376,6 +5436,11 @@ export interface CheckBoxProperties {
|
|
|
5376
5436
|
* Default value: """"
|
|
5377
5437
|
*/
|
|
5378
5438
|
innerHTML: string;
|
|
5439
|
+
/**
|
|
5440
|
+
* Sets or gets the unlockKey which unlocks the product.
|
|
5441
|
+
* Default value: ""
|
|
5442
|
+
*/
|
|
5443
|
+
unlockKey?: string;
|
|
5379
5444
|
/**
|
|
5380
5445
|
* Sets or gets the language. Used in conjunction with the property messages.
|
|
5381
5446
|
* Default value: "en"
|
|
@@ -5520,6 +5585,11 @@ export interface CheckInputProperties {
|
|
|
5520
5585
|
* Default value: 8
|
|
5521
5586
|
*/
|
|
5522
5587
|
items?: number;
|
|
5588
|
+
/**
|
|
5589
|
+
* Sets or gets the unlockKey which unlocks the product.
|
|
5590
|
+
* Default value: ""
|
|
5591
|
+
*/
|
|
5592
|
+
unlockKey?: string;
|
|
5523
5593
|
/**
|
|
5524
5594
|
* Sets or gets the language. Used in conjunction with the property messages.
|
|
5525
5595
|
* Default value: "en"
|
|
@@ -5707,6 +5777,11 @@ export interface ChipProperties {
|
|
|
5707
5777
|
* Default value: null
|
|
5708
5778
|
*/
|
|
5709
5779
|
itemTemplate?: any;
|
|
5780
|
+
/**
|
|
5781
|
+
* Sets or gets the unlockKey which unlocks the product.
|
|
5782
|
+
* Default value: ""
|
|
5783
|
+
*/
|
|
5784
|
+
unlockKey?: string;
|
|
5710
5785
|
/**
|
|
5711
5786
|
* Sets or gets the language. Used in conjunction with the property messages.
|
|
5712
5787
|
* Default value: "en"
|
|
@@ -5803,6 +5878,11 @@ export interface CircularProgressBarProperties {
|
|
|
5803
5878
|
* Default value: false
|
|
5804
5879
|
*/
|
|
5805
5880
|
inverted?: boolean;
|
|
5881
|
+
/**
|
|
5882
|
+
* Sets or gets the unlockKey which unlocks the product.
|
|
5883
|
+
* Default value: ""
|
|
5884
|
+
*/
|
|
5885
|
+
unlockKey?: string;
|
|
5806
5886
|
/**
|
|
5807
5887
|
* Sets or gets the language. Used in conjunction with the property messages.
|
|
5808
5888
|
* Default value: "en"
|
|
@@ -5939,6 +6019,11 @@ export interface ColorInputProperties {
|
|
|
5939
6019
|
* Default value: 8
|
|
5940
6020
|
*/
|
|
5941
6021
|
items?: number;
|
|
6022
|
+
/**
|
|
6023
|
+
* Sets or gets the unlockKey which unlocks the product.
|
|
6024
|
+
* Default value: ""
|
|
6025
|
+
*/
|
|
6026
|
+
unlockKey?: string;
|
|
5942
6027
|
/**
|
|
5943
6028
|
* Sets or gets the language. Used in conjunction with the property messages.
|
|
5944
6029
|
* Default value: "en"
|
|
@@ -6166,6 +6251,11 @@ export interface ColorPanelProperties {
|
|
|
6166
6251
|
* Default value: false
|
|
6167
6252
|
*/
|
|
6168
6253
|
inverted?: boolean;
|
|
6254
|
+
/**
|
|
6255
|
+
* Sets or gets the unlockKey which unlocks the product.
|
|
6256
|
+
* Default value: ""
|
|
6257
|
+
*/
|
|
6258
|
+
unlockKey?: string;
|
|
6169
6259
|
/**
|
|
6170
6260
|
* Sets or gets the language. Used in conjunction with the property messages.
|
|
6171
6261
|
* Default value: "en"
|
|
@@ -6455,232 +6545,242 @@ export interface ColorPickerProperties {
|
|
|
6455
6545
|
*/
|
|
6456
6546
|
label?: string;
|
|
6457
6547
|
/**
|
|
6458
|
-
* Sets or gets the
|
|
6459
|
-
* Default value: "en"
|
|
6460
|
-
*/
|
|
6461
|
-
locale?: string;
|
|
6462
|
-
/**
|
|
6463
|
-
* Callback used to customize the format of the messages that are returned from the Localization Module.
|
|
6464
|
-
* Default value: null
|
|
6465
|
-
*/
|
|
6466
|
-
localizeFormatFunction?: any;
|
|
6467
|
-
/**
|
|
6468
|
-
* Sets or gets an object specifying strings used in the widget that can be localized. Used in conjunction with the property locale.
|
|
6469
|
-
* Default value: * {
|
|
6470
|
-
* "en": {
|
|
6471
|
-
* "propertyUnknownType": "'' property is with undefined 'type' member!",
|
|
6472
|
-
* "propertyInvalidValue": "Invalid ''!",
|
|
6473
|
-
* "propertyInvalidValueType": "Invalid ''!",
|
|
6474
|
-
* "methodInvalidValueType": "Invalid ''!",
|
|
6475
|
-
* "methodInvalidArgumentsCount": "Invalid '' argument(s)!",
|
|
6476
|
-
* "methodInvalidReturnType": "Invalid ''!",
|
|
6477
|
-
* "elementNotInDOM": "Element does not exist in DOM! Please, add the element to the DOM, before invoking a method.",
|
|
6478
|
-
* "moduleUndefined": "Module is undefined.",
|
|
6479
|
-
* "missingReference": "'.",
|
|
6480
|
-
* "htmlTemplateNotSuported": ": Web Browser doesn't support HTMLTemplate elements.",
|
|
6481
|
-
* "invalidTemplate": "' property accepts a string that must match the id of an HTMLTemplate element from the DOM.",
|
|
6482
|
-
* "invalidNode": ".",
|
|
6483
|
-
* "redPrefix": "R:",
|
|
6484
|
-
* "greenPrefix": "G:",
|
|
6485
|
-
* "bluePrefix": "B:",
|
|
6486
|
-
* "hexPrefix": "#:",
|
|
6487
|
-
* "alphaPrefix": "Alpha:",
|
|
6488
|
-
* "ok": "OK",
|
|
6489
|
-
* "cancel": "CANCEL",
|
|
6490
|
-
* "customColor": "CUSTOM COLOR ..."
|
|
6491
|
-
* }
|
|
6492
|
-
* }
|
|
6493
|
-
*/
|
|
6494
|
-
messages?: any;
|
|
6495
|
-
/**
|
|
6496
|
-
* Sets or gets the name attribute for the element. Name is used when submiting HTML forms.
|
|
6497
|
-
* Default value: ""
|
|
6498
|
-
*/
|
|
6499
|
-
name?: string;
|
|
6500
|
-
/**
|
|
6501
|
-
* Determines whether the popup is opened or closed
|
|
6502
|
-
* Default value: false
|
|
6503
|
-
*/
|
|
6504
|
-
opened?: boolean;
|
|
6505
|
-
/**
|
|
6506
|
-
* Determines what colors will be displayed in 'spectrumGrid', 'grid' and 'hexagonal' displayModes.
|
|
6507
|
-
* Default value: default
|
|
6508
|
-
*/
|
|
6509
|
-
palette?: ColorPalette | string;
|
|
6510
|
-
/**
|
|
6511
|
-
* Defines an array of colors that form a custom palette. This palette can be used in displayModes 'grid' and 'spectrum grid' if the palette property is set to custom. The value of the property can be an array of strings or objects that contain valid colors ( HEX, RGBA, etc).
|
|
6512
|
-
* Default value: null
|
|
6513
|
-
*/
|
|
6514
|
-
paletteColors?: {name: string, value: string}[] | string[] | null;
|
|
6515
|
-
/**
|
|
6516
|
-
* Defines an array of colors that represent a predefined list of custom colors. This palette can be used in displayModes 'grid', 'default' and 'spectrum grid'. Custom colors are displayed at the bottom of the color grid below the button for custom color selection. They are only visible if enableCustomColor property is true.
|
|
6517
|
-
* Default value: null
|
|
6518
|
-
*/
|
|
6519
|
-
paletteCustomColors?: string[] | null;
|
|
6520
|
-
/**
|
|
6521
|
-
* The placeholder is shown when the value is not set yet or is set to null.
|
|
6522
|
-
* Default value: ""
|
|
6523
|
-
*/
|
|
6524
|
-
placeholder?: string;
|
|
6525
|
-
/**
|
|
6526
|
-
* Disables user interaction with the element.
|
|
6527
|
-
* Default value: false
|
|
6528
|
-
*/
|
|
6529
|
-
readonly?: boolean;
|
|
6530
|
-
/**
|
|
6531
|
-
* Determines whether the resize indicator in the bottom right corner of the drop down is visible or not. This property is used in conjunction with resizeMode.
|
|
6532
|
-
* Default value: false
|
|
6533
|
-
*/
|
|
6534
|
-
resizeIndicator?: boolean;
|
|
6535
|
-
/**
|
|
6536
|
-
* Determines whether the dropDown can be resized or not. When resizing is enabled, a resize bar appears on the top/bottom side of the drop down.
|
|
6537
|
-
* Default value: null
|
|
6538
|
-
*/
|
|
6539
|
-
resizeMode?: ResizeMode | string;
|
|
6540
|
-
/**
|
|
6541
|
-
* Sets or gets the value indicating whether the element is aligned to support locales using right-to-left fonts.
|
|
6542
|
-
* Default value: false
|
|
6543
|
-
*/
|
|
6544
|
-
rightToLeft?: boolean;
|
|
6545
|
-
/**
|
|
6546
|
-
* Determines the theme. Theme defines the look of the element
|
|
6548
|
+
* Sets or gets the unlockKey which unlocks the product.
|
|
6547
6549
|
* Default value: ""
|
|
6548
6550
|
*/
|
|
6549
|
-
|
|
6550
|
-
/**
|
|
6551
|
-
* Determines how the tooltip displays the value of the color that is being hovered.
|
|
6552
|
-
* Default value: hex
|
|
6553
|
-
*/
|
|
6554
|
-
tooltipDisplayMode?: ColorTooltipDisplayMode | string;
|
|
6555
|
-
/**
|
|
6556
|
-
* If is set to true, the element cannot be focused.
|
|
6557
|
-
* Default value: false
|
|
6558
|
-
*/
|
|
6559
|
-
unfocusable?: boolean;
|
|
6560
|
-
/**
|
|
6561
|
-
* Represents the value of the selected color as the value of the element.
|
|
6562
|
-
* Default value: "null"
|
|
6563
|
-
*/
|
|
6564
|
-
value?: string;
|
|
6565
|
-
/**
|
|
6566
|
-
* Determines the format of the color. Whether it's in HEX, RGB or RGBA. By default it shows the color depending on the displayMode.
|
|
6567
|
-
* Default value: default
|
|
6568
|
-
*/
|
|
6569
|
-
valueFormat?: ColorValueFormat | string;
|
|
6570
|
-
/**
|
|
6571
|
-
* Determines which elements will be displayed in color picker's action section.
|
|
6572
|
-
* Default value: default
|
|
6573
|
-
*/
|
|
6574
|
-
valueDisplayMode?: ColorValueDisplayMode | string;
|
|
6575
|
-
}
|
|
6576
|
-
/**
|
|
6577
|
-
ColorPicker is an advanced color picking component with Pallete, Spectrum Grid, Radial Palette and Excel-like options. Users can input colors either by a dropdown or input field.
|
|
6578
|
-
*/
|
|
6579
|
-
export interface ColorPicker extends BaseElement, ColorPickerProperties {
|
|
6580
|
-
|
|
6581
|
-
/* Get a member by its name */
|
|
6582
|
-
[name: string]: any;
|
|
6583
|
-
/**
|
|
6584
|
-
* This event is triggered when user clicks on the action button. 'Ok' button is visible only when <strong>applyValueMode</strong> is set to <strong>useButtons</strong>.
|
|
6585
|
-
* @param event. The custom event. */
|
|
6586
|
-
onActionButtonClick?: ((this: any, ev: Event) => any) | ((this: any, ev: CustomEvent<any>) => any) | null;
|
|
6587
|
-
/**
|
|
6588
|
-
* This event is triggered when the cancel button is clicked. 'Cancel' button is visible only when <strong>applyValueMode</strong> is set to <strong>useButtons</strong>.
|
|
6589
|
-
* @param event. The custom event. */
|
|
6590
|
-
onCancelButtonClick?: ((this: any, ev: Event) => any) | ((this: any, ev: CustomEvent<any>) => any) | null;
|
|
6591
|
-
/**
|
|
6592
|
-
* This event is triggered when the color value is changed.
|
|
6593
|
-
* @param event. The custom event. Custom data event was created with: ev.detail(oldValue, value)
|
|
6594
|
-
* oldValue - The previously selected color.
|
|
6595
|
-
* value - The new selected color.
|
|
6596
|
-
*/
|
|
6597
|
-
onChange: ((this: any, ev: Event) => any) | null;
|
|
6551
|
+
unlockKey?: string;
|
|
6598
6552
|
/**
|
|
6599
|
-
*
|
|
6600
|
-
|
|
6601
|
-
|
|
6602
|
-
|
|
6603
|
-
|
|
6604
|
-
|
|
6605
|
-
|
|
6606
|
-
|
|
6607
|
-
|
|
6608
|
-
|
|
6609
|
-
*
|
|
6610
|
-
|
|
6611
|
-
|
|
6612
|
-
|
|
6613
|
-
*
|
|
6614
|
-
|
|
6615
|
-
|
|
6616
|
-
|
|
6617
|
-
*
|
|
6618
|
-
|
|
6619
|
-
|
|
6620
|
-
|
|
6621
|
-
*
|
|
6622
|
-
|
|
6623
|
-
|
|
6624
|
-
|
|
6625
|
-
*
|
|
6626
|
-
|
|
6627
|
-
|
|
6628
|
-
|
|
6629
|
-
*
|
|
6630
|
-
|
|
6631
|
-
*
|
|
6632
|
-
|
|
6633
|
-
|
|
6634
|
-
|
|
6635
|
-
|
|
6636
|
-
|
|
6637
|
-
*
|
|
6638
|
-
|
|
6639
|
-
|
|
6640
|
-
|
|
6641
|
-
|
|
6642
|
-
|
|
6643
|
-
|
|
6644
|
-
|
|
6645
|
-
|
|
6646
|
-
|
|
6647
|
-
|
|
6648
|
-
|
|
6649
|
-
|
|
6650
|
-
|
|
6651
|
-
|
|
6652
|
-
|
|
6653
|
-
|
|
6654
|
-
|
|
6655
|
-
|
|
6656
|
-
|
|
6657
|
-
|
|
6658
|
-
|
|
6659
|
-
|
|
6660
|
-
|
|
6661
|
-
|
|
6662
|
-
|
|
6663
|
-
|
|
6664
|
-
|
|
6665
|
-
|
|
6666
|
-
|
|
6667
|
-
|
|
6668
|
-
*
|
|
6669
|
-
|
|
6670
|
-
|
|
6671
|
-
|
|
6672
|
-
|
|
6673
|
-
*
|
|
6674
|
-
|
|
6675
|
-
|
|
6676
|
-
|
|
6677
|
-
|
|
6678
|
-
*
|
|
6679
|
-
|
|
6680
|
-
|
|
6681
|
-
|
|
6682
|
-
|
|
6683
|
-
*
|
|
6553
|
+
* Sets or gets the language. Used in conjunction with the property messages.
|
|
6554
|
+
* Default value: "en"
|
|
6555
|
+
*/
|
|
6556
|
+
locale?: string;
|
|
6557
|
+
/**
|
|
6558
|
+
* Callback used to customize the format of the messages that are returned from the Localization Module.
|
|
6559
|
+
* Default value: null
|
|
6560
|
+
*/
|
|
6561
|
+
localizeFormatFunction?: any;
|
|
6562
|
+
/**
|
|
6563
|
+
* Sets or gets an object specifying strings used in the widget that can be localized. Used in conjunction with the property locale.
|
|
6564
|
+
* Default value: * {
|
|
6565
|
+
* "en": {
|
|
6566
|
+
* "propertyUnknownType": "'' property is with undefined 'type' member!",
|
|
6567
|
+
* "propertyInvalidValue": "Invalid ''!",
|
|
6568
|
+
* "propertyInvalidValueType": "Invalid ''!",
|
|
6569
|
+
* "methodInvalidValueType": "Invalid ''!",
|
|
6570
|
+
* "methodInvalidArgumentsCount": "Invalid '' argument(s)!",
|
|
6571
|
+
* "methodInvalidReturnType": "Invalid ''!",
|
|
6572
|
+
* "elementNotInDOM": "Element does not exist in DOM! Please, add the element to the DOM, before invoking a method.",
|
|
6573
|
+
* "moduleUndefined": "Module is undefined.",
|
|
6574
|
+
* "missingReference": "'.",
|
|
6575
|
+
* "htmlTemplateNotSuported": ": Web Browser doesn't support HTMLTemplate elements.",
|
|
6576
|
+
* "invalidTemplate": "' property accepts a string that must match the id of an HTMLTemplate element from the DOM.",
|
|
6577
|
+
* "invalidNode": ".",
|
|
6578
|
+
* "redPrefix": "R:",
|
|
6579
|
+
* "greenPrefix": "G:",
|
|
6580
|
+
* "bluePrefix": "B:",
|
|
6581
|
+
* "hexPrefix": "#:",
|
|
6582
|
+
* "alphaPrefix": "Alpha:",
|
|
6583
|
+
* "ok": "OK",
|
|
6584
|
+
* "cancel": "CANCEL",
|
|
6585
|
+
* "customColor": "CUSTOM COLOR ..."
|
|
6586
|
+
* }
|
|
6587
|
+
* }
|
|
6588
|
+
*/
|
|
6589
|
+
messages?: any;
|
|
6590
|
+
/**
|
|
6591
|
+
* Sets or gets the name attribute for the element. Name is used when submiting HTML forms.
|
|
6592
|
+
* Default value: ""
|
|
6593
|
+
*/
|
|
6594
|
+
name?: string;
|
|
6595
|
+
/**
|
|
6596
|
+
* Determines whether the popup is opened or closed
|
|
6597
|
+
* Default value: false
|
|
6598
|
+
*/
|
|
6599
|
+
opened?: boolean;
|
|
6600
|
+
/**
|
|
6601
|
+
* Determines what colors will be displayed in 'spectrumGrid', 'grid' and 'hexagonal' displayModes.
|
|
6602
|
+
* Default value: default
|
|
6603
|
+
*/
|
|
6604
|
+
palette?: ColorPalette | string;
|
|
6605
|
+
/**
|
|
6606
|
+
* Defines an array of colors that form a custom palette. This palette can be used in displayModes 'grid' and 'spectrum grid' if the palette property is set to custom. The value of the property can be an array of strings or objects that contain valid colors ( HEX, RGBA, etc).
|
|
6607
|
+
* Default value: null
|
|
6608
|
+
*/
|
|
6609
|
+
paletteColors?: {name: string, value: string}[] | string[] | null;
|
|
6610
|
+
/**
|
|
6611
|
+
* Defines an array of colors that represent a predefined list of custom colors. This palette can be used in displayModes 'grid', 'default' and 'spectrum grid'. Custom colors are displayed at the bottom of the color grid below the button for custom color selection. They are only visible if enableCustomColor property is true.
|
|
6612
|
+
* Default value: null
|
|
6613
|
+
*/
|
|
6614
|
+
paletteCustomColors?: string[] | null;
|
|
6615
|
+
/**
|
|
6616
|
+
* The placeholder is shown when the value is not set yet or is set to null.
|
|
6617
|
+
* Default value: ""
|
|
6618
|
+
*/
|
|
6619
|
+
placeholder?: string;
|
|
6620
|
+
/**
|
|
6621
|
+
* Disables user interaction with the element.
|
|
6622
|
+
* Default value: false
|
|
6623
|
+
*/
|
|
6624
|
+
readonly?: boolean;
|
|
6625
|
+
/**
|
|
6626
|
+
* Determines whether the resize indicator in the bottom right corner of the drop down is visible or not. This property is used in conjunction with resizeMode.
|
|
6627
|
+
* Default value: false
|
|
6628
|
+
*/
|
|
6629
|
+
resizeIndicator?: boolean;
|
|
6630
|
+
/**
|
|
6631
|
+
* Determines whether the dropDown can be resized or not. When resizing is enabled, a resize bar appears on the top/bottom side of the drop down.
|
|
6632
|
+
* Default value: null
|
|
6633
|
+
*/
|
|
6634
|
+
resizeMode?: ResizeMode | string;
|
|
6635
|
+
/**
|
|
6636
|
+
* Sets or gets the value indicating whether the element is aligned to support locales using right-to-left fonts.
|
|
6637
|
+
* Default value: false
|
|
6638
|
+
*/
|
|
6639
|
+
rightToLeft?: boolean;
|
|
6640
|
+
/**
|
|
6641
|
+
* Determines the theme. Theme defines the look of the element
|
|
6642
|
+
* Default value: ""
|
|
6643
|
+
*/
|
|
6644
|
+
theme?: string;
|
|
6645
|
+
/**
|
|
6646
|
+
* Determines how the tooltip displays the value of the color that is being hovered.
|
|
6647
|
+
* Default value: hex
|
|
6648
|
+
*/
|
|
6649
|
+
tooltipDisplayMode?: ColorTooltipDisplayMode | string;
|
|
6650
|
+
/**
|
|
6651
|
+
* If is set to true, the element cannot be focused.
|
|
6652
|
+
* Default value: false
|
|
6653
|
+
*/
|
|
6654
|
+
unfocusable?: boolean;
|
|
6655
|
+
/**
|
|
6656
|
+
* Represents the value of the selected color as the value of the element.
|
|
6657
|
+
* Default value: "null"
|
|
6658
|
+
*/
|
|
6659
|
+
value?: string;
|
|
6660
|
+
/**
|
|
6661
|
+
* Determines the format of the color. Whether it's in HEX, RGB or RGBA. By default it shows the color depending on the displayMode.
|
|
6662
|
+
* Default value: default
|
|
6663
|
+
*/
|
|
6664
|
+
valueFormat?: ColorValueFormat | string;
|
|
6665
|
+
/**
|
|
6666
|
+
* Determines which elements will be displayed in color picker's action section.
|
|
6667
|
+
* Default value: default
|
|
6668
|
+
*/
|
|
6669
|
+
valueDisplayMode?: ColorValueDisplayMode | string;
|
|
6670
|
+
}
|
|
6671
|
+
/**
|
|
6672
|
+
ColorPicker is an advanced color picking component with Pallete, Spectrum Grid, Radial Palette and Excel-like options. Users can input colors either by a dropdown or input field.
|
|
6673
|
+
*/
|
|
6674
|
+
export interface ColorPicker extends BaseElement, ColorPickerProperties {
|
|
6675
|
+
|
|
6676
|
+
/* Get a member by its name */
|
|
6677
|
+
[name: string]: any;
|
|
6678
|
+
/**
|
|
6679
|
+
* This event is triggered when user clicks on the action button. 'Ok' button is visible only when <strong>applyValueMode</strong> is set to <strong>useButtons</strong>.
|
|
6680
|
+
* @param event. The custom event. */
|
|
6681
|
+
onActionButtonClick?: ((this: any, ev: Event) => any) | ((this: any, ev: CustomEvent<any>) => any) | null;
|
|
6682
|
+
/**
|
|
6683
|
+
* This event is triggered when the cancel button is clicked. 'Cancel' button is visible only when <strong>applyValueMode</strong> is set to <strong>useButtons</strong>.
|
|
6684
|
+
* @param event. The custom event. */
|
|
6685
|
+
onCancelButtonClick?: ((this: any, ev: Event) => any) | ((this: any, ev: CustomEvent<any>) => any) | null;
|
|
6686
|
+
/**
|
|
6687
|
+
* This event is triggered when the color value is changed.
|
|
6688
|
+
* @param event. The custom event. Custom data event was created with: ev.detail(oldValue, value)
|
|
6689
|
+
* oldValue - The previously selected color.
|
|
6690
|
+
* value - The new selected color.
|
|
6691
|
+
*/
|
|
6692
|
+
onChange: ((this: any, ev: Event) => any) | null;
|
|
6693
|
+
/**
|
|
6694
|
+
* This event is triggered when the drop down is closed.
|
|
6695
|
+
* @param event. The custom event. */
|
|
6696
|
+
onClose: ((this: any, ev: Event) => any) | null;
|
|
6697
|
+
/**
|
|
6698
|
+
* This event is triggered when the drop down is about to be closed. This event allows to cancel the closing operation calling event.preventDefault() in the event handler function.
|
|
6699
|
+
* @param event. The custom event. */
|
|
6700
|
+
onClosing?: ((this: any, ev: Event) => any) | ((this: any, ev: CustomEvent<any>) => any) | null;
|
|
6701
|
+
/**
|
|
6702
|
+
* This event is triggered when the custom color selection view is opened/closed. Custom color selection view is available when <strong>enableCustomColors</strong> property is true.
|
|
6703
|
+
* @param event. The custom event. Custom data event was created with: ev.detail(value)
|
|
6704
|
+
* value - A boolean that indicates whether the custom color view is shown or not.
|
|
6705
|
+
*/
|
|
6706
|
+
onCustomColorSelection?: ((this: any, ev: Event) => any) | ((this: any, ev: CustomEvent<any>) => any) | null;
|
|
6707
|
+
/**
|
|
6708
|
+
* This event is triggered when user clicks on the drop down button.
|
|
6709
|
+
* @param event. The custom event. */
|
|
6710
|
+
onDropDownButtonClick?: ((this: any, ev: Event) => any) | ((this: any, ev: CustomEvent<any>) => any) | null;
|
|
6711
|
+
/**
|
|
6712
|
+
* This event is triggered when the ok button is clicked.
|
|
6713
|
+
* @param event. The custom event. */
|
|
6714
|
+
onOkButtonClick?: ((this: any, ev: Event) => any) | ((this: any, ev: CustomEvent<any>) => any) | null;
|
|
6715
|
+
/**
|
|
6716
|
+
* This event is triggered when the drop down is opened.
|
|
6717
|
+
* @param event. The custom event. */
|
|
6718
|
+
onOpen?: ((this: any, ev: Event) => any) | ((this: any, ev: CustomEvent<any>) => any) | null;
|
|
6719
|
+
/**
|
|
6720
|
+
* This event is triggered when the drop down is about to be opened. This event allows to cancel the opening operation calling event.preventDefault() in the event handler function.
|
|
6721
|
+
* @param event. The custom event. */
|
|
6722
|
+
onOpening?: ((this: any, ev: Event) => any) | ((this: any, ev: CustomEvent<any>) => any) | null;
|
|
6723
|
+
/**
|
|
6724
|
+
* This event is triggered when user starts resizing the drop down.
|
|
6725
|
+
* @param event. The custom event. Custom data event was created with: ev.detail(position)
|
|
6726
|
+
* position - An object containing the current left and top positions of the drop down.
|
|
6727
|
+
*/
|
|
6728
|
+
onResizeStart?: ((this: any, ev: Event) => any) | ((this: any, ev: CustomEvent<any>) => any) | null;
|
|
6729
|
+
/**
|
|
6730
|
+
* This event is triggered when the resizing of the drop down is finished.
|
|
6731
|
+
* @param event. The custom event. Custom data event was created with: ev.detail(position)
|
|
6732
|
+
* position - An object containing the current left and top positions of the drop down.
|
|
6733
|
+
*/
|
|
6734
|
+
onResizeEnd?: ((this: any, ev: Event) => any) | ((this: any, ev: CustomEvent<any>) => any) | null;
|
|
6735
|
+
/**
|
|
6736
|
+
* Opens the drop down of the color picker.
|
|
6737
|
+
*/
|
|
6738
|
+
open(): void;
|
|
6739
|
+
/**
|
|
6740
|
+
* Closes the drop down of the color picker.
|
|
6741
|
+
*/
|
|
6742
|
+
close(): void;
|
|
6743
|
+
}
|
|
6744
|
+
|
|
6745
|
+
declare global {
|
|
6746
|
+
interface Document {
|
|
6747
|
+
createElement(tagName: "smart-color-picker"): ColorPicker;
|
|
6748
|
+
querySelector(selectors: "smart-color-picker"): ColorPicker | null;
|
|
6749
|
+
querySelectorAll(selectors: "smart-color-picker"): NodeListOf<ColorPicker>;
|
|
6750
|
+
getElementsByTagName(qualifiedName: "smart-color-picker"): HTMLCollectionOf<ColorPicker>;
|
|
6751
|
+
getElementsByName(elementName: "smart-color-picker"): NodeListOf<ColorPicker>;
|
|
6752
|
+
}
|
|
6753
|
+
}
|
|
6754
|
+
|
|
6755
|
+
/**Determines how the drop down is going to open. */
|
|
6756
|
+
export declare type DropDownOpenMode = 'none' | 'default' | 'dropDownButton' | 'auto';
|
|
6757
|
+
/**Determines the vertical position of the dropDown. 'Auto' means its automatically determined depending on the viewport size. */
|
|
6758
|
+
export declare type DropDownPosition = 'auto' | 'top' | 'bottom' | 'overlay-top' | 'overlay-center' | 'overlay-bottom' | 'center-bottom' | 'center-top';
|
|
6759
|
+
/**Determines whether the dropDown can be resized or not. When resizing is enabled, a resize bar appears on the top/bottom side of the drop down. */
|
|
6760
|
+
export declare type ResizeMode = 'none' | 'horizontal' | 'vertical' | 'both';
|
|
6761
|
+
export interface ColumnPanelProperties {
|
|
6762
|
+
/**
|
|
6763
|
+
* Sets or gets the animation mode. Animation is disabled when the property is set to 'none'
|
|
6764
|
+
* Default value: advanced
|
|
6765
|
+
*/
|
|
6766
|
+
animation?: Animation | string;
|
|
6767
|
+
/**
|
|
6768
|
+
* Determines the data source that will be loaded to the column panel.
|
|
6769
|
+
* Default value: null
|
|
6770
|
+
*/
|
|
6771
|
+
dataSource?: ColumnPanelDataSource[];
|
|
6772
|
+
/**
|
|
6773
|
+
* Enables or disables the column panel.
|
|
6774
|
+
* Default value: false
|
|
6775
|
+
*/
|
|
6776
|
+
disabled?: boolean;
|
|
6777
|
+
/**
|
|
6778
|
+
* Sets or gets the unlockKey which unlocks the product.
|
|
6779
|
+
* Default value: ""
|
|
6780
|
+
*/
|
|
6781
|
+
unlockKey?: string;
|
|
6782
|
+
/**
|
|
6783
|
+
* Sets or gets the language. Used in conjunction with the property messages.
|
|
6684
6784
|
* Default value: "en"
|
|
6685
6785
|
*/
|
|
6686
6786
|
locale?: string;
|
|
@@ -6982,6 +7082,11 @@ export interface ComboBoxProperties {
|
|
|
6982
7082
|
* Default value: center
|
|
6983
7083
|
*/
|
|
6984
7084
|
loadingIndicatorPosition?: VerticalAlignment | string;
|
|
7085
|
+
/**
|
|
7086
|
+
* Sets or gets the unlockKey which unlocks the product.
|
|
7087
|
+
* Default value: ""
|
|
7088
|
+
*/
|
|
7089
|
+
unlockKey?: string;
|
|
6985
7090
|
/**
|
|
6986
7091
|
* Sets or gets the language. Used in conjunction with the property messages.
|
|
6987
7092
|
* Default value: "en"
|
|
@@ -7195,6 +7300,11 @@ export interface ComboBox extends BaseElement, ComboBoxProperties {
|
|
|
7195
7300
|
* @returns {Node}
|
|
7196
7301
|
*/
|
|
7197
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;
|
|
7198
7308
|
/**
|
|
7199
7309
|
* Removes all items from the drop down list.
|
|
7200
7310
|
*/
|
|
@@ -7207,6 +7317,10 @@ export interface ComboBox extends BaseElement, ComboBoxProperties {
|
|
|
7207
7317
|
* Closes the dropDown list.
|
|
7208
7318
|
*/
|
|
7209
7319
|
close(): void;
|
|
7320
|
+
/**
|
|
7321
|
+
* Performs a data bind. This can be used to refresh the data source.
|
|
7322
|
+
*/
|
|
7323
|
+
dataBind(): void;
|
|
7210
7324
|
/**
|
|
7211
7325
|
* Ensures the desired item is visible by scrolling to it.
|
|
7212
7326
|
* @param {HTMLElement | string} item. A list item or value of the desired item to be visible.
|
|
@@ -7221,7 +7335,7 @@ export interface ComboBox extends BaseElement, ComboBoxProperties {
|
|
|
7221
7335
|
/**
|
|
7222
7336
|
* Inserts a new item at a specified position.
|
|
7223
7337
|
* @param {number} position. The position where the item must be inserted.
|
|
7224
|
-
* @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.
|
|
7225
7339
|
*/
|
|
7226
7340
|
insert(position: number, item: any): void;
|
|
7227
7341
|
/**
|
|
@@ -7459,6 +7573,11 @@ export interface CustomizationDialogProperties {
|
|
|
7459
7573
|
* Default value: apply,close
|
|
7460
7574
|
*/
|
|
7461
7575
|
headerButtons?: string[];
|
|
7576
|
+
/**
|
|
7577
|
+
* Sets or gets the unlockKey which unlocks the product.
|
|
7578
|
+
* Default value: ""
|
|
7579
|
+
*/
|
|
7580
|
+
unlockKey?: string;
|
|
7462
7581
|
/**
|
|
7463
7582
|
* Sets or gets the language. Used in conjunction with the property messages.
|
|
7464
7583
|
* Default value: "en"
|
|
@@ -7955,6 +8074,11 @@ export interface DateInputProperties {
|
|
|
7955
8074
|
* Default value: 500
|
|
7956
8075
|
*/
|
|
7957
8076
|
autoCloseDelay?: number;
|
|
8077
|
+
/**
|
|
8078
|
+
* Determines the calendar properties to be set to the popup calendar.
|
|
8079
|
+
* Default value: null
|
|
8080
|
+
*/
|
|
8081
|
+
calendarProperties?: any;
|
|
7958
8082
|
/**
|
|
7959
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' }
|
|
7960
8084
|
* Default value: { day: 'numeric', month: 'numeric', year: 'numeric' }
|
|
@@ -7990,6 +8114,11 @@ export interface DateInputProperties {
|
|
|
7990
8114
|
* Default value: "off"
|
|
7991
8115
|
*/
|
|
7992
8116
|
inputPurpose?: string;
|
|
8117
|
+
/**
|
|
8118
|
+
* Sets or gets the unlockKey which unlocks the product.
|
|
8119
|
+
* Default value: ""
|
|
8120
|
+
*/
|
|
8121
|
+
unlockKey?: string;
|
|
7993
8122
|
/**
|
|
7994
8123
|
* Sets or gets the language. Used in conjunction with the property messages.
|
|
7995
8124
|
* Default value: "en"
|
|
@@ -8164,6 +8293,11 @@ export interface DateRangeInputProperties {
|
|
|
8164
8293
|
* Default value: "off"
|
|
8165
8294
|
*/
|
|
8166
8295
|
inputPurpose?: string;
|
|
8296
|
+
/**
|
|
8297
|
+
* Sets or gets the unlockKey which unlocks the product.
|
|
8298
|
+
* Default value: ""
|
|
8299
|
+
*/
|
|
8300
|
+
unlockKey?: string;
|
|
8167
8301
|
/**
|
|
8168
8302
|
* Sets or gets the language. Used in conjunction with the property messages.
|
|
8169
8303
|
* Default value: "en"
|
|
@@ -8508,6 +8642,11 @@ export interface DateTimePickerProperties {
|
|
|
8508
8642
|
* Default value: ""
|
|
8509
8643
|
*/
|
|
8510
8644
|
label?: string;
|
|
8645
|
+
/**
|
|
8646
|
+
* Sets or gets the unlockKey which unlocks the product.
|
|
8647
|
+
* Default value: ""
|
|
8648
|
+
*/
|
|
8649
|
+
unlockKey?: string;
|
|
8511
8650
|
/**
|
|
8512
8651
|
* Sets or gets the locale that determines what language is used to localize the labels inside the DateTimePicker.
|
|
8513
8652
|
* Default value: "en"
|
|
@@ -8788,7 +8927,7 @@ export interface DockingLayoutProperties {
|
|
|
8788
8927
|
*/
|
|
8789
8928
|
closedItems?: any;
|
|
8790
8929
|
/**
|
|
8791
|
-
* 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.
|
|
8792
8931
|
* Default value:
|
|
8793
8932
|
*/
|
|
8794
8933
|
layout?: any;
|
|
@@ -8797,6 +8936,11 @@ export interface DockingLayoutProperties {
|
|
|
8797
8936
|
* Default value: false
|
|
8798
8937
|
*/
|
|
8799
8938
|
liveResize?: boolean;
|
|
8939
|
+
/**
|
|
8940
|
+
* Sets or gets the unlockKey which unlocks the product.
|
|
8941
|
+
* Default value: ""
|
|
8942
|
+
*/
|
|
8943
|
+
unlockKey?: string;
|
|
8800
8944
|
/**
|
|
8801
8945
|
* Sets or gets the language. Used in conjunction with the property messages.
|
|
8802
8946
|
* Default value: "en"
|
|
@@ -9184,6 +9328,11 @@ export interface DropDownButtonProperties {
|
|
|
9184
9328
|
* Default value: ""
|
|
9185
9329
|
*/
|
|
9186
9330
|
label?: string;
|
|
9331
|
+
/**
|
|
9332
|
+
* Sets or gets the unlockKey which unlocks the product.
|
|
9333
|
+
* Default value: ""
|
|
9334
|
+
*/
|
|
9335
|
+
unlockKey?: string;
|
|
9187
9336
|
/**
|
|
9188
9337
|
* Sets or gets the language. Used in conjunction with the property messages.
|
|
9189
9338
|
* Default value: "en"
|
|
@@ -9347,11 +9496,6 @@ declare global {
|
|
|
9347
9496
|
}
|
|
9348
9497
|
|
|
9349
9498
|
export interface DropDownListProperties {
|
|
9350
|
-
/**
|
|
9351
|
-
* Sets or gets the animation mode. Animation is disabled when the property is set to 'none'
|
|
9352
|
-
* Default value: advanced
|
|
9353
|
-
*/
|
|
9354
|
-
animation?: Animation | string;
|
|
9355
9499
|
/**
|
|
9356
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.
|
|
9357
9501
|
* Default value: 100
|
|
@@ -9527,6 +9671,11 @@ export interface DropDownListProperties {
|
|
|
9527
9671
|
* Default value: center
|
|
9528
9672
|
*/
|
|
9529
9673
|
loadingIndicatorPosition?: VerticalAlignment | string;
|
|
9674
|
+
/**
|
|
9675
|
+
* Sets or gets the unlockKey which unlocks the product.
|
|
9676
|
+
* Default value: ""
|
|
9677
|
+
*/
|
|
9678
|
+
unlockKey?: string;
|
|
9530
9679
|
/**
|
|
9531
9680
|
* Sets or gets the language. Used in conjunction with the property messages.
|
|
9532
9681
|
* Default value: "en"
|
|
@@ -9734,6 +9883,11 @@ export interface DropDownList extends BaseElement, DropDownListProperties {
|
|
|
9734
9883
|
* @returns {Node}
|
|
9735
9884
|
*/
|
|
9736
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;
|
|
9737
9891
|
/**
|
|
9738
9892
|
* Removes all items from the drop down list.
|
|
9739
9893
|
*/
|
|
@@ -9746,6 +9900,10 @@ export interface DropDownList extends BaseElement, DropDownListProperties {
|
|
|
9746
9900
|
* Closes the dropDown list.
|
|
9747
9901
|
*/
|
|
9748
9902
|
close(): void;
|
|
9903
|
+
/**
|
|
9904
|
+
* Performs a data bind. This can be used to refresh the data source.
|
|
9905
|
+
*/
|
|
9906
|
+
dataBind(): void;
|
|
9749
9907
|
/**
|
|
9750
9908
|
* Ensures the desired item is visible by scrolling to it.
|
|
9751
9909
|
* @param {HTMLElement | string} item. A list item or value of the desired item to be visible.
|
|
@@ -9929,6 +10087,11 @@ export interface EditorProperties {
|
|
|
9929
10087
|
* Default value: [object Object]
|
|
9930
10088
|
*/
|
|
9931
10089
|
iframeSettings?: EditorIframeSettings;
|
|
10090
|
+
/**
|
|
10091
|
+
* Sets or gets the unlockKey which unlocks the product.
|
|
10092
|
+
* Default value: ""
|
|
10093
|
+
*/
|
|
10094
|
+
unlockKey?: string;
|
|
9932
10095
|
/**
|
|
9933
10096
|
* Sets or gets the language. Used in conjunction with the property messages.
|
|
9934
10097
|
* Default value: "en"
|
|
@@ -10857,6 +11020,11 @@ export interface ElementProperties {
|
|
|
10857
11020
|
* Default value: false
|
|
10858
11021
|
*/
|
|
10859
11022
|
isRendered?: boolean;
|
|
11023
|
+
/**
|
|
11024
|
+
* Sets or gets the unlockKey which unlocks the product.
|
|
11025
|
+
* Default value: ""
|
|
11026
|
+
*/
|
|
11027
|
+
unlockKey?: string;
|
|
10860
11028
|
/**
|
|
10861
11029
|
* Sets or gets the language. Used in conjunction with the property messages.
|
|
10862
11030
|
* Default value: "en"
|
|
@@ -11040,6 +11208,11 @@ export interface FileUploadProperties {
|
|
|
11040
11208
|
* Default value: null
|
|
11041
11209
|
*/
|
|
11042
11210
|
itemTemplate?: any;
|
|
11211
|
+
/**
|
|
11212
|
+
* Sets or gets the unlockKey which unlocks the product.
|
|
11213
|
+
* Default value: ""
|
|
11214
|
+
*/
|
|
11215
|
+
unlockKey?: string;
|
|
11043
11216
|
/**
|
|
11044
11217
|
* Sets or gets the language. Used in conjunction with the property messages.
|
|
11045
11218
|
* Default value: "en"
|
|
@@ -11304,6 +11477,11 @@ export interface FilterBuilderProperties {
|
|
|
11304
11477
|
* Default value: { '=': '=', '<>': '<>', '>': '>', '>=': '>=', '<': '<', '<=': '<=', 'startswith': 'a|bc', 'endswith': 'ab|c', 'contains': 'abc', 'notcontains': '!abc', 'isblank': 'o', 'isnotblank': '*'}
|
|
11305
11478
|
*/
|
|
11306
11479
|
icons?: FilterBuilderIcons;
|
|
11480
|
+
/**
|
|
11481
|
+
* Sets or gets the unlockKey which unlocks the product.
|
|
11482
|
+
* Default value: ""
|
|
11483
|
+
*/
|
|
11484
|
+
unlockKey?: string;
|
|
11307
11485
|
/**
|
|
11308
11486
|
* Sets or gets the language. Used in conjunction with the property messages.
|
|
11309
11487
|
* Default value: "en"
|
|
@@ -12487,6 +12665,11 @@ export interface FilterPanelProperties {
|
|
|
12487
12665
|
* Default value: "d"
|
|
12488
12666
|
*/
|
|
12489
12667
|
formatString?: string;
|
|
12668
|
+
/**
|
|
12669
|
+
* Sets or gets the unlockKey which unlocks the product.
|
|
12670
|
+
* Default value: ""
|
|
12671
|
+
*/
|
|
12672
|
+
unlockKey?: string;
|
|
12490
12673
|
/**
|
|
12491
12674
|
* Sets or gets the language. Used in conjunction with the property messages.
|
|
12492
12675
|
* Default value: "en"
|
|
@@ -13454,11 +13637,6 @@ export interface GanttChartProperties {
|
|
|
13454
13637
|
* Default value: true
|
|
13455
13638
|
*/
|
|
13456
13639
|
hideTimelineSecondHeaderDetails?: boolean;
|
|
13457
|
-
/**
|
|
13458
|
-
* Shows the selection column of the Task/Resource Table. When applied a checkbox column is displayed that allows to select tasks/resources.
|
|
13459
|
-
* Default value: false
|
|
13460
|
-
*/
|
|
13461
|
-
showSelectionColumn?: boolean;
|
|
13462
13640
|
/**
|
|
13463
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.
|
|
13464
13642
|
* Default value: false
|
|
@@ -13494,6 +13672,11 @@ export interface GanttChartProperties {
|
|
|
13494
13672
|
* Default value: false
|
|
13495
13673
|
*/
|
|
13496
13674
|
keyboardNavigation?: boolean;
|
|
13675
|
+
/**
|
|
13676
|
+
* Sets or gets the unlockKey which unlocks the product.
|
|
13677
|
+
* Default value: ""
|
|
13678
|
+
*/
|
|
13679
|
+
unlockKey?: string;
|
|
13497
13680
|
/**
|
|
13498
13681
|
* Determines the language of the GanttChart.
|
|
13499
13682
|
* Default value: "en"
|
|
@@ -13539,6 +13722,16 @@ export interface GanttChartProperties {
|
|
|
13539
13722
|
* Default value: null
|
|
13540
13723
|
*/
|
|
13541
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;
|
|
13542
13735
|
/**
|
|
13543
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.
|
|
13544
13737
|
* Default value: null
|
|
@@ -13629,11 +13822,21 @@ export interface GanttChartProperties {
|
|
|
13629
13822
|
* Default value:
|
|
13630
13823
|
*/
|
|
13631
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;
|
|
13632
13830
|
/**
|
|
13633
13831
|
* Enables/Disables the current time shader. If enabled all cells that represent past time will be shaded.
|
|
13634
13832
|
* Default value: false
|
|
13635
13833
|
*/
|
|
13636
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;
|
|
13637
13840
|
/**
|
|
13638
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.
|
|
13639
13842
|
* Default value: false
|
|
@@ -14171,6 +14374,11 @@ export interface GanttChart extends BaseElement, GanttChartProperties {
|
|
|
14171
14374
|
* @param {string} content?. Allows to set a custom content for the Tooltip.
|
|
14172
14375
|
*/
|
|
14173
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;
|
|
14174
14382
|
/**
|
|
14175
14383
|
* Saves the current settings of the element to LocalStorage. <strong>Requires an id to be set to the element.</strong>
|
|
14176
14384
|
* @param {any[]} state?. An Array containing a valid structure of Gantt Chart tasks.
|
|
@@ -14741,6 +14949,8 @@ export declare type QuarterFormat = 'numeric' | 'long' | 'short';
|
|
|
14741
14949
|
export declare type GanttChartResourceTimelineMode = 'diagram' | 'histogram' | 'custom';
|
|
14742
14950
|
/**Determines how the resources will be displayed inside the resource Timeline. */
|
|
14743
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';
|
|
14744
14954
|
/**Determines whether the GanttChart can be sorted by one, more then one or no columns. */
|
|
14745
14955
|
export declare type GanttChartSortMode = 'none' | 'one' | 'many';
|
|
14746
14956
|
/**Project, Task or Milestone type. Possible values are 'project', 'milestone' and 'task' */
|
|
@@ -14840,6 +15050,11 @@ export interface GaugeProperties {
|
|
|
14840
15050
|
* Default value: all
|
|
14841
15051
|
*/
|
|
14842
15052
|
labelsVisibility?: LabelsVisibility | string;
|
|
15053
|
+
/**
|
|
15054
|
+
* Sets or gets the unlockKey which unlocks the product.
|
|
15055
|
+
* Default value: ""
|
|
15056
|
+
*/
|
|
15057
|
+
unlockKey?: string;
|
|
14843
15058
|
/**
|
|
14844
15059
|
* Sets or gets the locale. Used in conjunction with the property messages.
|
|
14845
15060
|
* Default value: "en"
|
|
@@ -15082,15 +15297,15 @@ export interface GridProperties {
|
|
|
15082
15297
|
*/
|
|
15083
15298
|
behavior?: GridBehavior;
|
|
15084
15299
|
/**
|
|
15085
|
-
*
|
|
15086
|
-
* Default value:
|
|
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:
|
|
15087
15302
|
*/
|
|
15088
|
-
|
|
15303
|
+
currentUser?: string | number;
|
|
15089
15304
|
/**
|
|
15090
|
-
*
|
|
15091
|
-
* Default value:
|
|
15305
|
+
* Describes the column header settings.
|
|
15306
|
+
* Default value: [object Object]
|
|
15092
15307
|
*/
|
|
15093
|
-
|
|
15308
|
+
columnHeader?: GridColumnHeader;
|
|
15094
15309
|
/**
|
|
15095
15310
|
* The clipboard property is used to enable/disable clipboard operations with Ctrl+C, Ctrl+X and Ctrl+V keyboard navigations..
|
|
15096
15311
|
* Default value: [object Object]
|
|
@@ -15116,6 +15331,11 @@ export interface GridProperties {
|
|
|
15116
15331
|
* Default value:
|
|
15117
15332
|
*/
|
|
15118
15333
|
columnGroups?: GridColumnGroup[];
|
|
15334
|
+
/**
|
|
15335
|
+
*
|
|
15336
|
+
* Default value: false
|
|
15337
|
+
*/
|
|
15338
|
+
dropDownMode?: boolean;
|
|
15119
15339
|
/**
|
|
15120
15340
|
* Sets or gets details about conditional formatting to be applied to the Grid's cells.
|
|
15121
15341
|
* Default value: null
|
|
@@ -15156,11 +15376,51 @@ export interface GridProperties {
|
|
|
15156
15376
|
* Default value: [object Object]
|
|
15157
15377
|
*/
|
|
15158
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;
|
|
15159
15389
|
/**
|
|
15160
15390
|
* Describes the grid's grouping settings.
|
|
15161
15391
|
* Default value: [object Object]
|
|
15162
15392
|
*/
|
|
15163
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;
|
|
15164
15424
|
/**
|
|
15165
15425
|
* Sets the messages values.
|
|
15166
15426
|
* Default value: * [object Object]
|
|
@@ -15181,6 +15441,21 @@ export interface GridProperties {
|
|
|
15181
15441
|
* Default value: null
|
|
15182
15442
|
*/
|
|
15183
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};
|
|
15184
15459
|
/**
|
|
15185
15460
|
* Callback function() called before the grid has been initialized and the Grid's Virtual DOM is not created.
|
|
15186
15461
|
* Default value: null
|
|
@@ -15301,26 +15576,6 @@ export interface GridProperties {
|
|
|
15301
15576
|
* Default value: null
|
|
15302
15577
|
*/
|
|
15303
15578
|
onCommand?: {(name: string, command: any, details: GridCell, event: Event | KeyboardEvent | PointerEvent, handled: boolean): void};
|
|
15304
|
-
/**
|
|
15305
|
-
* Sets or gets the rows CSS class rules. Different CSS class names are conditionally applied. Example: rowCSSRules: { 'cell-class-1': settings => settings.data.quantity === 5, 'cell-class-2': settings => settings.data.quantity < 5, 'cell-class-3': settings => settings.data.quantity > 5 }. The settings object contains the following properties: index, data, row, api.
|
|
15306
|
-
* Default value: null
|
|
15307
|
-
*/
|
|
15308
|
-
rowCSSRules?: any;
|
|
15309
|
-
/**
|
|
15310
|
-
* Sets or gets the id of the current user. Has to correspond to the id of an item from the users property/array. Depending on the current user, different privileges are enabled. If no current user is set, privileges depend on the element's properties.
|
|
15311
|
-
* Default value:
|
|
15312
|
-
*/
|
|
15313
|
-
currentUser?: string | number;
|
|
15314
|
-
/**
|
|
15315
|
-
* Sets the grid users. Expects an array with 'id', 'name' and optionally 'color' and 'image' properties.
|
|
15316
|
-
* Default value: []
|
|
15317
|
-
*/
|
|
15318
|
-
users?: any[];
|
|
15319
|
-
/**
|
|
15320
|
-
* Sets the grid's image and filter upload settings for the image and attachment columns.
|
|
15321
|
-
* Default value: [object Object]
|
|
15322
|
-
*/
|
|
15323
|
-
uploadSettings?: GridUploadSettings;
|
|
15324
15579
|
/**
|
|
15325
15580
|
* Describes the paging settings.
|
|
15326
15581
|
* Default value: [object Object]
|
|
@@ -15336,16 +15591,26 @@ export interface GridProperties {
|
|
|
15336
15591
|
* Default value: [object Object]
|
|
15337
15592
|
*/
|
|
15338
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 => settings.data.quantity === 5, 'cell-class-2': settings => settings.data.quantity < 5, 'cell-class-3': settings => settings.data.quantity > 5 }. The settings object contains the following properties: index, data, row, api.
|
|
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[];
|
|
15339
15609
|
/**
|
|
15340
15610
|
* Sets the scroll mode settings.
|
|
15341
15611
|
* Default value: physical
|
|
15342
15612
|
*/
|
|
15343
15613
|
scrolling?: Scrolling | string;
|
|
15344
|
-
/**
|
|
15345
|
-
* Describes the column header settings.
|
|
15346
|
-
* Default value: [object Object]
|
|
15347
|
-
*/
|
|
15348
|
-
columnHeader?: GridColumnHeader;
|
|
15349
15614
|
/**
|
|
15350
15615
|
* Describes the summary row settings.
|
|
15351
15616
|
* Default value: [object Object]
|
|
@@ -15357,40 +15622,30 @@ export interface GridProperties {
|
|
|
15357
15622
|
*/
|
|
15358
15623
|
stateSettings?: GridStateSettings;
|
|
15359
15624
|
/**
|
|
15360
|
-
* Describes the settings
|
|
15361
|
-
* Default value: [object Object]
|
|
15362
|
-
*/
|
|
15363
|
-
groupHeader?: GridGroupHeader;
|
|
15364
|
-
/**
|
|
15365
|
-
* Describes the header settings of the grid.
|
|
15625
|
+
* Describes the selection settings.
|
|
15366
15626
|
* Default value: [object Object]
|
|
15367
15627
|
*/
|
|
15368
|
-
|
|
15628
|
+
selection?: GridSelection;
|
|
15369
15629
|
/**
|
|
15370
|
-
* Describes
|
|
15630
|
+
* Describes sorting settings.
|
|
15371
15631
|
* Default value: [object Object]
|
|
15372
15632
|
*/
|
|
15373
|
-
|
|
15374
|
-
/**
|
|
15375
|
-
* Sets or gets the value indicating whether the element is aligned to support locales using right-to-left fonts.
|
|
15376
|
-
* Default value: false
|
|
15377
|
-
*/
|
|
15378
|
-
rightToLeft?: boolean;
|
|
15633
|
+
sorting?: GridSorting;
|
|
15379
15634
|
/**
|
|
15380
|
-
*
|
|
15381
|
-
* Default value:
|
|
15635
|
+
* Sets the grid users. Expects an array with 'id', 'name' and optionally 'color' and 'image' properties.
|
|
15636
|
+
* Default value: []
|
|
15382
15637
|
*/
|
|
15383
|
-
|
|
15638
|
+
users?: any[];
|
|
15384
15639
|
/**
|
|
15385
|
-
*
|
|
15640
|
+
* Sets the grid's image and filter upload settings for the image and attachment columns.
|
|
15386
15641
|
* Default value: [object Object]
|
|
15387
15642
|
*/
|
|
15388
|
-
|
|
15643
|
+
uploadSettings?: GridUploadSettings;
|
|
15389
15644
|
/**
|
|
15390
|
-
*
|
|
15391
|
-
* Default value:
|
|
15645
|
+
* Sets the current data view. The possible values are 'grid', 'kanban' and 'card'.
|
|
15646
|
+
* Default value: "grid"
|
|
15392
15647
|
*/
|
|
15393
|
-
|
|
15648
|
+
view?: string;
|
|
15394
15649
|
}
|
|
15395
15650
|
/**
|
|
15396
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.
|
|
@@ -15465,6 +15720,15 @@ export interface Grid extends BaseElement, GridProperties {
|
|
|
15465
15720
|
* originalEvent - The origianl Event object.
|
|
15466
15721
|
*/
|
|
15467
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;
|
|
15468
15732
|
/**
|
|
15469
15733
|
* This event is triggered, when the user drags a column.
|
|
15470
15734
|
* @param event. The custom event. Custom data event was created with: ev.detail(column, dataField, index, data, originalEvent)
|
|
@@ -15578,10 +15842,11 @@ export interface Grid extends BaseElement, GridProperties {
|
|
|
15578
15842
|
onRowCollapse?: ((this: any, ev: Event) => any) | ((this: any, ev: CustomEvent<any>) => any) | null;
|
|
15579
15843
|
/**
|
|
15580
15844
|
* This event is triggered, when the user clicks on a row of the grid.
|
|
15581
|
-
* @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)
|
|
15582
15846
|
* row - The clicked row.
|
|
15583
15847
|
* originalEvent - The original event object, which is 'pointer', 'touch' or 'mouse' Event object, depending on the device type and web browser
|
|
15584
15848
|
* id - Gets the row id.
|
|
15849
|
+
* data - Gets the row data.
|
|
15585
15850
|
* isRightClick - Gets whether the pointing device's right button is clicked.
|
|
15586
15851
|
* pageX - Gets the click's X position.
|
|
15587
15852
|
* pageY - Gets the click's Y position.
|
|
@@ -15589,10 +15854,11 @@ export interface Grid extends BaseElement, GridProperties {
|
|
|
15589
15854
|
onRowClick?: ((this: any, ev: Event) => any) | ((this: any, ev: CustomEvent<any>) => any) | null;
|
|
15590
15855
|
/**
|
|
15591
15856
|
* This event is triggered, when the user double clicks on a row of the grid.
|
|
15592
|
-
* @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)
|
|
15593
15858
|
* row - The double-clicked row.
|
|
15594
15859
|
* originalEvent - The original event object, which is 'pointer', 'touch' or 'mouse' Event object, depending on the device type and web browser
|
|
15595
15860
|
* id - Gets the row id.
|
|
15861
|
+
* data - Gets the row data.
|
|
15596
15862
|
* isRightClick - Gets whether the pointing device's right button is clicked.
|
|
15597
15863
|
* pageX - Gets the click's X position.
|
|
15598
15864
|
* pageY - Gets the click's Y position.
|
|
@@ -15618,11 +15884,12 @@ export interface Grid extends BaseElement, GridProperties {
|
|
|
15618
15884
|
onRowStarred?: ((this: any, ev: Event) => any) | ((this: any, ev: CustomEvent<any>) => any) | null;
|
|
15619
15885
|
/**
|
|
15620
15886
|
* This event is triggered, when the user clicks on a cell of the grid.
|
|
15621
|
-
* @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)
|
|
15622
15888
|
* cell - The clicked cell.
|
|
15623
15889
|
* originalEvent - The original event object, which is 'pointer', 'touch' or 'mouse' Event object, depending on the device type and web browser
|
|
15624
15890
|
* id - Gets the row id.
|
|
15625
15891
|
* dataField - Gets the column dataField.
|
|
15892
|
+
* value - Gets the cell value.
|
|
15626
15893
|
* isRightClick - Gets whether the pointing device's right button is clicked.
|
|
15627
15894
|
* pageX - Gets the click's X position.
|
|
15628
15895
|
* pageY - Gets the click's Y position.
|
|
@@ -15630,11 +15897,12 @@ export interface Grid extends BaseElement, GridProperties {
|
|
|
15630
15897
|
onCellClick?: ((this: any, ev: Event) => any) | ((this: any, ev: CustomEvent<any>) => any) | null;
|
|
15631
15898
|
/**
|
|
15632
15899
|
* This event is triggered, when the user double clicks on a cell of the grid.
|
|
15633
|
-
* @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)
|
|
15634
15901
|
* cell - The double-clicked cell.
|
|
15635
15902
|
* originalEvent - The original event object, which is 'pointer', 'touch' or 'mouse' Event object, depending on the device type and web browser
|
|
15636
15903
|
* id - Gets the row id.
|
|
15637
15904
|
* dataField - Gets the column dataField.
|
|
15905
|
+
* value - Gets the cell value.
|
|
15638
15906
|
* isRightClick - Gets whether the pointing device's right button is clicked.
|
|
15639
15907
|
* pageX - Gets the click's X position.
|
|
15640
15908
|
* pageY - Gets the click's Y position.
|
|
@@ -15882,8 +16150,10 @@ export interface Grid extends BaseElement, GridProperties {
|
|
|
15882
16150
|
/**
|
|
15883
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.
|
|
15884
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.
|
|
15885
16155
|
*/
|
|
15886
|
-
exportData(Dataformat: string): void;
|
|
16156
|
+
exportData(Dataformat: string, callback?: any, dataCallback?: any): void;
|
|
15887
16157
|
/**
|
|
15888
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.
|
|
15889
16159
|
* @param {string} query. Search query
|
|
@@ -15898,6 +16168,12 @@ export interface Grid extends BaseElement, GridProperties {
|
|
|
15898
16168
|
* @returns {any[]}
|
|
15899
16169
|
*/
|
|
15900
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;
|
|
15901
16177
|
/**
|
|
15902
16178
|
* Navigates to a page, when paging is enabled.
|
|
15903
16179
|
* @param {number} index. page index
|
|
@@ -16020,22 +16296,6 @@ export interface Grid extends BaseElement, GridProperties {
|
|
|
16020
16296
|
* @returns {any}
|
|
16021
16297
|
*/
|
|
16022
16298
|
getState(): any;
|
|
16023
|
-
/**
|
|
16024
|
-
* Saves the Grid state and returns a JSON object with the following fields: 'sort', 'columns', 'expandedRows', 'filter', 'groups', 'paging', 'selectedCells', 'selectedrows'. The 'sort' represents an object which contains the sorted columns. Each key in that json object is the column's dataField item which has sortOrder: string and sortIndex: int properties. The sortOrder could be either 'asc' or 'desc'. Similarly, the filter object contains the filtered columns. Each key in that object is a column data field and each value has 'filters' array property with the applied filters to the column. The 'columns' property contains an array of columns with saved properties such as visible, width and freeze. The 'expandedRows' property contains the indexes of the expanded rows. The 'groups' property contains the grouped column data fields and the selectedCells and selectedRows include information about the cells or rows selection. These depend on the selection mode used in the Grid. The 'paging' object includes the sub-properties 'count', 'index' and 'size' which determine the count of pages, the current page's index and the page size.
|
|
16025
|
-
* @param {string} name?. state name
|
|
16026
|
-
* @returns {any}
|
|
16027
|
-
*/
|
|
16028
|
-
saveState(name?: string): any;
|
|
16029
|
-
/**
|
|
16030
|
-
* Loads a previously saved Grid state. You can pass a state name when there is a state which was previously saved with the saveState(stateName) method call or a state object returned by the saveState or getState method calls. The state object is required to be a JSON object with the following fields: 'sort', 'columns', 'expandedRows', 'filter', 'groups', 'paging', 'selectedCells', 'selectedrows'. The 'sort' represents an object which contains the sorted columns. Each key in that json object is the column's dataField item which has sortOrder: string and sortIndex: int properties. The sortOrder could be either 'asc' or 'desc'. Similarly, the filter object contains the filtered columns. Each key in that object is a column data field and each value has 'filters' array property with the applied filters to the column. The 'columns' property contains an array of columns with saved properties such as visible, width and freeze. The 'expandedRows' property contains the indexes of the expanded rows. The 'groups' property contains the grouped column data fields and the selectedCells and selectedRows include information about the cells or rows selection. These depend on the selection mode used in the Grid. The 'paging' object includes the sub-properties 'count', 'index' and 'size' which determine the count of pages, the current page's index and the page size.
|
|
16031
|
-
* @param {any} state. state name or state object
|
|
16032
|
-
* @returns {any}
|
|
16033
|
-
*/
|
|
16034
|
-
loadState(state: any): any;
|
|
16035
|
-
/**
|
|
16036
|
-
* Resets the Grid state.
|
|
16037
|
-
*/
|
|
16038
|
-
resetState(): void;
|
|
16039
16299
|
/**
|
|
16040
16300
|
* Gets the changes from the batch edit.
|
|
16041
16301
|
* @returns
|
|
@@ -16132,6 +16392,12 @@ export interface Grid extends BaseElement, GridProperties {
|
|
|
16132
16392
|
* @param callback?. Sets a callback function, which is called after the new row is added. The callback's argument is the new row.
|
|
16133
16393
|
*/
|
|
16134
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;
|
|
16135
16401
|
/**
|
|
16136
16402
|
* Opens a column drop-down menu.
|
|
16137
16403
|
* @param {string} dataField. column bound data field. For example, if you have a column with dataField: 'firstName', set 'firstName' here.
|
|
@@ -16143,6 +16409,14 @@ export interface Grid extends BaseElement, GridProperties {
|
|
|
16143
16409
|
* @param {number} top. Top Position.
|
|
16144
16410
|
*/
|
|
16145
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;
|
|
16146
16420
|
/**
|
|
16147
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.
|
|
16148
16422
|
*/
|
|
@@ -16159,6 +16433,10 @@ export interface Grid extends BaseElement, GridProperties {
|
|
|
16159
16433
|
* Refreshes the grid cells in view. The method is useful for live-updates of cell values.
|
|
16160
16434
|
*/
|
|
16161
16435
|
refreshView(): void;
|
|
16436
|
+
/**
|
|
16437
|
+
* Resets the Grid state.
|
|
16438
|
+
*/
|
|
16439
|
+
resetState(): void;
|
|
16162
16440
|
/**
|
|
16163
16441
|
* Removes a column filter.
|
|
16164
16442
|
* @param {string} dataField. column bound data field. For example, if you have a column with dataField: 'firstName', set 'firstName' here.
|
|
@@ -16190,6 +16468,12 @@ export interface Grid extends BaseElement, GridProperties {
|
|
|
16190
16468
|
* @param {boolean} insertAfter?. Determines whether to insert the first column after the reference column.
|
|
16191
16469
|
*/
|
|
16192
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;
|
|
16193
16477
|
/**
|
|
16194
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.
|
|
16195
16479
|
* @param {string} dataField. column bound data field. For example, if you have a column with dataField: 'firstName', set 'firstName' here.
|
|
@@ -16297,6 +16581,11 @@ export interface Grid extends BaseElement, GridProperties {
|
|
|
16297
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'.
|
|
16298
16582
|
*/
|
|
16299
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;
|
|
16300
16589
|
/**
|
|
16301
16590
|
* Sets the position of the vertical scrollbar. You can use this method in combination with the getVerticalScrollValue and getVerticalScrollMax.
|
|
16302
16591
|
* @param {number} value. The new scroll position
|
|
@@ -16312,6 +16601,13 @@ export interface Grid extends BaseElement, GridProperties {
|
|
|
16312
16601
|
* @param {string | number} rowId. row bound id
|
|
16313
16602
|
*/
|
|
16314
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;
|
|
16315
16611
|
/**
|
|
16316
16612
|
* Updates a row. When batch editing is enabled, the row is not saved until the batch edit is saved.
|
|
16317
16613
|
* @param {string | number} rowId. row bound id
|
|
@@ -16627,6 +16923,11 @@ export interface GridBehavior {
|
|
|
16627
16923
|
* Default value: false
|
|
16628
16924
|
*/
|
|
16629
16925
|
allowColumnFreeze?: boolean;
|
|
16926
|
+
/**
|
|
16927
|
+
* Determines whether the scrolling with mouse wheel is enabled.
|
|
16928
|
+
* Default value: true
|
|
16929
|
+
*/
|
|
16930
|
+
allowMouseWheel?: boolean;
|
|
16630
16931
|
/**
|
|
16631
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
|
|
16632
16933
|
* Default value: none
|
|
@@ -16639,48 +16940,13 @@ export interface GridBehavior {
|
|
|
16639
16940
|
rowResizeMode?: GridResizeMode | string;
|
|
16640
16941
|
}
|
|
16641
16942
|
|
|
16642
|
-
/**
|
|
16643
|
-
export interface
|
|
16644
|
-
/**
|
|
16645
|
-
* Enables or disables the Cells Value wrapping. When the property is true, cell value can wrap in multiple lines.
|
|
16646
|
-
* Default value: false
|
|
16647
|
-
*/
|
|
16648
|
-
allowCellsWrap?: boolean;
|
|
16649
|
-
/**
|
|
16650
|
-
* Automatically sets width to any new Column which does not have its 'width' property set.
|
|
16651
|
-
* Default value: false
|
|
16652
|
-
*/
|
|
16653
|
-
autoSizeNewColumn?: boolean;
|
|
16654
|
-
/**
|
|
16655
|
-
* Sets the width of the auto-generated Grid columns.
|
|
16656
|
-
* Default value: null
|
|
16657
|
-
*/
|
|
16658
|
-
autoGenerateColumnWidth?: string | number | null;
|
|
16659
|
-
/**
|
|
16660
|
-
* Sets the width of the Grid columns.
|
|
16661
|
-
* Default value: null
|
|
16662
|
-
*/
|
|
16663
|
-
columnWidth?: string | number | null;
|
|
16664
|
-
/**
|
|
16665
|
-
* Sets the height of the Grid columns.
|
|
16666
|
-
* Default value: null
|
|
16667
|
-
*/
|
|
16668
|
-
columnHeight?: string | number | null;
|
|
16669
|
-
/**
|
|
16670
|
-
* Sets the minimum height of the Grid columns.
|
|
16671
|
-
* Default value: 30
|
|
16672
|
-
*/
|
|
16673
|
-
columnMinHeight?: number;
|
|
16674
|
-
/**
|
|
16675
|
-
* Sets the minimum height of the Grid rows.
|
|
16676
|
-
* Default value: 30
|
|
16677
|
-
*/
|
|
16678
|
-
rowMinHeight?: number;
|
|
16943
|
+
/**Describes the column header settings. */
|
|
16944
|
+
export interface GridColumnHeader {
|
|
16679
16945
|
/**
|
|
16680
|
-
* Sets the
|
|
16681
|
-
* Default value:
|
|
16946
|
+
* Sets the column header visibility.
|
|
16947
|
+
* Default value: true
|
|
16682
16948
|
*/
|
|
16683
|
-
|
|
16949
|
+
visible?: boolean;
|
|
16684
16950
|
}
|
|
16685
16951
|
|
|
16686
16952
|
/**The <em>clipboard</em> property is used to enable/disable clipboard operations with Ctrl+C, Ctrl+X and Ctrl+V keyboard navigations.. */
|
|
@@ -16690,6 +16956,11 @@ export interface GridClipboard {
|
|
|
16690
16956
|
* Default value: true
|
|
16691
16957
|
*/
|
|
16692
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;
|
|
16693
16964
|
/**
|
|
16694
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.
|
|
16695
16966
|
* Default value: fillSeries
|
|
@@ -16729,10 +17000,10 @@ export interface GridColumn {
|
|
|
16729
17000
|
*/
|
|
16730
17001
|
allowSelect?: boolean | null;
|
|
16731
17002
|
/**
|
|
16732
|
-
* 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'; }
|
|
16733
17004
|
* Default value: true
|
|
16734
17005
|
*/
|
|
16735
|
-
allowEdit?:
|
|
17006
|
+
allowEdit?: any;
|
|
16736
17007
|
/**
|
|
16737
17008
|
* Sets or gets whether the column can be sorted.
|
|
16738
17009
|
* Default value: true
|
|
@@ -16763,6 +17034,11 @@ export interface GridColumn {
|
|
|
16763
17034
|
* Default value: true
|
|
16764
17035
|
*/
|
|
16765
17036
|
allowNull?: boolean;
|
|
17037
|
+
/**
|
|
17038
|
+
* Sets or gets the cell's height in card view mode.
|
|
17039
|
+
* Default value: 0
|
|
17040
|
+
*/
|
|
17041
|
+
cardHeight?: number;
|
|
16766
17042
|
/**
|
|
16767
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.
|
|
16768
17044
|
* Default value: ""
|
|
@@ -16823,6 +17099,11 @@ export interface GridColumn {
|
|
|
16823
17099
|
* Default value: ""
|
|
16824
17100
|
*/
|
|
16825
17101
|
description?: string;
|
|
17102
|
+
/**
|
|
17103
|
+
* Sets or gets custom data object related to the column.
|
|
17104
|
+
* Default value: null
|
|
17105
|
+
*/
|
|
17106
|
+
dataSet?: any;
|
|
16826
17107
|
/**
|
|
16827
17108
|
* Gets the HTML Element. The property returns null when the Column is not in the View.
|
|
16828
17109
|
* Default value: null
|
|
@@ -16863,6 +17144,11 @@ export interface GridColumn {
|
|
|
16863
17144
|
* Default value: [object Object]
|
|
16864
17145
|
*/
|
|
16865
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;
|
|
16866
17152
|
/**
|
|
16867
17153
|
* Sets or gets the column's group.
|
|
16868
17154
|
* Default value: ""
|
|
@@ -16904,10 +17190,20 @@ export interface GridColumn {
|
|
|
16904
17190
|
*/
|
|
16905
17191
|
rowSpan?: {(cellValue: any, rowIndex: number, data: any): number};
|
|
16906
17192
|
/**
|
|
16907
|
-
* Sets or gets the
|
|
16908
|
-
* Default value:
|
|
17193
|
+
* Sets or gets the relation id in the dataSourceSettings.relations. The 'relationField' property should be set.
|
|
17194
|
+
* Default value: ""
|
|
17195
|
+
*/
|
|
17196
|
+
relationId?: string;
|
|
17197
|
+
/**
|
|
17198
|
+
* Sets or gets the relation field in the dataSourceSettings.relations. The 'relationId' property should be set.
|
|
17199
|
+
* Default value: ""
|
|
16909
17200
|
*/
|
|
16910
|
-
|
|
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;
|
|
16911
17207
|
/**
|
|
16912
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'.
|
|
16913
17209
|
* Default value: null
|
|
@@ -16939,10 +17235,15 @@ export interface GridColumn {
|
|
|
16939
17235
|
*/
|
|
16940
17236
|
width?: string | number;
|
|
16941
17237
|
/**
|
|
16942
|
-
* 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', '
|
|
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.
|
|
16943
17239
|
* Default value:
|
|
16944
17240
|
*/
|
|
16945
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;
|
|
16946
17247
|
/**
|
|
16947
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.
|
|
16948
17249
|
* Default value: null
|
|
@@ -16977,6 +17278,11 @@ export interface GridContextMenu {
|
|
|
16977
17278
|
* Default value: false
|
|
16978
17279
|
*/
|
|
16979
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[];
|
|
16980
17286
|
/**
|
|
16981
17287
|
* Sets the data sources to the context menu.
|
|
16982
17288
|
* Default value: [object Object]
|
|
@@ -17380,6 +17686,61 @@ export interface GridDataExport {
|
|
|
17380
17686
|
* Default value: null
|
|
17381
17687
|
*/
|
|
17382
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;
|
|
17383
17744
|
}
|
|
17384
17745
|
|
|
17385
17746
|
/**Sets the grid's data source settings when the <em>dataSource</em> property is set to an Array or URL. */
|
|
@@ -17444,6 +17805,11 @@ export interface GridDataSourceSettings {
|
|
|
17444
17805
|
* Default value: "."
|
|
17445
17806
|
*/
|
|
17446
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;
|
|
17447
17813
|
/**
|
|
17448
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/
|
|
17449
17815
|
* Default value: null
|
|
@@ -17491,6 +17857,11 @@ export interface GridEditing {
|
|
|
17491
17857
|
* Default value: true
|
|
17492
17858
|
*/
|
|
17493
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;
|
|
17494
17865
|
/**
|
|
17495
17866
|
* Enables editing.
|
|
17496
17867
|
* Default value: false
|
|
@@ -17506,6 +17877,11 @@ export interface GridEditing {
|
|
|
17506
17877
|
* Default value: click
|
|
17507
17878
|
*/
|
|
17508
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;
|
|
17509
17885
|
/**
|
|
17510
17886
|
* Describes command keys.
|
|
17511
17887
|
* Default value: [object Object]
|
|
@@ -17856,6 +18232,20 @@ export interface GridFilteringFilterBuilder {
|
|
|
17856
18232
|
height?: number | null;
|
|
17857
18233
|
}
|
|
17858
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
|
+
|
|
17859
18249
|
/**Describes the grid's grouping settings. */
|
|
17860
18250
|
export interface GridGrouping {
|
|
17861
18251
|
/**
|
|
@@ -17968,38 +18358,141 @@ export interface GridGroupingSummaryRow {
|
|
|
17968
18358
|
visible?: boolean;
|
|
17969
18359
|
}
|
|
17970
18360
|
|
|
17971
|
-
/**
|
|
17972
|
-
export interface
|
|
18361
|
+
/**Describes the settings for the group header. */
|
|
18362
|
+
export interface GridGroupHeader {
|
|
17973
18363
|
/**
|
|
17974
|
-
* Sets
|
|
17975
|
-
* Default value:
|
|
18364
|
+
* Sets the visibility of the group header.
|
|
18365
|
+
* Default value: false
|
|
17976
18366
|
*/
|
|
17977
|
-
|
|
18367
|
+
visible?: boolean;
|
|
17978
18368
|
/**
|
|
17979
|
-
* Sets
|
|
17980
|
-
* Default value:
|
|
18369
|
+
* Sets a template for the group header.
|
|
18370
|
+
* Default value:
|
|
17981
18371
|
*/
|
|
17982
|
-
|
|
18372
|
+
template?: string | HTMLTemplateElement;
|
|
18373
|
+
}
|
|
18374
|
+
|
|
18375
|
+
/**Describes the header settings of the grid. */
|
|
18376
|
+
export interface GridHeader {
|
|
17983
18377
|
/**
|
|
17984
|
-
* Sets
|
|
17985
|
-
* Default value:
|
|
18378
|
+
* Sets the header visibility.
|
|
18379
|
+
* Default value: false
|
|
17986
18380
|
*/
|
|
17987
|
-
|
|
18381
|
+
visible?: boolean;
|
|
17988
18382
|
/**
|
|
17989
|
-
*
|
|
17990
|
-
* Default value:
|
|
18383
|
+
* Sets a template for the header.
|
|
18384
|
+
* Default value:
|
|
17991
18385
|
*/
|
|
17992
|
-
|
|
18386
|
+
template?: string | HTMLTemplateElement | {(element: HTMLElement): void};
|
|
17993
18387
|
/**
|
|
17994
|
-
*
|
|
17995
|
-
* 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
|
|
17996
18390
|
*/
|
|
17997
|
-
|
|
18391
|
+
onInit?: {(element: HTMLElement): void};
|
|
17998
18392
|
/**
|
|
17999
|
-
*
|
|
18000
|
-
* 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" ]
|
|
18001
18395
|
*/
|
|
18002
|
-
|
|
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;
|
|
18003
18496
|
}
|
|
18004
18497
|
|
|
18005
18498
|
/**Describes the paging settings. */
|
|
@@ -18240,120 +18733,6 @@ export interface GridRowDetail {
|
|
|
18240
18733
|
dialog?: Dialog;
|
|
18241
18734
|
}
|
|
18242
18735
|
|
|
18243
|
-
/**Describes the column header settings. */
|
|
18244
|
-
export interface GridColumnHeader {
|
|
18245
|
-
/**
|
|
18246
|
-
* Sets the column header visibility.
|
|
18247
|
-
* Default value: true
|
|
18248
|
-
*/
|
|
18249
|
-
visible?: boolean;
|
|
18250
|
-
}
|
|
18251
|
-
|
|
18252
|
-
/**Describes the summary row settings. */
|
|
18253
|
-
export interface GridSummaryRow {
|
|
18254
|
-
/**
|
|
18255
|
-
* Sets the summary row visibility.
|
|
18256
|
-
* Default value: false
|
|
18257
|
-
*/
|
|
18258
|
-
visible?: boolean;
|
|
18259
|
-
/**
|
|
18260
|
-
* 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.
|
|
18261
|
-
* Default value: false
|
|
18262
|
-
*/
|
|
18263
|
-
editing?: boolean;
|
|
18264
|
-
}
|
|
18265
|
-
|
|
18266
|
-
/**Sets the grid's state settings. */
|
|
18267
|
-
export interface GridStateSettings {
|
|
18268
|
-
/**
|
|
18269
|
-
* Enables or disables auto-save of the Grid's state
|
|
18270
|
-
* Default value: false
|
|
18271
|
-
*/
|
|
18272
|
-
autoSave?: boolean;
|
|
18273
|
-
/**
|
|
18274
|
-
* Enables or disables auto-load of the Grid's state on page reload.
|
|
18275
|
-
* Default value: false
|
|
18276
|
-
*/
|
|
18277
|
-
autoLoad?: boolean;
|
|
18278
|
-
/**
|
|
18279
|
-
* Enables or disables save/load of the grid state.
|
|
18280
|
-
* Default value: true
|
|
18281
|
-
*/
|
|
18282
|
-
enabled?: boolean;
|
|
18283
|
-
/**
|
|
18284
|
-
* Sets or gets the current state.
|
|
18285
|
-
* Default value: ""
|
|
18286
|
-
*/
|
|
18287
|
-
current?: string;
|
|
18288
|
-
/**
|
|
18289
|
-
* Container which is auto-filled with state objects when you call the saveState method or enable the autoSave of states. Each object has a key which is the state's name and value which is a json with the state's properties.
|
|
18290
|
-
* Default value: null
|
|
18291
|
-
*/
|
|
18292
|
-
storage?: any;
|
|
18293
|
-
/**
|
|
18294
|
-
* Function called when the state is changed.
|
|
18295
|
-
* Default value:
|
|
18296
|
-
*/
|
|
18297
|
-
onStateChange?: any;
|
|
18298
|
-
/**
|
|
18299
|
-
* Array with state options such as 'sort', 'filter', 'expandedRows', 'paging', 'selectedCells', 'selectedRows', 'group', 'columns'. This property determines which parts of the state would be saved or loaded.
|
|
18300
|
-
* Default value:
|
|
18301
|
-
*/
|
|
18302
|
-
options?: string[];
|
|
18303
|
-
}
|
|
18304
|
-
|
|
18305
|
-
/**Describes the settings for the group header. */
|
|
18306
|
-
export interface GridGroupHeader {
|
|
18307
|
-
/**
|
|
18308
|
-
* Sets the visibility of the group header.
|
|
18309
|
-
* Default value: false
|
|
18310
|
-
*/
|
|
18311
|
-
visible?: boolean;
|
|
18312
|
-
/**
|
|
18313
|
-
* Sets a template for the group header.
|
|
18314
|
-
* Default value:
|
|
18315
|
-
*/
|
|
18316
|
-
template?: string | HTMLTemplateElement;
|
|
18317
|
-
}
|
|
18318
|
-
|
|
18319
|
-
/**Describes the header settings of the grid. */
|
|
18320
|
-
export interface GridHeader {
|
|
18321
|
-
/**
|
|
18322
|
-
* Sets the header visibility.
|
|
18323
|
-
* Default value: false
|
|
18324
|
-
*/
|
|
18325
|
-
visible?: boolean;
|
|
18326
|
-
/**
|
|
18327
|
-
* Sets a template for the header.
|
|
18328
|
-
* Default value:
|
|
18329
|
-
*/
|
|
18330
|
-
template?: string | HTMLTemplateElement | {(element: HTMLElement): void};
|
|
18331
|
-
/**
|
|
18332
|
-
* This callback function can be used for customization of the Header toolbar. The Toolbar HTML Element is passed as an argument.
|
|
18333
|
-
* Default value: null
|
|
18334
|
-
*/
|
|
18335
|
-
onInit?: {(element: HTMLElement): void};
|
|
18336
|
-
/**
|
|
18337
|
-
* Determines the buttons displayed in the Grid header. 'columns' displays a button opening the columns chooser panel. 'filter' displays a button opening the filtering panel. 'group' displays a button opening the grouping panel. 'sort' displays a button opening the sorting panel. 'format' displays a button opening the conditional formatting panel. 'search' displays a button opening the search panel.
|
|
18338
|
-
* Default value: [ "columns", "filter", "group", "sort", "format", "search" ]
|
|
18339
|
-
*/
|
|
18340
|
-
buttons?: string[];
|
|
18341
|
-
}
|
|
18342
|
-
|
|
18343
|
-
/**Describes the footer settings of the grid. */
|
|
18344
|
-
export interface GridFooter {
|
|
18345
|
-
/**
|
|
18346
|
-
* Sets the footer visibility.
|
|
18347
|
-
* Default value: false
|
|
18348
|
-
*/
|
|
18349
|
-
visible?: boolean;
|
|
18350
|
-
/**
|
|
18351
|
-
* Sets a template for the footer.
|
|
18352
|
-
* Default value:
|
|
18353
|
-
*/
|
|
18354
|
-
template?: string | HTMLTemplateElement | {(element: HTMLElement): void};
|
|
18355
|
-
}
|
|
18356
|
-
|
|
18357
18736
|
export interface GridRow {
|
|
18358
18737
|
/**
|
|
18359
18738
|
* Sets or gets the row can be expanded or collapsed.
|
|
@@ -18610,6 +18989,59 @@ export interface GridCell {
|
|
|
18610
18989
|
setStyle?: {(value: any): void};
|
|
18611
18990
|
}
|
|
18612
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
|
+
|
|
18613
19045
|
/**Describes the selection settings. */
|
|
18614
19046
|
export interface GridSelection {
|
|
18615
19047
|
/**
|
|
@@ -18761,6 +19193,40 @@ export interface GridSorting {
|
|
|
18761
19193
|
sortToggleOnClickAndCommandKey?: boolean;
|
|
18762
19194
|
}
|
|
18763
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
|
+
|
|
18764
19230
|
declare global {
|
|
18765
19231
|
interface Document {
|
|
18766
19232
|
createElement(tagName: "smart-grid"): Grid;
|
|
@@ -18783,8 +19249,8 @@ export declare type GridClipboardAutoFillMode = 'none' | 'copy' | 'fillSeries';
|
|
|
18783
19249
|
export declare type Position = 'near' | 'far';
|
|
18784
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. */
|
|
18785
19251
|
export declare type GridColumnFilterMenuMode = 'basic' | 'default' | 'excel';
|
|
18786
|
-
/**Sets or gets the sort order of the column. Accepts: 'asc', 'desc' and null. */
|
|
18787
|
-
export declare type GridColumnSortOrder = 'asc' | 'desc' |
|
|
19252
|
+
/**Sets or gets the sort order of the column. Accepts: 'asc', 'desc', 'none' and null. */
|
|
19253
|
+
export declare type GridColumnSortOrder = 'asc' | 'desc' | 'none';
|
|
18788
19254
|
/**The formatting condition. */
|
|
18789
19255
|
export declare type GridConditionalFormattingCondition = 'between' | 'equal' | 'greaterThan' | 'lessThan' | 'notEqual';
|
|
18790
19256
|
/**Sets the page orientation, when exporting to PDF. */
|
|
@@ -18811,6 +19277,8 @@ export declare type GridFilteringFilterMenuMode = 'default' | 'excel';
|
|
|
18811
19277
|
export declare type GridGroupingExpandMode = 'buttonClick' | 'rowClick';
|
|
18812
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. */
|
|
18813
19279
|
export declare type GridGroupingRenderMode = 'basic' | 'compact' | 'advanced' | 'multipleColumns';
|
|
19280
|
+
/**Sets the search command type. */
|
|
19281
|
+
export declare type GridHeaderSearchCommand = 'search' | 'filter';
|
|
18814
19282
|
/**Sets the ellipsis display mode. */
|
|
18815
19283
|
export declare type GridPagerAutoEllipsis = 'none' | 'before' | 'after' | 'both';
|
|
18816
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' */
|
|
@@ -18844,6 +19312,11 @@ export interface GroupPanelProperties {
|
|
|
18844
19312
|
* Default value: false
|
|
18845
19313
|
*/
|
|
18846
19314
|
disabled?: boolean;
|
|
19315
|
+
/**
|
|
19316
|
+
* Sets or gets the unlockKey which unlocks the product.
|
|
19317
|
+
* Default value: ""
|
|
19318
|
+
*/
|
|
19319
|
+
unlockKey?: string;
|
|
18847
19320
|
/**
|
|
18848
19321
|
* Sets or gets the language. Used in conjunction with the property messages.
|
|
18849
19322
|
* Default value: "en"
|
|
@@ -18973,6 +19446,11 @@ export interface InputProperties {
|
|
|
18973
19446
|
* Default value: none
|
|
18974
19447
|
*/
|
|
18975
19448
|
dropDownButtonPosition?: DropDownButtonPosition | string;
|
|
19449
|
+
/**
|
|
19450
|
+
* Determines the position of the drop down when opened.
|
|
19451
|
+
* Default value: auto
|
|
19452
|
+
*/
|
|
19453
|
+
dropDownOpenPosition?: DropDownOpenPosition | string;
|
|
18976
19454
|
/**
|
|
18977
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.
|
|
18978
19456
|
* Default value:
|
|
@@ -18993,6 +19471,11 @@ export interface InputProperties {
|
|
|
18993
19471
|
* Default value: 8
|
|
18994
19472
|
*/
|
|
18995
19473
|
items?: number;
|
|
19474
|
+
/**
|
|
19475
|
+
* Sets or gets the unlockKey which unlocks the product.
|
|
19476
|
+
* Default value: ""
|
|
19477
|
+
*/
|
|
19478
|
+
unlockKey?: string;
|
|
18996
19479
|
/**
|
|
18997
19480
|
* Sets or gets the language. Used in conjunction with the property messages.
|
|
18998
19481
|
* Default value: "en"
|
|
@@ -19185,6 +19668,8 @@ declare global {
|
|
|
19185
19668
|
}
|
|
19186
19669
|
}
|
|
19187
19670
|
|
|
19671
|
+
/**Determines the position of the drop down when opened. */
|
|
19672
|
+
export declare type DropDownOpenPosition = 'auto' | 'top' | 'bottom';
|
|
19188
19673
|
/**Determines the auto complete query mode. This property also determines the matching algorithm for the autocomplete operation. */
|
|
19189
19674
|
export declare type InputQueryMode = 'contains' | 'containsIgnoreCase' | 'doesNotContain' | 'doesNotContainIgnoreCase' | 'equals' | 'equalsIgnoreCase' | 'startsWith' | 'startsWithIgnoreCase' | 'endsWith' | 'endsWithIgnoreCase';
|
|
19190
19675
|
export interface KanbanProperties {
|
|
@@ -19238,6 +19723,11 @@ export interface KanbanProperties {
|
|
|
19238
19723
|
* Default value: true
|
|
19239
19724
|
*/
|
|
19240
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;
|
|
19241
19731
|
/**
|
|
19242
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.
|
|
19243
19733
|
* Default value: false
|
|
@@ -19348,6 +19838,11 @@ export interface KanbanProperties {
|
|
|
19348
19838
|
* Default value: false
|
|
19349
19839
|
*/
|
|
19350
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;
|
|
19351
19846
|
/**
|
|
19352
19847
|
* Sets or gets the format string of the "Due date" label and the "Start date" and "Due date" editors.
|
|
19353
19848
|
* Default value: "d"
|
|
@@ -19368,6 +19863,11 @@ export interface KanbanProperties {
|
|
|
19368
19863
|
* Default value: columns
|
|
19369
19864
|
*/
|
|
19370
19865
|
hierarchy?: KanbanHierarchy | string;
|
|
19866
|
+
/**
|
|
19867
|
+
* Sets or gets the unlockKey which unlocks the product.
|
|
19868
|
+
* Default value: ""
|
|
19869
|
+
*/
|
|
19870
|
+
unlockKey?: string;
|
|
19371
19871
|
/**
|
|
19372
19872
|
* Sets or gets the locale. Used in conjunction with the property messages.
|
|
19373
19873
|
* Default value: "en"
|
|
@@ -20173,6 +20673,8 @@ export declare type KanbanAddNewButtonDisplayMode = 'top' | 'bottom' | 'both';
|
|
|
20173
20673
|
export declare type KanbanColumnOrientation = 'vertical' | 'horizontal';
|
|
20174
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. */
|
|
20175
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';
|
|
20176
20678
|
/**Sets or gets the header position. The header contains the Customize, Filter, Sort, and Search buttons. */
|
|
20177
20679
|
export declare type KanbanHeaderPosition = 'none' | 'top' | 'bottom';
|
|
20178
20680
|
/**Sets or gets the way column hierarchy is represented. */
|
|
@@ -20204,6 +20706,11 @@ export interface LayoutProperties {
|
|
|
20204
20706
|
* Default value: null
|
|
20205
20707
|
*/
|
|
20206
20708
|
dataSource?: any;
|
|
20709
|
+
/**
|
|
20710
|
+
* Sets or gets the unlockKey which unlocks the product.
|
|
20711
|
+
* Default value: ""
|
|
20712
|
+
*/
|
|
20713
|
+
unlockKey?: string;
|
|
20207
20714
|
/**
|
|
20208
20715
|
* Sets or gets the language. Used in conjunction with the property messages.
|
|
20209
20716
|
* Default value: "en"
|
|
@@ -20502,6 +21009,11 @@ export interface LedProperties {
|
|
|
20502
21009
|
* Default value: null
|
|
20503
21010
|
*/
|
|
20504
21011
|
indeterminateTemplate?: any;
|
|
21012
|
+
/**
|
|
21013
|
+
* Sets or gets the unlockKey which unlocks the product.
|
|
21014
|
+
* Default value: ""
|
|
21015
|
+
*/
|
|
21016
|
+
unlockKey?: string;
|
|
20505
21017
|
/**
|
|
20506
21018
|
* Sets or gets the language. Used in conjunction with the property messages.
|
|
20507
21019
|
* Default value: "en"
|
|
@@ -20753,6 +21265,11 @@ export interface ListBoxProperties {
|
|
|
20753
21265
|
* Default value: center
|
|
20754
21266
|
*/
|
|
20755
21267
|
loadingIndicatorPosition?: VerticalAlignment | string;
|
|
21268
|
+
/**
|
|
21269
|
+
* Sets or gets the unlockKey which unlocks the product.
|
|
21270
|
+
* Default value: ""
|
|
21271
|
+
*/
|
|
21272
|
+
unlockKey?: string;
|
|
20756
21273
|
/**
|
|
20757
21274
|
* Sets or gets the language. Used in conjunction with the property messages.
|
|
20758
21275
|
* Default value: "en"
|
|
@@ -20965,6 +21482,11 @@ export interface ListBox extends BaseElement, ListBoxProperties {
|
|
|
20965
21482
|
* @returns {Node}
|
|
20966
21483
|
*/
|
|
20967
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;
|
|
20968
21490
|
/**
|
|
20969
21491
|
* Removes all items from the listBox.
|
|
20970
21492
|
*/
|
|
@@ -20973,6 +21495,10 @@ export interface ListBox extends BaseElement, ListBoxProperties {
|
|
|
20973
21495
|
* Unselects all items.
|
|
20974
21496
|
*/
|
|
20975
21497
|
clearSelection(): void;
|
|
21498
|
+
/**
|
|
21499
|
+
* Performs a data bind. This can be used to refresh the data source.
|
|
21500
|
+
*/
|
|
21501
|
+
dataBind(): void;
|
|
20976
21502
|
/**
|
|
20977
21503
|
* Ensures the target item is visible by scrolling to it.
|
|
20978
21504
|
* @param {HTMLElement | string} item. A list item or value of the desired item to be visible.
|
|
@@ -21268,6 +21794,11 @@ export interface ListMenuProperties {
|
|
|
21268
21794
|
* Default value: center
|
|
21269
21795
|
*/
|
|
21270
21796
|
loadingIndicatorPosition?: VerticalAlignment | string;
|
|
21797
|
+
/**
|
|
21798
|
+
* Sets or gets the unlockKey which unlocks the product.
|
|
21799
|
+
* Default value: ""
|
|
21800
|
+
*/
|
|
21801
|
+
unlockKey?: string;
|
|
21271
21802
|
/**
|
|
21272
21803
|
* Sets or gets the language. Used in conjunction with the property messages.
|
|
21273
21804
|
* Default value: "en"
|
|
@@ -21568,6 +22099,11 @@ export interface MaskedTextBoxProperties {
|
|
|
21568
22099
|
* Default value: ""
|
|
21569
22100
|
*/
|
|
21570
22101
|
label?: string;
|
|
22102
|
+
/**
|
|
22103
|
+
* Sets or gets the unlockKey which unlocks the product.
|
|
22104
|
+
* Default value: ""
|
|
22105
|
+
*/
|
|
22106
|
+
unlockKey?: string;
|
|
21571
22107
|
/**
|
|
21572
22108
|
* Sets or gets the language. Used in conjunction with the property messages.
|
|
21573
22109
|
* Default value: "en"
|
|
@@ -21820,6 +22356,11 @@ export interface MenuProperties {
|
|
|
21820
22356
|
* Default value: "items"
|
|
21821
22357
|
*/
|
|
21822
22358
|
itemsMember?: string;
|
|
22359
|
+
/**
|
|
22360
|
+
* Sets or gets the unlockKey which unlocks the product.
|
|
22361
|
+
* Default value: ""
|
|
22362
|
+
*/
|
|
22363
|
+
unlockKey?: string;
|
|
21823
22364
|
/**
|
|
21824
22365
|
* Sets or gets the language. Used in conjunction with the property messages.
|
|
21825
22366
|
* Default value: "en"
|
|
@@ -22231,6 +22772,11 @@ export interface MultiColumnFilterPanelProperties {
|
|
|
22231
22772
|
* Default value: "Value"
|
|
22232
22773
|
*/
|
|
22233
22774
|
editorPlaceholder?: string;
|
|
22775
|
+
/**
|
|
22776
|
+
* Sets or gets the unlockKey which unlocks the product.
|
|
22777
|
+
* Default value: ""
|
|
22778
|
+
*/
|
|
22779
|
+
unlockKey?: string;
|
|
22234
22780
|
/**
|
|
22235
22781
|
* Sets or gets the language. Used in conjunction with the property messages.
|
|
22236
22782
|
* Default value: "en"
|
|
@@ -22402,6 +22948,11 @@ export interface MultiComboInputProperties {
|
|
|
22402
22948
|
* Default value: 8
|
|
22403
22949
|
*/
|
|
22404
22950
|
items?: number;
|
|
22951
|
+
/**
|
|
22952
|
+
* Sets or gets the unlockKey which unlocks the product.
|
|
22953
|
+
* Default value: ""
|
|
22954
|
+
*/
|
|
22955
|
+
unlockKey?: string;
|
|
22405
22956
|
/**
|
|
22406
22957
|
* Sets or gets the language. Used in conjunction with the property messages.
|
|
22407
22958
|
* Default value: "en"
|
|
@@ -22624,6 +23175,11 @@ export interface MultiInputProperties {
|
|
|
22624
23175
|
* Default value: 8
|
|
22625
23176
|
*/
|
|
22626
23177
|
items?: number;
|
|
23178
|
+
/**
|
|
23179
|
+
* Sets or gets the unlockKey which unlocks the product.
|
|
23180
|
+
* Default value: ""
|
|
23181
|
+
*/
|
|
23182
|
+
unlockKey?: string;
|
|
22627
23183
|
/**
|
|
22628
23184
|
* Sets or gets the language. Used in conjunction with the property messages.
|
|
22629
23185
|
* Default value: "en"
|
|
@@ -22854,6 +23410,11 @@ export interface MultilineTextBoxProperties {
|
|
|
22854
23410
|
* Default value: ""
|
|
22855
23411
|
*/
|
|
22856
23412
|
label?: string;
|
|
23413
|
+
/**
|
|
23414
|
+
* Sets or gets the unlockKey which unlocks the product.
|
|
23415
|
+
* Default value: ""
|
|
23416
|
+
*/
|
|
23417
|
+
unlockKey?: string;
|
|
22857
23418
|
/**
|
|
22858
23419
|
* Sets or gets the language. Used in conjunction with the property messages.
|
|
22859
23420
|
* Default value: "en"
|
|
@@ -23140,6 +23701,11 @@ export interface MultiSplitButtonProperties {
|
|
|
23140
23701
|
* Default value: center
|
|
23141
23702
|
*/
|
|
23142
23703
|
loadingIndicatorPosition?: VerticalAlignment | string;
|
|
23704
|
+
/**
|
|
23705
|
+
* Sets or gets the unlockKey which unlocks the product.
|
|
23706
|
+
* Default value: ""
|
|
23707
|
+
*/
|
|
23708
|
+
unlockKey?: string;
|
|
23143
23709
|
/**
|
|
23144
23710
|
* Sets or gets the language. Used in conjunction with the property messages.
|
|
23145
23711
|
* Default value: "en"
|
|
@@ -23341,6 +23907,11 @@ export interface NumberInputProperties {
|
|
|
23341
23907
|
* Default value: "off"
|
|
23342
23908
|
*/
|
|
23343
23909
|
inputPurpose?: string;
|
|
23910
|
+
/**
|
|
23911
|
+
* Sets or gets the unlockKey which unlocks the product.
|
|
23912
|
+
* Default value: ""
|
|
23913
|
+
*/
|
|
23914
|
+
unlockKey?: string;
|
|
23344
23915
|
/**
|
|
23345
23916
|
* Sets or gets the language. Used in conjunction with the property messages.
|
|
23346
23917
|
* Default value: "en"
|
|
@@ -23524,6 +24095,11 @@ export interface NumericTextBoxProperties {
|
|
|
23524
24095
|
* Default value: false
|
|
23525
24096
|
*/
|
|
23526
24097
|
leadingZeros?: boolean;
|
|
24098
|
+
/**
|
|
24099
|
+
* Sets or gets the unlockKey which unlocks the product.
|
|
24100
|
+
* Default value: ""
|
|
24101
|
+
*/
|
|
24102
|
+
unlockKey?: string;
|
|
23527
24103
|
/**
|
|
23528
24104
|
* Sets or gets the language. Used in conjunction with the property messages.
|
|
23529
24105
|
* Default value: "en"
|
|
@@ -23778,6 +24354,11 @@ export interface PagerProperties {
|
|
|
23778
24354
|
* Default value: false
|
|
23779
24355
|
*/
|
|
23780
24356
|
disabled?: boolean;
|
|
24357
|
+
/**
|
|
24358
|
+
* Sets or gets the unlockKey which unlocks the product.
|
|
24359
|
+
* Default value: ""
|
|
24360
|
+
*/
|
|
24361
|
+
unlockKey?: string;
|
|
23781
24362
|
/**
|
|
23782
24363
|
* Sets or gets the language. Used in conjunction with the property messages.
|
|
23783
24364
|
* Default value: "en"
|
|
@@ -23962,6 +24543,11 @@ export interface PasswordInputProperties {
|
|
|
23962
24543
|
* Default value: false
|
|
23963
24544
|
*/
|
|
23964
24545
|
disabled?: boolean;
|
|
24546
|
+
/**
|
|
24547
|
+
* Sets or gets the unlockKey which unlocks the product.
|
|
24548
|
+
* Default value: ""
|
|
24549
|
+
*/
|
|
24550
|
+
unlockKey?: string;
|
|
23965
24551
|
/**
|
|
23966
24552
|
* Sets or gets the language. Used in conjunction with the property messages.
|
|
23967
24553
|
* Default value: "en"
|
|
@@ -24098,6 +24684,11 @@ export interface PasswordTextBoxProperties {
|
|
|
24098
24684
|
* Default value: ""
|
|
24099
24685
|
*/
|
|
24100
24686
|
label?: string;
|
|
24687
|
+
/**
|
|
24688
|
+
* Sets or gets the unlockKey which unlocks the product.
|
|
24689
|
+
* Default value: ""
|
|
24690
|
+
*/
|
|
24691
|
+
unlockKey?: string;
|
|
24101
24692
|
/**
|
|
24102
24693
|
* Sets or gets the language. Used in conjunction with the property messages.
|
|
24103
24694
|
* Default value: "en"
|
|
@@ -24347,6 +24938,11 @@ export interface PathProperties {
|
|
|
24347
24938
|
* Default value: ""
|
|
24348
24939
|
*/
|
|
24349
24940
|
label?: string;
|
|
24941
|
+
/**
|
|
24942
|
+
* Sets or gets the unlockKey which unlocks the product.
|
|
24943
|
+
* Default value: ""
|
|
24944
|
+
*/
|
|
24945
|
+
unlockKey?: string;
|
|
24350
24946
|
/**
|
|
24351
24947
|
* Sets or gets the language. Used in conjunction with the property messages.
|
|
24352
24948
|
* Default value: "en"
|
|
@@ -24523,6 +25119,11 @@ export interface PhoneInputProperties {
|
|
|
24523
25119
|
* Default value: * [object Object]
|
|
24524
25120
|
*/
|
|
24525
25121
|
messages?: any;
|
|
25122
|
+
/**
|
|
25123
|
+
* Sets or gets the unlockKey which unlocks the product.
|
|
25124
|
+
* Default value: ""
|
|
25125
|
+
*/
|
|
25126
|
+
unlockKey?: string;
|
|
24526
25127
|
/**
|
|
24527
25128
|
* Sets or gets the name attribute for the element. Name is used when submiting data inside an HTML form.
|
|
24528
25129
|
* Default value: ""
|
|
@@ -24780,6 +25381,11 @@ export interface PivotTableProperties {
|
|
|
24780
25381
|
* Default value: false
|
|
24781
25382
|
*/
|
|
24782
25383
|
keyboardNavigation?: boolean;
|
|
25384
|
+
/**
|
|
25385
|
+
* Sets or gets the unlockKey which unlocks the product.
|
|
25386
|
+
* Default value: ""
|
|
25387
|
+
*/
|
|
25388
|
+
unlockKey?: string;
|
|
24783
25389
|
/**
|
|
24784
25390
|
* Sets or gets the language. Used in conjunction with the property messages.
|
|
24785
25391
|
* Default value: "en"
|
|
@@ -25198,6 +25804,11 @@ export interface PowerButtonProperties {
|
|
|
25198
25804
|
* Default value: false
|
|
25199
25805
|
*/
|
|
25200
25806
|
disabled?: boolean;
|
|
25807
|
+
/**
|
|
25808
|
+
* Sets or gets the unlockKey which unlocks the product.
|
|
25809
|
+
* Default value: ""
|
|
25810
|
+
*/
|
|
25811
|
+
unlockKey?: string;
|
|
25201
25812
|
/**
|
|
25202
25813
|
* Sets or gets the language. Used in conjunction with the property messages.
|
|
25203
25814
|
* Default value: "en"
|
|
@@ -25299,6 +25910,11 @@ export interface ProgressBarProperties {
|
|
|
25299
25910
|
* Default value: null
|
|
25300
25911
|
*/
|
|
25301
25912
|
formatFunction?: {(value: number): string};
|
|
25913
|
+
/**
|
|
25914
|
+
* Sets or gets the unlockKey which unlocks the product.
|
|
25915
|
+
* Default value: ""
|
|
25916
|
+
*/
|
|
25917
|
+
unlockKey?: string;
|
|
25302
25918
|
/**
|
|
25303
25919
|
* Sets or gets the language. Used in conjunction with the property messages.
|
|
25304
25920
|
* Default value: "en"
|
|
@@ -25612,6 +26228,11 @@ export interface QueryBuilderProperties {
|
|
|
25612
26228
|
* Default value: { '=': 'equals', '<>': 'notequals', '>': 'greaterthan', '>=': 'greaterthanorequal', '<': 'lessthan', '<=': 'lessthanorequal', 'startswith': 'startswith', 'endswith': 'endswith', 'contains': 'contains', 'notcontains': 'notcontains', 'isblank': 'isblank', 'isnotblank': 'isnotblank' }
|
|
25613
26229
|
*/
|
|
25614
26230
|
icons?: any;
|
|
26231
|
+
/**
|
|
26232
|
+
* Sets or gets the unlockKey which unlocks the product.
|
|
26233
|
+
* Default value: ""
|
|
26234
|
+
*/
|
|
26235
|
+
unlockKey?: string;
|
|
25615
26236
|
/**
|
|
25616
26237
|
* Sets or gets the language. Used in conjunction with the property messages.
|
|
25617
26238
|
* Default value: "en"
|
|
@@ -25931,6 +26552,11 @@ export interface RadioButtonProperties {
|
|
|
25931
26552
|
* Default value: """"
|
|
25932
26553
|
*/
|
|
25933
26554
|
innerHTML: string;
|
|
26555
|
+
/**
|
|
26556
|
+
* Sets or gets the unlockKey which unlocks the product.
|
|
26557
|
+
* Default value: ""
|
|
26558
|
+
*/
|
|
26559
|
+
unlockKey?: string;
|
|
25934
26560
|
/**
|
|
25935
26561
|
* Sets or gets the language. Used in conjunction with the property messages.
|
|
25936
26562
|
* Default value: "en"
|
|
@@ -26038,6 +26664,11 @@ export interface RatingProperties {
|
|
|
26038
26664
|
* Default value: false
|
|
26039
26665
|
*/
|
|
26040
26666
|
disabled?: boolean;
|
|
26667
|
+
/**
|
|
26668
|
+
* Sets or gets the unlockKey which unlocks the product.
|
|
26669
|
+
* Default value: ""
|
|
26670
|
+
*/
|
|
26671
|
+
unlockKey?: string;
|
|
26041
26672
|
/**
|
|
26042
26673
|
* Sets or gets the language. Used in conjunction with the property messages.
|
|
26043
26674
|
* Default value: "en"
|
|
@@ -26162,6 +26793,11 @@ export interface RepeatButtonProperties {
|
|
|
26162
26793
|
* Default value: """"
|
|
26163
26794
|
*/
|
|
26164
26795
|
innerHTML: string;
|
|
26796
|
+
/**
|
|
26797
|
+
* Sets or gets the unlockKey which unlocks the product.
|
|
26798
|
+
* Default value: ""
|
|
26799
|
+
*/
|
|
26800
|
+
unlockKey?: string;
|
|
26165
26801
|
/**
|
|
26166
26802
|
* Sets or gets the language. Used in conjunction with the property messages.
|
|
26167
26803
|
* Default value: "en"
|
|
@@ -26237,6 +26873,433 @@ declare global {
|
|
|
26237
26873
|
}
|
|
26238
26874
|
}
|
|
26239
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
|
+
|
|
26240
27303
|
export interface SchedulerProperties {
|
|
26241
27304
|
/**
|
|
26242
27305
|
* Determines the scroll speed while dragging an event.
|
|
@@ -26543,6 +27606,11 @@ export interface SchedulerProperties {
|
|
|
26543
27606
|
* Default value: auto
|
|
26544
27607
|
*/
|
|
26545
27608
|
horizontalScrollBarVisibility?: HorizontalScrollBarVisibility | string;
|
|
27609
|
+
/**
|
|
27610
|
+
* Sets or gets the unlockKey which unlocks the product.
|
|
27611
|
+
* Default value: ""
|
|
27612
|
+
*/
|
|
27613
|
+
unlockKey?: string;
|
|
26546
27614
|
/**
|
|
26547
27615
|
* Determines the language of the Scheduler.
|
|
26548
27616
|
* Default value: "en"
|
|
@@ -27090,9 +28158,10 @@ export interface Scheduler extends BaseElement, SchedulerProperties {
|
|
|
27090
28158
|
/**
|
|
27091
28159
|
* Exports the events from the Scheduler.
|
|
27092
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>
|
|
27093
|
-
* @param {any} callback?. A callback that allows to format the exported data based on a condition. For additional details, refer
|
|
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.
|
|
27094
28163
|
*/
|
|
27095
|
-
exportData(dataFormat: string, callback?: any): void;
|
|
28164
|
+
exportData(dataFormat: string, callback?: any, dataCallback?: any): void;
|
|
27096
28165
|
/**
|
|
27097
28166
|
* Returns a JSON representation of the events inside the Scheduler.
|
|
27098
28167
|
* @returns {any}
|
|
@@ -27602,6 +28671,11 @@ export interface ScrollBarProperties {
|
|
|
27602
28671
|
* Default value: 100
|
|
27603
28672
|
*/
|
|
27604
28673
|
largeStep?: number;
|
|
28674
|
+
/**
|
|
28675
|
+
* Sets or gets the unlockKey which unlocks the product.
|
|
28676
|
+
* Default value: ""
|
|
28677
|
+
*/
|
|
28678
|
+
unlockKey?: string;
|
|
27605
28679
|
/**
|
|
27606
28680
|
* Sets or gets the language. Used in conjunction with the property messages.
|
|
27607
28681
|
* Default value: "en"
|
|
@@ -27777,6 +28851,11 @@ export interface SliderProperties {
|
|
|
27777
28851
|
* Default value: all
|
|
27778
28852
|
*/
|
|
27779
28853
|
labelsVisibility?: LabelsVisibility | string;
|
|
28854
|
+
/**
|
|
28855
|
+
* Sets or gets the unlockKey which unlocks the product.
|
|
28856
|
+
* Default value: ""
|
|
28857
|
+
*/
|
|
28858
|
+
unlockKey?: string;
|
|
27780
28859
|
/**
|
|
27781
28860
|
* Sets or gets the locale. Used in conjunction with the property messages.
|
|
27782
28861
|
* Default value: "en"
|
|
@@ -28031,6 +29110,11 @@ export interface SortableProperties {
|
|
|
28031
29110
|
* Default value: null
|
|
28032
29111
|
*/
|
|
28033
29112
|
items?: string | null;
|
|
29113
|
+
/**
|
|
29114
|
+
* Sets or gets the unlockKey which unlocks the product.
|
|
29115
|
+
* Default value: ""
|
|
29116
|
+
*/
|
|
29117
|
+
unlockKey?: string;
|
|
28034
29118
|
/**
|
|
28035
29119
|
* Sets or gets the language. Used in conjunction with the property messages.
|
|
28036
29120
|
* Default value: "en"
|
|
@@ -28131,6 +29215,11 @@ export interface SortPanelProperties {
|
|
|
28131
29215
|
* Default value: false
|
|
28132
29216
|
*/
|
|
28133
29217
|
disabled?: boolean;
|
|
29218
|
+
/**
|
|
29219
|
+
* Sets or gets the unlockKey which unlocks the product.
|
|
29220
|
+
* Default value: ""
|
|
29221
|
+
*/
|
|
29222
|
+
unlockKey?: string;
|
|
28134
29223
|
/**
|
|
28135
29224
|
* Sets or gets the language. Used in conjunction with the property messages.
|
|
28136
29225
|
* Default value: "en"
|
|
@@ -28245,6 +29334,11 @@ export interface SplitterProperties {
|
|
|
28245
29334
|
* Default value: false
|
|
28246
29335
|
*/
|
|
28247
29336
|
keepProportionsOnResize?: boolean;
|
|
29337
|
+
/**
|
|
29338
|
+
* Sets or gets the unlockKey which unlocks the product.
|
|
29339
|
+
* Default value: ""
|
|
29340
|
+
*/
|
|
29341
|
+
unlockKey?: string;
|
|
28248
29342
|
/**
|
|
28249
29343
|
* Sets or gets the language. Used in conjunction with the property messages.
|
|
28250
29344
|
* Default value: "en"
|
|
@@ -28600,6 +29694,11 @@ export interface SwitchButtonProperties {
|
|
|
28600
29694
|
* Default value: false
|
|
28601
29695
|
*/
|
|
28602
29696
|
inverted?: boolean;
|
|
29697
|
+
/**
|
|
29698
|
+
* Sets or gets the unlockKey which unlocks the product.
|
|
29699
|
+
* Default value: ""
|
|
29700
|
+
*/
|
|
29701
|
+
unlockKey?: string;
|
|
28603
29702
|
/**
|
|
28604
29703
|
* Sets or gets the language. Used in conjunction with the property messages.
|
|
28605
29704
|
* Default value: "en"
|
|
@@ -29108,6 +30207,11 @@ export interface TableProperties {
|
|
|
29108
30207
|
* Default value: implementationOnly
|
|
29109
30208
|
*/
|
|
29110
30209
|
loadColumnStateBehavior?: TableLoadColumnStateBehavior | string;
|
|
30210
|
+
/**
|
|
30211
|
+
* Sets or gets the unlockKey which unlocks the product.
|
|
30212
|
+
* Default value: ""
|
|
30213
|
+
*/
|
|
30214
|
+
unlockKey?: string;
|
|
29111
30215
|
/**
|
|
29112
30216
|
* Sets or gets the language. Used in conjunction with the property messages.
|
|
29113
30217
|
* Default value: "en"
|
|
@@ -29202,7 +30306,7 @@ export interface TableProperties {
|
|
|
29202
30306
|
* Sets or gets the page size (when paging is enabled).
|
|
29203
30307
|
* Default value: 10
|
|
29204
30308
|
*/
|
|
29205
|
-
pageSize?:
|
|
30309
|
+
pageSize?: number;
|
|
29206
30310
|
/**
|
|
29207
30311
|
* Sets or gets the current (zero-based) page index (when paging is enabled).
|
|
29208
30312
|
* Default value: 0
|
|
@@ -29223,6 +30327,11 @@ export interface TableProperties {
|
|
|
29223
30327
|
* Default value: "null"
|
|
29224
30328
|
*/
|
|
29225
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;
|
|
29226
30335
|
/**
|
|
29227
30336
|
* Sets or gets an array of the Table's selected row's ids.
|
|
29228
30337
|
* Default value:
|
|
@@ -29940,8 +31049,6 @@ export declare type TableDataSourceSettingsDataSourceType = 'array' | 'json' | '
|
|
|
29940
31049
|
export declare type TableEditMode = 'cell' | 'row';
|
|
29941
31050
|
/**Sets or gets the behavior when loading column settings either via autoLoadState or loadState. Applicable only when stateSettings contains 'columns'. */
|
|
29942
31051
|
export declare type TableLoadColumnStateBehavior = 'implementationOnly' | 'intersection' | 'stateOnly';
|
|
29943
|
-
/**Sets or gets the page size (when paging is enabled). */
|
|
29944
|
-
export declare type TablePageSize = '10' | '25' | '50';
|
|
29945
31052
|
/**Sets or gets the selection mode. Only applicable when selection is enabled. */
|
|
29946
31053
|
export declare type TableSelectionMode = 'one' | 'many' | 'extended';
|
|
29947
31054
|
/**Determines the sorting mode of the Table. */
|
|
@@ -29997,6 +31104,11 @@ export interface TabsProperties {
|
|
|
29997
31104
|
* Default value: false
|
|
29998
31105
|
*/
|
|
29999
31106
|
enableMouseWheelAction?: boolean;
|
|
31107
|
+
/**
|
|
31108
|
+
* Sets or gets the unlockKey which unlocks the product.
|
|
31109
|
+
* Default value: ""
|
|
31110
|
+
*/
|
|
31111
|
+
unlockKey?: string;
|
|
30000
31112
|
/**
|
|
30001
31113
|
* Sets or gets the locale. Used in conjunction with the property messages.
|
|
30002
31114
|
* Default value: "en"
|
|
@@ -30300,6 +31412,11 @@ export interface TankProperties {
|
|
|
30300
31412
|
* Default value: all
|
|
30301
31413
|
*/
|
|
30302
31414
|
labelsVisibility?: LabelsVisibility | string;
|
|
31415
|
+
/**
|
|
31416
|
+
* Sets or gets the unlockKey which unlocks the product.
|
|
31417
|
+
* Default value: ""
|
|
31418
|
+
*/
|
|
31419
|
+
unlockKey?: string;
|
|
30303
31420
|
/**
|
|
30304
31421
|
* Sets or gets the locale. Used in conjunction with the property messages.
|
|
30305
31422
|
* Default value: "en"
|
|
@@ -30549,6 +31666,11 @@ export interface TextAreaProperties {
|
|
|
30549
31666
|
* Default value: 8
|
|
30550
31667
|
*/
|
|
30551
31668
|
items?: number;
|
|
31669
|
+
/**
|
|
31670
|
+
* Sets or gets the unlockKey which unlocks the product.
|
|
31671
|
+
* Default value: ""
|
|
31672
|
+
*/
|
|
31673
|
+
unlockKey?: string;
|
|
30552
31674
|
/**
|
|
30553
31675
|
* Sets or gets the language. Used in conjunction with the property messages.
|
|
30554
31676
|
* Default value: "en"
|
|
@@ -30621,6 +31743,11 @@ export interface TextAreaProperties {
|
|
|
30621
31743
|
* Default value: false
|
|
30622
31744
|
*/
|
|
30623
31745
|
rightToLeft?: boolean;
|
|
31746
|
+
/**
|
|
31747
|
+
* Enables or disables the rich text formatting.
|
|
31748
|
+
* Default value: false
|
|
31749
|
+
*/
|
|
31750
|
+
richText?: boolean;
|
|
30624
31751
|
/**
|
|
30625
31752
|
* Determines whether the items are sorted alphabetically or not
|
|
30626
31753
|
* Default value: false
|
|
@@ -30888,6 +32015,11 @@ export interface TextBoxProperties {
|
|
|
30888
32015
|
* Default value: center
|
|
30889
32016
|
*/
|
|
30890
32017
|
loadingIndicatorPosition?: VerticalAlignment | string;
|
|
32018
|
+
/**
|
|
32019
|
+
* Sets or gets the unlockKey which unlocks the product.
|
|
32020
|
+
* Default value: ""
|
|
32021
|
+
*/
|
|
32022
|
+
unlockKey?: string;
|
|
30891
32023
|
/**
|
|
30892
32024
|
* Sets or gets the language. Used in conjunction with the property messages.
|
|
30893
32025
|
* Default value: "en"
|
|
@@ -31075,6 +32207,11 @@ export interface TimeInputProperties {
|
|
|
31075
32207
|
* Default value: "off"
|
|
31076
32208
|
*/
|
|
31077
32209
|
inputPurpose?: string;
|
|
32210
|
+
/**
|
|
32211
|
+
* Sets or gets the unlockKey which unlocks the product.
|
|
32212
|
+
* Default value: ""
|
|
32213
|
+
*/
|
|
32214
|
+
unlockKey?: string;
|
|
31078
32215
|
/**
|
|
31079
32216
|
* Sets or gets the language. Used in conjunction with the property messages.
|
|
31080
32217
|
* Default value: "en"
|
|
@@ -31214,6 +32351,62 @@ declare global {
|
|
|
31214
32351
|
export declare type TimeFormatHour = 'numeric' | '2-digit';
|
|
31215
32352
|
/**Minute format. */
|
|
31216
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
|
+
|
|
31217
32410
|
export interface TimePickerProperties {
|
|
31218
32411
|
/**
|
|
31219
32412
|
* Sets or gets the animation mode. Animation is disabled when the property is set to 'none'
|
|
@@ -31245,6 +32438,11 @@ export interface TimePickerProperties {
|
|
|
31245
32438
|
* Default value: 12-hour
|
|
31246
32439
|
*/
|
|
31247
32440
|
format?: TimePickerFormat | string;
|
|
32441
|
+
/**
|
|
32442
|
+
* Sets or gets the unlockKey which unlocks the product.
|
|
32443
|
+
* Default value: ""
|
|
32444
|
+
*/
|
|
32445
|
+
unlockKey?: string;
|
|
31248
32446
|
/**
|
|
31249
32447
|
* Sets or gets the language. Used in conjunction with the property messages.
|
|
31250
32448
|
* Default value: "en"
|
|
@@ -31403,6 +32601,11 @@ export interface ToastProperties {
|
|
|
31403
32601
|
* Default value: "null"
|
|
31404
32602
|
*/
|
|
31405
32603
|
itemTemplate?: string;
|
|
32604
|
+
/**
|
|
32605
|
+
* Sets or gets the unlockKey which unlocks the product.
|
|
32606
|
+
* Default value: ""
|
|
32607
|
+
*/
|
|
32608
|
+
unlockKey?: string;
|
|
31406
32609
|
/**
|
|
31407
32610
|
* Sets or gets the language. Used in conjunction with the property messages.
|
|
31408
32611
|
* Default value: "en"
|
|
@@ -31572,6 +32775,11 @@ export interface ToggleButtonProperties {
|
|
|
31572
32775
|
* Default value: """"
|
|
31573
32776
|
*/
|
|
31574
32777
|
innerHTML: string;
|
|
32778
|
+
/**
|
|
32779
|
+
* Sets or gets the unlockKey which unlocks the product.
|
|
32780
|
+
* Default value: ""
|
|
32781
|
+
*/
|
|
32782
|
+
unlockKey?: string;
|
|
31575
32783
|
/**
|
|
31576
32784
|
* Sets or gets the language. Used in conjunction with the property messages.
|
|
31577
32785
|
* Default value: "en"
|
|
@@ -31699,6 +32907,11 @@ export interface TooltipProperties {
|
|
|
31699
32907
|
* Default value: 0,0
|
|
31700
32908
|
*/
|
|
31701
32909
|
offset?: number[];
|
|
32910
|
+
/**
|
|
32911
|
+
* Sets or gets the unlockKey which unlocks the product.
|
|
32912
|
+
* Default value: ""
|
|
32913
|
+
*/
|
|
32914
|
+
unlockKey?: string;
|
|
31702
32915
|
/**
|
|
31703
32916
|
* Sets or gets the language. Used in conjunction with the property messages.
|
|
31704
32917
|
* Default value: "en"
|
|
@@ -31944,6 +33157,11 @@ export interface TreeProperties {
|
|
|
31944
33157
|
* Default value: center
|
|
31945
33158
|
*/
|
|
31946
33159
|
loadingIndicatorPosition?: VerticalAlignment | string;
|
|
33160
|
+
/**
|
|
33161
|
+
* Sets or gets the unlockKey which unlocks the product.
|
|
33162
|
+
* Default value: ""
|
|
33163
|
+
*/
|
|
33164
|
+
unlockKey?: string;
|
|
31947
33165
|
/**
|
|
31948
33166
|
* Sets or gets the locale. Used in conjunction with the property messages.
|
|
31949
33167
|
* Default value: "en"
|
|
@@ -32149,6 +33367,12 @@ export interface Tree extends BaseElement, TreeProperties {
|
|
|
32149
33367
|
* children - the children of the jqx-tree-items-group to be expanded
|
|
32150
33368
|
*/
|
|
32151
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;
|
|
32152
33376
|
/**
|
|
32153
33377
|
* This event is triggered when the Tree has been scrolled to the bottom.
|
|
32154
33378
|
* @param event. The custom event. */
|
|
@@ -32225,6 +33449,11 @@ export interface Tree extends BaseElement, TreeProperties {
|
|
|
32225
33449
|
* @returns {HTMLElement}
|
|
32226
33450
|
*/
|
|
32227
33451
|
getItem(id: string): HTMLElement;
|
|
33452
|
+
/**
|
|
33453
|
+
* Gets the applied filter.
|
|
33454
|
+
* @returns {string}
|
|
33455
|
+
*/
|
|
33456
|
+
getFilter(): string;
|
|
32228
33457
|
/**
|
|
32229
33458
|
* Gets the selected values. If value is not defined, returns the selected labels.
|
|
32230
33459
|
* @returns {string[]}
|
|
@@ -32676,6 +33905,11 @@ export interface WindowProperties {
|
|
|
32676
33905
|
* Default value: null
|
|
32677
33906
|
*/
|
|
32678
33907
|
layout?: any;
|
|
33908
|
+
/**
|
|
33909
|
+
* Sets or gets the unlockKey which unlocks the product.
|
|
33910
|
+
* Default value: ""
|
|
33911
|
+
*/
|
|
33912
|
+
unlockKey?: string;
|
|
32679
33913
|
/**
|
|
32680
33914
|
* Sets or gets the language. Used in conjunction with the property messages.
|
|
32681
33915
|
* Default value: "en"
|