w2ui

Properties

autoLoad - Boolean, default = true
Indicates if the records should be loaded from the server automatically as user scrolls.
buttons - Object, default see below
Object that contains default toolbar items
colDefaults - Object, default = {...} see below
Default values for the column
columnGroups - Array, default = []
Array of column group objects.
columns - Array, default = []
Array of column objects.
dataType - String, default = null
Defines dateType for the grid
defaultOperator - Object, default = {...} // see below
Defines default operator for each search type group
disableCVS - Boolean, default = false
Indicates if column vertical scsoll (virtualization) is enabled.
fixedBody - Boolean, default = true
Indicates if the body of the grid is of fixed height.
header - String, default = ''
The header of the grid.
httpHeaders - Object, default = {}
Optional request headers.
keyboard - Boolean, default = true
Indicates if grid should listen to keyboard.
last - Object, default see below
Internal grid's variables.
limit - Integer, default = 100
Number of records to return from remote data source per attempt.
lineNumberWidth - Integer, default = 34
Width for the line number column.
markSearch - Boolean, default = true
Indicates if result of the search should be highlighted.
menu - Array, default = []
Array of object for context menu.
method - String, default = null
Overwrites method for ajax requests.
msgAJAXerror - String, default = 'AJAX error. See console for more details.'
Error message when server returns undefined error.
msgDelete - String, default = 'Are you sure you want to delete ${count} ${records}?'
Confirmation message when user clicks the delete button.
msgEmpty - String, default = ''
Message that appears in the middle of the grid when remote srouce returns no records.
msgNeedReload - String, default = 'Your remote data source record count has changed, reloading from the first record.'
Message that is displaed when total number of records on the server changed, and a reload from top is needed.
msgNotJSON - String, default = 'Returned data is not in valid JSON format.'
Error message when server does not return JSON structure.
msgRefresh - String, default = 'Refreshing...'
Message that appears when grid refreshes.
multiSearch - Boolean, default = true
Indicates if multi field search is allowed.
multiSelect - Boolean, default = true
Indicates if record multi select is allowed.
multiSort - Boolean, default = true
Indicates if column multi sort is allowed.
nestedFields - Boolean, default = true
Indicates if field names should be parsed
offset - Integer, default = 0
Number of records to skip when retrieving records from remote source.
operators - Object, default = {...} // see below
Defines operators for different types of search fields
operatorsMap - Object, default = {...} // see below
Defines a map of search type to operator type
parser - Function, default = null
Function to parse server response.
postData - Object, default = {}
Map of additional parameter to submit to remove data source.
ranges - Array, default = []
Array of all ranges defined for the grid.
recid - String, default = null
Name for the recid field in the records array.
recordHeight - Integer, default = 24
Height of the record.
records - Array, default = []
Array of record objects.
reorderColumns - Boolean, default = false
Indicates if reordering of columns is allowed.
reorderRows - Boolean, default = false
Indicates if reordering of rows is allowed.
routeData - String, default = ''
Object with data for the route.
searchData - Array, default = []
Array of search objects (submitted to data source for record filtering).
searchMap - Object, default = {}
Map for search fields (local to remote).
searches - Array, default = []
Array of search objects.
selectType - String, default = 'row'
Defines selection type.
show - Object, default - see below
Map of indicators which elements of the grid are visible.
showExtraOnSearch - Integer, default = 0
Number of records to show that are before and after the matched record
sortData - Array, default = []
Array of sort objects (submitted to data source for record sorting).
sortMap - Object, default = {}
Map for sort fields (local to remote).
stateColProps - Object, default = {...} see below
Defines which column properties when state is saved
stateId - String, default = null
Defines state id to save to local storage
summary - Array, default = []
Summary records that displayed on the bottom
tabIndex - Number, default = null
Defines tab index for the grid.
textSearch - String, default = 'begins'
Defines how the text search behaves.
toolbar - Object, default = null
Toolbar for the grid.
total - Integer, default = 0
Total number of records.
url - String or Object, default = ''
URL to the remote data source.
vs_extra - Number, default = 15
Defines the number of extra records to display when virtualizing
vs_start - Number, default = 150
Defines the number of records in the grid when to start virtualization

Common Properties

box - DOM Element, default = null
The DOM element where to render the object.
handlers - Array, default = []
Array of event handlers.
name - String, default = ''
Unique name for the object.
style - String, default = ''
Additional style for the .box where the object is rendered.