API Reference (index)

This page used to be the whole API reference. It is an index now: every heading below still answers to the link it has always had, and points at the page that holds it.

To look something up by name, go to Options or Methods. To find the guide behind a feature, go to Features.


Constructor Options

Options


Data Source Interface

Data Source

fetchMeta

Data Source

fetchData

Data Source

fetchPage: single-callback alternative

Data Source

Local Array Data (data)

Data Source


Column Definition Reference

Options


Public Methods

Methods

refresh()

Methods

reloadData()

Methods

repaint()

Methods

scrollTo(rowIndex)

Methods

goToPage(page) / nextPage() / prevPage()

Methods

getCurrentPage() / getPageCount()

Methods

setPageSize(n) / getPageSize()

Methods

getEdits()

Methods

clearEdits()

Methods

setCellValue(row, field, value)

Methods

setCellValues(entries)

Methods

undo() / redo()

Methods

isValid() / getInvalidCells() / validateAll()

Methods

getRowData(rowIndex) / ready()

Methods

destroy()

Methods


Features

Features


Pagination

Pagination

Letting users pick the page size

Pagination


Button Columns (type: 'button')

Cell Types

Cell Buttons (columnDefs[].cellButton)

Cell Types


Row Selection (rowSelection) / Header Checkbox

Selection

Selection, Focus and Editing from Code (getSelection / setSelection / focusCell / startEditing / stopEditing)

Selection


Context Menus (rowContextMenuItems / colContextMenuItems / cellContextMenuItems / setOptions)

Context Menus


Set Filter / Quick Filter

Filtering & Sorting

Tag Filter (fetchFilterValues)

Filtering & Sorting

Field-Based Filter / Sort (setFilter / setSort)

Filtering & Sorting

Multi-Column Sort (getSorts / setSorts / addSort / moveSort / clearSorts)

Filtering & Sorting


Adding/Deleting Rows (addRow / deleteRow)

Rows

Hiding Rows (hideRow / showRow / showAllRows)

Rows


Adding/Deleting/Hiding Columns (addColumn / deleteColumn / hideColumn)

Columns


Row Height (setRowHeight / autoFitColumns)

Rows


Responsive Sizing (responsive)

Columns

Filling the Width (stretchColumns)

Columns

Frozen Columns (frozenCols / frozenColsRight)

Columns


Pinned Rows (pinnedTopRows / pinnedBottomRows / pinRow)

Rows


State Snapshot/Restore (getState / setState)

State & Saving

Incremental Save (getOriginalRowData / isNewRow / acknowledgeSave / acknowledgeInsert)

State & Saving

Batch Save (rowKey / getChanges() / acknowledgeChanges())

State & Saving


Multi-Level Header Groups (columnDefs[].group)

Columns

Column Letter Header (columnLetterHeader)

Columns


Locale / Internationalization (locale / i18n)

Localization

Text Reference (i18n)

Localization


Conditional Styling (rowHighlighter / cellBackground)

Themes

Cell Decorator / Tooltip (cellDecorator / cellTooltip)

Themes


Row Drag Reorder (rowReorder)

Rows


Built-in Cell Renderers (CellRenderers)

Renderers & Custom Editors

Column Types: date / richtext / image, and Custom Editors/Renderers

Renderers & Custom Editors


Text Cells and Line Breaks

Editing


Checkbox Columns (type: 'checkbox')

Cell Types

Date Columns (type: 'date')

Cell Types

Radio Columns (type: 'radio')

Cell Types

Cell Types


Editor Options (columnDefs[].editorOptions)

Editing

Validation (columnDefs[].validation)

Editing


Data Export (exportCsv / printGrid)

Export & Print


Plugins (JHGrid.use)

Options


Accessibility

Interaction Reference


Exports

Options


This site uses Just the Docs, a documentation theme for Jekyll.