smart-webcomponents-react 14.2.83 → 14.3.0

package/grid/grid.d.ts

@@ -1,8 +1,8 @@
 import React from "react";
 import { GridProperties } from "./../index";
-import { Scrolling, GridAppearance, GridBehavior, GridLayout, GridClipboard, GridColumn, GridContextMenu, GridColumnMenu, GridColumnGroup, GridConditionalFormatting, GridCharting, GridCheckBoxes, GridDataExport, GridDataSourceSettings, GridEditing, GridFiltering, GridGrouping, GridPaging, GridPager, GridRowDetail, GridColumnHeader, GridSummaryRow, GridGroupHeader, GridHeader, GridFooter, GridRow, GridCell, GridSelection, GridSorting } from './../index';
+import { Scrolling, GridAppearance, GridBehavior, GridLayout, GridClipboard, GridColumn, GridContextMenu, GridColumnMenu, GridColumnGroup, GridConditionalFormatting, GridCharting, GridCheckBoxes, GridDataExport, GridDataSourceSettings, GridEditing, GridFiltering, GridGrouping, GridUploadSettings, GridPaging, GridPager, GridRowDetail, GridColumnHeader, GridSummaryRow, GridGroupHeader, GridHeader, GridFooter, GridRow, GridCell, GridSelection, GridSorting } from './../index';
 export { GridProperties } from "./../index";
-export { GridAppearanceAutoGenerateRowLabelMode, GridAppearanceAutoGenerateColumnLabelMode, GridResizeMode, GridClipboardAutoFillMode, HorizontalAlignment, VerticalAlignment, Position, GridColumnFilterMenuMode, GridColumnSortOrder, GridConditionalFormattingCondition, GridDataExportPageOrientation, GridDataSourceSettingsSanitizeHTML, GridDataSourceSettingsDataFieldDataType, GridDataSourceSettingsDataSourceType, GridEditingAction, LayoutPosition, GridCommandDisplayMode, GridEditingMode, GridEditingAddNewRowDisplayMode, GridFilteringFilterRowApplyMode, GridFilteringFilterMenuMode, GridGroupingExpandMode, GridGroupingRenderMode, GridPagerAutoEllipsis, Scrolling, GridSelectionMode, GridSelectionAction, GridSelectionCheckBoxesSelectAllMode, GridSortingMode, GridSortingCommandKey, GridAppearance, GridBehavior, GridLayout, GridClipboard, GridColumn, GridContextMenu, GridContextMenuDataSource, GridCommand, GridColumnMenu, GridColumnMenuDataSource, GridColumnGroup, GridConditionalFormatting, GridCharting, Dialog, GridCheckBoxes, GridDataExport, GridDataSourceSettings, GridDataSourceSettingsDataField, GridEditing, GridEditingCommandKeys, GridCommandKey, GridEditingCommandBar, GridEditingCommandBarDataSource, GridEditingCommandColumn, GridEditingCommandColumnDataSource, GridEditingAddNewRow, GridEditingAddNewColumn, GridFiltering, GridFilteringFilterRow, GridFilteringFilterMenu, GridFilteringFilterBuilder, GridGrouping, GridGroupingGroupBar, GridGroupingSummaryRow, GridPaging, GridPagingSpinner, GridPager, GridPagerPageSizeSelector, GridPagerSummary, GridPagerNavigationButtons, GridPagerNavigationButtonsPrevNextButtons, GridPagerNavigationButtonsFirstLastButtons, GridPagerNavigationButtonsLabels, GridPagerNavigationInput, GridPagerPageIndexSelectors, GridRowDetail, GridColumnHeader, GridSummaryRow, GridGroupHeader, GridHeader, GridFooter, GridRow, GridCell, GridSelection, GridSelectionCheckBoxes, GridSorting } from './../index';
+export { GridAppearanceAutoGenerateRowLabelMode, GridAppearanceAutoGenerateColumnLabelMode, GridResizeMode, GridClipboardAutoFillMode, HorizontalAlignment, VerticalAlignment, Position, GridColumnFilterMenuMode, GridColumnSortOrder, GridConditionalFormattingCondition, GridDataExportPageOrientation, GridDataSourceSettingsSanitizeHTML, GridDataSourceSettingsDataFieldDataType, GridDataSourceSettingsDataSourceType, GridEditingAction, LayoutPosition, GridCommandDisplayMode, GridEditingMode, GridEditingAddNewRowDisplayMode, GridFilteringFilterRowApplyMode, GridFilteringFilterMenuMode, GridGroupingExpandMode, GridGroupingRenderMode, GridPagerAutoEllipsis, Scrolling, GridSelectionMode, GridSelectionAction, GridSelectionCheckBoxesSelectAllMode, GridSortingMode, GridSortingCommandKey, GridAppearance, GridBehavior, GridLayout, GridClipboard, GridColumn, GridContextMenu, GridContextMenuDataSource, GridCommand, GridColumnMenu, GridColumnMenuDataSource, GridColumnGroup, GridConditionalFormatting, GridCharting, Dialog, GridCheckBoxes, GridDataExport, GridDataSourceSettings, GridDataSourceSettingsDataField, GridEditing, GridEditingCommandKeys, GridCommandKey, GridEditingCommandBar, GridEditingCommandBarDataSource, GridEditingCommandColumn, GridEditingCommandColumnDataSource, GridEditingAddNewRow, GridEditingAddNewColumn, GridFiltering, GridFilteringFilterRow, GridFilteringFilterMenu, GridFilteringFilterBuilder, GridGrouping, GridGroupingGroupBar, GridGroupingSummaryRow, GridUploadSettings, GridPaging, GridPagingSpinner, GridPager, GridPagerPageSizeSelector, GridPagerSummary, GridPagerNavigationButtons, GridPagerNavigationButtonsPrevNextButtons, GridPagerNavigationButtonsFirstLastButtons, GridPagerNavigationButtonsLabels, GridPagerNavigationInput, GridPagerPageIndexSelectors, GridRowDetail, GridColumnHeader, GridSummaryRow, GridGroupHeader, GridHeader, GridFooter, GridRow, GridCell, GridSelection, GridSelectionCheckBoxes, GridSorting } from './../index';
 export { DataAdapter, Chart } from './../index';
 export declare const Smart: any;
 export interface GridProps extends GridProperties {
@@ -216,22 +216,22 @@ export declare class Grid extends React.Component<React.HTMLAttributes<Element>
     set onAfterInit(value: {
         (): void;
     });
-    /** Describes the paging settings.
+    /** Sets the grid's image upload settings for the image columns.
     *	Property type: any
     */
     get onChartInit(): any;
     set onChartInit(value: any);
-    /** Describes the pager settings.
+    /** Describes the paging settings.
     *	Property type: any
     */
     get onRender(): any;
     set onRender(value: any);
-    /** Sets the row details.
+    /** Describes the pager settings.
     *	Property type: any
     */
     get onLoad(): any;
     set onLoad(value: any);
-    /** Sets the scroll mode settings.
+    /** Sets the row details.
     *	Property type: {(event: KeyboardEvent): void}
     */
     get onKey(): {
@@ -240,7 +240,7 @@ export declare class Grid extends React.Component<React.HTMLAttributes<Element>
     set onKey(value: {
         (event: KeyboardEvent): void;
     });
-    /** Describes the column header settings.
+    /** Sets the scroll mode settings.
     *	Property type: {(index: number, row: GridRow): void}
     */
     get onRowInit(): {
@@ -249,7 +249,7 @@ export declare class Grid extends React.Component<React.HTMLAttributes<Element>
     set onRowInit(value: {
         (index: number, row: GridRow): void;
     });
-    /** Describes the summary row settings.
+    /** Describes the column header settings.
     *	Property type: {(index: number, row: GridRow, details: HTMLElement): void}
     */
     get onRowDetailInit(): {
@@ -258,7 +258,7 @@ export declare class Grid extends React.Component<React.HTMLAttributes<Element>
     set onRowDetailInit(value: {
         (index: number, row: GridRow, details: HTMLElement): void;
     });
-    /** Describes the settings for the group header.
+    /** Describes the summary row settings.
     *	Property type: {(index: number, row: GridRow, details: HTMLElement): void}
     */
     get onRowDetailUpdated(): {
@@ -267,7 +267,7 @@ export declare class Grid extends React.Component<React.HTMLAttributes<Element>
     set onRowDetailUpdated(value: {
         (index: number, row: GridRow, details: HTMLElement): void;
     });
-    /** Describes the header settings of the grid.
+    /** Describes the settings for the group header.
     *	Property type: {(index: number, row: GridRow, history: any[]): void}
     */
     get onRowHistory(): {
@@ -276,7 +276,7 @@ export declare class Grid extends React.Component<React.HTMLAttributes<Element>
     set onRowHistory(value: {
         (index: number, row: GridRow, history: any[]): void;
     });
-    /** Describes the footer settings of the grid.
+    /** Describes the header settings of the grid.
     *	Property type: {(index: number, row: GridRow, history: any[]): void}
     */
     get onRowStyle(): {
@@ -285,7 +285,7 @@ export declare class Grid extends React.Component<React.HTMLAttributes<Element>
     set onRowStyle(value: {
         (index: number, row: GridRow, history: any[]): void;
     });
-    /** Sets or gets the value indicating whether the element is aligned to support locales using right-to-left fonts.
+    /** Describes the footer settings of the grid.
     *	Property type: {(index: number[], row: GridRow[]): void}
     */
     get onRowInserted(): {
@@ -294,7 +294,7 @@ export declare class Grid extends React.Component<React.HTMLAttributes<Element>
     set onRowInserted(value: {
         (index: number[], row: GridRow[]): void;
     });
-    /** The rows property is used to describe all rows displayed in the grid.
+    /** Sets or gets the value indicating whether the element is aligned to support locales using right-to-left fonts.
     *	Property type: {(indexes: number[], rows: GridRow[]): void}
     */
     get onRowRemoved(): {
@@ -303,7 +303,7 @@ export declare class Grid extends React.Component<React.HTMLAttributes<Element>
     set onRowRemoved(value: {
         (indexes: number[], rows: GridRow[]): void;
     });
-    /** Describes the selection settings.
+    /** The rows property is used to describe all rows displayed in the grid.
     *	Property type: {(index: number[], row: GridRow[], oldValues: any[], values: any[], confirm: {(commit: boolean): void}): void}
     */
     get onRowUpdate(): {
@@ -316,7 +316,7 @@ export declare class Grid extends React.Component<React.HTMLAttributes<Element>
             (commit: boolean): void;
         }): void;
     });
-    /** Describes sorting settings.
+    /** Describes the selection settings.
     *	Property type: {(index: number[], row: GridRow[]): void}
     */
     get onRowUpdated(): {
@@ -325,7 +325,7 @@ export declare class Grid extends React.Component<React.HTMLAttributes<Element>
     set onRowUpdated(value: {
         (index: number[], row: GridRow[]): void;
     });
-    /** undefined
+    /** Describes sorting settings.
     *	Property type: {(index: number, data: any, row: GridRow[]): void}
     */
     get onRowClass(): {
@@ -413,6 +413,11 @@ export declare class Grid extends React.Component<React.HTMLAttributes<Element>
     get users(): any[];
     set users(value: any[]);
     /** undefined
+    *	Property type: GridUploadSettings
+    */
+    get uploadSettings(): GridUploadSettings;
+    set uploadSettings(value: GridUploadSettings);
+    /** undefined
     *	Property type: GridPaging
     */
     get paging(): GridPaging;
@@ -779,18 +784,18 @@ export declare class Grid extends React.Component<React.HTMLAttributes<Element>
     * @param {string} position?. 'near' or 'far'
     * @returns {boolean}
   */
-    addNewRow(position?: string): Promise<any>;
+    addNewRow(position?: string): any;
     /** Adds a new column.
     * @param {any} column. A Grid column object. See 'columns' property.
     * @returns {boolean}
   */
-    addNewColumn(column: any): Promise<any>;
+    addNewColumn(column: any): any;
     /** Adds a new unbound row to the top or bottom. Unbound rows are not part of the Grid's dataSource. They become part of the dataSource, after an unbound row is edited.
     * @param {number} count. The count of unbound rows.
     * @param {string} position?. 'near' or 'far'
     * @returns {boolean}
   */
-    addUnboundRow(count: number, position?: string): Promise<any>;
+    addUnboundRow(count: number, position?: string): any;
     /** Adds a filter to a column. This method will apply a filter to the Grid data. Example for adding multiple filters to a column: grid.addFilter('lastName', ['CONTAINS "burke"', 'or', 'CONTAINS "peterson"']). Example for adding single filter to a column: grid.addFilter('lastName', 'CONTAINS "burke"'). Example for adding numeric filter:  grid.addFilter('quantity', '&lt;= 5')
     * @param {string} dataField. column bound data field. For example, if you have a column with dataField: 'firstName', set 'firstName' here.
     * @param {string} filter. Filter expression like: 'startsWith B'. Example 2: ['contains Andrew or contains Nancy'], Example 3:  ['quantity', '&lt;= 3 and &gt;= 8'].  Filter conditions which you can use in the expressions: '=', 'EQUAL','&lt;&gt;', 'NOT_EQUAL', '!=', '&lt;', 'LESS_THAN','&gt;', 'GREATER_THAN', '&lt;=', 'LESS_THAN_OR_EQUAL', '&gt;=', 'GREATER_THAN_OR_EQUAL','starts with', 'STARTS_WITH','ends with', 'ENDS_WITH', '', 'EMPTY', 'CONTAINS','DOES_NOT_CONTAIN', 'NULL','NOT_NULL'
@@ -819,7 +824,7 @@ export declare class Grid extends React.Component<React.HTMLAttributes<Element>
     /** This method returns true, if all rows in the Grid are selected.
     * @returns {boolean}
   */
-    areAllRowsSelected(): Promise<any>;
+    areAllRowsSelected(): any;
     /** Starts an update operation. This is appropriate when calling multiple methods or set multiple properties at once.
     */
     beginUpdate(): void;
@@ -880,7 +885,7 @@ export declare class Grid extends React.Component<React.HTMLAttributes<Element>
     * @param {string} dataField?. column bound data field. For example, if you have a column with dataField: 'firstName', set 'firstName' here.
     * @returns {boolean}
   */
-    ensureVisible(rowId: string | number, dataField?: string): Promise<any>;
+    ensureVisible(rowId: string | number, dataField?: string): any;
     /** Ends the editing. This method confirms all changes and closes the opened cell editor(s).
     */
     endEdit(): void;
@@ -909,12 +914,12 @@ export declare class Grid extends React.Component<React.HTMLAttributes<Element>
     * @param {string} condition?. Conditions which you can use in the expressions: '=', 'EQUAL','&lt;&gt;', 'NOT_EQUAL', '!=', '&lt;', 'LESS_THAN','&gt;', 'GREATER_THAN', '&lt;=', 'LESS_THAN_OR_EQUAL', '&gt;=', 'GREATER_THAN_OR_EQUAL','starts with', 'STARTS_WITH','ends with', 'ENDS_WITH', '', 'EMPTY', 'CONTAINS','DOES_NOT_CONTAIN', 'NULL','NOT_NULL'
     * @returns {any[]}
   */
-    find(query: string, dataField?: string, condition?: string): Promise<any>;
+    find(query: string, dataField?: string, condition?: string): any;
     /** Finds entries by using a query and returns an array of cells. Each cell in the array is also an array in this format: [id, dataField, value]. Example: const cells = grid.findCells('nancy'); returns all cells that have 'nancy' value. Example 2: const cells = grid.findCells('nancy, davolio'); returns all cells that have 'nancy' and 'davolio' values.
     * @param {string} query. Search query. You can enter multiple search strings, by using ','. Example: 'nancy, davolio'
     * @returns {any[]}
   */
-    findCells(query: string): Promise<any>;
+    findCells(query: string): any;
     /** Navigates to a page, when paging is enabled.
     * @param {number} index. page index
     */
@@ -947,126 +952,126 @@ export declare class Grid extends React.Component<React.HTMLAttributes<Element>
     /** Gets the maximum position of the vertical scrollbar. You can use this method in combination with the setVerticalScrollValue to apply a new scroll position.
     * @returns {number}
   */
-    getVerticalScrollMax(): Promise<any>;
+    getVerticalScrollMax(): any;
     /** Gets the position of the vertical scrollbar.
     * @returns {number}
   */
-    getVerticalScrollValue(): Promise<any>;
+    getVerticalScrollValue(): any;
     /** Gets the maximum position of the horizontal scrollbar. You can use this method in combination with the setHorizontalScrollValue to apply a new scroll position.
     * @returns {number}
   */
-    getHorizontalScrollMax(): Promise<any>;
+    getHorizontalScrollMax(): any;
     /** Gets the position of the horizontal scrollbar.
     * @returns {number}
   */
-    getHorizontalScrollValue(): Promise<any>;
+    getHorizontalScrollValue(): any;
     /** Gets the columns array. Each item in the array contains the column properties which are dynamically set by the user interaction and the columns initialization data properties such as: 'label', 'dataField', 'dataType', 'visible'.
     * @returns {any}
   */
-    getColumns(): Promise<any>;
+    getColumns(): any;
     /** Gets the editing cell(s), when the grid is editing.
     * @returns {any[]}
   */
-    getEditCells(): Promise<any>;
+    getEditCells(): any;
     /** Gets the groups array.
     * @returns {any[]}
   */
-    getGroups(): Promise<any>;
+    getGroups(): any;
     /** Gets an array of columns with applied sorting. Each member in the array is with column's data field used as a key and 'sortOrder' and 'sortIndex' as a value.
     * @returns {{[dataField: string]: { sortOrder: string, sortIndex: number }}}
   */
-    getSortedColumns(): Promise<any>;
+    getSortedColumns(): any;
     /** Gets the selection.
     * @returns {any}
   */
-    getSelection(): Promise<any>;
+    getSelection(): any;
     /** Gets an Array where each item is an Array of row id and row data. If the Grid is used in virtual mode, the row data parameter is empty object, because the data is loaded on demand.
     * @returns {any[]}
   */
-    getSelectedRows(): Promise<any>;
+    getSelectedRows(): any;
     /** Gets the selected row ids.
     * @returns {any[]}
   */
-    getSelectedRowIds(): Promise<any>;
+    getSelectedRowIds(): any;
     /** Gets the selected row indexes.
     * @returns {any[]}
   */
-    getSelectedRowIndexes(): Promise<any>;
+    getSelectedRowIndexes(): any;
     /** Gets the selected cells. The method returns an array of cell. Each cell is an array with row id, column data field and cell value.
     * @returns {any[]}
   */
-    getSelectedCells(): Promise<any>;
+    getSelectedCells(): any;
     /** Gets an array of columns with applied filters.
     * @returns {any}
   */
-    getFilteredColumns(): Promise<any>;
+    getFilteredColumns(): any;
     /** Gets an array of rows, which are visible and match the applied filter.
     * @returns {any}
   */
-    getVisibleRows(): Promise<any>;
+    getVisibleRows(): any;
     /** Gets the result of the getVisibleRows or the rows hierarchy, when the Grid is in TreeGrid/Grouping mode.
     * @returns {any}
   */
-    getViewRows(): Promise<any>;
+    getViewRows(): any;
     /** Gets a JSON object with the following fields: 'sort', 'filter', 'groups', 'paging', 'selectedCells', 'selectedrows'.
     * @returns {any}
   */
-    getState(): Promise<any>;
+    getState(): any;
     /** Gets the changes from the batch edit.
     * @returns {{ upDated: [{ id: string, dataField: string, oldValue: Object, newValue: Object }], deleted: [{id: string, data: Object}], added: [{id: string, data: Object}] }}
   */
-    getBatchEditChanges(): Promise<any>;
+    getBatchEditChanges(): any;
     /** Gets a value of a cell.
     * @param {string | number} rowId. row bound id
     * @param {string} dataField. column bound data field. For example, if you have a column with dataField: 'firstName', set 'firstName' here.
     * @returns {any}
   */
-    getCellValue(rowId: string | number, dataField: string): Promise<any>;
+    getCellValue(rowId: string | number, dataField: string): any;
     /** Gets a column. Returns a Grid column object.
     * @param {string} dataField. column bound data field. For example, if you have a column with dataField: 'firstName', set 'firstName' here.
     * @returns {GridColumn}
   */
-    getColumn(dataField: string): Promise<any>;
+    getColumn(dataField: string): any;
     /** Gets a value of a column.
     * @param {string} dataField. column bound data field. For example, if you have a column with dataField: 'firstName', set 'firstName' here.
     * @param {string} propertyName. The property name.
     * @returns {any}
   */
-    getColumnProperty(dataField: string, propertyName: string): Promise<any>;
+    getColumnProperty(dataField: string, propertyName: string): any;
     /** Gets a value of a row.
     * @param {string | number} rowId. row bound id
     * @param {string} propertyName. The property name.
     * @returns {any}
   */
-    getRowProperty(rowId: string | number, propertyName: string): Promise<any>;
+    getRowProperty(rowId: string | number, propertyName: string): any;
     /** Gets a row. Returns a Grid row object.
     * @param {string | number} rowId. row bound id
     * @returns {GridRow}
   */
-    getRow(rowId: string | number): Promise<any>;
+    getRow(rowId: string | number): any;
     /** Gets a row by its index. Returns a Grid row object.
     * @param {number} rowIndex. row bound index
     * @returns {GridRow}
   */
-    getRowByIndex(rowIndex: number): Promise<any>;
+    getRowByIndex(rowIndex: number): any;
     /** Gets the Data source data associated to the row.
     * @param {string | number} rowId. row bound id
     * @returns {any}
   */
-    getRowData(rowId: string | number): Promise<any>;
+    getRowData(rowId: string | number): any;
     /** Gets the Row's id by a row index.
     * @param {number} rowIndex. row index
     * @returns {string | number}
   */
-    getRowId(rowIndex: number): Promise<any>;
+    getRowId(rowIndex: number): any;
     /** Gets whether a column's drop-down menu is opened.
     * @returns {boolean}
   */
-    hasMenu(): Promise<any>;
+    hasMenu(): any;
     /** This method returns true, if any rows in the Grid are selected.
     * @returns {boolean}
   */
-    hasSelectedRows(): Promise<any>;
+    hasSelectedRows(): any;
     /** Hides the Details of a Row, when row details are enabled.
     * @param {string | number} rowId. row bound id
     */