Sigma.Grid

activeCell
DOM. Dom object of current active cell. Read only.

activeColumn
Object. Column object. Object of active/last active column. Read only.

activeRecord
Object or Array. Data set of current active row. Read only.

activeRow
DOM object. Td DOM object of active/last active row. Read only.

allowCustomSkin
Boolean. To specify whether *skin* appear on main menu.

allowFreeze
Boolean. To specify whether *freeze columns* appear on main menu.

allowGroup
Boolean. To specify whether *group column* appear on main menu.

clickStartEdit
Bool. To specify whether cell becomes editable once it is clicked. If this flag set to false, user need to click once more to edit an active cell.

columnMap
Object. Object of column objects in in key-value formate, where key is column id and value is column object. Read only.

columns
Array. Array of all the column objects. Read only. See Sigma.Column

container
Sting or DOM.
Id or DOM object which grid is built up based on. Generally, container should be div or span. Sample
<div id="gridcontainer"> </div> container: "gridcontainer"

customHead
String or DOM.
Id, dom object or HTML code of a table, which defines layout of grid header.
Sample1 - to build a grid header with submit button
<table id="gridHead1"> <tr><td>Column1</td><td>Column2</td></tr> <tr><td><input type="button" value="submit"></td><td>Column2</td></tr> </table> customHead: "gridHead1"Sample2 - to build a nested header
<table id="gridHead1"> <tr><td>Column1</td><td colspan="2">Column2</td></tr> <tr><td>Column1 Sub</td><td>Column2 Sub1</td><td>Column2 Sub2</td></tr> </table> customHead: "gridHead1"

dataset
Object. Dataset object of grid. Read only. See Sigma.Dataset

debug
Bool. To specify grid to be in debug mode. To be in debug mode can call out a console with more info printed.

defaultRecord
Object or Array.
Data record template. This template will be adopted if a new row is added or appended.
Sample - When a row is added, it is initialized with "somebody", 0, 25 in column1, comlumn2, and comlumn3 respectively.
defaultRecord:["somebody", 0, 25] //If data type is object, it should be defaultRecord:{name:"somebody", field:0, moreField:25]

groupable
Bool. To specify whether grouping menu is enabled. If this flag is set true, grouping menu will appears in main menu and grouping functionality is enabled. See Sigma.Grid.showGridMenu

height
Integer or String.
Height of whole grid. Pixel and percentage are supported. Sample
height: 200 height: "100%"

id
String. Id of grid. Every grid should have unique id if more than one grid appear on same page.
Sample
id : "sigmagrid1"

jsonParamName
String. To specify parameter name submitted to server side. It's set to "_gt_json" by default. For example, PHP developer could get whole JSON string by $_POST["_gt_json"] in php.

language
String. Language option.
By default, messages on toolbar, on menu, of warning are in english. These words for presentation are defined in a language file named gt_msg_en.js. Developer can work out profile of other language. Take Spaish for example, developer need two steps.
1. Work out language file named gt_msg_sp.js and put into the directory where gt_msg_en.js is.
2. Specify language of grid to be sp.
Sample
language:"sp"

lightOverRow
Bool. To specify whether to hightlight one row when mouse is hovering over it.

loadURL
String. Url which grid data is loaded from. A function could not be assigned to loadURL since version 2.1, please assign records to grid by setConent. See Sigma.Grid.setContent
Sample - To assign a real url to loadURL.
loadURL:"http://localhost/server/getStudentsInfo.php"

minHeight
Integer. To specify minimum height if grid can be resized by end user. See Sigma.Grid.resizable

minWidth
Integer. To specify minimum width if grid can be resized by end user. See Sigma.Grid.resizable

pageInfo
Object Page info of grid. See Sigma.Grid.PageInfo

pageSize
Integer. To specify how many rows presented per page.

pageSizeList
Array of Integer. To specify page size options. See Sigma.Grid.pageSize
The following sample will show a dropdown list of page size for end user to choose.
pageSizeList :[5,10,20,50,100]

reloadAfterSave
Bool. To specify whether grid data is reloaded after data being saving.

remoteFilter
Bool. To specify whether server side does filtering work.

remotePaging
Bool. To specify whether server side does paging work.

remoteSort
Bool. To specify whether server side does sorting work.

replaceContainer
Bool.
To specify whether container is placed with grid. If not, grid will be a child of container. Sample
replaceContainer:false

resizable
Bool. To specify grid be resized by end user. If this flage to be set true, a resizing handle will appears at right-bottom corner. End user could resize grid by dragging this handle.

saveURL
String. Url which grid data is saved to.
Sample
saveUrl:"http://localhost/server/saveStudentsInfo.php'

selectedRows
Array. Array of selected row objects. Read only.

selectRowByCheck
Boolean. To specify whether end user can select row by checkbox.

showGridMenu
Bool. To specify whether main menu shows up.

showIndexColumn
Bool. To specify whether to show row number at front of every row.

showReloadTool
Bool. To specify whether "Reload" button shows up.

showSaveTool
Bool. To specify whether "Save" button shows up.

skin
String. Name of skin. Could be "pink", "default", "mac", "vista".
Developer can also made own skin and put in /grid/skin.

stripeRows
Bool. To specify whether to show rows in stripe.

submitUpdatedFields
Boolean. To specify whether modified fields are submitted to server only.

toolbarContent
String. It's set to 'nav | pagesize | reload | add del save | print | filter chart | state' by default.
Developer can change its order or hide some buttons.
Sample
To show add, delete, save buttons only. There would be a seperator between delete and save. toolbarContent : "add del | save"

toolbarPosition
String. Position of toolbar, could be "top", "bottom" or null.

transparentMask
Boolean. To spcify whether mask is transparent or not. False by default.

width
Integer or String.
Width of whole grid. Pixel and percentage are supported. Sample
width:500 width:100%

add:function()
To append a new row.

addParameters:function(parameters)
To add an additional parameter pair for submittal. By default, only data defined here will be submitted to server side. By this function, developers could add more parameter pairs.
parameters: Addtional parameters in key-value formate.
Sample
addParameters({morekey1:"more value",morekey2:"more value"})

cleanContent:function()
To clear all the data showed and make grid empty.

cleanParameters:function()
Remove all additional parameters. See Sigma.Grid.addParameters

closeMainMenu:function()
To Close main menu.

del:function()
To delete currently selected row(s).

endEdit:function()
To close current cell editor and update current cell value.

exportGrid(type)
To export grid to a file. This function need server side programming supported.
type: export file type. Could be "xls" for MS Excel file, "pdf" for Adobe PDF file, "csv" for

filterGrid:function()
Apply filter to this grid. Developer need to specify filterInfo before calling this function. Only records meeting filter criteria will be displayed within grid.

forEachRow(targetFun)
Excute function targetFun(row,record,i,grid) on each row.
row: The object of the row.
record. The data record behine the row.
i: Loop counter.
grid: Grid object.

getColumn:function(colNoIdTd)
Get column object by column id or DOM object of cell.
colNoIdTd: Column id or DOM object of cell.
returns: Column object.

getColumnValue:function(colID,rowNo)
Set cell value by specifying column id and row number.
colID: string. Id of column where cell is in.
rowNo: integer. Number of row where cell is at.
returns: any. New cell value.
Sample
var ret = grid.getColumnValue("col1",1);

getDeletedRecords:function()
To get all records deleted.
returns: Array of records.

getDisplayColumns:function()
To get columns displayed.
returns: Array of displayed column objects. See Sigma.Column

getEventTargets(event)
To get event target.
event: Sigma.Grid.Event object. See Sigma.Grid.Event
returns: Sigma.Grid.EventTarget object. See Sigma.Grid.EventTarget

getInsertedRecords:function()
To get all records deleted.
returns: Array of records.

getRecord:function( rowNoTdTr)
Get record by row number or DOM of td or tr.
rowNoTdTr: Row number or DOM of td or tr.
returns: Record object.

getSelectedRecords:function()
To get selected records.
returns: Array of array/object. Records of selected rows.

getUpdatedRecords:function()
To get all records updated.
returns: Array of records.

hideCellToolTip:function()
To hide tool tip for cell.

hideDialog:function ()
To hide dialog.

hideMask:function()
To hide mask.

hideWaiting:function ()
To hide waiting bar.

insert:function(record, startEdit )
To insert a row into grid.
record: Array of array/object. Data of row to be inserted. defaultRecord will be adopted if this parameter is null. See Sigma.Grid.defaultRecord
startEdit: Boolean. To set true to start to edit row right after inserting.

onShow:function()
To show grid. This function must be called when a hidden grid becomes visible.

printGrid:function()
To print grid. This function may popup a printer-choosing dialog box.

refresh:function()
To rebuild grid without data reloaded.

reload:function()
To reload data from server side.

reload:function(data)
To reload data and rebuild grid.

removeParameter:function(key)
Remove additional parameters by key.
Sample
removeParameter("morekey1")

render:function()
To render a grid.

save:function()
To save modifications to server side.

setColumnValue:function(colID,rowNo,newValue)
Set cell value by specifying column id and row number.
colID: string. Id of column where cell is in.
rowNo: integer. Number of row where cell is at.
newValue: any. New cell value.
Sample
grid.setColumnValue("col1",1,"value11");

setContent:function(data)
To set grid data.
data: Array of array/object. Data records.
Sample
var data= [ ["010-0","US","Jerry","Keith",50,57,80,46,"2008-10-02"], ["010-1","BR","Charles","Marks",79,37,40,90,"2008-04-24"], ["010-2","BR","Vincent","Harrison",91,75,31,40,"2008-02-17"] ]; grid.setContent(data);

setSize:function(newWidth,newHeight)
To set grid width and height.
newWidth: New width.
newHeight: New height.

showCellToolTip(cell,width)
To show tool tip for cell.
cell: DOM of cell.
width: Width of tip bar.

showDialog:function (type)
To show a dialog.
type: Dialog type.

showMask:function()
To show a mask.

showWaiting:function ()
To show a waiting bar.

unfilterGrid:function()
To release grid from filter. See Sigma.Grid.filterGrid also.

findGridByElement:function(obj)
To find grid by td or tr object.
obj: DOM object of td or tr.

getAllRows:function(grid)
Get array of html element tr dom within one grid.
grid: Object. Grid object.
returns: Array of html element tr dom.

isSelectedRow:function(row)
To determine whether one row is selected.
row: DOM. HTML tr dom object.
returns: Bool. True for selected, false for not.

afterColumnResize:function(colObj,newWidth,grid);
Fired after: Column resized by user.
colObj: Object of column resized.
newWidth: integer. New width.
grid: Grid Object.

afterDelete:function(record)
Fired before: Changed data is to be posted to server side.
record: Object or Array. Record of the row added/appended by end user.
returns: Bool. Return false to prevent row from being posted to server side.

afterEdit:function()
Fired before: Cell is out of editable mode.
Developer can get active cell by refering to activeCell. See Sigma.Grid.activeCell
Developer can get active record by refering to activeRecord. See Sigma.Grid.activeRecord

afterInsert:function(record)
Fired before: Changed data is to be posted to server side.
record: Object or Array. Record of the row added/appended by end user.
returns: Bool. Return false to prevent row from being posted to server side.

afterSave(respD,isSuccess,grid)
Fired after: Data to save sent to server side then back to client side.
respD: String. Message sent from server side to client.
isSuccess: Bool. Value to indecate whether side side script is successfully executed or not.
grid: Grid object. This grid.

afterSelectRow:function(value, record , cell, row, colNO, rowNO, columnObj,grid)
Called before: End user selects one row.
value: Value of the cell where mouse pointer is at.
record: Object or array. Data record of the row to be selected.
cell: Dom of the cell where mouse pointer is at.
row: Dom of row to be selected.
colNo: Index of the column where mouse pointer is at.
columnObj: Column object.
grid: Grid object.
returns: Boolean. Return false to prevent row from being selected.

afterUpdate:function(record,fieldName,newValue)
Fired before: Changed data is to be posted to server side.
record: Object or Array. Record of the row modified by end user.
fieldName: String. Id of column changed.
newValue: New value.
returns: Bool. Return false to prevent row from being posted to server side.

beforeDelete:function(record)
Fired before: Changed data is to be posted to server side.
record: Object or Array. Record of the row added/appended by end user.
returns: Bool. Return false to prevent row from being posted to server side.

beforeEdit:function()
Fired before: Cell comes into editable mode.
Developer can get active cell by refering to activeCell. See Sigma.Grid.activeCell
Developer can get active record by refering to activeRecord. See Sigma.Grid.activeRecord

beforeGotoPage:function(requestParameter)
Fired before: User switch to another page.
requestParameter: Object. See DataExchange.Saving
return: Bool. Return false to prevent data from being posted to server side.

beforeInsert:function(record)
Fired before: Changed data is to be posted to server side.
record: Object or Array. Record of the row added/appended by end user.
returns: Bool. Return false to prevent row from being posted to server side.

beforeLoad:function(requestParameter)
Fired before: Grid is to about to load data from server side.
requestParameter: Object. See DataExchange.Loading
return: Bool. Return false to prevent grid from loading data from server side.

beforeSave:function(requestParameter)
Fired before: Changed data is to be posted to server side.
requestParameter: Object. See DataExchange.Saving
return: Bool. Return false to prevent data from being posted to server side.

beforeSelectRow:function(record ,row, rowNo,grid)
Called before: End user selects one row.
record: Object or array. Data record of the row to be selected.
row: Dom of row to be selected.
rowNo: Index of the row where mouse pointer is at. Base on 0.
grid: Grid object.
returns: Boolean. Return false to prevent row from being selected.

beforeUpdate:function(record,fieldName,newValue)
Fired before: Changed data is to be posted to server side.
record: Object or Array. Record of the row modified by end user.
fieldName: String. Id of column changed.
newValue: New value.
returns: Bool. Return false to prevent row from being posted to server side.

loadFailure:function(repObject)
Fired when failing to load data from server.
repObject.exception : String. Exception string.
repObject.success : Bool. Value indicating whether server side script is executed successfully or not.
text: String. Raw text from server side to client.

loadResponseHandler : function(response,requestParameter)
This function is a call back function to deal with the received content from server side. Developer could do some data translation work within this function.
response: String. Response content.
requestParameter: Object. See DataExchange.Loading

onClickCell:function(value, record , cell, row, colNO, rowNO,columnObj,grid)
Called when: End user click one cell.
value: Value of the cell where mouse pointer is at.
record: Object or array. Data record of the row where the cell is at.
cell: Dom of the cell.
row: Dom of row where the cell is at.
colNo: Index of the column where the cell is at.
columnObj: Column object.
grid: Grid object.
returns: Boolean. Return false to prevent cell from being active.

onClickHead:function(event,headCell,colObj,grid)
Called when: End user click column header.
event: Object. See Sigma.Grid.Event
headCell: Dom of the head cell.
colObj: Column object.
grid: Grid object.
returns: Boolean. Return false to prevent cell from being active.

onComplete:function(grid)
Called when: Grid is completely loaded.
grid: Grid object.

onDblClickCell:function(value, record , cell, row, colNO, rowNO,columnObj,grid)
Called when: End user double click one cell.
value: Value of the cell where mouse pointer is at.
record: Object or array. Data record of the row where the cell is at.
cell: Dom of the cell.
row: Dom of row where the cell is at.
colNo: Index of the column where the cell is at.
columnObj: Column object.
grid: Grid object.
returns: Boolean. Return false to prevent cell from being active.

onMouseMove: function(event,grid)
Fired when mouse pointer is moving over grid.
event: Object. See Sigma.Grid.Event
grid: Object. Grid Object.

onResize:function()
Called when: Width or height of grid changes.

saveFailure:function(repObject)
Fired when failing to save data to server.
repObject.exception : String. Exception string.
repObject.success : Bool. Value indicating whether server side script is executed successfully or not.
text: String. Raw text from server side to client.

saveResponseHandler : function(response,requestParameter)
This function is a call back function to deal with the received content from server side. Developer could do some data translation work within this function.
response: String. Response content.
requestParameter: Object. See DataExchange.Saving