Home

Kaas/Datagrid

Kind: global class

• Kaas/Datagrid
  • new DataGrid([options])
  • .sortHandler : CoreSort
  • .element : HTMLTableElement | boolean
  • .yScrollContainer : Node
  • .summaryRegister : DataSummary
  • .summaryFields : Object
  • .reset()
  • .hideColumns(columns)
  • .updateCellData(cell, data)
  • .getFormsData() ⇒ Object
  • .enableHeaderSort()
  • .addRows(json)
  • .renderText(text)
  • .render(force)
  • .selectAll(checked)
  • .sort(field, dir)
  • .getSortSettings() ⇒ Object
  • .registerPlugin(plugin)

new DataGrid([options])

Param	Type
[options]	Object
[options.element]	HTMLElement
[options.rowFormatter]	function
[options.summaryFields]	Object
[options.selectable]	boolean
[options.statusText]	String
[options.plugins]	Array
[options.editableCells]	Object
[options.cellFormatters]	Object
[options.sortFormatters]	Object
[options.cellClassFormatters]	Object
[options.rowHandler]	function

Example

var getPlugins = function () {
     return [
         new Kaas.plugins.DataLoader({url: './data/cars.json'})
     ]
 };

 var getCellFormatters = function () {
     return {
         model_weight_kg: Kaas.formatters.AmountFormat.format
     }
  };

 var getSummaryFields = function () {
     return {
         model_weight_kg: Kaas.formatters.AmountFormat.format
     }
 };

var rowFormatter = function(data) {
  delete data.model_lkm_city; //remove this data row
  data.options = "options"; //add options row to
  return data;
};

var init = function () {
  var element = document.querySelector('#cars-table');
  new Kaas.DataGrid({
     element: element,
     plugins: getPlugins(),
      cellFormatters: getCellFormatters(),
      summaryFields: getSummaryFields(),
      rowHandler: rowFormatter,
      statusText: '%d Cars'
  });
};

kaas/Datagrid.sortHandler : CoreSort

Kind: instance property of Kaas/Datagrid

kaas/Datagrid.element : HTMLTableElement | boolean

Kind: instance property of Kaas/Datagrid

kaas/Datagrid.yScrollContainer : Node

Kind: instance property of Kaas/Datagrid

kaas/Datagrid.summaryRegister : DataSummary

Kind: instance property of Kaas/Datagrid

kaas/Datagrid.summaryFields : Object

Kind: instance property of Kaas/Datagrid
Orivate:

kaas/Datagrid.reset()

Kind: instance method of Kaas/Datagrid

kaas/Datagrid.hideColumns(columns)

Kind: instance method of Kaas/Datagrid

Param	Type	Description
columns	Array	// array of column numbers

Example

var hiddenColumns = [1,2,3]
myDataGrid.hideColumns(hiddenColumns);

kaas/Datagrid.updateCellData(cell, data)

Kind: instance method of Kaas/Datagrid

Param	Type
cell	number
data	HTMLElement | DocumentFragment | String

kaas/Datagrid.getFormsData() ⇒ Object

Kind: instance method of Kaas/Datagrid
Returns: Object - //data from edit mode

kaas/Datagrid.enableHeaderSort()

Kind: instance method of Kaas/Datagrid

kaas/Datagrid.addRows(json)

Kind: instance method of Kaas/Datagrid

Param	Type	Description
json	String	//Json result string

kaas/Datagrid.renderText(text)

Kind: instance method of Kaas/Datagrid

Param	Type
text	String

kaas/Datagrid.render(force)

Kind: instance method of Kaas/Datagrid

Param	Type
force	Boolean

kaas/Datagrid.selectAll(checked)

Kind: instance method of Kaas/Datagrid

Param
checked

kaas/Datagrid.sort(field, dir)

Kind: instance method of Kaas/Datagrid

Param	Type
field	number
dir	number

kaas/Datagrid.getSortSettings() ⇒ Object

Kind: instance method of Kaas/Datagrid

kaas/Datagrid.registerPlugin(plugin)

Kind: instance method of Kaas/Datagrid

Param	Type
plugin	Plugin