Personal tools
| Home | sandbox | dhtmlxGrid | doc | ogroup
Document Actions

ogroup

.{font-family:arial;} h2 {cursor:pointer;font-size:16px;margin-left:10px;line-height:10px} h3 {cursor:pointer;font-weight:normal;color:gray;text-decoration:underline;line-height:10px} div.block {margin-left:30px;}

dhtmlXGridObject object API

addRow(...) [Professional]
><strong class="div_strong_method">add new row to treeGrid<strong>
><span>

><font class="exem">File required:<font>dhtmlxtreegrid.js><div>
addRow(new_id,text,ind)
><strong class="div_strong_method">adds row to the specified position (by default to the beginning of the grid)<strong>
><span>
Topic(s):
><font class="exem">File required:<font>dhtmlxgrid.js
  • new_id - id for new row
  • text - Array of values or String(with delimiter as in delimiter parameter)
  • [ind] - index of row (0 by default)

    • ><font class="exem">Returns:<font>new row dom object><div>
    addRowFromClipboard(...) [Professional]
    ><strong class="div_strong_method">add new row from clipboard<strong>
    ><span>
    Topic(s):
    ><font class="exem">File required:<font>dhtmlxgrid_nxml.js><div>
    adjustColumnSize(cInd)
    ><strong class="div_strong_method">autosize column to max content size<strong>
    ><span>

    ><font class="exem">File required:<font>dhtmlxgrid.js
  • cInd - index of column
    • ><div>
    attachFooter(...) [Professional]
    ><strong class="div_strong_method">attach additional line to footer<strong>
    ><span>

    ><font class="exem">File required:<font>dhtmlxgrid.js><div>
    attachHeader(values,style,_type)
    ><strong class="div_strong_method">attach additional line to header<strong>
    ><span>

    ><font class="exem">File required:<font>dhtmlxgrid.js
  • values - array of header titles
  • style - array of styles, optional
  • _type - reserved
    • ><div>
    attachToObject(obj)
    ><strong class="div_strong_method">attach grid to some object in DOM<strong>
    ><span>
    Topic(s): overal control;
    ><font class="exem">File required:<font>dhtmlxgrid.js
  • obj - object to attach to
    • ><div>
    cellById(row_id,col)
    ><strong class="div_strong_method">gets dhtmlXGridCellObject object (if no arguments then gets dhtmlXGridCellObject object of currently selected cell)<strong>
    ><span>
    Topic(s):
    ><font class="exem">File required:<font>dhtmlxgrid.js
  • row_id - row id
  • col - column index

    • ><font class="exem">Returns:<font>dhtmlXGridCellObject object (see its methods below)><div>
    cellByIndex(row_index,col)
    ><strong class="div_strong_method">gets dhtmlXGridCellObject object<strong>
    ><span>
    Topic(s):
    ><font class="exem">File required:<font>dhtmlxgrid.js
  • row_index - row index
  • col - column index

    • ><font class="exem">Returns:<font>dhtmlXGridCellObject object (see its methods below)><div>
    cellToClipboard(...) [Professional]
    ><strong class="div_strong_method">copy value of cell to clipboard<strong>
    ><span>
    Topic(s):
    ><font class="exem">File required:<font>dhtmlxgrid_nxml.js><div>
    cells(row_id,col)
    ><strong class="div_strong_method">gets dhtmlXGridCellObject object (if no arguments then gets dhtmlXGridCellObject object of currently selected cell)<strong>
    ><span>
    Topic(s):
    ><font class="exem">File required:<font>dhtmlxgrid.js
  • row_id - row id
  • col - column index

    • ><font class="exem">Returns:<font>dhtmlXGridCellObject object (use it to get/set value to cell etc.)><div>
    cells2(row_index,col)
    ><strong class="div_strong_method">gets dhtmlXGridCellObject object<strong>
    ><span>
    Topic(s):
    ><font class="exem">File required:<font>dhtmlxgrid.js
  • row_index - row index
  • col - column index

    • ><font class="exem">Returns:<font>dhtmlXGridCellObject object (see its methods below)><div>
    changePage(...) [Professional]
    ><strong class="div_strong_method">changes page to output (paginal output), populates grid with new set of records. When dynamical loading enabled, do not request page more than one portion far from already loaded<strong>
    ><span>
    Topic(s):
    ><font class="exem">File required:<font>dhtmlxgrid_pgn.js><div>
    changeRowId(oldRowId,newRowId)
    ><strong class="div_strong_method">changes id of the row to the new one<strong>
    ><span>
    Topic(s):
    ><font class="exem">File required:<font>dhtmlxgrid.js
  • oldRowId - row id to change
  • newRowId - row id to set
    • ><div>
    clearAll(header)
    ><strong class="div_strong_method">deletes all rows in grid<strong>
    ><span>
    Topic(s): overal control; treegrid;
    ><font class="exem">File required:<font>dhtmlxgrid.js
  • header - (boolean) enable/disable cleaning header
    • ><div>
    clearChangedState(...) [Professional]
    ><strong class="div_strong_method">clear wasChanged state for all cells in grid<strong>
    ><span>
    Topic(s):
    ><font class="exem">File required:<font>dhtmlxgrid.js><div>
    clearConfigCookie(...) [Professional]
    ><strong class="div_strong_method">clear cookie with grid config details<strong>
    ><span>
    Topic(s):
    ><font class="exem">File required:<font>dhtmlxgrid_ssc.js><div>
    clearSelection()
    ><strong class="div_strong_method">removes selection from the grid<strong>
    ><span>
    Topic(s): treegrid;
    ><font class="exem">File required:<font>dhtmlxgrid.js><div>
    closeItem(...) [Professional]
    ><strong class="div_strong_method">collapse row<strong>
    ><span>
    Topic(s):
    ><font class="exem">File required:<font>dhtmlxtreegrid.js><div>
    collapseAll(...) [Professional]
    ><strong class="div_strong_method">collapse all tree structure<strong>
    ><span>
    Topic(s):
    ><font class="exem">File required:<font>dhtmlxtreegrid.js><div>
    collapseAllGroups(...) [Professional]
    ><strong class="div_strong_method">collapse all groups<strong>
    ><span>

    ><font class="exem">File required:<font>dhtmlxgrid_group.js><div>
    collapseGroup(...) [Professional]
    ><strong class="div_strong_method">collapse group of rows<strong>
    ><span>

    ><font class="exem">File required:<font>dhtmlxgrid_group.js><div>
    collectValues(...) [Professional]
    ><strong class="div_strong_method">get all possible values in column<strong>
    ><span>
    Topic(s):
    ><font class="exem">File required:<font>dhtmlxgrid_filter.js
    ><font class="exem">Returns:<font>{array} array of all possible values in column><div>
    copyBlockToClipboard()
    ><strong class="div_strong_method">copy content of block selection into clipboard in csv format (delimiter as set for csv serialization)<strong>
    ><span>
    Topic(s):
    ><font class="exem">File required:<font>dhtmlxgrid_selection.js><div>
    copyRowContent(from_row_id, to_row_id)
    ><strong class="div_strong_method">copies row content to another existing row<strong>
    ><span>
    Topic(s): data manipulation;
    ><font class="exem">File required:<font>dhtmlxgrid.js
  • from_row_id - id of the row to copy content from
  • to_row_id - id of the row to copy content to
    • ><div>
    deleteChildItems(...) [Professional]
    ><strong class="div_strong_method">delete all childs of row in question<strong>
    ><span>
    Topic(s):
    ><font class="exem">File required:<font>dhtmlxtreegrid.js><div>
    deleteColumn(...) [Professional]
    ><strong class="div_strong_method">delete column<strong>
    ><span>
    Topic(s):
    ><font class="exem">File required:<font>dhtmlxgrid_mcol.js><div>
    deleteRow(row_id,node)
    ><strong class="div_strong_method">deletes row specified by ID<strong>
    ><span>
    Topic(s): treegrid;
    ><font class="exem">File required:<font>dhtmlxgrid.js
  • row_id - id of row to delete
  • node - reserved
    • ><div>
    deleteSelectedRows()
    ><strong class="div_strong_method">deletes selected row(s)<strong>
    ><span>
    Topic(s):
    ><font class="exem">File required:<font>dhtmlxgrid.js><div>
    destructor()
    ><strong class="div_strong_method">destructor, removes grid and cleans used memory<strong>
    ><span>
    Topic(s):
    ><font class="exem">File required:<font>dhtmlxgrid.js><div>
    detachFooter(index)
    ><strong class="div_strong_method">remove footer line from grid (opposite to attachFooter)<strong>
    ><span>

    ><font class="exem">File required:<font>dhtmlxgrid.js
  • values - array of header titles
    • ><div>
    detachHeader(index,hdr)
    ><strong class="div_strong_method">remove header line from grid (opposite to attachHeader)<strong>
    ><span>

    ><font class="exem">File required:<font>dhtmlxgrid.js
  • index - index of row to be removed ( zero based )
  • hdr - header object (optional)
    • ><div>
    doesRowExist(row_id)
    ><strong class="div_strong_method">determines if row with specified id exists<strong>
    ><span>
    Topic(s): overal control;
    ><font class="exem">File required:<font>dhtmlxgrid.js
  • row_id - row id

    • ><font class="exem">Returns:<font>true if exists, false otherwise><div>
    editCell()
    ><strong class="div_strong_method">creates Editor object and switch cell to edit mode if allowed<strong>
    ><span>
    Topic(s):
    ><font class="exem">File required:<font>dhtmlxgrid.js><div>
    editStop(mode)
    ><strong class="div_strong_method">retuns value from editor(if presents) to cell and closes editor<strong>
    ><span>
    Topic(s):
    ><font class="exem">File required:<font>dhtmlxgrid.js><div>
    enableAlterCss(cssE,cssU,perLevel,levelUnique)
    ><strong class="div_strong_method">set evenodd css styles
    ><span>
    Topic(s): appearence control;
    ><font class="exem">File required:<font>dhtmlxgrid.js
  • cssE - name of css class for even rows
  • cssU - name of css class for odd rows
  • perLevel - true/false - mark rows not by order, but by level in treegrid
  • levelUnique - true/false - creates additional unique css class based on row level
    • ><div>
    enableAutoHeight(mode,maxHeight,countFullHeight)
    ><strong class="div_strong_method">enable autoheight of grid<strong>
    ><span>
    Topic(s):
    ><font class="exem">File required:<font>dhtmlxgrid.js
  • mode - true/false
  • maxHeight - maximum height before scrolling appears (no limit by default)
  • countFullHeight - control the usage of maxHeight parameter - when set to true all grid height included in max height calculation, if false then only data part (no header) of grid included in calcualation (false by default)
    • ><div>
    enableAutoSaving(...) [Professional]
    ><strong class="div_strong_method">enable automatic saving of all possible params<strong>
    ><span>
    Topic(s):
    ><font class="exem">File required:<font>dhtmlxgrid_ssc.js><div>
    enableAutoSizeSaving(...) [Professional]
    ><strong class="div_strong_method">enable automatic size saving to cookie<strong>
    ><span>
    Topic(s):
    ><font class="exem">File required:<font>dhtmlxgrid_ssc.js><div>
    enableBlockSelection()
    ><strong class="div_strong_method">enables block selection mode in grid<strong>
    ><span>
    Topic(s):
    ><font class="exem">File required:<font>dhtmlxgrid_selection.js><div>
    enableBuffering(bufferSize)
    ><strong class="div_strong_method">enables buffering in content rendering. Using this you decrease the grid loading time.<strong>
    ><span>
    Topic(s): overal control;
    ><font class="exem">File required:<font>dhtmlxgrid.js><div>
    enableCSVAutoID(...) [Professional]
    ><strong class="div_strong_method">enable mode, where ID for rows loaded from CSV autogenerated<strong>
    ><span>
    Topic(s):
    ><font class="exem">File required:<font>dhtmlxgrid_nxml.js><div>
    enableCSVHeader(...) [Professional]
    ><strong class="div_strong_method">enable recognizing first row in CSV as header<strong>
    ><span>
    Topic(s):
    ><font class="exem">File required:<font>dhtmlxgrid_nxml.js><div>
    enableCellIds(mode)
    ><strong class="div_strong_method">enabledisable unique id for cells (id will be automaticaly created using the following template: "c_[RowId]_[colIndex]")
    ><span>
    Topic(s):
    ><font class="exem">File required:<font>dhtmlxgrid.js
  • mode - true/false - enable/disable
    • ><div>
    enableColSpan(...) [Professional]
    ><strong class="div_strong_method">enabledisable colspan support
    ><span>

    ><font class="exem">File required:<font>dhtmlxgrid.js><div>
    enableColumnAutoSize(mode)
    ><strong class="div_strong_method">enabledisable autosize of column (column size set depending on content size) on doubleclick
    ><span>

    ><font class="exem">File required:<font>dhtmlxgrid.js
  • mode - true/false
    • ><div>
    enableColumnMove(...) [Professional]
    ><strong class="div_strong_method">enable move column functionality<strong>
    ><span>
    Topic(s):
    ><font class="exem">File required:<font>dhtmlxgrid_mcol.js><div>
    enableContextMenu(menu)
    ><strong class="div_strong_method">enabledisable context menu
    ><span>
    Topic(s):
    ><font class="exem">File required:<font>dhtmlxgrid.js
  • dhtmlxMenu object, if null - context menu will be disabled
    • ><div>
    enableDistributedParsing(...) [Professional]
    ><strong class="div_strong_method">enabledisable distributed parsing (rows paresed portion by portion with some timeout)
    ><span>

    ><font class="exem">File required:<font>dhtmlxgrid.js><div>
    enableDragAndDrop(mode)
    ><strong class="div_strong_method">enabledisable drag-and-drop
    ><span>
    Topic(s):
    ><font class="exem">File required:<font>dhtmlxgrid_drag.js
  • mode - enabled/disabled [ can be true/false/temporary_disabled - last value mean that tree can be D-n-D can be switched to true later ]
    • ><div>
    enableDragOrder(mode)
    ><strong class="div_strong_method">switch to mode when draged item, droped in target location in same order as they was in source grid<strong>
    ><span>
    Topic(s):
    ><font class="exem">File required:<font>dhtmlxgrid_drag.js
  • mode - true/false to enable/disable mode
    • ><div>
    enableEditEvents(click, dblclick, f2Key)
    ><strong class="div_strong_method">enabledisable events which fire excell editing, mutual exclusive with enableLightMouseNavigation
    ><span>

    ><font class="exem">File required:<font>dhtmlxgrid.js
  • click - true/false - enable/disable editing by single click
  • dblclick - true/false - enable/disable editing by double click
  • f2Key - enable/disable editing by pressing F2 key
    • ><div>
    enableHeaderImages(fl)
    ><strong class="div_strong_method">specify if values passed to Header are images file names<strong>
    ><span>
    Topic(s): colums control;
    ><font class="exem">File required:<font>dhtmlxgrid.js
  • fl - true to treat column header values as image names
    • ><div>
    enableHeaderMenu(...) [Professional]
    ><strong class="div_strong_method">enable pop up menu which allows hiddingshowing columns
    ><span>

    ><font class="exem">File required:<font>dhtmlxgrid_hmenu.js><div>
    enableKeyboardSupport(mode)
    ><strong class="div_strong_method">enabledisable hot keys in grid
    ><span>
    Topic(s):
    ><font class="exem">File required:<font>dhtmlxgrid.js
  • mode - true/false
    • ><div>
    enableLightMouseNavigation(mode)
    ><strong class="div_strong_method">enabledisable light mouse navigation mode (row selection with mouse over, editing with single click), mutual exclusive with enableEditEvents
    ><span>

    ><font class="exem">File required:<font>dhtmlxgrid.js
  • mode - true/false
    • ><div>
    enableMathEditing(...) [Professional]
    ><strong class="div_strong_method">enabledisable editing of math cells
    ><span>

    ><font class="exem">File required:<font>dhtmlxgrid_math.js><div>
    enableMathSerialization(...) [Professional]
    ><strong class="div_strong_method">enabledisable serialization of math formulas
    ><span>

    ><font class="exem">File required:<font>dhtmlxgrid_math.js><div>
    enableMercyDrag(...) [Professional]
    ><strong class="div_strong_method">enable drag without removing (copy instead of move)<strong>
    ><span>
    Topic(s):
    ><font class="exem">File required:<font>dhtmlxgrid_drag.js><div>
    enableMultiline(state)
    ><strong class="div_strong_method">set multiline rows support to enabled or disabled state<strong>
    ><span>
    Topic(s): overal control;
    ><font class="exem">File required:<font>dhtmlxgrid.js
  • state - true or false
    • ><div>
    enableMultiselect(state)
    ><strong class="div_strong_method">set multiselect mode to enabled or disabled state<strong>
    ><span>
    Topic(s): overal control;
    ><font class="exem">File required:<font>dhtmlxgrid.js
  • state - true or false
    • ><div>
    enableOrderSaving(...) [Professional]
    ><strong class="div_strong_method">enable automatic column order saving to cookie<strong>
    ><span>
    Topic(s):
    ><font class="exem">File required:<font>dhtmlxgrid_ssc.js><div>
    enablePaging(...) [Professional]
    ><strong class="div_strong_method">enables paginal output of records in grid<strong>
    ><span>
    Topic(s):
    ><font class="exem">File required:<font>dhtmlxgrid_pgn.js><div>
    enablePagingWT(...) [Professional]
    ><strong class="div_strong_method">enable paging and setup dhtmlxToolbar for displaying paging navigation (requires dhtmlXProtobar.js,dhtmlXToolbar.js,dhtmlXToolbar.css)<strong>
    ><span>

    ><font class="exem">File required:<font>dhtmlxgrid_pgn.js
    ><font class="exem">Returns:<font>toolbar object><div>
    enableRecordsInfo(...) [Professional]
    ><strong class="div_strong_method">enablesdisables records info in paginal output
    ><span>
    Topic(s):
    ><font class="exem">File required:<font>dhtmlxgrid_pgn.js><div>
    enableResizing(list)
    ><strong class="div_strong_method">enabledisable resizing for specified colums
    ><span>
    Topic(s):
    ><font class="exem">File required:<font>dhtmlxgrid.js
  • list - list of true/false values, resizing enabled for all columns by default
    • ><div>
    enableRowsHover(mode,cssClass)
    ><strong class="div_strong_method">enabledisable hovering row on mouse over
    ><span>

    ><font class="exem">File required:<font>dhtmlxgrid.js
  • mode - true/false
  • cssClass - css class for hovering row
    • ><div>
    enableRowspan()
    ><strong class="div_strong_method">enable rowspan in grid<strong>
    ><span>

    ><font class="exem">File required:<font>dhtmlxgrid_rowspan.js><div>
    enableSmartRendering(mode,totalRows,bufferSize,renderSize)
    ><strong class="div_strong_method">enabledisable Smart Rendering mode (only visible content is rendered)
    ><span>
    Topic(s):
    ><font class="exem">File required:<font>dhtmlxgrid_srnd.js
  • mode - true/false to enable/disable
  • totalRows - max count of rows, optional
  • bufferSize - size of buffer, autodect by default
  • renderSize - size of rows rendered at one time, optional, by default equal to view size
    • ><div>
    enableSmartRenderingSorting(...) [professional]
    ><strong class="div_strong_method">enabledisable sorting in Smart Rendering mode (can be used only for static smart rendering )
    ><span>
    Topic(s):
    ><font class="exem">File required:<font>dhtmlxgrid_srnd.js><div>
    enableSmartXMLParsing(...) [Professional]
    ><strong class="div_strong_method">enabledisable smart XML parsing mode (usefull for big, well structured XML)
    ><span>
    Topic(s):
    ><font class="exem">File required:<font>dhtmlxtreegrid.js><div>
    enableSortingSaving(...) [Professional]
    ><strong class="div_strong_method">enable automatic sorting state saving to cookie<strong>
    ><span>
    Topic(s):
    ><font class="exem">File required:<font>dhtmlxgrid_ssc.js><div>
    enableStableSorting(mode)
    ><strong class="div_strong_method">enable stable sorting (slow). Stable sorting algorithms maintain the relative order of records with equal keys<strong>
    ><span>
    Topic(s):
    ><font class="exem">File required:<font>dhtmlxgrid.js
  • mode - true/false
    • ><div>
    enableTooltips(list)
    ><strong class="div_strong_method">enabledisable tooltips for specified colums
    ><span>
    Topic(s):
    ><font class="exem">File required:<font>dhtmlxgrid.js
  • list - list of true/false values, tooltips enabled for all columns by default
    • ><div>
    enableTreeCellEdit(mode)
    ><strong class="div_strong_method">enabledisable editor of tree cell ; enabled by default
    ><span>
    Topic(s):
    ><font class="exem">File required:<font>dhtmlxtreegrid.js
  • mode - (boolean) true/false
    • ><div>
    enableTreeGridLines(...) [Professional]
    ><strong class="div_strong_method">enable lines in treeGrid<strong>
    ><span>
    Topic(s):
    ><font class="exem">File required:<font>dhtmlxtreegrid_lines.js><div>
    expandAll(...) [Professional]
    ><strong class="div_strong_method">expand all tree structure<strong>
    ><span>
    Topic(s):
    ><font class="exem">File required:<font>dhtmlxtreegrid.js><div>
    expandAllGroups(...) [Professional]
    ><strong class="div_strong_method">expand all groups<strong>
    ><span>

    ><font class="exem">File required:<font>dhtmlxgrid_group.js><div>
    expandGroup(...) [Professional]
    ><strong class="div_strong_method">expand group of rows<strong>
    ><span>

    ><font class="exem">File required:<font>dhtmlxgrid_group.js><div>
    filterBy(...) [Professional]
    ><strong class="div_strong_method">filter grid by mask<strong>
    ><span>
    Topic(s):
    ><font class="exem">File required:<font>dhtmlxgrid_filter.js><div>
    findCell(...) [Professional]
    ><strong class="div_strong_method">find cell in grid by value<strong>
    ><span>

    ><font class="exem">File required:<font>dhtmlxgrid.js
    ><font class="exem">Returns:<font>array each member of which contains array with row index and cell index><div>
    forEachCell(rowId,custom_code)
    ><strong class="div_strong_method">execute code for each cell in a row<strong>
    ><span>

    ><font class="exem">File required:<font>dhtmlxgrid.js
  • rowId - id of row where cell must be itterated
  • custom_code - function which get eXcell object as incomming argument
    • ><div>
    forEachRow(custom_code)
    ><strong class="div_strong_method">execute code for each row in a grid<strong>
    ><span>

    ><font class="exem">File required:<font>dhtmlxgrid.js
  • custom_code - function which get row id as incomming argument
    • ><div>
    forceLabelSelection(mode)
    ><strong class="div_strong_method">affect block selection, so it will copy|paste only visible text , not values behind<strong>
    ><span>
    Topic(s):
    ><font class="exem">File required:<font>dhtmlxgrid_selection.js
  • mode - true/false
    • ><div>
    getAllRowIds(separator)
    ><strong class="div_strong_method">gets a list of all row ids in grid<strong>
    ><span>
    Topic(s): overal control;
    ><font class="exem">File required:<font>dhtmlxgrid.js
  • separator - delimiter to use in list

    • ><font class="exem">Returns:<font>list of all row ids in grid><div>
    getAllSubItems(...) [Professional]
    ><strong class="div_strong_method">get list of id of all nested rows<strong>
    ><span>
    Topic(s):
    ><font class="exem">File required:<font>dhtmlxtreegrid.js
    ><font class="exem">Returns:<font>list of id of all nested rows><div>
    getChangedRows(...) [Professional]
    ><strong class="div_strong_method">get list of IDs of changed rows<strong>
    ><span>
    Topic(s):
    ><font class="exem">File required:<font>dhtmlxgrid.js><div>
    getCheckedRows(col_ind)
    ><strong class="div_strong_method">get list of Ids of all rows with checked exCell in specified column<strong>
    ><span>
    Topic(s):
    ><font class="exem">File required:<font>dhtmlxgrid.js
  • col_ind - column index
    • ><div>
    getChildItemIdByIndex(...) [Professional]
    ><strong class="div_strong_method">get id of child item at specified position<strong>
    ><span>
    Topic(s):
    ><font class="exem">File required:<font>dhtmlxtreegrid.js
    ><font class="exem">Returns:<font>id of child item at specified position><div>
    getColIndexById(id)
    ><strong class="div_strong_method">gets column index by column id<strong>
    ><span>
    Topic(s):
    ><font class="exem">File required:<font>dhtmlxgrid.js
  • id - column id

    • ><font class="exem">Returns:<font>index of the column><div>
    getColType(cInd)
    ><strong class="div_strong_method">get column type by column index<strong>
    ><span>
    Topic(s): colums control; cells controll;
    ><font class="exem">File required:<font>dhtmlxgrid.js
  • cInd - column index

    • ><font class="exem">Returns:<font>type code><div>
    getColTypeById(cID)
    ><strong class="div_strong_method">get column type by column ID<strong>
    ><span>
    Topic(s): colums control; cells controll;
    ><font class="exem">File required:<font>dhtmlxgrid.js
  • cID - column id

    • ><font class="exem">Returns:<font>type code><div>
    getColWidth(ind)
    ><strong class="div_strong_method">gets width of specified column in pixels<strong>
    ><span>
    Topic(s): overal control;
    ><font class="exem">File required:<font>dhtmlxgrid.js
  • ind - column index

    • ><font class="exem">Returns:<font>column width in pixels><div>
    getColumnId(cin)
    ><strong class="div_strong_method">gets column id of column specified by index<strong>
    ><span>
    Topic(s):
    ><font class="exem">File required:<font>dhtmlxgrid.js
  • cin - column index

    • ><font class="exem">Returns:<font>column id><div>
    getColumnLabel(cin)
    ><strong class="div_strong_method">gets label of column specified by index<strong>
    ><span>
    Topic(s):
    ><font class="exem">File required:<font>dhtmlxgrid.js
  • cin - column index

    • ><font class="exem">Returns:<font>column label><div>
    getColumnsNum()
    ><strong class="div_strong_method">gets number of columns in grid<strong>
    ><span>
    Topic(s): overal control;
    ><font class="exem">File required:<font>dhtmlxgrid.js
    ><font class="exem">Returns:<font>number of columns in grid><div>
    getCombo(col_ind)
    ><strong class="div_strong_method">gets Combo object of specified column. Use it to change select box value for cell before editor opened<strong>
    ><span>
    Topic(s): cells controll;
    ><font class="exem">File required:<font>dhtmlxgrid.js
  • col_ind - index of the column to get combo object for
    • ><div>
    getCustomCombo(id,ind)
    ><strong class="div_strong_method">get combobox specific for cell in question<strong>
    ><span>

    ><font class="exem">File required:<font>dhtmlxgrid.js
  • id - row id
  • ind - row index
    • ><div>
    getItemImage(...) [Professional]
    ><strong class="div_strong_method">get image of tree col<strong>
    ><span>
    Topic(s):
    ><font class="exem">File required:<font>dhtmlxtreegrid.js><div>
    getItemText(...) [Professional]
    ><strong class="div_strong_method">get real caption of tree col<strong>
    ><span>
    Topic(s):
    ><font class="exem">File required:<font>dhtmlxtreegrid.js
    ><font class="exem">Returns:<font>real caption of tree col><div>
    getLevel(rowId)
    ><strong class="div_strong_method">return level of treeGrid row<strong>
    ><span>
    Topic(s):
    ><font class="exem">File required:<font>dhtmlxtreegrid.js
  • rowId - id of row

    • ><font class="exem">Returns:<font>level of treeGrid row><div>
    getNoRecordsString(...) [Professional]
    ><strong class="div_strong_method">get string to show in records info when no records in grid<strong>
    ><span>
    Topic(s):
    ><font class="exem">File required:<font>dhtmlxgrid_pgn.js
    ><font class="exem">Returns:<font>string><div>
    getOpenState(...) [Professional]
    ><strong class="div_strong_method">return openclose state of row
    ><span>
    Topic(s):
    ><font class="exem">File required:<font>dhtmlxtreegrid.js
    ><font class="exem">Returns:<font>open/close state of row><div>
    getPagePrefix(...) [Professional]
    ><strong class="div_strong_method">get string shown before pages output in paginal output<strong>
    ><span>
    Topic(s):
    ><font class="exem">File required:<font>dhtmlxgrid_pgn.js
    ><font class="exem">Returns:<font>string><div>
    getParentId(...) [Professional]
    ><strong class="div_strong_method">return id of parent row<strong>
    ><span>
    Topic(s):
    ><font class="exem">File required:<font>dhtmlxtreegrid.js
    ><font class="exem">Returns:<font>id of parent row><div>
    getRecordsInfoTemplate(...) [Professional]
    ><strong class="div_strong_method">get template of Record Info block in paginal output<strong>
    ><span>
    Topic(s):
    ><font class="exem">File required:<font>dhtmlxgrid_pgn.js
    ><font class="exem">Returns:<font>string template, like "Results [from]-[to] of [about][total]"><div>
    getRowId(ind)
    ><strong class="div_strong_method">gets row id by index<strong>
    ><span>
    Topic(s):
    ><font class="exem">File required:<font>dhtmlxgrid.js
  • ind - row index

    • ><font class="exem">Returns:<font>row id or null if there is no row with specified index><div>
    getRowIndex(row_id)
    ><strong class="div_strong_method">gets row index by id (grid only)<strong>
    ><span>
    Topic(s):
    ><font class="exem">File required:<font>dhtmlxgrid.js
  • row_id - row id

    • ><font class="exem">Returns:<font>row index or -1 if there is no row with specified id><div>
    getRowsNum()
    ><strong class="div_strong_method">gets number of rows in grid<strong>
    ><span>
    Topic(s): overal control;
    ><font class="exem">File required:<font>dhtmlxgrid.js
    ><font class="exem">Returns:<font>number of rows in grid><div>
    getSelectedCellIndex()
    ><strong class="div_strong_method">gets index of selected cell<strong>
    ><span>
    Topic(s): cells controll;
    ><font class="exem">File required:<font>dhtmlxgrid.js
    ><font class="exem">Returns:<font>index of selected cell or -1 if there is no selected sell><div>
    getSelectedRowId()
    ><strong class="div_strong_method">gets selected row id<strong>
    ><span>
    Topic(s): rows control; treegrid;
    ><font class="exem">File required:<font>dhtmlxgrid.js
    ><font class="exem">Returns:<font>id of selected row (list of ids with default delimiter) or null if non row selected><div>
    getSortingState()
    ><strong class="div_strong_method">get sorting state of grid<strong>
    ><span>
    Topic(s):
    ><font class="exem">File required:<font>dhtmlxgrid.js
    ><font class="exem">Returns:<font>array, first element is index of sortef column, second - direction of sorting ("asc" or "des").><div>
    getStateOfView()
    ><strong class="div_strong_method">return data about current view for Smart Rendering mode<strong>
    ><span>
    Topic(s):
    ><font class="exem">File required:<font>dhtmlxgrid_srnd.js
    ><font class="exem">Returns:<font>array [ start index, view size, total rows]><div>
    getSubItems(...) [Professional]
    ><strong class="div_strong_method">return list of child row id, sparated by comma<strong>
    ><span>
    Topic(s):
    ><font class="exem">File required:<font>dhtmlxtreegrid.js
    ><font class="exem">Returns:<font>list of child rows><div>
    getUserData(row_id,name)
    ><strong class="div_strong_method">gets user Data<strong>
    ><span>
    Topic(s): data manipulation;
    ><font class="exem">File required:<font>dhtmlxgrid.js
  • row_id - row id. if empty then user data is for grid (not row)
  • name - name of user data

    • ><font class="exem">Returns:<font>value of user data><div>
    gridFromClipboard(...) [Professional]
    ><strong class="div_strong_method">init grid from CSV stored in clipboard<strong>
    ><span>
    Topic(s):
    ><font class="exem">File required:<font>dhtmlxgrid_nxml.js><div>
    gridToClipboard(...) [Professional]
    ><strong class="div_strong_method">copy grid in CSV to clipboard<strong>
    ><span>
    Topic(s):
    ><font class="exem">File required:<font>dhtmlxgrid_nxml.js><div>
    gridToGrid(rowId,sgrid,tgrid)
    ><strong class="div_strong_method">redefine this method in your code to define how grid row values should be used in another grid<strong>
    ><span>
    Topic(s):
    ><font class="exem">File required:<font>dhtmlxgrid_drag.js
  • rowId - id of draged row
  • sgrid - source grid object
  • tgrid - target grid object

    • ><font class="exem">Returns:<font>array of values for cells in target grid row><div>
    gridToTreeElement(...) [Professional]
    ><strong class="div_strong_method">redefine this method in your code to define how grid row values should be used in tree (using input parameters you can change id of new tree node, set label, set userdata blocks etc.).<strong>
    ><span>
    Topic(s):
    ><font class="exem">File required:<font>dhtmlxgrid_drag.js
    ><font class="exem">Returns:<font>if true, then grid row will be moved to tree, else - copied><div>
    groupBy(...) [Professional]
    ><strong class="div_strong_method">group grid content by values of specified column<strong>
    ><span>

    ><font class="exem">File required:<font>dhtmlxgrid_group.js><div>
    hasChildren(...) [Professional]
    ><strong class="div_strong_method">return children count<strong>
    ><span>
    Topic(s):
    ><font class="exem">File required:<font>dhtmlxtreegrid.js
    ><font class="exem">Returns:<font>children count><div>
    hidePivot(cont)
    ><strong class="div_strong_method">hide pivot table related to grid, if any exists, switch grid back to normal mode<strong>
    ><span>
    Topic(s):
    ><font class="exem">File required:<font>dhtmlxgrid_pivot.js><div>
    init(fl)
    ><strong class="div_strong_method">initialize grid<strong>
    ><span>
    Topic(s): overal control;
    ><font class="exem">File required:<font>dhtmlxgrid.js
  • fl - if to parse on page xml data island
    • ><div>
    insertColumn(...) [Professional]
    ><strong class="div_strong_method">add new column to the grid<strong>
    ><span>
    Topic(s):
    ><font class="exem">File required:<font>dhtmlxgrid_mcol.js><div>
    isColumnHidden(...) [Professional]
    ><strong class="div_strong_method">get showhidden status of column
    ><span>

    ><font class="exem">File required:<font>dhtmlxgrid.js
    ><font class="exem">Returns:<font>if column hidden then true else false><div>
    loadCSVFile(...) [Professional]
    ><strong class="div_strong_method">load grid from CSV file<strong>
    ><span>
    Topic(s):
    ><font class="exem">File required:<font>dhtmlxgrid_nxml.js><div>
    loadCSVString(...) [Professional]
    ><strong class="div_strong_method">load grid from CSV string<strong>
    ><span>
    Topic(s):
    ><font class="exem">File required:<font>dhtmlxgrid_nxml.js><div>
    loadOrderFromCookie(...) [Professional]
    ><strong class="div_strong_method">load sorting order from cookie<strong>
    ><span>
    Topic(s):
    ><font class="exem">File required:<font>dhtmlxgrid_ssc.js><div>
    loadSizeFromCookie(...) [Professional]
    ><strong class="div_strong_method">load grid layout from cookie<strong>
    ><span>
    Topic(s):
    ><font class="exem">File required:<font>dhtmlxgrid_ssc.js><div>
    loadSortingFromCookie(...) [Professional]
    ><strong class="div_strong_method">load sorting order from cookie<strong>
    ><span>
    Topic(s):
    ><font class="exem">File required:<font>dhtmlxgrid_ssc.js><div>
    loadXML(url,afterCall)
    ><strong class="div_strong_method">loads xml content from specified url into grid<strong>
    ><span>
    Topic(s): data manipulation;
    ><font class="exem">File required:<font>dhtmlxgrid.js
  • url - XML file url
  • afterCall - function which will be called after xml loading
    • ><div>
    loadXMLString(...) [Professional]
    ><strong class="div_strong_method">loads xml content from specified string<strong>
    ><span>
    Topic(s): data manipulation;
    ><font class="exem">File required:<font>dhtmlxgrid.js><div>
    lockRow(rowId,mode)
    ><strong class="div_strong_method">lockunlock row for editing
    ><span>
    Topic(s):
    ><font class="exem">File required:<font>dhtmlxgrid.js
  • rowId - id of row
  • mode - true/false - lock/unlock
    • ><div>
    makeFilter(...) [Professional]
    ><strong class="div_strong_method">create a filter from any input element (text filter), select (dropdown) or DIV (combobox based on dhtmlxCombo)<strong>
    ><span>
    Topic(s):
    ><font class="exem">File required:<font>dhtmlxgrid_filter.js><div>
    makePivot(cont,details)
    ><strong class="div_strong_method">show pivot table based on grid<strong>
    ><span>
    Topic(s):
    ><font class="exem">File required:<font>dhtmlxgrid_pivot.js
  • cont - html container in which pivot rendered, but default pivot will be rendered over existing grid
    • ><div>
    makeSearch(...) [Professional]
    ><strong class="div_strong_method">create a search box (set selection to the row with found value) from any input<strong>
    ><span>
    Topic(s):
    ><font class="exem">File required:<font>dhtmlxgrid_filter.js><div>
    moveColumn(...) [Professional]
    ><strong class="div_strong_method">moves column of specified index to new position<strong>
    ><span>
    Topic(s):
    ><font class="exem">File required:<font>dhtmlxgrid_mcol.js><div>
    moveRow(...) [Professional]
    ><strong class="div_strong_method">move row<strong>
    ><span>
    Topic(s):
    ><font class="exem">File required:<font>dhtmlxgrid_drag.js><div>
    moveRowDown(row_id)
    ><strong class="div_strong_method">moves row one position down if possible<strong>
    ><span>
    Topic(s):
    ><font class="exem">File required:<font>dhtmlxgrid.js
  • row_id - row id
    • ><div>
    moveRowTo(...) [Professional]
    ><strong class="div_strong_method">move row<strong>
    ><span>
    Topic(s):
    ><font class="exem">File required:<font>dhtmlxgrid_drag.js
    ><font class="exem">Returns:<font>moved item ID><div>
    moveRowUp(row_id)
    ><strong class="div_strong_method">moves row one position up if possible<strong>
    ><span>
    Topic(s):
    ><font class="exem">File required:<font>dhtmlxgrid.js
  • row_id - row id
    • ><div>
    openItem(...) [Professional]
    ><strong class="div_strong_method">expand row<strong>
    ><span>
    Topic(s):
    ><font class="exem">File required:<font>dhtmlxtreegrid.js><div>
    parseXML(xml,startIndex)
    ><strong class="div_strong_method">populate grid with data from xml file (if passed parameter contains '.') or data island<strong>
    ><span>
    Topic(s): data manipulation;
    ><font class="exem">File required:<font>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
    • ><div>
    pasteBlockFromClipboard()
    ><strong class="div_strong_method">paste content of clipboard into block selection of grid<strong>
    ><span>
    Topic(s):
    ><font class="exem">File required:<font>dhtmlxgrid_selection.js><div>
    preventIECaching(mode)
    ><strong class="div_strong_method">prevent caching in IE by adding random values to URL string<strong>
    ><span>
    Topic(s): treegrid;
    ><font class="exem">File required:<font>dhtmlxgrid.js
  • mode - enable/disable random values in URLs ( disabled by default )
    • ><div>
    printView(...) [Professional]
    ><strong class="div_strong_method">generate print friendly view<strong>
    ><span>
    Topic(s):
    ><font class="exem">File required:<font>dhtmlxgrid_nxml.js><div>
    refreshFilters(...) [Professional]
    ><strong class="div_strong_method">refresh filtering ( can be used if data in grid changed and filters need to be updated )<strong>
    ><span>
    Topic(s):
    ><font class="exem">File required:<font>dhtmlxgrid_filter.js><div>
    rowToClipboard(...) [Professional]
    ><strong class="div_strong_method">copy value of row to clipboard<strong>
    ><span>
    Topic(s):
    ><font class="exem">File required:<font>dhtmlxgrid_nxml.js><div>
    rowToDragElement(gridRowId)
    ><strong class="div_strong_method">redefine this method in your code to define how grid row values should be displaied while draging<strong>
    ><span>
    Topic(s):
    ><font class="exem">File required:<font>dhtmlxgrid_drag.js
  • gridRowId - id of grid row

    • ><font class="exem">Returns:<font>html string representing dragging row><div>
    saveOrderToCookie(...) [Professional]
    ><strong class="div_strong_method">save sorting order to cookie<strong>
    ><span>
    Topic(s):
    ><font class="exem">File required:<font>dhtmlxgrid_ssc.js><div>
    saveSizeToCookie(...) [Professional]
    ><strong class="div_strong_method">save grid layout to cookie<strong>
    ><span>
    Topic(s):
    ><font class="exem">File required:<font>dhtmlxgrid_ssc.js><div>
    saveSortingToCookie(...) [Professional]
    ><strong class="div_strong_method">save sorting order to cookie<strong>
    ><span>
    Topic(s):
    ><font class="exem">File required:<font>dhtmlxgrid_ssc.js><div>
    selectAll()
    ><strong class="div_strong_method">select all rows in grid, it doesn't fire any events<strong>
    ><span>
    Topic(s): cells controll;
    ><font class="exem">File required:<font>dhtmlxgrid.js
  • edit - switch selected cell to edit mode
    • ><div>
    selectCell(r,cInd,fl,preserve,edit,show)
    ><strong class="div_strong_method">set selection to specified row-cell<strong>
    ><span>
    Topic(s): cells controll;
    ><font class="exem">File required:<font>dhtmlxgrid.js
  • r - row object or row index
  • cInd - cell index
  • [fl] - true if to call onRowSelect function
  • preserve - preserve previously selected rows true/false (false by default)
  • edit - switch selected cell to edit mode
  • show - true/false - scroll row to view, true by defaul
    • ><div>
    selectRow(r,fl,preserve,show)
    ><strong class="div_strong_method">selects row (and first cell of it)<strong>
    ><span>
    Topic(s): rows control;
    ><font class="exem">File required:<font>dhtmlxgrid.js
  • r - row index or row object
  • fl - if true, then call function on select
  • preserve - preserve previously selected rows true/false (false by default)
  • show - true/false - scroll row to view, true by defaul
    • ><div>
    serialize(...) [Professional]
    ><strong class="div_strong_method">get actual xml of grid. The depth of serialization can be set with setSerializationLevel method<strong>
    ><span>
    Topic(s): overal control;
    ><font class="exem">File required:<font>dhtmlxgrid.js><div>
    serializeToCSV(...) [Professional]
    ><strong class="div_strong_method">serialize to CSV string<strong>
    ><span>
    Topic(s):
    ><font class="exem">File required:<font>dhtmlxgrid_nxml.js><div>
    setAwaitedRowHeight(height)
    ><strong class="div_strong_method">set height which will be used in smart rendering mode for row calculation, function need to be used if you use custom skin for grid which changes default row height<strong>
    ><span>
    Topic(s):
    ><font class="exem">File required:<font>dhtmlxgrid_srnd.js
  • {int} height - awaited height of row

    • ><font class="exem">Returns:<font>void><div>
    setCSVDelimiter(...) [Professional]
    ><strong class="div_strong_method">load grid from CSV string<strong>
    ><span>
    Topic(s):
    ><font class="exem">File required:<font>dhtmlxgrid_nxml.js><div>
    setCellExcellType(...) [Professional]
    ><strong class="div_strong_method">set excell type for cell in question<strong>
    ><span>

    ><font class="exem">File required:<font>dhtmlxgrid.js><div>
    setCellTextStyle(row_id,ind,styleString)
    ><strong class="div_strong_method">sets style to cell<strong>
    ><span>
    Topic(s): appearence control;
    ><font class="exem">File required:<font>dhtmlxgrid.js
  • row_id - row id
  • ind - cell index
  • styleString - style string in common format (exmpl: "color:red;border:1px solid gray;")
    • ><div>
    setColAlign(alStr)
    ><strong class="div_strong_method">set align of values in columns<strong>
    ><span>
    Topic(s): colums control;
    ><font class="exem">File required:<font>dhtmlxgrid.js
  • alStr - list of align values (possible values are: right,left,center,justify). Default delimiter is ","
    • ><div>
    setColSorting(sortStr)
    ><strong class="div_strong_method">set column sort types (avaialble: str, int, date, na or function object for custom sorting)<strong>
    ><span>
    Topic(s): colums control; cells controll;
    ><font class="exem">File required:<font>dhtmlxgrid.js
  • sortStr - sort codes list with default delimiter
    • ><div>
    setColTypes(typeStr)
    ><strong class="div_strong_method">set column types<strong>
    ><span>
    Topic(s): colums control; cells controll;
    ><font class="exem">File required:<font>dhtmlxgrid.js
  • typeStr - type codes list (default delimiter is ",")
    • ><div>
    setColVAlign(valStr)
    ><strong class="div_strong_method">set vertical align of columns<strong>
    ><span>
    Topic(s): colums control;
    ><font class="exem">File required:<font>dhtmlxgrid.js
  • valStr - vertical align values list for columns (possible values are: baseline,sub,super,top,text-top,middle,bottom,text-bottom)
    • ><div>
    setColWidth(ind,value)
    ><strong class="div_strong_method">sets width of specified column in pixels (soen't works with procent based grid)<strong>
    ><span>
    Topic(s): overal control;
    ><font class="exem">File required:<font>dhtmlxgrid.js
  • ind - column index
  • value - new width value
    • ><div>
    setColspan(...) [Professional]
    ><strong class="div_strong_method">dynamicaly set colspan in row starting from specified column index<strong>
    ><span>
    Topic(s): treegrid;
    ><font class="exem">File required:<font>dhtmlxgrid.js><div>
    setColumnColor(clr)
    ><strong class="div_strong_method">colorize columns background.<strong>
    ><span>
    Topic(s): appearence control;
    ><font class="exem">File required:<font>dhtmlxgrid.js
  • clr - colors list
    • ><div>
    setColumnExcellType(...) [Professional]
    ><strong class="div_strong_method">set excell type for all cells in specified column<strong>
    ><span>

    ><font class="exem">File required:<font>dhtmlxgrid.js><div>
    setColumnHidden(...) [Professional]
    ><strong class="div_strong_method">hideshow column
    ><span>

    ><font class="exem">File required:<font>dhtmlxgrid.js><div>
    setColumnId(ind, id)
    ><strong class="div_strong_method">sets ids to specified column.<strong>
    ><span>
    Topic(s):
    ><font class="exem">File required:<font>dhtmlxgrid.js
  • ind- index of column
  • id- id of column
    • ><div>
    setColumnIds(ids)
    ><strong class="div_strong_method">sets ids to every column. Can be used then to retreive the index of the desired colum<strong>
    ><span>
    Topic(s):
    ><font class="exem">File required:<font>dhtmlxgrid.js
  • [ids] - delimitered list of ids (default delimiter is ","), or empty if to use values set earlier
    • ><div>
    setColumnLabel(c,label,ind)
    ><strong class="div_strong_method">sets new column header label<strong>
    ><span>
    Topic(s): appearence control;
    ><font class="exem">File required:<font>dhtmlxgrid.js
  • col - header column index
  • label - new label for the cpecified header's column. Can contai img:[imageUrl]Text Label
  • ind - header row index (default is 0)
    • ><div>
    setColumnMinWidth(width,ind)
    ><strong class="div_strong_method">set minimum column width ( works only for manual resizing )<strong>
    ><span>
    Topic(s):
    ><font class="exem">File required:<font>dhtmlxgrid.js
  • width - minimum column width, can be set for specified column, or as comma separated list for all columns
  • ind - column index
    • ><div>
    setColumnsVisibility(...) [Professional]
    ><strong class="div_strong_method">set list of visiblehidden columns
    ><span>
    Topic(s): initialization;
    ><font class="exem">File required:<font>dhtmlxgrid.js><div>
    setCustomSorting(...) [Professional]
    ><strong class="div_strong_method">set custom sorting (custom sort has three params - valueA,valueB,order; where order can be asc or des)<strong>
    ><span>
    Topic(s):
    ><font class="exem">File required:<font>dhtmlxgrid.js><div>
    setDateFormat(...) [Professional]
    ><strong class="div_strong_method">set mask for date formatting in cell<strong>
    ><span>
    Topic(s):
    ><font class="exem">File required:<font>dhtmlxgrid.js><div>
    setDelimiter(delim)
    ><strong class="div_strong_method">set delimiter character used in list values (default is ",")<strong>
    ><span>
    Topic(s):
    ><font class="exem">File required:<font>dhtmlxgrid.js
  • delim - delimiter as string
    • ><div>
    setDragBehavior(mode)
    ><strong class="div_strong_method">set Drag-And-Drop behavior (child - drop as chils, sibling - drop as sibling<strong>
    ><span>
    Topic(s):
    ><font class="exem">File required:<font>dhtmlxgrid_drag.js
  • mode - behavior name (child,sibling,complex)
    • ><div>
    setDragText(single,plural)
    ><strong class="div_strong_method">define text (single and plural forms) for extended visual appearence of drag-n-drop<strong>
    ><span>

    ><font class="exem">File required:<font>dhtmlx_extdrag.js
  • single - single form (like "product")
  • plural - plural form (if omitted, then "s" will be added to single form)
    • ><div>
    setEditable(fl)
    ><strong class="div_strong_method">manage editibility of the grid<strong>
    ><span>
    Topic(s):
    ><font class="exem">File required:<font>dhtmlxgrid.js
  • [fl] - set not editable if FALSE, set editable otherwise
    • ><div>
    setHeader(hdrStr,splitSign,styles)
    ><strong class="div_strong_method">set header label and default params for new headers<strong>
    ><span>
    Topic(s): colums control;
    ><font class="exem">File required:<font>dhtmlxgrid.js
  • hdrStr - header string with delimiters
  • splitSign - string used as a split marker, optional. Default is "#cspan"
  • styles - array of header styles
    • ><div>
    setHeaderCol(c,label,ind)
    ><strong class="div_strong_method">sets new column header label<strong>
    ><span>
    Topic(s): appearence control;
    ><font class="exem">File required:<font>dhtmlxgrid.js
  • col - header column index
  • label - new label for the cpecified header's column. Can contai img:[imageUrl]Text Label
  • ind - header row index (default is 0)
    • ><div>
    setImagePath(path)
    ><strong class="div_strong_method">set path to grid internal images (sort direction, any images used in editors, checkbox, radiobutton)<strong>
    ><span>
    Topic(s): overal control;
    ><font class="exem">File required:<font>dhtmlxgrid.js
  • path - url (or relative path) of images folder with closing "/"
    • ><div>
    setImageSize(...) [Professional]
    ><strong class="div_strong_method">set size of treegrid images<strong>
    ><span>
    Topic(s):
    ><font class="exem">File required:<font>dhtmlxtreegrid.js><div>
    setInitWidths(wp)
    ><strong class="div_strong_method">set width of columns in pixels<strong>
    ><span>
    Topic(s): overal control;
    ><font class="exem">File required:<font>dhtmlxgrid.js
  • wp - list of column width in pixels
    • ><div>
    setInitWidthsP(wp)
    ><strong class="div_strong_method">set width of columns in percents<strong>
    ><span>
    Topic(s): overal control;
    ><font class="exem">File required:<font>dhtmlxgrid.js
  • wp - list of column width in percents
    • ><div>
    setItemCloseable(...) [Professional]
    ><strong class="div_strong_method">enabledisable closing of row
    ><span>
    Topic(s):
    ><font class="exem">File required:<font>dhtmlxtreegrid.js><div>
    setItemImage(...) [Professional]
    ><strong class="div_strong_method">set image of tree col<strong>
    ><span>
    Topic(s):
    ><font class="exem">File required:<font>dhtmlxtreegrid.js><div>
    setItemText(...) [Professional]
    ><strong class="div_strong_method">set real caption of tree col<strong>
    ><span>
    Topic(s):
    ><font class="exem">File required:<font>dhtmlxtreegrid.js><div>
    setMathRound(...) [Professional]
    ><strong class="div_strong_method">enabledisable rounding while math calculations
    ><span>

    ><font class="exem">File required:<font>dhtmlxgrid_math.js><div>
    setNoHeader(fl)
    ><strong class="div_strong_method">create grid with no header. Call before initialization<strong>
    ><span>
    Topic(s): overal control;
    ><font class="exem">File required:<font>dhtmlxgrid.js
  • fl - true to use no header in the grid
    • ><div>
    setNoRecordsString(...) [Professional]
    ><strong class="div_strong_method">sets string to show in records info when no records in grid<strong>
    ><span>
    Topic(s):
    ><font class="exem">File required:<font>dhtmlxgrid_pgn.js><div>
    setNumberFormat(...) [Professional]
    ><strong class="div_strong_method">set mask for formatting numeric data ( works for [edro]n excell only or oher cell types with suport for this method)
    ><span>
    Topic(s):
    ><font class="exem">File required:<font>dhtmlxgrid.js><div>
    setOnKeyPressed(func)
    ><strong class="div_strong_method">changes grid's container size on the fly to fit total width of grid columns<strong>
    ><span>

    ><font class="exem">File required:<font>dhtmlxgrid.js
  • mode - truse/false - enable / disable
  • max_limit - max allowed width, not limited by default
  • min_limit - min allowed width, not limited by default
    • ><div>
    setOnKeyPressed(func)
    ><strong class="div_strong_method">changes grid's container size on the fly to fit total width of grid columns<strong>
    ><span>

    ><font class="exem">File required:<font>dhtmlxgrid.js
  • mode - truse/false - enable / disable
  • max_limit - max allowed width, not limited by default
  • min_limit - min allowed width, not limited by default
    • ><div>
    setOnOpenEndHandler(func)
    ><strong class="div_strong_method">set function called after tree node openedclosed
    ><span>

    ><fieldset><legend>Event<legend>Name:onOpenEnd
    >Event raised immideatly after item in tree got command to openclose , and before item was opened//closed. Event also raised for unclosable nodes and nodes without open/close functionality - in that case result of function will be ignored.
  • ID of node which will be opened/closed
  • Current open state of tree item. -1 - item closed, 1 - item opened.
    • Topic(s): event handlers;
    ><font class="exem">File required:<font>dhtmlxtreegrid.js
  • func - event handling function
    • ><div>
    setOnOpenStartHandler(func)
    ><strong class="div_strong_method">set function called before tree node openedclosed
    ><span>

    ><fieldset><legend>Event<legend>Name:onOpenStart
    >Event raised immideatly after item in tree got command to openclose , and before item was opened//closed. Event also raised for unclosable nodes and nodes without open/close functionality - in that case result of function will be ignored.
  • ID of node which will be opened/closed
  • Current open state of tree item. -1 - item closed, 1 - item opened.

    • ><font class="exem">Event returns:<font>true - confirm opening/closing; false - deny opening/closing;Topic(s): event handlers;
    ><font class="exem">File required:<font>dhtmlxtreegrid.js
  • func - event handling function
    • ><div>
    setOnPageChanged(...) [Professional]
    ><strong class="div_strong_method">set event handler to handle page changing (paginal output)<strong>
    ><span>
    Topic(s): paginal output;
    ><font class="exem">File required:<font>dhtmlxgrid_pgn.js><div>
    setOnPaging(...) [Professional]
    ><strong class="div_strong_method">capture event of paging block creation<strong>
    ><span>
    Topic(s): paginal output;
    ><font class="exem">File required:<font>dhtmlxgrid_pgn.js><div>
    setPagePrefix(...) [Professional]
    ><strong class="div_strong_method">sets string to show before pages output in paginal output, like "Result Page: "<strong>
    ><span>
    Topic(s):
    ><font class="exem">File required:<font>dhtmlxgrid_pgn.js><div>
    setPageSize(...) [Professional]
    ><strong class="div_strong_method">set new size of page in paging mode<strong>
    ><span>
    Topic(s):
    ><font class="exem">File required:<font>dhtmlxgrid_pgn.js><div>
    setPagingBlockParent(...) [Professional]
    ><strong class="div_strong_method">moves paging block to new parent element<strong>
    ><span>
    Topic(s):
    ><font class="exem">File required:<font>dhtmlxgrid_pgn.js><div>
    setPagingWTMode(...) [Professional]
    ><strong class="div_strong_method">configure paging with toolbar mode ( must be called BEFORE enablePagingWT )<strong>
    ><span>

    ><font class="exem">File required:<font>dhtmlxgrid_pgn.js><div>
    setRecordsInfoParent(...) [Professional]
    ><strong class="div_strong_method">sets(moves) records info block to new parent element<strong>
    ><span>
    Topic(s):
    ><font class="exem">File required:<font>dhtmlxgrid_pgn.js><div>
    setRecordsInfoTemplate(...) [Professional]
    ><strong class="div_strong_method">set template of Record Info block in paginal output<strong>
    ><span>
    Topic(s):
    ><font class="exem">File required:<font>dhtmlxgrid_pgn.js><div>
    setRowColor(row_id,color)
    ><strong class="div_strong_method">sets background color of row (via bgcolor attribute)<strong>
    ><span>
    Topic(s): appearence control;
    ><font class="exem">File required:<font>dhtmlxgrid.js
  • row_id - row id
  • color - color value
    • ><div>
    setRowExcellType(...) [Professional]
    ><strong class="div_strong_method">set excell type for all cells in specified row<strong>
    ><span>

    ><font class="exem">File required:<font>dhtmlxgrid.js><div>
    setRowHidden(id,state)
    ><strong class="div_strong_method">hideshow row (warning! - this command doesn't affect row indexes, only visual appearance)
    ><span>

    ><font class="exem">File required:<font>dhtmlxgrid.js
  • ind - column index
  • state - true/false - hide/show row
    • ><div>
    setRowId(ind,row_id)
    ><strong class="div_strong_method">sets new id for row by its index<strong>
    ><span>
    Topic(s):
    ><font class="exem">File required:<font>dhtmlxgrid.js
  • ind - row index
  • row_id - new row id
    • ><div>
    setRowTextBold(row_id)
    ><strong class="div_strong_method">sets row text BOLD<strong>
    ><span>
    Topic(s): appearence control;
    ><font class="exem">File required:<font>dhtmlxgrid.js
  • row_id - row id
    • ><div>
    setRowTextNormal(row_id)
    ><strong class="div_strong_method">sets row text weight to normal<strong>
    ><span>
    Topic(s): appearence control;
    ><font class="exem">File required:<font>dhtmlxgrid.js
  • row_id - row id
    • ><div>
    setRowTextStyle(row_id,styleString)
    ><strong class="div_strong_method">sets style to row<strong>
    ><span>
    Topic(s): appearence control;
    ><font class="exem">File required:<font>dhtmlxgrid.js
  • row_id - row id
  • styleString - style string in common format (exmpl: "color:red;border:1px solid gray;")
    • ><div>
    setRowspan(rowID,colInd,length)
    ><strong class="div_strong_method">set rowspan with specified length starting from specified cell<strong>
    ><span>

    ><font class="exem">File required:<font>dhtmlxgrid_rowspan.js
  • rowID - row Id
  • colInd - column index
  • length - length of rowspan
    • ><div>
    setScrollbarWidthCorrection(width)
    ><strong class="div_strong_method">set width of browser scrollbars, will be used to correct autoWidth calculations (by default grid uses 16 for IE and 19 pixels for FF)<strong>
    ><span>
    Topic(s):
    ><font class="exem">File required:<font>dhtmlxgrid.js
  • width - scrollbar width
    • ><div>
    setSerializableColumns(...) [Professional]
    ><strong class="div_strong_method">configure which column must be serialized (if you do not use this method, then all columns will be serialized)<strong>
    ><span>
    Topic(s): data manipulation; overal control;
    ><font class="exem">File required:<font>dhtmlxgrid.js><div>
    setSerializationLevel(...) [Professional]
    ><strong class="div_strong_method">configure XML serialization<strong>
    ><span>
    Topic(s): data manipulation; overal control;
    ><font class="exem">File required:<font>dhtmlxgrid.js><div>
    setSkin(name)
    ><strong class="div_strong_method">set one of predefined css styles (xp, mt, gray, light, clear, modern)<strong>
    ><span>
    Topic(s): appearence control;
    ><font class="exem">File required:<font>dhtmlxgrid.js
  • name - style name
    • ><div>
    setSortImgState(state,ind,order,row)
    ><strong class="div_strong_method">sets position and visibility of sort arrow<strong>
    ><span>
    Topic(s):
    ><font class="exem">File required:<font>dhtmlxgrid.js
  • state - true/false - show/hide image
  • ind - index of field
  • order - asc/desc - type of image
  • row - zero based index of header row ( used in multirow headers, top row by default )
    • ><div>
    setStyle(ss_header,ss_grid,ss_selCell,ss_selRow)
    ><strong class="div_strong_method">modify default style of grid and its elements. Call before or after Init<strong>
    ><span>
    Topic(s): appearence control;
    ><font class="exem">File required:<font>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
    • ><div>
    setTabOrder(order)
    ><strong class="div_strong_method">set tab order of columns<strong>
    ><span>

    ><font class="exem">File required:<font>dhtmlxgrid.js
  • order - list of tab indexes (default delimiter is ",")
    • ><div>
    setUserData(row_id,name,value)
    ><strong class="div_strong_method">sets user data to row<strong>
    ><span>
    Topic(s): data manipulation;
    ><font class="exem">File required:<font>dhtmlxgrid.js
  • row_id - row id. if empty then user data is set for grid (not row)
  • name - name of user data block
  • value - value of user data block
    • ><div>
    setXMLAutoLoading(filePath,bufferSize)
    ><strong class="div_strong_method">enables the possibility to load content from server when already loaded content was rendered. Using this feature you decrease the grid loading time for extremely big amounts of data ( in case of latest grid version, usage of SmartRendering instead of this mode strongly recommended )<strong>
    ><span>
    Topic(s): overal control;
    ><font class="exem">File required:<font>dhtmlxgrid.js
  • filePath - path which will be used for fetching additional data
  • bufferSize - size of client size buffer
    • ><div>
    showRow(rowID)
    ><strong class="div_strong_method">scrolls row to the visible area<strong>
    ><span>
    Topic(s): overal control;
    ><font class="exem">File required:<font>dhtmlxgrid.js
  • rowID - row id
    • ><div>
    sortRows(col,type,order)
    ><strong class="div_strong_method">sorts rows by specified column<strong>
    ><span>
    Topic(s): colums control; data manipulation; treegrid;
    ><font class="exem">File required:<font>dhtmlxgrid.js
  • col - column index
  • type - str.int.date
  • order - asc,desc
    • ><div>
    sortTreeRows(...) [Professional]
    ><strong class="div_strong_method">sorts treegrid by specified column<strong>
    ><span>
    Topic(s): colums control; data manipulation; treegrid;
    ><font class="exem">File required:<font>dhtmlxtreegrid.js><div>
    splitAt(...) [Professional]
    ><strong class="div_strong_method">split grid in two parts, with separate scrolling<strong>
    ><span>

    ><font class="exem">File required:<font>dhtmlxgrid_splt.js><div>
    startFastOperations()
    ><strong class="div_strong_method">start fast operation mode, in such mode events are not generated, some time consuming actions applied only once, which allow to increase performance<strong>
    ><span>
    Topic(s):
    ><font class="exem">File required:<font>dhtmlxgrid_fast.js><div>
    stopFastOperations()
    ><strong class="div_strong_method">turn off fast operation mode, need to be executed to normalize view.<strong>
    ><span>
    Topic(s):
    ><font class="exem">File required:<font>dhtmlxgrid_fast.js><div>
    submitAddedRows(mode)
    ><strong class="div_strong_method">include additional data with info about which rows was added and which deleted, enabled by default<strong>
    ><span>
    Topic(s):
    ><font class="exem">File required:<font>dhtmlxgrid_form.js
  • mode - {boolean} enable|disable mode
    • ><div>
    submitOnlyChanged(mode)
    ><strong class="div_strong_method">include only changed rows in form submit<strong>
    ><span>
    Topic(s):
    ><font class="exem">File required:<font>dhtmlxgrid_form.js
  • mode - {boolean} enable|disable mode
    • ><div>
    submitOnlyRowID(mode)
    ><strong class="div_strong_method">include only row's IDS in form submit<strong>
    ><span>
    Topic(s):
    ><font class="exem">File required:<font>dhtmlxgrid_form.js
  • mode - {boolean} enable|disable mode
    • ><div>
    submitOnlySelected(mode)
    ><strong class="div_strong_method">include only selected rows in form submit<strong>
    ><span>
    Topic(s):
    ><font class="exem">File required:<font>dhtmlxgrid_form.js
  • mode - {boolean} enable|disable mode
    • ><div>
    treeToGridElement(...) [Professional]
    ><strong class="div_strong_method">redefine this method in your code to define how tree node values should be used in grid (using input parameters you can change id of new row, values for cells, userdata blocks etc.).<strong>
    ><span>
    Topic(s):
    ><font class="exem">File required:<font>dhtmlxgrid_drag.js
    ><font class="exem">Returns:<font>if true, then tree node should be moved to grid, else - copied><div>
    updateCellFromClipboard(...) [Professional]
    ><strong class="div_strong_method">set value of cell from clipboard<strong>
    ><span>
    Topic(s):
    ><font class="exem">File required:<font>dhtmlxgrid_nxml.js><div>
    updateFromXML(url,insert_new,del_missed,afterCall)
    ><strong class="div_strong_method">refresh grid from XML ( doesnt work for buffering, tree grid or rows in smart rendering mode )<strong>
    ><span>

    ><font class="exem">File required:<font>dhtmlxgrid.js
  • insert_new - insert new items
  • del_missed - delete missed rows
  • afterCall - function, will be executed after refresh completted
    • ><div>
    updateRowFromClipboard(...) [Professional]
    ><strong class="div_strong_method">set value of row from clipboard<strong>
    ><span>
    Topic(s):
    ><font class="exem">File required:<font>dhtmlxgrid_nxml.js><div>><div>

    eXcell object API

    ><div>

    eXcell_ed object API

    ><div>

    eXcell_edtxt object API

    ><div>

    eXcell_edn object API

    ><div>

    eXcell_ch object API

    ><div>

    eXcell_ra object API

    ><div>

    eXcell_txt object API

    ><div>

    eXcell_txttxt object API

    ><div>

    eXcell_co object API

    ><div>

    eXcell_coro object API

    ><div>

    eXcell_cp object API

    ><div>

    eXcell_img object API

    ><div>

    eXcell_price object API

    ><div>

    eXcell_dyn object API

    ><div>

    eXcell_ro object API

    ><div>

    eXcell_rotxt object API

    ><div>

    eXcell_tree object API

    getLabel(val)
    ><strong class="div_strong_method">sets text representation of cell ( setLabel doesn't triger math calculations as setValue do)<strong>
    ><span>

    ><font class="exem">File required:<font>dhtmlxtreegrid.js
  • val - new value
    • ><div>
    setLabel(val)
    ><strong class="div_strong_method">sets text representation of cell ( setLabel doesn't triger math calculations as setValue do)<strong>
    ><span>

    ><font class="exem">File required:<font>dhtmlxtreegrid.js
  • val - new value
    • ><div>><div>

    Powered by Plone CMS, the Open Source Content Management System