attachToObject(obj) attach this grid to some object in DOM
File required:dhtmlxGrid.js
obj - object to attach to
doDynScroll(fl) dynamicaly scrolls grid content.
File required:dhtmlxGrid.js
fl - if no fl - initializes dynamic scroll, if 'up' - scroll page up, if 'dn' - scrolls page down
enableBuffering(bufferSize) enables buffering in content rendering. Using this you decrease the grid loading time.
File required:dhtmlxGrid.js
enableMultiline(state) set multiline rows support to enabled or disabled state
File required:dhtmlxGrid.js
state - true or false
enableMultiselect(state) set multiselect mode to enabled or disabled state
File required:dhtmlxGrid.js
state - true or false
init(fl) initialize grid
File required:dhtmlxGrid.js
fl - if to parse on page xml dataisland
setColAlign(alStr) set align of columns
File required:dhtmlxGrid.js
alStr - align string with delimiters
setColSorting(sortStr) set column sort types (avaialble: str, int, date, na)
File required:dhtmlxGrid.js
sortStr - sort codes list with default delimiter
setColTypes(typeStr) set column types
File required:dhtmlxGrid.js
typeStr - type codes list with default delimiter
setDelimiter(delim) set default delimiter
File required:dhtmlxGrid.js
delim - delimiter as string
setHeader(hdrStr) set header label and default params for new headers
File required:dhtmlxGrid.js
hdrStr - header string with delimiters
setImagePath(path) set path to grid internal images (sort direction, any images used in editors, checkbox, radiobutton)
File required:dhtmlxGrid.js
path - path to images folder with closing "/"
setInitWidths(wp) set width of columns in pixels
File required:dhtmlxGrid.js
wp - width in pixels
setInitWidthsP(wp) set width of columns in percents
File required:dhtmlxGrid.js
wp - width in percents
setMultiLine(fl) sets grid to multiline row support (call before init)
File required:dhtmlxGrid.js
fl - true to set multiline support
setMultiselect(fl) allow multiselection
File required:dhtmlxGrid.js
fl - false/true
setNoHeader(fl) use to create grid with no header
File required:dhtmlxGrid.js
fl - true to use no header in the grid
setStyle(ss_header,ss_grid,ss_selCell,ss_selRow) modify default style of grid and its elements. Call before or after Init
File required:dhtmlxGrid.js
ss_header - style def. expression for header
ss_grid - style def. expression for grid cells
ss_selCell - style def. expression for selected cell
ss_selRow - style def. expression for selected Row
setXMLAutoLoading(filePath,bufferSize) enables the possibility to load content from server when already loaded content was rendered. Using this you decrease the grid loading time for extremely big amounts of data.
File required:dhtmlxGrid.js
selection control
clearSelection() removes selection from the grid
File required:dhtmlxGrid.js
getSelectedCellIndex() gets index of selected cell
File required:dhtmlxGrid.js Returns:index of selected cell or -1 if there is no selected sell
getSelectedId() gets selected row id
File required:dhtmlxGrid.js Returns:id of selected row (list of ids with default delimiter) or null if non row selected
selectCell(r,cInd,fl) set selection to specified row-cell
File required:dhtmlxGrid.js
r - row object or row index
cInd - cell index
[fl] - true if to call onRowSelect function
selectRow(r,fl) selects row (and first cell of it)
Returns:dhtmlXGridCellObject object (see its methods below)
editCell() creates Editor object and switch cell to edit mode if allowed
File required:dhtmlxGrid.js
editStop() gets value from editor(if presents) to cell and closes editor
File required:dhtmlxGrid.js
getCombo(col_ind) gets Combo object of specified column
File required:dhtmlxGrid.js
col_ind - index of the column to get combo object for
getSelectedCellIndex() gets index of selected cell
File required:dhtmlxGrid.js Returns:index of selected cell or -1 if there is no selected sell
selectCell(r,cInd,fl) set selection to specified row-cell
File required:dhtmlxGrid.js
r - row object or row index
cInd - cell index
[fl] - true if to call onRowSelect function
setColSorting(sortStr) set column sort types (avaialble: str, int, date, na)
File required:dhtmlxGrid.js
sortStr - sort codes list with default delimiter
setColTypes(typeStr) set column types
File required:dhtmlxGrid.js
typeStr - type codes list with default delimiter
data manipulation
clearAll() deletes all rows in grid
File required:dhtmlxGrid.js
copyRowContent(from_row_id, to_row_id) copies row content to another existing row
File required:dhtmlxGrid.js
from_row_id - id of the row to copy content from
to_row_id - id of the row to copy content to
getUserData(row_id,name) gets user Data
File required:dhtmlxGrid.js
row_id - row id. if empty then user data is for grid (not row)
name - name of user data
Returns:value of user data
parseXML(xml,startIndex) populate grid with data from xml file (if passed parameter contains '.') or island
File required:dhtmlxGrid.js
[xml] - xml island will be found by grid id (id_xml) if no file or island id is specified. This also can be ready-to-use XML object
[startIndex] - index of row in grid to start insertion from
setUserData(row_id,name,value) sets user Data
File required:dhtmlxGrid.js
row_id - row id. if empty then user data is for grid (not row)
name - name of user data
value - value of user data
sortRows(col,type,order) sorts specified column
File required:dhtmlxGrid.js
col - column index
type - str.int.date
order - asc.desc
appearence control
doDynScroll(fl) dynamicaly scrolls grid content.
File required:dhtmlxGrid.js
fl - if no fl - initializes dynamic scroll, if 'up' - scroll page up, if 'dn' - scrolls page down
setColumnColor(clr) colorize columns.
File required:dhtmlxGrid.js
clr - colors list
setHeaderCol(col,label) sets new column header label
File required:dhtmlxGrid.js
col - header column index
label - new label for the cpecified header's column
setRowTextBold(row_id) sets row text BOLD
File required:dhtmlxGrid.js
row_id - row id
setRowTextNormal(row_id) sets row text NORMAL
File required:dhtmlxGrid.js
row_id - row id
setRowTextStyle(row_id,styleString) sets style to row
File required:dhtmlxGrid.js
row_id - row id
styleString - style string in common format (exmpl: "color:red;border:1px solid gray;")
setStyle(ss_header,ss_grid,ss_selCell,ss_selRow) modify default style of grid and its elements. Call before or after Init
File required:dhtmlxGrid.js
ss_header - style def. expression for header
ss_grid - style def. expression for grid cells
ss_selCell - style def. expression for selected cell
ss_selRow - style def. expression for selected Row
overal grid control
attachToObject(obj) attach this grid to some object in DOM
File required:dhtmlxGrid.js
obj - object to attach to
clearAll() deletes all rows in grid
File required:dhtmlxGrid.js
doDynScroll(fl) dynamicaly scrolls grid content.
File required:dhtmlxGrid.js
fl - if no fl - initializes dynamic scroll, if 'up' - scroll page up, if 'dn' - scrolls page down
enableBuffering(bufferSize) enables buffering in content rendering. Using this you decrease the grid loading time.
File required:dhtmlxGrid.js
enableMultiline(state) set multiline rows support to enabled or disabled state
File required:dhtmlxGrid.js
state - true or false
enableMultiselect(state) set multiselect mode to enabled or disabled state
File required:dhtmlxGrid.js
state - true or false
getAllItemIds(separator) gets a list of all row ids in grid
File required:dhtmlxGrid.js
separator - delimiter to use in list
Returns:list of all row ids in grid
getColumnCount() gets number of columns in grid
File required:dhtmlxGrid.js Returns:number of columns in grid
getColWidth(ind) gets width of specified column in pixels
File required:dhtmlxGrid.js
ind - column index
Returns:column width in pixels
getRowsNum() gets number of rows in grid
File required:dhtmlxGrid.js Returns:number of rows in grid
init(fl) initialize grid
File required:dhtmlxGrid.js
fl - if to parse on page xml dataisland
isItemExists(row_id) determines if row with specified id exists
File required:dhtmlxGrid.js
row_id - row id
Returns:true if exists, false otherwise
setEditable(fl) manage editibility of the grid
File required:dhtmlxGrid.js
[fl] - set not editable if FALSE, set editable otherwise
setImagePath(path) set path to grid internal images (sort direction, any images used in editors, checkbox, radiobutton)
File required:dhtmlxGrid.js
path - path to images folder with closing "/"
setInitWidths(wp) set width of columns in pixels
File required:dhtmlxGrid.js
wp - width in pixels
setInitWidthsP(wp) set width of columns in percents
File required:dhtmlxGrid.js
wp - width in percents
setMultiselect(fl) allow multiselection
File required:dhtmlxGrid.js
fl - false/true
setNoHeader(fl) use to create grid with no header
File required:dhtmlxGrid.js
fl - true to use no header in the grid
setXMLAutoLoading(filePath,bufferSize) enables the possibility to load content from server when already loaded content was rendered. Using this you decrease the grid loading time for extremely big amounts of data.
File required:dhtmlxGrid.js
showRow(rowID) scrolls row to the visible area
File required:dhtmlxGrid.js
rowID - row id
treegrid
clearAll() deletes all rows in grid
File required:dhtmlxGrid.js
clearSelection() removes selection from the grid
File required:dhtmlxGrid.js
deleteRow(row_id) deletes row
File required:dhtmlxGrid.js
row_id - id of row to delete
doDynScroll(fl) dynamicaly scrolls grid content.
File required:dhtmlxGrid.js
fl - if no fl - initializes dynamic scroll, if 'up' - scroll page up, if 'dn' - scrolls page down
getSelectedId() gets selected row id
File required:dhtmlxGrid.js Returns:id of selected row (list of ids with default delimiter) or null if non row selected
sortRows(col,type,order) sorts specified column
File required:dhtmlxGrid.js
col - column index
type - str.int.date
order - asc.desc
event handlers
setOnCheckHandler(func) set function called when checkbox or radiobutton was clicked
File required:dhtmlxGrid.js
func - event handling function (or its name)
setOnEditCellHandler(func) set function called when cell editted
File required:dhtmlxGrid.js
func - event handling function (or its name)
setOnEnterPressedHandler(func) set function called when user press Enter
File required:dhtmlxGrid.js
func - event handling function (or its name)
setOnRowSelectHandler(func) set function called when row selected
File required:dhtmlxGrid.js
func - event handling function (or its name)
dhtmlXGridCellObject object API
getBgColor() determ. cell's background color
File required:dhtmlxGridCell.js Returns:cell's background color
getFont() determ. font style if it was set
File required:dhtmlxGridCell.js Returns:font name only if it was set for the cell
getHorAlign() determines horisontal align od the cell
File required:dhtmlxGridCell.js Returns:horisontal align of cell content
getTextColor() determ. cell's text color
File required:dhtmlxGridCell.js Returns:cell's text color
getValue() gets Value of cell
File required:dhtmlxGridCell.js
getWidth() gets width of the cell in pixel
File required:dhtmlxGridCell.js Returns:width of the cell in pixels
isCheckbox() determines whether first child of the cell is checkbox or radio
File required:dhtmlxGridCell.js Returns:true if first child of the cell is input element of type radio or checkbox
isChecked() determines whether radio or checkbox inside is checked
File required:dhtmlxGridCell.js Returns:true if first child of the cell is checked
isDisabled() determines whether cell content (radio,checkbox) is disabled
File required:dhtmlxGridCell.js Returns:true if first child of the cell is disabled
setBgColor(val) sets background color to the cell
File required:dhtmlxGridCell.js
val - color value (name or hex)
setChecked(fl) checks checkbox or radion
File required:dhtmlxGridCell.js
fl - true or false
setDisabled(fl) disables radio or checkbox
File required:dhtmlxGridCell.js
fl - true or false
setFont(val) sets font family to the cell
File required:dhtmlxGridCell.js
val - string in format: Arial-bold(italic,bolditalic)-12px
setHorAlign(val) sets horisontal align to the cell
File required:dhtmlxGridCell.js
val - value in single-letter or full format(exmp: r or right)
setTextColor(val) sets text color to the cell
File required:dhtmlxGridCell.js
val - color value (name or hex)
setValue(val) sets value to the cell
File required:dhtmlxGridCell.js
val - new value
wasChanged() determines whether cell value was changed
File required:dhtmlxGridCell.js Returns:true if cell value was changed, otherwise - false
eXcell object API
getBgColor() determ. cell's background color
Nested from:dhtmlXGridCellObject File required:dhtmlxGridCell.js Returns:cell's background color
getFont() determ. font style if it was set
Nested from:dhtmlXGridCellObject File required:dhtmlxGridCell.js Returns:font name only if it was set for the cell
getHorAlign() determines horisontal align od the cell
Nested from:dhtmlXGridCellObject File required:dhtmlxGridCell.js Returns:horisontal align of cell content
getTextColor() determ. cell's text color
Nested from:dhtmlXGridCellObject File required:dhtmlxGridCell.js Returns:cell's text color