forked from volosoft/jtable
-
Notifications
You must be signed in to change notification settings - Fork 0
api
Franky Van Liedekerke edited this page Jul 21, 2025
·
22 revisions
jTable is used to develop AJAX-based CRUD (Create/Retrieve/Update/Delete) tables without coding HTML and JavaScript. The only required HTML tag is a simple div element in your page:
<div id="MyTableContainer"></div>To initialize a jTable instance, you can call the jtable method in the ready event of the document:
<script type="text/javascript">
$(document).ready(function () {
$('#MyTableContainer').jtable({
// General options come here
actions: {
// Action definitions come here
},
fields: {
// Field definitions come here
}
// Event handlers...
});
});
</script>jTable has three types of options:
- General options: Define the general behavior of the jTable instance.
- Actions: Define how to communicate from the client to the server.
- Fields: Define the structure of the record, create/edit forms, and table. A row in the table is called a "record," which must have fields like a relational database table.
NOTE: When you create a jTable instance, a table is created, but no data is loaded into the table. Use the
loadmethod to load data. See the Getting Started document for detailed usage.
- addRecordButton
- ajaxSettings
- animationsEnabled
- columnResizable
- columnSelectable
- csvDelimiter
- csvExport
- csvExportButton
- defaultDateFormat
- defaultDateLocale
- defaultSorting
- deleteConfirmation
- dialogShowEffect
- dialogHideEffect
- gotoPageArea
- jqueryuiTheme
- loadingAnimationDelay
- logLevel
- messages
- multiselect
- multiSorting
- multiSortingCtrlKey
- openChildAsAccordion
- paging
- pageList
- pageSize
- pageSizes
- printExtraStyles
- printMode
- printTable
- printTableButton
- pageSizeChangeArea
- saveUserPreferences
- saveUserPreferencesMethod
- selecting
- selectingCheckboxes
- selectOnRowClick
- showCloseButton
- sorting
- sortingInfoReset
- sortingInfoSelector
- tableId
- tableReset
- title
- toolbar
- toolbarreset
- toolbarsearch
- unAuthorizedRequestRedirectUrl
- columnResizable
- create
- edit
- dateFormat
- dateLocale
- defaultValue
- dependsOn
- display
- explain
- input
- inputAttributes
- inputClass
- inputEscapeHTML
- inputTitle
- key
- list
- listClass
- listClassEntry
- listClassHeader
- listEscapeHTML
- options
- optionsSorting
- placeholder
- searchable
- sorting
- title
- toolbarOptions
- type
- visibility
- width
3. Actions
4. Methods
- addRecord
- closeChildRow
- closeChildTable
- changeColumnVisibility
- deleteRecord
- deleteRows
- deselectRows
- destroy
- editRecordByKey
- editRecordViaAjax
- getChildRow
- getRowByKey
- getSortingInfo
- invertRowSelection
- isChildRowOpen
- load
- openChildRow
- openChildTable
- recalcColumnWidths
- recalcColumnWidthsOnce
- reload
- resetSorting
- resetTable
- selectedRows
- selectRows
- showCreateForm
- updateRecord
5. Events
- closeRequested
- formClosed
- formCreated
- formSubmitting
- loadingRecords
- recordAdded
- recordDeleted
- recordsLoaded
- recordUpdated
- rowInserted
- rowsRemoved
- rowUpdated
- selectionChanged