jquery.dgtable 2.0.36 → 2.0.38

package/README.md

@@ -89,10 +89,10 @@ To create a new table, just use `var myTable = new DGTable(INIT_OPTIONS)`.
 * **adjustColumnWidthForSortArrow**: `boolean=true` When set, the columns will automatically grow to accommodate for the sort arrow.
 * **relativeWidthGrowsToFillWidth**: `boolean=true` When set, relative width columns automatically grow to fill the table's width.
 * **relativeWidthShrinksToFillWidth**: `boolean=false` When set, relative width columns automatically shrink to fill the table's width.
-* **convertColumnWidthsToRelative**: `boolean=false` When set, auto-width columns are automatically converted to relatives.
-* **autoFillTableWidth**: `boolean=false` When set, columns are stretched proportionally to fill the table width (only if there is space left). Will supersede `relativeWidthGrowsToFillWidth` in the future.
-* **autoFillLastColumn**: `boolean=true` When set, the last visible column expands to fill leftover table width without changing its configured width.
-* **allowCancelSort**: `boolean=true` When set, the sorting arrows will have 3 modes - asc, desc, and cancelled.
+* **convertColumnWidthsToRelative**: `boolean=false` When set, auto-width columns are automatically converted to relatives.
+* **autoFillTableWidth**: `boolean=false` When set, columns are stretched proportionally to fill the table width (only if there is space left). Will supersede `relativeWidthGrowsToFillWidth` in the future.
+* **autoFillLastColumn**: `boolean=true` When set, the last visible column expands to fill leftover table width without changing its configured width.
+* **allowCancelSort**: `boolean=true` When set, the sorting arrows will have 3 modes - asc, desc, and cancelled.
 * **cellClasses**: `string` Classes to add to the DOM element of all cells
 * **sortColumn**: `string|string[]|COLUMN_SORT_OPTIONS|COLUMN_SORT_OPTIONS[]` Columns to sort by
   * Can be a column or an array of columns.
@@ -102,9 +102,9 @@ To create a new table, just use `var myTable = new DGTable(INIT_OPTIONS)`.
 * **cellFormatter**: `Function(string value, string columnName, Object rowData)string` *(optional)* A formatter function which will return the HTML for the cell. By default the formatter is a plain HTML formatter.
 * **headerCellFormatter**: `Function(string value, string columnName)string` *(optional)* A formatter function which will return the HTML for the cell's header. By default the formatter is a plain HTML formatter.
 * **rowsBufferSize**: `number=10` The size of the rows buffer, for virtual table
-* **minColumnWidth**: `number=35` In pixels, the minimum width for a column
-* **resizeAreaWidth**: `number=8` The size of the area where you can drag to resize.
-* **autoFitColumnOnResizeDoubleClick**: `boolean=false` Auto-fit a column when the user double-clicks the resize area.
+* **minColumnWidth**: `number=35` In pixels, the minimum width for a column
+* **resizeAreaWidth**: `number=8` The size of the area where you can drag to resize.
+* **autoFitColumnOnResizeDoubleClick**: `boolean=false` Auto-fit a column when the user double-clicks the resize area.
 * **onComparatorRequired**: `function(columnName: string, descending: boolean, defaultComparator: function(a,b):number):{function(a,b):number}` A callback that can pass a comparator function for each column and mode as required.
 * **resizerClassName**: `string='dgtable-resize'` Class name for the dragged resizing element (showing when resizing a column)
 * **tableClassName**: `string='dgtable'` Class name for the table
@@ -133,10 +133,10 @@ To create a new table, just use `var myTable = new DGTable(INIT_OPTIONS)`.
 * `addcolumn`: A column was added - `string` (the column's name)
 * `removecolumn`: A column was removed - `string` (the column's name)
 * `movecolumn`: A column was moved - `({ name: string, src: number, dest: number })`
-* `showcolumn`: A column was shown - `string` (the column's name)
-* `hidecolumn`: A column was hidden - `string` (the column's name)
-* `columnwidth`: A column was resized - `({ name: string, width: number|string, oldWidth: number|string })`
-* `columnresizeareadoubleclick`: A column resize area was double-clicked - `({ name: string, columnName: string, event: Event })`
+* `showcolumn`: A column was shown - `string` (the column's name)
+* `hidecolumn`: A column was hidden - `string` (the column's name)
+* `columnwidth`: A column was resized - `({ name: string, width: number|string, oldWidth: number|string })`
+* `columnresizeareadoubleclick`: A column resize area was double-clicked - `({ name: string, columnName: string, event: Event })`
 * `filter`: A filter was applied - `any` - the arguments passed to the filter method
 * `filterclear`: A filter was cleared
 * `sort`: The data was sorted - `{ sorts: { "column": "column's name", "descending": true|false }[], resort: true|undefined, comparator: Function }`
@@ -213,14 +213,14 @@ To create a new table, just use `var myTable = new DGTable(INIT_OPTIONS)`.
 * `getMovableColumns() {boolean}`: *Undocumented yet*
 * `setResizableColumns({boolean} resizableColumns) {DGTable}`: *Undocumented yet*
 * `getResizableColumns() {boolean}`: *Undocumented yet*
-* `setOnComparatorRequired({function(columnName: string, descending: boolean, defaultComparator: function(a,b):number):{function(a,b):number}}|null comparatorCallback) {DGTable}`: Sets a functions that supplies comparators dynamically
-  * **comparatorCallback**: a function that returns the comparator for a specific column
+* `setOnComparatorRequired({function(columnName: string, descending: boolean, defaultComparator: function(a,b):number):{function(a,b):number}}|null onComparatorRequired) {DGTable}`: Sets a functions that supplies comparators dynamically
+  * **onComparatorRequired**: a function that returns the comparator for a specific column
 * `setCustomSortingProvider({{function(data: any[], sort: function(any[]):any[]):any[]}|null} customSortingProvider) {DGTable}`: sets custom sorting function for a data set
   * **customSortingProvider**: provides a custom sorting function (not the comparator, but a sort() alternative) for a data set
-* `setColumnWidth({string} column, {number|string} width) {DGTable}`: Sets a column width. Use a number for pixels, a percentage string/decimal for relative width, `'auto'`, or `'rest'`.
-  * If `autoFillLastColumn` is enabled and visible columns do not reach the table edge, the last visible column expands as a layout-only fallback without changing its configured width.
-* `getColumnWidth({string} column) {string|null}`: *Undocumented yet*
-* `autoFitColumn({string} column) {DGTable}`: Fits a column to its header/content width when at least one row exists.
+* `setColumnWidth({string} column, {number|string} width) {DGTable}`: Sets a column width. Use a number for pixels, a percentage string/decimal for relative width, `'auto'`, or `'rest'`.
+  * If `autoFillLastColumn` is enabled and visible columns do not reach the table edge, the last visible column expands as a layout-only fallback without changing its configured width.
+* `getColumnWidth({string} column) {string|null}`: *Undocumented yet*
+* `autoFitColumn({string} column) {DGTable}`: Fits a column to its header/content width when at least one row exists.
 * `getColumnConfig({string} column name) {SERIALIZED_COLUMN}`: *Undocumented yet*
 * `getColumnsConfig() {Object}`: *Undocumented yet*
 * `getSortedColumns() {Array.<SERIALIZED_COLUMN_SORT>}`: *Undocumented yet*