@smart-webcomponents-angular/passwordtextbox 15.0.2 → 19.0.8
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/esm2020/passwordtextbox/smart.passwordtextbox.mjs +1 -1
- package/fesm2015/smart-webcomponents-angular-passwordtextbox.mjs.map +1 -1
- package/fesm2020/smart-webcomponents-angular-passwordtextbox.mjs.map +1 -1
- package/index.d.ts +1274 -425
- package/package.json +19 -19
- package/passwordtextbox/smart-webcomponents-angular-passwordtextbox.d.ts +1 -1
- package/source/modules/smart.passwordtextbox.js +2 -2
- package/source/smart.button.js +1 -1
- package/source/smart.element.js +2 -2
- package/source/smart.input.js +2 -2
- package/source/smart.passwordtextbox.js +1 -1
- package/source/smart.tooltip.js +1 -1
- package/styles/font/smart-icons.eot +0 -0
- package/styles/font/smart-icons.svg +29 -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.passwordtextbox.css +2 -2
- package/demo/angular.json +0 -127
- package/demo/package.json +0 -53
- package/demo/src/app/app.component.css +0 -0
- package/demo/src/app/app.component.html +0 -2
- package/demo/src/assets/fonts.css +0 -13
- package/demo/src/assets/styles.css +0 -12
- package/demo/src/index.html +0 -42
- package/demo/src/tsconfig.app.json +0 -15
- package/demo/src/tsconfig.json +0 -23
- package/start.js +0 -5
package/index.d.ts
CHANGED
|
@@ -169,6 +169,11 @@ export interface ThreeDChartProperties {
|
|
|
169
169
|
* Default value: null
|
|
170
170
|
*/
|
|
171
171
|
toolTipFormatFunction?: {(value?: any, index?: number, series?: any): string};
|
|
172
|
+
/**
|
|
173
|
+
* Tooltip data formatting settings for the values in the serie.
|
|
174
|
+
* Default value: [object Object]
|
|
175
|
+
*/
|
|
176
|
+
toolTipFormatSettings?: ThreeDChartFormatSettings;
|
|
172
177
|
/**
|
|
173
178
|
* Tooltip line color. By default it is set to the hovered item's color
|
|
174
179
|
* Default value: null
|
|
@@ -1896,6 +1901,16 @@ export interface BarcodeProperties {
|
|
|
1896
1901
|
* Default value: ""
|
|
1897
1902
|
*/
|
|
1898
1903
|
value?: string;
|
|
1904
|
+
/**
|
|
1905
|
+
* Sets or gets the width of the barcode. If the width is set to 0, the width of the barcode is calculated automatically.
|
|
1906
|
+
* Default value: 0
|
|
1907
|
+
*/
|
|
1908
|
+
width?: number;
|
|
1909
|
+
/**
|
|
1910
|
+
* Sets or gets the height of the barcode. If the height is set to 0, the height of the barcode is calculated automatically.
|
|
1911
|
+
* Default value: 0
|
|
1912
|
+
*/
|
|
1913
|
+
height?: number;
|
|
1899
1914
|
}
|
|
1900
1915
|
/**
|
|
1901
1916
|
Barcodes encodes text value in a specific pattern.
|
|
@@ -2354,6 +2369,11 @@ export interface CalendarProperties {
|
|
|
2354
2369
|
* Default value: false
|
|
2355
2370
|
*/
|
|
2356
2371
|
disableAutoNavigation?: boolean;
|
|
2372
|
+
/**
|
|
2373
|
+
* Enables or disables the Calendar mouse wheel behavior.
|
|
2374
|
+
* Default value: false
|
|
2375
|
+
*/
|
|
2376
|
+
disableMouseWheel?: boolean;
|
|
2357
2377
|
/**
|
|
2358
2378
|
* Determines the date view of the calendar when calendarMode is set to 'default'
|
|
2359
2379
|
* Default value: month
|
|
@@ -7180,6 +7200,11 @@ export interface ComboBox extends BaseElement, ComboBoxProperties {
|
|
|
7180
7200
|
* @returns {Node}
|
|
7181
7201
|
*/
|
|
7182
7202
|
appendChild<T extends Node>(node: Node): T;
|
|
7203
|
+
/**
|
|
7204
|
+
* Adds a new item(s).
|
|
7205
|
+
* @param {any} item. Describes the properties of the item that will be inserted. You can also pass an array of items.
|
|
7206
|
+
*/
|
|
7207
|
+
add(item: any): void;
|
|
7183
7208
|
/**
|
|
7184
7209
|
* Removes all items from the drop down list.
|
|
7185
7210
|
*/
|
|
@@ -7192,6 +7217,10 @@ export interface ComboBox extends BaseElement, ComboBoxProperties {
|
|
|
7192
7217
|
* Closes the dropDown list.
|
|
7193
7218
|
*/
|
|
7194
7219
|
close(): void;
|
|
7220
|
+
/**
|
|
7221
|
+
* Performs a data bind. This can be used to refresh the data source.
|
|
7222
|
+
*/
|
|
7223
|
+
dataBind(): void;
|
|
7195
7224
|
/**
|
|
7196
7225
|
* Ensures the desired item is visible by scrolling to it.
|
|
7197
7226
|
* @param {HTMLElement | string} item. A list item or value of the desired item to be visible.
|
|
@@ -7206,7 +7235,7 @@ export interface ComboBox extends BaseElement, ComboBoxProperties {
|
|
|
7206
7235
|
/**
|
|
7207
7236
|
* Inserts a new item at a specified position.
|
|
7208
7237
|
* @param {number} position. The position where the item must be inserted.
|
|
7209
|
-
* @param {any} item. Describes the properties of the item that will be inserted.
|
|
7238
|
+
* @param {any} item. Describes the properties of the item that will be inserted. You can also pass an array of items.
|
|
7210
7239
|
*/
|
|
7211
7240
|
insert(position: number, item: any): void;
|
|
7212
7241
|
/**
|
|
@@ -7940,6 +7969,11 @@ export interface DateInputProperties {
|
|
|
7940
7969
|
* Default value: 500
|
|
7941
7970
|
*/
|
|
7942
7971
|
autoCloseDelay?: number;
|
|
7972
|
+
/**
|
|
7973
|
+
* Determines the calendar properties to be set to the popup calendar.
|
|
7974
|
+
* Default value: null
|
|
7975
|
+
*/
|
|
7976
|
+
calendarProperties?: any;
|
|
7943
7977
|
/**
|
|
7944
7978
|
* Determines the format of the dates displayed in the input. Accepts valid ECMAScript Internationalization API format. Intl.DateTimeFormat is used to format date strings in JavaScript. By default the date format is 'numeric'. The default value is: { day: 'numeric', month: 'numeric', year: 'numeric' }
|
|
7945
7979
|
* Default value: { day: 'numeric', month: 'numeric', year: 'numeric' }
|
|
@@ -8773,7 +8807,7 @@ export interface DockingLayoutProperties {
|
|
|
8773
8807
|
*/
|
|
8774
8808
|
closedItems?: any;
|
|
8775
8809
|
/**
|
|
8776
|
-
* Determines the structure of the element. This property represents an array of objects that define the hierarchy of the items inside the element and their specific settings. Each object must have a type attribute that defines it's behavior. Three types of objects are allowed: LayoutGroup - Represents a group of items (Splitter). Used when the user wants more than one DockingLayout item in a single container. Properties: orientation - A string value indicating the orientation of the Splitter group. Possible values: 'horizontal', 'vertical'. size - A string | number value indicating the size of the Splitter group. items - An array of LayoutPanel object definitions. resizeMode - A string indicating the resize mode. Possible values: 'none', 'adjacent', 'end', 'proportional'. resizeStep - A nummeric value that determines the step of resizing. liveResize - Determines if splitter resizing happens while dragging or not. LayoutPanel - Represents a DockingLayout item (TabsWindow). LayoutPanels can have one or many items (TabItem). Properties: id - the ID of the LayoutPanel. autoHide - a boolean property that determines if the LayoutPanel is autoHidden. autoHidePosition - determines the autoHide position of the item if 'autoHide' property is set. Possible values: 'top', 'bottom', 'left', 'right'. dropPosition - Determines the possible positions for the item at which a new item can be dropped as a result of dragging. Possible values: 'top', 'bottom', 'left', 'right', 'center', 'header', 'layout-top', 'layout-bottom', 'layout-left', 'layout-right'. Positions with the 'layout' prefix reflect on LayoutPanelItems that are children of the LayoutPanel. label - the Label of the LayoutPanel window. tabPosition - Determines the position of the Tab labels inside the LayoutPanel. layout - determines the DockingLayout owner of the LayoutPanel. Accepts a string indicating the ID of a DockingLayout on the page or a direct reference to it. headerButtons - an Array of strings that define the buttons in the header section of the DockingLayout item. tabCloseButtons - a boolean property that Enables or disables the close buttons inside each Tab item label inside the DockingLayout item. tabOverflow - same as 'overflow' property of jqxTabs. It defines the overflow mode of the labels of the Tab items inside a DockingLayout item.selectionMode - the same as jqxTabs selection modes. Applies to Tab items inside a DockingLayout item. tabResize - the same as 'resize' property of jqxTabs. Allows resizing the Tab labels inside the DockingLayout item. locked - Locks the size of the item and does not allow resizing. max - sets the maximum size of the item. min - sets the minimum size of the item size - sets the size of the item. items - an array of objects. Each object defines the structure of a LayoutPanelItem. LayoutPanelItem - Represents a LayoutPanel item (TabItem). Properties: id - the ID of the Tab item. label - a string representing the label of the Tab item. content - represents the content of the Tab item. Can be anything. selected - determines if the item is selected. By default the first added item to the LayoutPanel is automatically selected. draggable - a boolean property that allows to disable the dragging of the Tab item.
|
|
8810
|
+
* Determines the structure of the element. This property represents an array of objects that define the hierarchy of the items inside the element and their specific settings. Each object must have a type attribute that defines it's behavior. Three types of objects are allowed: LayoutGroup - Represents a group of items (Splitter). Used when the user wants more than one DockingLayout item in a single container. Properties: orientation - A string value indicating the orientation of the Splitter group. Possible values: 'horizontal', 'vertical'. size - A string | number value indicating the size of the Splitter group. items - An array of LayoutPanel object definitions. resizeMode - A string indicating the resize mode. Possible values: 'none', 'adjacent', 'end', 'proportional'. resizeStep - A nummeric value that determines the step of resizing. liveResize - Determines if splitter resizing happens while dragging or not. LayoutPanel - Represents a DockingLayout item (TabsWindow). LayoutPanels can have one or many items (TabItem). Properties: id - the ID of the LayoutPanel. autoHide - a boolean property that determines if the LayoutPanel is autoHidden. autoHidePosition - determines the autoHide position of the item if 'autoHide' property is set. Possible values: 'top', 'bottom', 'left', 'right'. dropPosition - Determines the possible positions for the item at which a new item can be dropped as a result of dragging. Possible values: 'top', 'bottom', 'left', 'right', 'center', 'header', 'layout-top', 'layout-bottom', 'layout-left', 'layout-right'. Positions with the 'layout' prefix reflect on LayoutPanelItems that are children of the LayoutPanel. label - the Label of the LayoutPanel window. tabPosition - Determines the position of the Tab labels inside the LayoutPanel. layout - determines the DockingLayout owner of the LayoutPanel. Accepts a string indicating the ID of a DockingLayout on the page or a direct reference to it. headerButtons - an Array of strings that define the buttons in the header section of the DockingLayout item. Possible values for the array are empty array like this [] or an array with any of the following items: 'close', 'autoHide'. tabCloseButtons - a boolean property that Enables or disables the close buttons inside each Tab item label inside the DockingLayout item. tabOverflow - same as 'overflow' property of jqxTabs. It defines the overflow mode of the labels of the Tab items inside a DockingLayout item.selectionMode - the same as jqxTabs selection modes. Applies to Tab items inside a DockingLayout item. tabResize - the same as 'resize' property of jqxTabs. Allows resizing the Tab labels inside the DockingLayout item. locked - Locks the size of the item and does not allow resizing. max - sets the maximum size of the item. min - sets the minimum size of the item size - sets the size of the item. items - an array of objects. Each object defines the structure of a LayoutPanelItem. LayoutPanelItem - Represents a LayoutPanel item (TabItem). Properties: id - the ID of the Tab item. label - a string representing the label of the Tab item. content - represents the content of the Tab item. Can be anything. selected - determines if the item is selected. By default the first added item to the LayoutPanel is automatically selected. draggable - a boolean property that allows to disable the dragging of the Tab item.
|
|
8777
8811
|
* Default value:
|
|
8778
8812
|
*/
|
|
8779
8813
|
layout?: any;
|
|
@@ -9332,11 +9366,6 @@ declare global {
|
|
|
9332
9366
|
}
|
|
9333
9367
|
|
|
9334
9368
|
export interface DropDownListProperties {
|
|
9335
|
-
/**
|
|
9336
|
-
* Sets or gets the animation mode. Animation is disabled when the property is set to 'none'
|
|
9337
|
-
* Default value: advanced
|
|
9338
|
-
*/
|
|
9339
|
-
animation?: Animation | string;
|
|
9340
9369
|
/**
|
|
9341
9370
|
* Used only when dropDownOpenMode is set to 'auto'. Determines the delay before the opened drop down closes if the pointer is not over the element.
|
|
9342
9371
|
* Default value: 100
|
|
@@ -9437,6 +9466,11 @@ export interface DropDownListProperties {
|
|
|
9437
9466
|
* Default value: startsWithIgnoreCase
|
|
9438
9467
|
*/
|
|
9439
9468
|
filterMode?: FilterMode | string;
|
|
9469
|
+
/**
|
|
9470
|
+
* A callback that should return a condition that will be used for custom item filtering. Used in conjunction with filterMode 'custom'
|
|
9471
|
+
* Default value: null
|
|
9472
|
+
*/
|
|
9473
|
+
filterCallback?: any;
|
|
9440
9474
|
/**
|
|
9441
9475
|
* If enabled, the items will be grouped by their first letter. Can't be applied if the dataSource already contains groups.
|
|
9442
9476
|
* Default value: false
|
|
@@ -9714,6 +9748,11 @@ export interface DropDownList extends BaseElement, DropDownListProperties {
|
|
|
9714
9748
|
* @returns {Node}
|
|
9715
9749
|
*/
|
|
9716
9750
|
appendChild<T extends Node>(node: Node): T;
|
|
9751
|
+
/**
|
|
9752
|
+
* Adds a new item(s).
|
|
9753
|
+
* @param {any} item. Describes the properties of the item that will be inserted. You can also pass an array of items.
|
|
9754
|
+
*/
|
|
9755
|
+
add(item: any): void;
|
|
9717
9756
|
/**
|
|
9718
9757
|
* Removes all items from the drop down list.
|
|
9719
9758
|
*/
|
|
@@ -9726,6 +9765,10 @@ export interface DropDownList extends BaseElement, DropDownListProperties {
|
|
|
9726
9765
|
* Closes the dropDown list.
|
|
9727
9766
|
*/
|
|
9728
9767
|
close(): void;
|
|
9768
|
+
/**
|
|
9769
|
+
* Performs a data bind. This can be used to refresh the data source.
|
|
9770
|
+
*/
|
|
9771
|
+
dataBind(): void;
|
|
9729
9772
|
/**
|
|
9730
9773
|
* Ensures the desired item is visible by scrolling to it.
|
|
9731
9774
|
* @param {HTMLElement | string} item. A list item or value of the desired item to be visible.
|
|
@@ -10428,6 +10471,11 @@ export interface Editor extends BaseElement, EditorProperties {
|
|
|
10428
10471
|
* instance - The toast item that is the target of the operation.
|
|
10429
10472
|
*/
|
|
10430
10473
|
onMessageOpen?: ((this: any, ev: Event) => any) | ((this: any, ev: CustomEvent<any>) => any) | null;
|
|
10474
|
+
/**
|
|
10475
|
+
* Adds a new Toolbar item. Example: editor.addToolbarItem({ name: 'customButton2', width: 100, template: '<smart-button>Button2</smart-button>' })
|
|
10476
|
+
* @param {any} itemName. The toolbar item to be added
|
|
10477
|
+
*/
|
|
10478
|
+
addToolbarItem(itemName: any): void;
|
|
10431
10479
|
/**
|
|
10432
10480
|
* Blurs the content of the Editor.
|
|
10433
10481
|
*/
|
|
@@ -10494,6 +10542,12 @@ export interface Editor extends BaseElement, EditorProperties {
|
|
|
10494
10542
|
* Hides the last shown message.
|
|
10495
10543
|
*/
|
|
10496
10544
|
hideLastMessage(): void;
|
|
10545
|
+
/**
|
|
10546
|
+
* Inserts a new Toolbar item. Example: editor.insertToolbarItem({ name: 'customButton2', width: 100, template: '<smart-button>Button2</smart-button>' })
|
|
10547
|
+
* @param {any} itemName. The toolbar item to be added
|
|
10548
|
+
* @param {number} index. The toolbar item's index
|
|
10549
|
+
*/
|
|
10550
|
+
insertToolbarItem(itemName: any, index: number): void;
|
|
10497
10551
|
/**
|
|
10498
10552
|
* Shows a custom message inside the Editor.
|
|
10499
10553
|
* @param {string} message. The text message to be displayed.
|
|
@@ -10533,6 +10587,11 @@ export interface Editor extends BaseElement, EditorProperties {
|
|
|
10533
10587
|
* @param {boolean} value?. Determines whether to enter or leave split mode. By default the argument is not passed and the mode is toggled.
|
|
10534
10588
|
*/
|
|
10535
10589
|
previewMode(value?: boolean): void;
|
|
10590
|
+
/**
|
|
10591
|
+
* Removes a Toolbar item. Example: editor.removeToolbarItem(0)
|
|
10592
|
+
* @param {number} index. The toolbar item's index
|
|
10593
|
+
*/
|
|
10594
|
+
removeToolbarItem(index: number): void;
|
|
10536
10595
|
/**
|
|
10537
10596
|
* Sets Editor into Full Screen Mode. If enabled the Editor is positioned above the page content and fills the screen.
|
|
10538
10597
|
* @param {boolean} value?. Determines whether to enter or leave split mode. By default the argument is not passed and the mode is toggled.
|
|
@@ -12606,12 +12665,12 @@ export interface FormProperties {
|
|
|
12606
12665
|
* Callback function for handling status changes. The status could be 'disabled', 'invalid', 'pending', 'valid'.
|
|
12607
12666
|
* Default value: null
|
|
12608
12667
|
*/
|
|
12609
|
-
onStatusChanges?:
|
|
12668
|
+
onStatusChanges?: {(value: string): void};
|
|
12610
12669
|
/**
|
|
12611
|
-
* Callback function for handling value changes
|
|
12670
|
+
* Callback function for handling value changes. The function argument is the form's value as a JSON object.
|
|
12612
12671
|
* Default value: null
|
|
12613
12672
|
*/
|
|
12614
|
-
onValueChanges?: any;
|
|
12673
|
+
onValueChanges?: {(value: any): void};
|
|
12615
12674
|
/**
|
|
12616
12675
|
* Sets or Gets the labels position.
|
|
12617
12676
|
* Default value: left
|
|
@@ -13025,21 +13084,31 @@ export interface FormGroupProperties {
|
|
|
13025
13084
|
* Default value: 1
|
|
13026
13085
|
*/
|
|
13027
13086
|
columns?: number;
|
|
13087
|
+
/**
|
|
13088
|
+
* Sets the Form control data field. The control's inner input's name is set to the dataField value and in the FormGroup it is accessible through the dataField value.
|
|
13089
|
+
* Default value: ""
|
|
13090
|
+
*/
|
|
13091
|
+
dataField?: string;
|
|
13092
|
+
/**
|
|
13093
|
+
* Gets or Sets the Form control's label.
|
|
13094
|
+
* Default value: ""
|
|
13095
|
+
*/
|
|
13096
|
+
label?: string;
|
|
13028
13097
|
/**
|
|
13029
13098
|
*
|
|
13030
13099
|
* Default value: null
|
|
13031
13100
|
*/
|
|
13032
13101
|
controls?: Control[];
|
|
13033
13102
|
/**
|
|
13034
|
-
* Callback function for handling status changes
|
|
13103
|
+
* Callback function for handling status changes. The function argument is a string which could be: 'valid', 'invalid', 'disabled', 'pending'
|
|
13035
13104
|
* Default value: null
|
|
13036
13105
|
*/
|
|
13037
|
-
onStatusChanges?:
|
|
13106
|
+
onStatusChanges?: {(value: string): void};
|
|
13038
13107
|
/**
|
|
13039
|
-
* Callback function for handling value changes
|
|
13108
|
+
* Callback function for handling value changes. The function argument is the form's value as a JSON object.
|
|
13040
13109
|
* Default value: null
|
|
13041
13110
|
*/
|
|
13042
|
-
onValueChanges?: any;
|
|
13111
|
+
onValueChanges?: {(value: any): void};
|
|
13043
13112
|
/**
|
|
13044
13113
|
* Sets or Gets the labels position.
|
|
13045
13114
|
* Default value: left
|
|
@@ -13273,6 +13342,11 @@ export interface GanttChartProperties {
|
|
|
13273
13342
|
* Default value: false
|
|
13274
13343
|
*/
|
|
13275
13344
|
columnResizeFeedback?: boolean;
|
|
13345
|
+
/**
|
|
13346
|
+
* Gantt's current time. By default it is the today's date.
|
|
13347
|
+
* Default value:
|
|
13348
|
+
*/
|
|
13349
|
+
currentTime?: string | Date;
|
|
13276
13350
|
/**
|
|
13277
13351
|
* Enables/Disables the current time indicator. Current time indicator shows the current time in the appropriate view cells.
|
|
13278
13352
|
* Default value: false
|
|
@@ -13368,6 +13442,11 @@ export interface GanttChartProperties {
|
|
|
13368
13442
|
* Default value: false
|
|
13369
13443
|
*/
|
|
13370
13444
|
filterRow?: boolean;
|
|
13445
|
+
/**
|
|
13446
|
+
* Determines the view start day. Sunday is 0, Monday is 1, Saturday is 6. By default it's Sunday.
|
|
13447
|
+
* Default value: -1
|
|
13448
|
+
*/
|
|
13449
|
+
firstDayOfWeek?: number;
|
|
13371
13450
|
/**
|
|
13372
13451
|
* Groups the tasks inside the Task timeline according to the resources they are assigned to. Unassigned tasks are placed in a default group labeled 'Unassigned'.
|
|
13373
13452
|
* Default value: false
|
|
@@ -13384,15 +13463,20 @@ export interface GanttChartProperties {
|
|
|
13384
13463
|
*/
|
|
13385
13464
|
hideDateMarkers?: boolean;
|
|
13386
13465
|
/**
|
|
13387
|
-
* By default the Timeline has a
|
|
13466
|
+
* By default the Timeline has a three level header - timeline details, timeline second details and timeline header. This property hides the header container( the bottom container ).
|
|
13388
13467
|
* Default value: false
|
|
13389
13468
|
*/
|
|
13390
|
-
|
|
13469
|
+
hideTimelineHeader?: boolean;
|
|
13391
13470
|
/**
|
|
13392
|
-
*
|
|
13471
|
+
* By default the Timeline has a three level header - timeline details, timeline second details and timeline header. This property hides the header details container( the top container ).
|
|
13393
13472
|
* Default value: false
|
|
13394
13473
|
*/
|
|
13395
|
-
|
|
13474
|
+
hideTimelineHeaderDetails?: boolean;
|
|
13475
|
+
/**
|
|
13476
|
+
* By default the Timeline has a three level header - timeline details and timeline header. This property hides the second header details container( the middle container ).
|
|
13477
|
+
* Default value: true
|
|
13478
|
+
*/
|
|
13479
|
+
hideTimelineSecondHeaderDetails?: boolean;
|
|
13396
13480
|
/**
|
|
13397
13481
|
* Hides the Resource panel regardless of the resources availability By default the Resource panel is visible if resources are added to the GanttChart. This property allows to hide the Resource panel permanently.
|
|
13398
13482
|
* Default value: false
|
|
@@ -13453,6 +13537,11 @@ export interface GanttChartProperties {
|
|
|
13453
13537
|
* Default value: short
|
|
13454
13538
|
*/
|
|
13455
13539
|
monthFormat?: MonthFormat | string;
|
|
13540
|
+
/**
|
|
13541
|
+
* Determines the scale in Month view.
|
|
13542
|
+
* Default value: week
|
|
13543
|
+
*/
|
|
13544
|
+
monthScale?: MonthScale | string;
|
|
13456
13545
|
/**
|
|
13457
13546
|
* Determines the nonworking days of the week from 0 to 6, where 0 is the first day of the week and 6 is the last day. Nonworking days will be displayed with colored cells inside the timeline and will not affect the dateEnd of the tasks unless the adjustToNonworkingTime property is enabled.
|
|
13458
13547
|
* Default value:
|
|
@@ -13463,6 +13552,21 @@ export interface GanttChartProperties {
|
|
|
13463
13552
|
* Default value:
|
|
13464
13553
|
*/
|
|
13465
13554
|
nonworkingHours?: number[] | number[][];
|
|
13555
|
+
/**
|
|
13556
|
+
* A function that can be used to completly customize the task element. The function has five arguments: task - the task object.segment - the task current segment object. If the task has only one segment, the task object is passed again.taskElement - the task's html element.segmentElement - the task's segment html element.labelElement - the task's segment label html element.
|
|
13557
|
+
* Default value: null
|
|
13558
|
+
*/
|
|
13559
|
+
onTaskRender?: any;
|
|
13560
|
+
/**
|
|
13561
|
+
* A function that can be used to completly customize the task element. The function has two arguments: task - the task object.taskElement - the task's html element.
|
|
13562
|
+
* Default value: null
|
|
13563
|
+
*/
|
|
13564
|
+
taskFormatFunction?: any;
|
|
13565
|
+
/**
|
|
13566
|
+
* A function that can be used to completly customize the tooltip. The function has three arguments: tooltipObject - the tooltip object.event - the event that triggered the tooltip.content - the tooltip's label element.
|
|
13567
|
+
* Default value: null
|
|
13568
|
+
*/
|
|
13569
|
+
tooltipFormatFunction?: any;
|
|
13466
13570
|
/**
|
|
13467
13571
|
* A function that can be used to completly customize the popup Window that is used to interact width tasks by changing their properties. The function as three arguments: target - the target popup Window that is about to be opened.type - the type of the window. The type determines the purpose of the window. Three possible values: 'task' (task editing), 'confirm' ( confirmation window), 'connection' (used when deleting a connection between tasks). item - the connection/task object that is the target of the window.
|
|
13468
13572
|
* Default value: null
|
|
@@ -13478,6 +13582,11 @@ export interface GanttChartProperties {
|
|
|
13478
13582
|
* Default value: null
|
|
13479
13583
|
*/
|
|
13480
13584
|
progressLabelFormatFunction?: any;
|
|
13585
|
+
/**
|
|
13586
|
+
* Determines the format of the dates the timeline header when they represent quarters.
|
|
13587
|
+
* Default value: short
|
|
13588
|
+
*/
|
|
13589
|
+
quarterFormat?: QuarterFormat | string;
|
|
13481
13590
|
/**
|
|
13482
13591
|
* A getter that returns a flat structure as an array of all resources inside the element.
|
|
13483
13592
|
* Default value: null
|
|
@@ -13548,11 +13657,21 @@ export interface GanttChartProperties {
|
|
|
13548
13657
|
* Default value:
|
|
13549
13658
|
*/
|
|
13550
13659
|
selectedResourceIds?: number[] | string[];
|
|
13660
|
+
/**
|
|
13661
|
+
* Sets or gets the selection mode. Only applicable when selection is enabled.
|
|
13662
|
+
* Default value: many
|
|
13663
|
+
*/
|
|
13664
|
+
selectionMode?: GanttChartSelectionMode | string;
|
|
13551
13665
|
/**
|
|
13552
13666
|
* Enables/Disables the current time shader. If enabled all cells that represent past time will be shaded.
|
|
13553
13667
|
* Default value: false
|
|
13554
13668
|
*/
|
|
13555
13669
|
shadeUntilCurrentTime?: boolean;
|
|
13670
|
+
/**
|
|
13671
|
+
* Shows the selection column of the Task/Resource Table. When applied a checkbox column is displayed that allows to select tasks/resources.
|
|
13672
|
+
* Default value: false
|
|
13673
|
+
*/
|
|
13674
|
+
showSelectionColumn?: boolean;
|
|
13556
13675
|
/**
|
|
13557
13676
|
* Determines whether the baselnes of the tasks are visible or not. Baselines are defined via the 'planned' attribute on the task objects of the dataSource property.
|
|
13558
13677
|
* Default value: false
|
|
@@ -14090,6 +14209,11 @@ export interface GanttChart extends BaseElement, GanttChartProperties {
|
|
|
14090
14209
|
* @param {string} content?. Allows to set a custom content for the Tooltip.
|
|
14091
14210
|
*/
|
|
14092
14211
|
showTooltip(target: HTMLElement, content?: string): void;
|
|
14212
|
+
/**
|
|
14213
|
+
* Scrolls to a date.
|
|
14214
|
+
* @param {Date} date. The date to scroll to.
|
|
14215
|
+
*/
|
|
14216
|
+
scrollToDate(date: Date): void;
|
|
14093
14217
|
/**
|
|
14094
14218
|
* Saves the current settings of the element to LocalStorage. <strong>Requires an id to be set to the element.</strong>
|
|
14095
14219
|
* @param {any[]} state?. An Array containing a valid structure of Gantt Chart tasks.
|
|
@@ -14385,6 +14509,11 @@ export interface GanttChartTask {
|
|
|
14385
14509
|
* Default value: null
|
|
14386
14510
|
*/
|
|
14387
14511
|
formatFunction?: any;
|
|
14512
|
+
/**
|
|
14513
|
+
* Project, Task or Milestone format function. The function gets passed the following arguments: task, segment, taskElement, segmentElement, labelElement. task - the task object.segment - the task current segment object. If the task has only one segment, the task object is passed again.taskElement - the task's html element.segmentElement - the task's segment html element.labelElement - the task's segment label html element.
|
|
14514
|
+
* Default value: null
|
|
14515
|
+
*/
|
|
14516
|
+
onRender?: any;
|
|
14388
14517
|
/**
|
|
14389
14518
|
* Project, Task or Milestone max start date.
|
|
14390
14519
|
* Default value:
|
|
@@ -14647,10 +14776,16 @@ export declare type GanttDayFormat = '2-digit' | 'numeric' | 'long' | 'short' |
|
|
|
14647
14776
|
export declare type Duration = 'day' | 'hour' | 'minute' | 'second' | 'milisecond';
|
|
14648
14777
|
/**Determines the format of the dates inside the timeline header when they represent hours. */
|
|
14649
14778
|
export declare type HourFormat = 'default' | '2-digit' | 'numeric';
|
|
14779
|
+
/**Determines the scale in Month view. */
|
|
14780
|
+
export declare type MonthScale = 'day' | 'week';
|
|
14781
|
+
/**Determines the format of the dates the timeline header when they represent quarters. */
|
|
14782
|
+
export declare type QuarterFormat = 'numeric' | 'long' | 'short';
|
|
14650
14783
|
/**Determines how the capacity of the resources will be visualized inside the resource timeline. By default, the capacity is measured in hours depending on the <b>view</b> property of the element. */
|
|
14651
14784
|
export declare type GanttChartResourceTimelineMode = 'diagram' | 'histogram' | 'custom';
|
|
14652
14785
|
/**Determines how the resources will be displayed inside the resource Timeline. */
|
|
14653
14786
|
export declare type GanttChartResourceTimelineView = 'hours' | 'tasks' | 'custom';
|
|
14787
|
+
/**Sets or gets the selection mode. Only applicable when selection is enabled. */
|
|
14788
|
+
export declare type GanttChartSelectionMode = 'one' | 'many' | 'extended';
|
|
14654
14789
|
/**Determines whether the GanttChart can be sorted by one, more then one or no columns. */
|
|
14655
14790
|
export declare type GanttChartSortMode = 'none' | 'one' | 'many';
|
|
14656
14791
|
/**Project, Task or Milestone type. Possible values are 'project', 'milestone' and 'task' */
|
|
@@ -14661,7 +14796,7 @@ month - the timeline shows the days of the month.
|
|
|
14661
14796
|
year - the timeline shows the months of the year.
|
|
14662
14797
|
resource - displays the current tasks by grouping them according to the resources they have assigned. The unassigned tasks will be placed in a separate group called 'Unassigned'.
|
|
14663
14798
|
<br /> The timeline has a header section that contains the labels of each cell according to the date inside them. The header is splitted in two sections in order to give a more detailed information of the dates. */
|
|
14664
|
-
export declare type GanttChartView = 'day' | 'week' | 'month' | 'year';
|
|
14799
|
+
export declare type GanttChartView = 'day' | 'week' | 'month' | 'quarter' | 'year';
|
|
14665
14800
|
/**Determines the format of the dates inside the timeline header when they represent weeks. */
|
|
14666
14801
|
export declare type WeekFormat = 'long' | 'numeric';
|
|
14667
14802
|
export interface GaugeProperties {
|
|
@@ -14992,15 +15127,15 @@ export interface GridProperties {
|
|
|
14992
15127
|
*/
|
|
14993
15128
|
behavior?: GridBehavior;
|
|
14994
15129
|
/**
|
|
14995
|
-
*
|
|
14996
|
-
* Default value:
|
|
15130
|
+
* Sets or gets the id of the current user. Has to correspond to the id of an item from the users property/array. Depending on the current user, different privileges are enabled. If no current user is set, privileges depend on the element's properties.
|
|
15131
|
+
* Default value:
|
|
14997
15132
|
*/
|
|
14998
|
-
|
|
15133
|
+
currentUser?: string | number;
|
|
14999
15134
|
/**
|
|
15000
|
-
*
|
|
15001
|
-
* Default value:
|
|
15135
|
+
* Describes the column header settings.
|
|
15136
|
+
* Default value: [object Object]
|
|
15002
15137
|
*/
|
|
15003
|
-
|
|
15138
|
+
columnHeader?: GridColumnHeader;
|
|
15004
15139
|
/**
|
|
15005
15140
|
* The clipboard property is used to enable/disable clipboard operations with Ctrl+C, Ctrl+X and Ctrl+V keyboard navigations..
|
|
15006
15141
|
* Default value: [object Object]
|
|
@@ -15026,6 +15161,11 @@ export interface GridProperties {
|
|
|
15026
15161
|
* Default value:
|
|
15027
15162
|
*/
|
|
15028
15163
|
columnGroups?: GridColumnGroup[];
|
|
15164
|
+
/**
|
|
15165
|
+
*
|
|
15166
|
+
* Default value: false
|
|
15167
|
+
*/
|
|
15168
|
+
dropDownMode?: boolean;
|
|
15029
15169
|
/**
|
|
15030
15170
|
* Sets or gets details about conditional formatting to be applied to the Grid's cells.
|
|
15031
15171
|
* Default value: null
|
|
@@ -15066,11 +15206,41 @@ export interface GridProperties {
|
|
|
15066
15206
|
* Default value: [object Object]
|
|
15067
15207
|
*/
|
|
15068
15208
|
filtering?: GridFiltering;
|
|
15209
|
+
/**
|
|
15210
|
+
* Describes the footer settings of the grid.
|
|
15211
|
+
* Default value: [object Object]
|
|
15212
|
+
*/
|
|
15213
|
+
footer?: GridFooter;
|
|
15214
|
+
/**
|
|
15215
|
+
* Sets or gets whether Excel-like formulas can be passed as cell values. Formulas are always preceded by the = sign and are re-evaluated when cell values are changed. This feature depends on the third-party free plug-in formula-parser (the file formula-parser.min.js has to be referenced).
|
|
15216
|
+
* Default value: false
|
|
15217
|
+
*/
|
|
15218
|
+
formulas?: boolean;
|
|
15069
15219
|
/**
|
|
15070
15220
|
* Describes the grid's grouping settings.
|
|
15071
15221
|
* Default value: [object Object]
|
|
15072
15222
|
*/
|
|
15073
15223
|
grouping?: GridGrouping;
|
|
15224
|
+
/**
|
|
15225
|
+
* Describes the settings for the group header.
|
|
15226
|
+
* Default value: [object Object]
|
|
15227
|
+
*/
|
|
15228
|
+
groupHeader?: GridGroupHeader;
|
|
15229
|
+
/**
|
|
15230
|
+
* Describes the header settings of the grid.
|
|
15231
|
+
* Default value: [object Object]
|
|
15232
|
+
*/
|
|
15233
|
+
header?: GridHeader;
|
|
15234
|
+
/**
|
|
15235
|
+
* An object containing settings related to the grid's layout.
|
|
15236
|
+
* Default value: [object Object]
|
|
15237
|
+
*/
|
|
15238
|
+
layout?: GridLayout;
|
|
15239
|
+
/**
|
|
15240
|
+
* Sets or gets the language. Used in conjunction with the property messages.
|
|
15241
|
+
* Default value: "en"
|
|
15242
|
+
*/
|
|
15243
|
+
locale?: string;
|
|
15074
15244
|
/**
|
|
15075
15245
|
* Sets the messages values.
|
|
15076
15246
|
* Default value: * [object Object]
|
|
@@ -15091,6 +15261,16 @@ export interface GridProperties {
|
|
|
15091
15261
|
* Default value: null
|
|
15092
15262
|
*/
|
|
15093
15263
|
onCellRender?: {(cell: GridCell): void};
|
|
15264
|
+
/**
|
|
15265
|
+
* Callback function, which is called when a cell edit starts. If you return false, the edit will be canceled.
|
|
15266
|
+
* Default value: null
|
|
15267
|
+
*/
|
|
15268
|
+
onCellBeginEdit?: {(id: string, dataField: string, value: any): boolean};
|
|
15269
|
+
/**
|
|
15270
|
+
* Callback function, which is called when a cell edit ends. It is used along with the 'editing.readOnlyEdit' property when it is set to true and the purpose of this function is to update the Grid cell after editing.
|
|
15271
|
+
* Default value: null
|
|
15272
|
+
*/
|
|
15273
|
+
onCellEditRequest?: {(id: string, dataField: string, value: any, oldValue: any, data: any): void};
|
|
15094
15274
|
/**
|
|
15095
15275
|
* Callback function() called before the grid has been initialized and the Grid's Virtual DOM is not created.
|
|
15096
15276
|
* Default value: null
|
|
@@ -15211,26 +15391,6 @@ export interface GridProperties {
|
|
|
15211
15391
|
* Default value: null
|
|
15212
15392
|
*/
|
|
15213
15393
|
onCommand?: {(name: string, command: any, details: GridCell, event: Event | KeyboardEvent | PointerEvent, handled: boolean): void};
|
|
15214
|
-
/**
|
|
15215
|
-
* Sets or gets the rows CSS class rules. Different CSS class names are conditionally applied. Example: rowCSSRules: { 'cell-class-1': settings => 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.
|
|
15216
|
-
* Default value: null
|
|
15217
|
-
*/
|
|
15218
|
-
rowCSSRules?: any;
|
|
15219
|
-
/**
|
|
15220
|
-
* Sets or gets the id of the current user. Has to correspond to the id of an item from the users property/array. Depending on the current user, different privileges are enabled. If no current user is set, privileges depend on the element's properties.
|
|
15221
|
-
* Default value:
|
|
15222
|
-
*/
|
|
15223
|
-
currentUser?: string | number;
|
|
15224
|
-
/**
|
|
15225
|
-
* Sets the grid users. Expects an array with 'id', 'name' and optionally 'color' and 'image' properties.
|
|
15226
|
-
* Default value: []
|
|
15227
|
-
*/
|
|
15228
|
-
users?: any[];
|
|
15229
|
-
/**
|
|
15230
|
-
* Sets the grid's image and filter upload settings for the image and attachment columns.
|
|
15231
|
-
* Default value: [object Object]
|
|
15232
|
-
*/
|
|
15233
|
-
uploadSettings?: GridUploadSettings;
|
|
15234
15394
|
/**
|
|
15235
15395
|
* Describes the paging settings.
|
|
15236
15396
|
* Default value: [object Object]
|
|
@@ -15246,16 +15406,26 @@ export interface GridProperties {
|
|
|
15246
15406
|
* Default value: [object Object]
|
|
15247
15407
|
*/
|
|
15248
15408
|
rowDetail?: GridRowDetail;
|
|
15409
|
+
/**
|
|
15410
|
+
* Sets or gets the rows CSS class rules. Different CSS class names are conditionally applied. Example: rowCSSRules: { 'cell-class-1': settings => 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.
|
|
15411
|
+
* Default value: null
|
|
15412
|
+
*/
|
|
15413
|
+
rowCSSRules?: any;
|
|
15414
|
+
/**
|
|
15415
|
+
* Sets or gets the value indicating whether the element is aligned to support locales using right-to-left fonts.
|
|
15416
|
+
* Default value: false
|
|
15417
|
+
*/
|
|
15418
|
+
rightToLeft?: boolean;
|
|
15419
|
+
/**
|
|
15420
|
+
* The rows property is used to describe all rows displayed in the grid.
|
|
15421
|
+
* Default value:
|
|
15422
|
+
*/
|
|
15423
|
+
rows?: GridRow[];
|
|
15249
15424
|
/**
|
|
15250
15425
|
* Sets the scroll mode settings.
|
|
15251
15426
|
* Default value: physical
|
|
15252
15427
|
*/
|
|
15253
15428
|
scrolling?: Scrolling | string;
|
|
15254
|
-
/**
|
|
15255
|
-
* Describes the column header settings.
|
|
15256
|
-
* Default value: [object Object]
|
|
15257
|
-
*/
|
|
15258
|
-
columnHeader?: GridColumnHeader;
|
|
15259
15429
|
/**
|
|
15260
15430
|
* Describes the summary row settings.
|
|
15261
15431
|
* Default value: [object Object]
|
|
@@ -15267,40 +15437,30 @@ export interface GridProperties {
|
|
|
15267
15437
|
*/
|
|
15268
15438
|
stateSettings?: GridStateSettings;
|
|
15269
15439
|
/**
|
|
15270
|
-
* Describes the settings
|
|
15271
|
-
* Default value: [object Object]
|
|
15272
|
-
*/
|
|
15273
|
-
groupHeader?: GridGroupHeader;
|
|
15274
|
-
/**
|
|
15275
|
-
* Describes the header settings of the grid.
|
|
15440
|
+
* Describes the selection settings.
|
|
15276
15441
|
* Default value: [object Object]
|
|
15277
15442
|
*/
|
|
15278
|
-
|
|
15443
|
+
selection?: GridSelection;
|
|
15279
15444
|
/**
|
|
15280
|
-
* Describes
|
|
15445
|
+
* Describes sorting settings.
|
|
15281
15446
|
* Default value: [object Object]
|
|
15282
15447
|
*/
|
|
15283
|
-
|
|
15284
|
-
/**
|
|
15285
|
-
* Sets or gets the value indicating whether the element is aligned to support locales using right-to-left fonts.
|
|
15286
|
-
* Default value: false
|
|
15287
|
-
*/
|
|
15288
|
-
rightToLeft?: boolean;
|
|
15448
|
+
sorting?: GridSorting;
|
|
15289
15449
|
/**
|
|
15290
|
-
*
|
|
15291
|
-
* Default value:
|
|
15450
|
+
* Sets the grid users. Expects an array with 'id', 'name' and optionally 'color' and 'image' properties.
|
|
15451
|
+
* Default value: []
|
|
15292
15452
|
*/
|
|
15293
|
-
|
|
15453
|
+
users?: any[];
|
|
15294
15454
|
/**
|
|
15295
|
-
*
|
|
15455
|
+
* Sets the grid's image and filter upload settings for the image and attachment columns.
|
|
15296
15456
|
* Default value: [object Object]
|
|
15297
15457
|
*/
|
|
15298
|
-
|
|
15458
|
+
uploadSettings?: GridUploadSettings;
|
|
15299
15459
|
/**
|
|
15300
|
-
*
|
|
15301
|
-
* Default value:
|
|
15460
|
+
* Sets the current data view. The possible values are 'grid', 'kanban' and 'card'.
|
|
15461
|
+
* Default value: "grid"
|
|
15302
15462
|
*/
|
|
15303
|
-
|
|
15463
|
+
view?: string;
|
|
15304
15464
|
}
|
|
15305
15465
|
/**
|
|
15306
15466
|
Data Grid UI Component that covers everything from paging, sorting, grouping, filtering, and editing to row and column virtualization, right-to-left layout, export to Excel and PDF and Accessibility.
|
|
@@ -15375,6 +15535,15 @@ export interface Grid extends BaseElement, GridProperties {
|
|
|
15375
15535
|
* originalEvent - The origianl Event object.
|
|
15376
15536
|
*/
|
|
15377
15537
|
onColumnDragStart?: ((this: any, ev: Event) => any) | ((this: any, ev: CustomEvent<any>) => any) | null;
|
|
15538
|
+
/**
|
|
15539
|
+
* This event is triggered, when a column property is changed.
|
|
15540
|
+
* @param event. The custom event. Custom data event was created with: ev.detail(column, propertyName, oldValue, value)
|
|
15541
|
+
* column - The resized column.
|
|
15542
|
+
* propertyName - The changed property's name.
|
|
15543
|
+
* oldValue - The old value(s) of the column.
|
|
15544
|
+
* value - The new value(s) of the column.
|
|
15545
|
+
*/
|
|
15546
|
+
onColumnChange?: ((this: any, ev: Event) => any) | ((this: any, ev: CustomEvent<any>) => any) | null;
|
|
15378
15547
|
/**
|
|
15379
15548
|
* This event is triggered, when the user drags a column.
|
|
15380
15549
|
* @param event. The custom event. Custom data event was created with: ev.detail(column, dataField, index, data, originalEvent)
|
|
@@ -15488,10 +15657,11 @@ export interface Grid extends BaseElement, GridProperties {
|
|
|
15488
15657
|
onRowCollapse?: ((this: any, ev: Event) => any) | ((this: any, ev: CustomEvent<any>) => any) | null;
|
|
15489
15658
|
/**
|
|
15490
15659
|
* This event is triggered, when the user clicks on a row of the grid.
|
|
15491
|
-
* @param event. The custom event. Custom data event was created with: ev.detail(row, originalEvent, id, isRightClick, pageX, pageY)
|
|
15660
|
+
* @param event. The custom event. Custom data event was created with: ev.detail(row, originalEvent, id, data, isRightClick, pageX, pageY)
|
|
15492
15661
|
* row - The clicked row.
|
|
15493
15662
|
* originalEvent - The original event object, which is 'pointer', 'touch' or 'mouse' Event object, depending on the device type and web browser
|
|
15494
15663
|
* id - Gets the row id.
|
|
15664
|
+
* data - Gets the row data.
|
|
15495
15665
|
* isRightClick - Gets whether the pointing device's right button is clicked.
|
|
15496
15666
|
* pageX - Gets the click's X position.
|
|
15497
15667
|
* pageY - Gets the click's Y position.
|
|
@@ -15499,10 +15669,11 @@ export interface Grid extends BaseElement, GridProperties {
|
|
|
15499
15669
|
onRowClick?: ((this: any, ev: Event) => any) | ((this: any, ev: CustomEvent<any>) => any) | null;
|
|
15500
15670
|
/**
|
|
15501
15671
|
* This event is triggered, when the user double clicks on a row of the grid.
|
|
15502
|
-
* @param event. The custom event. Custom data event was created with: ev.detail(row, originalEvent, id, isRightClick, pageX, pageY)
|
|
15672
|
+
* @param event. The custom event. Custom data event was created with: ev.detail(row, originalEvent, id, data, isRightClick, pageX, pageY)
|
|
15503
15673
|
* row - The double-clicked row.
|
|
15504
15674
|
* originalEvent - The original event object, which is 'pointer', 'touch' or 'mouse' Event object, depending on the device type and web browser
|
|
15505
15675
|
* id - Gets the row id.
|
|
15676
|
+
* data - Gets the row data.
|
|
15506
15677
|
* isRightClick - Gets whether the pointing device's right button is clicked.
|
|
15507
15678
|
* pageX - Gets the click's X position.
|
|
15508
15679
|
* pageY - Gets the click's Y position.
|
|
@@ -15528,11 +15699,12 @@ export interface Grid extends BaseElement, GridProperties {
|
|
|
15528
15699
|
onRowStarred?: ((this: any, ev: Event) => any) | ((this: any, ev: CustomEvent<any>) => any) | null;
|
|
15529
15700
|
/**
|
|
15530
15701
|
* This event is triggered, when the user clicks on a cell of the grid.
|
|
15531
|
-
* @param event. The custom event. Custom data event was created with: ev.detail(cell, originalEvent, id, dataField, isRightClick, pageX, pageY)
|
|
15702
|
+
* @param event. The custom event. Custom data event was created with: ev.detail(cell, originalEvent, id, dataField, value, isRightClick, pageX, pageY)
|
|
15532
15703
|
* cell - The clicked cell.
|
|
15533
15704
|
* originalEvent - The original event object, which is 'pointer', 'touch' or 'mouse' Event object, depending on the device type and web browser
|
|
15534
15705
|
* id - Gets the row id.
|
|
15535
15706
|
* dataField - Gets the column dataField.
|
|
15707
|
+
* value - Gets the cell value.
|
|
15536
15708
|
* isRightClick - Gets whether the pointing device's right button is clicked.
|
|
15537
15709
|
* pageX - Gets the click's X position.
|
|
15538
15710
|
* pageY - Gets the click's Y position.
|
|
@@ -15540,11 +15712,12 @@ export interface Grid extends BaseElement, GridProperties {
|
|
|
15540
15712
|
onCellClick?: ((this: any, ev: Event) => any) | ((this: any, ev: CustomEvent<any>) => any) | null;
|
|
15541
15713
|
/**
|
|
15542
15714
|
* This event is triggered, when the user double clicks on a cell of the grid.
|
|
15543
|
-
* @param event. The custom event. Custom data event was created with: ev.detail(cell, originalEvent, id, dataField, isRightClick, pageX, pageY)
|
|
15715
|
+
* @param event. The custom event. Custom data event was created with: ev.detail(cell, originalEvent, id, dataField, value, isRightClick, pageX, pageY)
|
|
15544
15716
|
* cell - The double-clicked cell.
|
|
15545
15717
|
* originalEvent - The original event object, which is 'pointer', 'touch' or 'mouse' Event object, depending on the device type and web browser
|
|
15546
15718
|
* id - Gets the row id.
|
|
15547
15719
|
* dataField - Gets the column dataField.
|
|
15720
|
+
* value - Gets the cell value.
|
|
15548
15721
|
* isRightClick - Gets whether the pointing device's right button is clicked.
|
|
15549
15722
|
* pageX - Gets the click's X position.
|
|
15550
15723
|
* pageY - Gets the click's Y position.
|
|
@@ -15792,8 +15965,10 @@ export interface Grid extends BaseElement, GridProperties {
|
|
|
15792
15965
|
/**
|
|
15793
15966
|
* Exports the Grid data to .XLSX, .PDF, .JSON, .XML, .CSV, .TSV, .HTML, .JPEG or .PNG. The method uses the options of the <em>dataExport</em> property.
|
|
15794
15967
|
* @param {string} Dataformat. 'xlsx', 'pdf', 'json', 'xml', 'csv', 'tsv', 'html', 'png', 'jpeg'.
|
|
15968
|
+
* @param {any} callback?. A callback that allows to format the exported data based on a condition. For additional details, refer to the Smart Export Documentation.
|
|
15969
|
+
* @param {any} dataCallback?. A callback that allows to change the exported data.
|
|
15795
15970
|
*/
|
|
15796
|
-
exportData(Dataformat: string): void;
|
|
15971
|
+
exportData(Dataformat: string, callback?: any, dataCallback?: any): void;
|
|
15797
15972
|
/**
|
|
15798
15973
|
* Finds entries by using a query and returns an array of row ids. Example: const rows = grid.find('nancy'); returns all rows that have 'nancy' value. Example 2: const rows = grid.find('nancy, davolio'); returns all rows that have 'nancy' and 'davolio' values in the same row. Example 3: const rows = grid.find(5, 'quantity', '>'); returns all rows where the value of the 'quantity' field is > 5.
|
|
15799
15974
|
* @param {string} query. Search query
|
|
@@ -15808,6 +15983,12 @@ export interface Grid extends BaseElement, GridProperties {
|
|
|
15808
15983
|
* @returns {any[]}
|
|
15809
15984
|
*/
|
|
15810
15985
|
findCells(query: string): any[];
|
|
15986
|
+
/**
|
|
15987
|
+
* Filter by all columns. This method works like a global filter and applies a filter to all grid columns.
|
|
15988
|
+
* @param {string} query. Filter query to filter by.
|
|
15989
|
+
* @param {string} dataType?. Optionally filter by a specific data type like 'string', 'boolean', 'date', 'number'.
|
|
15990
|
+
*/
|
|
15991
|
+
filterBy(query: string, dataType?: string): void;
|
|
15811
15992
|
/**
|
|
15812
15993
|
* Navigates to a page, when paging is enabled.
|
|
15813
15994
|
* @param {number} index. page index
|
|
@@ -15930,22 +16111,6 @@ export interface Grid extends BaseElement, GridProperties {
|
|
|
15930
16111
|
* @returns {any}
|
|
15931
16112
|
*/
|
|
15932
16113
|
getState(): any;
|
|
15933
|
-
/**
|
|
15934
|
-
* Saves the Grid state and returns a JSON object with the following fields: 'sort', 'columns', 'expandedRows', 'filter', 'groups', 'paging', 'selectedCells', 'selectedrows'. The 'sort' represents an object which contains the sorted columns. Each key in that json object is the column's dataField item which has sortOrder: string and sortIndex: int properties. The sortOrder could be either 'asc' or 'desc'. Similarly, the filter object contains the filtered columns. Each key in that object is a column data field and each value has 'filters' array property with the applied filters to the column. The 'columns' property contains an array of columns with saved properties such as visible, width and freeze. The 'expandedRows' property contains the indexes of the expanded rows. The 'groups' property contains the grouped column data fields and the selectedCells and selectedRows include information about the cells or rows selection. These depend on the selection mode used in the Grid. The 'paging' object includes the sub-properties 'count', 'index' and 'size' which determine the count of pages, the current page's index and the page size.
|
|
15935
|
-
* @param {string} name?. state name
|
|
15936
|
-
* @returns {any}
|
|
15937
|
-
*/
|
|
15938
|
-
saveState(name?: string): any;
|
|
15939
|
-
/**
|
|
15940
|
-
* Loads a previously saved Grid state. You can pass a state name when there is a state which was previously saved with the saveState(stateName) method call or a state object returned by the saveState or getState method calls. The state object is required to be a JSON object with the following fields: 'sort', 'columns', 'expandedRows', 'filter', 'groups', 'paging', 'selectedCells', 'selectedrows'. The 'sort' represents an object which contains the sorted columns. Each key in that json object is the column's dataField item which has sortOrder: string and sortIndex: int properties. The sortOrder could be either 'asc' or 'desc'. Similarly, the filter object contains the filtered columns. Each key in that object is a column data field and each value has 'filters' array property with the applied filters to the column. The 'columns' property contains an array of columns with saved properties such as visible, width and freeze. The 'expandedRows' property contains the indexes of the expanded rows. The 'groups' property contains the grouped column data fields and the selectedCells and selectedRows include information about the cells or rows selection. These depend on the selection mode used in the Grid. The 'paging' object includes the sub-properties 'count', 'index' and 'size' which determine the count of pages, the current page's index and the page size.
|
|
15941
|
-
* @param {any} state. state name or state object
|
|
15942
|
-
* @returns {any}
|
|
15943
|
-
*/
|
|
15944
|
-
loadState(state: any): any;
|
|
15945
|
-
/**
|
|
15946
|
-
* Resets the Grid state.
|
|
15947
|
-
*/
|
|
15948
|
-
resetState(): void;
|
|
15949
16114
|
/**
|
|
15950
16115
|
* Gets the changes from the batch edit.
|
|
15951
16116
|
* @returns
|
|
@@ -16042,6 +16207,12 @@ export interface Grid extends BaseElement, GridProperties {
|
|
|
16042
16207
|
* @param callback?. Sets a callback function, which is called after the new row is added. The callback's argument is the new row.
|
|
16043
16208
|
*/
|
|
16044
16209
|
insertRow(data: any, index?: number, callback?: {(row: GridRow): void}): void;
|
|
16210
|
+
/**
|
|
16211
|
+
* Loads a previously saved Grid state. You can pass a state name when there is a state which was previously saved with the saveState(stateName) method call or a state object returned by the saveState or getState method calls. The state object is required to be a JSON object with the following fields: 'sort', 'columns', 'expandedRows', 'filter', 'groups', 'paging', 'selectedCells', 'selectedrows'. The 'sort' represents an object which contains the sorted columns. Each key in that json object is the column's dataField item which has sortOrder: string and sortIndex: int properties. The sortOrder could be either 'asc' or 'desc'. Similarly, the filter object contains the filtered columns. Each key in that object is a column data field and each value has 'filters' array property with the applied filters to the column. The 'columns' property contains an array of columns with saved properties such as visible, width and freeze. The 'expandedRows' property contains the indexes of the expanded rows. The 'groups' property contains the grouped column data fields and the selectedCells and selectedRows include information about the cells or rows selection. These depend on the selection mode used in the Grid. The 'paging' object includes the sub-properties 'count', 'index' and 'size' which determine the count of pages, the current page's index and the page size.
|
|
16212
|
+
* @param {any} state. state name or state object
|
|
16213
|
+
* @returns {any}
|
|
16214
|
+
*/
|
|
16215
|
+
loadState(state: any): any;
|
|
16045
16216
|
/**
|
|
16046
16217
|
* Opens a column drop-down menu.
|
|
16047
16218
|
* @param {string} dataField. column bound data field. For example, if you have a column with dataField: 'firstName', set 'firstName' here.
|
|
@@ -16053,6 +16224,14 @@ export interface Grid extends BaseElement, GridProperties {
|
|
|
16053
16224
|
* @param {number} top. Top Position.
|
|
16054
16225
|
*/
|
|
16055
16226
|
openContextMenu(left: number, top: number): void;
|
|
16227
|
+
/**
|
|
16228
|
+
* Opens the Grid when the 'dropDownMode' property is true.
|
|
16229
|
+
*/
|
|
16230
|
+
openDropDown(): void;
|
|
16231
|
+
/**
|
|
16232
|
+
* Closes the Grid when the 'dropDownMode' property is true.
|
|
16233
|
+
*/
|
|
16234
|
+
closeDropDown(): void;
|
|
16056
16235
|
/**
|
|
16057
16236
|
* Prints the Grid data. The method uses the options of the <em>dataExport</em> property. When printed, the Grid will not display any scrollbars so all rows and columns will be displayed. The grid will auto resize width and height to fit all contents. To customize the printing options, you can use the <em>dataExport</em> property.
|
|
16058
16237
|
*/
|
|
@@ -16069,6 +16248,10 @@ export interface Grid extends BaseElement, GridProperties {
|
|
|
16069
16248
|
* Refreshes the grid cells in view. The method is useful for live-updates of cell values.
|
|
16070
16249
|
*/
|
|
16071
16250
|
refreshView(): void;
|
|
16251
|
+
/**
|
|
16252
|
+
* Resets the Grid state.
|
|
16253
|
+
*/
|
|
16254
|
+
resetState(): void;
|
|
16072
16255
|
/**
|
|
16073
16256
|
* Removes a column filter.
|
|
16074
16257
|
* @param {string} dataField. column bound data field. For example, if you have a column with dataField: 'firstName', set 'firstName' here.
|
|
@@ -16100,6 +16283,12 @@ export interface Grid extends BaseElement, GridProperties {
|
|
|
16100
16283
|
* @param {boolean} insertAfter?. Determines whether to insert the first column after the reference column.
|
|
16101
16284
|
*/
|
|
16102
16285
|
reorderColumns(dataField: string | number, referenceDataField: string | number, insertAfter?: boolean): void;
|
|
16286
|
+
/**
|
|
16287
|
+
* Saves the Grid state and returns a JSON object with the following fields: 'sort', 'columns', 'expandedRows', 'filter', 'groups', 'paging', 'selectedCells', 'selectedrows'. The 'sort' represents an object which contains the sorted columns. Each key in that json object is the column's dataField item which has sortOrder: string and sortIndex: int properties. The sortOrder could be either 'asc' or 'desc'. Similarly, the filter object contains the filtered columns. Each key in that object is a column data field and each value has 'filters' array property with the applied filters to the column. The 'columns' property contains an array of columns with saved properties such as visible, width and freeze. The 'expandedRows' property contains the indexes of the expanded rows. The 'groups' property contains the grouped column data fields and the selectedCells and selectedRows include information about the cells or rows selection. These depend on the selection mode used in the Grid. The 'paging' object includes the sub-properties 'count', 'index' and 'size' which determine the count of pages, the current page's index and the page size.
|
|
16288
|
+
* @param {string} name?. state name
|
|
16289
|
+
* @returns {any}
|
|
16290
|
+
*/
|
|
16291
|
+
saveState(name?: string): any;
|
|
16103
16292
|
/**
|
|
16104
16293
|
* Sorts the Grid by a data field. This method will add or remove sorting, when sorting is enabled. To remove the sorting, use 'null' for the sortOrder parameter.
|
|
16105
16294
|
* @param {string} dataField. column bound data field. For example, if you have a column with dataField: 'firstName', set 'firstName' here.
|
|
@@ -16207,6 +16396,11 @@ export interface Grid extends BaseElement, GridProperties {
|
|
|
16207
16396
|
* @param rowStyle. The cell style object. The object may have one or all of the following properties: 'background', 'color', 'fontSize', 'fontFamily', 'textDecoration', 'fontStyle', 'fontWeight'.
|
|
16208
16397
|
*/
|
|
16209
16398
|
setCellStyle(rowId: string | number, dataField: string, rowStyle: {background?: string, color?: string, fontSize?: string, fontFamily?: string, textDecoration?: string, fontStyle?: string, fontWeight?: string}): void;
|
|
16399
|
+
/**
|
|
16400
|
+
* Sets the label of the Grid when the 'dropDownMode' property is true.
|
|
16401
|
+
* @param {string} label. The label to be displayed in the dropdown button.
|
|
16402
|
+
*/
|
|
16403
|
+
setDropDownLabel(label: string): void;
|
|
16210
16404
|
/**
|
|
16211
16405
|
* Sets the position of the vertical scrollbar. You can use this method in combination with the getVerticalScrollValue and getVerticalScrollMax.
|
|
16212
16406
|
* @param {number} value. The new scroll position
|
|
@@ -16222,6 +16416,13 @@ export interface Grid extends BaseElement, GridProperties {
|
|
|
16222
16416
|
* @param {string | number} rowId. row bound id
|
|
16223
16417
|
*/
|
|
16224
16418
|
showDetail(rowId: string | number): void;
|
|
16419
|
+
/**
|
|
16420
|
+
* Shows an overlay message below a cell. This method can be used for onboarding tips or in scenarios when you want to display custom messages to the user.
|
|
16421
|
+
* @param {string | number} rowId. row bound id
|
|
16422
|
+
* @param {string} dataField. column bound data field. For example, if you have a column with dataField: 'firstName', set 'firstName' here.
|
|
16423
|
+
* @param {string} value. The message to be shown below the cell
|
|
16424
|
+
*/
|
|
16425
|
+
showCellMessage(rowId: string | number, dataField: string, value: string): void;
|
|
16225
16426
|
/**
|
|
16226
16427
|
* Updates a row. When batch editing is enabled, the row is not saved until the batch edit is saved.
|
|
16227
16428
|
* @param {string | number} rowId. row bound id
|
|
@@ -16423,6 +16624,16 @@ export interface GridAppearance {
|
|
|
16423
16624
|
* Default value: true
|
|
16424
16625
|
*/
|
|
16425
16626
|
showRowLines?: boolean;
|
|
16627
|
+
/**
|
|
16628
|
+
* Shows lines between columns in column groups.
|
|
16629
|
+
* Default value: true
|
|
16630
|
+
*/
|
|
16631
|
+
showColumnGroupLines?: boolean;
|
|
16632
|
+
/**
|
|
16633
|
+
* Shows lines between cells in column groups.
|
|
16634
|
+
* Default value: true
|
|
16635
|
+
*/
|
|
16636
|
+
showColumnGroupCellLines?: boolean;
|
|
16426
16637
|
/**
|
|
16427
16638
|
* Shows column groups in the Hide columns panel. Column groups and columns are shown in a tree-like structure. When the property is set to false, the column groups are not displayed and the column labels contain the column group name.
|
|
16428
16639
|
* Default value: false
|
|
@@ -16444,10 +16655,10 @@ export interface GridAppearance {
|
|
|
16444
16655
|
*/
|
|
16445
16656
|
showFrozenColumnBackground?: boolean;
|
|
16446
16657
|
/**
|
|
16447
|
-
* Shows
|
|
16448
|
-
* Default value:
|
|
16658
|
+
* Shows the selection on top of all other styles.
|
|
16659
|
+
* Default value: false
|
|
16449
16660
|
*/
|
|
16450
|
-
|
|
16661
|
+
showSelectionOnTop?: boolean;
|
|
16451
16662
|
/**
|
|
16452
16663
|
* Shows column sort button.
|
|
16453
16664
|
* Default value: true
|
|
@@ -16527,6 +16738,11 @@ export interface GridBehavior {
|
|
|
16527
16738
|
* Default value: false
|
|
16528
16739
|
*/
|
|
16529
16740
|
allowColumnFreeze?: boolean;
|
|
16741
|
+
/**
|
|
16742
|
+
* Determines whether the scrolling with mouse wheel is enabled.
|
|
16743
|
+
* Default value: true
|
|
16744
|
+
*/
|
|
16745
|
+
allowMouseWheel?: boolean;
|
|
16530
16746
|
/**
|
|
16531
16747
|
* Sets the column resize mode. split resize mode 'grows' or 'shrinks' the resize element's size and 'shrinks' or 'grows' the next sibling element's size. growAndShrink resize mode 'grows' or 'shrinks' the resize element's size
|
|
16532
16748
|
* Default value: none
|
|
@@ -16539,48 +16755,13 @@ export interface GridBehavior {
|
|
|
16539
16755
|
rowResizeMode?: GridResizeMode | string;
|
|
16540
16756
|
}
|
|
16541
16757
|
|
|
16542
|
-
/**
|
|
16543
|
-
export interface
|
|
16544
|
-
/**
|
|
16545
|
-
* Enables or disables the Cells Value wrapping. When the property is true, cell value can wrap in multiple lines.
|
|
16546
|
-
* Default value: false
|
|
16547
|
-
*/
|
|
16548
|
-
allowCellsWrap?: boolean;
|
|
16549
|
-
/**
|
|
16550
|
-
* Automatically sets width to any new Column which does not have its 'width' property set.
|
|
16551
|
-
* Default value: false
|
|
16552
|
-
*/
|
|
16553
|
-
autoSizeNewColumn?: boolean;
|
|
16554
|
-
/**
|
|
16555
|
-
* Sets the width of the auto-generated Grid columns.
|
|
16556
|
-
* Default value: null
|
|
16557
|
-
*/
|
|
16558
|
-
autoGenerateColumnWidth?: string | number | null;
|
|
16559
|
-
/**
|
|
16560
|
-
* Sets the width of the Grid columns.
|
|
16561
|
-
* Default value: null
|
|
16562
|
-
*/
|
|
16563
|
-
columnWidth?: string | number | null;
|
|
16564
|
-
/**
|
|
16565
|
-
* Sets the height of the Grid columns.
|
|
16566
|
-
* Default value: null
|
|
16567
|
-
*/
|
|
16568
|
-
columnHeight?: string | number | null;
|
|
16569
|
-
/**
|
|
16570
|
-
* Sets the minimum height of the Grid columns.
|
|
16571
|
-
* Default value: 30
|
|
16572
|
-
*/
|
|
16573
|
-
columnMinHeight?: number;
|
|
16574
|
-
/**
|
|
16575
|
-
* Sets the minimum height of the Grid rows.
|
|
16576
|
-
* Default value: 30
|
|
16577
|
-
*/
|
|
16578
|
-
rowMinHeight?: number;
|
|
16758
|
+
/**Describes the column header settings. */
|
|
16759
|
+
export interface GridColumnHeader {
|
|
16579
16760
|
/**
|
|
16580
|
-
* Sets the
|
|
16581
|
-
* Default value:
|
|
16761
|
+
* Sets the column header visibility.
|
|
16762
|
+
* Default value: true
|
|
16582
16763
|
*/
|
|
16583
|
-
|
|
16764
|
+
visible?: boolean;
|
|
16584
16765
|
}
|
|
16585
16766
|
|
|
16586
16767
|
/**The <em>clipboard</em> property is used to enable/disable clipboard operations with Ctrl+C, Ctrl+X and Ctrl+V keyboard navigations.. */
|
|
@@ -16629,10 +16810,10 @@ export interface GridColumn {
|
|
|
16629
16810
|
*/
|
|
16630
16811
|
allowSelect?: boolean | null;
|
|
16631
16812
|
/**
|
|
16632
|
-
* Sets or gets whether the column can be edited.
|
|
16813
|
+
* Sets or gets whether the column can be edited. The property can be 'boolean' i.e accept true and false values. To dynamically determine which cells are editable, a callback function can be supplied to the 'allowEdit' property. For example: allowEdit: (id, dataField, value, data) => { return value === 'Cappuccino'; }
|
|
16633
16814
|
* Default value: true
|
|
16634
16815
|
*/
|
|
16635
|
-
allowEdit?:
|
|
16816
|
+
allowEdit?: any;
|
|
16636
16817
|
/**
|
|
16637
16818
|
* Sets or gets whether the column can be sorted.
|
|
16638
16819
|
* Default value: true
|
|
@@ -16663,6 +16844,11 @@ export interface GridColumn {
|
|
|
16663
16844
|
* Default value: true
|
|
16664
16845
|
*/
|
|
16665
16846
|
allowNull?: boolean;
|
|
16847
|
+
/**
|
|
16848
|
+
* Sets or gets the cell's height in card view mode.
|
|
16849
|
+
* Default value: false
|
|
16850
|
+
*/
|
|
16851
|
+
cardHeight?: number;
|
|
16666
16852
|
/**
|
|
16667
16853
|
* Sets or gets the column's cells format. This property is used for applying a formatting to the cell values. Number format strings: 'd' - decimal numbers.'f' - floating-point numbers.'n' - integer numbers.'c' - currency numbers.'p' - percentage numbers.For adding decimal places to the numbers, add a number after the formatting striFor example: 'c3' displays a number in this format $25.256Built-in Date formats:// short date pattern'd' - 'M/d/yyyy',// long date pattern'D' - 'dddd, MMMM dd, yyyy',// short time pattern't' - 'h:mm tt',// long time pattern'T' - 'h:mm:ss tt',// long date, short time pattern'f' - 'dddd, MMMM dd, yyyy h:mm tt',// long date, long time pattern'F' - 'dddd, MMMM dd, yyyy h:mm:ss tt',// month/day pattern'M' - 'MMMM dd',// month/year pattern'Y' - 'yyyy MMMM',// S is a sortable format that does not vary by culture'S' - 'yyyy'-'MM'-'dd'T'HH':'mm':'ss'Date format strings:'d'-the day of the month;'dd'-the day of the month'ddd'-the abbreviated name of the day of the week'dddd'- the full name of the day of the week'h'-the hour, using a 12-hour clock from 1 to 12'hh'-the hour, using a 12-hour clock from 01 to 12'H'-the hour, using a 24-hour clock from 0 to 23'HH'- the hour, using a 24-hour clock from 00 to 23'm'-the minute, from 0 through 59'mm'-the minutes,from 00 though59'M'- the month, from 1 through 12'MM'- the month, from 01 through 12'MMM'-the abbreviated name of the month'MMMM'-the full name of the month's'-the second, from 0 through 59'ss'-the second, from 00 through 59't'- the first character of the AM/PM designator'tt'-the AM/PM designator'y'- the year, from 0 to 99'yy'- the year, from 00 to 99'yyy'-the year, with a minimum of three digits'yyyy'-the year as a four-digit number;'yyyyy'-the year as a four-digit number.
|
|
16668
16854
|
* Default value: ""
|
|
@@ -16723,6 +16909,11 @@ export interface GridColumn {
|
|
|
16723
16909
|
* Default value: ""
|
|
16724
16910
|
*/
|
|
16725
16911
|
description?: string;
|
|
16912
|
+
/**
|
|
16913
|
+
* Sets or gets custom data object related to the column.
|
|
16914
|
+
* Default value: null
|
|
16915
|
+
*/
|
|
16916
|
+
dataSet?: any;
|
|
16726
16917
|
/**
|
|
16727
16918
|
* Gets the HTML Element. The property returns null when the Column is not in the View.
|
|
16728
16919
|
* Default value: null
|
|
@@ -16748,6 +16939,11 @@ export interface GridColumn {
|
|
|
16748
16939
|
* Default value: default
|
|
16749
16940
|
*/
|
|
16750
16941
|
filterMenuMode?: GridColumnFilterMenuMode | string;
|
|
16942
|
+
/**
|
|
16943
|
+
* Sets or gets the column's filter editor. The value is an object with the following possible options: template: string, condition: string, onInit: any - callback function for init purposes, min: number, max: number, minLength: number, maxLength: number
|
|
16944
|
+
* Default value: null
|
|
16945
|
+
*/
|
|
16946
|
+
filterEditor?: any;
|
|
16751
16947
|
/**
|
|
16752
16948
|
* Sets or gets the column's format function.
|
|
16753
16949
|
* Default value: null
|
|
@@ -16758,6 +16954,11 @@ export interface GridColumn {
|
|
|
16758
16954
|
* Default value: [object Object]
|
|
16759
16955
|
*/
|
|
16760
16956
|
formatSettings?: any;
|
|
16957
|
+
/**
|
|
16958
|
+
* Sets or gets the column's formula. The formula you set will be applied to all cells. Example: COL(Name) & '-' & COL(Price) or IF(COL(Price) * COL(Quantity) > 5, 'Yes', 'No')
|
|
16959
|
+
* Default value: ""
|
|
16960
|
+
*/
|
|
16961
|
+
formula?: string;
|
|
16761
16962
|
/**
|
|
16762
16963
|
* Sets or gets the column's group.
|
|
16763
16964
|
* Default value: ""
|
|
@@ -16798,6 +16999,16 @@ export interface GridColumn {
|
|
|
16798
16999
|
* Default value: null
|
|
16799
17000
|
*/
|
|
16800
17001
|
rowSpan?: {(cellValue: any, rowIndex: number, data: any): number};
|
|
17002
|
+
/**
|
|
17003
|
+
* Sets or gets the relation id in the dataSourceSettings.relations. The 'relationField' property should be set.
|
|
17004
|
+
* Default value: ""
|
|
17005
|
+
*/
|
|
17006
|
+
relationId?: string;
|
|
17007
|
+
/**
|
|
17008
|
+
* Sets or gets the relation field in the dataSourceSettings.relations. The 'relationId' property should be set.
|
|
17009
|
+
* Default value: ""
|
|
17010
|
+
*/
|
|
17011
|
+
relationField?: string;
|
|
16801
17012
|
/**
|
|
16802
17013
|
* Sets or gets the sort order of the column. Accepts: 'asc', 'desc' and null.
|
|
16803
17014
|
* Default value: null
|
|
@@ -16834,10 +17045,15 @@ export interface GridColumn {
|
|
|
16834
17045
|
*/
|
|
16835
17046
|
width?: string | number;
|
|
16836
17047
|
/**
|
|
16837
|
-
* Sets or gets the column's template. The property expects the 'id' of HTMLTemplateElement or HTML string which is displayed in the cells. Built-in string values are: 'checkBox', 'switchButton', '
|
|
17048
|
+
* Sets or gets the column's template. The property expects the 'id' of HTMLTemplateElement or HTML string which is displayed in the cells. Built-in string values are: 'checkBox', 'switchButton', 'url', 'email', 'dropdownlist', 'list', 'progress', 'tags', 'autoNumber', 'modifiedBy', 'createdBy', 'createdTime', 'modifiedTime', 'images', 'checklist', 'attachments', 'sparklines', 'richText', 'color', 'rating', 'duration', 'startDate', 'dueDates'. For example, when you set the template to 'url', the cells will be render anchor tags. When you set the template property to HTMLTemplateElement you should consider that once a template is rendered, the formatObject.template property stores the rendered template component for further use.
|
|
16838
17049
|
* Default value:
|
|
16839
17050
|
*/
|
|
16840
17051
|
template?: any;
|
|
17052
|
+
/**
|
|
17053
|
+
* Sets or gets additional settings related to the column's template. For example, when the template is 'sparklines', the templateSettings could be an object which defines has 'type' - 'bar', 'column', 'line' or 'pie'. If you want to apply a custom color, you can add the 'colorFunction: function(value) { } and return a custom color as a 'hex' string or a 'tooltipFormatFunction: function(value) {}' which returns a formatted tooltip string. Additional properties are 'min', 'max', 'gap' and 'strokeWidth'.
|
|
17054
|
+
* Default value: null
|
|
17055
|
+
*/
|
|
17056
|
+
templateSettings?: any;
|
|
16841
17057
|
/**
|
|
16842
17058
|
* Sets or gets the column's validation rules. The expected value is an Array of Objects. Each object should have a 'type' property that can be set to 'required', 'min', 'max', 'minLength', 'maxLength', 'email', 'null', 'requiredTrue', 'minData', 'maxDate', 'pattern'. The 'value' property should be set, too. For validation rule types 'required', 'requiredTrue' and 'null' you can skip the 'value' property. Optional property is 'message', which determines the error message.
|
|
16843
17059
|
* Default value: null
|
|
@@ -16872,6 +17088,11 @@ export interface GridContextMenu {
|
|
|
16872
17088
|
* Default value: false
|
|
16873
17089
|
*/
|
|
16874
17090
|
enabled?: boolean;
|
|
17091
|
+
/**
|
|
17092
|
+
* Sets an array of custom context menu items to be displayed in the context menu.
|
|
17093
|
+
* Default value: null
|
|
17094
|
+
*/
|
|
17095
|
+
customContextMenuItems?: any[];
|
|
16875
17096
|
/**
|
|
16876
17097
|
* Sets the data sources to the context menu.
|
|
16877
17098
|
* Default value: [object Object]
|
|
@@ -17339,6 +17560,11 @@ export interface GridDataSourceSettings {
|
|
|
17339
17560
|
* Default value: "."
|
|
17340
17561
|
*/
|
|
17341
17562
|
mapChar?: string;
|
|
17563
|
+
/**
|
|
17564
|
+
* Sets or gets the Grid relations. The property expects an array of objects. Each object should have '{id: string, label: string, columns: GridColumn[], dataSource: any}'. Once you have the relations defined, when you create a column, you can set 'relationId' and 'relationField'. This will automatically define a new column editor based on the relation settings.
|
|
17565
|
+
* Default value: null
|
|
17566
|
+
*/
|
|
17567
|
+
relations?: any;
|
|
17342
17568
|
/**
|
|
17343
17569
|
* Sets the virtual data source function which is called each time the Grid requests data. Example for calling the callback function with the new data set: resultCallbackFunction({dataSource: data}); Demos using 'virtualDataSource' are available on the Grid demos page. Example: https://www.htmlelements.com/demos/grid/virtualscroll/
|
|
17344
17570
|
* Default value: null
|
|
@@ -17401,6 +17627,11 @@ export interface GridEditing {
|
|
|
17401
17627
|
* Default value: click
|
|
17402
17628
|
*/
|
|
17403
17629
|
action?: GridEditingAction | string;
|
|
17630
|
+
/**
|
|
17631
|
+
* Read Only Edit is a mode in the grid whereby Cell Editing will not update the data inside the grid. Instead the grid invokes the 'onCellEditRequest' function allowing the application to process the update request.
|
|
17632
|
+
* Default value: false
|
|
17633
|
+
*/
|
|
17634
|
+
readOnlyEdit?: boolean;
|
|
17404
17635
|
/**
|
|
17405
17636
|
* Describes command keys.
|
|
17406
17637
|
* Default value: [object Object]
|
|
@@ -17751,6 +17982,20 @@ export interface GridFilteringFilterBuilder {
|
|
|
17751
17982
|
height?: number | null;
|
|
17752
17983
|
}
|
|
17753
17984
|
|
|
17985
|
+
/**Describes the footer settings of the grid. */
|
|
17986
|
+
export interface GridFooter {
|
|
17987
|
+
/**
|
|
17988
|
+
* Sets the footer visibility.
|
|
17989
|
+
* Default value: false
|
|
17990
|
+
*/
|
|
17991
|
+
visible?: boolean;
|
|
17992
|
+
/**
|
|
17993
|
+
* Sets a template for the footer.
|
|
17994
|
+
* Default value:
|
|
17995
|
+
*/
|
|
17996
|
+
template?: string | HTMLTemplateElement | {(element: HTMLElement): void};
|
|
17997
|
+
}
|
|
17998
|
+
|
|
17754
17999
|
/**Describes the grid's grouping settings. */
|
|
17755
18000
|
export interface GridGrouping {
|
|
17756
18001
|
/**
|
|
@@ -17863,38 +18108,141 @@ export interface GridGroupingSummaryRow {
|
|
|
17863
18108
|
visible?: boolean;
|
|
17864
18109
|
}
|
|
17865
18110
|
|
|
17866
|
-
/**
|
|
17867
|
-
export interface
|
|
18111
|
+
/**Describes the settings for the group header. */
|
|
18112
|
+
export interface GridGroupHeader {
|
|
17868
18113
|
/**
|
|
17869
|
-
* Sets
|
|
17870
|
-
* Default value:
|
|
18114
|
+
* Sets the visibility of the group header.
|
|
18115
|
+
* Default value: false
|
|
17871
18116
|
*/
|
|
17872
|
-
|
|
18117
|
+
visible?: boolean;
|
|
17873
18118
|
/**
|
|
17874
|
-
* Sets
|
|
17875
|
-
* Default value:
|
|
18119
|
+
* Sets a template for the group header.
|
|
18120
|
+
* Default value:
|
|
17876
18121
|
*/
|
|
17877
|
-
|
|
18122
|
+
template?: string | HTMLTemplateElement;
|
|
18123
|
+
}
|
|
18124
|
+
|
|
18125
|
+
/**Describes the header settings of the grid. */
|
|
18126
|
+
export interface GridHeader {
|
|
17878
18127
|
/**
|
|
17879
|
-
* Sets
|
|
17880
|
-
* Default value:
|
|
18128
|
+
* Sets the header visibility.
|
|
18129
|
+
* Default value: false
|
|
17881
18130
|
*/
|
|
17882
|
-
|
|
18131
|
+
visible?: boolean;
|
|
17883
18132
|
/**
|
|
17884
|
-
*
|
|
17885
|
-
* Default value:
|
|
18133
|
+
* Sets a template for the header.
|
|
18134
|
+
* Default value:
|
|
17886
18135
|
*/
|
|
17887
|
-
|
|
18136
|
+
template?: string | HTMLTemplateElement | {(element: HTMLElement): void};
|
|
17888
18137
|
/**
|
|
17889
|
-
*
|
|
17890
|
-
* Default value:
|
|
18138
|
+
* This callback function can be used for customization of the Header toolbar. The Toolbar HTML Element is passed as an argument.
|
|
18139
|
+
* Default value: null
|
|
17891
18140
|
*/
|
|
17892
|
-
|
|
18141
|
+
onInit?: {(element: HTMLElement): void};
|
|
17893
18142
|
/**
|
|
17894
|
-
*
|
|
17895
|
-
* Default value:
|
|
18143
|
+
* Determines the buttons displayed in the Grid header. 'columns' displays a button opening the columns chooser panel. 'filter' displays a button opening the filtering panel. 'group' displays a button opening the grouping panel. 'sort' displays a button opening the sorting panel. 'format' displays a button opening the conditional formatting panel. 'search' displays a button opening the search panel. 'colors' displays a button with colors options for formatting.
|
|
18144
|
+
* Default value: [ "columns", "filter", "group", "sort", "format", "search" ]
|
|
17896
18145
|
*/
|
|
17897
|
-
|
|
18146
|
+
buttons?: string[];
|
|
18147
|
+
/**
|
|
18148
|
+
* Sets the search command type.
|
|
18149
|
+
* Default value: search
|
|
18150
|
+
*/
|
|
18151
|
+
searchCommand?: GridHeaderSearchCommand | string;
|
|
18152
|
+
/**
|
|
18153
|
+
* Custom toolbar button. Allows you to add a custom button to the toolbar.
|
|
18154
|
+
* Default value: [object Object]
|
|
18155
|
+
*/
|
|
18156
|
+
customButton?: GridCommand;
|
|
18157
|
+
}
|
|
18158
|
+
|
|
18159
|
+
/**An object containing settings related to the grid's layout. */
|
|
18160
|
+
export interface GridLayout {
|
|
18161
|
+
/**
|
|
18162
|
+
* Enables or disables the Cells Value wrapping. When the property is true, cell value can wrap in multiple lines.
|
|
18163
|
+
* Default value: false
|
|
18164
|
+
*/
|
|
18165
|
+
allowCellsWrap?: boolean;
|
|
18166
|
+
/**
|
|
18167
|
+
* Automatically sets width to any new Column which does not have its 'width' property set.
|
|
18168
|
+
* Default value: false
|
|
18169
|
+
*/
|
|
18170
|
+
autoSizeNewColumn?: boolean;
|
|
18171
|
+
/**
|
|
18172
|
+
* Sets the min width of the new column.
|
|
18173
|
+
* Default value: 250
|
|
18174
|
+
*/
|
|
18175
|
+
autoSizeNewColumnMinWidth?: number;
|
|
18176
|
+
/**
|
|
18177
|
+
* Automatically sets the height of the Grid.
|
|
18178
|
+
* Default value: false
|
|
18179
|
+
*/
|
|
18180
|
+
autoHeight?: boolean;
|
|
18181
|
+
/**
|
|
18182
|
+
* Automatically sets the width of the Grid. All columns should have a 'width' property set to a number in order to use this feature.
|
|
18183
|
+
* Default value: false
|
|
18184
|
+
*/
|
|
18185
|
+
autoWidth?: boolean;
|
|
18186
|
+
/**
|
|
18187
|
+
* Sets the width of the auto-generated Grid columns.
|
|
18188
|
+
* Default value: null
|
|
18189
|
+
*/
|
|
18190
|
+
autoGenerateColumnWidth?: string | number | null;
|
|
18191
|
+
/**
|
|
18192
|
+
* Sets the width of the Grid columns.
|
|
18193
|
+
* Default value: null
|
|
18194
|
+
*/
|
|
18195
|
+
columnWidth?: string | number | null;
|
|
18196
|
+
/**
|
|
18197
|
+
* Sets the height of the Grid columns.
|
|
18198
|
+
* Default value: null
|
|
18199
|
+
*/
|
|
18200
|
+
columnHeight?: string | number | null;
|
|
18201
|
+
/**
|
|
18202
|
+
* Sets the minimum height of the Grid columns.
|
|
18203
|
+
* Default value: 30
|
|
18204
|
+
*/
|
|
18205
|
+
columnMinHeight?: number;
|
|
18206
|
+
/**
|
|
18207
|
+
* Sets the minimum width of a card in card view.
|
|
18208
|
+
* Default value: 250
|
|
18209
|
+
*/
|
|
18210
|
+
cardMinWidth?: number;
|
|
18211
|
+
/**
|
|
18212
|
+
* Sets the cards per row.
|
|
18213
|
+
* Default value: null
|
|
18214
|
+
*/
|
|
18215
|
+
cardsPerRow?: number;
|
|
18216
|
+
/**
|
|
18217
|
+
* Sets whether cards are vertically oriented. In this layout mode, the column label is displayed above the column value
|
|
18218
|
+
* Default value: false
|
|
18219
|
+
*/
|
|
18220
|
+
cardVertical?: boolean;
|
|
18221
|
+
/**
|
|
18222
|
+
* Sets the width of the Grid when displayed in a drop-down mode.
|
|
18223
|
+
* Default value: 700
|
|
18224
|
+
*/
|
|
18225
|
+
dropDownWidth?: number;
|
|
18226
|
+
/**
|
|
18227
|
+
* Sets the height of the Grid when displayed in a drop-down mode.
|
|
18228
|
+
* Default value: 500
|
|
18229
|
+
*/
|
|
18230
|
+
dropDownHeight?: number;
|
|
18231
|
+
/**
|
|
18232
|
+
* Sets the minimum height of the Grid rows.
|
|
18233
|
+
* Default value: 30
|
|
18234
|
+
*/
|
|
18235
|
+
rowMinHeight?: number;
|
|
18236
|
+
/**
|
|
18237
|
+
* Sets the height of the Grid rows. The property can be set to null, auto or a number.
|
|
18238
|
+
* Default value: null
|
|
18239
|
+
*/
|
|
18240
|
+
rowHeight?: string | number | null;
|
|
18241
|
+
/**
|
|
18242
|
+
* Sets the width of the view bar.
|
|
18243
|
+
* Default value: 250
|
|
18244
|
+
*/
|
|
18245
|
+
viewBarWidth?: number;
|
|
17898
18246
|
}
|
|
17899
18247
|
|
|
17900
18248
|
/**Describes the paging settings. */
|
|
@@ -18135,126 +18483,17 @@ export interface GridRowDetail {
|
|
|
18135
18483
|
dialog?: Dialog;
|
|
18136
18484
|
}
|
|
18137
18485
|
|
|
18138
|
-
|
|
18139
|
-
export interface GridColumnHeader {
|
|
18486
|
+
export interface GridRow {
|
|
18140
18487
|
/**
|
|
18141
|
-
* Sets the
|
|
18488
|
+
* Sets or gets the row can be expanded or collapsed.
|
|
18142
18489
|
* Default value: true
|
|
18143
18490
|
*/
|
|
18144
|
-
|
|
18145
|
-
}
|
|
18146
|
-
|
|
18147
|
-
/**Describes the summary row settings. */
|
|
18148
|
-
export interface GridSummaryRow {
|
|
18491
|
+
allowToggle?: boolean;
|
|
18149
18492
|
/**
|
|
18150
|
-
* Sets the
|
|
18151
|
-
* Default value:
|
|
18493
|
+
* Sets or gets the row can be resized.
|
|
18494
|
+
* Default value: true
|
|
18152
18495
|
*/
|
|
18153
|
-
|
|
18154
|
-
/**
|
|
18155
|
-
* Sets the summary row editor. When you point over a summary row cell, an editor is displayed and you will be able to dynamically change the summary type.
|
|
18156
|
-
* Default value: false
|
|
18157
|
-
*/
|
|
18158
|
-
editing?: boolean;
|
|
18159
|
-
}
|
|
18160
|
-
|
|
18161
|
-
/**Sets the grid's state settings. */
|
|
18162
|
-
export interface GridStateSettings {
|
|
18163
|
-
/**
|
|
18164
|
-
* Enables or disables auto-save of the Grid's state
|
|
18165
|
-
* Default value: false
|
|
18166
|
-
*/
|
|
18167
|
-
autoSave?: boolean;
|
|
18168
|
-
/**
|
|
18169
|
-
* Enables or disables save/load of the grid state.
|
|
18170
|
-
* Default value: true
|
|
18171
|
-
*/
|
|
18172
|
-
enabled?: boolean;
|
|
18173
|
-
/**
|
|
18174
|
-
* Sets or gets the current state.
|
|
18175
|
-
* Default value: ""
|
|
18176
|
-
*/
|
|
18177
|
-
current?: string;
|
|
18178
|
-
/**
|
|
18179
|
-
* Container which is auto-filled with state objects when you call the saveState method or enable the autoSave of states. Each object has a key which is the state's name and value which is a json with the state's properties.
|
|
18180
|
-
* Default value: null
|
|
18181
|
-
*/
|
|
18182
|
-
storage?: any;
|
|
18183
|
-
/**
|
|
18184
|
-
* Function called when the state is changed.
|
|
18185
|
-
* Default value:
|
|
18186
|
-
*/
|
|
18187
|
-
onStateChange?: any;
|
|
18188
|
-
/**
|
|
18189
|
-
* Array with state options such as 'sort', 'filter', 'expandedRows', 'paging', 'selectedCells', 'selectedRows', 'group', 'columns'. This property determines which parts of the state would be saved or loaded.
|
|
18190
|
-
* Default value:
|
|
18191
|
-
*/
|
|
18192
|
-
options?: string[];
|
|
18193
|
-
}
|
|
18194
|
-
|
|
18195
|
-
/**Describes the settings for the group header. */
|
|
18196
|
-
export interface GridGroupHeader {
|
|
18197
|
-
/**
|
|
18198
|
-
* Sets the visibility of the group header.
|
|
18199
|
-
* Default value: false
|
|
18200
|
-
*/
|
|
18201
|
-
visible?: boolean;
|
|
18202
|
-
/**
|
|
18203
|
-
* Sets a template for the group header.
|
|
18204
|
-
* Default value:
|
|
18205
|
-
*/
|
|
18206
|
-
template?: string | HTMLTemplateElement;
|
|
18207
|
-
}
|
|
18208
|
-
|
|
18209
|
-
/**Describes the header settings of the grid. */
|
|
18210
|
-
export interface GridHeader {
|
|
18211
|
-
/**
|
|
18212
|
-
* Sets the header visibility.
|
|
18213
|
-
* Default value: false
|
|
18214
|
-
*/
|
|
18215
|
-
visible?: boolean;
|
|
18216
|
-
/**
|
|
18217
|
-
* Sets a template for the header.
|
|
18218
|
-
* Default value:
|
|
18219
|
-
*/
|
|
18220
|
-
template?: string | HTMLTemplateElement | {(element: HTMLElement): void};
|
|
18221
|
-
/**
|
|
18222
|
-
* This callback function can be used for customization of the Header toolbar. The Toolbar HTML Element is passed as an argument.
|
|
18223
|
-
* Default value: null
|
|
18224
|
-
*/
|
|
18225
|
-
onInit?: {(element: HTMLElement): void};
|
|
18226
|
-
/**
|
|
18227
|
-
* Determines the buttons displayed in the Grid header. 'columns' displays a button opening the columns chooser panel. 'filter' displays a button opening the filtering panel. 'group' displays a button opening the grouping panel. 'sort' displays a button opening the sorting panel. 'format' displays a button opening the conditional formatting panel. 'search' displays a button opening the search panel.
|
|
18228
|
-
* Default value: [ "columns", "filter", "group", "sort", "format", "search" ]
|
|
18229
|
-
*/
|
|
18230
|
-
buttons?: string[];
|
|
18231
|
-
}
|
|
18232
|
-
|
|
18233
|
-
/**Describes the footer settings of the grid. */
|
|
18234
|
-
export interface GridFooter {
|
|
18235
|
-
/**
|
|
18236
|
-
* Sets the footer visibility.
|
|
18237
|
-
* Default value: false
|
|
18238
|
-
*/
|
|
18239
|
-
visible?: boolean;
|
|
18240
|
-
/**
|
|
18241
|
-
* Sets a template for the footer.
|
|
18242
|
-
* Default value:
|
|
18243
|
-
*/
|
|
18244
|
-
template?: string | HTMLTemplateElement | {(element: HTMLElement): void};
|
|
18245
|
-
}
|
|
18246
|
-
|
|
18247
|
-
export interface GridRow {
|
|
18248
|
-
/**
|
|
18249
|
-
* Sets or gets the row can be expanded or collapsed.
|
|
18250
|
-
* Default value: true
|
|
18251
|
-
*/
|
|
18252
|
-
allowToggle?: boolean;
|
|
18253
|
-
/**
|
|
18254
|
-
* Sets or gets the row can be resized.
|
|
18255
|
-
* Default value: true
|
|
18256
|
-
*/
|
|
18257
|
-
allowResize?: boolean;
|
|
18496
|
+
allowResize?: boolean;
|
|
18258
18497
|
/**
|
|
18259
18498
|
* Sets or gets the row can be selected.
|
|
18260
18499
|
* Default value: true
|
|
@@ -18500,6 +18739,59 @@ export interface GridCell {
|
|
|
18500
18739
|
setStyle?: {(value: any): void};
|
|
18501
18740
|
}
|
|
18502
18741
|
|
|
18742
|
+
/**Describes the summary row settings. */
|
|
18743
|
+
export interface GridSummaryRow {
|
|
18744
|
+
/**
|
|
18745
|
+
* Sets the summary row visibility.
|
|
18746
|
+
* Default value: false
|
|
18747
|
+
*/
|
|
18748
|
+
visible?: boolean;
|
|
18749
|
+
/**
|
|
18750
|
+
* Sets the summary row editor. When you point over a summary row cell, an editor is displayed and you will be able to dynamically change the summary type.
|
|
18751
|
+
* Default value: false
|
|
18752
|
+
*/
|
|
18753
|
+
editing?: boolean;
|
|
18754
|
+
}
|
|
18755
|
+
|
|
18756
|
+
/**Sets the grid's state settings. */
|
|
18757
|
+
export interface GridStateSettings {
|
|
18758
|
+
/**
|
|
18759
|
+
* Enables or disables auto-save of the Grid's state
|
|
18760
|
+
* Default value: false
|
|
18761
|
+
*/
|
|
18762
|
+
autoSave?: boolean;
|
|
18763
|
+
/**
|
|
18764
|
+
* Enables or disables auto-load of the Grid's state on page reload.
|
|
18765
|
+
* Default value: false
|
|
18766
|
+
*/
|
|
18767
|
+
autoLoad?: boolean;
|
|
18768
|
+
/**
|
|
18769
|
+
* Enables or disables save/load of the grid state.
|
|
18770
|
+
* Default value: true
|
|
18771
|
+
*/
|
|
18772
|
+
enabled?: boolean;
|
|
18773
|
+
/**
|
|
18774
|
+
* Sets or gets the current state.
|
|
18775
|
+
* Default value: ""
|
|
18776
|
+
*/
|
|
18777
|
+
current?: string;
|
|
18778
|
+
/**
|
|
18779
|
+
* Container which is auto-filled with state objects when you call the saveState method or enable the autoSave of states. Each object has a key which is the state's name and value which is a json with the state's properties.
|
|
18780
|
+
* Default value: null
|
|
18781
|
+
*/
|
|
18782
|
+
storage?: any;
|
|
18783
|
+
/**
|
|
18784
|
+
* Function called when the state is changed.
|
|
18785
|
+
* Default value:
|
|
18786
|
+
*/
|
|
18787
|
+
onStateChange?: any;
|
|
18788
|
+
/**
|
|
18789
|
+
* Array with state options such as 'sort', 'filter', 'expandedRows', 'paging', 'selectedCells', 'selectedRows', 'group', 'columns'. This property determines which parts of the state would be saved or loaded.
|
|
18790
|
+
* Default value:
|
|
18791
|
+
*/
|
|
18792
|
+
options?: string[];
|
|
18793
|
+
}
|
|
18794
|
+
|
|
18503
18795
|
/**Describes the selection settings. */
|
|
18504
18796
|
export interface GridSelection {
|
|
18505
18797
|
/**
|
|
@@ -18651,6 +18943,40 @@ export interface GridSorting {
|
|
|
18651
18943
|
sortToggleOnClickAndCommandKey?: boolean;
|
|
18652
18944
|
}
|
|
18653
18945
|
|
|
18946
|
+
/**Sets the grid's image and filter upload settings for the image and attachment columns. */
|
|
18947
|
+
export interface GridUploadSettings {
|
|
18948
|
+
/**
|
|
18949
|
+
* Sets or file/image upload url.
|
|
18950
|
+
* Default value: ""
|
|
18951
|
+
*/
|
|
18952
|
+
url?: string;
|
|
18953
|
+
/**
|
|
18954
|
+
* Sets or file/image remove url.
|
|
18955
|
+
* Default value: ""
|
|
18956
|
+
*/
|
|
18957
|
+
removeUrl?: string;
|
|
18958
|
+
/**
|
|
18959
|
+
* Sets or gets the upload field name. In the backend, you can use this name to access the images data. For example in expressJS, you can use something like that: const images = req['files']['userfile[]'];
|
|
18960
|
+
* Default value: "userfile[]"
|
|
18961
|
+
*/
|
|
18962
|
+
name?: string;
|
|
18963
|
+
/**
|
|
18964
|
+
* Additional data to pass to the server. The format should be a JSON string.
|
|
18965
|
+
* Default value: ""
|
|
18966
|
+
*/
|
|
18967
|
+
data?: string;
|
|
18968
|
+
/**
|
|
18969
|
+
* Function called when the upload is completed. JSON object with 'files', 'status', 'fileURL' and 'serverResponse' are passed as parameters when the function is called by the Grid.
|
|
18970
|
+
* Default value:
|
|
18971
|
+
*/
|
|
18972
|
+
onUploadCompleted?: any;
|
|
18973
|
+
/**
|
|
18974
|
+
* Function called when the upload has failed. JSON object with 'files', 'status' and 'serverResponse' are passed as parameters when the function is called by the Grid.
|
|
18975
|
+
* Default value:
|
|
18976
|
+
*/
|
|
18977
|
+
onUploadError?: any;
|
|
18978
|
+
}
|
|
18979
|
+
|
|
18654
18980
|
declare global {
|
|
18655
18981
|
interface Document {
|
|
18656
18982
|
createElement(tagName: "smart-grid"): Grid;
|
|
@@ -18701,6 +19027,8 @@ export declare type GridFilteringFilterMenuMode = 'default' | 'excel';
|
|
|
18701
19027
|
export declare type GridGroupingExpandMode = 'buttonClick' | 'rowClick';
|
|
18702
19028
|
/**Sets the group render mode. 'basic' mode renders the group headers without taking into account the indent, groupRowHeight and column label properties. 'compact' mode is the same as basic, but also renders the column labels in the group headers. The default mode is 'advanced', which adds indents to groups that depend on the group level. In 'multipleColumns' mode, each group is displayed in its column. */
|
|
18703
19029
|
export declare type GridGroupingRenderMode = 'basic' | 'compact' | 'advanced' | 'multipleColumns';
|
|
19030
|
+
/**Sets the search command type. */
|
|
19031
|
+
export declare type GridHeaderSearchCommand = 'search' | 'filter';
|
|
18704
19032
|
/**Sets the ellipsis display mode. */
|
|
18705
19033
|
export declare type GridPagerAutoEllipsis = 'none' | 'before' | 'after' | 'both';
|
|
18706
19034
|
/**Sets or gets whether the selection allows you to select 'one', 'many' or a variation of 'many' called 'extended'. 'one' allows you to have only single cell or row selected. 'many' */
|
|
@@ -19128,6 +19456,11 @@ export interface KanbanProperties {
|
|
|
19128
19456
|
* Default value: true
|
|
19129
19457
|
*/
|
|
19130
19458
|
allowDrop?: boolean;
|
|
19459
|
+
/**
|
|
19460
|
+
* Allows the dropping of tasks placeholder. When you drag a task over another task it will make an empty space for the task.
|
|
19461
|
+
* Default value: false
|
|
19462
|
+
*/
|
|
19463
|
+
allowDropPlaceholder?: boolean;
|
|
19131
19464
|
/**
|
|
19132
19465
|
* This property changes the visual appeal of the Kanban columns and tasks. When set to true and the Kanban columns have their 'color' property set, the color is also applied to the tasks and edit dialog.
|
|
19133
19466
|
* Default value: false
|
|
@@ -19238,6 +19571,11 @@ export interface KanbanProperties {
|
|
|
19238
19571
|
* Default value: false
|
|
19239
19572
|
*/
|
|
19240
19573
|
editable?: boolean;
|
|
19574
|
+
/**
|
|
19575
|
+
* Determines the edit behavior. It could be either singleClick or doubleClick. The dialog edit window is by default opened when user double clicks on a Kanban task.
|
|
19576
|
+
* Default value: doubleClick
|
|
19577
|
+
*/
|
|
19578
|
+
editMode?: KanbanEditMode | string;
|
|
19241
19579
|
/**
|
|
19242
19580
|
* Sets or gets the format string of the "Due date" label and the "Start date" and "Due date" editors.
|
|
19243
19581
|
* Default value: "d"
|
|
@@ -19749,10 +20087,10 @@ export interface Kanban extends BaseElement, KanbanProperties {
|
|
|
19749
20087
|
*/
|
|
19750
20088
|
getSelectedTasks(id: number): any;
|
|
19751
20089
|
/**
|
|
19752
|
-
* Gets the Kanban's state.
|
|
19753
|
-
* @returns
|
|
20090
|
+
* Gets the Kanban's state. Returns an object with the following type: { collapsed: {}, dataSource: [], filtering: { filters: [], operator: string }, selection: { selected: [], selectionStart?: number | string, selectionInColumn: string, swimlane: string }, sorting: { dataFields: [], dataTypes: [], orderBy: [] }, tabs: [], visibility: { taskActions: boolean, taskComments: boolean, taskDue: boolean, taskPriority: boolean, taskProgress: boolean, taskTags: boolean, taskUserIcon: boolean } }
|
|
20091
|
+
* @returns {any}
|
|
19754
20092
|
*/
|
|
19755
|
-
getState():
|
|
20093
|
+
getState(): any;
|
|
19756
20094
|
/**
|
|
19757
20095
|
* Loads the Kanban's state.
|
|
19758
20096
|
* @param state?. An object returned by one of the methods getState or saveState. If not passed, gets saved state from the browser's localStorage.
|
|
@@ -20063,6 +20401,8 @@ export declare type KanbanAddNewButtonDisplayMode = 'top' | 'bottom' | 'both';
|
|
|
20063
20401
|
export declare type KanbanColumnOrientation = 'vertical' | 'horizontal';
|
|
20064
20402
|
/**Determines the column edit behavior. With the 'header' option, edit starts on double click on the column's label. In 'menu' mode, edit is allowed from the 'columnActions' menu. In 'headerAndMenu' option, column editing includes both options. */
|
|
20065
20403
|
export declare type KanbanColumnEditMode = 'header' | 'menu' | 'headerAndMenu';
|
|
20404
|
+
/**Determines the edit behavior. It could be either singleClick or doubleClick. The dialog edit window is by default opened when user double clicks on a Kanban task. */
|
|
20405
|
+
export declare type KanbanEditMode = 'doubleClick' | 'singleClick';
|
|
20066
20406
|
/**Sets or gets the header position. The header contains the Customize, Filter, Sort, and Search buttons. */
|
|
20067
20407
|
export declare type KanbanHeaderPosition = 'none' | 'top' | 'bottom';
|
|
20068
20408
|
/**Sets or gets the way column hierarchy is represented. */
|
|
@@ -20855,6 +21195,11 @@ export interface ListBox extends BaseElement, ListBoxProperties {
|
|
|
20855
21195
|
* @returns {Node}
|
|
20856
21196
|
*/
|
|
20857
21197
|
appendChild<T extends Node>(node: Node): T;
|
|
21198
|
+
/**
|
|
21199
|
+
* Adds a new item(s).
|
|
21200
|
+
* @param {any} item. Describes the properties of the item that will be inserted. You can also pass an array of items.
|
|
21201
|
+
*/
|
|
21202
|
+
add(item: any): void;
|
|
20858
21203
|
/**
|
|
20859
21204
|
* Removes all items from the listBox.
|
|
20860
21205
|
*/
|
|
@@ -20863,6 +21208,10 @@ export interface ListBox extends BaseElement, ListBoxProperties {
|
|
|
20863
21208
|
* Unselects all items.
|
|
20864
21209
|
*/
|
|
20865
21210
|
clearSelection(): void;
|
|
21211
|
+
/**
|
|
21212
|
+
* Performs a data bind. This can be used to refresh the data source.
|
|
21213
|
+
*/
|
|
21214
|
+
dataBind(): void;
|
|
20866
21215
|
/**
|
|
20867
21216
|
* Ensures the target item is visible by scrolling to it.
|
|
20868
21217
|
* @param {HTMLElement | string} item. A list item or value of the desired item to be visible.
|
|
@@ -24700,6 +25049,21 @@ export interface PivotTableProperties {
|
|
|
24700
25049
|
* Default value: null
|
|
24701
25050
|
*/
|
|
24702
25051
|
onInit?: { (): void };
|
|
25052
|
+
/**
|
|
25053
|
+
* Sets or gets the page size (when paging is enabled).
|
|
25054
|
+
* Default value: 10
|
|
25055
|
+
*/
|
|
25056
|
+
pageSize?: PivotTablePageSize | string;
|
|
25057
|
+
/**
|
|
25058
|
+
* Sets or gets the current (zero-based) page index (when paging is enabled).
|
|
25059
|
+
* Default value: 0
|
|
25060
|
+
*/
|
|
25061
|
+
pageIndex?: number;
|
|
25062
|
+
/**
|
|
25063
|
+
* Sets or gets whether paging is enabled.
|
|
25064
|
+
* Default value: false
|
|
25065
|
+
*/
|
|
25066
|
+
paging?: boolean;
|
|
24703
25067
|
/**
|
|
24704
25068
|
* Sets or gets the value indicating whether the element is aligned to support locales using right-to-left fonts.
|
|
24705
25069
|
* Default value: false
|
|
@@ -25044,6 +25408,8 @@ export declare type PivotTableDesignerPosition = 'near' | 'far';
|
|
|
25044
25408
|
export declare type PivotTableDrillDownDataExport = null | 'xlsx' | 'pdf' | 'html' | 'json' | 'csv' | 'tsv' | 'xml';
|
|
25045
25409
|
/**Sets or gets the way row nesting (based on rowGroup columns) is displayed. */
|
|
25046
25410
|
export declare type PivotTableGroupLayout = 'classic' | 'default';
|
|
25411
|
+
/**Sets or gets the page size (when paging is enabled). */
|
|
25412
|
+
export declare type PivotTablePageSize = '10' | '25' | '50';
|
|
25047
25413
|
/**Sets or gets the position of row total columns (shown when rowTotals is enabled). */
|
|
25048
25414
|
export declare type PivotTableRowTotalsPosition = 'near' | 'far';
|
|
25049
25415
|
/**Sets or gets the selection mode. Only applicable when selection is enabled. */
|
|
@@ -25283,6 +25649,11 @@ export interface QRcodeProperties {
|
|
|
25283
25649
|
* Default value: "H"
|
|
25284
25650
|
*/
|
|
25285
25651
|
errorLevel?: string;
|
|
25652
|
+
/**
|
|
25653
|
+
* Sets color to the transparent parts of the embedded image. Background remains transparent if set to empty string.
|
|
25654
|
+
* Default value: ""
|
|
25655
|
+
*/
|
|
25656
|
+
imageBackgroundColor?: string;
|
|
25286
25657
|
/**
|
|
25287
25658
|
* Sets the height of the embedded image.
|
|
25288
25659
|
* Default value: 15
|
|
@@ -25343,6 +25714,16 @@ export interface QRcodeProperties {
|
|
|
25343
25714
|
* Default value: ""
|
|
25344
25715
|
*/
|
|
25345
25716
|
value?: string;
|
|
25717
|
+
/**
|
|
25718
|
+
* Sets or gets the width of the QR Code. If the width is set to 0, the width of the QR Code is calculated automatically.
|
|
25719
|
+
* Default value: 0
|
|
25720
|
+
*/
|
|
25721
|
+
width?: number;
|
|
25722
|
+
/**
|
|
25723
|
+
* Sets or gets the height of the QR Code. If the height is set to 0, the height of the QR Code is calculated automatically.
|
|
25724
|
+
* Default value: 0
|
|
25725
|
+
*/
|
|
25726
|
+
height?: number;
|
|
25346
25727
|
}
|
|
25347
25728
|
/**
|
|
25348
25729
|
QR Codes encode text values in a two-dimensional pattern.
|
|
@@ -25860,238 +26241,660 @@ export interface RadioButton extends BaseElement, RadioButtonProperties {
|
|
|
25860
26241
|
* oldValue - A boolean value indicating the previous state of the button ( checked or not ).
|
|
25861
26242
|
* changeType - A string flag indicating whether the change event was triggered via API or an event.
|
|
25862
26243
|
*/
|
|
25863
|
-
onChange: ((this: any, ev: Event) => any) | null;
|
|
26244
|
+
onChange: ((this: any, ev: Event) => any) | null;
|
|
26245
|
+
/**
|
|
26246
|
+
* This event is triggered when the widget is checked.
|
|
26247
|
+
* @param event. The custom event. Custom data event was created with: ev.detail(changeType)
|
|
26248
|
+
* changeType - A string flag indicating whether the change event was triggered via API or an event.
|
|
26249
|
+
*/
|
|
26250
|
+
onCheckValue?: ((this: any, ev: Event) => any) | ((this: any, ev: CustomEvent<any>) => any) | null;
|
|
26251
|
+
/**
|
|
26252
|
+
* This event is triggered when the widget is unchecked.
|
|
26253
|
+
* @param event. The custom event. Custom data event was created with: ev.detail(changeType)
|
|
26254
|
+
* changeType - A string flag indicating whether the change event was triggered via API or an event.
|
|
26255
|
+
*/
|
|
26256
|
+
onUncheckValue?: ((this: any, ev: Event) => any) | ((this: any, ev: CustomEvent<any>) => any) | null;
|
|
26257
|
+
}
|
|
26258
|
+
|
|
26259
|
+
declare global {
|
|
26260
|
+
interface Document {
|
|
26261
|
+
createElement(tagName: "smart-radio-button"): RadioButton;
|
|
26262
|
+
querySelector(selectors: "smart-radio-button"): RadioButton | null;
|
|
26263
|
+
querySelectorAll(selectors: "smart-radio-button"): NodeListOf<RadioButton>;
|
|
26264
|
+
getElementsByTagName(qualifiedName: "smart-radio-button"): HTMLCollectionOf<RadioButton>;
|
|
26265
|
+
getElementsByName(elementName: "smart-radio-button"): NodeListOf<RadioButton>;
|
|
26266
|
+
}
|
|
26267
|
+
}
|
|
26268
|
+
|
|
26269
|
+
export interface RatingProperties {
|
|
26270
|
+
/**
|
|
26271
|
+
* Sets or gets the animation mode. Animation is disabled when the property is set to 'none'
|
|
26272
|
+
* Default value: advanced
|
|
26273
|
+
*/
|
|
26274
|
+
animation?: Animation | string;
|
|
26275
|
+
/**
|
|
26276
|
+
* Disables the interaction with the element.
|
|
26277
|
+
* Default value: false
|
|
26278
|
+
*/
|
|
26279
|
+
disabled?: boolean;
|
|
26280
|
+
/**
|
|
26281
|
+
* Sets or gets the language. Used in conjunction with the property messages.
|
|
26282
|
+
* Default value: "en"
|
|
26283
|
+
*/
|
|
26284
|
+
locale?: string;
|
|
26285
|
+
/**
|
|
26286
|
+
* Callback used to customize the format of the messages that are returned from the Localization Module.
|
|
26287
|
+
* Default value: null
|
|
26288
|
+
*/
|
|
26289
|
+
localizeFormatFunction?: any;
|
|
26290
|
+
/**
|
|
26291
|
+
* Determines the number of stars that will be displayed.
|
|
26292
|
+
* Default value:
|
|
26293
|
+
*/
|
|
26294
|
+
max?: number;
|
|
26295
|
+
/**
|
|
26296
|
+
* Sets or gets an object specifying strings used in the element that can be localized. Used in conjunction with the property locale.
|
|
26297
|
+
* Default value: * {
|
|
26298
|
+
* "en": {
|
|
26299
|
+
* "propertyUnknownType": "'' property is with undefined 'type' member!",
|
|
26300
|
+
* "propertyInvalidValue": "Invalid '!",
|
|
26301
|
+
* "propertyInvalidValueType": "Invalid '!",
|
|
26302
|
+
* "elementNotInDOM": "Element does not exist in DOM! Please, add the element to the DOM, before invoking a method.",
|
|
26303
|
+
* "moduleUndefined": "Module is undefined.",
|
|
26304
|
+
* "missingReference": ".",
|
|
26305
|
+
* "htmlTemplateNotSuported": ": Browser doesn't support HTMLTemplate elements.",
|
|
26306
|
+
* "invalidTemplate": "' property accepts a string that must match the id of an HTMLTemplate element from the DOM."
|
|
26307
|
+
* }
|
|
26308
|
+
* }
|
|
26309
|
+
*/
|
|
26310
|
+
messages?: any;
|
|
26311
|
+
/**
|
|
26312
|
+
* The name of the element. Used when submiting data inside a Form.
|
|
26313
|
+
* Default value: ""
|
|
26314
|
+
*/
|
|
26315
|
+
name?: string;
|
|
26316
|
+
/**
|
|
26317
|
+
* Sets or gets the value indicating whether the element is aligned to support locales using right-to-left fonts.
|
|
26318
|
+
* Default value: false
|
|
26319
|
+
*/
|
|
26320
|
+
rightToLeft?: boolean;
|
|
26321
|
+
/**
|
|
26322
|
+
* Determines the theme. Theme defines the look of the element
|
|
26323
|
+
* Default value: ""
|
|
26324
|
+
*/
|
|
26325
|
+
theme?: string;
|
|
26326
|
+
/**
|
|
26327
|
+
* If is set to true, the element cannot be focused.
|
|
26328
|
+
* Default value: false
|
|
26329
|
+
*/
|
|
26330
|
+
unfocusable?: boolean;
|
|
26331
|
+
/**
|
|
26332
|
+
* Determines the number of stars that will be marked as active.
|
|
26333
|
+
* Default value:
|
|
26334
|
+
*/
|
|
26335
|
+
value?: number;
|
|
26336
|
+
}
|
|
26337
|
+
/**
|
|
26338
|
+
Rating allows you to input a rating. It is broadly used in applications with reviews.
|
|
26339
|
+
*/
|
|
26340
|
+
export interface Rating extends BaseElement, RatingProperties {
|
|
26341
|
+
|
|
26342
|
+
/* Get a member by its name */
|
|
26343
|
+
[name: string]: any;
|
|
26344
|
+
/**
|
|
26345
|
+
* This event is triggered when the value of the slider is changed.
|
|
26346
|
+
* @param event. The custom event. Custom data event was created with: ev.detail(value, oldValue)
|
|
26347
|
+
* value - A numeric value indicating the scroll position.
|
|
26348
|
+
* oldValue - A numeric value indicating the previous scroll position.
|
|
26349
|
+
*/
|
|
26350
|
+
onChange: ((this: any, ev: Event) => any) | null;
|
|
26351
|
+
/**
|
|
26352
|
+
* Get the value of the rating.
|
|
26353
|
+
* @returns {number}
|
|
26354
|
+
*/
|
|
26355
|
+
getValue(): number;
|
|
26356
|
+
/**
|
|
26357
|
+
* Sets the value of the rating.
|
|
26358
|
+
* @param {number} value. Sets the value of the rating
|
|
26359
|
+
*/
|
|
26360
|
+
setValue(value: number): void;
|
|
26361
|
+
}
|
|
26362
|
+
|
|
26363
|
+
declare global {
|
|
26364
|
+
interface Document {
|
|
26365
|
+
createElement(tagName: "smart-rating"): Rating;
|
|
26366
|
+
querySelector(selectors: "smart-rating"): Rating | null;
|
|
26367
|
+
querySelectorAll(selectors: "smart-rating"): NodeListOf<Rating>;
|
|
26368
|
+
getElementsByTagName(qualifiedName: "smart-rating"): HTMLCollectionOf<Rating>;
|
|
26369
|
+
getElementsByName(elementName: "smart-rating"): NodeListOf<Rating>;
|
|
26370
|
+
}
|
|
26371
|
+
}
|
|
26372
|
+
|
|
26373
|
+
export interface RepeatButtonProperties {
|
|
26374
|
+
/**
|
|
26375
|
+
* Sets or gets the animation mode. Animation is disabled when the property is set to 'none'
|
|
26376
|
+
* Default value: advanced
|
|
26377
|
+
*/
|
|
26378
|
+
animation?: Animation | string;
|
|
26379
|
+
/**
|
|
26380
|
+
* Sets the click mode of the button.
|
|
26381
|
+
* Default value: release
|
|
26382
|
+
*/
|
|
26383
|
+
clickMode?: ClickMode | string;
|
|
26384
|
+
/**
|
|
26385
|
+
* Sets the delay between repeats in miliseconds.
|
|
26386
|
+
* Default value: 50
|
|
26387
|
+
*/
|
|
26388
|
+
delay?: number;
|
|
26389
|
+
/**
|
|
26390
|
+
* Enables or disables the ratio button.
|
|
26391
|
+
* Default value: false
|
|
26392
|
+
*/
|
|
26393
|
+
disabled?: boolean;
|
|
26394
|
+
/**
|
|
26395
|
+
* Sets a delay before the first repeat iteration in miliseconds.
|
|
26396
|
+
* Default value: 150
|
|
26397
|
+
*/
|
|
26398
|
+
initialDelay?: number;
|
|
26399
|
+
/**
|
|
26400
|
+
* Sets the inner HTML of the element.
|
|
26401
|
+
* Default value: """"
|
|
26402
|
+
*/
|
|
26403
|
+
innerHTML: string;
|
|
26404
|
+
/**
|
|
26405
|
+
* Sets or gets the language. Used in conjunction with the property messages.
|
|
26406
|
+
* Default value: "en"
|
|
26407
|
+
*/
|
|
26408
|
+
locale?: string;
|
|
26409
|
+
/**
|
|
26410
|
+
* Callback, related to localization module.
|
|
26411
|
+
* Default value: null
|
|
26412
|
+
*/
|
|
26413
|
+
localizeFormatFunction?: any;
|
|
26414
|
+
/**
|
|
26415
|
+
* Sets an object with string values, related to the different states of passwords strength.
|
|
26416
|
+
* Default value: * {
|
|
26417
|
+
* "en": {
|
|
26418
|
+
* "propertyUnknownType": "'' property is with undefined 'type' member!",
|
|
26419
|
+
* "propertyInvalidValue": "Invalid '!",
|
|
26420
|
+
* "propertyInvalidValueType": "Invalid '!",
|
|
26421
|
+
* "elementNotInDOM": "Element does not exist in DOM! Please, add the element to the DOM, before invoking a method.",
|
|
26422
|
+
* "moduleUndefined": "Module is undefined.",
|
|
26423
|
+
* "missingReference": ".",
|
|
26424
|
+
* "htmlTemplateNotSuported": ": Browser doesn't support HTMLTemplate elements.",
|
|
26425
|
+
* "invalidTemplate": "' property accepts a string that must match the id of an HTMLTemplate element from the DOM."
|
|
26426
|
+
* }
|
|
26427
|
+
* }
|
|
26428
|
+
*/
|
|
26429
|
+
messages?: any;
|
|
26430
|
+
/**
|
|
26431
|
+
* Sets or gets the widget's name.
|
|
26432
|
+
* Default value: """"
|
|
26433
|
+
*/
|
|
26434
|
+
name?: string;
|
|
26435
|
+
/**
|
|
26436
|
+
* If the custom element is readonly, it cannot be interacted with.
|
|
26437
|
+
* Default value: false
|
|
26438
|
+
*/
|
|
26439
|
+
readonly?: boolean;
|
|
26440
|
+
/**
|
|
26441
|
+
* Determines the theme. Theme defines the look of the element
|
|
26442
|
+
* Default value: ""
|
|
26443
|
+
*/
|
|
26444
|
+
theme?: string;
|
|
26445
|
+
/**
|
|
26446
|
+
* If is set to true, the element cannot be focused.
|
|
26447
|
+
* Default value: false
|
|
26448
|
+
*/
|
|
26449
|
+
unfocusable?: boolean;
|
|
26450
|
+
/**
|
|
26451
|
+
* Sets or gets the widget's value.
|
|
26452
|
+
* Default value: """"
|
|
26453
|
+
*/
|
|
26454
|
+
value?: string;
|
|
26455
|
+
}
|
|
26456
|
+
/**
|
|
26457
|
+
RepatButton provides press-and-hold functionality and it is an ideal UI component for allowing end-users to control an increasing or decreasing value.
|
|
26458
|
+
*/
|
|
26459
|
+
export interface RepeatButton extends BaseElement, RepeatButtonProperties {
|
|
26460
|
+
|
|
26461
|
+
/* Get a member by its name */
|
|
26462
|
+
[name: string]: any;
|
|
26463
|
+
/**
|
|
26464
|
+
* This event is triggered when the element is clicked.
|
|
26465
|
+
* @param event. The custom event. */
|
|
26466
|
+
onClick: ((this: any, ev: Event) => any) | null;
|
|
26467
|
+
}
|
|
26468
|
+
|
|
26469
|
+
declare global {
|
|
26470
|
+
interface Document {
|
|
26471
|
+
createElement(tagName: "smart-repeat-button"): RepeatButton;
|
|
26472
|
+
querySelector(selectors: "smart-repeat-button"): RepeatButton | null;
|
|
26473
|
+
querySelectorAll(selectors: "smart-repeat-button"): NodeListOf<RepeatButton>;
|
|
26474
|
+
getElementsByTagName(qualifiedName: "smart-repeat-button"): HTMLCollectionOf<RepeatButton>;
|
|
26475
|
+
getElementsByName(elementName: "smart-repeat-button"): NodeListOf<RepeatButton>;
|
|
26476
|
+
}
|
|
26477
|
+
}
|
|
26478
|
+
|
|
26479
|
+
export interface RibbonProperties {
|
|
26480
|
+
/**
|
|
26481
|
+
* Determines whether the ribbon is collapsible.
|
|
26482
|
+
* Default value: false
|
|
26483
|
+
*/
|
|
26484
|
+
collapsible?: any;
|
|
26485
|
+
/**
|
|
26486
|
+
* Determines the tab items of the ribbon.
|
|
26487
|
+
* Default value:
|
|
26488
|
+
*/
|
|
26489
|
+
dataSource?: any;
|
|
26490
|
+
/**
|
|
26491
|
+
* Sets or gets the value indicating whether the element is disabled.
|
|
26492
|
+
* Default value: false
|
|
26493
|
+
*/
|
|
26494
|
+
disabled?: boolean;
|
|
26495
|
+
/**
|
|
26496
|
+
* Determines the file menu options of the ribbon.
|
|
26497
|
+
* Default value: undefined
|
|
26498
|
+
*/
|
|
26499
|
+
fileMenu?: RibbonFileMenu;
|
|
26500
|
+
/**
|
|
26501
|
+
* Determines the locale of the ribbon.
|
|
26502
|
+
* Default value: "en"
|
|
26503
|
+
*/
|
|
26504
|
+
locale?: string;
|
|
26505
|
+
/**
|
|
26506
|
+
* Determines the messages of the ribbon
|
|
26507
|
+
* Default value: * [object Object]
|
|
26508
|
+
*/
|
|
26509
|
+
messages?: any;
|
|
26510
|
+
/**
|
|
26511
|
+
* Sets or gets the value indicating whether the element is aligned to support locales using right-to-left fonts.
|
|
26512
|
+
* Default value: false
|
|
26513
|
+
*/
|
|
26514
|
+
rightToLeft?: boolean;
|
|
26515
|
+
/**
|
|
26516
|
+
* Determines the selected tab.
|
|
26517
|
+
* Default value: 0
|
|
26518
|
+
*/
|
|
26519
|
+
selectedTab?: any;
|
|
26520
|
+
}
|
|
26521
|
+
/**
|
|
26522
|
+
Ribbon is a navigation control that allows you to organize your application's commands in a tabbed interface.
|
|
26523
|
+
*/
|
|
26524
|
+
export interface Ribbon extends BaseElement, RibbonProperties {
|
|
26525
|
+
|
|
26526
|
+
/* Get a member by its name */
|
|
26527
|
+
[name: string]: any;
|
|
26528
|
+
/**
|
|
26529
|
+
* This event is triggered when the ribbon is collapsed.
|
|
26530
|
+
* @param event. The custom event. */
|
|
26531
|
+
onCollapse?: ((this: any, ev: Event) => any) | ((this: any, ev: CustomEvent<any>) => any) | null;
|
|
26532
|
+
/**
|
|
26533
|
+
* This event is triggered when the ribbon is collapsing. The event can be canceled by calling event.preventDefault() in the event handler function.
|
|
26534
|
+
* @param event. The custom event. */
|
|
26535
|
+
onCollapsing?: ((this: any, ev: Event) => any) | ((this: any, ev: CustomEvent<any>) => any) | null;
|
|
26536
|
+
/**
|
|
26537
|
+
* This event is triggered when the dialog launcher is clicked.
|
|
26538
|
+
* @param event. The custom event. Custom data event was created with: ev.detail(groupLabel, groupId)
|
|
26539
|
+
* groupLabel - The label of the dialog launcher's ribbon group.
|
|
26540
|
+
* groupId - The id of the dialog launcher's ribbon group.
|
|
26541
|
+
*/
|
|
26542
|
+
onDialogLauncherClick?: ((this: any, ev: Event) => any) | ((this: any, ev: CustomEvent<any>) => any) | null;
|
|
26543
|
+
/**
|
|
26544
|
+
* This event is triggered when the ribbon is expanded.
|
|
26545
|
+
* @param event. The custom event. */
|
|
26546
|
+
onExpand?: ((this: any, ev: Event) => any) | ((this: any, ev: CustomEvent<any>) => any) | null;
|
|
26547
|
+
/**
|
|
26548
|
+
* This event is triggered when the ribbon is expanding. The event can be canceled by calling event.preventDefault() in the event handler function.
|
|
26549
|
+
* @param event. The custom event. */
|
|
26550
|
+
onExpanding?: ((this: any, ev: Event) => any) | ((this: any, ev: CustomEvent<any>) => any) | null;
|
|
26551
|
+
/**
|
|
26552
|
+
* This event is triggered when the file menu button is clicked.
|
|
26553
|
+
* @param event. The custom event. */
|
|
26554
|
+
onFileButtonClick?: ((this: any, ev: Event) => any) | ((this: any, ev: CustomEvent<any>) => any) | null;
|
|
26555
|
+
/**
|
|
26556
|
+
* This event is triggered when the file menu is opened.
|
|
26557
|
+
* @param event. The custom event. */
|
|
26558
|
+
onFileMenuOpen?: ((this: any, ev: Event) => any) | ((this: any, ev: CustomEvent<any>) => any) | null;
|
|
26559
|
+
/**
|
|
26560
|
+
* This event is triggered when the file menu is closed.
|
|
26561
|
+
* @param event. The custom event. */
|
|
26562
|
+
onFileMenuClose?: ((this: any, ev: Event) => any) | ((this: any, ev: CustomEvent<any>) => any) | null;
|
|
26563
|
+
/**
|
|
26564
|
+
* This event is triggered when a file menu item is clicked.
|
|
26565
|
+
* @param event. The custom event. Custom data event was created with: ev.detail(item)
|
|
26566
|
+
* item - The file menu item.
|
|
26567
|
+
*/
|
|
26568
|
+
onFileMenuItemClick?: ((this: any, ev: Event) => any) | ((this: any, ev: CustomEvent<any>) => any) | null;
|
|
26569
|
+
/**
|
|
26570
|
+
* This event is triggered when the tab selection is changed.
|
|
26571
|
+
* @param event. The custom event. Custom data event was created with: ev.detail(oldIndex, index)
|
|
26572
|
+
* oldIndex - The previous tab index.
|
|
26573
|
+
* index - The new index of the selected tab.
|
|
26574
|
+
*/
|
|
26575
|
+
onSelect?: ((this: any, ev: Event) => any) | ((this: any, ev: CustomEvent<any>) => any) | null;
|
|
26576
|
+
/**
|
|
26577
|
+
* This event is triggered when the tab selection is changing. The event can be canceled by calling event.preventDefault() in the event handler function.
|
|
26578
|
+
* @param event. The custom event. Custom data event was created with: ev.detail(oldIndex, index)
|
|
26579
|
+
* oldIndex - The previous tab index.
|
|
26580
|
+
* index - The new index of the selected tab.
|
|
26581
|
+
*/
|
|
26582
|
+
onSelecting?: ((this: any, ev: Event) => any) | ((this: any, ev: CustomEvent<any>) => any) | null;
|
|
26583
|
+
/**
|
|
26584
|
+
* Adds a new ribbon tab to the ribbon. The tab can be added as an object, HTMLElement or id to an HTMLElement.
|
|
26585
|
+
* @param {any} tab. The ribbon tab to be added.
|
|
26586
|
+
*/
|
|
26587
|
+
addTab(tab: any): void;
|
|
26588
|
+
/**
|
|
26589
|
+
* Adds a new group to a ribbon tab. The group can be added as an object, HTMLElement or id to an HTMLElement.
|
|
26590
|
+
* @param {any} tab. The id, index or HTMLElement of the parent ribbon tab.
|
|
26591
|
+
* @param {any} group. The ribbon group to be added.
|
|
26592
|
+
*/
|
|
26593
|
+
addGroup(tab: any, group: any): void;
|
|
26594
|
+
/**
|
|
26595
|
+
* Adds a new ribbon item to a ribbon group. The item can be added as an object, HTMLElement or id to an HTMLElement.
|
|
26596
|
+
* @param {string | number | HTMLElement} tab. The id, index or HTMLElement of the parent ribbon tab.
|
|
26597
|
+
* @param {string | HTMLElement} group. The id or HTMLElement of the parent ribbon group.
|
|
26598
|
+
* @param {any} item. The ribbon item to be added.
|
|
26599
|
+
*/
|
|
26600
|
+
addItem(tab: string | number | HTMLElement, group: string | HTMLElement, item: any): void;
|
|
26601
|
+
/**
|
|
26602
|
+
* Collapses the ribbon.
|
|
26603
|
+
*/
|
|
26604
|
+
collapse(): void;
|
|
26605
|
+
/**
|
|
26606
|
+
* Expands the ribbon.
|
|
26607
|
+
*/
|
|
26608
|
+
expand(): void;
|
|
26609
|
+
/**
|
|
26610
|
+
* Removes a ribbon tab from the ribbon.
|
|
26611
|
+
* @param {string | number} ribbonTab. The id or index of the ribbon tab to be removed.
|
|
26612
|
+
*/
|
|
26613
|
+
removeTab(ribbonTab: string | number): void;
|
|
25864
26614
|
/**
|
|
25865
|
-
*
|
|
25866
|
-
|
|
25867
|
-
*
|
|
26615
|
+
* Removes a ribbon group from a ribbon tab.
|
|
26616
|
+
* @param {string | number} ribbonTabIndex?. The id or index of the parent ribbon tab.
|
|
26617
|
+
* @param {string | number} ribbonGroup?. The id or index of the ribbon group to be removed.
|
|
25868
26618
|
*/
|
|
25869
|
-
|
|
26619
|
+
removeGroup(ribbonTabIndex?: string | number, ribbonGroup?: string | number): void;
|
|
25870
26620
|
/**
|
|
25871
|
-
*
|
|
25872
|
-
|
|
25873
|
-
*
|
|
26621
|
+
* Removes a ribbon item from a ribbon group.
|
|
26622
|
+
* @param {string | number} ribbonTabIndex?. The id or index of the parent ribbon tab.
|
|
26623
|
+
* @param {string | number} ribbonGroup?. The id or index of the parent ribbon group.
|
|
26624
|
+
* @param {string | number} ribbonItem?. The id or index of the ribbon item to be removed.
|
|
25874
26625
|
*/
|
|
25875
|
-
|
|
25876
|
-
|
|
25877
|
-
|
|
25878
|
-
|
|
25879
|
-
|
|
25880
|
-
|
|
25881
|
-
querySelector(selectors: "smart-radio-button"): RadioButton | null;
|
|
25882
|
-
querySelectorAll(selectors: "smart-radio-button"): NodeListOf<RadioButton>;
|
|
25883
|
-
getElementsByTagName(qualifiedName: "smart-radio-button"): HTMLCollectionOf<RadioButton>;
|
|
25884
|
-
getElementsByName(elementName: "smart-radio-button"): NodeListOf<RadioButton>;
|
|
25885
|
-
}
|
|
26626
|
+
removeItem(ribbonTabIndex?: string | number, ribbonGroup?: string | number, ribbonItem?: string | number): void;
|
|
26627
|
+
/**
|
|
26628
|
+
* Selects a ribbon tab.
|
|
26629
|
+
* @param {string | number} ribbonTabIndex. The index of the ribbon tab to be selected.
|
|
26630
|
+
*/
|
|
26631
|
+
selectTab(ribbonTabIndex: string | number): void;
|
|
25886
26632
|
}
|
|
25887
26633
|
|
|
25888
|
-
|
|
26634
|
+
/**Determines the file menu options of the ribbon. */
|
|
26635
|
+
export interface RibbonFileMenu {
|
|
25889
26636
|
/**
|
|
25890
|
-
*
|
|
25891
|
-
* Default value:
|
|
26637
|
+
* Determines whether the file button is enabled.
|
|
26638
|
+
* Default value: true
|
|
25892
26639
|
*/
|
|
25893
|
-
|
|
26640
|
+
enabled?: boolean;
|
|
25894
26641
|
/**
|
|
25895
|
-
*
|
|
25896
|
-
* Default value:
|
|
26642
|
+
* Determines the data source that will be loaded to the FileMenu.
|
|
26643
|
+
* Default value:
|
|
25897
26644
|
*/
|
|
25898
|
-
|
|
26645
|
+
items?: any;
|
|
25899
26646
|
/**
|
|
25900
|
-
*
|
|
25901
|
-
* Default value:
|
|
26647
|
+
* Determines the position of the file menu.
|
|
26648
|
+
* Default value: left
|
|
25902
26649
|
*/
|
|
25903
|
-
|
|
26650
|
+
position?: RibbonFileMenuPosition | string;
|
|
25904
26651
|
/**
|
|
25905
|
-
*
|
|
25906
|
-
* Default value:
|
|
26652
|
+
* Determines the label of the file menu.
|
|
26653
|
+
* Default value: "File"
|
|
25907
26654
|
*/
|
|
25908
|
-
|
|
26655
|
+
label?: string;
|
|
25909
26656
|
/**
|
|
25910
|
-
* Determines the
|
|
25911
|
-
* Default value:
|
|
26657
|
+
* Determines the tooltip of the file menu.
|
|
26658
|
+
* Default value: ""
|
|
25912
26659
|
*/
|
|
25913
|
-
|
|
26660
|
+
tooltip?: string;
|
|
25914
26661
|
/**
|
|
25915
|
-
*
|
|
25916
|
-
* Default value:
|
|
25917
|
-
* "en": {
|
|
25918
|
-
* "propertyUnknownType": "'' property is with undefined 'type' member!",
|
|
25919
|
-
* "propertyInvalidValue": "Invalid '!",
|
|
25920
|
-
* "propertyInvalidValueType": "Invalid '!",
|
|
25921
|
-
* "elementNotInDOM": "Element does not exist in DOM! Please, add the element to the DOM, before invoking a method.",
|
|
25922
|
-
* "moduleUndefined": "Module is undefined.",
|
|
25923
|
-
* "missingReference": ".",
|
|
25924
|
-
* "htmlTemplateNotSuported": ": Browser doesn't support HTMLTemplate elements.",
|
|
25925
|
-
* "invalidTemplate": "' property accepts a string that must match the id of an HTMLTemplate element from the DOM."
|
|
25926
|
-
* }
|
|
25927
|
-
* }
|
|
26662
|
+
* Determines the template of the file menu. Accepts HTMLTemplateElement, an id of an HTMLTemplateElement or a Function.
|
|
26663
|
+
* Default value: ""
|
|
25928
26664
|
*/
|
|
25929
|
-
|
|
26665
|
+
template?: string;
|
|
25930
26666
|
/**
|
|
25931
|
-
*
|
|
26667
|
+
* Determines the type of the file menu.
|
|
26668
|
+
* Default value: dropDown
|
|
26669
|
+
*/
|
|
26670
|
+
type?: RibbonFileMenuType | string;
|
|
26671
|
+
/**
|
|
26672
|
+
* Determines the icon of the file menu.
|
|
25932
26673
|
* Default value: ""
|
|
25933
26674
|
*/
|
|
25934
|
-
|
|
26675
|
+
icon?: string;
|
|
26676
|
+
}
|
|
26677
|
+
|
|
26678
|
+
declare global {
|
|
26679
|
+
interface Document {
|
|
26680
|
+
createElement(tagName: "smart-ribbon"): Ribbon;
|
|
26681
|
+
querySelector(selectors: "smart-ribbon"): Ribbon | null;
|
|
26682
|
+
querySelectorAll(selectors: "smart-ribbon"): NodeListOf<Ribbon>;
|
|
26683
|
+
getElementsByTagName(qualifiedName: "smart-ribbon"): HTMLCollectionOf<Ribbon>;
|
|
26684
|
+
getElementsByName(elementName: "smart-ribbon"): NodeListOf<Ribbon>;
|
|
26685
|
+
}
|
|
26686
|
+
}
|
|
26687
|
+
|
|
26688
|
+
/**Determines the position of the file menu. */
|
|
26689
|
+
export declare type RibbonFileMenuPosition = 'left' | 'right';
|
|
26690
|
+
/**Determines the type of the file menu. */
|
|
26691
|
+
export declare type RibbonFileMenuType = 'dropDown' | 'button';
|
|
26692
|
+
export interface RibbonGroupProperties {
|
|
25935
26693
|
/**
|
|
25936
|
-
*
|
|
25937
|
-
* Default value:
|
|
26694
|
+
* Determines the label of the ribbon group.
|
|
26695
|
+
* Default value: ""
|
|
25938
26696
|
*/
|
|
25939
|
-
|
|
26697
|
+
label?: string;
|
|
25940
26698
|
/**
|
|
25941
|
-
* Determines the
|
|
26699
|
+
* Determines the icon of the ribbon group.
|
|
25942
26700
|
* Default value: ""
|
|
25943
26701
|
*/
|
|
25944
|
-
|
|
26702
|
+
icon?: string;
|
|
25945
26703
|
/**
|
|
25946
|
-
*
|
|
25947
|
-
* Default value:
|
|
26704
|
+
* Determines the class of the ribbon group.
|
|
26705
|
+
* Default value: ""
|
|
25948
26706
|
*/
|
|
25949
|
-
|
|
26707
|
+
cssClass?: string;
|
|
25950
26708
|
/**
|
|
25951
|
-
* Determines the
|
|
26709
|
+
* Determines the ribbon items of the ribbon group.
|
|
25952
26710
|
* Default value:
|
|
25953
26711
|
*/
|
|
25954
|
-
|
|
26712
|
+
ribbonItems?: any;
|
|
26713
|
+
/**
|
|
26714
|
+
* Determines the direction of the ribbon group.
|
|
26715
|
+
* Default value: horizontal
|
|
26716
|
+
*/
|
|
26717
|
+
direction?: RibbonGroupDirection | string;
|
|
26718
|
+
/**
|
|
26719
|
+
* Determines the settings of the dialog launcher of the ribbon group.
|
|
26720
|
+
* Default value: [object Object]
|
|
26721
|
+
*/
|
|
26722
|
+
dialogLauncher?: RibbonGroupDialogLauncher;
|
|
26723
|
+
/**
|
|
26724
|
+
* Determines the size, below which the ribbon group will be wrapped.
|
|
26725
|
+
* Default value: undefined
|
|
26726
|
+
*/
|
|
26727
|
+
wrapSize?: RibbonGroupWrapSize | string;
|
|
25955
26728
|
}
|
|
25956
26729
|
/**
|
|
25957
|
-
|
|
26730
|
+
Defines a ribbon group.
|
|
25958
26731
|
*/
|
|
25959
|
-
export interface
|
|
26732
|
+
export interface RibbonGroup extends BaseElement, RibbonGroupProperties {
|
|
25960
26733
|
|
|
25961
26734
|
/* Get a member by its name */
|
|
25962
26735
|
[name: string]: any;
|
|
26736
|
+
}
|
|
26737
|
+
|
|
26738
|
+
/**Determines the settings of the dialog launcher of the ribbon group. */
|
|
26739
|
+
export interface RibbonGroupDialogLauncher {
|
|
25963
26740
|
/**
|
|
25964
|
-
*
|
|
25965
|
-
|
|
25966
|
-
* value - A numeric value indicating the scroll position.
|
|
25967
|
-
* oldValue - A numeric value indicating the previous scroll position.
|
|
25968
|
-
*/
|
|
25969
|
-
onChange: ((this: any, ev: Event) => any) | null;
|
|
25970
|
-
/**
|
|
25971
|
-
* Get the value of the rating.
|
|
25972
|
-
* @returns {number}
|
|
26741
|
+
* Determines whether the dialog launcher is enabled.
|
|
26742
|
+
* Default value: false
|
|
25973
26743
|
*/
|
|
25974
|
-
|
|
26744
|
+
enabled?: boolean;
|
|
25975
26745
|
/**
|
|
25976
|
-
*
|
|
25977
|
-
*
|
|
26746
|
+
* Determines the tooltip of the dialog launcher.
|
|
26747
|
+
* Default value: ""
|
|
25978
26748
|
*/
|
|
25979
|
-
|
|
26749
|
+
tooltip?: string;
|
|
25980
26750
|
}
|
|
25981
26751
|
|
|
25982
26752
|
declare global {
|
|
25983
26753
|
interface Document {
|
|
25984
|
-
createElement(tagName: "smart-
|
|
25985
|
-
querySelector(selectors: "smart-
|
|
25986
|
-
querySelectorAll(selectors: "smart-
|
|
25987
|
-
getElementsByTagName(qualifiedName: "smart-
|
|
25988
|
-
getElementsByName(elementName: "smart-
|
|
26754
|
+
createElement(tagName: "smart-ribbon-group"): RibbonGroup;
|
|
26755
|
+
querySelector(selectors: "smart-ribbon-group"): RibbonGroup | null;
|
|
26756
|
+
querySelectorAll(selectors: "smart-ribbon-group"): NodeListOf<RibbonGroup>;
|
|
26757
|
+
getElementsByTagName(qualifiedName: "smart-ribbon-group"): HTMLCollectionOf<RibbonGroup>;
|
|
26758
|
+
getElementsByName(elementName: "smart-ribbon-group"): NodeListOf<RibbonGroup>;
|
|
25989
26759
|
}
|
|
25990
26760
|
}
|
|
25991
26761
|
|
|
25992
|
-
|
|
26762
|
+
/**Determines the direction of the ribbon group. */
|
|
26763
|
+
export declare type RibbonGroupDirection = 'horizontal' | 'vertical';
|
|
26764
|
+
/**Determines the size, below which the ribbon group will be wrapped. */
|
|
26765
|
+
export declare type RibbonGroupWrapSize = 'iconOnly' | 'verySmall' | 'small' | 'normal' | 'large' | 'none';
|
|
26766
|
+
export interface RibbonItemProperties {
|
|
25993
26767
|
/**
|
|
25994
|
-
*
|
|
25995
|
-
* Default value:
|
|
26768
|
+
* Determines whether the ribbon item is disabled.
|
|
26769
|
+
* Default value: false
|
|
25996
26770
|
*/
|
|
25997
|
-
|
|
26771
|
+
disabled?: boolean;
|
|
25998
26772
|
/**
|
|
25999
|
-
*
|
|
26000
|
-
* Default value:
|
|
26773
|
+
* Determines the label of the ribbon item.
|
|
26774
|
+
* Default value: ""
|
|
26001
26775
|
*/
|
|
26002
|
-
|
|
26776
|
+
label?: string;
|
|
26003
26777
|
/**
|
|
26004
|
-
*
|
|
26005
|
-
* Default value:
|
|
26778
|
+
* Determines the type of the ribbon item.
|
|
26779
|
+
* Default value: button
|
|
26006
26780
|
*/
|
|
26007
|
-
|
|
26781
|
+
type?: RibbonItemType | string;
|
|
26008
26782
|
/**
|
|
26009
|
-
*
|
|
26010
|
-
* Default value:
|
|
26783
|
+
* Determines the template of the ribbon item. Accepts HTMLTemplateElement, an id of an HTMLTemplateElement or a Function.
|
|
26784
|
+
* Default value: ""
|
|
26011
26785
|
*/
|
|
26012
|
-
|
|
26786
|
+
template?: string;
|
|
26013
26787
|
/**
|
|
26014
|
-
*
|
|
26015
|
-
* Default value:
|
|
26788
|
+
* Determines the size of the ribbon item.
|
|
26789
|
+
* Default value: normal
|
|
26016
26790
|
*/
|
|
26017
|
-
|
|
26791
|
+
size?: RibbonItemSize | string;
|
|
26018
26792
|
/**
|
|
26019
|
-
*
|
|
26020
|
-
* Default value:
|
|
26793
|
+
*
|
|
26794
|
+
* Default value: null
|
|
26021
26795
|
*/
|
|
26022
|
-
|
|
26796
|
+
sizeChanged?: any;
|
|
26023
26797
|
/**
|
|
26024
|
-
*
|
|
26025
|
-
* Default value:
|
|
26798
|
+
* Determines the allowed sizes of the ribbon item.
|
|
26799
|
+
* Default value:
|
|
26026
26800
|
*/
|
|
26027
|
-
|
|
26801
|
+
allowedSizes?: any;
|
|
26028
26802
|
/**
|
|
26029
|
-
*
|
|
26803
|
+
* Determines the icon of the ribbon item.
|
|
26804
|
+
* Default value: ""
|
|
26805
|
+
*/
|
|
26806
|
+
icon?: string;
|
|
26807
|
+
/**
|
|
26808
|
+
* Determines the settings of the ribbon item. The settings will be applied as properties if the ribbon item is set to a Smart Element.
|
|
26809
|
+
* Default value: [object Object]
|
|
26810
|
+
*/
|
|
26811
|
+
settings?: RibbonItemSettings;
|
|
26812
|
+
/**
|
|
26813
|
+
* Determines the class of the ribbon item.
|
|
26814
|
+
* Default value: ""
|
|
26815
|
+
*/
|
|
26816
|
+
cssClass?: string;
|
|
26817
|
+
/**
|
|
26818
|
+
* Sets a click event handler for the ribbon item.
|
|
26030
26819
|
* Default value: null
|
|
26031
26820
|
*/
|
|
26032
|
-
|
|
26821
|
+
onItemClick?: any;
|
|
26033
26822
|
/**
|
|
26034
|
-
* Sets
|
|
26035
|
-
* Default value:
|
|
26036
|
-
* "en": {
|
|
26037
|
-
* "propertyUnknownType": "'' property is with undefined 'type' member!",
|
|
26038
|
-
* "propertyInvalidValue": "Invalid '!",
|
|
26039
|
-
* "propertyInvalidValueType": "Invalid '!",
|
|
26040
|
-
* "elementNotInDOM": "Element does not exist in DOM! Please, add the element to the DOM, before invoking a method.",
|
|
26041
|
-
* "moduleUndefined": "Module is undefined.",
|
|
26042
|
-
* "missingReference": ".",
|
|
26043
|
-
* "htmlTemplateNotSuported": ": Browser doesn't support HTMLTemplate elements.",
|
|
26044
|
-
* "invalidTemplate": "' property accepts a string that must match the id of an HTMLTemplate element from the DOM."
|
|
26045
|
-
* }
|
|
26046
|
-
* }
|
|
26823
|
+
* Sets a change event handler for the ribbon item.
|
|
26824
|
+
* Default value: null
|
|
26047
26825
|
*/
|
|
26048
|
-
|
|
26826
|
+
onItemChange?: any;
|
|
26049
26827
|
/**
|
|
26050
|
-
*
|
|
26051
|
-
* Default value: ""
|
|
26828
|
+
* Determines the tooltip of the ribbon item.
|
|
26829
|
+
* Default value: ""
|
|
26052
26830
|
*/
|
|
26053
|
-
|
|
26831
|
+
tooltip?: string;
|
|
26832
|
+
}
|
|
26833
|
+
/**
|
|
26834
|
+
Defines a ribbon item.
|
|
26835
|
+
*/
|
|
26836
|
+
export interface RibbonItem extends BaseElement, RibbonItemProperties {
|
|
26837
|
+
|
|
26838
|
+
/* Get a member by its name */
|
|
26839
|
+
[name: string]: any;
|
|
26840
|
+
}
|
|
26841
|
+
|
|
26842
|
+
/**Determines the settings of the ribbon item. The settings will be applied as properties if the ribbon item is set to a Smart Element. */
|
|
26843
|
+
export interface RibbonItemSettings {
|
|
26844
|
+
}
|
|
26845
|
+
|
|
26846
|
+
declare global {
|
|
26847
|
+
interface Document {
|
|
26848
|
+
createElement(tagName: "smart-ribbon-item"): RibbonItem;
|
|
26849
|
+
querySelector(selectors: "smart-ribbon-item"): RibbonItem | null;
|
|
26850
|
+
querySelectorAll(selectors: "smart-ribbon-item"): NodeListOf<RibbonItem>;
|
|
26851
|
+
getElementsByTagName(qualifiedName: "smart-ribbon-item"): HTMLCollectionOf<RibbonItem>;
|
|
26852
|
+
getElementsByName(elementName: "smart-ribbon-item"): NodeListOf<RibbonItem>;
|
|
26853
|
+
}
|
|
26854
|
+
}
|
|
26855
|
+
|
|
26856
|
+
/**Determines the type of the ribbon item. */
|
|
26857
|
+
export declare type RibbonItemType = 'separator' | 'button' | 'toggleButton' | 'multiSplitButton' | 'dropDownButton' | 'input' | 'custom';
|
|
26858
|
+
/**Determines the size of the ribbon item. */
|
|
26859
|
+
export declare type RibbonItemSize = 'iconOnly' | 'small' | 'verySmall' | 'normal' | 'large';
|
|
26860
|
+
export interface RibbonTabProperties {
|
|
26054
26861
|
/**
|
|
26055
|
-
*
|
|
26862
|
+
* Determines whether the tab item is disabled.
|
|
26056
26863
|
* Default value: false
|
|
26057
26864
|
*/
|
|
26058
|
-
|
|
26865
|
+
disabled?: boolean;
|
|
26059
26866
|
/**
|
|
26060
|
-
* Determines the
|
|
26867
|
+
* Determines the label of the tab item.
|
|
26061
26868
|
* Default value: ""
|
|
26062
26869
|
*/
|
|
26063
|
-
|
|
26870
|
+
label?: string;
|
|
26064
26871
|
/**
|
|
26065
|
-
*
|
|
26872
|
+
* Determines whether the tab item is selected.
|
|
26066
26873
|
* Default value: false
|
|
26067
26874
|
*/
|
|
26068
|
-
|
|
26875
|
+
selected?: boolean;
|
|
26069
26876
|
/**
|
|
26070
|
-
*
|
|
26071
|
-
* Default value:
|
|
26877
|
+
* Determines the ribbon group of the tab item
|
|
26878
|
+
* Default value: undefined
|
|
26072
26879
|
*/
|
|
26073
|
-
|
|
26880
|
+
ribbonGroups?: any;
|
|
26074
26881
|
}
|
|
26075
26882
|
/**
|
|
26076
|
-
|
|
26883
|
+
Defines a ribbon tab.
|
|
26077
26884
|
*/
|
|
26078
|
-
export interface
|
|
26885
|
+
export interface RibbonTab extends BaseElement, RibbonTabProperties {
|
|
26079
26886
|
|
|
26080
26887
|
/* Get a member by its name */
|
|
26081
26888
|
[name: string]: any;
|
|
26082
|
-
/**
|
|
26083
|
-
* This event is triggered when the element is clicked.
|
|
26084
|
-
* @param event. The custom event. */
|
|
26085
|
-
onClick: ((this: any, ev: Event) => any) | null;
|
|
26086
26889
|
}
|
|
26087
26890
|
|
|
26088
26891
|
declare global {
|
|
26089
26892
|
interface Document {
|
|
26090
|
-
createElement(tagName: "smart-
|
|
26091
|
-
querySelector(selectors: "smart-
|
|
26092
|
-
querySelectorAll(selectors: "smart-
|
|
26093
|
-
getElementsByTagName(qualifiedName: "smart-
|
|
26094
|
-
getElementsByName(elementName: "smart-
|
|
26893
|
+
createElement(tagName: "smart-ribbon-tab"): RibbonTab;
|
|
26894
|
+
querySelector(selectors: "smart-ribbon-tab"): RibbonTab | null;
|
|
26895
|
+
querySelectorAll(selectors: "smart-ribbon-tab"): NodeListOf<RibbonTab>;
|
|
26896
|
+
getElementsByTagName(qualifiedName: "smart-ribbon-tab"): HTMLCollectionOf<RibbonTab>;
|
|
26897
|
+
getElementsByName(elementName: "smart-ribbon-tab"): NodeListOf<RibbonTab>;
|
|
26095
26898
|
}
|
|
26096
26899
|
}
|
|
26097
26900
|
|
|
@@ -26116,6 +26919,11 @@ export interface SchedulerProperties {
|
|
|
26116
26919
|
* Default value: #D50000,#E67C73,#F4511E,#F6BF26,#33B679,#0B8043,#039BE5,#3F51B5,#7986CB,#8E24AA,#616161,
|
|
26117
26920
|
*/
|
|
26118
26921
|
colorScheme?: string[];
|
|
26922
|
+
/**
|
|
26923
|
+
* Determines the current time of the Scheduler to use for the current time indicator functionality. By default the current time is Today.
|
|
26924
|
+
* Default value: new Date()
|
|
26925
|
+
*/
|
|
26926
|
+
currentTime?: string | Date;
|
|
26119
26927
|
/**
|
|
26120
26928
|
* Enables/Disables the current time indicator. Current time indicator shows the current time in the appropriate view cells.
|
|
26121
26929
|
* Default value: false
|
|
@@ -26472,7 +27280,7 @@ export interface SchedulerProperties {
|
|
|
26472
27280
|
*/
|
|
26473
27281
|
restrictedHours?: any;
|
|
26474
27282
|
/**
|
|
26475
|
-
* Defines an array of dates and hours that are not allowed to have events on. Events that overlap restricted Hours or start/end on them will not be displayed. Each array item is an Object and requires 2 fields - date and hours. For example: { date: new Date(
|
|
27283
|
+
* Defines an array of dates and hours that are not allowed to have events on. Events that overlap restricted Hours or start/end on them will not be displayed. Each array item is an Object and requires 2 fields - date and hours. For example: { date: new Date(2023, 10, 1), hours: [[0, 6], 12, [20, 23]] }. The hours define a range of restricted hours similartly to the restricted hours property, the date defines a date where the restricted hours will be applied.
|
|
26476
27284
|
* Default value:
|
|
26477
27285
|
*/
|
|
26478
27286
|
restricted?: any;
|
|
@@ -26943,9 +27751,10 @@ export interface Scheduler extends BaseElement, SchedulerProperties {
|
|
|
26943
27751
|
/**
|
|
26944
27752
|
* Exports the events from the Scheduler.
|
|
26945
27753
|
* @param {string} dataFormat. Determines the format of the exported file. The following values are available: <ul><li><b>pdf</b></li><li><b>xlsx</b></li><li><b>html</b></li><li><b>iCal</b></li></ul>
|
|
26946
|
-
* @param {any} callback?. A callback that allows to format the exported data based on a condition. For additional details, refer
|
|
27754
|
+
* @param {any} callback?. A callback that allows to format the exported data based on a condition. For additional details, refer to the Smart Export Documentation.
|
|
27755
|
+
* @param {any} dataCallback?. A callback that allows to change the exported data.
|
|
26947
27756
|
*/
|
|
26948
|
-
exportData(dataFormat: string, callback?: any): void;
|
|
27757
|
+
exportData(dataFormat: string, callback?: any, dataCallback?: any): void;
|
|
26949
27758
|
/**
|
|
26950
27759
|
* Returns a JSON representation of the events inside the Scheduler.
|
|
26951
27760
|
* @returns {any}
|
|
@@ -29055,7 +29864,7 @@ export interface TableProperties {
|
|
|
29055
29864
|
* Sets or gets the page size (when paging is enabled).
|
|
29056
29865
|
* Default value: 10
|
|
29057
29866
|
*/
|
|
29058
|
-
pageSize?:
|
|
29867
|
+
pageSize?: number;
|
|
29059
29868
|
/**
|
|
29060
29869
|
* Sets or gets the current (zero-based) page index (when paging is enabled).
|
|
29061
29870
|
* Default value: 0
|
|
@@ -29076,6 +29885,11 @@ export interface TableProperties {
|
|
|
29076
29885
|
* Default value: "null"
|
|
29077
29886
|
*/
|
|
29078
29887
|
rowDetailTemplate?: string;
|
|
29888
|
+
/**
|
|
29889
|
+
* Sets or gets a callback function with 3 arguments - column, filterConditions, filterInputTemplateString. The function should return the new filter input.
|
|
29890
|
+
* Default value: null
|
|
29891
|
+
*/
|
|
29892
|
+
onFilterRowInput?: any;
|
|
29079
29893
|
/**
|
|
29080
29894
|
* Sets or gets an array of the Table's selected row's ids.
|
|
29081
29895
|
* Default value:
|
|
@@ -29431,6 +30245,10 @@ export interface Table extends BaseElement, TableProperties {
|
|
|
29431
30245
|
* @param {string | number} row. The id of the cell's row.
|
|
29432
30246
|
*/
|
|
29433
30247
|
removeRow(row: string | number): void;
|
|
30248
|
+
/**
|
|
30249
|
+
* Resets the Table's state. Information about columns, expanded rows, selected rows, applied fitering, grouping, and sorted columns is cleared, based on the value of the <strong>stateSettings</strong> property.
|
|
30250
|
+
*/
|
|
30251
|
+
resetState(): void;
|
|
29434
30252
|
/**
|
|
29435
30253
|
* Saves the Table's state. Information about columns, expanded rows, selected rows, applied fitering, grouping, and sorted columns is saved, based on the value of the <strong>stateSettings</strong> property.
|
|
29436
30254
|
* @returns {any}
|
|
@@ -29789,8 +30607,6 @@ export declare type TableDataSourceSettingsDataSourceType = 'array' | 'json' | '
|
|
|
29789
30607
|
export declare type TableEditMode = 'cell' | 'row';
|
|
29790
30608
|
/**Sets or gets the behavior when loading column settings either via autoLoadState or loadState. Applicable only when stateSettings contains 'columns'. */
|
|
29791
30609
|
export declare type TableLoadColumnStateBehavior = 'implementationOnly' | 'intersection' | 'stateOnly';
|
|
29792
|
-
/**Sets or gets the page size (when paging is enabled). */
|
|
29793
|
-
export declare type TablePageSize = '10' | '25' | '50';
|
|
29794
30610
|
/**Sets or gets the selection mode. Only applicable when selection is enabled. */
|
|
29795
30611
|
export declare type TableSelectionMode = 'one' | 'many' | 'extended';
|
|
29796
30612
|
/**Determines the sorting mode of the Table. */
|
|
@@ -30460,11 +31276,21 @@ export interface TextAreaProperties {
|
|
|
30460
31276
|
* Default value: false
|
|
30461
31277
|
*/
|
|
30462
31278
|
readonly?: boolean;
|
|
31279
|
+
/**
|
|
31280
|
+
* Determines whether ot not the user can resize the Textarea.
|
|
31281
|
+
* Default value: none
|
|
31282
|
+
*/
|
|
31283
|
+
resize?: TextAreaResize | string;
|
|
30463
31284
|
/**
|
|
30464
31285
|
* Sets or gets the value indicating whether the element is aligned to support locales using right-to-left fonts.
|
|
30465
31286
|
* Default value: false
|
|
30466
31287
|
*/
|
|
30467
31288
|
rightToLeft?: boolean;
|
|
31289
|
+
/**
|
|
31290
|
+
* Enables or disables the rich text formatting.
|
|
31291
|
+
* Default value: false
|
|
31292
|
+
*/
|
|
31293
|
+
richText?: boolean;
|
|
30468
31294
|
/**
|
|
30469
31295
|
* Determines whether the items are sorted alphabetically or not
|
|
30470
31296
|
* Default value: false
|
|
@@ -30490,6 +31316,11 @@ export interface TextAreaProperties {
|
|
|
30490
31316
|
* Default value: false
|
|
30491
31317
|
*/
|
|
30492
31318
|
unfocusable?: boolean;
|
|
31319
|
+
/**
|
|
31320
|
+
* Sets the TextArea users. Expects an array of objects. Each object should have an id and name properties. When you press the 'at' key, you can enter an user from a dropdown.
|
|
31321
|
+
* Default value: []
|
|
31322
|
+
*/
|
|
31323
|
+
users?: any[];
|
|
30493
31324
|
/**
|
|
30494
31325
|
* Sets or gets the value of the element.
|
|
30495
31326
|
* Default value: ""
|
|
@@ -30527,6 +31358,11 @@ export interface TextArea extends BaseElement, TextAreaProperties {
|
|
|
30527
31358
|
* Ensures that the active ( selected ) item is always visible.
|
|
30528
31359
|
*/
|
|
30529
31360
|
ensureVisible(): void;
|
|
31361
|
+
/**
|
|
31362
|
+
* Returns an array of users mentioned in the Textarea's value.
|
|
31363
|
+
* @returns {any[]}
|
|
31364
|
+
*/
|
|
31365
|
+
getMentions(): any[];
|
|
30530
31366
|
/**
|
|
30531
31367
|
* Opens the drop down.
|
|
30532
31368
|
*/
|
|
@@ -30549,6 +31385,8 @@ declare global {
|
|
|
30549
31385
|
|
|
30550
31386
|
/**Determines the auto complete query mode. This property also determines the matching algorithm for the autocomplete operation. */
|
|
30551
31387
|
export declare type TextAreaQueryMode = 'contains' | 'containsIgnoreCase' | 'doesNotContain' | 'doesNotContainIgnoreCase' | 'equals' | 'equalsIgnoreCase' | 'startsWith' | 'startsWithIgnoreCase' | 'endsWith' | 'endsWithIgnoreCase';
|
|
31388
|
+
/**Determines whether ot not the user can resize the Textarea. */
|
|
31389
|
+
export declare type TextAreaResize = 'none' | 'horizontal' | 'vertical' | 'both';
|
|
30552
31390
|
export interface TextBoxProperties {
|
|
30553
31391
|
/**
|
|
30554
31392
|
* Sets or gets the animation mode. Animation is disabled when the property is set to 'none'
|
|
@@ -31981,6 +32819,12 @@ export interface Tree extends BaseElement, TreeProperties {
|
|
|
31981
32819
|
* children - the children of the jqx-tree-items-group to be expanded
|
|
31982
32820
|
*/
|
|
31983
32821
|
onExpanding?: ((this: any, ev: Event) => any) | ((this: any, ev: CustomEvent<any>) => any) | null;
|
|
32822
|
+
/**
|
|
32823
|
+
* This event is triggered when selection in jqx-tree is changed.
|
|
32824
|
+
* @param event. The custom event. Custom data event was created with: ev.detail(value)
|
|
32825
|
+
* value - The filter input value.
|
|
32826
|
+
*/
|
|
32827
|
+
onFilterChange?: ((this: any, ev: Event) => any) | ((this: any, ev: CustomEvent<any>) => any) | null;
|
|
31984
32828
|
/**
|
|
31985
32829
|
* This event is triggered when the Tree has been scrolled to the bottom.
|
|
31986
32830
|
* @param event. The custom event. */
|
|
@@ -32057,6 +32901,11 @@ export interface Tree extends BaseElement, TreeProperties {
|
|
|
32057
32901
|
* @returns {HTMLElement}
|
|
32058
32902
|
*/
|
|
32059
32903
|
getItem(id: string): HTMLElement;
|
|
32904
|
+
/**
|
|
32905
|
+
* Gets the applied filter.
|
|
32906
|
+
* @returns {string}
|
|
32907
|
+
*/
|
|
32908
|
+
getFilter(): string;
|
|
32060
32909
|
/**
|
|
32061
32910
|
* Gets the selected values. If value is not defined, returns the selected labels.
|
|
32062
32911
|
* @returns {string[]}
|