Wijmo UI for the Web
IDetailSettings Interface
wijmo.grid Namespace : IDetailSettings Interface
Represents options of the detail grid.
Fields
 NameDescription
 Field

The afterCellEdit event handler is a function called after cell editing is completed. This function can assist you in completing many tasks, such as in making changes once editing is completed; in tracking changes in cells, columns, or rows; or in integrating custom editing functions on the front end.

 
 Field

The afterCellUpdate event handler is a function that is called after a cell has been updated. Among other functions, this event allows you to track and store the indices of changed rows or columns.

 
 Field

A value indicating whether columns can be moved.

 
 Field

Determines whether the column width can be increased and decreased by dragging the sizing handle, or the edge of the column header, with the mouse.

 
 Field

Determines whether the user can make changes to cell contents in the grid. This option is obsolete. Use the editingMode option instead.

 
 Field

Determines whether the user can move the current cell using the arrow keys.

 
 Field

Determines whether the grid should display paging buttons. The number of rows on a page is determined by the pageSize option.

 
 Field

Determines whether the widget can be sorted by clicking the column header.

 
 Field

A value that indicates whether virtual scrolling is allowed. Set allowVirtualScrolling to true when using large amounts of data to improve efficiency. Obsoleted, set the scrollingSettings.virtualization.mode property to "rows" instead.

 
 Field

The beforeCellEdit event handler is a function that is called before a cell enters edit mode. The beforeCellEdit event handler assists you in appending a widget, data, or other item to a wijgrid's cells before the cells enter edit mode. This event is cancellable if the editigMode options is set to "cell".

 
 Field

The beforeCellUpdate event handler is a function that is called before the cell is updated with new or user-entered data. This event is cancellable if the editingMode options is set to "cell". There are many instances where this event is helpful, such as when you need to check a cell's value before the update occurs or when you need to apply an alert message based on the cell's value.

 
 Field

A value that indicates calendar's options in grid. It works for calendar in inputdate.

 
 Field

The cellClicked event handler is a function that is called when a cell is clicked. You can use this event to get the information of a clicked cell using the args parameter.

 
 Field

This function is called each time wijgrid needs to change cell appearence, for example, when the current cell position is changed or cell is selected. Can be used for customization of cell style depending on its state.

 
 Field

The columnDragged event handler is a function that is called when column dragging has been started. You can use this event to find the column being dragged or the dragged column's location.

 
 Field

The columnDragging event handler is a function that is called when column dragging has been started, but before the wijgrid handles the operation. This event is cancellable.

 
 Field

The columnDropped event handler is a function that is called when a column has been dropped into the columns area.

 
 Field

The columnDropping event handler is a function that is called when a column is dropped into the columns area, but before wijgrid handles the operation. This event is cancellable.

 
 Field

The columnGrouped event handler is a function that is called when a column has been dropped into the group area.

 
 Field

The columnGrouping event handler is a function that is called when a column is dropped into the group area, but before the wijgrid handles the operation. This event is cancellable.

 
 Field

The columnResized event handler is called when a user has changed a column's size.

 
 Field

The columnResizing event handler is called when a user resizes the column but before the wijgrid handles the operation. This event is cancellable.

 
 Field

Type: wijmo.grid.IColumn[]

An array of column options.

 
 Field

Determines behavior for column autogeneration. Possible values are: "none", "append", "merge".

 
 Field

The columnUngrouped event handler is called when a column has been removed from the group area.

 
 Field

The columnUngrouping event handler is called when a column has been removed from the group area but before the wjgrid handles the operation. This event is cancellable.

 
 Field

Determines the culture ID.

 
 Field

A value that indicators the culture calendar to format the text. This option must work with culture option.

 
 Field

The currentCellChanged event handler is called after the current cell is changed.

 
 Field

The currentCellChanging event handler is called before the cell is changed. You can use this event to get a selected row or column or to get a data row bound to the current cell. This event is cancellable.

 
 Field

Type: wijmo.grid.IFilterOperator[]

An array of custom user filters. Use this option if you want to extend the default set of filter operators with your own. Custom filters will be shown in the filter dropdown.

 
 Field

Determines the datasource. Possible datasources include: 1. A DOM table. This is the default datasource, used if the data option is null. Table must have no cells with rowSpan and colSpan attributes. 2. A two-dimensional array, such as [[0, "a"], [1, "b"]]. 3. An array of objects, such as [{field0: 0, field1: "a"}, {field0: 1, field1: "b'}]. 4. A wijdatasource. 5. A wijdataview.

 
 Field

The dataLoaded event handler is a function that is called when data is loaded.

 
 Field

The dataLoading event handler is a function that is called when the wijgrid loads a portion of data from the underlying datasource. This can be used for modification of data sent to server if using dynamic remote wijdatasource.

 
 Field

The detailCreating event handler is called when wijgrid requires to create a new detail wijgrid.

 
 Field

Determines an action to bring a cell in the editing mode when the editingMode option is set to "cell". Possible values are: "click", "doubleClick", "auto".

 
 Field

Determines the editing mode. Possible values are: "none", "row", "cell",

 
 Field

Determines if the exact column width, in pixels, is used.

 
 Field

The filtered event handler is a function that is called after the wijgrid is filtered.

 
 Field

The filtering event handler is a function that is called before the filtering operation is started. For example, you can use this event to change a filtering condition before a filter will be applied to the data. This event is cancellable.

 
 Field

The filterOperatorsListShowing event handler is a function that is called before the filter drop-down list is shown. You can use this event to customize the list of filter operators for your users.

 
 Field

Determines the order of items in the filter drop-down list. Possible values are: "none", "alphabetical", "alphabeticalCustomFirst" and "alphabeticalEmbeddedFirst"

 
 Field

Determines whether the user can change position of the static column or row by dragging the vertical or horizontal freezing handle with the mouse. Possible values are: "none", "columns", "rows", "both". Obsoleted, use the scrollingSettings.freezingMode property instead.

 
 Field

The groupAggregate event handler is a function that is called when groups are being created and the column object's aggregate option has been set to "custom". This event is useful when you want to calculate custom aggregate values.

 
 Field

Determines the caption of the group area.

 
 Field

Determines the indentation of the groups, in pixels.

 
 Field

The groupText event handler is a function that is called when groups are being created and the groupInfo option has the groupInfo.headerText or the groupInfo.footerText options set to "custom". This event can be used to customize group headers and group footers.

 
 Field

Determines the height of the detail grid.

 
 Field

Determines whether the position of the current cell is highlighted or not.

 
 Field

Determines whether hovered row is highlighted or not.

 
 Field

The invalidCellValue event handler is a function called when a cell needs to start updating but the cell value is invalid. So if the value in a wijgrid cell can't be converted to the column target type, the invalidCellValue event will fire.

 
 Field

Determines the action to be performed when the user presses the TAB key.

 
 Field

The loaded event handler is a function that is called at the end the wijgrid's lifecycle when wijgrid is filled with data and rendered. You can use this event to manipulate the grid html content or to finish a custom load indication.

 
 Field

The loading event handler is a function that is called at the beginning of the wijgrid's lifecycle. You can use this event to activate a custom load progress indicator.

 
 Field

Determines the text to be displayed when the grid is loading.

 
 Field

Cell values equal to this property value are considered null values. Use this option if you want to change default representation of null values (empty strings) with something else.

 
 Field

Determines the zero-based index of the current page. You can use this to access a specific page, for example, when using the paging feature.

 
 Field

The pageIndexChanged event handler is a function that is called after the page index is changed, such as when you use the numeric buttons to swtich between pages or assign a new value to the pageIndex option.

 
 Field

The pageIndexChanging event handler is a function that is called before the page index is changed. This event is cancellable.

 
 Field

Type: wijmo.grid.IPagerSettings

Determines the pager settings for the grid including the mode (page buttons or next/previous buttons), number of page buttons, and position where the buttons appear.

 
 Field

Number of rows to place on a single page. The default value is 10.

 
 Field

A value indicating whether DOM cell attributes can be passed within a data value.

 
 Field

Type: wijmo.grid.IMasterDetailRelation[]

Determines an array of IMasterDetailRelation objects that represent master-detail relations in a hierarchical grid.

 
 Field

The rendered event handler is a function that is called when the wijgrid is rendered. Normally you do not need to use this event.

 
 Field

The rendering event handler is a function that is called when the wijgrid is about to render. Normally you do not need to use this event.

 
 Field

Determines the height of a rows when virtual scrolling is used. Obsoleted, use the scrollingSettings.virtualization.rowHeight property instead.

 
 Field

Function used for styling rows in wijgrid.

 
 Field

Type: wijmo.grid.IScrollingSettings

Determines the scrolling settings.

 
 Field

Determines which scrollbars are active and if they appear automatically based on content size. Possbile values are: "none", "auto", "horizontal", "vertical", "both". Obsoleted, use the scrollingSettings.mode property instead.

 
 Field

The selectionChanged event handler is a function that is called after the selection is changed.

 
 Field

Determines which cells, range of cells, columns, or rows can be selected at one time. Possible values are: "none", "singleCell", "singleColumn", "singleRow", "singleRange", "multiColumn", "multiRow" and "multiRange".

 
 Field

A value indicating whether the filter row is visible. Filter row is used to display column filtering interface.

 
 Field

A value indicating whether the footer row is visible. Footer row is used for displaying of tfoot section of original table, and to show totals.

 
 Field

A value indicating whether group area is visible. Group area is used to display headers of groupped columns. User can drag columns from/to group area by dragging column headers with mouse, if allowColMoving option is on.

 
 Field

A value indicating whether the row header is visible.

 
 Field

A value indicating whether a selection will be automatically displayed at the current cell position when the wijgrid is rendered. Set this option to false if you want to prevent wijgrid from selecting the currentCell automatically.

 
 Field

The sorted event handler is a function that is called after the widget is sorted. The allowSorting option must be set to "true" to allow this event to fire.

 
 Field

The sorting event handler is a function that is called before the sorting operation is started. This event is cancellable. The allowSorting option must be set to "true" for this event to fire.

 
 Field

Determines whether the hierarchy will be expanded by default or not.

 
 Field

Indicates the index of columns that will always be shown on the left when the grid view is scrolled horizontally. Obsoleted, use the scrollingSettings.staticColumnIndex property instead.

 
 Field

Gets or sets the alignment of the static columns area. Possible values are "left", "right". Obsoleted, use the scrollingSettings.staticColumnsAlignment property instead.

 
 Field

Indicates the index of data rows that will always be shown on the top when the wijgrid is scrolled vertically. Obsoleted, use the scrollingSettings.staticRowIndext property instead.

 
 Field

Gets or sets the virtual number of items in the wijgrid and enables custom paging. Setting option to a positive value activates custom paging, the number of displayed rows and the total number of pages will be determined by the totalRows and pageSize values.

 
 Field

Determines the width of the detail grid.

 
Top
See Also

Reference

wijmo.grid Namespace