[ Mini Kiebo ]
Server: Windows NT DESKTOP-5B8S0D4 6.2 build 9200 (Windows 8 Professional Edition) i586
Path:
D:
/
Backup
/
05122024
/
htdocs
/
simpeg
/
zapatec
/
zpgrid
/
zpgrid
/
jsdocs
/
Zapatec
/
[
Home
]
File: Grid.html
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN""http://www.w3.org/TR/REC-html40/loose.dtd"> <!--NewPage--> <HTML> <HEAD> <TITLE> Zapatec.Grid </TITLE> <LINK REL ="stylesheet" TYPE="text/css" HREF="../stylesheet.css" TITLE="Style"> </HEAD> <SCRIPT> function asd() { parent.document.title="Zapatec.Grid"; } </SCRIPT> <BODY BGCOLOR="white" onload="asd();"> <!-- ========== START OF NAVBAR ========== --> <A NAME="navbar_bottom"><!-- --></A> <TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0"> <TR> <TD COLSPAN=3 BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A NAME="navbar_bottom_firstrow"><!-- --></A> <TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3"> <TR ALIGN="center" VALIGN="top"> <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../overview-summary.html"><FONT CLASS="NavBarFont1"><B>Overview</B></FONT></A> </TD> <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../overview-summary-zpgrid-core.js.html"><FONT CLASS="NavBarFont1"><B>File</B></FONT></A> </TD> <TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> <FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT> </TD> <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../overview-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A> </TD> <!--TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"--> <!--A HREF="deprecated-list.html"--><!--FONT CLASS="NavBarFont1">Deprecated</FONT--><!--/A--><!-- </TD--> <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../index-all.html"--><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A> </TD> <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A> </TD> </TR> </TABLE> </TD> <TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM> <B>Zapatec Grid</B> </EM> </TD </TR> <TR> <TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2"> <A HREF="../Zapatec/EditableGrid.html"><B>PREV CLASS</B></A><!-- NEXT CLASS --> <A HREF="../Zapatec/GridQuery.html"><B>NEXT CLASS</B></A></FONT></TD> <TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2"> <A HREF="../index.html" TARGET="_top"><B>FRAMES</B></A> <A HREF="" TARGET="_top"><B>NO FRAMES</B></A> <SCRIPT> <!-- if(window==top) { document.writeln('<A HREF="../allclasses-noframe.html" TARGET=""><B>All Classes</B></A>'); } //--> </SCRIPT> <NOSCRIPT> <A HREF="../allclasses-noframe.html" TARGET=""><B>All Classes</B></A> </NOSCRIPT> </FONT></TD> </TR> <TR> <TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2"> SUMMARY: <A HREF="#field_summary">FIELD</A> | <A HREF="#constructor_summary">CONSTR</A> | <A HREF="#method_summary">METHOD</A></FONT></TD> <TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2"> DETAIL: <A HREF="#field_detail">FIELD</A> | <A HREF="#constructor_detail">CONSTR</A> | <A HREF="#method_detail">METHOD</A></FONT></TD> </TR> </TABLE> <!-- =========== END OF NAVBAR =========== --> <HR> <!-- ======== START OF CLASS DATA ======== --> <H2>Class Zapatec.Grid</H2> <PRE>Object | +--Zapatec.Widget | +--<b>Zapatec.Grid</b> </PRE> <DL> <DT> <B>Direct Known Subclasses:</B> <DD> <a href='../Zapatec/GridToolbar.html'>Zapatec.GridToolbar</a>, <a href='../Zapatec/EditableGrid.html'>Zapatec.EditableGrid</a> </DD> </DL> <HR> <DL> <!-- Class definition --> <DT>class <B>Zapatec.Grid</B> <DT>extends Zapatec.Widget </DL> <P> <I>Defined in <a href='../overview-summary-zpgrid-core.js.html'>zpgrid-core.js</a></I><BR/><BR/> </P> <HR> <!-- ======== NESTED CLASS SUMMARY ======== --> <!-- ======== END NESTED CLASS SUMMARY ======== --> <!-- =========== FIELD SUMMARY =========== --> <!-- =========== END FIELD SUMMARY =========== --> <!-- ======== CONSTRUCTOR SUMMARY ======== --> <A NAME="constructor_summary"><!-- --></A> <TABLE BORDER="1" CELLPADDING="3" CELLSPACING="0" WIDTH="100%"> <TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor"> <TD COLSPAN=2><FONT SIZE="+2"> <B>Constructor Summary</B></FONT></TD> </TR> <TR BGCOLOR="white" CLASS="TableRowColor"> <TD> <CODE> <B> <A HREF="#Zapatec.Grid()">Zapatec.Grid</A></B>(<object> oArg) </CODE> <BR> Grid core. </TD> </TR> </TABLE> <!-- ======== END CONSTRUCTOR SUMMARY ======== --> <!-- ========== METHOD SUMMARY =========== --> <A NAME="method_summary"><!-- --></A> <TABLE BORDER="1" CELLPADDING="3" CELLSPACING="0" WIDTH="100%"> <TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor"> <TD COLSPAN=2><FONT SIZE="+2"> <B>Method Summary</B></FONT></TD> </TR> <TR BGCOLOR="white" CLASS="TableRowColor"> <TD ALIGN="right" VALIGN="top" WIDTH="1%"> <FONT SIZE="-1"> <CODE> void</CODE> </FONT> </TD> <TD> <CODE> <B> <A HREF="#addFilterOut">addFilterOut</A></B>(<object> oArg) </CODE> <BR> Adds filter out to the Grid. </TD> </TR> <TR BGCOLOR="white" CLASS="TableRowColor"> <TD ALIGN="right" VALIGN="top" WIDTH="1%"> <FONT SIZE="-1"> <CODE> object</CODE> </FONT> </TD> <TD> <CODE> <B> <A HREF="#applyPaging">applyPaging</A></B>() </CODE> <BR> Returns array of rows that are or must be (depending on context) displayed on the current page. </TD> </TR> <TR BGCOLOR="white" CLASS="TableRowColor"> <TD ALIGN="right" VALIGN="top" WIDTH="1%"> <FONT SIZE="-1"> <CODE> void</CODE> </FONT> </TD> <TD> <CODE> <B> <A HREF="#autoresize">autoresize</A></B>() </CODE> <BR> Adjusts number of rows per page in the grid when <b>fitInto</b> config option is used. </TD> </TR> <TR BGCOLOR="white" CLASS="TableRowColor"> <TD ALIGN="right" VALIGN="top" WIDTH="1%"> <FONT SIZE="-1"> <CODE> void</CODE> </FONT> </TD> <TD> <CODE> <B> <A HREF="#changeColumnWidth">changeColumnWidth</A></B>(<string> iWidth) </CODE> <BR> Changes width of all columns. </TD> </TR> <TR BGCOLOR="white" CLASS="TableRowColor"> <TD ALIGN="right" VALIGN="top" WIDTH="1%"> <FONT SIZE="-1"> <CODE> void</CODE> </FONT> </TD> <TD> <CODE> <B> <A HREF="#clearSelection">clearSelection</A></B>() </CODE> <BR> Unselects all selected rows and cells. </TD> </TR> <TR BGCOLOR="white" CLASS="TableRowColor"> <TD ALIGN="right" VALIGN="top" WIDTH="1%"> <FONT SIZE="-1"> <CODE> object</CODE> </FONT> </TD> <TD> <CODE> <B> <A HREF="#convertBoolean">convertBoolean</A></B>(<object> oCell) </CODE> <BR> Converts cell to boolean data type. </TD> </TR> <TR BGCOLOR="white" CLASS="TableRowColor"> <TD ALIGN="right" VALIGN="top" WIDTH="1%"> <FONT SIZE="-1"> <CODE> object</CODE> </FONT> </TD> <TD> <CODE> <B> <A HREF="#convertBooleanTF">convertBooleanTF</A></B>(<object> oCell) </CODE> <BR> Converts cell to boolean data type. </TD> </TR> <TR BGCOLOR="white" CLASS="TableRowColor"> <TD ALIGN="right" VALIGN="top" WIDTH="1%"> <FONT SIZE="-1"> <CODE> object</CODE> </FONT> </TD> <TD> <CODE> <B> <A HREF="#convertDate">convertDate</A></B>(<object> oCell) </CODE> <BR> Converts cell to date data type. </TD> </TR> <TR BGCOLOR="white" CLASS="TableRowColor"> <TD ALIGN="right" VALIGN="top" WIDTH="1%"> <FONT SIZE="-1"> <CODE> object</CODE> </FONT> </TD> <TD> <CODE> <B> <A HREF="#convertFloat">convertFloat</A></B>(<object> oCell) </CODE> <BR> Converts cell to float data type. </TD> </TR> <TR BGCOLOR="white" CLASS="TableRowColor"> <TD ALIGN="right" VALIGN="top" WIDTH="1%"> <FONT SIZE="-1"> <CODE> object</CODE> </FONT> </TD> <TD> <CODE> <B> <A HREF="#convertFloatGerman">convertFloatGerman</A></B>(<object> oCell) </CODE> <BR> Converts cell containing number in German format to float data type. </TD> </TR> <TR BGCOLOR="white" CLASS="TableRowColor"> <TD ALIGN="right" VALIGN="top" WIDTH="1%"> <FONT SIZE="-1"> <CODE> object</CODE> </FONT> </TD> <TD> <CODE> <B> <A HREF="#convertInsensitiveString">convertInsensitiveString</A></B>(<object> oCell) </CODE> <BR> Converts cell to insensitive string data type. </TD> </TR> <TR BGCOLOR="white" CLASS="TableRowColor"> <TD ALIGN="right" VALIGN="top" WIDTH="1%"> <FONT SIZE="-1"> <CODE> object</CODE> </FONT> </TD> <TD> <CODE> <B> <A HREF="#convertInteger">convertInteger</A></B>(<object> oCell) </CODE> <BR> Converts cell to integer data type. </TD> </TR> <TR BGCOLOR="white" CLASS="TableRowColor"> <TD ALIGN="right" VALIGN="top" WIDTH="1%"> <FONT SIZE="-1"> <CODE> object</CODE> </FONT> </TD> <TD> <CODE> <B> <A HREF="#convertIntegerGerman">convertIntegerGerman</A></B>(<object> oCell) </CODE> <BR> Converts cell containing number in German format to integer data type. </TD> </TR> <TR BGCOLOR="white" CLASS="TableRowColor"> <TD ALIGN="right" VALIGN="top" WIDTH="1%"> <FONT SIZE="-1"> <CODE> object</CODE> </FONT> </TD> <TD> <CODE> <B> <A HREF="#convertString">convertString</A></B>(<object> oCell) </CODE> <BR> Converts cell to string data type. </TD> </TR> <TR BGCOLOR="white" CLASS="TableRowColor"> <TD ALIGN="right" VALIGN="top" WIDTH="1%"> <FONT SIZE="-1"> <CODE> object</CODE> </FONT> </TD> <TD> <CODE> <B> <A HREF="#convertTime">convertTime</A></B>(<object> oCell) </CODE> <BR> Converts cell to time data type. </TD> </TR> <TR BGCOLOR="white" CLASS="TableRowColor"> <TD ALIGN="right" VALIGN="top" WIDTH="1%"> <FONT SIZE="-1"> <CODE> object</CODE> </FONT> </TD> <TD> <CODE> <B> <A HREF="#convertTimestampDDMMYYYY">convertTimestampDDMMYYYY</A></B>(<object> oCell) </CODE> <BR> Converts cell to UNIX timestamp data type. </TD> </TR> <TR BGCOLOR="white" CLASS="TableRowColor"> <TD ALIGN="right" VALIGN="top" WIDTH="1%"> <FONT SIZE="-1"> <CODE> object</CODE> </FONT> </TD> <TD> <CODE> <B> <A HREF="#convertTimestampLocale">convertTimestampLocale</A></B>(<object> oCell) </CODE> <BR> Converts cell to UNIX timestamp data type. </TD> </TR> <TR BGCOLOR="white" CLASS="TableRowColor"> <TD ALIGN="right" VALIGN="top" WIDTH="1%"> <FONT SIZE="-1"> <CODE> object</CODE> </FONT> </TD> <TD> <CODE> <B> <A HREF="#convertTimestampMMDDYYYY">convertTimestampMMDDYYYY</A></B>(<object> oCell) </CODE> <BR> Converts cell to UNIX timestamp data type. </TD> </TR> <TR BGCOLOR="white" CLASS="TableRowColor"> <TD ALIGN="right" VALIGN="top" WIDTH="1%"> <FONT SIZE="-1"> <CODE> object</CODE> </FONT> </TD> <TD> <CODE> <B> <A HREF="#convertTimestampYYYYMMDD">convertTimestampYYYYMMDD</A></B>(<object> oCell) </CODE> <BR> Converts cell to UNIX timestamp data type. </TD> </TR> <TR BGCOLOR="white" CLASS="TableRowColor"> <TD ALIGN="right" VALIGN="top" WIDTH="1%"> <FONT SIZE="-1"> <CODE> number</CODE> </FONT> </TD> <TD> <CODE> <B> <A HREF="#deleteColumns">deleteColumns</A></B>(<object> oArg) </CODE> <BR> Deletes specified columns. </TD> </TR> <TR BGCOLOR="white" CLASS="TableRowColor"> <TD ALIGN="right" VALIGN="top" WIDTH="1%"> <FONT SIZE="-1"> <CODE> void</CODE> </FONT> </TD> <TD> <CODE> <B> <A HREF="#displayFilterOut">displayFilterOut</A></B>() </CODE> <BR> Displays filter out forms. </TD> </TR> <TR BGCOLOR="white" CLASS="TableRowColor"> <TD ALIGN="right" VALIGN="top" WIDTH="1%"> <FONT SIZE="-1"> <CODE> void</CODE> </FONT> </TD> <TD> <CODE> <B> <A HREF="#editSelectedCells">editSelectedCells</A></B>(<object> oEditor) </CODE> <BR> Passes array of selected cells to the specified editor. </TD> </TR> <TR BGCOLOR="white" CLASS="TableRowColor"> <TD ALIGN="right" VALIGN="top" WIDTH="1%"> <FONT SIZE="-1"> <CODE> void</CODE> </FONT> </TD> <TD> <CODE> <B> <A HREF="#editSelectedRows">editSelectedRows</A></B>(<object> oEditor) </CODE> <BR> Passes array of selected rows to the specified editor. </TD> </TR> <TR BGCOLOR="white" CLASS="TableRowColor"> <TD ALIGN="right" VALIGN="top" WIDTH="1%"> <FONT SIZE="-1"> <CODE> object</CODE> </FONT> </TD> <TD> <CODE> <B> <A HREF="#exportDataJson">exportDataJson</A></B>(<string> strMode) </CODE> <BR> Exports grid data as object. </TD> </TR> <TR BGCOLOR="white" CLASS="TableRowColor"> <TD ALIGN="right" VALIGN="top" WIDTH="1%"> <FONT SIZE="-1"> <CODE> void</CODE> </FONT> </TD> <TD> <CODE> <B> <A HREF="#filterOut">filterOut</A></B>(<object> oArg) </CODE> <BR> Filters out rows with the specified value in the specified column or set of columns. </TD> </TR> <TR BGCOLOR="white" CLASS="TableRowColor"> <TD ALIGN="right" VALIGN="top" WIDTH="1%"> <FONT SIZE="-1"> <CODE> string</CODE> </FONT> </TD> <TD> <CODE> <B> <A HREF="#flatfile">flatfile</A></B>(<string> FS, <string> RS, <number> iMode) </CODE> <BR> Returns flatfile of grid. </TD> </TR> <TR BGCOLOR="white" CLASS="TableRowColor"> <TD ALIGN="right" VALIGN="top" WIDTH="1%"> <FONT SIZE="-1"> <CODE> object</CODE> </FONT> </TD> <TD> <CODE> <B> <A HREF="#getCellById">getCellById</A></B>(<number> iRowId, <number> iCellId) </CODE> <BR> Finds cell by its row id and cell id. </TD> </TR> <TR BGCOLOR="white" CLASS="TableRowColor"> <TD ALIGN="right" VALIGN="top" WIDTH="1%"> <FONT SIZE="-1"> <CODE> object</CODE> </FONT> </TD> <TD> <CODE> <B> <A HREF="#getCellByRow">getCellByRow</A></B>(<object> oRow, <number> iCellId) </CODE> <BR> Finds cell by its row and cell id. </TD> </TR> <TR BGCOLOR="white" CLASS="TableRowColor"> <TD ALIGN="right" VALIGN="top" WIDTH="1%"> <FONT SIZE="-1"> <CODE> string</CODE> </FONT> </TD> <TD> <CODE> <B> <A HREF="#getCellData">getCellData</A></B>(<object> oCell, <number> iMode) </CODE> <BR> Returns data to be displayed in grid cell. </TD> </TR> <TR BGCOLOR="white" CLASS="TableRowColor"> <TD ALIGN="right" VALIGN="top" WIDTH="1%"> <FONT SIZE="-1"> <CODE> string</CODE> </FONT> </TD> <TD> <CODE> <B> <A HREF="#getCellDataType">getCellDataType</A></B>(<object> oCell) </CODE> <BR> Returns cell data type. </TD> </TR> <TR BGCOLOR="white" CLASS="TableRowColor"> <TD ALIGN="right" VALIGN="top" WIDTH="1%"> <FONT SIZE="-1"> <CODE> object</CODE> </FONT> </TD> <TD> <CODE> <B> <A HREF="#getCellElement">getCellElement</A></B>(<object> oCell) </CODE> <BR> Returns table cell element or undefined if cell is on different page or not found. </TD> </TR> <TR BGCOLOR="white" CLASS="TableRowColor"> <TD ALIGN="right" VALIGN="top" WIDTH="1%"> <FONT SIZE="-1"> <CODE> number</CODE> </FONT> </TD> <TD> <CODE> <B> <A HREF="#getCellId">getCellId</A></B>(<object> oCell) </CODE> <BR> Returns cell id. </TD> </TR> <TR BGCOLOR="white" CLASS="TableRowColor"> <TD ALIGN="right" VALIGN="top" WIDTH="1%"> <FONT SIZE="-1"> <CODE> number</CODE> </FONT> </TD> <TD> <CODE> <B> <A HREF="#getCellRowId">getCellRowId</A></B>(<object> oCell) </CODE> <BR> Returns cell row id. </TD> </TR> <TR BGCOLOR="white" CLASS="TableRowColor"> <TD ALIGN="right" VALIGN="top" WIDTH="1%"> <FONT SIZE="-1"> <CODE> number</CODE> </FONT> </TD> <TD> <CODE> <B> <A HREF="#getCellRowNumber">getCellRowNumber</A></B>(<object> oCell) </CODE> <BR> Returns cell visible row number. </TD> </TR> <TR BGCOLOR="white" CLASS="TableRowColor"> <TD ALIGN="right" VALIGN="top" WIDTH="1%"> <FONT SIZE="-1"> <CODE> boolean</CODE> </FONT> </TD> <TD> <CODE> <B> <A HREF="#getCellSelected">getCellSelected</A></B>(<object> oCell) </CODE> <BR> Returns true if cell is selected. </TD> </TR> <TR BGCOLOR="white" CLASS="TableRowColor"> <TD ALIGN="right" VALIGN="top" WIDTH="1%"> <FONT SIZE="-1"> <CODE> string</CODE> </FONT> </TD> <TD> <CODE> <B> <A HREF="#getCellStyle">getCellStyle</A></B>(<object> oCell, <number> iRow) </CODE> <BR> Returns cell style defined by user. </TD> </TR> <TR BGCOLOR="white" CLASS="TableRowColor"> <TD ALIGN="right" VALIGN="top" WIDTH="1%"> <FONT SIZE="-1"> <CODE> any</CODE> </FONT> </TD> <TD> <CODE> <B> <A HREF="#getCellValue">getCellValue</A></B>(<object> oCell) </CODE> <BR> Returns cell value to display. </TD> </TR> <TR BGCOLOR="white" CLASS="TableRowColor"> <TD ALIGN="right" VALIGN="top" WIDTH="1%"> <FONT SIZE="-1"> <CODE> any</CODE> </FONT> </TD> <TD> <CODE> <B> <A HREF="#getCellValueCompare">getCellValueCompare</A></B>(<object> oCell) </CODE> <BR> Returns cell value to compare. </TD> </TR> <TR BGCOLOR="white" CLASS="TableRowColor"> <TD ALIGN="right" VALIGN="top" WIDTH="1%"> <FONT SIZE="-1"> <CODE> any</CODE> </FONT> </TD> <TD> <CODE> <B> <A HREF="#getCellValueOriginal">getCellValueOriginal</A></B>(<object> oCell) </CODE> <BR> Returns original cell value. </TD> </TR> <TR BGCOLOR="white" CLASS="TableRowColor"> <TD ALIGN="right" VALIGN="top" WIDTH="1%"> <FONT SIZE="-1"> <CODE> string</CODE> </FONT> </TD> <TD> <CODE> <B> <A HREF="#getCellValueString">getCellValueString</A></B>(<object> oCell) </CODE> <BR> Returns cell value to display as string. </TD> </TR> <TR BGCOLOR="white" CLASS="TableRowColor"> <TD ALIGN="right" VALIGN="top" WIDTH="1%"> <FONT SIZE="-1"> <CODE> string</CODE> </FONT> </TD> <TD> <CODE> <B> <A HREF="#getClassByType">getClassByType</A></B>(<string> sType) </CODE> <BR> Returns class name corresponding to data type. </TD> </TR> <TR BGCOLOR="white" CLASS="TableRowColor"> <TD ALIGN="right" VALIGN="top" WIDTH="1%"> <FONT SIZE="-1"> <CODE> object</CODE> </FONT> </TD> <TD> <CODE> <B> <A HREF="#getColumnRange">getColumnRange</A></B>(<object> oArg) </CODE> <BR> Returns range of values of the specified column. </TD> </TR> <TR BGCOLOR="white" CLASS="TableRowColor"> <TD ALIGN="right" VALIGN="top" WIDTH="1%"> <FONT SIZE="-1"> <CODE> string</CODE> </FONT> </TD> <TD> <CODE> <B> <A HREF="#getConvertByType">getConvertByType</A></B>(<string> sType) </CODE> <BR> Returns name of convert method corresponding to data type. </TD> </TR> <TR BGCOLOR="white" CLASS="TableRowColor"> <TD ALIGN="right" VALIGN="top" WIDTH="1%"> <FONT SIZE="-1"> <CODE> number</CODE> </FONT> </TD> <TD> <CODE> <B> <A HREF="#getCurrentPageNumber">getCurrentPageNumber</A></B>() </CODE> <BR> Returns current page number. </TD> </TR> <TR BGCOLOR="white" CLASS="TableRowColor"> <TD ALIGN="right" VALIGN="top" WIDTH="1%"> <FONT SIZE="-1"> <CODE> object</CODE> </FONT> </TD> <TD> <CODE> <B> <A HREF="#getFieldByCell">getFieldByCell</A></B>(<object> oCell) </CODE> <BR> Finds field by cell. </TD> </TR> <TR BGCOLOR="white" CLASS="TableRowColor"> <TD ALIGN="right" VALIGN="top" WIDTH="1%"> <FONT SIZE="-1"> <CODE> object</CODE> </FONT> </TD> <TD> <CODE> <B> <A HREF="#getFieldById">getFieldById</A></B>(<number> iFieldId) </CODE> <BR> Finds field by its id. </TD> </TR> <TR BGCOLOR="white" CLASS="TableRowColor"> <TD ALIGN="right" VALIGN="top" WIDTH="1%"> <FONT SIZE="-1"> <CODE> object</CODE> </FONT> </TD> <TD> <CODE> <B> <A HREF="#getFieldElement">getFieldElement</A></B>(<object> oField) </CODE> <BR> Returns table cell element or undefined if field is not found. </TD> </TR> <TR BGCOLOR="white" CLASS="TableRowColor"> <TD ALIGN="right" VALIGN="top" WIDTH="1%"> <FONT SIZE="-1"> <CODE> boolean</CODE> </FONT> </TD> <TD> <CODE> <B> <A HREF="#getFieldHidden">getFieldHidden</A></B>(<object> oField) </CODE> <BR> Returns true if field is hidden. </TD> </TR> <TR BGCOLOR="white" CLASS="TableRowColor"> <TD ALIGN="right" VALIGN="top" WIDTH="1%"> <FONT SIZE="-1"> <CODE> number</CODE> </FONT> </TD> <TD> <CODE> <B> <A HREF="#getFieldId">getFieldId</A></B>(<object> oField) </CODE> <BR> Returns field id. </TD> </TR> <TR BGCOLOR="white" CLASS="TableRowColor"> <TD ALIGN="right" VALIGN="top" WIDTH="1%"> <FONT SIZE="-1"> <CODE> boolean</CODE> </FONT> </TD> <TD> <CODE> <B> <A HREF="#getFieldNosort">getFieldNosort</A></B>(<object> oField) </CODE> <BR> Returns true if it is not allowed to sort the field. </TD> </TR> <TR BGCOLOR="white" CLASS="TableRowColor"> <TD ALIGN="right" VALIGN="top" WIDTH="1%"> <FONT SIZE="-1"> <CODE> string</CODE> </FONT> </TD> <TD> <CODE> <B> <A HREF="#getFieldOnclick">getFieldOnclick</A></B>(<object> oField) </CODE> <BR> Forms field onclick attribute value. </TD> </TR> <TR BGCOLOR="white" CLASS="TableRowColor"> <TD ALIGN="right" VALIGN="top" WIDTH="1%"> <FONT SIZE="-1"> <CODE> object</CODE> </FONT> </TD> <TD> <CODE> <B> <A HREF="#getFields">getFields</A></B>(<object> oArg) </CODE> <BR> Returns reference to private array containing grid fields. </TD> </TR> <TR BGCOLOR="white" CLASS="TableRowColor"> <TD ALIGN="right" VALIGN="top" WIDTH="1%"> <FONT SIZE="-1"> <CODE> boolean</CODE> </FONT> </TD> <TD> <CODE> <B> <A HREF="#getFieldSorted">getFieldSorted</A></B>(<object> oField) </CODE> <BR> Returns true if the field is sorted ascending. </TD> </TR> <TR BGCOLOR="white" CLASS="TableRowColor"> <TD ALIGN="right" VALIGN="top" WIDTH="1%"> <FONT SIZE="-1"> <CODE> boolean</CODE> </FONT> </TD> <TD> <CODE> <B> <A HREF="#getFieldSortedDesc">getFieldSortedDesc</A></B>(<object> oField) </CODE> <BR> Returns true if the field is sorted descending. </TD> </TR> <TR BGCOLOR="white" CLASS="TableRowColor"> <TD ALIGN="right" VALIGN="top" WIDTH="1%"> <FONT SIZE="-1"> <CODE> string</CODE> </FONT> </TD> <TD> <CODE> <B> <A HREF="#getFieldSpan">getFieldSpan</A></B>(<object> oField) </CODE> <BR> Returns field span value. </TD> </TR> <TR BGCOLOR="white" CLASS="TableRowColor"> <TD ALIGN="right" VALIGN="top" WIDTH="1%"> <FONT SIZE="-1"> <CODE> object</CODE> </FONT> </TD> <TD> <CODE> <B> <A HREF="#getFieldSpanned">getFieldSpanned</A></B>(<object> oField) </CODE> <BR> Returns spanned columns number and spanned fields array. </TD> </TR> <TR BGCOLOR="white" CLASS="TableRowColor"> <TD ALIGN="right" VALIGN="top" WIDTH="1%"> <FONT SIZE="-1"> <CODE> string</CODE> </FONT> </TD> <TD> <CODE> <B> <A HREF="#getFieldSpanStyle">getFieldSpanStyle</A></B>(<object> oField) </CODE> <BR> Returns field span style defined by user. </TD> </TR> <TR BGCOLOR="white" CLASS="TableRowColor"> <TD ALIGN="right" VALIGN="top" WIDTH="1%"> <FONT SIZE="-1"> <CODE> string</CODE> </FONT> </TD> <TD> <CODE> <B> <A HREF="#getFieldSpanTitle">getFieldSpanTitle</A></B>(<object> oField) </CODE> <BR> Returns field span title. </TD> </TR> <TR BGCOLOR="white" CLASS="TableRowColor"> <TD ALIGN="right" VALIGN="top" WIDTH="1%"> <FONT SIZE="-1"> <CODE> string</CODE> </FONT> </TD> <TD> <CODE> <B> <A HREF="#getFieldStyle">getFieldStyle</A></B>(<object> oField) </CODE> <BR> Returns field style defined by user. </TD> </TR> <TR BGCOLOR="white" CLASS="TableRowColor"> <TD ALIGN="right" VALIGN="top" WIDTH="1%"> <FONT SIZE="-1"> <CODE> string</CODE> </FONT> </TD> <TD> <CODE> <B> <A HREF="#getFieldTitle">getFieldTitle</A></B>(<object> oField) </CODE> <BR> Returns column title. </TD> </TR> <TR BGCOLOR="white" CLASS="TableRowColor"> <TD ALIGN="right" VALIGN="top" WIDTH="1%"> <FONT SIZE="-1"> <CODE> string</CODE> </FONT> </TD> <TD> <CODE> <B> <A HREF="#getFieldType">getFieldType</A></B>(<object> oField) </CODE> <BR> Returns field data type. </TD> </TR> <TR BGCOLOR="white" CLASS="TableRowColor"> <TD ALIGN="right" VALIGN="top" WIDTH="1%"> <FONT SIZE="-1"> <CODE> string</CODE> </FONT> </TD> <TD> <CODE> <B> <A HREF="#getFieldWidth">getFieldWidth</A></B>(<object> oField) </CODE> <BR> Returns column width defined by user. </TD> </TR> <TR BGCOLOR="white" CLASS="TableRowColor"> <TD ALIGN="right" VALIGN="top" WIDTH="1%"> <FONT SIZE="-1"> <CODE> object</CODE> </FONT> </TD> <TD> <CODE> <B> <A HREF="#getFilteredRows">getFilteredRows</A></B>() </CODE> <BR> Returns reference to private array containing filtered rows. </TD> </TR> <TR BGCOLOR="white" CLASS="TableRowColor"> <TD ALIGN="right" VALIGN="top" WIDTH="1%"> <FONT SIZE="-1"> <CODE> object</CODE> </FONT> </TD> <TD> <CODE> <B> <A HREF="#getGridDimensions">getGridDimensions</A></B>() </CODE> <BR> Returns real width and height of the grid after it has been drawn. </TD> </TR> <TR BGCOLOR="white" CLASS="TableRowColor"> <TD ALIGN="right" VALIGN="top" WIDTH="1%"> <FONT SIZE="-1"> <CODE> string</CODE> </FONT> </TD> <TD> <CODE> <B> <A HREF="#getHeaderStyle">getHeaderStyle</A></B>() </CODE> <BR> Returns grid header style defined by user. </TD> </TR> <TR BGCOLOR="white" CLASS="TableRowColor"> <TD ALIGN="right" VALIGN="top" WIDTH="1%"> <FONT SIZE="-1"> <CODE> number</CODE> </FONT> </TD> <TD> <CODE> <B> <A HREF="#getId">getId</A></B>() </CODE> <BR> Returns grid id. </TD> </TR> <TR BGCOLOR="white" CLASS="TableRowColor"> <TD ALIGN="right" VALIGN="top" WIDTH="1%"> <FONT SIZE="-1"> <CODE> object</CODE> </FONT> </TD> <TD> <CODE> <B> <A HREF="#getInvalidCells">getInvalidCells</A></B>() </CODE> <BR> Returns cells having invalid value in an array. </TD> </TR> <TR BGCOLOR="white" CLASS="TableRowColor"> <TD ALIGN="right" VALIGN="top" WIDTH="1%"> <FONT SIZE="-1"> <CODE> object</CODE> </FONT> </TD> <TD> <CODE> <B> <A HREF="#getInvalidRows">getInvalidRows</A></B>() </CODE> <BR> Returns rows with cells having invalid value in an array. </TD> </TR> <TR BGCOLOR="white" CLASS="TableRowColor"> <TD ALIGN="right" VALIGN="top" WIDTH="1%"> <FONT SIZE="-1"> <CODE> object</CODE> </FONT> </TD> <TD> <CODE> <B> <A HREF="#getRowByCell">getRowByCell</A></B>(<object> oCell) </CODE> <BR> Finds row by cell. </TD> </TR> <TR BGCOLOR="white" CLASS="TableRowColor"> <TD ALIGN="right" VALIGN="top" WIDTH="1%"> <FONT SIZE="-1"> <CODE> object</CODE> </FONT> </TD> <TD> <CODE> <B> <A HREF="#getRowById">getRowById</A></B>(<number> iRowId) </CODE> <BR> Finds row by its id. </TD> </TR> <TR BGCOLOR="white" CLASS="TableRowColor"> <TD ALIGN="right" VALIGN="top" WIDTH="1%"> <FONT SIZE="-1"> <CODE> object</CODE> </FONT> </TD> <TD> <CODE> <B> <A HREF="#getRowCells">getRowCells</A></B>(<object> oRow) </CODE> <BR> Returns cells array of the row. </TD> </TR> <TR BGCOLOR="white" CLASS="TableRowColor"> <TD ALIGN="right" VALIGN="top" WIDTH="1%"> <FONT SIZE="-1"> <CODE> object</CODE> </FONT> </TD> <TD> <CODE> <B> <A HREF="#getRowElement">getRowElement</A></B>(<object> oRow) </CODE> <BR> Returns table row element or undefined if row is on different page or not found. </TD> </TR> <TR BGCOLOR="white" CLASS="TableRowColor"> <TD ALIGN="right" VALIGN="top" WIDTH="1%"> <FONT SIZE="-1"> <CODE> object</CODE> </FONT> </TD> <TD> <CODE> <B> <A HREF="#getRowElementByCell">getRowElementByCell</A></B>(<object> oCell) </CODE> <BR> Returns table row element or undefined if row is on different page or not found. </TD> </TR> <TR BGCOLOR="white" CLASS="TableRowColor"> <TD ALIGN="right" VALIGN="top" WIDTH="1%"> <FONT SIZE="-1"> <CODE> number</CODE> </FONT> </TD> <TD> <CODE> <B> <A HREF="#getRowId">getRowId</A></B>(<object> oRow) </CODE> <BR> Returns row id. </TD> </TR> <TR BGCOLOR="white" CLASS="TableRowColor"> <TD ALIGN="right" VALIGN="top" WIDTH="1%"> <FONT SIZE="-1"> <CODE> number</CODE> </FONT> </TD> <TD> <CODE> <B> <A HREF="#getRowNumber">getRowNumber</A></B>(<object> oRow) </CODE> <BR> Returns visible row number. </TD> </TR> <TR BGCOLOR="white" CLASS="TableRowColor"> <TD ALIGN="right" VALIGN="top" WIDTH="1%"> <FONT SIZE="-1"> <CODE> object</CODE> </FONT> </TD> <TD> <CODE> <B> <A HREF="#getRows">getRows</A></B>() </CODE> <BR> Returns reference to private array containing grid rows. </TD> </TR> <TR BGCOLOR="white" CLASS="TableRowColor"> <TD ALIGN="right" VALIGN="top" WIDTH="1%"> <FONT SIZE="-1"> <CODE> boolean</CODE> </FONT> </TD> <TD> <CODE> <B> <A HREF="#getRowSelected">getRowSelected</A></B>(<object> oRow) </CODE> <BR> Returns true if row is selected. </TD> </TR> <TR BGCOLOR="white" CLASS="TableRowColor"> <TD ALIGN="right" VALIGN="top" WIDTH="1%"> <FONT SIZE="-1"> <CODE> string</CODE> </FONT> </TD> <TD> <CODE> <B> <A HREF="#getRowStyle">getRowStyle</A></B>(<object> oRow) </CODE> <BR> Returns row style defined by user. </TD> </TR> <TR BGCOLOR="white" CLASS="TableRowColor"> <TD ALIGN="right" VALIGN="top" WIDTH="1%"> <FONT SIZE="-1"> <CODE> string</CODE> </FONT> </TD> <TD> <CODE> <B> <A HREF="#getSearchByType">getSearchByType</A></B>(<string> sType) </CODE> <BR> Returns search method name corresponding to data type. </TD> </TR> <TR BGCOLOR="white" CLASS="TableRowColor"> <TD ALIGN="right" VALIGN="top" WIDTH="1%"> <FONT SIZE="-1"> <CODE> object</CODE> </FONT> </TD> <TD> <CODE> <B> <A HREF="#getSelectedCells">getSelectedCells</A></B>() </CODE> <BR> Returns selected cells in an array. </TD> </TR> <TR BGCOLOR="white" CLASS="TableRowColor"> <TD ALIGN="right" VALIGN="top" WIDTH="1%"> <FONT SIZE="-1"> <CODE> object</CODE> </FONT> </TD> <TD> <CODE> <B> <A HREF="#getSelectedRows">getSelectedRows</A></B>() </CODE> <BR> Returns selected rows in an array. </TD> </TR> <TR BGCOLOR="white" CLASS="TableRowColor"> <TD ALIGN="right" VALIGN="top" WIDTH="1%"> <FONT SIZE="-1"> <CODE> string</CODE> </FONT> </TD> <TD> <CODE> <B> <A HREF="#getStyle">getStyle</A></B>() </CODE> <BR> Returns grid style defined by user. </TD> </TR> <TR BGCOLOR="white" CLASS="TableRowColor"> <TD ALIGN="right" VALIGN="top" WIDTH="1%"> <FONT SIZE="-1"> <CODE> object</CODE> </FONT> </TD> <TD> <CODE> <B> <A HREF="#getTotals">getTotals</A></B>() </CODE> <BR> Returns array of rows for totals section. </TD> </TR> <TR BGCOLOR="white" CLASS="TableRowColor"> <TD ALIGN="right" VALIGN="top" WIDTH="1%"> <FONT SIZE="-1"> <CODE> string</CODE> </FONT> </TD> <TD> <CODE> <B> <A HREF="#getTypeByClass">getTypeByClass</A></B>(<string> sClass) </CODE> <BR> Returns data type corresponding to class name. </TD> </TR> <TR BGCOLOR="white" CLASS="TableRowColor"> <TD ALIGN="right" VALIGN="top" WIDTH="1%"> <FONT SIZE="-1"> <CODE> string</CODE> </FONT> </TD> <TD> <CODE> <B> <A HREF="#getValidateByType">getValidateByType</A></B>(<string> strType) </CODE> <BR> Returns name of validation method corresponding to data type. </TD> </TR> <TR BGCOLOR="white" CLASS="TableRowColor"> <TD ALIGN="right" VALIGN="top" WIDTH="1%"> <FONT SIZE="-1"> <CODE> void</CODE> </FONT> </TD> <TD> <CODE> <B> <A HREF="#gotoHorizontalOffset">gotoHorizontalOffset</A></B>(<object> oArg) </CODE> <BR> Scrolls grid to the specified column. </TD> </TR> <TR BGCOLOR="white" CLASS="TableRowColor"> <TD ALIGN="right" VALIGN="top" WIDTH="1%"> <FONT SIZE="-1"> <CODE> void</CODE> </FONT> </TD> <TD> <CODE> <B> <A HREF="#gotoPage">gotoPage</A></B>(<number> iPage) </CODE> <BR> Displays specified page. </TD> </TR> <TR BGCOLOR="white" CLASS="TableRowColor"> <TD ALIGN="right" VALIGN="top" WIDTH="1%"> <FONT SIZE="-1"> <CODE> void</CODE> </FONT> </TD> <TD> <CODE> <B> <A HREF="#gotoRowId">gotoRowId</A></B>(<number> iRowId) </CODE> <BR> Displays page with specified row. </TD> </TR> <TR BGCOLOR="white" CLASS="TableRowColor"> <TD ALIGN="right" VALIGN="top" WIDTH="1%"> <FONT SIZE="-1"> <CODE> void</CODE> </FONT> </TD> <TD> <CODE> <B> <A HREF="#gotoVerticalOffset">gotoVerticalOffset</A></B>(<object> oArg) </CODE> <BR> Scrolls grid to the specified row. </TD> </TR> <TR BGCOLOR="white" CLASS="TableRowColor"> <TD ALIGN="right" VALIGN="top" WIDTH="1%"> <FONT SIZE="-1"> <CODE> void</CODE> </FONT> </TD> <TD> <CODE> <B> <A HREF="#hideColumns">hideColumns</A></B>(<object> oArg) </CODE> <BR> Hides specified columns. </TD> </TR> <TR BGCOLOR="white" CLASS="TableRowColor"> <TD ALIGN="right" VALIGN="top" WIDTH="1%"> <FONT SIZE="-1"> <CODE> void</CODE> </FONT> </TD> <TD> <CODE> <B> <A HREF="#init">init</A></B>(<object> oArg) </CODE> <BR> Initializes grid. </TD> </TR> <TR BGCOLOR="white" CLASS="TableRowColor"> <TD ALIGN="right" VALIGN="top" WIDTH="1%"> <FONT SIZE="-1"> <CODE> void</CODE> </FONT> </TD> <TD> <CODE> <B> <A HREF="#limitRange">limitRange</A></B>(<object> oArg) </CODE> <BR> Limits range of values of the specified column. </TD> </TR> <TR BGCOLOR="white" CLASS="TableRowColor"> <TD ALIGN="right" VALIGN="top" WIDTH="1%"> <FONT SIZE="-1"> <CODE> void</CODE> </FONT> </TD> <TD> <CODE> <B> <A HREF="#loadData">loadData</A></B>(<object> oArg) </CODE> <BR> Reloads data from the specified source after grid is initialized. </TD> </TR> <TR BGCOLOR="white" CLASS="TableRowColor"> <TD ALIGN="right" VALIGN="top" WIDTH="1%"> <FONT SIZE="-1"> <CODE> void</CODE> </FONT> </TD> <TD> <CODE> <B> <A HREF="#modify">modify</A></B>() </CODE> <BR> Displays grid after modification of data like splice or query. </TD> </TR> <TR BGCOLOR="white" CLASS="TableRowColor"> <TD ALIGN="right" VALIGN="top" WIDTH="1%"> <FONT SIZE="-1"> <CODE> boolean</CODE> </FONT> </TD> <TD> <CODE> <B> <A HREF="#moveColumn">moveColumn</A></B>(<object> oArg) </CODE> <BR> Moves column within the grid. </TD> </TR> <TR BGCOLOR="white" CLASS="TableRowColor"> <TD ALIGN="right" VALIGN="top" WIDTH="1%"> <FONT SIZE="-1"> <CODE> object</CODE> </FONT> </TD> <TD> <CODE> <B> <A HREF="#query">query</A></B>(<object> oArgs) </CODE> <BR> Executes query on the grid. </TD> </TR> <TR BGCOLOR="white" CLASS="TableRowColor"> <TD ALIGN="right" VALIGN="top" WIDTH="1%"> <FONT SIZE="-1"> <CODE> void</CODE> </FONT> </TD> <TD> <CODE> <B> <A HREF="#receiveData">receiveData</A></B>(<object> oArg) </CODE> <BR> Loads passed data into already initialized grid to view or edit them. </TD> </TR> <TR BGCOLOR="white" CLASS="TableRowColor"> <TD ALIGN="right" VALIGN="top" WIDTH="1%"> <FONT SIZE="-1"> <CODE> void</CODE> </FONT> </TD> <TD> <CODE> <B> <A HREF="#reconfigure">reconfigure</A></B>(<object> oArg) </CODE> <BR> Reconfigures the grid with new config options after it was initialized. </TD> </TR> <TR BGCOLOR="white" CLASS="TableRowColor"> <TD ALIGN="right" VALIGN="top" WIDTH="1%"> <FONT SIZE="-1"> <CODE> number</CODE> </FONT> </TD> <TD> <CODE> <B> <A HREF="#recordsDisplayed">recordsDisplayed</A></B>() </CODE> <BR> Returns number of rows that are currently displayed. </TD> </TR> <TR BGCOLOR="white" CLASS="TableRowColor"> <TD ALIGN="right" VALIGN="top" WIDTH="1%"> <FONT SIZE="-1"> <CODE> void</CODE> </FONT> </TD> <TD> <CODE> <B> <A HREF="#redrawTotals">redrawTotals</A></B>(<object> oArg) </CODE> <BR> Redraws totals for the specified columns. </TD> </TR> <TR BGCOLOR="white" CLASS="TableRowColor"> <TD ALIGN="right" VALIGN="top" WIDTH="1%"> <FONT SIZE="-1"> <CODE> void</CODE> </FONT> </TD> <TD> <CODE> <B> <A HREF="#refresh">refresh</A></B>() </CODE> <BR> Refreshes grid after sorting or filtering. </TD> </TR> <TR BGCOLOR="white" CLASS="TableRowColor"> <TD ALIGN="right" VALIGN="top" WIDTH="1%"> <FONT SIZE="-1"> <CODE> void</CODE> </FONT> </TD> <TD> <CODE> <B> <A HREF="#removeFilter">removeFilter</A></B>(<object> oArg) </CODE> <BR> Removes filter from the specified columns. </TD> </TR> <TR BGCOLOR="white" CLASS="TableRowColor"> <TD ALIGN="right" VALIGN="top" WIDTH="1%"> <FONT SIZE="-1"> <CODE> void</CODE> </FONT> </TD> <TD> <CODE> <B> <A HREF="#resetFilters">resetFilters</A></B>() </CODE> <BR> Resets all filterouts, ranges and text filters. </TD> </TR> <TR BGCOLOR="white" CLASS="TableRowColor"> <TD ALIGN="right" VALIGN="top" WIDTH="1%"> <FONT SIZE="-1"> <CODE> number</CODE> </FONT> </TD> <TD> <CODE> <B> <A HREF="#searchInsensitiveString">searchInsensitiveString</A></B>(<object> oArg) </CODE> <BR> Searches specified value in the specified cell of insensitive string data type. </TD> </TR> <TR BGCOLOR="white" CLASS="TableRowColor"> <TD ALIGN="right" VALIGN="top" WIDTH="1%"> <FONT SIZE="-1"> <CODE> void</CODE> </FONT> </TD> <TD> <CODE> <B> <A HREF="#setBooleanTFValues">setBooleanTFValues</A></B>(<string> sFalse, <string> sTrue) </CODE> <BR> Sets display values for booleanTF data type. </TD> </TR> <TR BGCOLOR="white" CLASS="TableRowColor"> <TD ALIGN="right" VALIGN="top" WIDTH="1%"> <FONT SIZE="-1"> <CODE> void</CODE> </FONT> </TD> <TD> <CODE> <B> <A HREF="#setBooleanValues">setBooleanValues</A></B>(<string> sNo, <string> sYes) </CODE> <BR> Sets display values for boolean data type. </TD> </TR> <TR BGCOLOR="white" CLASS="TableRowColor"> <TD ALIGN="right" VALIGN="top" WIDTH="1%"> <FONT SIZE="-1"> <CODE> object</CODE> </FONT> </TD> <TD> <CODE> <B> <A HREF="#setCellStyle">setCellStyle</A></B>(<object> oCell, <string> sStyle) </CODE> <BR> Sets cell style. </TD> </TR> <TR BGCOLOR="white" CLASS="TableRowColor"> <TD ALIGN="right" VALIGN="top" WIDTH="1%"> <FONT SIZE="-1"> <CODE> object</CODE> </FONT> </TD> <TD> <CODE> <B> <A HREF="#setCellValue">setCellValue</A></B>(<object> oCell, <any> value) </CODE> <BR> Sets cell value. </TD> </TR> <TR BGCOLOR="white" CLASS="TableRowColor"> <TD ALIGN="right" VALIGN="top" WIDTH="1%"> <FONT SIZE="-1"> <CODE> void</CODE> </FONT> </TD> <TD> <CODE> <B> <A HREF="#setCurrentHorizontalOffset">setCurrentHorizontalOffset</A></B>(<object> oArg) </CODE> <BR> Sets current horizontal scroll. </TD> </TR> <TR BGCOLOR="white" CLASS="TableRowColor"> <TD ALIGN="right" VALIGN="top" WIDTH="1%"> <FONT SIZE="-1"> <CODE> void</CODE> </FONT> </TD> <TD> <CODE> <B> <A HREF="#setCurrentPage">setCurrentPage</A></B>(<number> iPage) </CODE> <BR> Sets current page. </TD> </TR> <TR BGCOLOR="white" CLASS="TableRowColor"> <TD ALIGN="right" VALIGN="top" WIDTH="1%"> <FONT SIZE="-1"> <CODE> void</CODE> </FONT> </TD> <TD> <CODE> <B> <A HREF="#setCurrentVerticalOffset">setCurrentVerticalOffset</A></B>(<object> oArg) </CODE> <BR> Sets current vertical scroll. </TD> </TR> <TR BGCOLOR="white" CLASS="TableRowColor"> <TD ALIGN="right" VALIGN="top" WIDTH="1%"> <FONT SIZE="-1"> <CODE> void</CODE> </FONT> </TD> <TD> <CODE> <B> <A HREF="#setDisplayedRows">setDisplayedRows</A></B>(<number> iRows) </CODE> <BR> Sets number of currently displayed rows. </TD> </TR> <TR BGCOLOR="white" CLASS="TableRowColor"> <TD ALIGN="right" VALIGN="top" WIDTH="1%"> <FONT SIZE="-1"> <CODE> number</CODE> </FONT> </TD> <TD> <CODE> <B> <A HREF="#setFieldTitle">setFieldTitle</A></B>(<object> oField, <string> sTitle) </CODE> <BR> Sets column title and visualizes changes immediately without refreshing whole grid. </TD> </TR> <TR BGCOLOR="white" CLASS="TableRowColor"> <TD ALIGN="right" VALIGN="top" WIDTH="1%"> <FONT SIZE="-1"> <CODE> void</CODE> </FONT> </TD> <TD> <CODE> <B> <A HREF="#setFilter">setFilter</A></B>(<object> oArg) </CODE> <BR> Limits the result set by doing a search. </TD> </TR> <TR BGCOLOR="white" CLASS="TableRowColor"> <TD ALIGN="right" VALIGN="top" WIDTH="1%"> <FONT SIZE="-1"> <CODE> object</CODE> </FONT> </TD> <TD> <CODE> <B> <A HREF="#setRowStyle">setRowStyle</A></B>(<object> oRow, <string> sStyle) </CODE> <BR> Sets row style. </TD> </TR> <TR BGCOLOR="white" CLASS="TableRowColor"> <TD ALIGN="right" VALIGN="top" WIDTH="1%"> <FONT SIZE="-1"> <CODE> void</CODE> </FONT> </TD> <TD> <CODE> <B> <A HREF="#setTotalRows">setTotalRows</A></B>(<number> iRows) </CODE> <BR> Sets total number of rows. </TD> </TR> <TR BGCOLOR="white" CLASS="TableRowColor"> <TD ALIGN="right" VALIGN="top" WIDTH="1%"> <FONT SIZE="-1"> <CODE> void</CODE> </FONT> </TD> <TD> <CODE> <B> <A HREF="#showColumns">showColumns</A></B>(<object> oArg) </CODE> <BR> Unhides specified columns. </TD> </TR> <TR BGCOLOR="white" CLASS="TableRowColor"> <TD ALIGN="right" VALIGN="top" WIDTH="1%"> <FONT SIZE="-1"> <CODE> void</CODE> </FONT> </TD> <TD> <CODE> <B> <A HREF="#sort">sort</A></B>(aArg) </CODE> <BR> Sorts the grid. </TD> </TR> <TR BGCOLOR="white" CLASS="TableRowColor"> <TD ALIGN="right" VALIGN="top" WIDTH="1%"> <FONT SIZE="-1"> <CODE> object</CODE> </FONT> </TD> <TD> <CODE> <B> <A HREF="#splice">splice</A></B>(<object> aData) </CODE> <BR> Changes the content of the grid, replacing, adding or removing rows. </TD> </TR> <TR BGCOLOR="white" CLASS="TableRowColor"> <TD ALIGN="right" VALIGN="top" WIDTH="1%"> <FONT SIZE="-1"> <CODE> number</CODE> </FONT> </TD> <TD> <CODE> <B> <A HREF="#spliceColumns">spliceColumns</A></B>(<object> aData) </CODE> <BR> Changes the content of the grid, replacing, adding or removing columns. </TD> </TR> <TR BGCOLOR="white" CLASS="TableRowColor"> <TD ALIGN="right" VALIGN="top" WIDTH="1%"> <FONT SIZE="-1"> <CODE> object</CODE> </FONT> </TD> <TD> <CODE> <B> <A HREF="#spliceXml">spliceXml</A></B>(<object> oDoc) </CODE> <BR> Changes content of the grid, replacing, adding or removing rows. </TD> </TR> <TR BGCOLOR="white" CLASS="TableRowColor"> <TD ALIGN="right" VALIGN="top" WIDTH="1%"> <FONT SIZE="-1"> <CODE> number</CODE> </FONT> </TD> <TD> <CODE> <B> <A HREF="#totalPages">totalPages</A></B>() </CODE> <BR> Returns total number of pages. </TD> </TR> <TR BGCOLOR="white" CLASS="TableRowColor"> <TD ALIGN="right" VALIGN="top" WIDTH="1%"> <FONT SIZE="-1"> <CODE> number</CODE> </FONT> </TD> <TD> <CODE> <B> <A HREF="#totalRecords">totalRecords</A></B>() </CODE> <BR> Returns total number of rows. </TD> </TR> <TR BGCOLOR="white" CLASS="TableRowColor"> <TD ALIGN="right" VALIGN="top" WIDTH="1%"> <FONT SIZE="-1"> <CODE> void</CODE> </FONT> </TD> <TD> <CODE> <B> <A HREF="#unfilterOut">unfilterOut</A></B>(<object> oArg) </CODE> <BR> Removes all hidden values from the specified columns. </TD> </TR> <TR BGCOLOR="white" CLASS="TableRowColor"> <TD ALIGN="right" VALIGN="top" WIDTH="1%"> <FONT SIZE="-1"> <CODE> void</CODE> </FONT> </TD> <TD> <CODE> <B> <A HREF="#unsort">unsort</A></B>() </CODE> <BR> Unsorts the grid. </TD> </TR> <TR BGCOLOR="white" CLASS="TableRowColor"> <TD ALIGN="right" VALIGN="top" WIDTH="1%"> <FONT SIZE="-1"> <CODE> boolean</CODE> </FONT> </TD> <TD> <CODE> <B> <A HREF="#validateBoolean">validateBoolean</A></B>(<object> objCell) </CODE> <BR> Validates cell of boolean data type. </TD> </TR> <TR BGCOLOR="white" CLASS="TableRowColor"> <TD ALIGN="right" VALIGN="top" WIDTH="1%"> <FONT SIZE="-1"> <CODE> boolean</CODE> </FONT> </TD> <TD> <CODE> <B> <A HREF="#validateBooleanTF">validateBooleanTF</A></B>(<object> objCell) </CODE> <BR> Validates cell of booleanTF data type. </TD> </TR> <TR BGCOLOR="white" CLASS="TableRowColor"> <TD ALIGN="right" VALIGN="top" WIDTH="1%"> <FONT SIZE="-1"> <CODE> boolean</CODE> </FONT> </TD> <TD> <CODE> <B> <A HREF="#validateDate">validateDate</A></B>(<object> objCell) </CODE> <BR> Validates cell of date data type. </TD> </TR> <TR BGCOLOR="white" CLASS="TableRowColor"> <TD ALIGN="right" VALIGN="top" WIDTH="1%"> <FONT SIZE="-1"> <CODE> boolean</CODE> </FONT> </TD> <TD> <CODE> <B> <A HREF="#validateFloat">validateFloat</A></B>(<object> objCell) </CODE> <BR> Validates cell of float data type. </TD> </TR> <TR BGCOLOR="white" CLASS="TableRowColor"> <TD ALIGN="right" VALIGN="top" WIDTH="1%"> <FONT SIZE="-1"> <CODE> boolean</CODE> </FONT> </TD> <TD> <CODE> <B> <A HREF="#validateInteger">validateInteger</A></B>(<object> objCell) </CODE> <BR> Validates cell of integer data type. </TD> </TR> <TR BGCOLOR="white" CLASS="TableRowColor"> <TD ALIGN="right" VALIGN="top" WIDTH="1%"> <FONT SIZE="-1"> <CODE> boolean</CODE> </FONT> </TD> <TD> <CODE> <B> <A HREF="#validateTime">validateTime</A></B>(<object> objCell) </CODE> <BR> Validates cell of time data type. </TD> </TR> <TR BGCOLOR="white" CLASS="TableRowColor"> <TD ALIGN="right" VALIGN="top" WIDTH="1%"> <FONT SIZE="-1"> <CODE> boolean</CODE> </FONT> </TD> <TD> <CODE> <B> <A HREF="#validateTimestamp">validateTimestamp</A></B>(<object> objCell) </CODE> <BR> Validates cell of timestamp data type. </TD> </TR> <TR BGCOLOR="white" CLASS="TableRowColor"> <TD ALIGN="right" VALIGN="top" WIDTH="1%"> <FONT SIZE="-1"> <CODE> void</CODE> </FONT> </TD> <TD> <CODE> <B> <A HREF="#visualizeCellReadOnly">visualizeCellReadOnly</A></B>(<object> oCell) </CODE> <BR> Redraws specified cell without redrawing whole grid. </TD> </TR> <TR BGCOLOR="white" CLASS="TableRowColor"> <TD ALIGN="right" VALIGN="top" WIDTH="1%"> <FONT SIZE="-1"> <CODE><static> object</CODE> </FONT> </TD> <TD> <CODE> <B> <A HREF="#!s!avg">avg</A></B>(<object> oArg) </CODE> <BR> Calculates average for one or several columns. </TD> </TR> <TR BGCOLOR="white" CLASS="TableRowColor"> <TD ALIGN="right" VALIGN="top" WIDTH="1%"> <FONT SIZE="-1"> <CODE><static> object</CODE> </FONT> </TD> <TD> <CODE> <B> <A HREF="#!s!count">count</A></B>(<object> oArg) </CODE> <BR> Calculates count for one or several columns. </TD> </TR> <TR BGCOLOR="white" CLASS="TableRowColor"> <TD ALIGN="right" VALIGN="top" WIDTH="1%"> <FONT SIZE="-1"> <CODE><static> object</CODE> </FONT> </TD> <TD> <CODE> <B> <A HREF="#!s!countDistinct">countDistinct</A></B>(<object> oArg) </CODE> <BR> Calculates count of distinct values for one or several columns. </TD> </TR> <TR BGCOLOR="white" CLASS="TableRowColor"> <TD ALIGN="right" VALIGN="top" WIDTH="1%"> <FONT SIZE="-1"> <CODE><static> void</CODE> </FONT> </TD> <TD> <CODE> <B> <A HREF="#!s!createType">createType</A></B>(<function> funcConvert, <string> sTypeName, <string> sTypeClass) </CODE> <BR> Creates custom data type. </TD> </TR> <TR BGCOLOR="white" CLASS="TableRowColor"> <TD ALIGN="right" VALIGN="top" WIDTH="1%"> <FONT SIZE="-1"> <CODE><static> void</CODE> </FONT> </TD> <TD> <CODE> <B> <A HREF="#!s!createValidation">createValidation</A></B>(funcValidate, <string> strTypeName) </CODE> <BR> Creates validation method for custom data type. </TD> </TR> <TR BGCOLOR="white" CLASS="TableRowColor"> <TD ALIGN="right" VALIGN="top" WIDTH="1%"> <FONT SIZE="-1"> <CODE><static> void</CODE> </FONT> </TD> <TD> <CODE> <B> <A HREF="#!s!firstPage">firstPage</A></B>(<number> iGridId) </CODE> <BR> Goes to the first page. </TD> </TR> <TR BGCOLOR="white" CLASS="TableRowColor"> <TD ALIGN="right" VALIGN="top" WIDTH="1%"> <FONT SIZE="-1"> <CODE><static> number</CODE> </FONT> </TD> <TD> <CODE> <B> <A HREF="#!s!getNewColumnNumber">getNewColumnNumber</A></B>(<object> oArg) </CODE> <BR> Converts any column number after column moving. </TD> </TR> <TR BGCOLOR="white" CLASS="TableRowColor"> <TD ALIGN="right" VALIGN="top" WIDTH="1%"> <FONT SIZE="-1"> <CODE><static> void</CODE> </FONT> </TD> <TD> <CODE> <B> <A HREF="#!s!lastPage">lastPage</A></B>(<number> iGridId) </CODE> <BR> Goes to the last page. </TD> </TR> <TR BGCOLOR="white" CLASS="TableRowColor"> <TD ALIGN="right" VALIGN="top" WIDTH="1%"> <FONT SIZE="-1"> <CODE><static> object</CODE> </FONT> </TD> <TD> <CODE> <B> <A HREF="#!s!max">max</A></B>(<object> oArg) </CODE> <BR> Calculates max value for one or several columns. </TD> </TR> <TR BGCOLOR="white" CLASS="TableRowColor"> <TD ALIGN="right" VALIGN="top" WIDTH="1%"> <FONT SIZE="-1"> <CODE><static> object</CODE> </FONT> </TD> <TD> <CODE> <B> <A HREF="#!s!min">min</A></B>(<object> oArg) </CODE> <BR> Calculates min value for one or several columns. </TD> </TR> <TR BGCOLOR="white" CLASS="TableRowColor"> <TD ALIGN="right" VALIGN="top" WIDTH="1%"> <FONT SIZE="-1"> <CODE><static> void</CODE> </FONT> </TD> <TD> <CODE> <B> <A HREF="#!s!nextPage">nextPage</A></B>(<number> iGridId) </CODE> <BR> Goes to the next page. </TD> </TR> <TR BGCOLOR="white" CLASS="TableRowColor"> <TD ALIGN="right" VALIGN="top" WIDTH="1%"> <FONT SIZE="-1"> <CODE><static> void</CODE> </FONT> </TD> <TD> <CODE> <B> <A HREF="#!s!previousPage">previousPage</A></B>(<number> iGridId) </CODE> <BR> Goes to the previous page. </TD> </TR> <TR BGCOLOR="white" CLASS="TableRowColor"> <TD ALIGN="right" VALIGN="top" WIDTH="1%"> <FONT SIZE="-1"> <CODE><static> object</CODE> </FONT> </TD> <TD> <CODE> <B> <A HREF="#!s!sum">sum</A></B>(<object> oArg) </CODE> <BR> Calculates sum for one or several columns. </TD> </TR> </TABLE> <P> <!-- ========== END METHOD SUMMARY =========== --> <!-- ============ FIELD DETAIL START =========== --> <!-- ============ FIELD DETAIL END =========== --> <!-- ========= CONSTRUCTOR DETAIL START ======== --> <A NAME="constructor_detail"><!-- --></A> <TABLE BORDER="1" CELLPADDING="3" CELLSPACING="0" WIDTH="100%"> <TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor"> <TD COLSPAN=1> <FONT SIZE="+2"><B>Constructor Detail</B></FONT> </TD> </TR> </TABLE> <A NAME="Zapatec.Grid()"><!-- --></A><H3> Zapatec.Grid</H3> <PRE><B>Zapatec.Grid</B>(<object> oArg)</PRE> <UL> Grid core. <pre> <strong>Input data formats:</strong> <strong>JSON:</strong> { style: [string, optional] table style attribute, headerStyle: [string, optional] header table row style attribute, fields: [ { i: [number] zero-based column number, <b>dataPrepared</b> specific, title: [string, optional] column title, dataType: [string, optional] defines which standard or custom data type to use for cell conversion (if not specified, no conversion is done), columnWidth: [string, optional] column width, e.g. "10px", "10em", style: [string, optional] header table cell style attribute, span: [number, optional] how many columns to span, spanTitle: [string, optional] span title, spanStyle: [string, optional] span table cell style attribute, hidden: [boolean, optional] if true, column will not be displayed, but filtering and searching can still be done on this column, nosort: [boolean, optional] if true, grid will not be sorted when this header is clicked, sortByColumn: [number, optional] zero-based number of column to use for sorting, hiddenValues: [object, optional] array of hidden values - rows conaining these values in the column will not be displayed, minValue: [any, optional] rows containing values in the column lesser than this value will not be displayed, maxValue: [any, optional] rows containing values in the column greater than this value will not be displayed, regexpFilter: [string, optional] rows where column value don't match this regular expression will not be displayed, textFilter: [string, optional] rows which don't contain this pattern in the column value will not be displayed, columnRange: [object, optional] see <a href="../Zapatec/Grid.html#getColumnRange">Zapatec.Grid.getColumnRange()</a> }, ... ], primaryKey: [number, optional] number of column to use as primary key, rows: [ { i: [number] zero-based row number, <b>dataPrepared</b> specific, cells: [ { i: [number] zero-based column number, <b>dataPrepared</b> specific, r: [number] zero-based row number, <b>dataPrepared</b> specific, v: [any] cell value to display, c: [any, optional] cell value to compare, o: [any, optional] original cell value, style: [string, optional] table cell style attribute, colspan: [number, optional] number of columns this cell spans, rowspan: [number, optional] number of rows this cell spans }, ... ], style: [string, optional] table row style attribute }, ... ], totalRows: [number, optional] <b>dataOnDemand</b> specific, displayedRows: [number, optional] <b>dataOnDemand</b> specific, currentPage: [number, optional] <b>dataOnDemand</b> specific } "i" and "r" properties are required when <b>dataPrepared</b> config option is true. When <b>dataPrepared</b> is false, they are overwritten by automatic column and row numbers. "c" and "o" properties may be useful when column "dataType" is not set. Also they are required when <b>dataPrepared</b> config option is true and their values differ from the value of "v" property of the cell. Anyway, they shouldn't be set if their values are equal to the value of "v" property of the cell. "totalRows" property is used to pass total number of rows in the grid when <b>dataOnDemand</b> config option is used. "displayedRows" property is used to pass number of displayed rows when <b>dataOnDemand</b> config option is used and filter is applied. If filter is not applied and there are no hidden rows, should be equal to totalRows. "currentPage" property is used to pass zero-based current page number when <b>dataOnDemand</b> config option is used. "totalRows", "displayedRows" and "currentPage" properties are required when <b>dataOnDemand</b> config option is true. When <b>dataOnDemand</b> is false, they are ignored. "dataType" property requires zpgrid-convert.js module that is included by default. "hiddenValues", "minValue", "maxValue", "regexpFilter", "regexpFilter", "columnRange" properies are useful when <b>dataOnDemand</b> config option is true. See phone_ondemand.html demo. <strong>HTML:</strong> (requires zpgrid-html.js that is included by default) <xmp> <table style="border: 1px solid #000"> <tbody> <tr style="background-color: #00f"> <td width="56" class="zpGridTypeDate" style="font-weight: bold" span="2" spantitle="Date & Time" spanstyle="text-align: center"> Date </td> <td width="56" class="zpGridTypeTime" style="font-weight: bold"> Time </td> <td> Title </td> <td> Comments </td> ... </tr> <tr style="background-color: #ccc"> <td style="background-color: #f00">01/01/2001</td> <td style="background-color: #f00">09:30AM</td> <td colspan="2" rowspan="2">Meeting</td> ... </tr> <tr style="background-color: #ccc"> <td style="background-color: #f00">01/01/2001</td> <td style="background-color: #f00">10:30AM</td> ... </tr> ... </tbody> </table> </xmp> First row in the source table defines grid columns. To set column data type other than "string", add one of standard or custom data type class names to the "class" attribute of the corresponding cell in the first row. Difference from JSON input format: If data type is not specified, conversion will be done according to the "string" data type. Column width can be set through "width" attribute of the corresponding cell in the first row. Special "zpGridTypeHidden" class makes column hidden and it will not be displayed, but filtering and searching can still be done on this column. This field type can be used alone or in conjunction with other field type, e.g. class="zpGridTypeInt zpGridTypeHidden". Special "zpGridTypeNosort" class makes column header not clickable. Grid will not be sorted when this header is clicked. This field type can be used alone or in conjunction with other field type, e.g. class="zpGridTypeInt zpGridTypeNosort". Special "zpGridTypeNotags" class makes grid skip all tags in the column, and only uses the text. This will facilitate migrating from an existing table to the grid. This field type can be used alone or in conjunction with other field type, e.g. class="zpGridTypeInt zpGridTypeNotags". Special "zpGridTypeSortByN" class makes column use anoter column for sorting. Where N is zero-based column number to use for sorting. This field type can be used alone or in conjunction with other field type, e.g. class="zpGridTypeInt zpGridTypeSortBy2". Special "zpGridTypePrimaryKey" class makes column a primary key for the grid. This field type can be used alone or in conjunction with other field type, e.g. class="zpGridTypeInt zpGridTypePrimaryKey". Attributes "style", "width", "span", "spantitle", "spanstyle", "colspan" are optional. "span" how many columns to span. "spantitle" span title. "spanstyle" span table cell style attribute. Other attributes mean the same as for regular HTML table. <strong>XML:</strong> (requires zpgrid-xml.js that is NOT included by default) <xmp> <?xml version="1.0"?> <grid> <table style="border: solid black 1px" headerstyle="background: #ccc" primarykey="0" totalrows="123" displayedrows="89" currentpage="3"> <fields> <field width="10px" hidden="true" nosort="true" sortbycolumn="2" style="color: #00f" span="2" spantitle="Span Title" spanstyle="text-align: center"> <title>Title</title> <datatype>string</datatype> <hiddenvalues> <hiddenval>Hidden value</hiddenval> ... </hiddenvalues> <minlimit>Min displayed value (useful for Slider)</minlimit> <maxlimit>Max displayed value (useful for Slider)</maxlimit> <regexpfilter>Regexp filter</regexpfilter> <textfilter>Text filter</textfilter> <columnrange> <minvalue>Min value</minvalue> <maxvalue>Max value</maxvalue> <uniquevalues> <uniqueval>Unique value</uniqueval> ... </uniquevalues> </columnrange> </field> ... </fields> <rows> <row style="background: #eee"> <cell style="color: #f00" colspan="2" rowspan="2">Value</cell> ... </row> ... </rows> </table> </grid> </xmp> Where "style", "headerstyle", "primarykey", "totalrows", "displayedrows", "currentpage", "width", "hidden", "nosort", "sortbycolumn", "span", "spantitle", "spanstyle", "colspan" attributes are optional. "style" is style attribute of table, row or cell. "headerstyle" is header table row style attribute. "primarykey" defines column number to use as primary key. If not specified, no primary key is created. "totalrows" is total number of rows when <b>dataOnDemand</b> config option is true. "displayedrows" is number of rows displayed when <b>dataOnDemand</b> config option is true. "currentpage" is zero-based current page number when <b>dataOnDemand</b> config option is true. "width" is column width. "hidden=true" attribute makes column hidden and it will not be displayed, but filtering and searching can still be done on this column. "nosort=true" attribute makes column header not clickable. Grid will not be sorted when this header is clicked. "sortbycolumn=N" attribute makes column use anoter column for sorting. Where N is zero-based column number to use for sorting. "span" how many columns to span. "spantitle" span title. "spanstyle" span table cell style attribute. "datatype" tag is optional. Defines which standard or custom data type to use for cell conversion. If not specified, no conversion is done. "hiddenvalues", "minlimit", "maxlimit", "regexpfilter", "textfilter", "columnrange" tags are optional. They are useful when <b>dataOnDemand</b> config option is true. See phone_ondemand_xml.html demo. "colspan" number of columns this cell spans. Works the same as in HTML table. "rowspan" number of rows this cell spans. Works the same as in HTML table. <strong>Possible data types:</strong> ----------------------------------------------------------------------------- Name for JSON |Class name for HTML |Input data |Format of and XML formats |format |format |displayed data -----------------|---------------------------|----------------|-------------- string |zpGridTypeString |string |same as input -----------------|---------------------------|----------------| istring |zpGridTypeStringInsensitive|case insensitive| | |string | -----------------|---------------------------|----------------| int |zpGridTypeInt |number or | | |Infinity | -----------------|---------------------------|----------------| intGerman |zpGridTypeIntGerman |number in | | |German format or| | |Infinity | -----------------|---------------------------|----------------| float |zpGridTypeFloat |number or | | |Infinity | -----------------|---------------------------|----------------| floatGerman |zpGridTypeFloatGerman |number in | | |German format or| | |Infinity | -----------------|---------------------------|----------------| date |zpGridTypeDate |string accepted | | |by builtin | | |javascript Date | | |object | -----------------|---------------------------|----------------| time |zpGridTypeTime |HH:MM:SS | | |HH:MM:SS AM/PM | | |HH:MM | | |HH:MM AM/PM | | |HHMMSS | | |HHMMSS AM/PM | | |HHMM | | |HHMM AM/PM | -----------------|---------------------------|----------------|-------------- timestamp |zpGridTypeTimestampLocale |integer (number |Date in locale | |of seconds since|format -----------------|---------------------------|01/01/1970 |-------------- timestampMMDDYYYY|zpGridTypeTimestampMMDDYYYY|00:00 GMT) |MM/DD/YYYY -----------------|---------------------------| |-------------- timestampDDMMYYYY|zpGridTypeTimestampDDMMYYYY| |DD/MM/YYYY -----------------|---------------------------| |-------------- timestampYYYYMMDD|zpGridTypeTimestampYYYYMMDD| |YYYY/MM/DD -----------------|---------------------------|----------------|-------------- boolean |zpGridTypeBoolean |case insensitive|No/Yes | |0 or 1 |or custom -----------------|---------------------------|f or t |-------------- booleanTF |zpGridTypeBooleanTF |false or true |False/True | |n or y |or custom | |no or yes | ----------------------------------------------------------------------------- <strong>In addition to config options defined in base Zapatec.Widget class provides following config options:</strong> <b>show_asis</b> [boolean] Show data as is. The original data the is imported to the grid needs to be translated to it's field type. In many cases this translation changes the original data. This option gives control back to the user to define how to display the grid cell Possible values: boolean true - Show ALL cells as is false - Show the cells based on the field type conversion object {bBoth, funcShow} bBoth - Show both in cell, Ex: Orig = Zapatec Value Ex: Showing both BYTES- cell=|15 MB=15360000000|; where 15 MB is orig and 15360000000 bytes is converted value HOURS- cell=|2 days 1 hour=49|; where 2 days 1 hour is orig and 49 hours is converted value WEIGHT- cell=|1 lb 2 oz=18|; where 1 lb 2 oz is orig and 18 oz is converted value funcShow - callback function to create presentable cell data Function to visually present the data. Does NOT effect sorting, just visual sShowData = this.config.show_asis.funcShow(oGrid, oCell); param oCell - Zapatec.Grid object param oCell - cell object <b>funcStyle</b> [function] Callback function to dynamically change the style of a cell. Dynamically change the style of a cell based on the contents. param oGrid - Zapatec.Grid object param oCell - cell object param iRow - index of the row in the displayed rows array returned by <a href="../Zapatec/Grid.html#applyPaging">Zapatec.Grid.applyPaging()</a> method return undefined if NO change to style return string for the inline style that should be applied to this cell <b>convert</b> [function] Callback function to convert the cell value. Receives Zapatec.Grid object and cell object. If returns a value, that value will be assigned to the cell display and compare values. <b>container</b> [object or string] Element or id of element that will hold the grid. If "callbackHeaderDisplay" and "callbackRowDisplay" or "callbackDataDisplay" options are defined, grid will be drawn using those functions and "container" option is ignored. Also can be used instead of "source" option. If "source" option is not defined, first child table of container element is used as source. Standard output requires zpgrid-output.js module that is included by default. <b>headerContainer</b> [object or string] Element or id of element that will hold header of the grid. Used together with "container" option when header should be separated from the grid. E.g. to have grid data scrollable vertically and header always visible. See scroll.html demo for details. <b>totalsContainer</b> [object or string] Element or id of element that will hold totals. Used together with "container" option when totals should be separated from the grid. E.g. to have grid data scrollable vertically and totals always visible. See scroll.html demo for details. <b>visibleRows</b> [number] Used for displaying custom vertical scrollbar. If > 0, limits number of rows displayed starting from current vertical offset. See <a href="../Zapatec/Grid.html#gotoVerticalOffset">Zapatec.Grid.gotoVerticalOffset()</a> method for details about current vertical offset. Default: 0. <b>visibleColumns</b> [number] Used for displaying custom horizontal scrollbar. If > 0, limits number of columns displayed starting from current horizontal offset. See <a href="../Zapatec/Grid.html#gotoHorizontalOffset">Zapatec.Grid.gotoHorizontalOffset()</a> method for details about current horizontal offset. Default: 0. <b>rowsPerPage</b> [number] If > 0, paging is used. Default: 0. <b>paginationContainer</b> [object or string] Element or id of element that will hold pagination of the grid. Used together with "container" and "rowsPerPage" options when pagination should be separated from the grid. See scroll.html demo for example. You can pass several containers in an array to this option if you need to display pagination in two or more places. See compare.html demo for example. <b>border</b> [object or string] Element or id of element that is parent for all grid containers. Used to determine dimensions of the grid when it has several containers. Need only for <b>fitIntoParent</b> feature below when grid has several containers. Default is parent element of the <b>container</b>. <b>fitIntoParent</b> [boolean, object or string] When true, grid will be adjusted dynamically to fit into parent element of the <b>border</b>. When element or id of element, grid will be adjusted dynamically to fit into that element. <b>horizontal</b> [boolean] If true, horizontal layout is used in standard output. Default: false. <b>selectRows</b> [boolean] If true, selected rows will be marked by different color depending from theme. Default: true. Ignored when callback functions are used to display grid. <b>selectCells</b> [boolean] If true, selected cells will be marked by different color depending from theme. Default: true. Ignored when callback functions are used to display grid. <b>activeRows</b> [boolean] If true, active rows will be marked by different color depending from theme. Default: true. Ignored when callback functions are used to display grid. <b>activeCells</b> [boolean] If true, active cells will be marked by different color depending from theme. Default: true. Ignored when callback functions are used to display grid. <b>multipleSelect</b> [boolean] If true, "Shift" and "Ctrl" click will select multiple rows and cells. If false, only one row and cell can be selected at a time. Default: true. <b>callbackHeaderDisplay</b> [function] Callback function to display grid header. Used togeter with callbackRowDisplay or callbackDataDisplay option as alternetive way to display the grid. Otherwise ignored. Receives Zapatec.Grid object. No return value is needed. <b>callbackDataDisplay</b> [function] Callback function to display grid rows. Used togeter with callbackHeaderDisplay option as alternetive way to display the grid. Otherwise ignored. Receives Zapatec.Grid object and array of row objects. No return value is needed. <b>callbackRowDisplay</b> [function] Callback function to display grid row. Called for each row. Used togeter with callbackHeaderDisplay option as alternetive way to display the grid. Otherwise ignored. Ignored when callbackDataDisplay is set. Receives Zapatec.Grid object and row object. No return value is needed. <b>callbackTotalsDisplay</b> [function] Callback function to display totals. Used togeter with callbackHeaderDisplay, callbackRowDisplay and callbackDataDisplay options as alternetive way to display the grid, but also can be used separately as a replacement for standard totals. Receives Zapatec.Grid object and array of row objects for totals. If totals option is not set this option still can be used, but it receives undefined instead of array of rows. No return value is needed. <b>callbackTotalDisplay</b> [function] Callback function to display totals row. Called for each totals row. Used togeter with callbackHeaderDisplay, callbackRowDisplay and callbackDataDisplay options as alternetive way to display the grid, but also can be used separately as a replacement for standard totals. Ignored when callbackTotalsDisplay is set. Receives Zapatec.Grid object and totals row object. No return value is needed. <b>callbackPaginationDisplay</b> [function] Callback function to display grid pagination. Used togeter with callbackHeaderDisplay, callbackRowDisplay and callbackDataDisplay options as alternetive way to display the grid, but also can be used separately as a replacement for standard pagination. Receives Zapatec.Grid object. No return value is needed. See also <a href="../Zapatec/Grid.html#gotoPage">Zapatec.Grid.gotoPage()</a>, <a href="../Zapatec/Grid.html#!s!previousPage">Zapatec.Grid.previousPage()</a>, <a href="../Zapatec/Grid.html#!s!firstPage">Zapatec.Grid.firstPage()</a>, <a href="../Zapatec/Grid.html#!s!nextPage">Zapatec.Grid.nextPage()</a>, <a href="../Zapatec/Grid.html#!s!lastPage">Zapatec.Grid.lastPage()</a>. <b>callbackRowOnClick</b> [function] Callback function to call when grid row is clicked with left mouse button. Receives Zapatec.Grid object and row object. No return value is needed. <b>callbackRowOnRightClick</b> [function] Callback function to call when grid row is clicked with right mouse button. Receives Zapatec.Grid object and row object. No return value is needed. <b>callbackCellOnClick</b> [function] Callback function to call when grid cell is clicked with left mouse button. Receives Zapatec.Grid object and cell object. No return value is needed. If this option is defined, above "callbackRowOnClick" option is ignored. <b>callbackCellOnRightClick</b> [function] Callback function to call when grid cell is clicked with right mouse button. Receives Zapatec.Grid object and cell object. No return value is needed. If this option is defined, above "callbackRowOnRightClick" option is ignored. <b>callbackRowOnDblClick</b> [function] Callback function to call when grid row is double clicked. Receives Zapatec.Grid object and row object. No return value is needed. <b>callbackCellOnDblClick</b> [function] Callback function to call when grid cell is double clicked. Receives Zapatec.Grid object and cell object. No return value is needed. If this option is defined, above "callbackRowOnDblClick" option is ignored. <b>callbackRowSelect</b> [function] Callback function to call when grid row is selected. Receives Zapatec.Grid object and row object. No return value is needed. <b>callbackCellSelect</b> [function] Callback function to call when grid cell is selected. Receives Zapatec.Grid object and cell object. No return value is needed. If this option is defined, above "callbackRowSelect" option is ignored. <b>callbackRowUnselect</b> [function] Callback function to call when grid row is unselected. Receives Zapatec.Grid object and row object. No return value is needed. <b>callbackCellUnselect</b> [function] Callback function to call when grid cell is unselected. Receives Zapatec.Grid object and cell object. No return value is needed. If this option is defined, above "callbackRowUnselect" option is ignored. <b>callbackOnRefresh</b> [function] Callback function to call when grid is refreshed. Receives Zapatec.Grid object. No return value is needed. Deprecated. Use <b>gridRefreshed</b> event described below instead. <b>sortColumn</b> [number] Number of column to sort initially. First column number is 0. If not set, initially grid will not be sorted. <b>sortDesc</b> [boolean] Used together with sortColumn option. Otherwise ignored. If true, initially grid will be sorted in descending order. <b>filterOut</b> [object] Array of associative arrays: [ { column: [object or number] array of zero-based column numbers or single zero-based column number to use as source of values to filter out, sortDesc: [boolean, optional] if true, list of values will be sorted descending, otherwise ascending (default is false), container: [object or string, optional] element or id of element that will hold the list of values to filter out , onclick: [string, optional] string with javascript code that will be evaluated when checkbox is clicked before filtering out the grid (should not contain " (double quote) symbol), callback: [function, optional] callback function reference used as alternative way to display filter out list }, ... ] If "callback" property is defined, "container" and "onclick" properties are ingnored. "onclick" is useful when some simple actions like function call or alert should be done before filtering out the grid. If you need to do more complex actions than the code that can be passed in the string, use alternative way to display filter out list with callback function. callback function receives following array of associative arrays: [ { value: [string] the unique value from grid column, onclick: [string] onclick attribute value of the corresponding checkbox, checked: [boolean] true if this checkbox is checked, link: [string] onclick attribute for the link to filter out all values except this, selectall: [string] onclick attribute for the link to unfilter out all values (this property is defined only for the first value), clearall: [string] onclick attribute for the link to filter out all values (this property is defined only for the first value) }, ... ] No return value is needed. <b>totals</b> (requires zpgrid-aggregate.js module that is included by default) [object] Array of associative arrays: [ { column: [object or number, optional] array of zero-based column numbers or single zero-based column number to calculate (passed to the function; required for standard aggregate functions, optional for custom callback function), callback: [function, optional] callback function to calculate value (see below) or one of standard static aggregate functions: Zapatec.Grid.sum, Zapatec.Grid.avg, Zapatec.Grid.max, Zapatec.Grid.min, Zapatec.Grid.count, Zapatec.Grid.countDistinct (default is Zapatec.Grid.sum), label: [string, optional] label for the value (passed to the function; overrides standard label), labelColumn: [number, optional] zero-based column number where to put label (passed to the function; by default label is placed before the value in the same cell) }, ... ] "callback" property is a callback function that calculates totals using desired algorithm. It receives following object containing grid rows: { grid: [object] grid object, rows: [object] array of row objects, column: [object or number, optional] "column" property of "totals", label: [string, optional] "label" property of "totals", labelColumn: [string, optional] "labelColumn" property of "totals" } and should return following object containing one or several rows with totals (number of cells should correspond to the number of grid fields): { rows: [ { cells: [ { v: [string] value to display, style: [string, optional] table cell style attribute }, ... ], style: [string, optional] table row style attribute }, ... ] } See <a href="../Zapatec/Grid.html#!s!sum">Zapatec.Grid.sum()</a> for example. <b>dataPrepared</b> [boolean] If true, grid will not attempt to check and correct input data. External application is responsible for data preparation. May be used with json source type to speed up large grid initialization. Data must be prepared strictly according to grid internal format. <b>dataOnDemand</b> [boolean] If true, on every paging, sorting, filtering, ranging, and search action grid instead of doing actual operation reloads its data. It makes sence to use this option together with "callbackSource" config option defined in Zapatec.Widget class. In this case grid passes to callbackSource function following object: { currentPage: [number] zero-based current page number, sortColumn: [number] zero-based column number on which grid is currently sorted (deprecated, use order instead), sortDesc: [boolean] true if grid is currently sorted in descending order (deprecated, use order instead), order: [object] array showing how the grid is currently sorted with sorting priority from first to last element of the array, see <a href="../Zapatec/Grid.html#sort">Zapatec.Grid.sort()</a> method for more details about sorting: [ { col: [number] zero-based column number, desc: [boolean, optional] indicates descending order for this column, lt: [number] 1 if desc, -1 otherwise, gt: [number] -1 if desc, 1 otherwise }, ... ] filters: [object] array containing an object for each grid column: [ { hiddenValues: [object] array of hidden values - rows conaining these values in the column should not be displayed, minValue: [any] rows containing values in the column lesser than this value should not be displayed, maxValue: [any] rows containing values in the column greater than this value should not be displayed, regexpFilter: [string, optional] rows where column value don't match this regular expression should not be displayed, textFilter: [string] rows which don't contain this pattern in the column value should not be displayed }, ... ] } and lets it to form the source, e.g. server URL, from which grid is reloaded then. See Zapatec.Widget for details. <b>fixedLeft</b> [number] Number of columns starting from the left that are not moved during horizontal scrolling. <b>columnWidth</b> [string] Default column width. Should contain correct CSS value, e.g. 'auto', '200px', etc. 'auto' must not be used with grids having separate container for header. Default: 'auto' if headerContainer and totalsContainer are not set, '100px' if headerContainer or totalsContainer is set. <b>rowHeight</b> [string] Default row height. Should contain correct CSS value, e.g. 'auto', '1.2em', etc. 'auto' must not be used with grids having fixed columns. Default: 'auto'. <b>mouseSelect</b> [boolean or string] Allow selection of cells and rows using left mouse button. Default: true. <b>dragAndDropCells</b> [boolean or string] Allow drag and drop cells using left mouse button. Default: false. Note: if this option is true, <b>mouseSelect</b> must be false. <b>dragAndDropColumns</b> [boolean or string] Allow drag and drop columns using left mouse button. Default: false. <strong>In addition to events fired from base Zapatec.Widget class fires following events:</strong> <b>gridInitialized</b> when grid initialization process is completed. <b>gridPrepareRefresh</b> before grid refresh is started. <b>gridRefreshed</b> when grid refresh is completed. <b>gridPrepareModify</b> before splice or query is started. <b>gridModified</b> when splice or query is completed. <b>gridPrepareFilter</b> before filtering is started. <b>gridFiltered</b> when filtering is completed. <b>gridResizedColumn</b> when standard output is used and column was resized manually. Listener receives two arguments: column id and width increment in pixels. Width increment can be negative. <b>gridMovedColumn</b> when column is moved. Listener receives following argument: { fieldId: [number] zero-based id of the moved field, position: [number] new zero-based column position } <b>gridCellMousedown</b> when mouse down event occurs on the cell's td element. Listener receives two arguments: row id and cell id. </pre> </UL> <UL> <B>Parameters:</B> <UL><CODE>oArg</CODE> - User configuration </UL> </UL> <!-- Constructor return value(s) --> <!-- End constructor return value(s) --> <!-- ADDITIONAL ATTRIBUTES --> <HR/> <!-- END ADDITIONAL ATTRIBUTES --> <!-- ========= CONSTRUCTOR DETAIL END ======== --> <!-- ============ METHOD DETAIL START ========== --> <A NAME="method_detail"><!-- --></A> <TABLE BORDER="1" CELLPADDING="3" CELLSPACING="0" WIDTH="100%"> <TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor"> <TD COLSPAN=1><FONT SIZE="+2"> <B>Method Detail</B></FONT> </TD> </TR> </TABLE> <!-- One single method detail entry --> <A NAME="addFilterOut"><!-- --></A> <H3>addFilterOut</H3> <PRE>void <B>addFilterOut</B>(<object> oArg)</PRE> <UL>Adds filter out to the Grid. See <b>filterOut</b> config option for details.</UL> <!-- METHOD PARAMETERS START --> <UL> <B>Parameters:</B> <UL><CODE>oArg</CODE> - Argument object (see <b>filterOut</b> config option for description) </UL> </UL> <!-- METHOD PARAMETERS END --> <!-- ADDITIONAL ATTRIBUTES START --> <!-- ADDITIONAL ATTRIBUTES END --> <HR> <A NAME="applyPaging"><!-- --></A> <H3>applyPaging</H3> <PRE>object <B>applyPaging</B>()</PRE> <UL>Returns array of rows that are or must be (depending on context) displayed on the current page.</UL> <!-- METHOD PARAMETERS START --> <!-- METHOD PARAMETERS END --> <UL> <B>Returns:</B> <UL> Array of rows on the current page </UL> </UL> <!-- ADDITIONAL ATTRIBUTES START --> <!-- ADDITIONAL ATTRIBUTES END --> <HR> <A NAME="autoresize"><!-- --></A> <H3>autoresize</H3> <PRE>void <B>autoresize</B>()</PRE> <UL>Adjusts number of rows per page in the grid when <b>fitInto</b> config option is used. Calculates approximate number of rows per page and adjusts the grid. Then attaches itself to <b>gridRefreshed</b> event and redraws grid. When <b>gridRefreshed</b> event occurs, detaches itself from the event, corrects adjustment after grid has been redrawn and we know precise row heights. Then redraws grid again. <pre> Defines internal property <b>autoresizeState</b>. </pre></UL> <!-- METHOD PARAMETERS START --> <!-- METHOD PARAMETERS END --> <!-- ADDITIONAL ATTRIBUTES START --> <!-- ADDITIONAL ATTRIBUTES END --> <HR> <A NAME="changeColumnWidth"><!-- --></A> <H3>changeColumnWidth</H3> <PRE>void <B>changeColumnWidth</B>(<string> iWidth)</PRE> <UL>Changes width of all columns. Useful for dynamic grid resizing.</UL> <!-- METHOD PARAMETERS START --> <UL> <B>Parameters:</B> <UL><CODE>iWidth</CODE> - New column width in px </UL> </UL> <!-- METHOD PARAMETERS END --> <!-- ADDITIONAL ATTRIBUTES START --> <!-- ADDITIONAL ATTRIBUTES END --> <HR> <A NAME="clearSelection"><!-- --></A> <H3>clearSelection</H3> <PRE>void <B>clearSelection</B>()</PRE> <UL>Unselects all selected rows and cells.</UL> <!-- METHOD PARAMETERS START --> <!-- METHOD PARAMETERS END --> <!-- ADDITIONAL ATTRIBUTES START --> <!-- ADDITIONAL ATTRIBUTES END --> <HR> <A NAME="convertBoolean"><!-- --></A> <H3>convertBoolean</H3> <PRE>object <B>convertBoolean</B>(<object> oCell)</PRE> <UL>Converts cell to boolean data type.</UL> <!-- METHOD PARAMETERS START --> <UL> <B>Parameters:</B> <UL><CODE>oCell</CODE> - Cell object </UL> </UL> <!-- METHOD PARAMETERS END --> <UL> <B>Returns:</B> <UL> Converted cell object </UL> </UL> <!-- ADDITIONAL ATTRIBUTES START --> <!-- ADDITIONAL ATTRIBUTES END --> <HR> <A NAME="convertBooleanTF"><!-- --></A> <H3>convertBooleanTF</H3> <PRE>object <B>convertBooleanTF</B>(<object> oCell)</PRE> <UL>Converts cell to boolean data type.</UL> <!-- METHOD PARAMETERS START --> <UL> <B>Parameters:</B> <UL><CODE>oCell</CODE> - Cell object </UL> </UL> <!-- METHOD PARAMETERS END --> <UL> <B>Returns:</B> <UL> Converted cell object </UL> </UL> <!-- ADDITIONAL ATTRIBUTES START --> <!-- ADDITIONAL ATTRIBUTES END --> <HR> <A NAME="convertDate"><!-- --></A> <H3>convertDate</H3> <PRE>object <B>convertDate</B>(<object> oCell)</PRE> <UL>Converts cell to date data type.</UL> <!-- METHOD PARAMETERS START --> <UL> <B>Parameters:</B> <UL><CODE>oCell</CODE> - Cell object </UL> </UL> <!-- METHOD PARAMETERS END --> <UL> <B>Returns:</B> <UL> Converted cell object </UL> </UL> <!-- ADDITIONAL ATTRIBUTES START --> <!-- ADDITIONAL ATTRIBUTES END --> <HR> <A NAME="convertFloat"><!-- --></A> <H3>convertFloat</H3> <PRE>object <B>convertFloat</B>(<object> oCell)</PRE> <UL>Converts cell to float data type.</UL> <!-- METHOD PARAMETERS START --> <UL> <B>Parameters:</B> <UL><CODE>oCell</CODE> - Cell object </UL> </UL> <!-- METHOD PARAMETERS END --> <UL> <B>Returns:</B> <UL> Converted cell object </UL> </UL> <!-- ADDITIONAL ATTRIBUTES START --> <!-- ADDITIONAL ATTRIBUTES END --> <HR> <A NAME="convertFloatGerman"><!-- --></A> <H3>convertFloatGerman</H3> <PRE>object <B>convertFloatGerman</B>(<object> oCell)</PRE> <UL>Converts cell containing number in German format to float data type.</UL> <!-- METHOD PARAMETERS START --> <UL> <B>Parameters:</B> <UL><CODE>oCell</CODE> - Cell object </UL> </UL> <!-- METHOD PARAMETERS END --> <UL> <B>Returns:</B> <UL> Converted cell object </UL> </UL> <!-- ADDITIONAL ATTRIBUTES START --> <!-- ADDITIONAL ATTRIBUTES END --> <HR> <A NAME="convertInsensitiveString"><!-- --></A> <H3>convertInsensitiveString</H3> <PRE>object <B>convertInsensitiveString</B>(<object> oCell)</PRE> <UL>Converts cell to insensitive string data type.</UL> <!-- METHOD PARAMETERS START --> <UL> <B>Parameters:</B> <UL><CODE>oCell</CODE> - Cell object </UL> </UL> <!-- METHOD PARAMETERS END --> <UL> <B>Returns:</B> <UL> Converted cell object </UL> </UL> <!-- ADDITIONAL ATTRIBUTES START --> <!-- ADDITIONAL ATTRIBUTES END --> <HR> <A NAME="convertInteger"><!-- --></A> <H3>convertInteger</H3> <PRE>object <B>convertInteger</B>(<object> oCell)</PRE> <UL>Converts cell to integer data type.</UL> <!-- METHOD PARAMETERS START --> <UL> <B>Parameters:</B> <UL><CODE>oCell</CODE> - Cell object </UL> </UL> <!-- METHOD PARAMETERS END --> <UL> <B>Returns:</B> <UL> Converted cell object </UL> </UL> <!-- ADDITIONAL ATTRIBUTES START --> <!-- ADDITIONAL ATTRIBUTES END --> <HR> <A NAME="convertIntegerGerman"><!-- --></A> <H3>convertIntegerGerman</H3> <PRE>object <B>convertIntegerGerman</B>(<object> oCell)</PRE> <UL>Converts cell containing number in German format to integer data type.</UL> <!-- METHOD PARAMETERS START --> <UL> <B>Parameters:</B> <UL><CODE>oCell</CODE> - Cell object </UL> </UL> <!-- METHOD PARAMETERS END --> <UL> <B>Returns:</B> <UL> Converted cell object </UL> </UL> <!-- ADDITIONAL ATTRIBUTES START --> <!-- ADDITIONAL ATTRIBUTES END --> <HR> <A NAME="convertString"><!-- --></A> <H3>convertString</H3> <PRE>object <B>convertString</B>(<object> oCell)</PRE> <UL>Converts cell to string data type.</UL> <!-- METHOD PARAMETERS START --> <UL> <B>Parameters:</B> <UL><CODE>oCell</CODE> - Cell object </UL> </UL> <!-- METHOD PARAMETERS END --> <UL> <B>Returns:</B> <UL> Converted cell object </UL> </UL> <!-- ADDITIONAL ATTRIBUTES START --> <!-- ADDITIONAL ATTRIBUTES END --> <HR> <A NAME="convertTime"><!-- --></A> <H3>convertTime</H3> <PRE>object <B>convertTime</B>(<object> oCell)</PRE> <UL>Converts cell to time data type. <pre> Following time formats are recognized: 1) HH:MM:SS 2) HH:MM:SS AM/PM 3) HH:MM 4) HH:MM AM/PM 5) HHMMSS 6) HHMMSS AM/PM 7) HHMM 8) HHMM AM/PM Any type of separator can be used. Examples: 1.40AM, 05-06-02, 3:8:1, 0205[PM], etc. </pre></UL> <!-- METHOD PARAMETERS START --> <UL> <B>Parameters:</B> <UL><CODE>oCell</CODE> - Cell object </UL> </UL> <!-- METHOD PARAMETERS END --> <UL> <B>Returns:</B> <UL> Converted cell object </UL> </UL> <!-- ADDITIONAL ATTRIBUTES START --> <!-- ADDITIONAL ATTRIBUTES END --> <HR> <A NAME="convertTimestampDDMMYYYY"><!-- --></A> <H3>convertTimestampDDMMYYYY</H3> <PRE>object <B>convertTimestampDDMMYYYY</B>(<object> oCell)</PRE> <UL>Converts cell to UNIX timestamp data type. Value displayed in DD/MM/YYYY format.</UL> <!-- METHOD PARAMETERS START --> <UL> <B>Parameters:</B> <UL><CODE>oCell</CODE> - Cell object </UL> </UL> <!-- METHOD PARAMETERS END --> <UL> <B>Returns:</B> <UL> Converted cell object </UL> </UL> <!-- ADDITIONAL ATTRIBUTES START --> <!-- ADDITIONAL ATTRIBUTES END --> <HR> <A NAME="convertTimestampLocale"><!-- --></A> <H3>convertTimestampLocale</H3> <PRE>object <B>convertTimestampLocale</B>(<object> oCell)</PRE> <UL>Converts cell to UNIX timestamp data type.</UL> <!-- METHOD PARAMETERS START --> <UL> <B>Parameters:</B> <UL><CODE>oCell</CODE> - Cell object </UL> </UL> <!-- METHOD PARAMETERS END --> <UL> <B>Returns:</B> <UL> Converted cell object </UL> </UL> <!-- ADDITIONAL ATTRIBUTES START --> <!-- ADDITIONAL ATTRIBUTES END --> <HR> <A NAME="convertTimestampMMDDYYYY"><!-- --></A> <H3>convertTimestampMMDDYYYY</H3> <PRE>object <B>convertTimestampMMDDYYYY</B>(<object> oCell)</PRE> <UL>Converts cell to UNIX timestamp data type. Value displayed in MM/DD/YYYY format.</UL> <!-- METHOD PARAMETERS START --> <UL> <B>Parameters:</B> <UL><CODE>oCell</CODE> - Cell object </UL> </UL> <!-- METHOD PARAMETERS END --> <UL> <B>Returns:</B> <UL> Converted cell object </UL> </UL> <!-- ADDITIONAL ATTRIBUTES START --> <!-- ADDITIONAL ATTRIBUTES END --> <HR> <A NAME="convertTimestampYYYYMMDD"><!-- --></A> <H3>convertTimestampYYYYMMDD</H3> <PRE>object <B>convertTimestampYYYYMMDD</B>(<object> oCell)</PRE> <UL>Converts cell to UNIX timestamp data type. Value displayed in YYYY/MM/DD format.</UL> <!-- METHOD PARAMETERS START --> <UL> <B>Parameters:</B> <UL><CODE>oCell</CODE> - Cell object </UL> </UL> <!-- METHOD PARAMETERS END --> <UL> <B>Returns:</B> <UL> Converted cell object </UL> </UL> <!-- ADDITIONAL ATTRIBUTES START --> <!-- ADDITIONAL ATTRIBUTES END --> <HR> <A NAME="deleteColumns"><!-- --></A> <H3>deleteColumns</H3> <PRE>number <B>deleteColumns</B>(<object> oArg)</PRE> <UL>Deletes specified columns. <pre> Argument object format: { columns: [object or number] Array of zero-based column numbers or single zero-based column number, noRefresh: [boolean] If true, grid is not refreshed. Useful when you need to delete some columns and to insert other columns } </pre></UL> <!-- METHOD PARAMETERS START --> <UL> <B>Parameters:</B> <UL><CODE>oArg</CODE> - Argument object </UL> </UL> <!-- METHOD PARAMETERS END --> <UL> <B>Returns:</B> <UL> Number of deleted columns </UL> </UL> <!-- ADDITIONAL ATTRIBUTES START --> <!-- ADDITIONAL ATTRIBUTES END --> <HR> <A NAME="displayFilterOut"><!-- --></A> <H3>displayFilterOut</H3> <PRE>void <B>displayFilterOut</B>()</PRE> <UL>Displays filter out forms. Useful after <a href="../Zapatec/Grid.html#addFilterOut">Zapatec.Grid.addFilterOut()</a>.</UL> <!-- METHOD PARAMETERS START --> <!-- METHOD PARAMETERS END --> <!-- ADDITIONAL ATTRIBUTES START --> <!-- ADDITIONAL ATTRIBUTES END --> <HR> <A NAME="editSelectedCells"><!-- --></A> <H3>editSelectedCells</H3> <PRE>void <B>editSelectedCells</B>(<object> oEditor)</PRE> <UL>Passes array of selected cells to the specified editor.</UL> <!-- METHOD PARAMETERS START --> <UL> <B>Parameters:</B> <UL><CODE>oEditor</CODE> - Widget object used as editor </UL> </UL> <!-- METHOD PARAMETERS END --> <!-- ADDITIONAL ATTRIBUTES START --> <!-- ADDITIONAL ATTRIBUTES END --> <HR> <A NAME="editSelectedRows"><!-- --></A> <H3>editSelectedRows</H3> <PRE>void <B>editSelectedRows</B>(<object> oEditor)</PRE> <UL>Passes array of selected rows to the specified editor.</UL> <!-- METHOD PARAMETERS START --> <UL> <B>Parameters:</B> <UL><CODE>oEditor</CODE> - Widget object used as editor </UL> </UL> <!-- METHOD PARAMETERS END --> <!-- ADDITIONAL ATTRIBUTES START --> <!-- ADDITIONAL ATTRIBUTES END --> <HR> <A NAME="exportDataJson"><!-- --></A> <H3>exportDataJson</H3> <PRE>object <B>exportDataJson</B>(<string> strMode)</PRE> <UL>Exports grid data as object. Returned object may be converted to JSON string using Zapatec.Transport.serializeJsonObj function.</UL> <!-- METHOD PARAMETERS START --> <UL> <B>Parameters:</B> <UL><CODE>strMode</CODE> - Optional. 'asis' - returns data object as is; 'compact' - returns minimal data object to be able to initialize grid with "dataPrepared" option turned off; undefined - returns minimal data object to be able to initialize grid with "dataPrepared" option turned on </UL> </UL> <!-- METHOD PARAMETERS END --> <UL> <B>Returns:</B> <UL> Object in the same format as JSON input data (see Zapatec.Grid constructor description) </UL> </UL> <!-- ADDITIONAL ATTRIBUTES START --> <!-- ADDITIONAL ATTRIBUTES END --> <HR> <A NAME="filterOut"><!-- --></A> <H3>filterOut</H3> <PRE>void <B>filterOut</B>(<object> oArg)</PRE> <UL>Filters out rows with the specified value in the specified column or set of columns. <pre> Arguments format: { column: [object or number] array of zero-based column numbers or single zero-based column number to filter, value: [object or string] array of values or single value to filter out, show: [boolean] show rows having this value or not } </pre></UL> <!-- METHOD PARAMETERS START --> <UL> <B>Parameters:</B> <UL><CODE>oArg</CODE> - Arguments </UL> </UL> <!-- METHOD PARAMETERS END --> <!-- ADDITIONAL ATTRIBUTES START --> <!-- ADDITIONAL ATTRIBUTES END --> <HR> <A NAME="flatfile"><!-- --></A> <H3>flatfile</H3> <PRE>string <B>flatfile</B>(<string> FS, <string> RS, <number> iMode)</PRE> <UL>Returns flatfile of grid. Each field is separated by FS, if FS in field then enclose in double quotes. Each record is separated by RS.</UL> <!-- METHOD PARAMETERS START --> <UL> <B>Parameters:</B> <UL><CODE>FS</CODE> - To separate each field </UL> <UL><CODE>RS</CODE> - To separate each row </UL> <UL><CODE>iMode</CODE> - Mode of show data, 1=Check As Is, 2=Force Grid Type, 3=Force As Is </UL> </UL> <!-- METHOD PARAMETERS END --> <UL> <B>Returns:</B> <UL> String of grid in flatfile format </UL> </UL> <!-- ADDITIONAL ATTRIBUTES START --> <!-- ADDITIONAL ATTRIBUTES END --> <HR> <A NAME="getCellById"><!-- --></A> <H3>getCellById</H3> <PRE>object <B>getCellById</B>(<number> iRowId, <number> iCellId)</PRE> <UL>Finds cell by its row id and cell id.</UL> <!-- METHOD PARAMETERS START --> <UL> <B>Parameters:</B> <UL><CODE>iRowId</CODE> - Row id </UL> <UL><CODE>iCellId</CODE> - Cell id </UL> </UL> <!-- METHOD PARAMETERS END --> <UL> <B>Returns:</B> <UL> Cell object or undefined if not found </UL> </UL> <!-- ADDITIONAL ATTRIBUTES START --> <!-- ADDITIONAL ATTRIBUTES END --> <HR> <A NAME="getCellByRow"><!-- --></A> <H3>getCellByRow</H3> <PRE>object <B>getCellByRow</B>(<object> oRow, <number> iCellId)</PRE> <UL>Finds cell by its row and cell id.</UL> <!-- METHOD PARAMETERS START --> <UL> <B>Parameters:</B> <UL><CODE>oRow</CODE> - Row object </UL> <UL><CODE>iCellId</CODE> - Cell id </UL> </UL> <!-- METHOD PARAMETERS END --> <UL> <B>Returns:</B> <UL> Cell object or undefined if not found </UL> </UL> <!-- ADDITIONAL ATTRIBUTES START --> <!-- ADDITIONAL ATTRIBUTES END --> <HR> <A NAME="getCellData"><!-- --></A> <H3>getCellData</H3> <PRE>string <B>getCellData</B>(<object> oCell, <number> iMode)</PRE> <UL>Returns data to be displayed in grid cell.</UL> <!-- METHOD PARAMETERS START --> <UL> <B>Parameters:</B> <UL><CODE>oCell</CODE> - Cell object </UL> <UL><CODE>iMode</CODE> - Optional. Mode for show as is: 1 = check show_asis, 2 = show converted, 3 = show as is with any conversion, 4 = original value. Default: 1. </UL> </UL> <!-- METHOD PARAMETERS END --> <UL> <B>Returns:</B> <UL> Data to display for this cell </UL> </UL> <!-- ADDITIONAL ATTRIBUTES START --> <!-- ADDITIONAL ATTRIBUTES END --> <HR> <A NAME="getCellDataType"><!-- --></A> <H3>getCellDataType</H3> <PRE>string <B>getCellDataType</B>(<object> oCell)</PRE> <UL>Returns cell data type.</UL> <!-- METHOD PARAMETERS START --> <UL> <B>Parameters:</B> <UL><CODE>oCell</CODE> - Cell object </UL> </UL> <!-- METHOD PARAMETERS END --> <UL> <B>Returns:</B> <UL> Cell data type or undefined if not found </UL> </UL> <!-- ADDITIONAL ATTRIBUTES START --> <!-- ADDITIONAL ATTRIBUTES END --> <HR> <A NAME="getCellElement"><!-- --></A> <H3>getCellElement</H3> <PRE>object <B>getCellElement</B>(<object> oCell)</PRE> <UL>Returns table cell element or undefined if cell is on different page or not found.</UL> <!-- METHOD PARAMETERS START --> <UL> <B>Parameters:</B> <UL><CODE>oCell</CODE> - Cell object </UL> </UL> <!-- METHOD PARAMETERS END --> <UL> <B>Returns:</B> <UL> Table cell element </UL> </UL> <!-- ADDITIONAL ATTRIBUTES START --> <!-- ADDITIONAL ATTRIBUTES END --> <HR> <A NAME="getCellId"><!-- --></A> <H3>getCellId</H3> <PRE>number <B>getCellId</B>(<object> oCell)</PRE> <UL>Returns cell id.</UL> <!-- METHOD PARAMETERS START --> <UL> <B>Parameters:</B> <UL><CODE>oCell</CODE> - Cell object </UL> </UL> <!-- METHOD PARAMETERS END --> <UL> <B>Returns:</B> <UL> Cell id or undefined if not found </UL> </UL> <!-- ADDITIONAL ATTRIBUTES START --> <!-- ADDITIONAL ATTRIBUTES END --> <HR> <A NAME="getCellRowId"><!-- --></A> <H3>getCellRowId</H3> <PRE>number <B>getCellRowId</B>(<object> oCell)</PRE> <UL>Returns cell row id.</UL> <!-- METHOD PARAMETERS START --> <UL> <B>Parameters:</B> <UL><CODE>oCell</CODE> - Cell object </UL> </UL> <!-- METHOD PARAMETERS END --> <UL> <B>Returns:</B> <UL> Cell row id or undefined if not found </UL> </UL> <!-- ADDITIONAL ATTRIBUTES START --> <!-- ADDITIONAL ATTRIBUTES END --> <HR> <A NAME="getCellRowNumber"><!-- --></A> <H3>getCellRowNumber</H3> <PRE>number <B>getCellRowNumber</B>(<object> oCell)</PRE> <UL>Returns cell visible row number.</UL> <!-- METHOD PARAMETERS START --> <UL> <B>Parameters:</B> <UL><CODE>oCell</CODE> - Cell object </UL> </UL> <!-- METHOD PARAMETERS END --> <UL> <B>Returns:</B> <UL> Cell row number or undefined if not found </UL> </UL> <!-- ADDITIONAL ATTRIBUTES START --> <!-- ADDITIONAL ATTRIBUTES END --> <HR> <A NAME="getCellSelected"><!-- --></A> <H3>getCellSelected</H3> <PRE>boolean <B>getCellSelected</B>(<object> oCell)</PRE> <UL>Returns true if cell is selected.</UL> <!-- METHOD PARAMETERS START --> <UL> <B>Parameters:</B> <UL><CODE>oCell</CODE> - Cell object </UL> </UL> <!-- METHOD PARAMETERS END --> <UL> <B>Returns:</B> <UL> true if cell is selected </UL> </UL> <!-- ADDITIONAL ATTRIBUTES START --> <!-- ADDITIONAL ATTRIBUTES END --> <HR> <A NAME="getCellStyle"><!-- --></A> <H3>getCellStyle</H3> <PRE>string <B>getCellStyle</B>(<object> oCell, <number> iRow)</PRE> <UL>Returns cell style defined by user.</UL> <!-- METHOD PARAMETERS START --> <UL> <B>Parameters:</B> <UL><CODE>oCell</CODE> - Cell object </UL> <UL><CODE>iRow</CODE> - Row number passed to funcStyle </UL> </UL> <!-- METHOD PARAMETERS END --> <UL> <B>Returns:</B> <UL> User defined cell style </UL> </UL> <!-- ADDITIONAL ATTRIBUTES START --> <!-- ADDITIONAL ATTRIBUTES END --> <HR> <A NAME="getCellValue"><!-- --></A> <H3>getCellValue</H3> <PRE>any <B>getCellValue</B>(<object> oCell)</PRE> <UL>Returns cell value to display.</UL> <!-- METHOD PARAMETERS START --> <UL> <B>Parameters:</B> <UL><CODE>oCell</CODE> - Cell object </UL> </UL> <!-- METHOD PARAMETERS END --> <UL> <B>Returns:</B> <UL> Cell value to display </UL> </UL> <!-- ADDITIONAL ATTRIBUTES START --> <!-- ADDITIONAL ATTRIBUTES END --> <HR> <A NAME="getCellValueCompare"><!-- --></A> <H3>getCellValueCompare</H3> <PRE>any <B>getCellValueCompare</B>(<object> oCell)</PRE> <UL>Returns cell value to compare.</UL> <!-- METHOD PARAMETERS START --> <UL> <B>Parameters:</B> <UL><CODE>oCell</CODE> - Cell object </UL> </UL> <!-- METHOD PARAMETERS END --> <UL> <B>Returns:</B> <UL> Cell value to compare </UL> </UL> <!-- ADDITIONAL ATTRIBUTES START --> <!-- ADDITIONAL ATTRIBUTES END --> <HR> <A NAME="getCellValueOriginal"><!-- --></A> <H3>getCellValueOriginal</H3> <PRE>any <B>getCellValueOriginal</B>(<object> oCell)</PRE> <UL>Returns original cell value.</UL> <!-- METHOD PARAMETERS START --> <UL> <B>Parameters:</B> <UL><CODE>oCell</CODE> - Cell object </UL> </UL> <!-- METHOD PARAMETERS END --> <UL> <B>Returns:</B> <UL> Original cell value </UL> </UL> <!-- ADDITIONAL ATTRIBUTES START --> <!-- ADDITIONAL ATTRIBUTES END --> <HR> <A NAME="getCellValueString"><!-- --></A> <H3>getCellValueString</H3> <PRE>string <B>getCellValueString</B>(<object> oCell)</PRE> <UL>Returns cell value to display as string.</UL> <!-- METHOD PARAMETERS START --> <UL> <B>Parameters:</B> <UL><CODE>oCell</CODE> - Cell object </UL> </UL> <!-- METHOD PARAMETERS END --> <UL> <B>Returns:</B> <UL> Cell value to display </UL> </UL> <!-- ADDITIONAL ATTRIBUTES START --> <!-- ADDITIONAL ATTRIBUTES END --> <HR> <A NAME="getClassByType"><!-- --></A> <H3>getClassByType</H3> <PRE>string <B>getClassByType</B>(<string> sType)</PRE> <UL>Returns class name corresponding to data type.</UL> <!-- METHOD PARAMETERS START --> <UL> <B>Parameters:</B> <UL><CODE>sType</CODE> - Data type </UL> </UL> <!-- METHOD PARAMETERS END --> <UL> <B>Returns:</B> <UL> Class name or undefined if not found </UL> </UL> <!-- ADDITIONAL ATTRIBUTES START --> <!-- ADDITIONAL ATTRIBUTES END --> <HR> <A NAME="getColumnRange"><!-- --></A> <H3>getColumnRange</H3> <PRE>object <B>getColumnRange</B>(<object> oArg)</PRE> <UL>Returns range of values of the specified column. If field property "columnRange" of the column is defined, it is returned instead. If array of column numbers is passed, concatenates all specified columns and returns range of values of the result. <pre> Argument object format: { column: [object or number] array of zero-based column numbers or single zero-based column number, filtered: [boolean] use only filtered rows } Return object format: { min: [any] min value to compare, minValue: [string] min value to display, minOrig: [any] min original value, max: [any] max value to compare, maxValue: [string] max value to display, maxOrig: [any] max original value, values: [object] array of unique column values in the following format: [ { c: [any] value to compare, v: [string] value to display, o: [any] original value }, ... ] } </pre></UL> <!-- METHOD PARAMETERS START --> <UL> <B>Parameters:</B> <UL><CODE>oArg</CODE> - Argument object </UL> </UL> <!-- METHOD PARAMETERS END --> <UL> <B>Returns:</B> <UL> Range of column values or null </UL> </UL> <!-- ADDITIONAL ATTRIBUTES START --> <!-- ADDITIONAL ATTRIBUTES END --> <HR> <A NAME="getConvertByType"><!-- --></A> <H3>getConvertByType</H3> <PRE>string <B>getConvertByType</B>(<string> sType)</PRE> <UL>Returns name of convert method corresponding to data type.</UL> <!-- METHOD PARAMETERS START --> <UL> <B>Parameters:</B> <UL><CODE>sType</CODE> - Data type </UL> </UL> <!-- METHOD PARAMETERS END --> <UL> <B>Returns:</B> <UL> Convert method name or undefined if not found </UL> </UL> <!-- ADDITIONAL ATTRIBUTES START --> <!-- ADDITIONAL ATTRIBUTES END --> <HR> <A NAME="getCurrentPageNumber"><!-- --></A> <H3>getCurrentPageNumber</H3> <PRE>number <B>getCurrentPageNumber</B>()</PRE> <UL>Returns current page number.</UL> <!-- METHOD PARAMETERS START --> <!-- METHOD PARAMETERS END --> <UL> <B>Returns:</B> <UL> Current page number </UL> </UL> <!-- ADDITIONAL ATTRIBUTES START --> <!-- ADDITIONAL ATTRIBUTES END --> <HR> <A NAME="getFieldByCell"><!-- --></A> <H3>getFieldByCell</H3> <PRE>object <B>getFieldByCell</B>(<object> oCell)</PRE> <UL>Finds field by cell.</UL> <!-- METHOD PARAMETERS START --> <UL> <B>Parameters:</B> <UL><CODE>oCell</CODE> - Cell object </UL> </UL> <!-- METHOD PARAMETERS END --> <UL> <B>Returns:</B> <UL> Field object or undefined if not found </UL> </UL> <!-- ADDITIONAL ATTRIBUTES START --> <!-- ADDITIONAL ATTRIBUTES END --> <HR> <A NAME="getFieldById"><!-- --></A> <H3>getFieldById</H3> <PRE>object <B>getFieldById</B>(<number> iFieldId)</PRE> <UL>Finds field by its id.</UL> <!-- METHOD PARAMETERS START --> <UL> <B>Parameters:</B> <UL><CODE>iFieldId</CODE> - Field id </UL> </UL> <!-- METHOD PARAMETERS END --> <UL> <B>Returns:</B> <UL> Field object or undefined if not found </UL> </UL> <!-- ADDITIONAL ATTRIBUTES START --> <!-- ADDITIONAL ATTRIBUTES END --> <HR> <A NAME="getFieldElement"><!-- --></A> <H3>getFieldElement</H3> <PRE>object <B>getFieldElement</B>(<object> oField)</PRE> <UL>Returns table cell element or undefined if field is not found. To get field element by cell, pass cell object instead of field.</UL> <!-- METHOD PARAMETERS START --> <UL> <B>Parameters:</B> <UL><CODE>oField</CODE> - Field or cell object </UL> </UL> <!-- METHOD PARAMETERS END --> <UL> <B>Returns:</B> <UL> Table cell element </UL> </UL> <!-- ADDITIONAL ATTRIBUTES START --> <!-- ADDITIONAL ATTRIBUTES END --> <HR> <A NAME="getFieldHidden"><!-- --></A> <H3>getFieldHidden</H3> <PRE>boolean <B>getFieldHidden</B>(<object> oField)</PRE> <UL>Returns true if field is hidden.</UL> <!-- METHOD PARAMETERS START --> <UL> <B>Parameters:</B> <UL><CODE>oField</CODE> - Field object </UL> </UL> <!-- METHOD PARAMETERS END --> <UL> <B>Returns:</B> <UL> True if field is hidden </UL> </UL> <!-- ADDITIONAL ATTRIBUTES START --> <!-- ADDITIONAL ATTRIBUTES END --> <HR> <A NAME="getFieldId"><!-- --></A> <H3>getFieldId</H3> <PRE>number <B>getFieldId</B>(<object> oField)</PRE> <UL>Returns field id.</UL> <!-- METHOD PARAMETERS START --> <UL> <B>Parameters:</B> <UL><CODE>oField</CODE> - Field object </UL> </UL> <!-- METHOD PARAMETERS END --> <UL> <B>Returns:</B> <UL> Field id or undefined if not found </UL> </UL> <!-- ADDITIONAL ATTRIBUTES START --> <!-- ADDITIONAL ATTRIBUTES END --> <HR> <A NAME="getFieldNosort"><!-- --></A> <H3>getFieldNosort</H3> <PRE>boolean <B>getFieldNosort</B>(<object> oField)</PRE> <UL>Returns true if it is not allowed to sort the field.</UL> <!-- METHOD PARAMETERS START --> <UL> <B>Parameters:</B> <UL><CODE>oField</CODE> - Field object </UL> </UL> <!-- METHOD PARAMETERS END --> <UL> <B>Returns:</B> <UL> True if it is not allowed to sort the field </UL> </UL> <!-- ADDITIONAL ATTRIBUTES START --> <!-- ADDITIONAL ATTRIBUTES END --> <HR> <A NAME="getFieldOnclick"><!-- --></A> <H3>getFieldOnclick</H3> <PRE>string <B>getFieldOnclick</B>(<object> oField)</PRE> <UL>Forms field onclick attribute value.</UL> <!-- METHOD PARAMETERS START --> <UL> <B>Parameters:</B> <UL><CODE>oField</CODE> - Field object </UL> </UL> <!-- METHOD PARAMETERS END --> <UL> <B>Returns:</B> <UL> Field onclick attribute value </UL> </UL> <!-- ADDITIONAL ATTRIBUTES START --> <!-- ADDITIONAL ATTRIBUTES END --> <HR> <A NAME="getFields"><!-- --></A> <H3>getFields</H3> <PRE>object <B>getFields</B>(<object> oArg)</PRE> <UL>Returns reference to private array containing grid fields. <pre> Arguments format: { visible: [boolean, optional] if true, result array will contain only visible fields } </pre></UL> <!-- METHOD PARAMETERS START --> <UL> <B>Parameters:</B> <UL><CODE>oArg</CODE> - Arguments </UL> </UL> <!-- METHOD PARAMETERS END --> <UL> <B>Returns:</B> <UL> Grid fields array </UL> </UL> <!-- ADDITIONAL ATTRIBUTES START --> <!-- ADDITIONAL ATTRIBUTES END --> <HR> <A NAME="getFieldSorted"><!-- --></A> <H3>getFieldSorted</H3> <PRE>boolean <B>getFieldSorted</B>(<object> oField)</PRE> <UL>Returns true if the field is sorted ascending.</UL> <!-- METHOD PARAMETERS START --> <UL> <B>Parameters:</B> <UL><CODE>oField</CODE> - Field object </UL> </UL> <!-- METHOD PARAMETERS END --> <UL> <B>Returns:</B> <UL> True if the field is sorted ascending </UL> </UL> <!-- ADDITIONAL ATTRIBUTES START --> <!-- ADDITIONAL ATTRIBUTES END --> <HR> <A NAME="getFieldSortedDesc"><!-- --></A> <H3>getFieldSortedDesc</H3> <PRE>boolean <B>getFieldSortedDesc</B>(<object> oField)</PRE> <UL>Returns true if the field is sorted descending.</UL> <!-- METHOD PARAMETERS START --> <UL> <B>Parameters:</B> <UL><CODE>oField</CODE> - Field object </UL> </UL> <!-- METHOD PARAMETERS END --> <UL> <B>Returns:</B> <UL> True if the field is sorted descending </UL> </UL> <!-- ADDITIONAL ATTRIBUTES START --> <!-- ADDITIONAL ATTRIBUTES END --> <HR> <A NAME="getFieldSpan"><!-- --></A> <H3>getFieldSpan</H3> <PRE>string <B>getFieldSpan</B>(<object> oField)</PRE> <UL>Returns field span value.</UL> <!-- METHOD PARAMETERS START --> <UL> <B>Parameters:</B> <UL><CODE>oField</CODE> - Field object </UL> </UL> <!-- METHOD PARAMETERS END --> <UL> <B>Returns:</B> <UL> Span title </UL> </UL> <!-- ADDITIONAL ATTRIBUTES START --> <!-- ADDITIONAL ATTRIBUTES END --> <HR> <A NAME="getFieldSpanned"><!-- --></A> <H3>getFieldSpanned</H3> <PRE>object <B>getFieldSpanned</B>(<object> oField)</PRE> <UL>Returns spanned columns number and spanned fields array. If there is no span, returns undefined. <pre> Format of returned object: { spanned: [number] spanned columns number, fields: [object] array of spanned field objects } </pre></UL> <!-- METHOD PARAMETERS START --> <UL> <B>Parameters:</B> <UL><CODE>oField</CODE> - Field object </UL> </UL> <!-- METHOD PARAMETERS END --> <UL> <B>Returns:</B> <UL> Span properties </UL> </UL> <!-- ADDITIONAL ATTRIBUTES START --> <!-- ADDITIONAL ATTRIBUTES END --> <HR> <A NAME="getFieldSpanStyle"><!-- --></A> <H3>getFieldSpanStyle</H3> <PRE>string <B>getFieldSpanStyle</B>(<object> oField)</PRE> <UL>Returns field span style defined by user.</UL> <!-- METHOD PARAMETERS START --> <UL> <B>Parameters:</B> <UL><CODE>oField</CODE> - Field object </UL> </UL> <!-- METHOD PARAMETERS END --> <UL> <B>Returns:</B> <UL> Span style </UL> </UL> <!-- ADDITIONAL ATTRIBUTES START --> <!-- ADDITIONAL ATTRIBUTES END --> <HR> <A NAME="getFieldSpanTitle"><!-- --></A> <H3>getFieldSpanTitle</H3> <PRE>string <B>getFieldSpanTitle</B>(<object> oField)</PRE> <UL>Returns field span title.</UL> <!-- METHOD PARAMETERS START --> <UL> <B>Parameters:</B> <UL><CODE>oField</CODE> - Field object </UL> </UL> <!-- METHOD PARAMETERS END --> <UL> <B>Returns:</B> <UL> Span title </UL> </UL> <!-- ADDITIONAL ATTRIBUTES START --> <!-- ADDITIONAL ATTRIBUTES END --> <HR> <A NAME="getFieldStyle"><!-- --></A> <H3>getFieldStyle</H3> <PRE>string <B>getFieldStyle</B>(<object> oField)</PRE> <UL>Returns field style defined by user.</UL> <!-- METHOD PARAMETERS START --> <UL> <B>Parameters:</B> <UL><CODE>oField</CODE> - Field object </UL> </UL> <!-- METHOD PARAMETERS END --> <UL> <B>Returns:</B> <UL> Field style </UL> </UL> <!-- ADDITIONAL ATTRIBUTES START --> <!-- ADDITIONAL ATTRIBUTES END --> <HR> <A NAME="getFieldTitle"><!-- --></A> <H3>getFieldTitle</H3> <PRE>string <B>getFieldTitle</B>(<object> oField)</PRE> <UL>Returns column title.</UL> <!-- METHOD PARAMETERS START --> <UL> <B>Parameters:</B> <UL><CODE>oField</CODE> - Field object </UL> </UL> <!-- METHOD PARAMETERS END --> <UL> <B>Returns:</B> <UL> Column title </UL> </UL> <!-- ADDITIONAL ATTRIBUTES START --> <!-- ADDITIONAL ATTRIBUTES END --> <HR> <A NAME="getFieldType"><!-- --></A> <H3>getFieldType</H3> <PRE>string <B>getFieldType</B>(<object> oField)</PRE> <UL>Returns field data type.</UL> <!-- METHOD PARAMETERS START --> <UL> <B>Parameters:</B> <UL><CODE>oField</CODE> - Field object </UL> </UL> <!-- METHOD PARAMETERS END --> <UL> <B>Returns:</B> <UL> Field data type or undefined if not found </UL> </UL> <!-- ADDITIONAL ATTRIBUTES START --> <!-- ADDITIONAL ATTRIBUTES END --> <HR> <A NAME="getFieldWidth"><!-- --></A> <H3>getFieldWidth</H3> <PRE>string <B>getFieldWidth</B>(<object> oField)</PRE> <UL>Returns column width defined by user.</UL> <!-- METHOD PARAMETERS START --> <UL> <B>Parameters:</B> <UL><CODE>oField</CODE> - Field object </UL> </UL> <!-- METHOD PARAMETERS END --> <UL> <B>Returns:</B> <UL> Column width </UL> </UL> <!-- ADDITIONAL ATTRIBUTES START --> <!-- ADDITIONAL ATTRIBUTES END --> <HR> <A NAME="getFilteredRows"><!-- --></A> <H3>getFilteredRows</H3> <PRE>object <B>getFilteredRows</B>()</PRE> <UL>Returns reference to private array containing filtered rows. Note: to get currently displayed rows use <a href="../Zapatec/Grid.html#applyPaging">Zapatec.Grid.applyPaging()</a> method instead.</UL> <!-- METHOD PARAMETERS START --> <!-- METHOD PARAMETERS END --> <UL> <B>Returns:</B> <UL> Filtered rows array </UL> </UL> <!-- ADDITIONAL ATTRIBUTES START --> <!-- ADDITIONAL ATTRIBUTES END --> <HR> <A NAME="getGridDimensions"><!-- --></A> <H3>getGridDimensions</H3> <PRE>object <B>getGridDimensions</B>()</PRE> <UL>Returns real width and height of the grid after it has been drawn. <pre> Format of returned object: { width: [number] width of the grid in pixels, height: [number] height of the grid in pixels } </pre></UL> <!-- METHOD PARAMETERS START --> <!-- METHOD PARAMETERS END --> <UL> <B>Returns:</B> <UL> Object containing width and height of the grid </UL> </UL> <!-- ADDITIONAL ATTRIBUTES START --> <!-- ADDITIONAL ATTRIBUTES END --> <HR> <A NAME="getHeaderStyle"><!-- --></A> <H3>getHeaderStyle</H3> <PRE>string <B>getHeaderStyle</B>()</PRE> <UL>Returns grid header style defined by user.</UL> <!-- METHOD PARAMETERS START --> <!-- METHOD PARAMETERS END --> <UL> <B>Returns:</B> <UL> Grid header style </UL> </UL> <!-- ADDITIONAL ATTRIBUTES START --> <!-- ADDITIONAL ATTRIBUTES END --> <HR> <A NAME="getId"><!-- --></A> <H3>getId</H3> <PRE>number <B>getId</B>()</PRE> <UL>Returns grid id.</UL> <!-- METHOD PARAMETERS START --> <!-- METHOD PARAMETERS END --> <UL> <B>Returns:</B> <UL> Grid id </UL> </UL> <!-- ADDITIONAL ATTRIBUTES START --> <!-- ADDITIONAL ATTRIBUTES END --> <HR> <A NAME="getInvalidCells"><!-- --></A> <H3>getInvalidCells</H3> <PRE>object <B>getInvalidCells</B>()</PRE> <UL>Returns cells having invalid value in an array.</UL> <!-- METHOD PARAMETERS START --> <!-- METHOD PARAMETERS END --> <UL> <B>Returns:</B> <UL> Array of cell objects </UL> </UL> <!-- ADDITIONAL ATTRIBUTES START --> <!-- ADDITIONAL ATTRIBUTES END --> <HR> <A NAME="getInvalidRows"><!-- --></A> <H3>getInvalidRows</H3> <PRE>object <B>getInvalidRows</B>()</PRE> <UL>Returns rows with cells having invalid value in an array.</UL> <!-- METHOD PARAMETERS START --> <!-- METHOD PARAMETERS END --> <UL> <B>Returns:</B> <UL> Array of row objects </UL> </UL> <!-- ADDITIONAL ATTRIBUTES START --> <!-- ADDITIONAL ATTRIBUTES END --> <HR> <A NAME="getRowByCell"><!-- --></A> <H3>getRowByCell</H3> <PRE>object <B>getRowByCell</B>(<object> oCell)</PRE> <UL>Finds row by cell.</UL> <!-- METHOD PARAMETERS START --> <UL> <B>Parameters:</B> <UL><CODE>oCell</CODE> - Cell object </UL> </UL> <!-- METHOD PARAMETERS END --> <UL> <B>Returns:</B> <UL> Row object or undefined if not found </UL> </UL> <!-- ADDITIONAL ATTRIBUTES START --> <!-- ADDITIONAL ATTRIBUTES END --> <HR> <A NAME="getRowById"><!-- --></A> <H3>getRowById</H3> <PRE>object <B>getRowById</B>(<number> iRowId)</PRE> <UL>Finds row by its id.</UL> <!-- METHOD PARAMETERS START --> <UL> <B>Parameters:</B> <UL><CODE>iRowId</CODE> - Row id </UL> </UL> <!-- METHOD PARAMETERS END --> <UL> <B>Returns:</B> <UL> Row object or undefined if not found </UL> </UL> <!-- ADDITIONAL ATTRIBUTES START --> <!-- ADDITIONAL ATTRIBUTES END --> <HR> <A NAME="getRowCells"><!-- --></A> <H3>getRowCells</H3> <PRE>object <B>getRowCells</B>(<object> oRow)</PRE> <UL>Returns cells array of the row.</UL> <!-- METHOD PARAMETERS START --> <UL> <B>Parameters:</B> <UL><CODE>oRow</CODE> - Row object </UL> </UL> <!-- METHOD PARAMETERS END --> <UL> <B>Returns:</B> <UL> Array of cell objects or undefined if not found </UL> </UL> <!-- ADDITIONAL ATTRIBUTES START --> <!-- ADDITIONAL ATTRIBUTES END --> <HR> <A NAME="getRowElement"><!-- --></A> <H3>getRowElement</H3> <PRE>object <B>getRowElement</B>(<object> oRow)</PRE> <UL>Returns table row element or undefined if row is on different page or not found.</UL> <!-- METHOD PARAMETERS START --> <UL> <B>Parameters:</B> <UL><CODE>oRow</CODE> - Row object </UL> </UL> <!-- METHOD PARAMETERS END --> <UL> <B>Returns:</B> <UL> Table row element </UL> </UL> <!-- ADDITIONAL ATTRIBUTES START --> <!-- ADDITIONAL ATTRIBUTES END --> <HR> <A NAME="getRowElementByCell"><!-- --></A> <H3>getRowElementByCell</H3> <PRE>object <B>getRowElementByCell</B>(<object> oCell)</PRE> <UL>Returns table row element or undefined if row is on different page or not found.</UL> <!-- METHOD PARAMETERS START --> <UL> <B>Parameters:</B> <UL><CODE>oCell</CODE> - Cell object </UL> </UL> <!-- METHOD PARAMETERS END --> <UL> <B>Returns:</B> <UL> Table row element </UL> </UL> <!-- ADDITIONAL ATTRIBUTES START --> <!-- ADDITIONAL ATTRIBUTES END --> <HR> <A NAME="getRowId"><!-- --></A> <H3>getRowId</H3> <PRE>number <B>getRowId</B>(<object> oRow)</PRE> <UL>Returns row id.</UL> <!-- METHOD PARAMETERS START --> <UL> <B>Parameters:</B> <UL><CODE>oRow</CODE> - Row object </UL> </UL> <!-- METHOD PARAMETERS END --> <UL> <B>Returns:</B> <UL> Row id or undefined if not found </UL> </UL> <!-- ADDITIONAL ATTRIBUTES START --> <!-- ADDITIONAL ATTRIBUTES END --> <HR> <A NAME="getRowNumber"><!-- --></A> <H3>getRowNumber</H3> <PRE>number <B>getRowNumber</B>(<object> oRow)</PRE> <UL>Returns visible row number.</UL> <!-- METHOD PARAMETERS START --> <UL> <B>Parameters:</B> <UL><CODE>oRow</CODE> - Row object </UL> </UL> <!-- METHOD PARAMETERS END --> <UL> <B>Returns:</B> <UL> Row number or undefined if not found </UL> </UL> <!-- ADDITIONAL ATTRIBUTES START --> <!-- ADDITIONAL ATTRIBUTES END --> <HR> <A NAME="getRows"><!-- --></A> <H3>getRows</H3> <PRE>object <B>getRows</B>()</PRE> <UL>Returns reference to private array containing grid rows.</UL> <!-- METHOD PARAMETERS START --> <!-- METHOD PARAMETERS END --> <UL> <B>Returns:</B> <UL> Grid rows array </UL> </UL> <!-- ADDITIONAL ATTRIBUTES START --> <!-- ADDITIONAL ATTRIBUTES END --> <HR> <A NAME="getRowSelected"><!-- --></A> <H3>getRowSelected</H3> <PRE>boolean <B>getRowSelected</B>(<object> oRow)</PRE> <UL>Returns true if row is selected.</UL> <!-- METHOD PARAMETERS START --> <UL> <B>Parameters:</B> <UL><CODE>oRow</CODE> - Row object </UL> </UL> <!-- METHOD PARAMETERS END --> <UL> <B>Returns:</B> <UL> true if row is selected </UL> </UL> <!-- ADDITIONAL ATTRIBUTES START --> <!-- ADDITIONAL ATTRIBUTES END --> <HR> <A NAME="getRowStyle"><!-- --></A> <H3>getRowStyle</H3> <PRE>string <B>getRowStyle</B>(<object> oRow)</PRE> <UL>Returns row style defined by user.</UL> <!-- METHOD PARAMETERS START --> <UL> <B>Parameters:</B> <UL><CODE>oRow</CODE> - Row object </UL> </UL> <!-- METHOD PARAMETERS END --> <UL> <B>Returns:</B> <UL> Row style </UL> </UL> <!-- ADDITIONAL ATTRIBUTES START --> <!-- ADDITIONAL ATTRIBUTES END --> <HR> <A NAME="getSearchByType"><!-- --></A> <H3>getSearchByType</H3> <PRE>string <B>getSearchByType</B>(<string> sType)</PRE> <UL>Returns search method name corresponding to data type.</UL> <!-- METHOD PARAMETERS START --> <UL> <B>Parameters:</B> <UL><CODE>sType</CODE> - Data type </UL> </UL> <!-- METHOD PARAMETERS END --> <UL> <B>Returns:</B> <UL> Search method name or undefined if not found </UL> </UL> <!-- ADDITIONAL ATTRIBUTES START --> <!-- ADDITIONAL ATTRIBUTES END --> <HR> <A NAME="getSelectedCells"><!-- --></A> <H3>getSelectedCells</H3> <PRE>object <B>getSelectedCells</B>()</PRE> <UL>Returns selected cells in an array.</UL> <!-- METHOD PARAMETERS START --> <!-- METHOD PARAMETERS END --> <UL> <B>Returns:</B> <UL> Array of cell objects </UL> </UL> <!-- ADDITIONAL ATTRIBUTES START --> <!-- ADDITIONAL ATTRIBUTES END --> <HR> <A NAME="getSelectedRows"><!-- --></A> <H3>getSelectedRows</H3> <PRE>object <B>getSelectedRows</B>()</PRE> <UL>Returns selected rows in an array.</UL> <!-- METHOD PARAMETERS START --> <!-- METHOD PARAMETERS END --> <UL> <B>Returns:</B> <UL> Array of row objects </UL> </UL> <!-- ADDITIONAL ATTRIBUTES START --> <!-- ADDITIONAL ATTRIBUTES END --> <HR> <A NAME="getStyle"><!-- --></A> <H3>getStyle</H3> <PRE>string <B>getStyle</B>()</PRE> <UL>Returns grid style defined by user.</UL> <!-- METHOD PARAMETERS START --> <!-- METHOD PARAMETERS END --> <UL> <B>Returns:</B> <UL> Grid style </UL> </UL> <!-- ADDITIONAL ATTRIBUTES START --> <!-- ADDITIONAL ATTRIBUTES END --> <HR> <A NAME="getTotals"><!-- --></A> <H3>getTotals</H3> <PRE>object <B>getTotals</B>()</PRE> <UL>Returns array of rows for totals section.</UL> <!-- METHOD PARAMETERS START --> <!-- METHOD PARAMETERS END --> <UL> <B>Returns:</B> <UL> Array of rows for totals section </UL> </UL> <!-- ADDITIONAL ATTRIBUTES START --> <!-- ADDITIONAL ATTRIBUTES END --> <HR> <A NAME="getTypeByClass"><!-- --></A> <H3>getTypeByClass</H3> <PRE>string <B>getTypeByClass</B>(<string> sClass)</PRE> <UL>Returns data type corresponding to class name. Default is "string".</UL> <!-- METHOD PARAMETERS START --> <UL> <B>Parameters:</B> <UL><CODE>sClass</CODE> - className attribute value </UL> </UL> <!-- METHOD PARAMETERS END --> <UL> <B>Returns:</B> <UL> Data type </UL> </UL> <!-- ADDITIONAL ATTRIBUTES START --> <!-- ADDITIONAL ATTRIBUTES END --> <HR> <A NAME="getValidateByType"><!-- --></A> <H3>getValidateByType</H3> <PRE>string <B>getValidateByType</B>(<string> strType)</PRE> <UL>Returns name of validation method corresponding to data type.</UL> <!-- METHOD PARAMETERS START --> <UL> <B>Parameters:</B> <UL><CODE>strType</CODE> - Data type </UL> </UL> <!-- METHOD PARAMETERS END --> <UL> <B>Returns:</B> <UL> Validation method name or undefined if not found </UL> </UL> <!-- ADDITIONAL ATTRIBUTES START --> <!-- ADDITIONAL ATTRIBUTES END --> <HR> <A NAME="gotoHorizontalOffset"><!-- --></A> <H3>gotoHorizontalOffset</H3> <PRE>void <B>gotoHorizontalOffset</B>(<object> oArg)</PRE> <UL>Scrolls grid to the specified column. <pre> Arguments format: { fieldId: [number, optional] zero-based field (column) id, field: [object, optional] field object } Only one of <i>fieldId</i> and <i>field</i> properties should be defined. </pre></UL> <!-- METHOD PARAMETERS START --> <UL> <B>Parameters:</B> <UL><CODE>oArg</CODE> - Arguments </UL> </UL> <!-- METHOD PARAMETERS END --> <!-- ADDITIONAL ATTRIBUTES START --> <!-- ADDITIONAL ATTRIBUTES END --> <HR> <A NAME="gotoPage"><!-- --></A> <H3>gotoPage</H3> <PRE>void <B>gotoPage</B>(<number> iPage)</PRE> <UL>Displays specified page.</UL> <!-- METHOD PARAMETERS START --> <UL> <B>Parameters:</B> <UL><CODE>iPage</CODE> - Zero-based number of page </UL> </UL> <!-- METHOD PARAMETERS END --> <!-- ADDITIONAL ATTRIBUTES START --> <!-- ADDITIONAL ATTRIBUTES END --> <HR> <A NAME="gotoRowId"><!-- --></A> <H3>gotoRowId</H3> <PRE>void <B>gotoRowId</B>(<number> iRowId)</PRE> <UL>Displays page with specified row.</UL> <!-- METHOD PARAMETERS START --> <UL> <B>Parameters:</B> <UL><CODE>iRowId</CODE> - Row id </UL> </UL> <!-- METHOD PARAMETERS END --> <!-- ADDITIONAL ATTRIBUTES START --> <!-- ADDITIONAL ATTRIBUTES END --> <HR> <A NAME="gotoVerticalOffset"><!-- --></A> <H3>gotoVerticalOffset</H3> <PRE>void <B>gotoVerticalOffset</B>(<object> oArg)</PRE> <UL>Scrolls grid to the specified row. <pre> Arguments format: { rowId: [number, optional] zero-based row id row: [object, optional] row object } Only one of <i>rowId</i> and <i>row</i> properties should be defined. </pre></UL> <!-- METHOD PARAMETERS START --> <UL> <B>Parameters:</B> <UL><CODE>oArg</CODE> - Arguments </UL> </UL> <!-- METHOD PARAMETERS END --> <!-- ADDITIONAL ATTRIBUTES START --> <!-- ADDITIONAL ATTRIBUTES END --> <HR> <A NAME="hideColumns"><!-- --></A> <H3>hideColumns</H3> <PRE>void <B>hideColumns</B>(<object> oArg)</PRE> <UL>Hides specified columns. <pre> Argument object format: { columns: [object or number] Array of zero-based column numbers or single zero-based column number, noRefresh: [boolean] If true, grid is not refreshed. Useful when you need to hide some columns and to show other columns } </pre></UL> <!-- METHOD PARAMETERS START --> <UL> <B>Parameters:</B> <UL><CODE>oArg</CODE> - Argument object </UL> </UL> <!-- METHOD PARAMETERS END --> <!-- ADDITIONAL ATTRIBUTES START --> <!-- ADDITIONAL ATTRIBUTES END --> <HR> <A NAME="init"><!-- --></A> <H3>init</H3> <PRE>void <B>init</B>(<object> oArg)</PRE> <UL>Initializes grid.</UL> <!-- METHOD PARAMETERS START --> <UL> <B>Parameters:</B> <UL><CODE>oArg</CODE> - User configuration </UL> </UL> <!-- METHOD PARAMETERS END --> <!-- ADDITIONAL ATTRIBUTES START --> <!-- ADDITIONAL ATTRIBUTES END --> <HR> <A NAME="limitRange"><!-- --></A> <H3>limitRange</H3> <PRE>void <B>limitRange</B>(<object> oArg)</PRE> <UL>Limits range of values of the specified column. <pre> Argument object format: { column: [number] zero-based number of column to filter, min [any, optional] minimum cell value to compare, minValue [any, optional] minimum cell value, max [any, optional] mamximum cell value to compare, maxValue [any, optional] mamximum cell value } If <b>min</b> property is defined, <b>minValue</b> is ignored. If <b>max</b> property is defined, <b>maxValue</b> is ignored. </pre></UL> <!-- METHOD PARAMETERS START --> <UL> <B>Parameters:</B> <UL><CODE>oArg</CODE> - Argument object </UL> </UL> <!-- METHOD PARAMETERS END --> <!-- ADDITIONAL ATTRIBUTES START --> <!-- ADDITIONAL ATTRIBUTES END --> <HR> <A NAME="loadData"><!-- --></A> <H3>loadData</H3> <PRE>void <B>loadData</B>(<object> oArg)</PRE> <UL>Reloads data from the specified source after grid is initialized. Argument should be passed only when dataOnDemand config option is true and callbackSource config option is defined. See description of dataOnDemand config option for details.</UL> <!-- METHOD PARAMETERS START --> <UL> <B>Parameters:</B> <UL><CODE>oArg</CODE> - Optional. Argument object </UL> </UL> <!-- METHOD PARAMETERS END --> <!-- ADDITIONAL ATTRIBUTES START --> <!-- ADDITIONAL ATTRIBUTES END --> <HR> <A NAME="modify"><!-- --></A> <H3>modify</H3> <PRE>void <B>modify</B>()</PRE> <UL>Displays grid after modification of data like splice or query. Updates filters, refreshes the grid and fires gridModified event. Note: To redraw grid if data were not modified, use <a href="../Zapatec/Grid.html#refresh">Zapatec.Grid.refresh()</a> method instead.</UL> <!-- METHOD PARAMETERS START --> <!-- METHOD PARAMETERS END --> <!-- ADDITIONAL ATTRIBUTES START --> <!-- ADDITIONAL ATTRIBUTES END --> <HR> <A NAME="moveColumn"><!-- --></A> <H3>moveColumn</H3> <PRE>boolean <B>moveColumn</B>(<object> oArg)</PRE> <UL>Moves column within the grid. Note: Changes ids of the columns. <pre> Arguments format: { fieldId: [number] zero-based field id to move, position: [number] new zero-based column position, noRefresh: [boolean, optional] indicates that grid should not be refreshed after changing (default is false) (useful when several changes go one by one) } </pre></UL> <!-- METHOD PARAMETERS START --> <UL> <B>Parameters:</B> <UL><CODE>oArg</CODE> - Arguments </UL> </UL> <!-- METHOD PARAMETERS END --> <UL> <B>Returns:</B> <UL> True on success, false on attempt to move column into itself, undefined if arguments are invalid </UL> </UL> <!-- ADDITIONAL ATTRIBUTES START --> <!-- ADDITIONAL ATTRIBUTES END --> <HR> <A NAME="query"><!-- --></A> <H3>query</H3> <PRE>object <B>query</B>(<object> oArgs)</PRE> <UL>Executes query on the grid. <pre> Query object format: { type: [string] query type ('insert', 'update' or 'delete'), rows: [object, optional] array of rows to add (see Zapatec.Grid.prototype.splice for details), values: [object, optional] object with new values of row (see Zapatec.GridQueryUpdate.prototype.execute for details), where: [object, optional] condition statement object (see Zapatec.GridQuery.prototype.compileStatement for details), noRefresh: [boolean, optional] indicates that grid should not be refreshed after changing (default: false) (useful when several changes go one by one), debug: [boolean, optional] if true, actual change to the grid will not be performed } </pre></UL> <!-- METHOD PARAMETERS START --> <UL> <B>Parameters:</B> <UL><CODE>oArgs</CODE> - Query object. </UL> </UL> <!-- METHOD PARAMETERS END --> <UL> <B>Returns:</B> <UL> Array of affected rows during query. Number of affected rows can be accessed through the length property of this array. If error occured during query, returns undefined. See <a href="../Zapatec/GridQueryInsert.html#execute">Zapatec.GridQueryInsert.execute()</a>, <a href="../Zapatec/GridQueryUpdate.html#execute">Zapatec.GridQueryUpdate.execute()</a>, <a href="../Zapatec/GridQueryDelete.html#execute">Zapatec.GridQueryDelete.execute()</a> for details </UL> </UL> <!-- ADDITIONAL ATTRIBUTES START --> <!-- ADDITIONAL ATTRIBUTES END --> <HR> <A NAME="receiveData"><!-- --></A> <H3>receiveData</H3> <PRE>void <B>receiveData</B>(<object> oArg)</PRE> <UL>Loads passed data into already initialized grid to view or edit them. <pre> Arguments object format: { data: [object] data in format specific for each widget } </pre></UL> <!-- METHOD PARAMETERS START --> <UL> <B>Parameters:</B> <UL><CODE>oArg</CODE> - Arguments </UL> </UL> <!-- METHOD PARAMETERS END --> <!-- ADDITIONAL ATTRIBUTES START --> <!-- ADDITIONAL ATTRIBUTES END --> <HR> <A NAME="reconfigure"><!-- --></A> <H3>reconfigure</H3> <PRE>void <B>reconfigure</B>(<object> oArg)</PRE> <UL>Reconfigures the grid with new config options after it was initialized. May be used to change look or behavior of the grid after it has loaded the data. In the argument pass only values for changed config options. There is no need to pass config options that were not changed. <pre> Note: "sortColumn" and "sortDesc" config options are ignored by this method because they are useful only on initialization. To sort the grid after it was initialized use sort method instead. </pre></UL> <!-- METHOD PARAMETERS START --> <UL> <B>Parameters:</B> <UL><CODE>oArg</CODE> - Changes to user configuration </UL> </UL> <!-- METHOD PARAMETERS END --> <!-- ADDITIONAL ATTRIBUTES START --> <!-- ADDITIONAL ATTRIBUTES END --> <HR> <A NAME="recordsDisplayed"><!-- --></A> <H3>recordsDisplayed</H3> <PRE>number <B>recordsDisplayed</B>()</PRE> <UL>Returns number of rows that are currently displayed.</UL> <!-- METHOD PARAMETERS START --> <!-- METHOD PARAMETERS END --> <UL> <B>Returns:</B> <UL> How many rows are currently displayed </UL> </UL> <!-- ADDITIONAL ATTRIBUTES START --> <!-- ADDITIONAL ATTRIBUTES END --> <HR> <A NAME="redrawTotals"><!-- --></A> <H3>redrawTotals</H3> <PRE>void <B>redrawTotals</B>(<object> oArg)</PRE> <UL>Redraws totals for the specified columns. <pre> Takes in following object: { column: [object or number, optional] array of zero-based column numbers or single zero-based column number to redraw (default is all columns) } </pre></UL> <!-- METHOD PARAMETERS START --> <UL> <B>Parameters:</B> <UL><CODE>oArg</CODE> - Arguments object </UL> </UL> <!-- METHOD PARAMETERS END --> <!-- ADDITIONAL ATTRIBUTES START --> <!-- ADDITIONAL ATTRIBUTES END --> <HR> <A NAME="refresh"><!-- --></A> <H3>refresh</H3> <PRE>void <B>refresh</B>()</PRE> <UL>Refreshes grid after sorting or filtering. Note: After modification of data like splice or query, use Zapatec.Grid.modify method instead to update filters properly. <pre> Defines internal property <b>refreshState</b>. </pre></UL> <!-- METHOD PARAMETERS START --> <!-- METHOD PARAMETERS END --> <!-- ADDITIONAL ATTRIBUTES START --> <!-- ADDITIONAL ATTRIBUTES END --> <HR> <A NAME="removeFilter"><!-- --></A> <H3>removeFilter</H3> <PRE>void <B>removeFilter</B>(<object> oArg)</PRE> <UL>Removes filter from the specified columns. <pre> Argument object format: { columns: [object, optional] array with column numbers to remove filter from } If oArg or columns are not defined or empty, filter is removed from all columns. </pre></UL> <!-- METHOD PARAMETERS START --> <UL> <B>Parameters:</B> <UL><CODE>oArg</CODE> - Optional. Argument object </UL> </UL> <!-- METHOD PARAMETERS END --> <!-- ADDITIONAL ATTRIBUTES START --> <!-- ADDITIONAL ATTRIBUTES END --> <HR> <A NAME="resetFilters"><!-- --></A> <H3>resetFilters</H3> <PRE>void <B>resetFilters</B>()</PRE> <UL>Resets all filterouts, ranges and text filters.</UL> <!-- METHOD PARAMETERS START --> <!-- METHOD PARAMETERS END --> <!-- ADDITIONAL ATTRIBUTES START --> <!-- ADDITIONAL ATTRIBUTES END --> <HR> <A NAME="searchInsensitiveString"><!-- --></A> <H3>searchInsensitiveString</H3> <PRE>number <B>searchInsensitiveString</B>(<object> oArg)</PRE> <UL>Searches specified value in the specified cell of insensitive string data type. <pre> Arguments format: { cell: [object] cell object, searchValue: [string] value to search for } </pre></UL> <!-- METHOD PARAMETERS START --> <UL> <B>Parameters:</B> <UL><CODE>oArg</CODE> - Arguments </UL> </UL> <!-- METHOD PARAMETERS END --> <UL> <B>Returns:</B> <UL> The index within the cell string representation of the first occurrence of the specified value, or -1 if the value is not found, or undefined in case of invalid arguments </UL> </UL> <!-- ADDITIONAL ATTRIBUTES START --> <!-- ADDITIONAL ATTRIBUTES END --> <HR> <A NAME="setBooleanTFValues"><!-- --></A> <H3>setBooleanTFValues</H3> <PRE>void <B>setBooleanTFValues</B>(<string> sFalse, <string> sTrue)</PRE> <UL>Sets display values for booleanTF data type.</UL> <!-- METHOD PARAMETERS START --> <UL> <B>Parameters:</B> <UL><CODE>sFalse</CODE> - Replacement for "False" </UL> <UL><CODE>sTrue</CODE> - Replacement for "True" </UL> </UL> <!-- METHOD PARAMETERS END --> <!-- ADDITIONAL ATTRIBUTES START --> <!-- ADDITIONAL ATTRIBUTES END --> <HR> <A NAME="setBooleanValues"><!-- --></A> <H3>setBooleanValues</H3> <PRE>void <B>setBooleanValues</B>(<string> sNo, <string> sYes)</PRE> <UL>Sets display values for boolean data type.</UL> <!-- METHOD PARAMETERS START --> <UL> <B>Parameters:</B> <UL><CODE>sNo</CODE> - Replacement for "No" </UL> <UL><CODE>sYes</CODE> - Replacement for "Yes" </UL> </UL> <!-- METHOD PARAMETERS END --> <!-- ADDITIONAL ATTRIBUTES START --> <!-- ADDITIONAL ATTRIBUTES END --> <HR> <A NAME="setCellStyle"><!-- --></A> <H3>setCellStyle</H3> <PRE>object <B>setCellStyle</B>(<object> oCell, <string> sStyle)</PRE> <UL>Sets cell style.</UL> <!-- METHOD PARAMETERS START --> <UL> <B>Parameters:</B> <UL><CODE>oCell</CODE> - Cell object </UL> <UL><CODE>sStyle</CODE> - New cell style </UL> </UL> <!-- METHOD PARAMETERS END --> <UL> <B>Returns:</B> <UL> Updated cell object </UL> </UL> <!-- ADDITIONAL ATTRIBUTES START --> <!-- ADDITIONAL ATTRIBUTES END --> <HR> <A NAME="setCellValue"><!-- --></A> <H3>setCellValue</H3> <PRE>object <B>setCellValue</B>(<object> oCell, <any> value)</PRE> <UL>Sets cell value. Saves previous value in the private property.</UL> <!-- METHOD PARAMETERS START --> <UL> <B>Parameters:</B> <UL><CODE>oCell</CODE> - Cell object </UL> <UL><CODE>value</CODE> - New cell value </UL> </UL> <!-- METHOD PARAMETERS END --> <UL> <B>Returns:</B> <UL> Updated cell object </UL> </UL> <!-- ADDITIONAL ATTRIBUTES START --> <!-- ADDITIONAL ATTRIBUTES END --> <HR> <A NAME="setCurrentHorizontalOffset"><!-- --></A> <H3>setCurrentHorizontalOffset</H3> <PRE>void <B>setCurrentHorizontalOffset</B>(<object> oArg)</PRE> <UL>Sets current horizontal scroll. Only sets private variable without grid refreshing. <pre> Arguments format: { fieldId: [number, optional] zero-based field (column) id, field: [object, optional] field object } Only one of <i>fieldId</i> and <i>field</i> properties should be defined. </pre></UL> <!-- METHOD PARAMETERS START --> <UL> <B>Parameters:</B> <UL><CODE>oArg</CODE> - Arguments </UL> </UL> <!-- METHOD PARAMETERS END --> <!-- ADDITIONAL ATTRIBUTES START --> <!-- ADDITIONAL ATTRIBUTES END --> <HR> <A NAME="setCurrentPage"><!-- --></A> <H3>setCurrentPage</H3> <PRE>void <B>setCurrentPage</B>(<number> iPage)</PRE> <UL>Sets current page. Only sets private variable without grid refreshing.</UL> <!-- METHOD PARAMETERS START --> <UL> <B>Parameters:</B> <UL><CODE>iPage</CODE> - Zero-based number of page </UL> </UL> <!-- METHOD PARAMETERS END --> <!-- ADDITIONAL ATTRIBUTES START --> <!-- ADDITIONAL ATTRIBUTES END --> <HR> <A NAME="setCurrentVerticalOffset"><!-- --></A> <H3>setCurrentVerticalOffset</H3> <PRE>void <B>setCurrentVerticalOffset</B>(<object> oArg)</PRE> <UL>Sets current vertical scroll. Only sets private variable without grid refreshing. <pre> Arguments format: { rowId: [number, optional] zero-based row id row: [object, optional] row object } Only one of <i>rowId</i> and <i>row</i> properties should be defined. </pre></UL> <!-- METHOD PARAMETERS START --> <UL> <B>Parameters:</B> <UL><CODE>oArg</CODE> - Arguments </UL> </UL> <!-- METHOD PARAMETERS END --> <!-- ADDITIONAL ATTRIBUTES START --> <!-- ADDITIONAL ATTRIBUTES END --> <HR> <A NAME="setDisplayedRows"><!-- --></A> <H3>setDisplayedRows</H3> <PRE>void <B>setDisplayedRows</B>(<number> iRows)</PRE> <UL>Sets number of currently displayed rows. Effective only when dataOnDemand config option is used.</UL> <!-- METHOD PARAMETERS START --> <UL> <B>Parameters:</B> <UL><CODE>iRows</CODE> - Number of currently displayed rows </UL> </UL> <!-- METHOD PARAMETERS END --> <!-- ADDITIONAL ATTRIBUTES START --> <!-- ADDITIONAL ATTRIBUTES END --> <HR> <A NAME="setFieldTitle"><!-- --></A> <H3>setFieldTitle</H3> <PRE>number <B>setFieldTitle</B>(<object> oField, <string> sTitle)</PRE> <UL>Sets column title and visualizes changes immediately without refreshing whole grid.</UL> <!-- METHOD PARAMETERS START --> <UL> <B>Parameters:</B> <UL><CODE>oField</CODE> - Field object </UL> <UL><CODE>sTitle</CODE> - New column title </UL> </UL> <!-- METHOD PARAMETERS END --> <UL> <B>Returns:</B> <UL> Number of renamed columns (0 or 1) </UL> </UL> <!-- ADDITIONAL ATTRIBUTES START --> <!-- ADDITIONAL ATTRIBUTES END --> <HR> <A NAME="setFilter"><!-- --></A> <H3>setFilter</H3> <PRE>void <B>setFilter</B>(<object> oArg)</PRE> <UL>Limits the result set by doing a search. Only rows having specified text fragment will be shown. JavaScript regular expression can be used instead or in addition to the text fragment. If you use both regexp and text, regexp is applied first. <pre> Argument object format: { regexp: [object or string, optional] RegExp object or regular expression string to match, text: [string, optional] text fragment to search, columns: [object, optional] array with zero-based column numbers to search (by default all columns are searched) } </pre></UL> <!-- METHOD PARAMETERS START --> <UL> <B>Parameters:</B> <UL><CODE>oArg</CODE> - Argument object </UL> </UL> <!-- METHOD PARAMETERS END --> <!-- ADDITIONAL ATTRIBUTES START --> <!-- ADDITIONAL ATTRIBUTES END --> <HR> <A NAME="setRowStyle"><!-- --></A> <H3>setRowStyle</H3> <PRE>object <B>setRowStyle</B>(<object> oRow, <string> sStyle)</PRE> <UL>Sets row style.</UL> <!-- METHOD PARAMETERS START --> <UL> <B>Parameters:</B> <UL><CODE>oRow</CODE> - Row object </UL> <UL><CODE>sStyle</CODE> - New row style </UL> </UL> <!-- METHOD PARAMETERS END --> <UL> <B>Returns:</B> <UL> Updated row object </UL> </UL> <!-- ADDITIONAL ATTRIBUTES START --> <!-- ADDITIONAL ATTRIBUTES END --> <HR> <A NAME="setTotalRows"><!-- --></A> <H3>setTotalRows</H3> <PRE>void <B>setTotalRows</B>(<number> iRows)</PRE> <UL>Sets total number of rows. Effective only when dataOnDemand config option is used.</UL> <!-- METHOD PARAMETERS START --> <UL> <B>Parameters:</B> <UL><CODE>iRows</CODE> - Total number of rows </UL> </UL> <!-- METHOD PARAMETERS END --> <!-- ADDITIONAL ATTRIBUTES START --> <!-- ADDITIONAL ATTRIBUTES END --> <HR> <A NAME="showColumns"><!-- --></A> <H3>showColumns</H3> <PRE>void <B>showColumns</B>(<object> oArg)</PRE> <UL>Unhides specified columns. <pre> Argument object format: { columns: [object or number] Array of zero-based column numbers or single zero-based column number, noRefresh: [boolean] If true, grid is not refreshed. Useful when you need to show some columns and to hide other columns } </pre></UL> <!-- METHOD PARAMETERS START --> <UL> <B>Parameters:</B> <UL><CODE>oArg</CODE> - Argument object </UL> </UL> <!-- METHOD PARAMETERS END --> <!-- ADDITIONAL ATTRIBUTES START --> <!-- ADDITIONAL ATTRIBUTES END --> <HR> <A NAME="sort"><!-- --></A> <H3>sort</H3> <PRE>void <B>sort</B>(aArg)</PRE> <UL>Sorts the grid. You can pass single column or an array of columns to sort by several columns simultaneously. This works as follows: Grid is sorted by primary column (first column in the array). If there are equal values, sorting is done by next column in the array and so on. When single column is passed instead of an array, it becomes primary column and in case of equal values sorting is done by other columns from most left column to most right column in ascending order. If column is not specified (no argument is passed or passed an empty array), primary column and order from the last sorting are used. <pre> Argument object format: [ { column: [number or string, optional] number of column to sort (default is value of sortColumn config option), desc: [boolean, optional] sort in descending order (default is false) }, ... ] Also accepted following format: { column: [number or string, optional] number of column to sort (default is value of sortColumn config option), desc: [boolean, optional] sort in descending order (default is false) } </pre></UL> <!-- METHOD PARAMETERS START --> <UL> <B>Parameters:</B> <UL><CODE>oArg</CODE> - Optional. Argument object </UL> </UL> <!-- METHOD PARAMETERS END --> <!-- ADDITIONAL ATTRIBUTES START --> <!-- ADDITIONAL ATTRIBUTES END --> <HR> <A NAME="splice"><!-- --></A> <H3>splice</H3> <PRE>object <B>splice</B>(<object> aData)</PRE> <UL>Changes the content of the grid, replacing, adding or removing rows. <pre> Input object format: { atKey: [string, optional] primary key value at which to start changing the grid, atRowId: [number, optional] id of row at which to start changing the grid, atRow: [number, optional, private] index of row in rows array at which to start changing the grid, afterKey: [string, optional] primary key value after which to start changing the grid, afterRowId: [number, optional] id of row after which to start changing the grid, afterRow: [number, optional, private] index of row in rows array after which to start changing the grid, howMany: [number, optional] number of rows to replace or remove (default is 0), rows: [object, optional] array of rows to add: [ { cells: [ { v: [any] cell value to display, c: [any, optional] cell value to compare, o: [any, optional] original cell value, style: [string, optional] table cell style attribute }, ... ], style: [string, optional] table row style attribute }, ... ], noRefresh: [boolean, optional] indicates that grid should not be refreshed after changing (default is false) (useful when several changes go one by one) } Only one of "atKey", "atRowId", "atRow", "afterKey", "afterRowId" and "afterRow" properties should be defined. If none of them is defined, new rows will be added to the end of grid. Several input objects can be passed in an array. This is useful when several changes must be done simultaneously. If several objects are passed in an array, "noRefresh" property is ignored for all objects except the last. </pre></UL> <!-- METHOD PARAMETERS START --> <UL> <B>Parameters:</B> <UL><CODE>aData</CODE> - Array of objects or single object in above shown format </UL> </UL> <!-- METHOD PARAMETERS END --> <UL> <B>Returns:</B> <UL> Array with replaced or removed row objects. Number of replaced or removed rows can be accessed through the length property of this array. If error occured, returns undefined. </UL> </UL> <!-- ADDITIONAL ATTRIBUTES START --> <!-- ADDITIONAL ATTRIBUTES END --> <HR> <A NAME="spliceColumns"><!-- --></A> <H3>spliceColumns</H3> <PRE>number <B>spliceColumns</B>(<object> aData)</PRE> <UL>Changes the content of the grid, replacing, adding or removing columns. <pre> Input object format: { atColumnId: [number, optional] id of column at which to start changing the grid, afterColumnId: [number, optional] id of column after which to start changing the grid, howMany: [number, optional] number of columns to replace or remove (default is 0), fields: [ { i: [number] zero-based column number, <b>dataPrepared</b> specific, title: [string, optional] column title, dataType: [string, optional] defines which standard or custom data type to use for cell conversion (if not specified, no conversion is done), columnWidth: [string, optional] column width, e.g. "10px", "10em", style: [string, optional] header table cell style attribute, ... }, ... ], rows: [ { cells: [ { v: [any] cell value to display, c: [any, optional] cell value to compare, o: [any, optional] original cell value, style: [string, optional] table cell style attribute, ... }, ... ] }, ... ], noRefresh: [boolean, optional] indicates that grid should not be refreshed after changing (default is false) (useful when several changes go one by one) } Only one of "atColumnId" and "afterColumnId" properties should be defined. If none of them is defined, new columns will be added to the end of the grid. Several input objects can be passed in an array. This is useful when several changes must be done simultaneously. If several objects are passed in an array, "noRefresh" property is ignored for all objects except the last. </pre></UL> <!-- METHOD PARAMETERS START --> <UL> <B>Parameters:</B> <UL><CODE>aData</CODE> - Array of objects or single object in above shown format </UL> </UL> <!-- METHOD PARAMETERS END --> <UL> <B>Returns:</B> <UL> Number of deleted columns. </UL> </UL> <!-- ADDITIONAL ATTRIBUTES START --> <!-- ADDITIONAL ATTRIBUTES END --> <HR> <A NAME="spliceXml"><!-- --></A> <H3>spliceXml</H3> <PRE>object <B>spliceXml</B>(<object> oDoc)</PRE> <UL>Changes content of the grid, replacing, adding or removing rows. <pre> Input XML format: <xmp> <?xml version="1.0"?> <grid norefresh="true"> <table> <atkey>Primary key value</atkey> <atid>0</atid> <atrow>0</atrow> <afterkey>Primary key value</afterkey> <afterid>0</afterid> <afterrow>0</atrow> <howmany>0</howmany> <rows> <row style="background: #eee"> <cell style="color: #f00">Value</cell> ... </row> ... </rows> </table> ... </grid> </xmp> Where: "norefresh" attribute [string, optional] indicates that grid should not be refreshed after changing (useful when several changes go one by one). "atkey" tag [string, optional] defines primary key value at which to start changing the grid. "atid" tag [number, optional] defines id of row at which to start changing the grid. "atrow" tag [number, optional, private] defines index of row in rows array at which to start changing the grid. "afterkey" tag [string, optional] defines primary key value after which to start changing the grid. "afterid" tag [number, optional] defines id of row after which to start changing the grid. "afterrow" tag [number, optional, private] defines index of row in rows array after which to start changing the grid. "howmany" tag [number, optional] defines number of rows to replace or remove (default is 0). Only one of "atkey", "atid", "atrow", "afterkey", "afterid" and "afterrow" tags should be defined. If none of them is defined, new rows will be added to the end of grid. There can be several table tags in the input XML. This is useful when several changes must be done simultaneously. XMLDocument object can be obtained from XML fragment using Zapatec.Transport.parseXml function. Old input format (deprecated): <xmp> <?xml version="1.0"?> <grid> <table> <rows atRow="0" afterRow="0" howMany="0" noRefresh="noRefresh"> <row style="background: #eee"> <cell style="color: #f00">Value</cell> ... </row> ... </rows> </table> </grid> </xmp> </pre></UL> <!-- METHOD PARAMETERS START --> <UL> <B>Parameters:</B> <UL><CODE>oDoc</CODE> - XMLDocument object that describes one or several rows to add. </UL> </UL> <!-- METHOD PARAMETERS END --> <UL> <B>Returns:</B> <UL> Array with replaced or removed row objects. Number of replaced or removed rows can be accessed through the length property of this array. If error occured, returns undefined. </UL> </UL> <!-- ADDITIONAL ATTRIBUTES START --> <!-- ADDITIONAL ATTRIBUTES END --> <HR> <A NAME="totalPages"><!-- --></A> <H3>totalPages</H3> <PRE>number <B>totalPages</B>()</PRE> <UL>Returns total number of pages.</UL> <!-- METHOD PARAMETERS START --> <!-- METHOD PARAMETERS END --> <UL> <B>Returns:</B> <UL> Total number of pages in the grid </UL> </UL> <!-- ADDITIONAL ATTRIBUTES START --> <!-- ADDITIONAL ATTRIBUTES END --> <HR> <A NAME="totalRecords"><!-- --></A> <H3>totalRecords</H3> <PRE>number <B>totalRecords</B>()</PRE> <UL>Returns total number of rows.</UL> <!-- METHOD PARAMETERS START --> <!-- METHOD PARAMETERS END --> <UL> <B>Returns:</B> <UL> Total number of rows </UL> </UL> <!-- ADDITIONAL ATTRIBUTES START --> <!-- ADDITIONAL ATTRIBUTES END --> <HR> <A NAME="unfilterOut"><!-- --></A> <H3>unfilterOut</H3> <PRE>void <B>unfilterOut</B>(<object> oArg)</PRE> <UL>Removes all hidden values from the specified columns. <pre> Argument object format: { column: [object or number] array of zero-based column numbers or single zero-based column number to remove hidden values from } </pre></UL> <!-- METHOD PARAMETERS START --> <UL> <B>Parameters:</B> <UL><CODE>oArg</CODE> - Argument object </UL> </UL> <!-- METHOD PARAMETERS END --> <!-- ADDITIONAL ATTRIBUTES START --> <!-- ADDITIONAL ATTRIBUTES END --> <HR> <A NAME="unsort"><!-- --></A> <H3>unsort</H3> <PRE>void <B>unsort</B>()</PRE> <UL>Unsorts the grid.</UL> <!-- METHOD PARAMETERS START --> <UL> <B>Parameters:</B> <UL><CODE>oArg</CODE> - Argument object </UL> </UL> <!-- METHOD PARAMETERS END --> <!-- ADDITIONAL ATTRIBUTES START --> <!-- ADDITIONAL ATTRIBUTES END --> <HR> <A NAME="validateBoolean"><!-- --></A> <H3>validateBoolean</H3> <PRE>boolean <B>validateBoolean</B>(<object> objCell)</PRE> <UL>Validates cell of boolean data type.</UL> <!-- METHOD PARAMETERS START --> <UL> <B>Parameters:</B> <UL><CODE>objCell</CODE> - Cell object </UL> </UL> <!-- METHOD PARAMETERS END --> <UL> <B>Returns:</B> <UL> True if valid </UL> </UL> <!-- ADDITIONAL ATTRIBUTES START --> <!-- ADDITIONAL ATTRIBUTES END --> <HR> <A NAME="validateBooleanTF"><!-- --></A> <H3>validateBooleanTF</H3> <PRE>boolean <B>validateBooleanTF</B>(<object> objCell)</PRE> <UL>Validates cell of booleanTF data type.</UL> <!-- METHOD PARAMETERS START --> <UL> <B>Parameters:</B> <UL><CODE>objCell</CODE> - Cell object </UL> </UL> <!-- METHOD PARAMETERS END --> <UL> <B>Returns:</B> <UL> True if valid </UL> </UL> <!-- ADDITIONAL ATTRIBUTES START --> <!-- ADDITIONAL ATTRIBUTES END --> <HR> <A NAME="validateDate"><!-- --></A> <H3>validateDate</H3> <PRE>boolean <B>validateDate</B>(<object> objCell)</PRE> <UL>Validates cell of date data type.</UL> <!-- METHOD PARAMETERS START --> <UL> <B>Parameters:</B> <UL><CODE>objCell</CODE> - Cell object </UL> </UL> <!-- METHOD PARAMETERS END --> <UL> <B>Returns:</B> <UL> True if valid </UL> </UL> <!-- ADDITIONAL ATTRIBUTES START --> <!-- ADDITIONAL ATTRIBUTES END --> <HR> <A NAME="validateFloat"><!-- --></A> <H3>validateFloat</H3> <PRE>boolean <B>validateFloat</B>(<object> objCell)</PRE> <UL>Validates cell of float data type.</UL> <!-- METHOD PARAMETERS START --> <UL> <B>Parameters:</B> <UL><CODE>objCell</CODE> - Cell object </UL> </UL> <!-- METHOD PARAMETERS END --> <UL> <B>Returns:</B> <UL> True if valid </UL> </UL> <!-- ADDITIONAL ATTRIBUTES START --> <!-- ADDITIONAL ATTRIBUTES END --> <HR> <A NAME="validateInteger"><!-- --></A> <H3>validateInteger</H3> <PRE>boolean <B>validateInteger</B>(<object> objCell)</PRE> <UL>Validates cell of integer data type.</UL> <!-- METHOD PARAMETERS START --> <UL> <B>Parameters:</B> <UL><CODE>objCell</CODE> - Cell object </UL> </UL> <!-- METHOD PARAMETERS END --> <UL> <B>Returns:</B> <UL> True if valid </UL> </UL> <!-- ADDITIONAL ATTRIBUTES START --> <!-- ADDITIONAL ATTRIBUTES END --> <HR> <A NAME="validateTime"><!-- --></A> <H3>validateTime</H3> <PRE>boolean <B>validateTime</B>(<object> objCell)</PRE> <UL>Validates cell of time data type.</UL> <!-- METHOD PARAMETERS START --> <UL> <B>Parameters:</B> <UL><CODE>objCell</CODE> - Cell object </UL> </UL> <!-- METHOD PARAMETERS END --> <UL> <B>Returns:</B> <UL> True if valid </UL> </UL> <!-- ADDITIONAL ATTRIBUTES START --> <!-- ADDITIONAL ATTRIBUTES END --> <HR> <A NAME="validateTimestamp"><!-- --></A> <H3>validateTimestamp</H3> <PRE>boolean <B>validateTimestamp</B>(<object> objCell)</PRE> <UL>Validates cell of timestamp data type.</UL> <!-- METHOD PARAMETERS START --> <UL> <B>Parameters:</B> <UL><CODE>objCell</CODE> - Cell object </UL> </UL> <!-- METHOD PARAMETERS END --> <UL> <B>Returns:</B> <UL> True if valid </UL> </UL> <!-- ADDITIONAL ATTRIBUTES START --> <!-- ADDITIONAL ATTRIBUTES END --> <HR> <A NAME="visualizeCellReadOnly"><!-- --></A> <H3>visualizeCellReadOnly</H3> <PRE>void <B>visualizeCellReadOnly</B>(<object> oCell)</PRE> <UL>Redraws specified cell without redrawing whole grid. Useful after changing of cell value.</UL> <!-- METHOD PARAMETERS START --> <UL> <B>Parameters:</B> <UL><CODE>oCell</CODE> - Cell object </UL> </UL> <!-- METHOD PARAMETERS END --> <!-- ADDITIONAL ATTRIBUTES START --> <!-- ADDITIONAL ATTRIBUTES END --> <HR> <A NAME="!s!avg"><!-- --></A> <H3>avg</H3> <PRE><static> object <B>avg</B>(<object> oArg)</PRE> <UL>Calculates average for one or several columns. Input and output object format is the same as for <a href="../Zapatec/Grid.html#!s!sum">Zapatec.Grid.sum()</a>.</UL> <!-- METHOD PARAMETERS START --> <UL> <B>Parameters:</B> <UL><CODE>oArg</CODE> - Arguments object </UL> </UL> <!-- METHOD PARAMETERS END --> <UL> <B>Returns:</B> <UL> Row with totals </UL> </UL> <!-- ADDITIONAL ATTRIBUTES START --> <!-- ADDITIONAL ATTRIBUTES END --> <HR> <A NAME="!s!count"><!-- --></A> <H3>count</H3> <PRE><static> object <B>count</B>(<object> oArg)</PRE> <UL>Calculates count for one or several columns. Input and output object format is the same as for <a href="../Zapatec/Grid.html#!s!sum">Zapatec.Grid.sum()</a>.</UL> <!-- METHOD PARAMETERS START --> <UL> <B>Parameters:</B> <UL><CODE>oArg</CODE> - Arguments object </UL> </UL> <!-- METHOD PARAMETERS END --> <UL> <B>Returns:</B> <UL> Row with totals </UL> </UL> <!-- ADDITIONAL ATTRIBUTES START --> <!-- ADDITIONAL ATTRIBUTES END --> <HR> <A NAME="!s!countDistinct"><!-- --></A> <H3>countDistinct</H3> <PRE><static> object <B>countDistinct</B>(<object> oArg)</PRE> <UL>Calculates count of distinct values for one or several columns. Input and output object format is the same as for <a href="../Zapatec/Grid.html#!s!sum">Zapatec.Grid.sum()</a>.</UL> <!-- METHOD PARAMETERS START --> <UL> <B>Parameters:</B> <UL><CODE>oArg</CODE> - Arguments object </UL> </UL> <!-- METHOD PARAMETERS END --> <UL> <B>Returns:</B> <UL> Row with totals </UL> </UL> <!-- ADDITIONAL ATTRIBUTES START --> <!-- ADDITIONAL ATTRIBUTES END --> <HR> <A NAME="!s!createType"><!-- --></A> <H3>createType</H3> <PRE><static> void <B>createType</B>(<function> funcConvert, <string> sTypeName, <string> sTypeClass)</PRE> <UL>Creates custom data type.</UL> <!-- METHOD PARAMETERS START --> <UL> <B>Parameters:</B> <UL><CODE>funcConvert</CODE> - Function that converts cell value </UL> <UL><CODE>sTypeName</CODE> - Type name </UL> <UL><CODE>sTypeClass</CODE> - Optional. Class name </UL> </UL> <!-- METHOD PARAMETERS END --> <!-- ADDITIONAL ATTRIBUTES START --> <!-- ADDITIONAL ATTRIBUTES END --> <HR> <A NAME="!s!createValidation"><!-- --></A> <H3>createValidation</H3> <PRE><static> void <B>createValidation</B>(funcValidate, <string> strTypeName)</PRE> <UL>Creates validation method for custom data type.</UL> <!-- METHOD PARAMETERS START --> <UL> <B>Parameters:</B> <UL><CODE>strTypeName</CODE> - Type name </UL> <UL><CODE>funcConvert</CODE> - Function that validates cell value </UL> </UL> <!-- METHOD PARAMETERS END --> <!-- ADDITIONAL ATTRIBUTES START --> <!-- ADDITIONAL ATTRIBUTES END --> <HR> <A NAME="!s!firstPage"><!-- --></A> <H3>firstPage</H3> <PRE><static> void <B>firstPage</B>(<number> iGridId)</PRE> <UL>Goes to the first page.</UL> <!-- METHOD PARAMETERS START --> <UL> <B>Parameters:</B> <UL><CODE>iGridId</CODE> - Id of the grid </UL> </UL> <!-- METHOD PARAMETERS END --> <!-- ADDITIONAL ATTRIBUTES START --> <!-- ADDITIONAL ATTRIBUTES END --> <HR> <A NAME="!s!getNewColumnNumber"><!-- --></A> <H3>getNewColumnNumber</H3> <PRE><static> number <B>getNewColumnNumber</B>(<object> oArg)</PRE> <UL>Converts any column number after column moving. When column is moved, ids of the fields are changed. This function takes old field id and converts it to the new id of the same field. Note: static method. <pre> Arguments format: { fieldId: [number] old zero-based field id, move: [object] object received from the <b>gridMovedColumn</b> event } </pre></UL> <!-- METHOD PARAMETERS START --> <UL> <B>Parameters:</B> <UL><CODE>oArg</CODE> - Arguments </UL> </UL> <!-- METHOD PARAMETERS END --> <UL> <B>Returns:</B> <UL> New zero-based field id or undefined in case of invalid arguments </UL> </UL> <!-- ADDITIONAL ATTRIBUTES START --> <!-- ADDITIONAL ATTRIBUTES END --> <HR> <A NAME="!s!lastPage"><!-- --></A> <H3>lastPage</H3> <PRE><static> void <B>lastPage</B>(<number> iGridId)</PRE> <UL>Goes to the last page.</UL> <!-- METHOD PARAMETERS START --> <UL> <B>Parameters:</B> <UL><CODE>iGridId</CODE> - Id of the grid </UL> </UL> <!-- METHOD PARAMETERS END --> <!-- ADDITIONAL ATTRIBUTES START --> <!-- ADDITIONAL ATTRIBUTES END --> <HR> <A NAME="!s!max"><!-- --></A> <H3>max</H3> <PRE><static> object <B>max</B>(<object> oArg)</PRE> <UL>Calculates max value for one or several columns. Input and output object format is the same as for <a href="../Zapatec/Grid.html#!s!sum">Zapatec.Grid.sum()</a>.</UL> <!-- METHOD PARAMETERS START --> <UL> <B>Parameters:</B> <UL><CODE>oArg</CODE> - Arguments object </UL> </UL> <!-- METHOD PARAMETERS END --> <UL> <B>Returns:</B> <UL> Row with totals </UL> </UL> <!-- ADDITIONAL ATTRIBUTES START --> <!-- ADDITIONAL ATTRIBUTES END --> <HR> <A NAME="!s!min"><!-- --></A> <H3>min</H3> <PRE><static> object <B>min</B>(<object> oArg)</PRE> <UL>Calculates min value for one or several columns. Input and output object format is the same as for <a href="../Zapatec/Grid.html#!s!sum">Zapatec.Grid.sum()</a>.</UL> <!-- METHOD PARAMETERS START --> <UL> <B>Parameters:</B> <UL><CODE>oArg</CODE> - Arguments object </UL> </UL> <!-- METHOD PARAMETERS END --> <UL> <B>Returns:</B> <UL> Row with totals </UL> </UL> <!-- ADDITIONAL ATTRIBUTES START --> <!-- ADDITIONAL ATTRIBUTES END --> <HR> <A NAME="!s!nextPage"><!-- --></A> <H3>nextPage</H3> <PRE><static> void <B>nextPage</B>(<number> iGridId)</PRE> <UL>Goes to the next page.</UL> <!-- METHOD PARAMETERS START --> <UL> <B>Parameters:</B> <UL><CODE>iGridId</CODE> - Id of the grid </UL> </UL> <!-- METHOD PARAMETERS END --> <!-- ADDITIONAL ATTRIBUTES START --> <!-- ADDITIONAL ATTRIBUTES END --> <HR> <A NAME="!s!previousPage"><!-- --></A> <H3>previousPage</H3> <PRE><static> void <B>previousPage</B>(<number> iGridId)</PRE> <UL>Goes to the previous page.</UL> <!-- METHOD PARAMETERS START --> <UL> <B>Parameters:</B> <UL><CODE>iGridId</CODE> - Id of the grid </UL> </UL> <!-- METHOD PARAMETERS END --> <!-- ADDITIONAL ATTRIBUTES START --> <!-- ADDITIONAL ATTRIBUTES END --> <HR> <A NAME="!s!sum"><!-- --></A> <H3>sum</H3> <PRE><static> object <B>sum</B>(<object> oArg)</PRE> <UL>Calculates sum for one or several columns. <pre> Takes in following object: { grid: [object] grid object, rows: [object] array of row objects, column: [object or number] array of zero-based column numbers or single zero-based column number to calculate, label: [string, optional] label for the value (overrides standard label), labelColumn: [string, optional] zero-based column number where to put label (by default label is placed before the value in the same cell) } Returns following object: { rows: [ { cells: [ { v: [string] value to display }, ... ] } ] } </pre></UL> <!-- METHOD PARAMETERS START --> <UL> <B>Parameters:</B> <UL><CODE>oArg</CODE> - Arguments object </UL> </UL> <!-- METHOD PARAMETERS END --> <UL> <B>Returns:</B> <UL> Row with totals </UL> </UL> <!-- ADDITIONAL ATTRIBUTES START --> <!-- ADDITIONAL ATTRIBUTES END --> <HR> <!-- ============ METHOD DETAIL END ========== --> <!-- ========= END OF CLASS DATA ========= --> <!-- ========== START OF NAVBAR ========== --> <A NAME="navbar_bottom"><!-- --></A> <TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0"> <TR> <TD COLSPAN=3 BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A NAME="navbar_bottom_firstrow"><!-- --></A> <TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3"> <TR ALIGN="center" VALIGN="top"> <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../overview-summary.html"><FONT CLASS="NavBarFont1"><B>Overview</B></FONT></A> </TD> <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../overview-summary-zpgrid-core.js.html"><FONT CLASS="NavBarFont1"><B>File</B></FONT></A> </TD> <TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> <FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT> </TD> <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../overview-tree.html"><FONT CLASS="NavBarFont1"><b>Tree</b></FONT></A> </TD> <!--TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"--> <!--A HREF="deprecated-list.html"--><!--FONT CLASS="NavBarFont1">Deprecated</FONT--><!--/A--><!-- </TD--> <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../index-all.html"><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A> </TD> <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A> </TD> </TR> </TABLE> </TD> <TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM> <B>Zapatec Grid</B> </EM> </TD </TR> <TR> <TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2"> <A HREF="../Zapatec/EditableGrid.html"><B>PREV CLASS</B></A><!-- NEXT CLASS --> <A HREF="../Zapatec/GridQuery.html"><B>NEXT CLASS</B></A></FONT></TD> <TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2"> <A HREF="../index.html" TARGET="_top"><B>FRAMES</B></A> <A HREF="" TARGET="_top"><B>NO FRAMES</B></A> <SCRIPT> <!-- if(window==top) { document.writeln('<A HREF="../allclasses-noframe.html" TARGET=""><B>All Classes</B></A>'); } //--> </SCRIPT> <NOSCRIPT> <A HREF="../allclasses-noframe.html" TARGET=""><B>All Classes</B></A> </NOSCRIPT> </FONT></TD> </TR> <TR> <TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2"> SUMMARY: <A HREF="#field_summary">FIELD</A> | <A HREF="#constructor_summary">CONSTR</A> | <A HREF="#method_summary">METHOD</A></FONT></TD> <TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2"> DETAIL: <A HREF="#field_detail">FIELD</A> | <A HREF="#constructor_detail">CONSTR</A> | <A HREF="#method_detail">METHOD</A></FONT></TD> </TR> </TABLE> <!-- =========== END OF NAVBAR =========== --> <HR> <FONT SIZE="-1"> </FONT> <div class="jsdoc_ctime">Documentation generated by <a href="http://jsdoc.sourceforge.net/" target="_parent">JSDoc</a> on Thu Aug 16 12:18:56 2007</div> </BODY> </HTML>