Release Notes¶

========================================

Version 5.8.7 (2024-06-01)¶

Additions and Updates¶

Add new function to add custom excel style - font and colors in onBeforeExport event
Added parameters - this, value and options in editoptions.value object when it is a function. See: https://github.com/tonytomov/jqGrid/issues/1049Replaced the complette ajax event with success to fix server latency.Changes in headerData and footerData - added actions, addrow, delrow, remove. Action set can set data on certain position. Additional parameter is added index - to determine on which index to perform the action
Added parameter method (default GET) to excelExport which allow posting data with GET or POST
Add postForm function to post data to server without ajax
Add shadow class to support it in columnMenus and navigator actions menu
Add support for label class in form editing + fix position of dropmenu in navigator
Addition: if custom_value function return #ignoreme# the element is not added to the postdata to be posted to the server. This allow to ignore element by condition when post to the server.
Add function isVisible to resize only visible grids when responsive flag is on
Add minGridWidth and maxGridWidth grid parameters to which grid can not be resized defaults are 100 and 3000.
Add boolean grid parameter resizeHeight (true) to resize height when responsive is on. Set it to false does not resize the gridheight
Add name attribute to the pager selectbox
Add deleteIfExists in dbconfig (indexedDB) to determine if the existing data should be cleared when loading new one. Add reader property in the same to filter records - this can be a Function
Add onMultiSelect event which executes when action is performed
Add onErrorLoadData for simple subgrid when do ajax request. Added ajax error event in ajax populatesubgrid function.
To the multiselect checkboxes we can apply custom formatter
Add possibility in info_dialog to control the overlay
Add option items in colMenuAdd o be a possible to create one level submenu. Properties for text icon and run of items array are the same as for item menu
Optimize starsWith and endsWith in from function
Add tooltip property to setColSpanHeader too.
Add tooltip (title attribute) to setGroupHeaders
In onkeyCheck event is added a object baseFunc which contain the basic functions for movements in excelLikegrid. The following are available: bF.isValidCellm bF.getNextCell, bF.getNextVisibleCell, bF.movePage

Bug Fixes¶

Fix for setColSpanHeader to support html lables
Fix setColSpanHeader to accept html tags in titleText
Fix rowNum and other issues related to the rowIndex. See https://github.com/tonytomov/jqGrid/issues/1063#issuecomment-2106461023,
Set info_dialog to get the style in case the defaults.styleUI is set.
Fix deprecated substr in all modules. See: https://github.com/tonytomov/jqGrid/issues/1059,
Re-initializing v variable to prevent its assignment to the next filter fields
Fix grid in case it is within form tag and a enter is pressed. This caused submitting a form
Fix editing cell if row is disabled with a disabled class
Fix cellEdit in case no ariabody and enter key saves the cell.
Fix destroyGrid in case the grid does not exists
The footerData and headerData methods should get the un-formatted value when format parameter is on
Add scope=col to labels. We need to fix this for the grouped headers too.
Fix modal classes and info_dialog function
Show info dialog when error in indexedDB crud operations.
Fixes in deletestorageRecord and addstoragerecord and updatestoragerecords method in indexedDB
Fix selectAll check box not to be on when there are no records in the grid and preserveSelection is on
Fix identify selects in search form - the must have at minimum name attribute
Fix delete dialog width (bootstrap 5)
Fix navGrid not to create alertmod info dialog when it is created. This causes too many content in case of subgrids with navigators. Now we create in line dialog and remove it after it is closed.
Fix Add name attribute to some inputs elements for browser readers
Fix autowidth to be calculated before to put any content from the grid. Small improvements for bootstrap
Fix check the unformatted value in editCell https://github.com/tonytomov/jqGrid/issues/1055
Fix setGridWidth to remove the unneeded scroll when height auto and grid is resized.
Fix dropmenu=true to show all description texts when no button text is set
Fix custom button margin in pager in BS5 CSS
Fix calculating the count and return the right style number in addExcelStyle method.
Fixes for headerData/footerData in bootstrap.
Fix getTextWidth to update the font correct every time it is called with different one.
Fix in indexedDB when sortname are not set. We set the first field from colModel
Fix autosize_headers in case the label is changed with setLabel method.
Update grid.locale-he.js
Fix frozen columns when grouping and the grid is initially invisible: See https://github.com/tonytomov/jqGrid/issues/1041#issuecomment-1660613019
Fix frozen Columns in case of grouping and height auto See: https://github.com/tonytomov/jqGrid/issues/1041#issuecomment-1660790265
Fix returnAsString in ExportToCsv
Change the logic of saving the row when textarea and enter is pressed. First we check for onEnter event and then if the input is textarea.
Fix modal position when rtl and width is set to auto

Version 5.8.0 (2022-12-19)¶

Additions and Updates¶

When groupHeader is on the names appear in columns colmenu
Support colSpamStyle when export to excel and pdf and header grouping is on
ColumnChooser can not take in account grouping header values. To activate set groupHeaders to true in the method options.
Define inColumnHeader function as common to overcome writing repeated code
Added experimental comboGrid method
filterInput method can now be used for remote(ajax) data. Added new parameter selectFirstFound to highlight(select) the first found record in grid
Add new boolean parameter in bindKeys - onSlectRow - which disables or enables the execution of onSelectRow when enter is pressed. Default true.
Make getGridRowById method to use the much faster namedItem JavaScript build in function.
Add new method getGridRowByIndex to return the grid row by index.
Add grid parameter defaultColWidth default column width parameter in case the width is not set in colModel.
Add maxWidth option in colModel to support maximum width in columns. See https://github.com/tonytomov/jqGrid/issues/1019#issuecomment-1296806264
Add two new methods hideSearchCol and showSearchCol to show and hide columns when searchCols is on
Update the Romanian language file
Added onHeaderKeyCheck event to check the key when the naviagaion is on the header cells. Accept index an event as parameters. Can be used separately in ariaHeaderGrid or in setAriaGrid
Change the number of parameters of onKeyCheck in ariaGrid and excelLike grid
Add option visibleCoumns in searchColOptions to exclude a search on certain columns.
Remove column menu when show/hide col and do not remove it when sorting
Changes in dialogs bootstrap5
Add possibility to include fields by name in the summaryTpl formatting string. See https://github.com/tonytomov/jqGrid/issues/1015#issuecomment-1176405115
Add possibility to export only visible tree nodes in all export modules. The option is visibleTreeNodes, which by default is false.
Add option excel_header_format in exportoptions to separately format the header labels in export to excel.
Added new event replace_header_format, which is similar to replace_format, but only for the headers
Add labels array in data object parameter so that we can modify all the data before export in export modules. See customizeData event.
Adding Shift key to the disabled array in searchColOnKey method.
Added multiseparator option (string) in select editoptions to custom separate the data when multiple select is used instead of ","
triggerToolbar function accept parameter page to load certain page after triggering the search.
Add methods setColSpanHeader and destroyColSpanHeader to set colspan on headers.

Bug Fixes¶

Fix scrollMaxBuffer to work correct when virtual scroll is enabled.
Fix colmenu select in bootstrap5
Fix customFilterDef to run correctly after replacing eval
Fix loadState and jqGridExport methods to work correct when searchCols is on.
Fix not needed calculation when autoResizing is off, which can cause memory and time consuming in case of relative many rows and columns
Fix for bootstrap 3 css
Fix sizingString Function to accept options from formatter.
Fix title in serch dialog subgroup button
Fix for rtl
Fix sorting parameters when grouping is removed
CSS fixes for bootstrap5
Fix Bootstrap5 alert class
Fix grouping when groupingCollapse true and showSummaryOnHide. See https://github.com/tonytomov/jqGrid/issues/1014
Fix searchColOnEnter to work correct when frozenRows is on
Fix bootstrap5 to view the form without transparency
Fix horizontal scroll when filterToolbar.
Fix exportToExcel date fields.
Fix export hidden cols in exportToExcel
Fixing destroyColSpanHeader to do hide=false on the hidden spanning columns
Fix form edit form when initially set to auto and then reopen it without to change its position
Fixes for Bootstrap5 - search dialog and filter toolbar.
Small fix in setFrozenRows when data is already here (to quick)
Fix setRowData in case of treeGrid and the column is leaf

Version 5.7.0 (2022-03-09)¶

========================================

Additions and Updates¶

Add new transposed module which convert rows to columns Demo Docs
Add new frozen rows module Demo Docs
Add searching by column values. Demo Docs
Improve maxGridHeigh method. Add third parameter to indicate the minimum height at which the method run.
Add pager input to be configurable - i.e replace the input with text See
Changes in language file
Add title text when hovering column menu
Adding searchColumn menu when the new search is enabled
Add two new methods disabelColMenu and enableColMenu to disable and enable dynamically the column menu at specified column.
Add colMenuBeforeProcess for column menu as triggered event (grid option) + fix for building menu custom column menus
Optimizing rebuild calls when autoresizing is on
Scroll the form to top to view the error in case there are a lot of fields on it
Add stripScript function
Add customizeData event in exportToExcel which allow to work on the raw data before to export,

Bug Fixes¶

Fix problem when ariaGrid and searchColumn are on.
Fix setGridWidth when shrinkToFit is true and the data height is < gridheight (no vertical scroll) and show hide columns are performed
Fix sync the searchColumn with aria grid.
Prevent change the state of select box in multiselct mode when beforeSelectRow Return false. See
Prevent header checkbox (when multiselect) to go back in off state when it is off. See
Fix maxGridHeight to work after data is loaded. Remove not needed aftercomplete event. See
Fix multisort when frozen is off
Second fix for the callinf events with options parameter
Fix for previous fix when calling bindEvents with option parameter
Fix passing correct oper option when editing data plus adding the option array in dataEvents as parameter - the first parameter is event the second is a option
Fix show sort icons when frozen columns are on
Fix typo name in transposed module
Fix horizontal scroll when filterToolbar is on
Fix scrolling grid in certain cases.
Fix + optimization in frozenColumns method.
Fix mixing local names in resizeColumn
Fix parameter name in progressBar function
Fix for sort icons to be found correct
Fix multisort when frozenColumns and autoresizing are on
Fix when multisorting
Fix for IE11 in stripScript function
Fix for IE11 to use the new features in 5.6.0
Fix ungroup from column menu
Fix prevent XSS in search textbox when showQuery is on ,
Fix passing correct parameter in custom_value function in form editing ,

========================================

Version 5.6.0 (2021-11-03)¶

========================================

Additions and Updates¶

Add support for Bootstrap5
Add method excelLikeGrid to simulate editing and key navigation like Excel (see docs)
Add event onFrozenColumnsCall which is triggered every time the method setFrozenColumns is called
Adding new option in colModel labelClasses, which add custom classes to the labels in the grid.
Replace javascrip eval function in all jqGrid code
Improve ariaGrid and cellEdit to work better together
Remove deprecated :eq and :first from setRowData method and replace it with .eq()
Add customCellAction event in ariaGrid which raises when the user press key different from the predefined one up, down and etc.
Update package.json to include the repository
Add new common parameter frozenColCount to indicate the number of frozen columns when set
Add Support for cell editing when ariaGrid and excelLikeGrid method(s) are activated.
Add method getLastVisibleCol to get the index of last visible col
Method setCell now support frozen columns.
Method delRowData now support frozen columns
Method setRowData now support frozen columns
Add new method groupingInit, which set the grouping parameters to initial state.
Add In groupingRemove method second parameter, which if set to true destroy all the grouping data
Adding common function $.jgrid.isNull

Bug Fixes¶

Fix misalignment of columns when frozen columns and grouped headers
Fix frozen columns in case scrollOffset will be set manually
Fix for multiselect plugin remove all button, to work correct after the second click
Fix adding classes property to the invisible first row in the grid - class=firstrow.
Fix set predefined custom style in export to excel.
Fix in addRowData method when no not rows in the grid.
Fix resizeGrid method when grid height is set to auto
Fix hide no records row when emptyRecordRow is false
Fix scrollbar in case no data and resizeGrid is called
Fix saveRow to pass correct parameter in custom formatter when edit type is select
Fix position of alert box in form edit in case the grid has height auto or 100%
Fix refershFilterToolbar method to take in account the index from colModel
Fix - do not create frozen divs and multiple calls of frozen columns without to destroy it first
Fix setLabel method to work correct when column menu is enabled
Fix colMenuBeforeProcess to be called in customMenu actions
Fix for sortable (remapColumns method) to correct reorder grouping cells, when grouping is activated.

========================================

Version 5.5.5 (2021-05-17)¶

========================================

Additions and Updates¶

method GetFont now return more parameters to calculate precisely the width in canvas
optimize intNum function and add new floatNum function for more compact calculations
Add new colModel option autosize_headers - if set to true it will include the headers cells when calculation max width for auto re-sizing feature
Add close button to search dialog in column menu
Add aria-label=Close to elements without text which close the dialog s
Add P option to date formatting . See https://www.php.net/manual/en/datetime.format.php
Rename build.gradle to build_gradle
Code and speed optimizations in filterToolbar method
mergeSearch options is added in colMenu searching
Add possibility to search in filter toolbar splitting the word separated with option splitSearchSeparator which produce or logic. By example entering a;b in search field will produce field == a or field == b
Add grid option emptyRecordRow which enables or disables the No records to view row. Default is true.
Add new parameter in dragEnd function to disable calling recreation of frozenColumns
Add new common function - getElemByAttrVal to get element by attribute value from array of objects element
Add new parameter in resizeColumn method to not recreate forzenColumns.
Add possibility to use a predefined excel formatters again with possibility to format the excel value as true text - set exportoption excel_type ='text' . See: https://github.com/tonytomov/jqGrid/issues/984
Add new utility function isJSON to check if the given value is (valid) JSON object.
Changing parameter name in getGridParam which conflicts in some frameworks: https://github.com/tonytomov/jqGrid/issues/986
Add a utility function dateToOADate to convert an ECMAScript Date to a Microsoft OADate. Used for export to excel for better date formatting.

Bug Fixes¶

Fix column name parameter in colMenuBeforeProcess when freeze
Fix disable sortable columns with mouse on frozen columns.
Fix for parameter disabledKeys in fillterToolbar method in order to prevent error in save/load-Sates methods.
Fix for key-press in fillterToolbar when grid is restored from loadState
Fix column grouping in state restoring loadState
Fix column menu searching when reset is pushed and data is local with grouping
Revert back the changes in setCell and setRowData methods so that we do not change the existing cell properties.
Fix forzen column when re-sizing and calling it correct when rebuilding.
Fix filterToolbar to restore correct the search in loadState when mergeSearch is on
Fix for filterRefactor function to find correct the included fields
Fix the No records to view row to be not editable.
Fix css presentation of custom element in filter Toolbar. Fix executing search on custom element in filterToolbar
Fix auto re-sizing no to recreate frozenColumns on every column
Fix toolbar search to keep the search values on frozen columns
Fix showing sort icons on frozen columns
Fix bug in setLabel method
Fix for ie11 when using filterToolbar disabledKeys
Fix gridResize method to work with bootstrap.
Fix small problem in jquery ui resizable which should attach only one class with comma
Fix export to excel when formatter return &nbsp
Fix mergeSearch to work with single search in dialog searching (multipleSearch = false)
Fix local sorting to work with local special characters https://github.com/tonytomov/jqGrid/issues/982
Fix custom formatting in export to excel See: https://github.com/tonytomov/jqGrid/issues/983
Fix forzen columns vertical synchronization when a new column is set to frozen.

========================================

Version 5.5.4 (2021-02-16)¶

========================================

Additions and Updates¶

Add new feature combined search - to combine search results in different searching modules. Added two new parameters - mergeSearch (boolen) and searchModules (object). See searching in documentation.
Add two parameters to resizeGrid to enable responsibility on width and/or height
$.jgrid.parseDate now can be used without to be applied to a grid object. Added new option parameter for validation
Add colModel sizingStringFunc which is a user defined function to calculate the max width of column value. Parameters to it are cell value, font, options and row data object. Should return the width of cell value.
Add grid event colMenuBeforeProcess to be executed before any action in any column menu defined. Parameters passed to it are module, action, and column name

Bug Fixes¶

Fix no records message in frozen columns
Fix group headers in case of autoresize is applied with double click
Fixes for position dialog s (edit, view, search) when rtl is on and recreateForm is false
Disable searching in filterToolbar when press special keys like alt, ctrl and etc. and autosearch is enabled.
Fix exports in grouping
Fix setGridWidth method when shrinkToFit parameter is set to false
Fix getCol and getRowData methods in case of no records message appear.
Replace the deprecated jQuery.isArray with Array.isArray
Replace deprecated jQuery.isFunction with $.jgrid.isFunction
Replace deprecated jQuery.type with $.jgrid.type
Replace deprecated jQuery :first with first()
Fix autoresizing when hidden columns are present.
Fix frozen columns in certain situation when the first columns are hidden
Fix icon position left in bootstrap4
Replace deprecated jQuery :eq with eq()
Replace deprecated jQuery :last with last()
Replace deprecated :gt with slice
Replace jQuery $.trim with $.jgrid.trim
Fix pager when RTL.
Fix transparency of header and footer rows in Boostrap4
Fix frozen columns in various situations

========================================

Version 5.5.2 (2021-01-06)¶

========================================

Additions and Updates¶

Add second parameter to setGridHeight so that we set the entry grid height. This is experimental.

Bug Fixes¶

Fix getDataIDs to not return "norecs" row
Fix "norecs" row in case when add row with addRowData.
Fix addRowdata when add elements at certain positions in data array and fix reindexing of elements.
Fine tune sort icons in bootstrap4
Fix multiselect plugin to work with jQuery 3.5.x
Fix pixel which causes scroll in Chrome in setGridWidth method when boostrap4
Fixes for multibox header for jquery-ui css
Fisxes for multisorting and sorting icons in Boostrap4
resizeGrid now resizes to the parent/window height
CSS Fixes for searchoperators in toolbar search
Fix for the headerrow column in Bootstrap4
Fixes for header row
Fix find correct search operator in case there is a custom search element.
Fixes for Frozen columns, stripped tables, group headers row hovering and row selecting in Bootstrap4
Fixes for calling isGrouHeaderOn in filtering and exporting
Fix icon position in navigator Bootstrap4 for fontAwesome
Fix groupingHeaders when they are removed. Fix setGridWidth to remove/set frozen columns when it is executed. Fix position of data div of the frozen columns. Fix hovering in bootstrap
Fix jquery UI css adding overflow hidden in navigator buttons with texts
Fix remove centering of label cells when grouping. Add overflow hidden to long texts in navigator buttons
Fix dirty-cell not being set and console error when saving using latest jQuery #972
Fixes for boostrap4 modal-content class
Fixed error "hasOwnProperty is not a function when saving data using jQuery 3.5.1
Fix dirty-cell not being set on cells changed inline
Fixing destroy group header function
Fix Bootstrap4 warning dialog display property
Fix grouping headers with frozen columns rebuilding.
Bootstarp4 css fixes for group headers and frozen columns
Fix hovering and highlighted selected row in Bootstrap 4 css
Fix losing focus when setGroupHeaders is call.
Fix sort icons in fontawesome and octicons css definition

========================================

Version 5.5.1 (2020-10-12)¶

========================================

Bug Fixes¶

Fix preserving original values in method getRowData when using indent
Fix reloading tree after search when treeModel is adjacency
Fix for xml data when reloading tree node
Fix formatting numbers in summary, header and footer data in excel export

========================================

Version 5.5.0 (2020-09-01)¶

========================================

Additions and Updates¶

Added is a informative row in case no records are in the grid. Uses emptyrecords property from language file. See https://github.com/tonytomov/jqGrid/issues/950
Disable freeze menu (in column menu) when subgrid, treegrid, celledit are on
Add forcePgButtons parameter to force creation of pager buttons in responsive mode.
Update Italian language file.
Support of select All option in colmenu columns option. New option in coloptions object in colModel - columns_selectAll - default false. See docs.
Add aria-sort attribute to support section 508 when sorting a column
Add options sortTreeByNodeType (false/true) default false, sortTreeNodeOrder (asc/desc) to sort the tree by node type. I.e first node with children and then leafs or vice verso.
Add option FullTreeSearchResult (false/true) default false to show the full tree node on found item in tree.
In case of grouping headers set the columns to contain the parent and child names in searching dialog.
Add support for hyperlinks in excel export
Disable sorting in column Menu when sortable options in colModel is false and enable sorting only when this option and sorting option in colmenuoptions is true
Add option navigationDisabled to disable navigation dynamically in aria module.
Add Support new line in textarea in cell editing when alt + Enter is used in order to prevent saving data.
Add new option in getRowData method to indent the expandColumn in case of treeGrid. Default is false.
Add new option in all export modules treeindent to indent the expandcolumn when treegrid is exporting.
Add options includeHeader in all export modules (exportToCsv, exportToPdf, ....) in order to support header row option when set. Default is true.
Add method maxGridHeight to set and remove maximum height of entire grid
Add option viewselected in viewGridRow method. If multiselect is true and this option is true viewing is enabled only to the selected grid rows in view grid mode.

Bug Fixes¶

Fix local sorting in case date srcformat = newformat.
Fix clearsearch values in filterToolbar
Fix border-bottom in case of searchtoolbar and jQuery UI css
Fix horizontal scroll bar in case shrinkToFit is set to false and no records are available.
Fix pager in case it contain special characters. See https://stackoverflow.com/questions/57792149/jqgrid-pager-doesnt-display-when-its-id-has-special-characters
Fix centering subgrid icon.
Fix for the subgrid icon in Chrome
Fix calculating autosize when Bootstrap is used
Fix position of column menu when used jQuery > 3.x. See https://github.com/tonytomov/jqGrid/issues/951
Fix export modules to read correct complex data structures in data
Fix sorting a tree after search
Fix setCell and setRowData methods to use the cellattr event in case of updating data. See: https://github.com/tonytomov/jqGrid/issues/953
Fix editing module to use cellattr correct having all the needed data. See https://github.com/tonytomov/jqGrid/issues/953#issuecomment-554935412
Fix formatting numbers in footer when colTotals is on in pivot grid https://github.com/tonytomov/jqGrid/issues/952
Fix edit forms when jQuery UI CSS is used again with installed latest Bootstrap.
Removing not needed css property zoom from bootstrap
Fix hideCol/showCol to work correct with groupHeader
Fix (Rework) setSortIcon method to better display left sorting icons
Fix treeGrid to work correctly with local data
Fix add serializeRowData in inline edit when clientArray is set as url
Fix grid.utils.js module only to be run correct with jQuery.
Fix delete norecs row in loadState after first initialization. This will be added correctly after calling updatepager
Fix edit null line in inline edit. See https://github.com/tonytomov/jqGrid/issues/954
Fix position of column menu when grid inside within element with left property
Fix alert dialog position in navigator when grid is in bottom of the page in the scrolling window.
Fix frozen columns (outherheight on row) to be compatible with jquery 3.x
Fix sending correct sortnames and order to server when sorting and grouping is on and no sortname is set
Fix grouping headers when it is set and autoresize is on
Fix in all export methods to correctly export a treegrid.
Fix getRowData, setRowData, editRow, saveRow and restoreRow to work correct only with single level down the DOM tree of table cell not including elements of other (sub)grids in the cell See https://github.com/tonytomov/jqGrid/issues/969

Version 5.4.0 (2019-06-29)¶

Additions and Updates¶

Add new module grid.aria.js to support section 508. See docs for details. Demo
Add automatic and custom auto-re sizing of columns on data loading. Two new options autoResizing in grid option and autosize in colModel. Demo
Add a custom defined search filter see grid option customFilterDef. Demo
Add custom excel formatting with introduction a new option in colModel exportoptions. Demo
Add parameter loadIndicator in all export modules (pdf, csv, excel, html). Can be a function or Boolean. Demo
Add support for in and not in operands when searching local data. Demo
Add support for frozen row at header - option headerrow (similat to footerrow ). Demo
Add method headerData and support of userDataOnHeader for the frozen header row
Add method autoSelect similar to Excel auto filter for search type select. Works only on local data and toolbar filtering. Demo
Remove not used parameter in scrollGrid internal function
Remove currentview parameter from getRootNodes and getNodeChildren since the view and the data are the same in treeGrid
Add onBeforeExport event in exportToCsv method
Extend options parameter in createEl function with property module for determining from which editing module is called. The new parameter is module with the following possible values : cell, form, inline
Add option decodeValue in formatter select in order to decode value in case it is encoded. This fix a selection of displayed value.
Making the pager buttons and info responsive.

Bug Fixes¶

Fix scroll in Chrome when height auto or 100% when Bootstrap
Fix delRowData in multi-select mode when the parameter is integer. See https://github.com/tonytomov/jqGrid/issues/935
Fix for local search comparison of numeric values in case a non-numeric is entered
Do not remove the ids of edited rows when reset the selection
Fix option scrollOffset when rtl is set
Fix method setGridWidth in case of multiple headers
Fix method setGridWidth in case grouping headers is on and there is a horizontal scroll.
Fix column menu position in case when group header is set
Fix form edit option checkonUpdate in case edittype is select with dataUrl is used
Fix for numbers with length > 15 in the in excel export method exportToExcel in the new parsers.
Fix multiple search in case of jQuery 3.x
Fix formatter select to set correct all attributes in case no value option is set
Six treeGrid functions which add/edit/delete data to be compatible with idPrefix option
Fix getRowData method to take idPrefix in account when parameter usedata is on
Add BOM to fix excel bug when exporting to csv and the charset is utf-8
Fix clear search value in toolbar filtering when column reordering is enabled.
Fix exporting integer 0 in excel export.
Fix export to excel in case a number is detected (prevent double value creating in case of multiple parser which meet the condition)
Header and Footer user data should be not formatted (userDataOnFooter, userDataOnHeader) when placed in grid. They should npot use the formatter for that column

Version 5.3.2 (2018-10-15)¶

Additions and Updates¶

Added option preserveSelection which allow to preserve selected rows in multiselect mode.
Support for searchOperators im refreshToolBar method
Add option editNextRowCell to continued editing of cells when Tab/shift Tab is pressed and the end of row is reached. The option works only when cell editing is enabled.
Add tooltip property in colModel to set different title in headers. See: https://github.com/tonytomov/jqGrid/issues/909
Add second parameter rowPos (last inserted row index) in onBeforeExport event in exportToExcel method
Selection preserver (scroll 1 or true) works now in multiselect mode
Add onInitPivot and onCompletePivot events to indicate the start and end process of building the pivot.
Added option loadMsg in pivot options parameters which enables a loading message during pivot build. Default is true

Bug Fixes¶

Fix rounding numbers in certain situations. See https://github.com/tonytomov/jqGrid/issues/905
Fix cellattr event to omit strings which contain style word
Fix subgrid option expandOnLoad when multiselect and/or rownumbers true. See https://github.com/tonytomov/jqGrid/issues/892
Fix position of multiselect box on bootstrap 4
Fix border of toppager (when enabled) when bootstrap 4
Fix positioning of column menu.
Fix conversion the value to number in case a octal values is present in search toolbar
Fix exporting hidden columns in all export modules. We set a property exportcol which will then overwrite dynamically set hidden column
Fix setGridWidth method in case grid overflow-y is set to scroll.
Fix bindKey method to select a row only if it is jqgrid row and when there is a id.
Fix multiselect in toolbar search filtering
Fix position of column menu according to the new changes connected with the styling. See here: https://github.com/tonytomov/jqGrid/issues/913
Fix subgrid to read correct data using getAccessor in case mapping is set in subGridModel and there is a complex data
Fix bindKey to prevent focus in inputs in case of inline edit is activated.
Fix passing the right parameter to reader function in JSONReder in order to overcome wrong detecting of keyName. See: https://github.com/tonytomov/jqGrid/issues/918
Fix resetting the selected row(s) in selection preserver to keep the selection active over all the scroll time
Fix bootstrap pixel problem in case height is set to auto or 100%
Prevent bad position of column menu when it is activated and user scroll horizontally https://github.com/tonytomov/jqGrid/issues/920

Version 5.3.1 (2018-03-12)¶

Additions and Updates¶

Bootstrap 4 improvements
Support for Font Awesome when Bootstrap 4
Add new option useNameForSearch to search by name on local data and not on index when set.

Bug Fixes¶

Do not include subgrid and other internal columns in addlocaldata for manipulating
Removing badly added grouping == true when set frozen columns.
Fix in addXmlData to add empty string in case CDATA (when set) does not contain data.
Fix grouping when grouSummaryPos = header and there are hidden fields at beginning of colModel. Small optimization in buildSummaryTd.
Fix excluding subgrid column in exportToHtml
Fix exportToHtml to get the labels of header from colNames
Fix apperaing print preview dialog in Chrome (method exportToHtml)
Fix Drag and drop rows (gridDnD method) when drop by name is false.
Fix loadState method when a subgrid has open subgrids as grids
Fix all exporting methods when grouping is enabled
Fix vertical scroolbar for bootstrap 4
Fix setAttributes function in CreateEl to be called as last one when a editable element is created, so that the developer can overwrite the defaults.
Fix subgrid with parent as altRows set for Bootstrap 4

Version 5.3.0 (2018-01-04)¶

Additions and Updates¶

Add Support for Bootstrap 4. Demo
Support validation in filterToolbar via searchrules
Adding parameter errorcheck to enable/disable the validation of the search inputs in the toolbar searching
Update Stronger check for number in case of strict mode prevent entering a octal values
Adding jqGridInitGrid triggered event, which can replace initGrid event
Add exportToHtml method with ability to print. Demo
Extend excel export to recognize more numeric types. Support for ISO date only at the moment
Add 3 parameter returnobject in getCell method which set to true return the cell as jQuery object
Add menubar on caption layer. Added new option menubar which place a icon on left (or right) and the user can add actions. Added two new methods for this purpose menubarAdd and menubarDelete to add and delete items. Demo
Added new options in colModel - minResizeWidth, which defines minimal re-sizing width per column. When set this option have higher priority of minColWidth
Add possibility to define user defined buttons in editGridRow, delGridRow and viewGridRow forms. Demo
Add $.jgrid.buildButtons function in common module to return a string with a buttons defined in buttons array in the different modules.
Add support for html5 in form edit Demo
Add a treeGrid paging based on the code of Vyacheslav N. Boyko See here. For more information documentation information. Demo
Add buttons array in order allow to add custom buttons in the searchGrid form. The button item object contain the following properties - side, position, text, icon, click, id. To the click function is passed the search form, search parameters and click event. See here. Demo
Remove z-index from jqgrid-overlay class and add jqgrid-overlay-modal class to serve separate modals.
Add possibility to create the search dialog as first child of body setting the layer option to true.
Add event colMenuColumnDone as grid options which executes on reordering of the columns when colMenu columns options is on - the event is similar to in columnChooser.
Adding onEnter and onEscape events in editRow in order to get possibility for custom save cancel code - by example pop-up to ask for saving and etc. Demo
Enlarge mousedown area in jqModal in case some other components like datepicker are outside the modal dialog. Added two new parameters heightOffset and widthOffset.
In inline saveRow method the deletion of the saved row is moved after aftersavefunc so that this row can be available for comparing
In method gridDnD droppable now applied to table's closest ui-jqgrid-bdiv for greater drop area Added "tolerance" setting to default drop_opts
Add parameter previous selected rowid in bindkeys onUpKey and onDownKey events
Add onUpKey and onDownKey check events in bindKeys method. Also to all events is added second parameter the event
Add custom column menu. This is done via the two new methods colMenuAdd to add a new column menu and colMenuDelete to delete it. More can be found in the [methods list]..//user-guide/basic-grid.md#method-list) Demo
Add two additional parameters to summaryTpl in colModel for grouping - the name of the summary field and the value of the summary field - respectively the can be added as {2} and {3} in the template Demo
Added isExported and exporttype in the formatter options in colModel when export to pdf, csv or excel occur. This allow to conditionally format the value depending if it is exported. Demo
Update Spain translation
Return empty pivot grid when no data, rather than to expose a exception
Update Portuguese translation

Bug Fixes¶

Fix for saveState not to save the data when saveData is on and datatype is local.
Fix creating the ids of the grid with the build in generator randId in case local data and scroll is on (virtual scrolling)
Fix building the id row when a add operation in method editGridRow. The comparing of the empty row missed the idPreffix
Fix column menu in case the searchbox and cols menu are outside the view port
Fix setCell to get right row unformatted data. If the datatype is local no unformat function is needed
Fix setCell to find the right cell in case the cell contain another table data.
Fix correct dropping row in gridDnD when both grids have equal colModel's and dropbyname parameter is false
Fix exportcol property in exportToCsv, exportToExcel, exportToPdf methods when hidden is false, but exportcol is true
Fix exportToCsv, exportToExcel, exportToPdf methods to export all the data when datatype is local
Fix for csv export summary data to skip not exported column. Fix export to excel to skip the same column
Fix typo "inine-block" in ui.jqgrid.css
Fix exportTo excel to interpret virtual values not as part of the data array
Fix remove not needed comma from jqGridFilter parameters
Fix grid width in bootstrap in different situations when shrinkToFit changes. Calculation of width methods is now synchronized. Fixed small issues when autowidth is on and responsive is on too
Fix add missed parameter in editCell - the event, which is used in onCellSelect
Fix previous navigator button in viewGridRow method to work correct. See
Fix for minColWidth
Fix Albanian translation to get the right two code See
Fix checkOnUpdate in Chrome [See] (https://github.com/tonytomov/jqGrid/issues/881)
Fix when subgrid and grouping are on again with loadonce true thanks to preethi koochana
Fix jqFilter getParameter method.
Fix loadui grid parameter when set to block
Create separate modal overlay in viewMoodal and hide it in hideModal. Fix viewModal to get the overlay class depending on style.
Fix for viewModal parameters when called in searchGrid method. The id of entire grid box was wrong set
Fix height of the frozen div.
Fix inconsistent state if saveAfterSelect is true but method saveRow fails
Fix when styleUI is Bootstrap and altRows is on
Fix typo when calling onCellSelect grid event
Fix removing not needed href='#/' when build column menu
Fix bindKeys method to work when grid drag and drop method gridDnD method is activated
Fix exportToExcel when the number length is > 15 (know problem in Microsoft Excel)
Fix resting grouping values when clearGroupData is called
Fix determine the vertical scroll-bar dynamically and fix the issue when Bootstrap in Windows
Fix for showSummaryOnHide when grouping is enabled
Fix in JSON.parse in utility module to parse correct all cases when function is available.
Fix multisorting issues.
Fix bug with big select element in modal dialog
Fix celledit to support subgrid and any additional rows content added during editing
Fix width of column when exportToExcel and the data is number.

Version 5.2.1 (2017-05-01)¶

Additions and Updates¶

Add a showSaveCancelButtons() method in inline editiong to enable save and cancel buttons
Add saveData parameter in saveState method, which enables/disables saving the data. Default true.
Add restoreData option in loadState method which enables/disables restoring the saved data state. Default true.
Removed a grid option altclass. Added definition for striped table in the styleUI object. The striped table is now build (option altRows : true) only when add a class to the main table. This add a speed improvements when loading the data. Removed the not needed code in delRowData and addRowdata
Add onBeforeExport event in exportToExcel method
Add parameter forceresize to resizeColumn methods
Added triggred event jqGridBeforeProcessing which is equivalent of beforeProcessing
Add triggered events jqGridLoadError = loadError and jqGridLoadBeforeSend = loadBeforeSend
Add triggered event jqGridPaging = onPaging
Remove global object jqGridUtils and add all the functions in $.jgrid object removing a need to have two global jqGrid objects.
Exclude more attributes not needed to be add in input element in createEl function
Add triggered event jqGridErrorCell = errorCell in cell editing
Add new property in colModel exportcol which enables disables the export in the methods exportToPdf and ExportToExcel exportToCsv.
Add saveui and savetext parameters to the editRow method
Added missed triggered events in viewGridRow method see documentation
Adding missed triggred evenents in delGridRow see documentation
Added replaceStr event in exportToExcel parameters in order to control the formatting of the exported text.
Add onSubmitCell event in cell edit
Removing not used option delayOnLoad in subgrid
Adding the missing triggered events in treeGrid
Adding option multimail
Adding count parameter to summaryTpl -> {1}
Add option scrollMaxBuffer to prevent memory problems when using virtual scrolling in local mode using the mouse wheel

Bug Fixes¶

Fix: small fixes according to eslint
Fix: comparing with equal data types in getNodeParent
Selector fixes the addJSONData and addXMLData
Fix: Support autoencode grid option to prevent XSS in jqFilter
Fix restoreRow to restore all the data saved into the savedRow array and not only the editable. This fixes calling of depended formatter custom function. See here
Fix: Unreadable content in MS Excel when open the generated excel file generated with exportToExcel method`
Fix: saveAs function in exportToExcel to work correct in IE11 (Access denied error fix)
Fix: set search option to false when we reset the seasrch in column menu
Fix: fixes in normalizeData function to read correct the unique name.
Fix setFrozenColumns when box-sizing=border-box is used.
Fix: add beforeProcessing event to every datatype.
Small fix in beforeRequest event. The triggered event and option event should be one after other.
Fix according to the documentation if datatype is function beforeRequest does not fire
Fix: More strict check in setColProp for the type object
Fix jqgroup class to have same height as jqgrow class.
Fix calling custom_element in search modules with the right html element.
Fix delGridRow view modal dialogue in case first time beforeInitData return false.
Fix: remove the parameter searchurl in filterToolbar it is never used
Fix: get correct label from colNames instead of colModel.label in buildColMenu
Fix: When exporting we should use the colNames and not colModel.label
Fix remove bad set counter for service fields: row numbers and multiselect.
Fix frozen columns when zooming.
Fix calling triggered event jqGridAddEditAfterComplete in editGridRow.
Fix add missed parameter postdata in jqGridAddEditBeforeCheckValues
Fix setGroupHeader method in case it is called 2 or more times with colspan : true
Fix export to excel allowing quotes in the values.
Fix Bootstrap css dispearing icons
Fix: colmenu search options operands replaced with groupOps common to all search modules
Fix columnChooser - setting height causes selection list not to overflow correct.
Fix sortable columns to perform sort when the column is sorted to its original position
Fix reading data in case key colModel option is set and repeatitems in jsonReader is true.
Fix passing parameters in editRow
Fix stop function in sortablColumns method to be executed within delay
Fix deselectAfterSort to not highlight the remaining rows
Fix exportToExcel method to order properly the columns. The bug originally come for the reason that object properties are ordered and do not follow natural insert order
Fix exportToPdf to order correctly the columns in case some of them have a number as name
Fix exportToCsv to order correct column names in header when they are numbers.
Fix timeoffset in parseDate function.
Fix it is possible to search when select has a multiple property in dialogue search
Fix toggleToolbar method when frozenColumns are set
Fix filterInput to use ! correct

Version 5.2.0 (2016-11-21)¶

Additions and Updates¶

Support to jQuery 3.x
Added a export to CSV, Excel (open excel format) and pdf. For excel we need additionally jsZip and for pdf pdfMake libs.
Add saveAs function in util module, which do a browser save dialog for saving diffrent data type.
Update Portugase translation file grid.locale-pt.js
Add a new event – validationCell which may occur (if defined) when a validation error. Parameters – element, error message, iRow and iCol. When restoreCellonFail is set to false now we focus the cell when info dialog is closed
Added method setSortIcon. the method changes the position of the sort icon at left or right. The first parameter is the column name or the position of the column in colModel starting from zero. The second parameter is left or right(or empty or nothing).
Update of lang files for the serch dilogs
Update for the language spanish file.
Update of Bulgarian, German and Russian language files according to the new search text
Adding validationCell event custom message in inline edit. Parameters passed to this are the element, error message, row index and column index.
Update Chinese Translate for v5.1.1
Adding custom aggregate function in pivot grid. In the aggregates array the aggregator now can be a function.
Parameters passed to this function are: value, field name, data record
Making possible to run addLocalData as grid method. Added a parameter(boolean) which set if we need all the data (and not paged one)

Bug Fixes¶

Fixes in import module.
Fix cc variable in cell edit to be a jQuery object causing error. See https://github.com/tonytomov/jqGrid/issues/812
Fix pivot in case yDimension is not set
Fix getRowData when the second paraneter is not set
More tolerante checking of isEmpty function in formedit validations
Fix for beforedrop event in the gridDnD method.
Fix for avg function in pivot
Fix: Data in pivot should be array.
Fix cacheUrl to accept empty values in case in case they are defined in option value.
Fix getting the cell data in cell edit mode
Fix: Added missed translation text in serach dialogs for the button rules.
Fix get cell to return the right content of the ExpandColumn field when treeGrid is on
Fix for Bootstrap horizontall scroll bar when height auto/100%
Fixed misspelling of “inline-block”
Fix info dilog when error from the server – position the dialog ner to the cell and focus a field if restoronCellFail is false
Try to focus the field in inline edit when a validation error occur
Fix finding the position of the objec. We need the cuurent position of the screen.
Fix pivot initial sorting when set in grid options as sortname
Fix pager info for loaded records when adding new one and virtual scroll is enabled.
Formatting changes
Fix adding non empty id in editGridRow (fix is for treegrid)
Fix German locale toolbar search options

Version 5.1.1 (2016-06-08)¶

Additions and Updates¶

SetLabel method accept now column name or index of the coulmn.
Remove the local _savedData parameter from editRow and replace it with the global savedData (like savedRow) which now part of Grid parameter for easy access
Add support in loadState for Subgrid
Add support in loadState for Tree Grid
getFormData have the same ruled obtaining the values as in createData and syncSavedData
Update French localization
Added beforeSetTreeNode and afterSetTreeNode events (grid parameters) in setTreeNode method
Added method setLeaf, which visually change the icons and data (isLeaf) parameter
reloadNode method now support updating the current node Leaf status depending if there is a data or not
Added debug option in saveState method to generate dump grid file with options and data (very useful for test and support).
Added option editselected (default false) in form edit module which allow to edit only the selected rows in multi select mode
Set $.jgrid.useJSON by default true
In custom sort function we add the full sort objects as 4 and 5 parameter in order to overcome some Chrome unexpected sort behavior
Add parameter saveAfterSelect (default false) in inline navigator (inlineNav) to save the row if another is selected
RTL support for column menu. The column menu is positioned near to column icon

Bug Fixes¶

Fix for search operators and search oper menu
Fix checking compareData function to work properly when checkOnUpdate and/or checkOnSubmit is on
Fix saveSatate to export correct the data
Fix savedData array in form editing to have fields only if they are found in template
Fix the position of column menu with actions
Fix column menu sort to work with multisort
Fix for inline saveRow method to show the validation UI dialog.
Fix for info_dialog syling
Fix using checkOnUpdate with dataUrl in edit options.
Fix binding click events in treeGrid after loadState is called. The _index should be refreshed in order to get right positions
Removing not needed code in grouping
Fixes in getRowData
Fix jqGridExport not to delete the additional tree Columns
Fix toppager css
Fix for frozen Columns in IE11
Fix check in our json parse function
Fix for right border when bootstrap is used with alternate row collor
Fix for loadState to check selected checkboxes of selected rows when multiselect is set
Fix for cbox class to not be added two times
Fix for bootstrap border problems in different grid elements
Fix prevent click for the disabled check boxes in multiselect mode in IE browsers
Fix jumping to the top of page when a colmenu is clicked
Fix multiselect when a checkbox is checked
Fix setFrozenColumns heigh inconsitencies when the height is not default and/or a rowspan is used
Fix detecting MS IE <=11. Note that MS Edge is not IE browser
Fix uniqueSearchFields in filter string
Fix for RTL scrollbar
Bootstrap CSS fix for RTL
Fix semicolon in base module.
Fix inlineNav when beforeAddRow and beforeEditRow return false not to show the save cancel buttons in inline navigator

Version 5.1.0 (2016-03-03)¶

Additions and Updates¶

Add new event parameter in filterToolbar method – onClearSearchValue and corresponding jqGridToolbarClearVal. To this event are passed the following parameters: html element, column index, searchoptions, default value
Added a options between. The option is valid only in filterToolbar method. To use this feature the values in search field should be separated with “…”. Example – to parse values between 1 and 10 the following should be entered: 1…10 in the search field. Click for demo here
Added a possibility to use multi select in toolbar searching. Any multiselect plugin can be used.For this purpose a new parameter is added in filterToolbar method – groupOpSelect to determine the group operand when multi select is on Can be AND or OR. Default is AND. Click for demo here
Update Japanese translation
Added new method refreshFilterToolbar This method only refresh the toolbar filter and does not use reload to reload data. It loads the values from filters parameter in postData
Updated Italian translation
Added option uniqueSearchFields (boolean – default false) in jqFilter respectively in searchGrid methods form searching which allow the searched field to appear only once in the search list. Click for demo here
Added search option searchOperMenu in colModel searchoptions property (valid only in filterToolbar method) which enable/disable the search operators menu for particular field in colModel. The option work with global searchOperator option
Added event isHasSubGrid in grid parameters. To the event is passed the row id. If defined it is executed on every row before the subgrid is build. If the event return false the subgrid for that row is not builded. The plus icon disappear. Click for demo here
searchTree method now return only the result founds with its parents. Click for demo here.
Added sortable plugin not depended on jQuery UI lib.
Added grid option colMenu which if set to true will enable column menus on every grid colum header with different actions. Added visual representation of colMenu for Bootstrap and jQuery UI. Added option colmenu in colModel to enable/disable the menu for particular column. The following actions are present in the menu – sorting, filtering, grouping, freeze, show/hide reorder columns. Click for demo here
Add event parameter beforeExport in excelExport method to modify/add parameters in the export url.
Added options exporthidden and exportgrouping in excelExport (default false) for exporting colModel hidden property and grouping options. Useful in server side exporting like PHP ASP and etc
Add parameter reverse in getNodeAncestor method which if set to true will return the nodes in natural order – i.e first root , then first child and etc
Add parameter expanded in getNodeAncestor method which if set to true will return the nodes with expanded property set to true
Added simple filterInput method which allow with single value to filter on all fields in the grid. Works only when datatype is local. Click for demo here
Added new parameter in getNodeChildren method – currentview to get (walk) nodes from current view or whole local data

Bug Fixes¶

Fix padding in toolbar search inputs
More precise calculation of totaltime – time to put the data in grid
Fix sort and search in treegrid.

Version 5.0.2 (2016-01-18)¶

Additions and Changes¶

Support for jQuery versions 1.12.0 and 2.2.0
Add support for nullifempty in celledit.
Adding name parameter (cell which is changed) to the serializeCellData in editCell method.
Added license property in bower.json
Add support for radio buttons in GetFormData. This allow custom radio button elements to be parsed correct.
Added syncSavedDataFunction in form editing module.The purpose for this function is to synchronize the custom added elements with class .customelement, so that checkOnUpdate will work corrcet. Usefull for custom templates in the form.
Add possibility to define custom formatDisplayField in grouping in case hideFirstGroupColl is set to true.
Added Albanian translation

Bug Fixes¶

Fix selecting row when cellEdit parameter is set to true
Fix in CSS input width elements in filterToolbar
Fix filterToolbar to allow using of dataEvents. Thanks to Manuel - See: https://github.com/tonytomov/jqGrid/issues/727
Fixes for pivot grid
Fix in CSS wrapping texts in IE 11
Fix in CSS subgrid row data border
Fix Equality set of width in dragEnd and setGroudHeaders. Thanks to iguana3
Fix for checkonUpdate checkOnSubmit

Version 5.0.1 (2015-10-19)¶

Additions and Changes¶

Updates in Bulgarian, German Russian and Italian language files
Additions in setRegional method in order to load big data.
Add restoreFromFilters parameter in toolbarSearch method to restore the state after searching and when save/load state is used
Adding keyevent parameter in editRow method (inline edit) to define a desired key event. Default ‘keydown’. When used with boostrap typeahead use ‘keyup’ value of place of keydown.
Added sortname and sortorder in xDimension, so that grouping can be controlled.
Aded ignoreCase in pivot options in case this is needed in some special situations
Adding afterSetGrid event parameter in loadGridState to do some thing after the grid is loaded in searching and save/load state is used.
Added a common function $.jgrid.isGridInStorage
Added restoreCellonFail which determine if the cell should be set or restored on fail. Default true
Update Spanish Translation
Pivot avg fact added
Experimental: Position the validation error dialog next to the cell input element in cell edit

Bug Fixes¶

Fix bootstrap theme to use table condesed in pager
Removing bad added comments in grid CSS
Fix rowTotals in PivotGrid
Fix restore the state of the grid when a custom buttons are added with navButtonAdd, navSeparatorAdd
Fix loadState method to restore the search strings in filterToolbar
Fix for jqDrag which jumps the window to a default position after draging. Now we use a tinyDragable plugin by Simon Steinberger
Fix Including frozenColumns in the restoring the grid state
Fix local sorting and multisorting to work correct with the indexes when datatype is local
Fix bug in navgrid wheh responsive parameter is not set and width does not match.
Fixes for navigator drop down menu – stopPropagation and click the right menu button in case of more than one grid in page
Grid should be unloaded in loadState method only when all conditions are meet
Fix language text (in language files) to be set correct in navButton menu
Prevent navgrid to be loaded when storeNavOptions is true, but navigator is not initially run
delRowData should reset the select row only if it is equal to the rowid parameter
Fix for columnChooser when show/hide selected columns. We need to use .is(”:selected”)
Fix reference to table body in addXMLData.
Replace indexOf with $.inArray (IE8 fix)

Version 5.0.0 (2015-08-03)¶

Common features¶

Native Boostrap Support

As of version 5.0 Guriddo jqGrid can be adapted easy with any CSS framework. We have develoed a Bootstrap port. To use the feature you will need only to include the appropriate CSS

...
<link rel="stylesheet" type="text/css" media="screen" href="path_to_css_files/ui.jqgrid-bootstrap.css" />
...

file and tell jqGrid to use Bootstrap – with the option:

$("#grid").jqGrid( {
   ...
   styleUI : "Bootstrap",
   ...
});

Except Column Chooser and re sizing the grid with a mouse we support all the jqGrid existing features.

You can enjoy the Guriddo jqGrid Bootstrap Demo

Independent CSS Styling

We have changed our code so that jqGrid can be developed with any CSS framework. This can be achieved with a setting of the styleUI object to use the appropriate classes. The full description will be added into the documentation.

Responsive Grid
We have added a responsive options which make the grid a really responsive.
With this options the grid is re sized automatically when the device is rotated and the windows width is changed. Another useful feature is auto calculating the the space of the navGrid buttons – if the space does not fith the grid width we create a drop dawn menu button where all actions are inserted.

TreeGrid

We added new events and a method called reloadNode. With this method is possible to reload only certain node data and put it into the treeGrid instead of reloading the entrie treeGrid which in some situations consume a lot of time.

The code below reloaded only the added or edited node (Form editing module)

...
var reloadnode = function (rowid, rowdata, rowobject)
{
   var id = $("#tree").jqGrid('getGridParam','selrow');
   if(id) { // if add a root do not reload
        var record = $("#tree").jqGrid('getLocalRow',id);
        $("#tree").jqGrid('reloadNode', record);
   }
}

$("#grid").jqGrid("navGrid",
   {...},
   { "afterComplete" : reloadnode,  "reloadAfterSubmit" : false, "closeAfterSubmit" :true}, //add
   { "afterComplete" : reloadnode,  "reloadAfterSubmit" : false, "closeAfterSubmit" :true}, //edit
...
);

PivotGrid
Fixed a lot of Bugs related to showing the labels and groupig.

Below is a full list of changes

Additions and changes¶

Add native bootstrap support.
Added styleUI object class definition this way it is possible to impelemet jqGrid in any CSS framework
Added option responsive where the grid automatically make some calculations
Change keydown with keyup in inline edit when analyzing the enter key (This is a fix for Boostrap typeahead plugin)
Adding the Reload node method in treeGrid - …jqGrid(“reloadNode”, record);
It is possible now to define all input types according to the html5
Add focusField in form editing
Changes in the css to fix and add new settings
multisort option now support order of clicking.
Support of mousewheel on frozen columns
Add resizeColumn method + small fix in dragMove
Adding events when expanding/collapsing rows/nodes in treeGrid. the events are as follow:
beforeExpandTreeGridRow(rowid, record, childern);
afterExpandTreeGridRow(rowid, record, childern);
beforeCollapseTreeGridRow(rowid, record, childern);
afterCollapseTreeGridRow(rowid, record, childern);
beforeExpandTreeGridNode( id, record )
afterExpandTreeGridNode( id, record )
Add event data population in dropdown - the name is jqGridAddEditAfterSelectUrlComplete
Upgrade to the latest multiselect jQuery UI plugin
Small speed optimization in addXMLData and addJSONData in case gridview is false.
Added onUnSelectRow which is called only in resetSelection
Added this in the onPaging in order to get the new value of the element before processing
Make sure loading message is always visible - thanks to: marek-saji - see: https://github.com/tonytomov/jqGrid/pull/514
Added new parameter className in groupingHeader to make a custom individual style of every group
Automatically detect language if the loaded language file is only one

Fixes¶

ts.firstElementChild.innerHTML causes more problems that advantages. So drop support of this instead of the speed.
Fix a case when a multiselect with multikey is set and checkbox is clicked only. It shouild be not changed in case the multikey is not pressed
Fix realoding a grid to certain page when a virtual scrolling is enabled.
Fix ruleMenu in filter toolbar if the parent grid element has zindex
Fix submit old input value after select field change in dialog filtering
Fix in addRowdata when altRows and position == last
Fix griResize in case of frozen columns
Fix calculating the width in pager
Fix for gridResize when caption is a vilable and button hide grid is clicked
Fix the columnChosser - we must pass the width instead of tblwidth.
Fix toppager count pager thanks to: windofny
Fix multiselect addAll
Fix rownumbers and check box columns to be set to frozen
Fixing dependecy in bower.json
Fix for frozen columns and multisort
Small fix in multi sort when data type is local
Remove moot version property from bower.json
Fixes for focusField.
Fix Ukraine language code file to be set as ISO 639-1
Small fix in class definition
Fix multiple select in case of add record in form edit.
Fix position of the select template in search dialog
Fix saving the group headers when we call it mopre than once
Fix Display correct the labels in pivot

Version 4.8.0 (2015-03-20)¶

Additions and Changes¶

Adding support for AMD. View demo
Adding support for AMD in language files.
Introducing templating in Form edit module. View Demo
Adding scrollPopUp to appear a popup with page information when virtual scrolling is on. Also added top offset to controll the appearing. View demo
Add a methods saveState which save the grid state when the option storeNavOptions is set to true in grid option. method uses localStorage. View demo
Add method loadState to restore the previous saved state with saveState.
Added searchTree grid when we have a local data. View Demo
Added a option cacheUrlData in colModel editoptions,which caches the data from dataUrl. This very usefull in search fileter and inline edit in order to prevent too much server calls. View demo
Added a new grid parameter – regional – two letter code which correspond to the code in grid.locale-xx.js. To load a language file different from English (default) in the grid this parameter should be set.
Added method setRegional to change the language on the fly. The method uses sessionStorage. View demo
Added ui.jqgrid-bootstrap.css as a separate css in order to have good grid in boostrap. View demo
tabletogrid() function is no more supported.The module is moved into the plugins directory
Added WCAG AA related ids and headers
Code optimization in editGridRow
IE versions <= 8 are no more supported.
Added parameter storeNavOptions to store the nav options in the grid options. The parameter is used in navGrid and if true the options are saved as grid parameters.
Adding UI classes to jQuery UI search dialog. Removing some css rules and adding new for the search filter dialog
Changes in GridUnload and GridDestroy. In previous case we never can destroy the grid object. The function are called different way – i.e they are a jgrid namespaced
Internal module changes and function move.
inlineNav can be called without to call first navGrid.
Added second parameter in getGridParam – module to query the certain module parameters.
Now it is possible to get the parameter of the navigator using jQuery data – …jqGrid(‘getGridParam’,name,’navGrid’);
Add ignoreCasde default to true.
Added a option in getFullTreeNode to expand the returned result
Addeed a option in getRootNodes to return the root nodes of the current grid data.
Added second param in getRowData – usedata. If set to true the current view is returned from data array (if any) and not from the html table
TreeGrid now support local data
Code optimizations in inlineNav when restoreAfterselect is true
Removing the non utf language files
Language file structure changes to support more lang at the same time and change it easy
Adding missed saving messages in language files
Drop the LGPL JsonXml.js from jqGrid and replace the code with our own. Created grid.utils.js
Moving jqGridImport to $.jgrid namespace
Add/remove classes ui-sg-collapsed/ui-sg-expanded in subgrid row to check if it is expanded or collapsed
Add class widget-content to pager select box
Add scrollLeftOffset to controll dynamically the appearance of the scroll dialog information
Changes in CSS to make the grid to look modern

Fixes¶

Fix for possible duplicated IDs in the search input boxes
Removed faulty role=”row” on pager
Removing duplicate code. Moving template in base grid deleting the format function and replace it with template
Small fixes and support for bootstrap via jQuery UI Bootstrap
Fix saving the data row in inline edit in case not a reloading is lunched.
Fix subGridBeforeExpand event should be executed independed of the reloadOnExpand option
Fixes for pager and toppager
Fix bug in searching when data is local and the field is defined as formatter data with srcformat and newformat.
Fixes in clearBeforeUnload.
Fix sortTreeGrid in case a local serch is performed.
Fixed collapsing of expandable row if this row is dragging in sortable table
Fix for beforeselectrow in inline navigator.
Fixes in addJSONData, addXmlData in IE when used firstChild
Fix in showFilter calling parameters
Fix “multiple:true” might work unexpectedly
Fix in case grouping and subgrid to not expand subgrid rows when they are not expanded
Fix loading the default lang according to the new lang changes

Upgrade¶

The ui.jqgrid.css file should be replaced with the last one.
Language files (grid.locale-xx.js) should be replaced with the last one. If this is not performed a error will appear and grid will not be build.
The method GridUnload – i.e $(“#grid”).jqGrid(‘GridUnload’) does not have effect.
Replace the old with the new one $.jgrid.gridUnload(‘#jqGridId’); where jqGridId is the id of the grid
The method GridDestroy – i.e $(“#grid”).jqGrid(‘GridDestroy’) does not have effect.
Replace the old with the new one $.jgrid.gridDestroy(‘#jqGridId’); where jqGridId is the id of the grid
The method jqGridImport – i.e $(“#grid”).jqGrid(‘jqGridImport’,options) does not have effect.
Replace the old with the new one $.jgrid.jqGridImport(‘#jqGridId’, options); where jqGridId is the id of the grid
The $.jgrid.defaults property is unchanged and it is possible to use $.extend($.jgrid.defaults, {…});

All other parameter from the language file should be changed this way:
Suppose the current language file is English, then extending the edit parameters should be replaced from

    $.extend($.jgrid.edit, {…});

    to

    $.extend($.jgrid.regional[‘en’].edit, {…});

The same apply for all other parameters in language file.
To load your own language file you will need to setup the regional parameter in the grid.
Let suppose that default language file should be grid.locale-cn.js, then in grid it is needed to do this:

    $("#jqGrid").jqGrid({
    ...
    regional : 'cn',
    ...
    });