@syncfusion/ej2-grids 20.3.47-54738 → 20.3.47-54739

package/src/grid/base/enum.d.ts

@@ -0,0 +1,704 @@
+/**
+ * Defines Actions of the Grid. They are
+ * * paging
+ * * refresh
+ * * sorting
+ * * filtering
+ * * selection
+ * * rowdraganddrop
+ * * reorder
+ * * grouping
+ * * ungrouping
+ */
+export declare type Action = 
+/**  Defines current Action as Paging */
+'paging' | 
+/**  Defines current Action as Refresh */
+'refresh' | 
+/**  Defines current Action as Sorting */
+'sorting' | 
+/**  Defines current Action as Selection */
+'selection' | 
+/**  Defines current Action as Filtering */
+'filtering' | 
+/**  Defines current Action as Searching */
+'searching' | 
+/**  Defines current Action as Row Drag and Drop */
+'rowdraganddrop' | 
+/**  Defines current Action as Reorder */
+'reorder' | 
+/**  Defines current Action as Grouping */
+'grouping' | 
+/**  Defines current Action as UnGrouping */
+'ungrouping' | 
+/**  Defines current Action as Batch Save */
+'batchsave' | 
+/** Defines current Action as Virtual Scroll */
+'virtualscroll' | 
+/** Defines current Action as print */
+'print' | 
+/** Defines current Action as beginedit */
+'beginEdit' | 
+/** Defines current Action as save */
+'save' | 
+/** Defines current Action as delete */
+'delete' | 
+/** Defines current Action as cancel */
+'cancel' | 
+/** Defines current Action as add */
+'add' | 
+/** Defines current Action as filterBeforeOpen */
+'filterBeforeOpen' | 
+/** Defines current Action as filterChoiceRequest */
+'filterchoicerequest' | 
+/** Defines current Action as filterAfterOpen */
+'filterAfterOpen' | 
+/** Defines current Action as filterSearchBegin */
+'filterSearchBegin' | 
+/** represents the column state */
+'columnstate' | 
+/** Defines current Action as Infinite Scroll */
+'infiniteScroll' | 
+/** Defines current Action as stringfilterrequest */
+'stringfilterrequest';
+/**
+ * Defines directions of Sorting. They are
+ * * Ascending
+ * * Descending
+ */
+export declare type SortDirection = 
+/**  Defines SortDirection as Ascending */
+'Ascending' | 
+/**  Defines SortDirection as Descending */
+'Descending';
+/**
+ * `columnQueryMode`provides options to retrive data from the datasource. They are
+ * * All
+ * * Schema
+ * * ExcludeHidden
+ */
+export declare type ColumnQueryModeType = 
+/**  It Retrieves whole datasource */
+'All' | 
+/**  Retrives data for all the defined columns in grid from the datasource.  */
+'Schema' | 
+/**  Retrives data only for visible columns of grid from the dataSource. */
+'ExcludeHidden';
+/**
+ * Defines types of Selection. They are
+ * * Single - Allows user to select a row or cell.
+ * * Multiple - Allows user to select multiple rows or cells.
+ */
+export declare type SelectionType = 
+/**  Defines Single selection in the Grid */
+'Single' | 
+/**  Defines multiple selections in the Grid */
+'Multiple';
+/**
+ * Defines modes of checkbox Selection. They are
+ * * Default
+ * * ResetOnRowClick
+ */
+export declare type CheckboxSelectionType = 
+/**  Allows the user to select multiple rows by clicking rows one by one */
+'Default' | 
+/**  Allows to reset the previously selected row when a row is clicked and multiple rows can be selected by using CTRL or SHIFT key */
+'ResetOnRowClick';
+/**
+ * Defines alignments of text, they are
+ * * Left
+ * * Right
+ * * Center
+ * * Justify
+ */
+export declare type TextAlign = 
+/**  Defines Left alignment */
+'Left' | 
+/**  Defines Right alignment */
+'Right' | 
+/**  Defines Center alignment */
+'Center' | 
+/**  Defines Justify alignment */
+'Justify';
+/**
+ * Defines types of Cell
+ *
+ * @hidden
+ */
+export declare enum CellType {
+    /**  Defines CellType as Data */
+    Data = 0,
+    /**  Defines CellType as Header */
+    Header = 1,
+    /**  Defines CellType as Summary */
+    Summary = 2,
+    /**  Defines CellType as GroupSummary */
+    GroupSummary = 3,
+    /**  Defines CellType as CaptionSummary */
+    CaptionSummary = 4,
+    /**  Defines CellType as Filter */
+    Filter = 5,
+    /**  Defines CellType as Indent */
+    Indent = 6,
+    /**  Defines CellType as GroupCaption */
+    GroupCaption = 7,
+    /**  Defines CellType as GroupCaptionEmpty */
+    GroupCaptionEmpty = 8,
+    /**  Defines CellType as Expand */
+    Expand = 9,
+    /**  Defines CellType as HeaderIndent */
+    HeaderIndent = 10,
+    /**  Defines CellType as StackedHeader */
+    StackedHeader = 11,
+    /**  Defines CellType as DetailHeader */
+    DetailHeader = 12,
+    /**  Defines CellType as DetailExpand */
+    DetailExpand = 13,
+    /**  Defines CellType as CommandColumn */
+    CommandColumn = 14,
+    /**  Defines CellType as DetailFooterIntent */
+    DetailFooterIntent = 15,
+    /**  Defines CellType as RowDrag */
+    RowDragIcon = 16,
+    /**  Defines CellType as RowDragHeader */
+    RowDragHIcon = 17
+}
+/**
+ * Defines modes of GridLine, They are
+ * * Both - Displays both the horizontal and vertical grid lines.
+ * * None - No grid lines are displayed.
+ * * Horizontal - Displays the horizontal grid lines only.
+ * * Vertical - Displays the vertical grid lines only.
+ * * Default - Displays grid lines based on the theme.
+ */
+export declare type GridLine = 
+/** Show both the vertical and horizontal line in the Grid  */
+'Both' | 
+/** Hide both the vertical and horizontal line in the Grid  */
+'None' | 
+/** Shows the horizontal line only in the Grid */
+'Horizontal' | 
+/** Shows the vertical line only in the Grid  */
+'Vertical' | 
+/** Shows the grid lines based on the theme  */
+'Default';
+/**
+ * Defines types of Render
+ *
+ * @hidden
+ */
+export declare enum RenderType {
+    /**  Defines RenderType as Header */
+    Header = 0,
+    /**  Defines RenderType as Content */
+    Content = 1,
+    /**  Defines RenderType as Summary */
+    Summary = 2
+}
+/**
+ * Defines modes of Selection, They are
+ * * Row
+ * * Cell
+ * * Both
+ */
+export declare type SelectionMode = 
+/**  Defines SelectionMode as Cell */
+'Cell' | 
+/**  Defines SelectionMode as Row */
+'Row' | 
+/**  Defines SelectionMode as Both */
+'Both';
+/**
+ * Print mode options are
+ * * AllPages - Print all pages records of the Grid.
+ * * CurrentPage - Print current page records of the Grid.
+ */
+export declare type PrintMode = 
+/**  Defines PrintMode as AllPages */
+'AllPages' | 
+/**  Defines PrintMode as CurrentPage */
+'CurrentPage';
+/**
+ * Hierarchy Grid Print modes are
+ * * `Expanded` - Prints the master grid with expanded child grids.
+ * * `All` - Prints the master grid with all the child grids.
+ * * `None` - Prints the master grid alone.
+ */
+export declare type HierarchyGridPrintMode = 
+/**  Defines Hierarchy PrintMode as Expanded */
+'Expanded' | 
+/**  Defines Hierarchy PrintMode as All */
+'All' | 
+/** Defines Hierarchy PrintMode as None */
+'None';
+/**
+ * Defines types of Filter
+ * * Menu - Specifies the filter type as menu.
+ * * Excel - Specifies the filter type as excel.
+ * * FilterBar - Specifies the filter type as filter bar.
+ * * CheckBox - Specifies the filter type as check box.
+ */
+export declare type FilterType = 
+/**  Defines FilterType as filterbar */
+'FilterBar' | 
+/**  Defines FilterType as excel */
+'Excel' | 
+/**  Defines FilterType as menu */
+'Menu' | 
+/**  Defines FilterType as checkbox */
+'CheckBox';
+/**
+ * Filter bar mode options are
+ * * OnEnter - Initiate filter operation after Enter key is pressed.
+ * * Immediate -  Initiate filter operation after certain time interval. By default time interval is 1500 ms.
+ */
+export declare type FilterBarMode = 
+/**  Defines FilterBarMode as onenter */
+'OnEnter' | 
+/**  Defines FilterBarMode  as immediate */
+'Immediate';
+/**
+ * Defines the aggregate types.
+ */
+export declare type AggregateType = 
+/** Defines sum aggregate type */
+'Sum' | 
+/** Specifies average aggregate type */
+'Average' | 
+/** Specifies maximum aggregate type */
+'Max' | 
+/** Specifies minimum aggregate type */
+'Min' | 
+/** Specifies count aggregate type */
+'Count' | 
+/** Specifies true count aggregate type */
+'TrueCount' | 
+/** Specifies false count aggregate type */
+'FalseCount' | 
+/** Specifies custom aggregate type */
+'Custom';
+/**
+ * Defines the wrap mode.
+ * * Both -  Wraps both header and content.
+ * * Header - Wraps header alone.
+ * * Content - Wraps content alone.
+ * {% codeBlock src='grid/textWrapSettings/index.md' %}{% endcodeBlock %}
+ */
+export declare type WrapMode = 
+/** Wraps both header and content */
+'Both' | 
+/** Wraps  header alone */
+'Header' | 
+/** Wraps  content alone */
+'Content';
+/**
+ * Defines Multiple Export Type.
+ */
+export declare type MultipleExportType = 
+/**  Multiple Grids are exported to same Worksheet. */
+'AppendToSheet' | 
+/**  Multiple Grids are exported to separate Worksheet. */
+'NewSheet';
+/**
+ * Defines Predefined toolbar items.
+ *
+ * @hidden
+ */
+export declare type ToolbarItems = 
+/** Add new record */
+'Add' | 
+/** Delete selected record */
+'Delete' | 
+/** Update edited record */
+'Update' | 
+/** Cancel the edited state */
+'Cancel' | 
+/** Edit the selected record */
+'Edit' | 
+/** Searches the grid records by given key */
+'Search' | 
+/** ColumnChooser used show/gird columns */
+'ColumnChooser' | 
+/** Print the Grid */
+'Print' | 
+/** Export the Grid to PDF format */
+'PdfExport' | 
+/** Export the Grid to Excel format */
+'ExcelExport' | 
+/** Export the Grid to CSV format */
+'CsvExport' | 
+/** Export the Grid to word fromat */
+'WordExport';
+/**
+ * Defines the cell content's overflow mode. The available modes are
+ * * `Clip` -  Truncates the cell content when it overflows its area.
+ * * `Ellipsis` -  Displays ellipsis when the cell content overflows its area.
+ * * `EllipsisWithTooltip` - Displays ellipsis when the cell content overflows its area
+ * also it will display tooltip while hover on ellipsis applied cell.
+ * {% codeBlock src='grid/clipMode/index.md' %}{% endcodeBlock %}
+ */
+export declare type ClipMode = 
+/**  Truncates the cell content when it overflows its area */
+'Clip' | 
+/** Displays ellipsis when the cell content overflows its area */
+'Ellipsis' | 
+/** Displays ellipsis when the cell content overflows its area also it will display tooltip while hover on ellipsis applied cell. */
+'EllipsisWithTooltip';
+/**
+ * Defines the Command Buttons type.
+ * * Edit -  Edit the current record.
+ * * Delete - Delete the current record.
+ * * Save - Save the current edited record.
+ * * Cancel - Cancel the edited state.
+ */
+export declare type CommandButtonType = 
+/** Default enum type */
+'None' | 
+/** Edit the current row */
+'Edit' | 
+/** Delete the current row */
+'Delete' | 
+/** Save the current edited row */
+'Save' | 
+/**  Cancel the edited state */
+'Cancel';
+/**
+ * Defines the default items of context menu.
+ */
+export declare type ContextMenuItem = 
+/**  Auto fit the size of all columns */
+'AutoFitAll' | 
+/**  Auto fit the current column */
+'AutoFit' | 
+/**  Group by current column */
+'Group' | 
+/**  Ungroup by current column */
+'Ungroup' | 
+/**  Edit the current record */
+'Edit' | 
+/**  Delete the current record */
+'Delete' | 
+/**  Save the edited record */
+'Save' | 
+/**  Cancel the edited state */
+'Cancel' | 
+/**  Copy the selected records */
+'Copy' | 
+/**  Export the grid as Pdf format */
+'PdfExport' | 
+/**  Export the grid as Excel format */
+'ExcelExport' | 
+/**  Export the grid as CSV format */
+'CsvExport' | 
+/**  Sort the current column in ascending order */
+'SortAscending' | 
+/**  Sort the current column in descending order */
+'SortDescending' | 
+/**  Go to the first page */
+'FirstPage' | 
+/**  Go to the previous page */
+'PrevPage' | 
+/**  Go to the last page */
+'LastPage' | 
+/**  Go to the next page */
+'NextPage';
+/**
+ * Defines the default items of Column menu.
+ */
+export declare type ColumnMenuItem = 
+/**  Auto fit the size of all columns */
+'AutoFitAll' | 
+/**  Auto fit the current column */
+'AutoFit' | 
+/**  Group by current column */
+'Group' | 
+/**  Ungroup by current column */
+'Ungroup' | 
+/**  Sort the current column in ascending order */
+'SortAscending' | 
+/**  Sort the current column in descending order */
+'SortDescending' | 
+/**  show the column chooser */
+'ColumnChooser' | 
+/**  show the Filter popup */
+'Filter';
+/**
+ * Defines Predefined toolbar items.
+ *
+ * @hidden
+ */
+export declare enum ToolbarItem {
+    Add = 0,
+    Edit = 1,
+    Update = 2,
+    Delete = 3,
+    Cancel = 4,
+    Print = 5,
+    Search = 6,
+    ColumnChooser = 7,
+    PdfExport = 8,
+    ExcelExport = 9,
+    CsvExport = 10,
+    WordExport = 11
+}
+export declare type PdfPageSize = 'Letter' | 'Note' | 'Legal' | 'A0' | 'A1' | 'A2' | 'A3' | 'A4' | 'A5' | 'A6' | 'A7' | 'A8' | 'A9' | 'B0' | 'B1' | 'B2' | 'B3' | 'B4' | 'B5' | 'Archa' | 'Archb' | 'Archc' | 'Archd' | 'Arche' | 'Flsa' | 'HalfLetter' | 'Letter11x17' | 'Ledger';
+export declare type PageOrientation = 'Landscape' | 'Portrait';
+export declare type ContentType = 'Image' | 'Line' | 'PageNumber' | 'Text';
+export declare type PdfPageNumberType = 'LowerLatin' | 'LowerRoman' | 'UpperLatin' | 'UpperRoman' | 'Numeric' | 'Arabic';
+export declare type PdfDashStyle = 'Solid' | 'Dash' | 'Dot' | 'DashDot' | 'DashDotDot';
+/**
+ * Defines PDF horizontal alignment.
+ */
+export declare type PdfHAlign = 
+/** left alignment */
+'Left' | 
+/** right alignment */
+'Right' | 
+/** center alignment */
+'Center' | 
+/** justify alignment */
+'Justify';
+/**
+ * Defines PDF vertical alignment.
+ */
+export declare type PdfVAlign = 
+/** top alignment */
+'Top' | 
+/** bottom alignment */
+'Bottom' | 
+/** middle alignment */
+'Middle';
+/**
+ * Defines Export Type.
+ */
+export declare type ExportType = 
+/** All pages of the grid is exported. */
+'AllPages' | 
+/** Current page in grid is exported. */
+'CurrentPage';
+/**
+ * Defines Excel horizontal alignment.
+ */
+export declare type ExcelHAlign = 
+/** left alignment  */
+'Left' | 
+/** right alignment  */
+'Right' | 
+/** center alignment  */
+'Center' | 
+/** fill alignment  */
+'Fill';
+/**
+ * Defines Excel vertical alignment.
+ */
+export declare type ExcelVAlign = 
+/** top alignment  */
+'Top' | 
+/** bottom alignment  */
+'Bottom' | 
+/** center alignment  */
+'Center' | 
+/** justify alignment  */
+'Justify';
+/**
+ * Defines excel border line style.
+ */
+export declare type ExcelBorderLineStyle = 
+/** thin line style  */
+'thin' | 
+/** thick line style  */
+'thick';
+/**
+ * Defines border line style.
+ */
+export declare type BorderLineStyle = 
+/** thin line style  */
+'Thin' | 
+/** thick line style  */
+'Thick';
+export declare type CheckState = 'Check' | 'Uncheck' | 'Intermediate' | 'None';
+/**
+ * Defines mode of cell selection.
+ * * Flow
+ * * Box
+ */
+export declare type CellSelectionMode = 
+/**  Defines CellSelectionMode as Flow */
+'Flow' | 
+/**  Defines CellSelectionMode as Box */
+'Box' | 
+/**  Defines CellSelectionMode as Box with border */
+'BoxWithBorder';
+/**
+ * Defines modes of editing.
+ * * Normal
+ * * Dialog
+ * * Batch
+ */
+export declare type EditMode = 
+/**  Defines EditMode as Normal */
+'Normal' | 
+/**  Defines EditMode as Dialog */
+'Dialog' | 
+/**  Defines EditMode as Batch */
+'Batch';
+/**
+ * Defines adding new row position.
+ * * Top
+ * * Bottom
+ */
+export declare type NewRowPosition = 
+/**  Defines row adding position as Top */
+'Top' | 
+/**  Defines row adding position as Top */
+'Bottom';
+/**
+ * Defines the Edit Type of the column
+ * * DefaultEdit
+ * * DropdownEdit
+ * * BooleanEdit
+ * * DatepickerEdit
+ * * DatetimepickerEdit
+ * * NumericEdit
+ */
+export declare type EditType = 
+/**  Defines EditType as DefaultEdit */
+'defaultEdit' | 
+/**  Defines EditMode as Dropdownedit */
+'dropDownEdit' | 
+/**  Defines EditMode as Booleanedit */
+'booleanEdit' | 
+/**  Defines EditMode as Datepickeredit */
+'datePickerEdit' | 
+/**  Defines EditType as Datetimepickeredit */
+'dateTimePickerEdit' | 
+/**  Defines EditMode as Numericedit */
+'numericEdit';
+/**
+ * Defines the Column Type
+ * * String
+ * * Number
+ * * Boolean
+ * * Date
+ * * DateTime
+ * * checkBox
+ */
+export declare type ColumnType = 
+/**  Defines ColumnType as Null */
+'none' | 
+/**  Defines ColumnType as String */
+'string' | 
+/**  Defines ColumnType as Number */
+'number' | 
+/**  Defines ColumnType as Boolean */
+'boolean' | 
+/**  Defines ColumnType as Date */
+'date' | 
+/**  Defines ColumnType as DateTime */
+'dateTime' | 
+/**  Defines ColumnType as checkBox */
+'checkBox';
+/**
+ * Defines the Aggregate Template Type
+ * * groupCaptionTemplate
+ * * groupFooterTemplate
+ * * footerTemplate
+ */
+export declare type AggregateTemplateType = 'GroupCaption' | 'GroupFooter' | 'Footer';
+/**
+ * Defines mode of resizing.
+ * * Normal
+ * * Auto
+ */
+export declare type ResizeMode = 
+/**  Columns will not be adjusted to fit the remaining space */
+'Normal' | 
+/**  Resized column width will be adjusted by other columns automatically */
+'Auto';
+/**
+ * Defines freeze direction of the grid columns
+ * * Left
+ * * Right
+ */
+export declare type freezeDirection = 
+/**  freeze the columns at left */
+'Left' | 
+/**  freeze the columns at right */
+'Right';
+/**
+ * Defines rendered part of the grid column
+ *
+ * @hidden
+ */
+export declare type freezeTable = 
+/**  Defines rendered the column at frozen left part */
+'frozen-left' | 
+/**  Defines rendered the columns at frozen right part */
+'frozen-right' | 
+/**  Defines rendered the columns at movable part */
+'movable';
+/**
+ * Defines name of the Grid frozen mode
+ * * Left
+ * * Right
+ * * Left-Right
+ */
+export declare type freezeMode = 
+/**  Left frozen mode */
+'Left' | 
+/**  Right frozen mode */
+'Right' | 
+/**  Left and right frozen mode */
+'Left-Right';
+/**
+ * Defines types of responsive dialogs
+ *
+ * @hidden
+ */
+export declare enum ResponsiveDialogAction {
+    /**  Defines dialog type as Edit */
+    isEdit = 0,
+    /**  Defines dialog type as Add */
+    isAdd = 1,
+    /**  Defines dialog type as Sort */
+    isSort = 2,
+    /**  Defines dialog type as Filter */
+    isFilter = 3
+}
+/**
+ * Defines responsive toolbar actions
+ *
+ * @hidden
+ */
+export declare enum ResponsiveToolbarAction {
+    /**  Defines initial responsive toolbar buttons */
+    isInitial = 0,
+    /**  Defines responsive toolbar search */
+    isSearch = 1
+}
+/**
+ * Defines mode of row rendering.
+ * * Horizontal
+ * * Vertical
+ */
+export declare type RowRenderingDirection = 
+/**  Defines horizontal row rendeing */
+'Horizontal' | 
+/**  Defined vertical row rendering */
+'Vertical';
+/**
+ * Defines keyboard focus keys.
+ *
+ * @hidden
+ */
+export declare type FocusKeys = 'downArrow' | 'upArrow' | 'PageUp' | 'PageDown' | 'enter' | 'shiftEnter' | 'tab' | 'shiftTab';
+/**
+ * Defines Loading Indicator of the Grid.
+ * * Spinner
+ * * Shimmer
+ */
+export declare type IndicatorType = 
+/**  Defines Loading Indicator as Spinner */
+'Spinner' | 
+/**  Defines Loading Indicator as Shimmer */
+'Shimmer';