-
- public
-
-
-
-
- prfxLoader: string
-
-
-
- source
-
-
-
-
-
-
-
-
-
-
@@ -1326,14 +1281,15 @@
- source
+ source
-
+
@@ -1366,14 +1322,15 @@
- source
+ source
-
+
Initializes Loader instance
+
@@ -1402,18 +1359,19 @@
-
show(p: *)
+
show(Two: String)
- source
+ source
-
+
Shows or hides activity indicator
+
@@ -1426,10 +1384,11 @@
- | p |
- * |
+ Two |
+ String |
|
- |
+ possible values: '' or 'none'
+ |
diff --git a/docs/class/src/modules/noResults.js~NoResults.html b/docs/class/src/modules/noResults.js~NoResults.html
index 7c877285..2ac7e900 100644
--- a/docs/class/src/modules/noResults.js~NoResults.html
+++ b/docs/class/src/modules/noResults.js~NoResults.html
@@ -3,7 +3,7 @@
-
NoResults | tablefilter v0.2.45 API Document
+
NoResults | tablefilter v0.2.46 API Document
diff --git a/docs/class/src/modules/paging.js~Paging.html b/docs/class/src/modules/paging.js~Paging.html
index 5c78f98a..272dabb7 100644
--- a/docs/class/src/modules/paging.js~Paging.html
+++ b/docs/class/src/modules/paging.js~Paging.html
@@ -3,7 +3,7 @@
-
Paging | tablefilter v0.2.45 API Document
+
Paging | tablefilter v0.2.46 API Document
diff --git a/docs/class/src/modules/popupFilter.js~PopupFilter.html b/docs/class/src/modules/popupFilter.js~PopupFilter.html
index c3e1ebd0..a0454608 100644
--- a/docs/class/src/modules/popupFilter.js~PopupFilter.html
+++ b/docs/class/src/modules/popupFilter.js~PopupFilter.html
@@ -3,7 +3,7 @@
-
PopupFilter | tablefilter v0.2.45 API Document
+
PopupFilter | tablefilter v0.2.46 API Document
diff --git a/docs/class/src/modules/rowsCounter.js~RowsCounter.html b/docs/class/src/modules/rowsCounter.js~RowsCounter.html
index c97b9aed..3f89b1e6 100644
--- a/docs/class/src/modules/rowsCounter.js~RowsCounter.html
+++ b/docs/class/src/modules/rowsCounter.js~RowsCounter.html
@@ -3,7 +3,7 @@
-
RowsCounter | tablefilter v0.2.45 API Document
+
RowsCounter | tablefilter v0.2.46 API Document
diff --git a/docs/class/src/modules/state.js~State.html b/docs/class/src/modules/state.js~State.html
index a381fd56..462d7898 100644
--- a/docs/class/src/modules/state.js~State.html
+++ b/docs/class/src/modules/state.js~State.html
@@ -3,7 +3,7 @@
-
State | tablefilter v0.2.45 API Document
+
State | tablefilter v0.2.46 API Document
diff --git a/docs/class/src/modules/statusBar.js~StatusBar.html b/docs/class/src/modules/statusBar.js~StatusBar.html
index 324dc6f8..ffac5830 100644
--- a/docs/class/src/modules/statusBar.js~StatusBar.html
+++ b/docs/class/src/modules/statusBar.js~StatusBar.html
@@ -3,7 +3,7 @@
-
StatusBar | tablefilter v0.2.45 API Document
+
StatusBar | tablefilter v0.2.46 API Document
diff --git a/docs/class/src/modules/storage.js~Storage.html b/docs/class/src/modules/storage.js~Storage.html
index 5eb1ca95..612d1b46 100644
--- a/docs/class/src/modules/storage.js~Storage.html
+++ b/docs/class/src/modules/storage.js~Storage.html
@@ -3,7 +3,7 @@
-
Storage | tablefilter v0.2.45 API Document
+
Storage | tablefilter v0.2.46 API Document
diff --git a/docs/class/src/tablefilter.js~TableFilter.html b/docs/class/src/tablefilter.js~TableFilter.html
index 1653d48e..0efddc3e 100644
--- a/docs/class/src/tablefilter.js~TableFilter.html
+++ b/docs/class/src/tablefilter.js~TableFilter.html
@@ -3,7 +3,7 @@
-
TableFilter | tablefilter v0.2.45 API Document
+
TableFilter | tablefilter v0.2.46 API Document
diff --git a/docs/coverage.json b/docs/coverage.json
index 33c2298d..01db6461 100644
--- a/docs/coverage.json
+++ b/docs/coverage.json
@@ -1,7 +1,7 @@
{
- "coverage": "42.31%",
- "expectCount": 761,
- "actualCount": 322,
+ "coverage": "44.73%",
+ "expectCount": 760,
+ "actualCount": 340,
"files": {
"src/const.js": {
"expectCount": 13,
@@ -354,34 +354,14 @@
},
"src/modules/highlightKeywords.js": {
"expectCount": 10,
- "actualCount": 4,
- "undocumentLines": [
- 4,
- 111,
- 16,
- 13,
- 19,
- 15
- ]
+ "actualCount": 10,
+ "undocumentLines": []
},
"src/modules/loader.js": {
- "expectCount": 15,
- "actualCount": 1,
+ "expectCount": 14,
+ "actualCount": 13,
"undocumentLines": [
- 7,
- 117,
- 39,
- 92,
- 30,
- 28,
- 22,
- 26,
- 24,
- 20,
- 34,
- 32,
- 36,
- 95
+ 138
]
},
"src/modules/noResults.js": {
diff --git a/docs/dump.json b/docs/dump.json
index 3300c57d..34bb7e67 100644
--- a/docs/dump.json
+++ b/docs/dump.json
@@ -6608,7 +6608,7 @@
"access": null,
"description": null,
"lineNumber": 1,
- "content": "import {Feature} from '../feature';\nimport {createElm, createText, elm, removeElm} from '../dom';\nimport {addEvt} from '../event';\n\n/**\n * Clear button UI component\n */\nexport class ClearButton extends Feature {\n\n /**\n * Creates an instance of ClearButton\n * @param {TableFilter} tf TableFilter instance\n */\n constructor(tf) {\n super(tf, 'btnReset');\n\n let f = this.config;\n\n /**\n * Container element ID\n * @type {String}\n */\n this.targetId = f.btn_reset_target_id || null;\n\n /**\n * Clear button element\n * @type {DOMElement}\n * @private\n */\n this.element = null;\n\n /**\n * Text for the clear button\n * @type {String}\n */\n this.text = f.btn_reset_text || 'Reset';\n\n /**\n * Tooltip text for the clear button\n * @type {String}\n */\n this.tooltip = f.btn_reset_tooltip || 'Clear filters';\n\n /**\n * Custom Html string for the clear button\n * @type {String}\n */\n this.html = f.btn_reset_html ||\n (!tf.enableIcons ? null :\n '
');\n\n /**\n * Prefix fot ID of container element\n * @type {String}\n * @private\n */\n this.prfxCont = 'resetspan_';\n }\n\n /**\n * Click event handler for clear button\n * @private\n */\n onClick() {\n if (!this.isEnabled()) {\n return;\n }\n this.tf.clearFilters();\n }\n\n /**\n * Initialize clear button component\n */\n init() {\n let tf = this.tf;\n\n if (this.initialized) {\n return;\n }\n\n let resetspan = createElm('span', ['id', this.prfxCont + tf.id]);\n\n // reset button is added to defined element\n if (!this.targetId) {\n tf.setToolbar();\n }\n let targetEl = !this.targetId ? tf.rDiv : elm(this.targetId);\n targetEl.appendChild(resetspan);\n\n if (!this.html) {\n let fltreset = createElm('a', ['href', 'javascript:void(0);']);\n fltreset.className = tf.btnResetCssClass;\n fltreset.appendChild(createText(this.text));\n resetspan.appendChild(fltreset);\n addEvt(fltreset, 'click', () => this.onClick());\n } else {\n resetspan.innerHTML = this.html;\n let resetEl = resetspan.firstChild;\n addEvt(resetEl, 'click', () => this.onClick());\n }\n this.element = resetspan.firstChild;\n\n this.initialized = true;\n }\n\n /**\n * Destroy ClearButton instance\n */\n destroy() {\n let tf = this.tf;\n\n if (!this.initialized) {\n return;\n }\n\n let resetspan = elm(this.prfxCont + tf.id);\n if (resetspan) {\n removeElm(resetspan);\n }\n this.element = null;\n this.initialized = false;\n }\n}\n"
+ "content": "import {Feature} from '../feature';\nimport {createElm, createText, elm, removeElm} from '../dom';\nimport {addEvt} from '../event';\n\n/**\n * Clear button UI component\n */\nexport class ClearButton extends Feature {\n\n /**\n * Creates an instance of ClearButton\n * @param {TableFilter} tf TableFilter instance\n */\n constructor(tf) {\n super(tf, 'btnReset');\n\n let f = this.config;\n\n /**\n * Container element ID\n * @type {String}\n */\n this.targetId = f.btn_reset_target_id || null;\n\n /**\n * Clear button element\n * @type {DOMElement}\n * @private\n */\n this.element = null;\n\n /**\n * Text for the clear button\n * @type {String}\n */\n this.text = f.btn_reset_text || 'Reset';\n\n /**\n * Tooltip text for the clear button\n * @type {String}\n */\n this.tooltip = f.btn_reset_tooltip || 'Clear filters';\n\n /**\n * Custom Html string for the clear button\n * @type {String}\n */\n this.html = f.btn_reset_html ||\n (!tf.enableIcons ? null :\n '
');\n\n /**\n * Prefix for container ID\n * @type {String}\n * @private\n */\n this.prfxCont = 'resetspan_';\n }\n\n /**\n * Click event handler for clear button\n * @private\n */\n onClick() {\n if (!this.isEnabled()) {\n return;\n }\n this.tf.clearFilters();\n }\n\n /**\n * Initialize clear button component\n */\n init() {\n let tf = this.tf;\n\n if (this.initialized) {\n return;\n }\n\n let resetspan = createElm('span', ['id', this.prfxCont + tf.id]);\n\n // reset button is added to defined element\n if (!this.targetId) {\n tf.setToolbar();\n }\n let targetEl = !this.targetId ? tf.rDiv : elm(this.targetId);\n targetEl.appendChild(resetspan);\n\n if (!this.html) {\n let fltreset = createElm('a', ['href', 'javascript:void(0);']);\n fltreset.className = tf.btnResetCssClass;\n fltreset.appendChild(createText(this.text));\n resetspan.appendChild(fltreset);\n addEvt(fltreset, 'click', () => this.onClick());\n } else {\n resetspan.innerHTML = this.html;\n let resetEl = resetspan.firstChild;\n addEvt(resetEl, 'click', () => this.onClick());\n }\n this.element = resetspan.firstChild;\n\n this.initialized = true;\n }\n\n /**\n * Destroy ClearButton instance\n */\n destroy() {\n let tf = this.tf;\n\n if (!this.initialized) {\n return;\n }\n\n let resetspan = elm(this.prfxCont + tf.id);\n if (resetspan) {\n removeElm(resetspan);\n }\n this.element = null;\n this.initialized = false;\n }\n}\n"
},
{
"__docId__": 304,
@@ -6763,7 +6763,7 @@
"memberof": "src/modules/clearButton.js~ClearButton",
"longname": "src/modules/clearButton.js~ClearButton#prfxCont",
"access": "private",
- "description": "Prefix fot ID of container element",
+ "description": "Prefix for container ID",
"lineNumber": 58,
"type": {
"nullable": null,
@@ -7506,7 +7506,7 @@
"access": null,
"description": null,
"lineNumber": 1,
- "content": "import {Feature} from '../feature';\nimport {createElm, removeElm, elm, tag} from '../dom';\nimport {isNull} from '../types';\nimport {addEvt, targetEvt} from '../event';\nimport {contains} from '../string';\nimport {NONE} from '../const';\n\n/**\n * Grid layout, table with fixed headers\n */\nexport class GridLayout extends Feature {\n\n /**\n * Creates an instance of GridLayout\n * @param {Object} tf TableFilter instance\n */\n constructor(tf) {\n super(tf, 'gridLayout');\n\n let f = this.config;\n\n /**\n * Grid-layout container width as CSS string\n * @type {String}\n */\n this.width = f.grid_width || null;\n\n /**\n * Grid-layout container height as CSS string\n * @type {String}\n */\n this.height = f.grid_height || null;\n\n /**\n * Css class for main container element\n * @type {String}\n */\n this.mainContCssClass = f.grid_cont_css_class || 'grd_Cont';\n\n /**\n * Css class for body table container element\n * @type {String}\n */\n this.contCssClass = f.grid_tbl_cont_css_class || 'grd_tblCont';\n\n /**\n * Css class for headers table container element\n * @type {String}\n */\n this.headContCssClass = f.grid_tblHead_cont_css_class ||\n 'grd_headTblCont';\n\n /**\n * Css class for toolbar container element (rows counter, paging etc.)\n * @type {String}\n */\n this.infDivCssClass = f.grid_inf_grid_css_class || 'grd_inf';\n\n /**\n * Index of the headers row, default: 0\n * @type {Number}\n */\n this.headRowIndex = f.grid_headers_row_index || 0;\n\n /**\n * Collection of the header row indexes to be moved into headers table\n * @type {Array}\n */\n this.headRows = f.grid_headers_rows || [0];\n\n /**\n * Enable or disable column filters generation, default: true\n * @type {Boolean}\n */\n this.enableFilters = f.grid_enable_default_filters === false ?\n false : true;\n\n /**\n * Enable or disable column headers, default: false\n * @type {Boolean}\n */\n this.noHeaders = Boolean(f.grid_no_headers);\n\n /**\n * Grid-layout default column widht as CSS string\n * @type {String}\n */\n this.defaultColWidth = f.grid_default_col_width || '100px';\n\n /**\n * List of column elements\n * @type {Array}\n * @private\n */\n this.colElms = [];\n\n /**\n * Prefix for grid-layout main container ID\n * @type {String}\n * @private\n */\n this.prfxMainTblCont = 'gridCont_';\n\n /**\n * Prefix for grid-layout body table container ID\n * @type {String}\n * @private\n */\n this.prfxTblCont = 'tblCont_';\n\n /**\n * Prefix for grid-layout headers table container ID\n * @type {String}\n * @private\n */\n this.prfxHeadTblCont = 'tblHeadCont_';\n\n /**\n * Prefix for grid-layout headers table ID\n * @type {String}\n * @private\n */\n this.prfxHeadTbl = 'tblHead_';\n\n /**\n * Prefix for grid-layout filter's cell ID\n * @type {String}\n * @private\n */\n this.prfxGridFltTd = '_td_';\n\n /**\n * Prefix for grid-layout header's cell ID\n * @type {String}\n * @private\n */\n this.prfxGridTh = 'tblHeadTh_';\n\n /**\n * Mark-up of original HTML table\n * @type {String}\n * @private\n */\n this.sourceTblHtml = tf.tbl.outerHTML;\n\n /**\n * Indicates if working table has column elements\n * @type {Boolean}\n * @private\n */\n this.tblHasColTag = tag(tf.tbl, 'col').length > 0 ? true : false;\n\n // filters flag at TF level\n tf.fltGrid = this.enableFilters;\n }\n\n /**\n * Generates a grid with fixed headers\n * TODO: reduce size of init by extracting single purposed methods\n */\n init() {\n let tf = this.tf;\n let tbl = tf.tbl;\n\n if (this.initialized) {\n return;\n }\n\n // Override relevant TableFilter properties\n this.setOverrides();\n\n // Assign default column widths\n this.setDefaultColWidths();\n\n // Initial table width\n let tblW = this.initialTableWidth();\n\n //Main container: it will contain all the elements\n this.tblMainCont = this.createContainer(this.prfxMainTblCont + tf.id,\n 'div', this.mainContCssClass);\n if (this.width) {\n this.tblMainCont.style.width = this.width;\n }\n tbl.parentNode.insertBefore(this.tblMainCont, tbl);\n\n //Table container: div wrapping content table\n this.tblCont = this.createContainer(this.prfxTblCont + tf.id, 'div',\n this.contCssClass);\n this.setConfigWidth(this.tblCont);\n if (this.height) {\n this.tblCont.style.height = this.height;\n }\n tbl.parentNode.insertBefore(this.tblCont, tbl);\n let t = removeElm(tbl);\n this.tblCont.appendChild(t);\n\n //In case table width is expressed in %\n if (tbl.style.width === '') {\n tbl.style.width = (contains('%', tblW) ?\n tbl.clientWidth : tblW) + 'px';\n }\n\n let d = removeElm(this.tblCont);\n this.tblMainCont.appendChild(d);\n\n //Headers table container: div wrapping headers table\n this.headTblCont = this.createContainer(this.prfxHeadTblCont + tf.id,\n 'div', this.headContCssClass);\n this.setConfigWidth(this.headTblCont);\n\n //Headers table\n this.headTbl = createElm('table', ['id', this.prfxHeadTbl + tf.id]);\n let tH = createElm('tHead');\n\n //1st row should be headers row, ids are added if not set\n //Those ids are used by the sort feature\n let hRow = tbl.rows[this.headRowIndex];\n let sortTriggers = this.getSortTriggerIds(hRow);\n\n //Filters row is created\n let filtersRow = this.createFiltersRow();\n\n //Headers row are moved from content table to headers table\n this.setHeadersRow(tH);\n\n this.headTbl.appendChild(tH);\n if (tf.filtersRowIndex === 0) {\n tH.insertBefore(filtersRow, hRow);\n } else {\n tH.appendChild(filtersRow);\n }\n\n this.headTblCont.appendChild(this.headTbl);\n this.tblCont.parentNode.insertBefore(this.headTblCont, this.tblCont);\n\n //THead needs to be removed in content table for sort feature\n let thead = tag(tbl, 'thead');\n if (thead.length > 0) {\n tbl.removeChild(thead[0]);\n }\n\n //Headers table style\n this.headTbl.style.tableLayout = 'fixed';\n tbl.style.tableLayout = 'fixed';\n this.headTbl.cellPadding = tbl.cellPadding;\n this.headTbl.cellSpacing = tbl.cellSpacing;\n // this.headTbl.style.width = tbl.style.width;\n\n //content table without headers needs col widths to be reset\n tf.setColWidths(this.headTbl);\n\n //Headers container width\n // this.headTblCont.style.width = this.tblCont.clientWidth+'px';\n\n tbl.style.width = '';\n //\n this.headTbl.style.width = tbl.clientWidth + 'px';\n //\n\n //scroll synchronisation\n addEvt(this.tblCont, 'scroll', (evt) => {\n let elm = targetEvt(evt);\n let scrollLeft = elm.scrollLeft;\n this.headTblCont.scrollLeft = scrollLeft;\n //New pointerX calc taking into account scrollLeft\n // if(!o.isPointerXOverwritten){\n // try{\n // o.Evt.pointerX = function(evt){\n // let e = evt || global.event;\n // let bdScrollLeft = tf_StandardBody().scrollLeft +\n // scrollLeft;\n // return (e.pageX + scrollLeft) ||\n // (e.clientX + bdScrollLeft);\n // };\n // o.isPointerXOverwritten = true;\n // } catch(err) {\n // o.isPointerXOverwritten = false;\n // }\n // }\n });\n\n // TODO: Trigger a custom event handled by sort extension\n let sort = tf.extension('sort');\n if (sort) {\n sort.asyncSort = true;\n sort.triggerIds = sortTriggers;\n }\n\n //Col elements are enough to keep column widths after sorting and\n //filtering\n this.setColumnElements();\n\n if (tf.popupFilters) {\n filtersRow.style.display = NONE;\n }\n\n if (tbl.clientWidth !== this.headTbl.clientWidth) {\n tbl.style.width = this.headTbl.clientWidth + 'px';\n }\n\n this.initialized = true;\n }\n\n /**\n * Overrides TableFilter instance properties to adjust to grid layout mode\n * @private\n */\n setOverrides() {\n let tf = this.tf;\n tf.refRow = isNull(tf.startRow) ? 0 : tf.startRow;\n tf.headersRow = 0;\n tf.filtersRowIndex = 1;\n tf.isExternalFlt = true;\n }\n\n /**\n * Set grid-layout default column widths if column widths are not defined\n * @private\n */\n setDefaultColWidths() {\n let tf = this.tf;\n if (tf.hasColWidths) {\n return;\n }\n for (let k = 0, len = tf.getCellsNb(); k < len; k++) {\n let colW;\n let cell = tf.tbl.rows[tf.getHeadersRowIndex()].cells[k];\n if (cell.width !== '') {\n colW = cell.width;\n } else if (cell.style.width !== '') {\n colW = parseInt(cell.style.width, 10);\n } else {\n colW = this.defaultColWidth;\n }\n tf.colWidths[k] = colW;\n }\n tf.hasColWidths = true;\n tf.setColWidths();\n }\n\n /**\n * Initial table width\n * @returns {Number}\n * @private\n */\n initialTableWidth() {\n let tbl = this.tf.tbl;\n let width; //initial table width\n\n if (tbl.width !== '') {\n width = tbl.width;\n }\n else if (tbl.style.width !== '') {\n width = tbl.style.width;\n } else {\n width = tbl.clientWidth;\n }\n return parseInt(width, 10);\n }\n\n /**\n * Creates container element\n * @param {String} id Element ID\n * @param {String} tag Tag name\n * @param {String} className Css class to assign to element\n * @returns {DOMElement}\n * @private\n */\n createContainer(id, tag, className) {\n let element = createElm(tag, ['id', id]);\n element.className = className;\n return element;\n }\n\n /**\n * Creates filters row with cells\n * @returns {HTMLTableRowElement}\n * @private\n */\n createFiltersRow() {\n let tf = this.tf;\n let filtersRow = createElm('tr');\n if (this.enableFilters && tf.fltGrid) {\n tf.externalFltTgtIds = [];\n for (let j = 0; j < tf.getCellsNb(); j++) {\n let fltTdId = tf.prfxFlt + j + this.prfxGridFltTd + tf.id;\n let cl = createElm(tf.fltCellTag, ['id', fltTdId]);\n filtersRow.appendChild(cl);\n tf.externalFltTgtIds[j] = fltTdId;\n }\n }\n return filtersRow;\n }\n\n /**\n * Generates column elements if necessary and assigns their widths\n * @private\n */\n setColumnElements() {\n let tf = this.tf;\n let cols = tag(tf.tbl, 'col');\n this.tblHasColTag = cols.length > 0;\n\n for (let k = (tf.nbCells - 1); k >= 0; k--) {\n let col;\n let id = `${tf.id}_col_${k}`;\n\n if (!this.tblHasColTag) {\n col = createElm('col', ['id', id]);\n tf.tbl.insertBefore(col, tf.tbl.firstChild);\n } else {\n col = cols[k];\n col.setAttribute('id', id);\n }\n col.style.width = tf.colWidths[k];\n this.colElms[k] = col;\n }\n this.tblHasColTag = true;\n }\n\n /**\n * Sets headers row in headers table\n * @param {HTMLHeadElement} tableHead Table head element\n * @private\n */\n setHeadersRow(tableHead) {\n if (this.noHeaders) {\n // Handle table with no headers, assuming here headers do not\n // exist\n tableHead.appendChild(createElm('tr'));\n } else {\n // Headers row are moved from content table to headers table\n for (let i = 0; i < this.headRows.length; i++) {\n let row = this.tf.tbl.rows[this.headRows[i]];\n tableHead.appendChild(row);\n }\n }\n }\n\n /**\n * Sets width defined in configuration to passed element\n * @param {DOMElement} element DOM element\n * @private\n */\n setConfigWidth(element) {\n if (!this.width) {\n return;\n }\n if (this.width.indexOf('%') !== -1) {\n element.style.width = '100%';\n } else {\n element.style.width = this.width;\n }\n }\n\n /**\n * Returns a list of header IDs used for specifing external sort triggers\n * @param {HTMLTableRowElement} row DOM row element\n * @returns {Array} List of IDs\n * @private\n */\n getSortTriggerIds(row) {\n let tf = this.tf;\n let sortTriggers = [];\n for (let n = 0; n < tf.getCellsNb(); n++) {\n let c = row.cells[n];\n let thId = c.getAttribute('id');\n if (!thId || thId === '') {\n thId = this.prfxGridTh + n + '_' + tf.id;\n c.setAttribute('id', thId);\n }\n sortTriggers.push(thId);\n }\n return sortTriggers;\n }\n\n /**\n * Removes the grid layout\n */\n destroy() {\n let tf = this.tf;\n let tbl = tf.tbl;\n\n if (!this.initialized) {\n return;\n }\n let t = removeElm(tbl);\n this.tblMainCont.parentNode.insertBefore(t, this.tblMainCont);\n removeElm(this.tblMainCont);\n\n this.tblMainCont = null;\n this.headTblCont = null;\n this.headTbl = null;\n this.tblCont = null;\n\n tbl.outerHTML = this.sourceTblHtml;\n //needed to keep reference of table element for future usage\n this.tf.tbl = elm(tf.id);\n\n this.initialized = false;\n }\n}\n"
+ "content": "import {Feature} from '../feature';\nimport {createElm, removeElm, elm, tag} from '../dom';\nimport {isNull} from '../types';\nimport {addEvt, targetEvt} from '../event';\nimport {contains} from '../string';\nimport {NONE} from '../const';\n\n/**\n * Grid layout, table with fixed headers\n */\nexport class GridLayout extends Feature {\n\n /**\n * Creates an instance of GridLayout\n * @param {TableFilter} tf TableFilter instance\n */\n constructor(tf) {\n super(tf, 'gridLayout');\n\n let f = this.config;\n\n /**\n * Grid-layout container width as CSS string\n * @type {String}\n */\n this.width = f.grid_width || null;\n\n /**\n * Grid-layout container height as CSS string\n * @type {String}\n */\n this.height = f.grid_height || null;\n\n /**\n * Css class for main container element\n * @type {String}\n */\n this.mainContCssClass = f.grid_cont_css_class || 'grd_Cont';\n\n /**\n * Css class for body table container element\n * @type {String}\n */\n this.contCssClass = f.grid_tbl_cont_css_class || 'grd_tblCont';\n\n /**\n * Css class for headers table container element\n * @type {String}\n */\n this.headContCssClass = f.grid_tblHead_cont_css_class ||\n 'grd_headTblCont';\n\n /**\n * Css class for toolbar container element (rows counter, paging etc.)\n * @type {String}\n */\n this.infDivCssClass = f.grid_inf_grid_css_class || 'grd_inf';\n\n /**\n * Index of the headers row, default: 0\n * @type {Number}\n */\n this.headRowIndex = f.grid_headers_row_index || 0;\n\n /**\n * Collection of the header row indexes to be moved into headers table\n * @type {Array}\n */\n this.headRows = f.grid_headers_rows || [0];\n\n /**\n * Enable or disable column filters generation, default: true\n * @type {Boolean}\n */\n this.enableFilters = f.grid_enable_default_filters === false ?\n false : true;\n\n /**\n * Enable or disable column headers, default: false\n * @type {Boolean}\n */\n this.noHeaders = Boolean(f.grid_no_headers);\n\n /**\n * Grid-layout default column widht as CSS string\n * @type {String}\n */\n this.defaultColWidth = f.grid_default_col_width || '100px';\n\n /**\n * List of column elements\n * @type {Array}\n * @private\n */\n this.colElms = [];\n\n /**\n * Prefix for grid-layout main container ID\n * @type {String}\n * @private\n */\n this.prfxMainTblCont = 'gridCont_';\n\n /**\n * Prefix for grid-layout body table container ID\n * @type {String}\n * @private\n */\n this.prfxTblCont = 'tblCont_';\n\n /**\n * Prefix for grid-layout headers table container ID\n * @type {String}\n * @private\n */\n this.prfxHeadTblCont = 'tblHeadCont_';\n\n /**\n * Prefix for grid-layout headers table ID\n * @type {String}\n * @private\n */\n this.prfxHeadTbl = 'tblHead_';\n\n /**\n * Prefix for grid-layout filter's cell ID\n * @type {String}\n * @private\n */\n this.prfxGridFltTd = '_td_';\n\n /**\n * Prefix for grid-layout header's cell ID\n * @type {String}\n * @private\n */\n this.prfxGridTh = 'tblHeadTh_';\n\n /**\n * Mark-up of original HTML table\n * @type {String}\n * @private\n */\n this.sourceTblHtml = tf.tbl.outerHTML;\n\n /**\n * Indicates if working table has column elements\n * @type {Boolean}\n * @private\n */\n this.tblHasColTag = tag(tf.tbl, 'col').length > 0 ? true : false;\n\n // filters flag at TF level\n tf.fltGrid = this.enableFilters;\n }\n\n /**\n * Generates a grid with fixed headers\n * TODO: reduce size of init by extracting single purposed methods\n */\n init() {\n let tf = this.tf;\n let tbl = tf.tbl;\n\n if (this.initialized) {\n return;\n }\n\n // Override relevant TableFilter properties\n this.setOverrides();\n\n // Assign default column widths\n this.setDefaultColWidths();\n\n // Initial table width\n let tblW = this.initialTableWidth();\n\n //Main container: it will contain all the elements\n this.tblMainCont = this.createContainer(this.prfxMainTblCont + tf.id,\n 'div', this.mainContCssClass);\n if (this.width) {\n this.tblMainCont.style.width = this.width;\n }\n tbl.parentNode.insertBefore(this.tblMainCont, tbl);\n\n //Table container: div wrapping content table\n this.tblCont = this.createContainer(this.prfxTblCont + tf.id, 'div',\n this.contCssClass);\n this.setConfigWidth(this.tblCont);\n if (this.height) {\n this.tblCont.style.height = this.height;\n }\n tbl.parentNode.insertBefore(this.tblCont, tbl);\n let t = removeElm(tbl);\n this.tblCont.appendChild(t);\n\n //In case table width is expressed in %\n if (tbl.style.width === '') {\n tbl.style.width = (contains('%', tblW) ?\n tbl.clientWidth : tblW) + 'px';\n }\n\n let d = removeElm(this.tblCont);\n this.tblMainCont.appendChild(d);\n\n //Headers table container: div wrapping headers table\n this.headTblCont = this.createContainer(this.prfxHeadTblCont + tf.id,\n 'div', this.headContCssClass);\n this.setConfigWidth(this.headTblCont);\n\n //Headers table\n this.headTbl = createElm('table', ['id', this.prfxHeadTbl + tf.id]);\n let tH = createElm('tHead');\n\n //1st row should be headers row, ids are added if not set\n //Those ids are used by the sort feature\n let hRow = tbl.rows[this.headRowIndex];\n let sortTriggers = this.getSortTriggerIds(hRow);\n\n //Filters row is created\n let filtersRow = this.createFiltersRow();\n\n //Headers row are moved from content table to headers table\n this.setHeadersRow(tH);\n\n this.headTbl.appendChild(tH);\n if (tf.filtersRowIndex === 0) {\n tH.insertBefore(filtersRow, hRow);\n } else {\n tH.appendChild(filtersRow);\n }\n\n this.headTblCont.appendChild(this.headTbl);\n this.tblCont.parentNode.insertBefore(this.headTblCont, this.tblCont);\n\n //THead needs to be removed in content table for sort feature\n let thead = tag(tbl, 'thead');\n if (thead.length > 0) {\n tbl.removeChild(thead[0]);\n }\n\n //Headers table style\n this.headTbl.style.tableLayout = 'fixed';\n tbl.style.tableLayout = 'fixed';\n this.headTbl.cellPadding = tbl.cellPadding;\n this.headTbl.cellSpacing = tbl.cellSpacing;\n // this.headTbl.style.width = tbl.style.width;\n\n //content table without headers needs col widths to be reset\n tf.setColWidths(this.headTbl);\n\n //Headers container width\n // this.headTblCont.style.width = this.tblCont.clientWidth+'px';\n\n tbl.style.width = '';\n //\n this.headTbl.style.width = tbl.clientWidth + 'px';\n //\n\n //scroll synchronisation\n addEvt(this.tblCont, 'scroll', (evt) => {\n let elm = targetEvt(evt);\n let scrollLeft = elm.scrollLeft;\n this.headTblCont.scrollLeft = scrollLeft;\n //New pointerX calc taking into account scrollLeft\n // if(!o.isPointerXOverwritten){\n // try{\n // o.Evt.pointerX = function(evt){\n // let e = evt || global.event;\n // let bdScrollLeft = tf_StandardBody().scrollLeft +\n // scrollLeft;\n // return (e.pageX + scrollLeft) ||\n // (e.clientX + bdScrollLeft);\n // };\n // o.isPointerXOverwritten = true;\n // } catch(err) {\n // o.isPointerXOverwritten = false;\n // }\n // }\n });\n\n // TODO: Trigger a custom event handled by sort extension\n let sort = tf.extension('sort');\n if (sort) {\n sort.asyncSort = true;\n sort.triggerIds = sortTriggers;\n }\n\n //Col elements are enough to keep column widths after sorting and\n //filtering\n this.setColumnElements();\n\n if (tf.popupFilters) {\n filtersRow.style.display = NONE;\n }\n\n if (tbl.clientWidth !== this.headTbl.clientWidth) {\n tbl.style.width = this.headTbl.clientWidth + 'px';\n }\n\n this.initialized = true;\n }\n\n /**\n * Overrides TableFilter instance properties to adjust to grid layout mode\n * @private\n */\n setOverrides() {\n let tf = this.tf;\n tf.refRow = isNull(tf.startRow) ? 0 : tf.startRow;\n tf.headersRow = 0;\n tf.filtersRowIndex = 1;\n tf.isExternalFlt = true;\n }\n\n /**\n * Set grid-layout default column widths if column widths are not defined\n * @private\n */\n setDefaultColWidths() {\n let tf = this.tf;\n if (tf.hasColWidths) {\n return;\n }\n for (let k = 0, len = tf.getCellsNb(); k < len; k++) {\n let colW;\n let cell = tf.tbl.rows[tf.getHeadersRowIndex()].cells[k];\n if (cell.width !== '') {\n colW = cell.width;\n } else if (cell.style.width !== '') {\n colW = parseInt(cell.style.width, 10);\n } else {\n colW = this.defaultColWidth;\n }\n tf.colWidths[k] = colW;\n }\n tf.hasColWidths = true;\n tf.setColWidths();\n }\n\n /**\n * Initial table width\n * @returns {Number}\n * @private\n */\n initialTableWidth() {\n let tbl = this.tf.tbl;\n let width; //initial table width\n\n if (tbl.width !== '') {\n width = tbl.width;\n }\n else if (tbl.style.width !== '') {\n width = tbl.style.width;\n } else {\n width = tbl.clientWidth;\n }\n return parseInt(width, 10);\n }\n\n /**\n * Creates container element\n * @param {String} id Element ID\n * @param {String} tag Tag name\n * @param {String} className Css class to assign to element\n * @returns {DOMElement}\n * @private\n */\n createContainer(id, tag, className) {\n let element = createElm(tag, ['id', id]);\n element.className = className;\n return element;\n }\n\n /**\n * Creates filters row with cells\n * @returns {HTMLTableRowElement}\n * @private\n */\n createFiltersRow() {\n let tf = this.tf;\n let filtersRow = createElm('tr');\n if (this.enableFilters && tf.fltGrid) {\n tf.externalFltTgtIds = [];\n for (let j = 0; j < tf.getCellsNb(); j++) {\n let fltTdId = tf.prfxFlt + j + this.prfxGridFltTd + tf.id;\n let cl = createElm(tf.fltCellTag, ['id', fltTdId]);\n filtersRow.appendChild(cl);\n tf.externalFltTgtIds[j] = fltTdId;\n }\n }\n return filtersRow;\n }\n\n /**\n * Generates column elements if necessary and assigns their widths\n * @private\n */\n setColumnElements() {\n let tf = this.tf;\n let cols = tag(tf.tbl, 'col');\n this.tblHasColTag = cols.length > 0;\n\n for (let k = (tf.nbCells - 1); k >= 0; k--) {\n let col;\n let id = `${tf.id}_col_${k}`;\n\n if (!this.tblHasColTag) {\n col = createElm('col', ['id', id]);\n tf.tbl.insertBefore(col, tf.tbl.firstChild);\n } else {\n col = cols[k];\n col.setAttribute('id', id);\n }\n col.style.width = tf.colWidths[k];\n this.colElms[k] = col;\n }\n this.tblHasColTag = true;\n }\n\n /**\n * Sets headers row in headers table\n * @param {HTMLHeadElement} tableHead Table head element\n * @private\n */\n setHeadersRow(tableHead) {\n if (this.noHeaders) {\n // Handle table with no headers, assuming here headers do not\n // exist\n tableHead.appendChild(createElm('tr'));\n } else {\n // Headers row are moved from content table to headers table\n for (let i = 0; i < this.headRows.length; i++) {\n let row = this.tf.tbl.rows[this.headRows[i]];\n tableHead.appendChild(row);\n }\n }\n }\n\n /**\n * Sets width defined in configuration to passed element\n * @param {DOMElement} element DOM element\n * @private\n */\n setConfigWidth(element) {\n if (!this.width) {\n return;\n }\n if (this.width.indexOf('%') !== -1) {\n element.style.width = '100%';\n } else {\n element.style.width = this.width;\n }\n }\n\n /**\n * Returns a list of header IDs used for specifing external sort triggers\n * @param {HTMLTableRowElement} row DOM row element\n * @returns {Array} List of IDs\n * @private\n */\n getSortTriggerIds(row) {\n let tf = this.tf;\n let sortTriggers = [];\n for (let n = 0; n < tf.getCellsNb(); n++) {\n let c = row.cells[n];\n let thId = c.getAttribute('id');\n if (!thId || thId === '') {\n thId = this.prfxGridTh + n + '_' + tf.id;\n c.setAttribute('id', thId);\n }\n sortTriggers.push(thId);\n }\n return sortTriggers;\n }\n\n /**\n * Removes the grid layout\n */\n destroy() {\n let tf = this.tf;\n let tbl = tf.tbl;\n\n if (!this.initialized) {\n return;\n }\n let t = removeElm(tbl);\n this.tblMainCont.parentNode.insertBefore(t, this.tblMainCont);\n removeElm(this.tblMainCont);\n\n this.tblMainCont = null;\n this.headTblCont = null;\n this.headTbl = null;\n this.tblCont = null;\n\n tbl.outerHTML = this.sourceTblHtml;\n //needed to keep reference of table element for future usage\n this.tf.tbl = elm(tf.id);\n\n this.initialized = false;\n }\n}\n"
},
{
"__docId__": 345,
@@ -7542,7 +7542,7 @@
{
"nullable": null,
"types": [
- "Object"
+ "TableFilter"
],
"spread": false,
"optional": false,
@@ -8891,7 +8891,7 @@
"access": null,
"description": null,
"lineNumber": 1,
- "content": "import {Feature} from '../feature';\nimport {createElm, createText, elm, removeElm} from '../dom';\nimport {addEvt} from '../event';\nimport {NONE} from '../const';\n\nconst WIKI_URL = 'https://github.com/koalyptus/TableFilter/wiki/' +\n '4.-Filter-operators';\nconst WEBSITE_URL = 'http://koalyptus.github.io/TableFilter/';\n\n/**\n * Help UI component\n */\nexport class Help extends Feature {\n\n /**\n * Creates an instance of Help.\n * @param {TableFilter} tf TableFilter instance\n */\n constructor(tf) {\n super(tf, 'help');\n\n var f = this.config;\n\n /**\n * ID of main custom container element\n * @type {String}\n */\n this.tgtId = f.help_instructions_target_id || null;\n\n /**\n * ID of custom container element for instructions\n * @type {String}\n */\n this.contTgtId = f.help_instructions_container_target_id ||\n null;\n\n /**\n * Instructions text (accepts HTML)\n * @type {String}\n */\n this.instrText = f.help_instructions_text ?\n f.help_instructions_text :\n 'Use the filters above each column to filter and limit table ' +\n 'data. Advanced searches can be performed by using the following ' +\n 'operators:
<,
<=,
>, ' +\n '
>=,
=,
*,
!,
{,
}, ' +\n '
||,
&&,
[empty],
[nonempty], ' +\n '
rgx:' +\n 'Learn more
';\n\n /**\n * Instructions HTML\n * @type {String}\n */\n this.instrHtml = f.help_instructions_html || null;\n\n /**\n * Help button text ('?')\n * @type {String}\n */\n this.btnText = f.help_instructions_btn_text || '?';\n\n /**\n * Custom help button HTML\n * @type {String}\n */\n this.btnHtml = f.help_instructions_btn_html || null;\n\n /**\n * Css class for help button\n * @type {String}\n */\n this.btnCssClass = f.help_instructions_btn_css_class || 'helpBtn';\n\n /**\n * Css class for help container element\n * @type {String}\n */\n this.contCssClass = f.help_instructions_container_css_class ||\n 'helpCont';\n\n /**\n * Stores button DOM element\n * @type {DOMElement}\n */\n this.btn = null;\n\n /**\n * Stores help container DOM element\n * @type {DOMElement}\n */\n this.cont = null;\n\n /**\n * Default HTML appended to instructions text\n * @type {String}\n */\n this.defaultHtml = '';\n\n /**\n * Prefix for help main container ID\n * @type {String}\n * @private\n */\n this.prfxHelpSpan = 'helpSpan_';\n\n /**\n * Prefix for help instructions container ID\n * @type {String}\n * @private\n */\n this.prfxHelpDiv = 'helpDiv_';\n\n this.emitter.on(['init-help'], () => this.init());\n }\n\n /**\n * Initialise Help instance\n * @returns (description)\n */\n init() {\n if (this.initialized) {\n return;\n }\n\n var tf = this.tf;\n\n var helpspan = createElm('span', ['id', this.prfxHelpSpan + tf.id]);\n var helpdiv = createElm('div', ['id', this.prfxHelpDiv + tf.id]);\n\n //help button is added to defined element\n if (!this.tgtId) {\n tf.setToolbar();\n }\n var targetEl = !this.tgtId ? tf.rDiv : elm(this.tgtId);\n targetEl.appendChild(helpspan);\n\n var divContainer = !this.contTgtId ? helpspan : elm(this.contTgtId);\n\n if (!this.btnHtml) {\n divContainer.appendChild(helpdiv);\n var helplink = createElm('a', ['href', 'javascript:void(0);']);\n helplink.className = this.btnCssClass;\n helplink.appendChild(createText(this.btnText));\n helpspan.appendChild(helplink);\n addEvt(helplink, 'click', () => this.toggle());\n } else {\n helpspan.innerHTML = this.btnHtml;\n var helpEl = helpspan.firstChild;\n addEvt(helpEl, 'click', () => this.toggle());\n divContainer.appendChild(helpdiv);\n }\n\n if (!this.instrHtml) {\n helpdiv.innerHTML = this.instrText;\n helpdiv.className = this.contCssClass;\n addEvt(helpdiv, 'dblclick', () => this.toggle());\n } else {\n if (this.contTgtId) {\n divContainer.appendChild(helpdiv);\n }\n helpdiv.innerHTML = this.instrHtml;\n if (!this.contTgtId) {\n helpdiv.className = this.contCssClass;\n addEvt(helpdiv, 'dblclick', () => this.toggle());\n }\n }\n helpdiv.innerHTML += this.defaultHtml;\n addEvt(helpdiv, 'click', () => this.toggle());\n\n this.cont = helpdiv;\n this.btn = helpspan;\n /**\n * @inherited\n */\n this.initialized = true;\n }\n\n /**\n * Toggle help pop-up\n */\n toggle() {\n // check only if explicitily set to false as in this case undefined\n // signifies the help feature is enabled by default\n if (this.enabled === false) {\n return;\n }\n var divDisplay = this.cont.style.display;\n if (divDisplay === '' || divDisplay === NONE) {\n this.cont.style.display = 'inline';\n } else {\n this.cont.style.display = NONE;\n }\n }\n\n /**\n * Remove help UI\n */\n destroy() {\n if (!this.initialized) {\n return;\n }\n removeElm(this.btn);\n this.btn = null;\n if (!this.cont) {\n return;\n }\n removeElm(this.cont);\n this.cont = null;\n this.initialized = false;\n }\n\n}\n"
+ "content": "import {Feature} from '../feature';\nimport {createElm, createText, elm, removeElm} from '../dom';\nimport {addEvt} from '../event';\nimport {NONE} from '../const';\n\nconst WIKI_URL = 'https://github.com/koalyptus/TableFilter/wiki/' +\n '4.-Filter-operators';\nconst WEBSITE_URL = 'http://koalyptus.github.io/TableFilter/';\n\n/**\n * Help UI component\n */\nexport class Help extends Feature {\n\n /**\n * Creates an instance of Help.\n * @param {TableFilter} tf TableFilter instance\n */\n constructor(tf) {\n super(tf, 'help');\n\n var f = this.config;\n\n /**\n * ID of main custom container element\n * @type {String}\n */\n this.tgtId = f.help_instructions_target_id || null;\n\n /**\n * ID of custom container element for instructions\n * @type {String}\n */\n this.contTgtId = f.help_instructions_container_target_id ||\n null;\n\n /**\n * Instructions text (accepts HTML)\n * @type {String}\n */\n this.instrText = f.help_instructions_text ?\n f.help_instructions_text :\n 'Use the filters above each column to filter and limit table ' +\n 'data. Advanced searches can be performed by using the following ' +\n 'operators:
<,
<=,
>, ' +\n '
>=,
=,
*,
!,
{,
}, ' +\n '
||,
&&,
[empty],
[nonempty], ' +\n '
rgx:' +\n 'Learn more
';\n\n /**\n * Instructions HTML\n * @type {String}\n */\n this.instrHtml = f.help_instructions_html || null;\n\n /**\n * Help button text ('?')\n * @type {String}\n */\n this.btnText = f.help_instructions_btn_text || '?';\n\n /**\n * Custom help button HTML\n * @type {String}\n */\n this.btnHtml = f.help_instructions_btn_html || null;\n\n /**\n * Css class for help button\n * @type {String}\n */\n this.btnCssClass = f.help_instructions_btn_css_class || 'helpBtn';\n\n /**\n * Css class for help container element\n * @type {String}\n */\n this.contCssClass = f.help_instructions_container_css_class ||\n 'helpCont';\n\n /**\n * Stores button DOM element\n * @type {DOMElement}\n */\n this.btn = null;\n\n /**\n * Stores help container DOM element\n * @type {DOMElement}\n */\n this.cont = null;\n\n /**\n * Default HTML appended to instructions text\n * @type {String}\n */\n this.defaultHtml = '';\n\n /**\n * Prefix for help main container ID\n * @type {String}\n * @private\n */\n this.prfxHelpSpan = 'helpSpan_';\n\n /**\n * Prefix for help instructions container ID\n * @type {String}\n * @private\n */\n this.prfxHelpDiv = 'helpDiv_';\n\n this.emitter.on(['init-help'], () => this.init());\n }\n\n /**\n * Initialise Help instance\n */\n init() {\n if (this.initialized) {\n return;\n }\n\n var tf = this.tf;\n\n var helpspan = createElm('span', ['id', this.prfxHelpSpan + tf.id]);\n var helpdiv = createElm('div', ['id', this.prfxHelpDiv + tf.id]);\n\n //help button is added to defined element\n if (!this.tgtId) {\n tf.setToolbar();\n }\n var targetEl = !this.tgtId ? tf.rDiv : elm(this.tgtId);\n targetEl.appendChild(helpspan);\n\n var divContainer = !this.contTgtId ? helpspan : elm(this.contTgtId);\n\n if (!this.btnHtml) {\n divContainer.appendChild(helpdiv);\n var helplink = createElm('a', ['href', 'javascript:void(0);']);\n helplink.className = this.btnCssClass;\n helplink.appendChild(createText(this.btnText));\n helpspan.appendChild(helplink);\n addEvt(helplink, 'click', () => this.toggle());\n } else {\n helpspan.innerHTML = this.btnHtml;\n var helpEl = helpspan.firstChild;\n addEvt(helpEl, 'click', () => this.toggle());\n divContainer.appendChild(helpdiv);\n }\n\n if (!this.instrHtml) {\n helpdiv.innerHTML = this.instrText;\n helpdiv.className = this.contCssClass;\n addEvt(helpdiv, 'dblclick', () => this.toggle());\n } else {\n if (this.contTgtId) {\n divContainer.appendChild(helpdiv);\n }\n helpdiv.innerHTML = this.instrHtml;\n if (!this.contTgtId) {\n helpdiv.className = this.contCssClass;\n addEvt(helpdiv, 'dblclick', () => this.toggle());\n }\n }\n helpdiv.innerHTML += this.defaultHtml;\n addEvt(helpdiv, 'click', () => this.toggle());\n\n this.cont = helpdiv;\n this.btn = helpspan;\n /**\n * @inherited\n */\n this.initialized = true;\n }\n\n /**\n * Toggle help pop-up\n */\n toggle() {\n // check only if explicitily set to false as in this case undefined\n // signifies the help feature is enabled by default\n if (this.enabled === false) {\n return;\n }\n var divDisplay = this.cont.style.display;\n if (divDisplay === '' || divDisplay === NONE) {\n this.cont.style.display = 'inline';\n } else {\n this.cont.style.display = NONE;\n }\n }\n\n /**\n * Remove help UI\n */\n destroy() {\n if (!this.initialized) {\n return;\n }\n removeElm(this.btn);\n this.btn = null;\n if (!this.cont) {\n return;\n }\n removeElm(this.cont);\n this.cont = null;\n this.initialized = false;\n }\n\n}\n"
},
{
"__docId__": 413,
@@ -9249,22 +9249,8 @@
"longname": "src/modules/help.js~Help#init",
"access": null,
"description": "Initialise Help instance",
- "lineNumber": 126,
- "unknown": [
- {
- "tagName": "@returns",
- "tagValue": "(description)"
- }
- ],
+ "lineNumber": 125,
"params": [],
- "return": {
- "nullable": null,
- "types": [
- "*"
- ],
- "spread": false,
- "description": "(description)"
- },
"generator": false
},
{
@@ -9277,7 +9263,7 @@
"longname": "src/modules/help.js~Help#cont",
"access": null,
"description": null,
- "lineNumber": 176,
+ "lineNumber": 175,
"undocument": true,
"type": {
"types": [
@@ -9295,7 +9281,7 @@
"longname": "src/modules/help.js~Help#btn",
"access": null,
"description": null,
- "lineNumber": 177,
+ "lineNumber": 176,
"undocument": true,
"type": {
"types": [
@@ -9313,7 +9299,7 @@
"longname": "src/modules/help.js~Help#initialized",
"access": null,
"description": "",
- "lineNumber": 181,
+ "lineNumber": 180,
"unknown": [
{
"tagName": "@inherited",
@@ -9336,7 +9322,7 @@
"longname": "src/modules/help.js~Help#toggle",
"access": null,
"description": "Toggle help pop-up",
- "lineNumber": 187,
+ "lineNumber": 186,
"params": [],
"generator": false
},
@@ -9350,7 +9336,7 @@
"longname": "src/modules/help.js~Help#destroy",
"access": null,
"description": "Remove help UI",
- "lineNumber": 204,
+ "lineNumber": 203,
"params": [],
"generator": false
},
@@ -9364,7 +9350,7 @@
"longname": "src/modules/help.js~Help#btn",
"access": null,
"description": null,
- "lineNumber": 209,
+ "lineNumber": 208,
"undocument": true,
"type": {
"types": [
@@ -9382,7 +9368,7 @@
"longname": "src/modules/help.js~Help#cont",
"access": null,
"description": null,
- "lineNumber": 214,
+ "lineNumber": 213,
"undocument": true,
"type": {
"types": [
@@ -9400,7 +9386,7 @@
"longname": "src/modules/help.js~Help#initialized",
"access": null,
"description": null,
- "lineNumber": 215,
+ "lineNumber": 214,
"undocument": true,
"type": {
"types": [
@@ -9419,7 +9405,7 @@
"access": null,
"description": null,
"lineNumber": 1,
- "content": "import {createText, createElm, getText} from '../dom';\nimport {isArray} from '../types';\n\nexport class HighlightKeyword {\n\n /**\n * HighlightKeyword, highlight matched keyword\n * @param {Object} tf TableFilter instance\n */\n constructor(tf) {\n let f = tf.config();\n //defines css class for highlighting\n this.highlightCssClass = f.highlight_css_class || 'keyword';\n\n this.tf = tf;\n this.emitter = tf.emitter;\n }\n\n init() {\n this.emitter.on(\n ['before-filtering', 'destroy'],\n () => this.unhighlightAll()\n );\n this.emitter.on(\n ['highlight-keyword'],\n (tf, cell, word) =>\n this.highlight(cell, word, this.highlightCssClass)\n );\n }\n\n /**\n * highlight occurences of searched term in passed node\n * @param {Node} node\n * @param {String} word Searched term\n * @param {String} cssClass Css class name\n *\n * TODO: refactor this method\n */\n highlight(node, word, cssClass) {\n // Iterate into this nodes childNodes\n if (node.hasChildNodes) {\n let children = node.childNodes;\n for (let i = 0; i < children.length; i++) {\n this.highlight(children[i], word, cssClass);\n }\n }\n\n if (node.nodeType === 3) {\n let tempNodeVal = node.nodeValue.toLowerCase();\n let tempWordVal = word.toLowerCase();\n if (tempNodeVal.indexOf(tempWordVal) !== -1) {\n let pn = node.parentNode;\n if (pn && pn.className !== cssClass) {\n // word not highlighted yet\n let nv = node.nodeValue,\n ni = tempNodeVal.indexOf(tempWordVal),\n // Create a load of replacement nodes\n before = createText(nv.substr(0, ni)),\n docWordVal = nv.substr(ni, word.length),\n after = createText(nv.substr(ni + word.length)),\n hiwordtext = createText(docWordVal),\n hiword = createElm('span');\n hiword.className = cssClass;\n hiword.appendChild(hiwordtext);\n pn.insertBefore(before, node);\n pn.insertBefore(hiword, node);\n pn.insertBefore(after, node);\n pn.removeChild(node);\n }\n }\n }\n }\n\n /**\n * Removes highlight to nodes matching passed string\n * @param {String} word\n * @param {String} cssClass Css class to remove\n */\n unhighlight(word, cssClass) {\n let highlightedNodes = this.tf.tbl.querySelectorAll(`.${cssClass}`);\n for (let i = 0; i < highlightedNodes.length; i++) {\n let n = highlightedNodes[i];\n let nodeVal = getText(n),\n tempNodeVal = nodeVal.toLowerCase(),\n tempWordVal = word.toLowerCase();\n\n if (tempNodeVal.indexOf(tempWordVal) !== -1) {\n n.parentNode.replaceChild(createText(nodeVal), n);\n }\n }\n }\n\n /**\n * Clear all occurrences of highlighted nodes\n */\n unhighlightAll() {\n if (!this.tf.highlightKeywords) {\n return;\n }\n // iterate filters values to unhighlight all values\n this.tf.getFiltersValue().forEach((val) => {\n if (isArray(val)) {\n val.forEach((item) =>\n this.unhighlight(item, this.highlightCssClass));\n } else {\n this.unhighlight(val, this.highlightCssClass);\n }\n });\n }\n\n destroy() {\n this.emitter.off(\n ['before-filtering', 'destroy'],\n () => this.unhighlightAll()\n );\n this.emitter.off(\n ['highlight-keyword'],\n (tf, cell, word) =>\n this.highlight(cell, word, this.highlightCssClass)\n );\n }\n}\n"
+ "content": "import {createText, createElm, getText} from '../dom';\nimport {isArray} from '../types';\n\n/**\n * Highlight matched keywords upon filtering\n *\n * @export\n * @class HighlightKeyword\n */\nexport class HighlightKeyword {\n\n /**\n * Creates an instance of HighlightKeyword\n * @param {TableFilter} tf TableFilter instance\n */\n constructor(tf) {\n let f = tf.config();\n\n /**\n * Css class for highlighted term\n * @type {String}\n */\n this.highlightCssClass = f.highlight_css_class || 'keyword';\n\n /**\n * TableFilter instance\n * @type {TableFilter}\n */\n this.tf = tf;\n\n /**\n * TableFilter's emitter instance\n * @type {Emitter}\n */\n this.emitter = tf.emitter;\n }\n\n /**\n * Initializes HighlightKeyword instance\n */\n init() {\n this.emitter.on(\n ['before-filtering', 'destroy'],\n () => this.unhighlightAll()\n );\n this.emitter.on(\n ['highlight-keyword'],\n (tf, cell, word) =>\n this.highlight(cell, word, this.highlightCssClass)\n );\n }\n\n /**\n * Highlight occurences of searched term in passed node\n * @param {Node} node\n * @param {String} word Searched term\n * @param {String} cssClass Css class name\n *\n * TODO: refactor this method\n */\n highlight(node, word, cssClass) {\n // Iterate into this nodes childNodes\n if (node.hasChildNodes) {\n let children = node.childNodes;\n for (let i = 0; i < children.length; i++) {\n this.highlight(children[i], word, cssClass);\n }\n }\n\n if (node.nodeType === 3) {\n let tempNodeVal = node.nodeValue.toLowerCase();\n let tempWordVal = word.toLowerCase();\n if (tempNodeVal.indexOf(tempWordVal) !== -1) {\n let pn = node.parentNode;\n if (pn && pn.className !== cssClass) {\n // word not highlighted yet\n let nv = node.nodeValue,\n ni = tempNodeVal.indexOf(tempWordVal),\n // Create a load of replacement nodes\n before = createText(nv.substr(0, ni)),\n docWordVal = nv.substr(ni, word.length),\n after = createText(nv.substr(ni + word.length)),\n hiwordtext = createText(docWordVal),\n hiword = createElm('span');\n hiword.className = cssClass;\n hiword.appendChild(hiwordtext);\n pn.insertBefore(before, node);\n pn.insertBefore(hiword, node);\n pn.insertBefore(after, node);\n pn.removeChild(node);\n }\n }\n }\n }\n\n /**\n * Removes highlight to nodes matching passed string\n * @param {String} word\n * @param {String} cssClass Css class to remove\n */\n unhighlight(word, cssClass) {\n let highlightedNodes = this.tf.tbl.querySelectorAll(`.${cssClass}`);\n for (let i = 0; i < highlightedNodes.length; i++) {\n let n = highlightedNodes[i];\n let nodeVal = getText(n),\n tempNodeVal = nodeVal.toLowerCase(),\n tempWordVal = word.toLowerCase();\n\n if (tempNodeVal.indexOf(tempWordVal) !== -1) {\n n.parentNode.replaceChild(createText(nodeVal), n);\n }\n }\n }\n\n /**\n * Clear all occurrences of highlighted nodes\n */\n unhighlightAll() {\n if (!this.tf.highlightKeywords) {\n return;\n }\n // iterate filters values to unhighlight all values\n this.tf.getFiltersValue().forEach((val) => {\n if (isArray(val)) {\n val.forEach((item) =>\n this.unhighlight(item, this.highlightCssClass));\n } else {\n this.unhighlight(val, this.highlightCssClass);\n }\n });\n }\n\n /**\n * Remove feature\n */\n destroy() {\n this.emitter.off(\n ['before-filtering', 'destroy'],\n () => this.unhighlightAll()\n );\n this.emitter.off(\n ['highlight-keyword'],\n (tf, cell, word) =>\n this.highlight(cell, word, this.highlightCssClass)\n );\n }\n}\n"
},
{
"__docId__": 440,
@@ -9433,9 +9419,18 @@
"export": true,
"importPath": "tablefilter/src/modules/highlightKeywords.js",
"importStyle": "{HighlightKeyword}",
- "description": null,
- "lineNumber": 4,
- "undocument": true,
+ "description": "Highlight matched keywords upon filtering",
+ "lineNumber": 10,
+ "unknown": [
+ {
+ "tagName": "@export",
+ "tagValue": ""
+ },
+ {
+ "tagName": "@class",
+ "tagValue": "HighlightKeyword"
+ }
+ ],
"interface": false
},
{
@@ -9447,13 +9442,13 @@
"memberof": "src/modules/highlightKeywords.js~HighlightKeyword",
"longname": "src/modules/highlightKeywords.js~HighlightKeyword#constructor",
"access": null,
- "description": "HighlightKeyword, highlight matched keyword",
- "lineNumber": 10,
+ "description": "Creates an instance of HighlightKeyword",
+ "lineNumber": 16,
"params": [
{
"nullable": null,
"types": [
- "Object"
+ "TableFilter"
],
"spread": false,
"optional": false,
@@ -9472,13 +9467,15 @@
"memberof": "src/modules/highlightKeywords.js~HighlightKeyword",
"longname": "src/modules/highlightKeywords.js~HighlightKeyword#highlightCssClass",
"access": null,
- "description": null,
- "lineNumber": 13,
- "undocument": true,
+ "description": "Css class for highlighted term",
+ "lineNumber": 23,
"type": {
+ "nullable": null,
"types": [
- "*"
- ]
+ "String"
+ ],
+ "spread": false,
+ "description": null
}
},
{
@@ -9490,13 +9487,15 @@
"memberof": "src/modules/highlightKeywords.js~HighlightKeyword",
"longname": "src/modules/highlightKeywords.js~HighlightKeyword#tf",
"access": null,
- "description": null,
- "lineNumber": 15,
- "undocument": true,
+ "description": "TableFilter instance",
+ "lineNumber": 29,
"type": {
+ "nullable": null,
"types": [
- "*"
- ]
+ "TableFilter"
+ ],
+ "spread": false,
+ "description": null
}
},
{
@@ -9508,13 +9507,15 @@
"memberof": "src/modules/highlightKeywords.js~HighlightKeyword",
"longname": "src/modules/highlightKeywords.js~HighlightKeyword#emitter",
"access": null,
- "description": null,
- "lineNumber": 16,
- "undocument": true,
+ "description": "TableFilter's emitter instance",
+ "lineNumber": 35,
"type": {
+ "nullable": null,
"types": [
- "*"
- ]
+ "Emitter"
+ ],
+ "spread": false,
+ "description": null
}
},
{
@@ -9526,9 +9527,8 @@
"memberof": "src/modules/highlightKeywords.js~HighlightKeyword",
"longname": "src/modules/highlightKeywords.js~HighlightKeyword#init",
"access": null,
- "description": null,
- "lineNumber": 19,
- "undocument": true,
+ "description": "Initializes HighlightKeyword instance",
+ "lineNumber": 41,
"params": [],
"generator": false
},
@@ -9541,8 +9541,8 @@
"memberof": "src/modules/highlightKeywords.js~HighlightKeyword",
"longname": "src/modules/highlightKeywords.js~HighlightKeyword#highlight",
"access": null,
- "description": "highlight occurences of searched term in passed node",
- "lineNumber": 39,
+ "description": "Highlight occurences of searched term in passed node",
+ "lineNumber": 61,
"params": [
{
"nullable": null,
@@ -9587,7 +9587,7 @@
"longname": "src/modules/highlightKeywords.js~HighlightKeyword#unhighlight",
"access": null,
"description": "Removes highlight to nodes matching passed string",
- "lineNumber": 79,
+ "lineNumber": 101,
"params": [
{
"nullable": null,
@@ -9622,7 +9622,7 @@
"longname": "src/modules/highlightKeywords.js~HighlightKeyword#unhighlightAll",
"access": null,
"description": "Clear all occurrences of highlighted nodes",
- "lineNumber": 96,
+ "lineNumber": 118,
"params": [],
"generator": false
},
@@ -9635,9 +9635,8 @@
"memberof": "src/modules/highlightKeywords.js~HighlightKeyword",
"longname": "src/modules/highlightKeywords.js~HighlightKeyword#destroy",
"access": null,
- "description": null,
- "lineNumber": 111,
- "undocument": true,
+ "description": "Remove feature",
+ "lineNumber": 136,
"params": [],
"generator": false
},
@@ -9652,7 +9651,7 @@
"access": null,
"description": null,
"lineNumber": 1,
- "content": "import {Feature} from '../feature';\nimport {createElm, createText, elm, removeElm} from '../dom';\nimport {isFn} from '../types';\nimport {root} from '../root';\nimport {NONE} from '../const';\n\nexport class Loader extends Feature {\n\n /**\n * Loading message/spinner\n * @param {Object} tf TableFilter instance\n */\n constructor(tf) {\n super(tf, 'loader');\n\n // TableFilter configuration\n let f = this.config;\n\n //id of container element\n this.loaderTgtId = f.loader_target_id || null;\n //div containing loader\n this.loaderDiv = null;\n //defines loader text\n this.loaderText = f.loader_text || 'Loading...';\n //defines loader innerHtml\n this.loaderHtml = f.loader_html || null;\n //defines css class for loader div\n this.loaderCssClass = f.loader_css_class || 'loader';\n //delay for hiding loader\n this.loaderCloseDelay = 250;\n //callback function before loader is displayed\n this.onShowLoader = isFn(f.on_show_loader) ? f.on_show_loader : null;\n //callback function after loader is closed\n this.onHideLoader = isFn(f.on_hide_loader) ? f.on_hide_loader : null;\n //loader div\n this.prfxLoader = 'load_';\n }\n\n init() {\n if (this.initialized) {\n return;\n }\n\n let tf = this.tf;\n let emitter = this.emitter;\n\n let containerDiv = createElm('div', ['id', this.prfxLoader + tf.id]);\n containerDiv.className = this.loaderCssClass;\n\n let targetEl = !this.loaderTgtId ?\n tf.tbl.parentNode : elm(this.loaderTgtId);\n if (!this.loaderTgtId) {\n targetEl.insertBefore(containerDiv, tf.tbl);\n } else {\n targetEl.appendChild(containerDiv);\n }\n this.loaderDiv = containerDiv;\n if (!this.loaderHtml) {\n this.loaderDiv.appendChild(createText(this.loaderText));\n } else {\n this.loaderDiv.innerHTML = this.loaderHtml;\n }\n\n this.show(NONE);\n\n // Subscribe to events\n emitter.on([\n 'before-filtering',\n 'before-populating-filter',\n 'before-page-change',\n 'before-clearing-filters',\n 'before-page-length-change',\n 'before-reset-page',\n 'before-reset-page-length',\n 'before-loading-extensions',\n 'before-loading-themes'],\n () => this.show('')\n );\n emitter.on([\n 'after-filtering',\n 'after-populating-filter',\n 'after-page-change',\n 'after-clearing-filters',\n 'after-page-length-change',\n 'after-reset-page',\n 'after-reset-page-length',\n 'after-loading-extensions',\n 'after-loading-themes'],\n () => this.show(NONE)\n );\n\n this.initialized = true;\n }\n\n show(p) {\n if (!this.isEnabled()) {\n return;\n }\n\n let displayLoader = () => {\n if (!this.loaderDiv) {\n return;\n }\n if (this.onShowLoader && p !== NONE) {\n this.onShowLoader.call(null, this);\n }\n this.loaderDiv.style.display = p;\n if (this.onHideLoader && p === NONE) {\n this.onHideLoader.call(null, this);\n }\n };\n\n let t = p === NONE ? this.loaderCloseDelay : 1;\n root.setTimeout(displayLoader, t);\n }\n\n destroy() {\n if (!this.initialized) {\n return;\n }\n\n let emitter = this.emitter;\n\n removeElm(this.loaderDiv);\n this.loaderDiv = null;\n\n // Unsubscribe to events\n emitter.off([\n 'before-filtering',\n 'before-populating-filter',\n 'before-page-change',\n 'before-clearing-filters',\n 'before-page-length-change',\n 'before-reset-page',\n 'before-reset-page-length',\n 'before-loading-extensions',\n 'before-loading-themes'],\n () => this.show('')\n );\n emitter.off([\n 'after-filtering',\n 'after-populating-filter',\n 'after-page-change',\n 'after-clearing-filters',\n 'after-page-length-change',\n 'after-reset-page',\n 'after-reset-page-length',\n 'after-loading-extensions',\n 'after-loading-themes'],\n () => this.show(NONE)\n );\n\n this.initialized = false;\n }\n}\n"
+ "content": "import {Feature} from '../feature';\nimport {createElm, createText, elm, removeElm} from '../dom';\nimport {isFn} from '../types';\nimport {root} from '../root';\nimport {NONE} from '../const';\n\n/**\n * Activity indicator\n *\n * @export\n * @class Loader\n * @extends {Feature}\n */\nexport class Loader extends Feature {\n\n /**\n * Creates an instance of Loader.\n *\n * @param {TableFilter} tf TableFilter instance\n */\n constructor(tf) {\n super(tf, 'loader');\n\n let f = this.config;\n\n /**\n * ID of custom container element\n * @type {String}\n */\n this.targetId = f.loader_target_id || null;\n\n /**\n * Loader container DOM element\n * @type {DOMElement}\n */\n this.cont = null;\n\n /**\n * Text displayed when indicator is visible\n * @type {String}\n */\n this.text = f.loader_text || 'Loading...';\n\n /**\n * Custom HTML injected in Loader's container element\n * @type {String}\n */\n this.html = f.loader_html || null;\n\n /**\n * Css class for Loader's container element\n * @type {String}\n */\n this.cssClass = f.loader_css_class || 'loader';\n\n /**\n * Close delay in milliseconds\n * @type {Number}\n */\n this.closeDelay = 250;\n\n /**\n * Callback fired when loader is displayed\n * @type {Function}\n */\n this.onShow = isFn(f.on_show_loader) ? f.on_show_loader : null;\n\n /**\n * Callback fired when loader is closed\n * @type {Function}\n */\n this.onHide = isFn(f.on_hide_loader) ? f.on_hide_loader : null;\n\n /**\n * Prefix for container ID\n * @type {String}\n * @private\n */\n this.prfx = 'load_';\n }\n\n /**\n * Initializes Loader instance\n */\n init() {\n if (this.initialized) {\n return;\n }\n\n let tf = this.tf;\n let emitter = this.emitter;\n\n let containerDiv = createElm('div', ['id', this.prfx + tf.id]);\n containerDiv.className = this.cssClass;\n\n let targetEl = !this.targetId ?\n tf.tbl.parentNode : elm(this.targetId);\n if (!this.targetId) {\n targetEl.insertBefore(containerDiv, tf.tbl);\n } else {\n targetEl.appendChild(containerDiv);\n }\n this.cont = containerDiv;\n if (!this.html) {\n this.cont.appendChild(createText(this.text));\n } else {\n this.cont.innerHTML = this.html;\n }\n\n this.show(NONE);\n\n // Subscribe to events\n emitter.on([\n 'before-filtering',\n 'before-populating-filter',\n 'before-page-change',\n 'before-clearing-filters',\n 'before-page-length-change',\n 'before-reset-page',\n 'before-reset-page-length',\n 'before-loading-extensions',\n 'before-loading-themes'],\n () => this.show('')\n );\n emitter.on([\n 'after-filtering',\n 'after-populating-filter',\n 'after-page-change',\n 'after-clearing-filters',\n 'after-page-length-change',\n 'after-reset-page',\n 'after-reset-page-length',\n 'after-loading-extensions',\n 'after-loading-themes'],\n () => this.show(NONE)\n );\n\n this.initialized = true;\n }\n\n /**\n * Shows or hides activity indicator\n * @param {String} Two possible values: '' or 'none'\n */\n show(p) {\n if (!this.isEnabled()) {\n return;\n }\n\n let displayLoader = () => {\n if (!this.cont) {\n return;\n }\n if (this.onShow && p !== NONE) {\n this.onShow.call(null, this);\n }\n this.cont.style.display = p;\n if (this.onHide && p === NONE) {\n this.onHide.call(null, this);\n }\n };\n\n let t = p === NONE ? this.closeDelay : 1;\n root.setTimeout(displayLoader, t);\n }\n\n /**\n * Removes feature\n */\n destroy() {\n if (!this.initialized) {\n return;\n }\n\n let emitter = this.emitter;\n\n removeElm(this.cont);\n this.cont = null;\n\n // Unsubscribe to events\n emitter.off([\n 'before-filtering',\n 'before-populating-filter',\n 'before-page-change',\n 'before-clearing-filters',\n 'before-page-length-change',\n 'before-reset-page',\n 'before-reset-page-length',\n 'before-loading-extensions',\n 'before-loading-themes'],\n () => this.show('')\n );\n emitter.off([\n 'after-filtering',\n 'after-populating-filter',\n 'after-page-change',\n 'after-clearing-filters',\n 'after-page-length-change',\n 'after-reset-page',\n 'after-reset-page-length',\n 'after-loading-extensions',\n 'after-loading-themes'],\n () => this.show(NONE)\n );\n\n this.initialized = false;\n }\n}\n"
},
{
"__docId__": 451,
@@ -9666,12 +9665,21 @@
"export": true,
"importPath": "tablefilter/src/modules/loader.js",
"importStyle": "{Loader}",
- "description": null,
- "lineNumber": 7,
- "undocument": true,
+ "description": "Activity indicator",
+ "lineNumber": 14,
+ "unknown": [
+ {
+ "tagName": "@export",
+ "tagValue": ""
+ },
+ {
+ "tagName": "@class",
+ "tagValue": "Loader"
+ }
+ ],
"interface": false,
"extends": [
- "src/feature.js~Feature"
+ "Feature"
]
},
{
@@ -9683,13 +9691,13 @@
"memberof": "src/modules/loader.js~Loader",
"longname": "src/modules/loader.js~Loader#constructor",
"access": null,
- "description": "Loading message/spinner",
- "lineNumber": 13,
+ "description": "Creates an instance of Loader.",
+ "lineNumber": 21,
"params": [
{
"nullable": null,
"types": [
- "Object"
+ "TableFilter"
],
"spread": false,
"optional": false,
@@ -9704,17 +9712,19 @@
"kind": "member",
"static": false,
"variation": null,
- "name": "loaderTgtId",
+ "name": "targetId",
"memberof": "src/modules/loader.js~Loader",
- "longname": "src/modules/loader.js~Loader#loaderTgtId",
+ "longname": "src/modules/loader.js~Loader#targetId",
"access": null,
- "description": null,
- "lineNumber": 20,
- "undocument": true,
+ "description": "ID of custom container element",
+ "lineNumber": 30,
"type": {
+ "nullable": null,
"types": [
- "*"
- ]
+ "String"
+ ],
+ "spread": false,
+ "description": null
}
},
{
@@ -9722,17 +9732,19 @@
"kind": "member",
"static": false,
"variation": null,
- "name": "loaderDiv",
+ "name": "cont",
"memberof": "src/modules/loader.js~Loader",
- "longname": "src/modules/loader.js~Loader#loaderDiv",
+ "longname": "src/modules/loader.js~Loader#cont",
"access": null,
- "description": null,
- "lineNumber": 22,
- "undocument": true,
+ "description": "Loader container DOM element",
+ "lineNumber": 36,
"type": {
+ "nullable": null,
"types": [
- "*"
- ]
+ "DOMElement"
+ ],
+ "spread": false,
+ "description": null
}
},
{
@@ -9740,17 +9752,19 @@
"kind": "member",
"static": false,
"variation": null,
- "name": "loaderText",
+ "name": "text",
"memberof": "src/modules/loader.js~Loader",
- "longname": "src/modules/loader.js~Loader#loaderText",
+ "longname": "src/modules/loader.js~Loader#text",
"access": null,
- "description": null,
- "lineNumber": 24,
- "undocument": true,
+ "description": "Text displayed when indicator is visible",
+ "lineNumber": 42,
"type": {
+ "nullable": null,
"types": [
- "*"
- ]
+ "String"
+ ],
+ "spread": false,
+ "description": null
}
},
{
@@ -9758,17 +9772,19 @@
"kind": "member",
"static": false,
"variation": null,
- "name": "loaderHtml",
+ "name": "html",
"memberof": "src/modules/loader.js~Loader",
- "longname": "src/modules/loader.js~Loader#loaderHtml",
+ "longname": "src/modules/loader.js~Loader#html",
"access": null,
- "description": null,
- "lineNumber": 26,
- "undocument": true,
+ "description": "Custom HTML injected in Loader's container element",
+ "lineNumber": 48,
"type": {
+ "nullable": null,
"types": [
- "*"
- ]
+ "String"
+ ],
+ "spread": false,
+ "description": null
}
},
{
@@ -9776,17 +9792,19 @@
"kind": "member",
"static": false,
"variation": null,
- "name": "loaderCssClass",
+ "name": "cssClass",
"memberof": "src/modules/loader.js~Loader",
- "longname": "src/modules/loader.js~Loader#loaderCssClass",
+ "longname": "src/modules/loader.js~Loader#cssClass",
"access": null,
- "description": null,
- "lineNumber": 28,
- "undocument": true,
+ "description": "Css class for Loader's container element",
+ "lineNumber": 54,
"type": {
+ "nullable": null,
"types": [
- "*"
- ]
+ "String"
+ ],
+ "spread": false,
+ "description": null
}
},
{
@@ -9794,17 +9812,19 @@
"kind": "member",
"static": false,
"variation": null,
- "name": "loaderCloseDelay",
+ "name": "closeDelay",
"memberof": "src/modules/loader.js~Loader",
- "longname": "src/modules/loader.js~Loader#loaderCloseDelay",
+ "longname": "src/modules/loader.js~Loader#closeDelay",
"access": null,
- "description": null,
- "lineNumber": 30,
- "undocument": true,
+ "description": "Close delay in milliseconds",
+ "lineNumber": 60,
"type": {
+ "nullable": null,
"types": [
- "number"
- ]
+ "Number"
+ ],
+ "spread": false,
+ "description": null
}
},
{
@@ -9812,17 +9832,19 @@
"kind": "member",
"static": false,
"variation": null,
- "name": "onShowLoader",
+ "name": "onShow",
"memberof": "src/modules/loader.js~Loader",
- "longname": "src/modules/loader.js~Loader#onShowLoader",
+ "longname": "src/modules/loader.js~Loader#onShow",
"access": null,
- "description": null,
- "lineNumber": 32,
- "undocument": true,
+ "description": "Callback fired when loader is displayed",
+ "lineNumber": 66,
"type": {
+ "nullable": null,
"types": [
- "*"
- ]
+ "Function"
+ ],
+ "spread": false,
+ "description": null
}
},
{
@@ -9830,17 +9852,19 @@
"kind": "member",
"static": false,
"variation": null,
- "name": "onHideLoader",
+ "name": "onHide",
"memberof": "src/modules/loader.js~Loader",
- "longname": "src/modules/loader.js~Loader#onHideLoader",
+ "longname": "src/modules/loader.js~Loader#onHide",
"access": null,
- "description": null,
- "lineNumber": 34,
- "undocument": true,
+ "description": "Callback fired when loader is closed",
+ "lineNumber": 72,
"type": {
+ "nullable": null,
"types": [
- "*"
- ]
+ "Function"
+ ],
+ "spread": false,
+ "description": null
}
},
{
@@ -9848,17 +9872,19 @@
"kind": "member",
"static": false,
"variation": null,
- "name": "prfxLoader",
+ "name": "prfx",
"memberof": "src/modules/loader.js~Loader",
- "longname": "src/modules/loader.js~Loader#prfxLoader",
- "access": null,
- "description": null,
- "lineNumber": 36,
- "undocument": true,
+ "longname": "src/modules/loader.js~Loader#prfx",
+ "access": "private",
+ "description": "Prefix for container ID",
+ "lineNumber": 79,
"type": {
+ "nullable": null,
"types": [
- "string"
- ]
+ "String"
+ ],
+ "spread": false,
+ "description": null
}
},
{
@@ -9870,9 +9896,8 @@
"memberof": "src/modules/loader.js~Loader",
"longname": "src/modules/loader.js~Loader#init",
"access": null,
- "description": null,
- "lineNumber": 39,
- "undocument": true,
+ "description": "Initializes Loader instance",
+ "lineNumber": 85,
"params": [],
"generator": false
},
@@ -9881,12 +9906,12 @@
"kind": "member",
"static": false,
"variation": null,
- "name": "loaderDiv",
+ "name": "cont",
"memberof": "src/modules/loader.js~Loader",
- "longname": "src/modules/loader.js~Loader#loaderDiv",
+ "longname": "src/modules/loader.js~Loader#cont",
"access": null,
"description": null,
- "lineNumber": 57,
+ "lineNumber": 103,
"undocument": true,
"type": {
"types": [
@@ -9904,7 +9929,7 @@
"longname": "src/modules/loader.js~Loader#initialized",
"access": null,
"description": null,
- "lineNumber": 92,
+ "lineNumber": 138,
"undocument": true,
"type": {
"types": [
@@ -9921,15 +9946,18 @@
"memberof": "src/modules/loader.js~Loader",
"longname": "src/modules/loader.js~Loader#show",
"access": null,
- "description": null,
- "lineNumber": 95,
- "undocument": true,
+ "description": "Shows or hides activity indicator",
+ "lineNumber": 145,
"params": [
{
- "name": "p",
+ "nullable": null,
"types": [
- "*"
- ]
+ "String"
+ ],
+ "spread": false,
+ "optional": false,
+ "name": "Two",
+ "description": "possible values: '' or 'none'"
}
],
"generator": false
@@ -9943,9 +9971,8 @@
"memberof": "src/modules/loader.js~Loader",
"longname": "src/modules/loader.js~Loader#destroy",
"access": null,
- "description": null,
- "lineNumber": 117,
- "undocument": true,
+ "description": "Removes feature",
+ "lineNumber": 170,
"params": [],
"generator": false
},
@@ -9954,12 +9981,12 @@
"kind": "member",
"static": false,
"variation": null,
- "name": "loaderDiv",
+ "name": "cont",
"memberof": "src/modules/loader.js~Loader",
- "longname": "src/modules/loader.js~Loader#loaderDiv",
+ "longname": "src/modules/loader.js~Loader#cont",
"access": null,
"description": null,
- "lineNumber": 125,
+ "lineNumber": 178,
"undocument": true,
"type": {
"types": [
@@ -9977,7 +10004,7 @@
"longname": "src/modules/loader.js~Loader#initialized",
"access": null,
"description": null,
- "lineNumber": 153,
+ "lineNumber": 206,
"undocument": true,
"type": {
"types": [
diff --git a/docs/file/src/array.js.html b/docs/file/src/array.js.html
index 8bd34020..d20f8641 100644
--- a/docs/file/src/array.js.html
+++ b/docs/file/src/array.js.html
@@ -3,7 +3,7 @@
-
src/array.js | tablefilter v0.2.45 API Document
+
src/array.js | tablefilter v0.2.46 API Document
diff --git a/docs/file/src/const.js.html b/docs/file/src/const.js.html
index a6e72d61..1118497d 100644
--- a/docs/file/src/const.js.html
+++ b/docs/file/src/const.js.html
@@ -3,7 +3,7 @@
-
src/const.js | tablefilter v0.2.45 API Document
+
src/const.js | tablefilter v0.2.46 API Document
diff --git a/docs/file/src/cookie.js.html b/docs/file/src/cookie.js.html
index c7b8d68c..62d5b710 100644
--- a/docs/file/src/cookie.js.html
+++ b/docs/file/src/cookie.js.html
@@ -3,7 +3,7 @@
-
src/cookie.js | tablefilter v0.2.45 API Document
+
src/cookie.js | tablefilter v0.2.46 API Document
diff --git a/docs/file/src/date.js.html b/docs/file/src/date.js.html
index 7857a9d1..8bc90fd8 100644
--- a/docs/file/src/date.js.html
+++ b/docs/file/src/date.js.html
@@ -3,7 +3,7 @@
-
src/date.js | tablefilter v0.2.45 API Document
+
src/date.js | tablefilter v0.2.46 API Document
diff --git a/docs/file/src/dom.js.html b/docs/file/src/dom.js.html
index ddf8b371..455d1220 100644
--- a/docs/file/src/dom.js.html
+++ b/docs/file/src/dom.js.html
@@ -3,7 +3,7 @@
-
src/dom.js | tablefilter v0.2.45 API Document
+
src/dom.js | tablefilter v0.2.46 API Document
diff --git a/docs/file/src/emitter.js.html b/docs/file/src/emitter.js.html
index 1b48c941..4a8c9a50 100644
--- a/docs/file/src/emitter.js.html
+++ b/docs/file/src/emitter.js.html
@@ -3,7 +3,7 @@
-
src/emitter.js | tablefilter v0.2.45 API Document
+
src/emitter.js | tablefilter v0.2.46 API Document
diff --git a/docs/file/src/event.js.html b/docs/file/src/event.js.html
index bf0a190f..1ac69c83 100644
--- a/docs/file/src/event.js.html
+++ b/docs/file/src/event.js.html
@@ -3,7 +3,7 @@
-
src/event.js | tablefilter v0.2.45 API Document
+
src/event.js | tablefilter v0.2.46 API Document
diff --git a/docs/file/src/extensions/advancedGrid/adapterEzEditTable.js.html b/docs/file/src/extensions/advancedGrid/adapterEzEditTable.js.html
index c7a41208..06526eb0 100644
--- a/docs/file/src/extensions/advancedGrid/adapterEzEditTable.js.html
+++ b/docs/file/src/extensions/advancedGrid/adapterEzEditTable.js.html
@@ -3,7 +3,7 @@
-
src/extensions/advancedGrid/adapterEzEditTable.js | tablefilter v0.2.45 API Document
+
src/extensions/advancedGrid/adapterEzEditTable.js | tablefilter v0.2.46 API Document
diff --git a/docs/file/src/extensions/advancedGrid/advancedGrid.js.html b/docs/file/src/extensions/advancedGrid/advancedGrid.js.html
index 75da0d6d..f75da97e 100644
--- a/docs/file/src/extensions/advancedGrid/advancedGrid.js.html
+++ b/docs/file/src/extensions/advancedGrid/advancedGrid.js.html
@@ -3,7 +3,7 @@
-
src/extensions/advancedGrid/advancedGrid.js | tablefilter v0.2.45 API Document
+
src/extensions/advancedGrid/advancedGrid.js | tablefilter v0.2.46 API Document
diff --git a/docs/file/src/extensions/colOps/colOps.js.html b/docs/file/src/extensions/colOps/colOps.js.html
index c7e1b6d8..12e35f28 100644
--- a/docs/file/src/extensions/colOps/colOps.js.html
+++ b/docs/file/src/extensions/colOps/colOps.js.html
@@ -3,7 +3,7 @@
-
src/extensions/colOps/colOps.js | tablefilter v0.2.45 API Document
+
src/extensions/colOps/colOps.js | tablefilter v0.2.46 API Document
diff --git a/docs/file/src/extensions/colsVisibility/colsVisibility.js.html b/docs/file/src/extensions/colsVisibility/colsVisibility.js.html
index 6fd9a114..53857f4f 100644
--- a/docs/file/src/extensions/colsVisibility/colsVisibility.js.html
+++ b/docs/file/src/extensions/colsVisibility/colsVisibility.js.html
@@ -3,7 +3,7 @@
-
src/extensions/colsVisibility/colsVisibility.js | tablefilter v0.2.45 API Document
+
src/extensions/colsVisibility/colsVisibility.js | tablefilter v0.2.46 API Document
diff --git a/docs/file/src/extensions/filtersVisibility/filtersVisibility.js.html b/docs/file/src/extensions/filtersVisibility/filtersVisibility.js.html
index a38b7807..fcc3f6cd 100644
--- a/docs/file/src/extensions/filtersVisibility/filtersVisibility.js.html
+++ b/docs/file/src/extensions/filtersVisibility/filtersVisibility.js.html
@@ -3,7 +3,7 @@
-
src/extensions/filtersVisibility/filtersVisibility.js | tablefilter v0.2.45 API Document
+
src/extensions/filtersVisibility/filtersVisibility.js | tablefilter v0.2.46 API Document
diff --git a/docs/file/src/extensions/sort/adapterSortabletable.js.html b/docs/file/src/extensions/sort/adapterSortabletable.js.html
index cf9551b7..7cb0c61b 100644
--- a/docs/file/src/extensions/sort/adapterSortabletable.js.html
+++ b/docs/file/src/extensions/sort/adapterSortabletable.js.html
@@ -3,7 +3,7 @@
-
src/extensions/sort/adapterSortabletable.js | tablefilter v0.2.45 API Document
+
src/extensions/sort/adapterSortabletable.js | tablefilter v0.2.46 API Document
diff --git a/docs/file/src/extensions/sort/sort.js.html b/docs/file/src/extensions/sort/sort.js.html
index ecd2a2d2..a1f2df87 100644
--- a/docs/file/src/extensions/sort/sort.js.html
+++ b/docs/file/src/extensions/sort/sort.js.html
@@ -3,7 +3,7 @@
-
src/extensions/sort/sort.js | tablefilter v0.2.45 API Document
+
src/extensions/sort/sort.js | tablefilter v0.2.46 API Document
diff --git a/docs/file/src/feature.js.html b/docs/file/src/feature.js.html
index bdbd68eb..72792ae9 100644
--- a/docs/file/src/feature.js.html
+++ b/docs/file/src/feature.js.html
@@ -3,7 +3,7 @@
-
src/feature.js | tablefilter v0.2.45 API Document
+
src/feature.js | tablefilter v0.2.46 API Document
diff --git a/docs/file/src/helpers.js.html b/docs/file/src/helpers.js.html
index 4991a29a..7a3f3e26 100644
--- a/docs/file/src/helpers.js.html
+++ b/docs/file/src/helpers.js.html
@@ -3,7 +3,7 @@
-
src/helpers.js | tablefilter v0.2.45 API Document
+
src/helpers.js | tablefilter v0.2.46 API Document
diff --git a/docs/file/src/modules/alternateRows.js.html b/docs/file/src/modules/alternateRows.js.html
index 40b3a94b..cce5cffb 100644
--- a/docs/file/src/modules/alternateRows.js.html
+++ b/docs/file/src/modules/alternateRows.js.html
@@ -3,7 +3,7 @@
-
src/modules/alternateRows.js | tablefilter v0.2.45 API Document
+
src/modules/alternateRows.js | tablefilter v0.2.46 API Document
diff --git a/docs/file/src/modules/checkList.js.html b/docs/file/src/modules/checkList.js.html
index e244535e..a901191b 100644
--- a/docs/file/src/modules/checkList.js.html
+++ b/docs/file/src/modules/checkList.js.html
@@ -3,7 +3,7 @@
-
src/modules/checkList.js | tablefilter v0.2.45 API Document
+
src/modules/checkList.js | tablefilter v0.2.46 API Document
diff --git a/docs/file/src/modules/clearButton.js.html b/docs/file/src/modules/clearButton.js.html
index dc679cd4..d3ca3d83 100644
--- a/docs/file/src/modules/clearButton.js.html
+++ b/docs/file/src/modules/clearButton.js.html
@@ -3,7 +3,7 @@
-
src/modules/clearButton.js | tablefilter v0.2.45 API Document
+
src/modules/clearButton.js | tablefilter v0.2.46 API Document
@@ -168,7 +168,7 @@ export class ClearButton extends Feature {
'" ' + 'title="' + this.tooltip + '" />');
/**
- * Prefix fot ID of container element
+ * Prefix for container ID
* @type {String}
* @private
*/
diff --git a/docs/file/src/modules/dropdown.js.html b/docs/file/src/modules/dropdown.js.html
index f9b1be52..c7e4cd8d 100644
--- a/docs/file/src/modules/dropdown.js.html
+++ b/docs/file/src/modules/dropdown.js.html
@@ -3,7 +3,7 @@
-
src/modules/dropdown.js | tablefilter v0.2.45 API Document
+
src/modules/dropdown.js | tablefilter v0.2.46 API Document
diff --git a/docs/file/src/modules/gridLayout.js.html b/docs/file/src/modules/gridLayout.js.html
index 392394d8..7cb5ed2b 100644
--- a/docs/file/src/modules/gridLayout.js.html
+++ b/docs/file/src/modules/gridLayout.js.html
@@ -3,7 +3,7 @@
-
src/modules/gridLayout.js | tablefilter v0.2.45 API Document
+
src/modules/gridLayout.js | tablefilter v0.2.46 API Document
@@ -129,7 +129,7 @@ export class GridLayout extends Feature {
/**
* Creates an instance of GridLayout
- * @param {Object} tf TableFilter instance
+ * @param {TableFilter} tf TableFilter instance
*/
constructor(tf) {
super(tf, 'gridLayout');
diff --git a/docs/file/src/modules/hash.js.html b/docs/file/src/modules/hash.js.html
index fa86d25d..5fe80bc4 100644
--- a/docs/file/src/modules/hash.js.html
+++ b/docs/file/src/modules/hash.js.html
@@ -3,7 +3,7 @@
-
src/modules/hash.js | tablefilter v0.2.45 API Document
+
src/modules/hash.js | tablefilter v0.2.46 API Document
diff --git a/docs/file/src/modules/help.js.html b/docs/file/src/modules/help.js.html
index b209f791..c7d1bd91 100644
--- a/docs/file/src/modules/help.js.html
+++ b/docs/file/src/modules/help.js.html
@@ -3,7 +3,7 @@
-
src/modules/help.js | tablefilter v0.2.45 API Document
+
src/modules/help.js | tablefilter v0.2.46 API Document
@@ -238,7 +238,6 @@ export class Help extends Feature {
/**
* Initialise Help instance
- * @returns (description)
*/
init() {
if (this.initialized) {
diff --git a/docs/file/src/modules/highlightKeywords.js.html b/docs/file/src/modules/highlightKeywords.js.html
index bad32fde..e1db30ca 100644
--- a/docs/file/src/modules/highlightKeywords.js.html
+++ b/docs/file/src/modules/highlightKeywords.js.html
@@ -3,7 +3,7 @@
-
src/modules/highlightKeywords.js | tablefilter v0.2.45 API Document
+
src/modules/highlightKeywords.js | tablefilter v0.2.46 API Document
@@ -118,21 +118,43 @@
import {createText, createElm, getText} from '../dom';
import {isArray} from '../types';
+/**
+ * Highlight matched keywords upon filtering
+ *
+ * @export
+ * @class HighlightKeyword
+ */
export class HighlightKeyword {
/**
- * HighlightKeyword, highlight matched keyword
- * @param {Object} tf TableFilter instance
+ * Creates an instance of HighlightKeyword
+ * @param {TableFilter} tf TableFilter instance
*/
constructor(tf) {
let f = tf.config();
- //defines css class for highlighting
+
+ /**
+ * Css class for highlighted term
+ * @type {String}
+ */
this.highlightCssClass = f.highlight_css_class || 'keyword';
+ /**
+ * TableFilter instance
+ * @type {TableFilter}
+ */
this.tf = tf;
+
+ /**
+ * TableFilter's emitter instance
+ * @type {Emitter}
+ */
this.emitter = tf.emitter;
}
+ /**
+ * Initializes HighlightKeyword instance
+ */
init() {
this.emitter.on(
['before-filtering', 'destroy'],
@@ -146,7 +168,7 @@ export class HighlightKeyword {
}
/**
- * highlight occurences of searched term in passed node
+ * Highlight occurences of searched term in passed node
* @param {Node} node
* @param {String} word Searched term
* @param {String} cssClass Css class name
@@ -225,6 +247,9 @@ export class HighlightKeyword {
});
}
+ /**
+ * Remove feature
+ */
destroy() {
this.emitter.off(
['before-filtering', 'destroy'],
diff --git a/docs/file/src/modules/loader.js.html b/docs/file/src/modules/loader.js.html
index 7633298c..6469d015 100644
--- a/docs/file/src/modules/loader.js.html
+++ b/docs/file/src/modules/loader.js.html
@@ -3,7 +3,7 @@
- src/modules/loader.js | tablefilter v0.2.45 API Document
+ src/modules/loader.js | tablefilter v0.2.46 API Document
@@ -121,38 +121,84 @@ import {isFn} from '../types';
import {root} from '../root';
import {NONE} from '../const';
+/**
+ * Activity indicator
+ *
+ * @export
+ * @class Loader
+ * @extends {Feature}
+ */
export class Loader extends Feature {
/**
- * Loading message/spinner
- * @param {Object} tf TableFilter instance
+ * Creates an instance of Loader.
+ *
+ * @param {TableFilter} tf TableFilter instance
*/
constructor(tf) {
super(tf, 'loader');
- // TableFilter configuration
let f = this.config;
- //id of container element
- this.loaderTgtId = f.loader_target_id || null;
- //div containing loader
- this.loaderDiv = null;
- //defines loader text
- this.loaderText = f.loader_text || 'Loading...';
- //defines loader innerHtml
- this.loaderHtml = f.loader_html || null;
- //defines css class for loader div
- this.loaderCssClass = f.loader_css_class || 'loader';
- //delay for hiding loader
- this.loaderCloseDelay = 250;
- //callback function before loader is displayed
- this.onShowLoader = isFn(f.on_show_loader) ? f.on_show_loader : null;
- //callback function after loader is closed
- this.onHideLoader = isFn(f.on_hide_loader) ? f.on_hide_loader : null;
- //loader div
- this.prfxLoader = 'load_';
+ /**
+ * ID of custom container element
+ * @type {String}
+ */
+ this.targetId = f.loader_target_id || null;
+
+ /**
+ * Loader container DOM element
+ * @type {DOMElement}
+ */
+ this.cont = null;
+
+ /**
+ * Text displayed when indicator is visible
+ * @type {String}
+ */
+ this.text = f.loader_text || 'Loading...';
+
+ /**
+ * Custom HTML injected in Loader's container element
+ * @type {String}
+ */
+ this.html = f.loader_html || null;
+
+ /**
+ * Css class for Loader's container element
+ * @type {String}
+ */
+ this.cssClass = f.loader_css_class || 'loader';
+
+ /**
+ * Close delay in milliseconds
+ * @type {Number}
+ */
+ this.closeDelay = 250;
+
+ /**
+ * Callback fired when loader is displayed
+ * @type {Function}
+ */
+ this.onShow = isFn(f.on_show_loader) ? f.on_show_loader : null;
+
+ /**
+ * Callback fired when loader is closed
+ * @type {Function}
+ */
+ this.onHide = isFn(f.on_hide_loader) ? f.on_hide_loader : null;
+
+ /**
+ * Prefix for container ID
+ * @type {String}
+ * @private
+ */
+ this.prfx = 'load_';
}
+ /**
+ * Initializes Loader instance
+ */
init() {
if (this.initialized) {
return;
@@ -161,21 +207,21 @@ export class Loader extends Feature {
let tf = this.tf;
let emitter = this.emitter;
- let containerDiv = createElm('div', ['id', this.prfxLoader + tf.id]);
- containerDiv.className = this.loaderCssClass;
+ let containerDiv = createElm('div', ['id', this.prfx + tf.id]);
+ containerDiv.className = this.cssClass;
- let targetEl = !this.loaderTgtId ?
- tf.tbl.parentNode : elm(this.loaderTgtId);
- if (!this.loaderTgtId) {
+ let targetEl = !this.targetId ?
+ tf.tbl.parentNode : elm(this.targetId);
+ if (!this.targetId) {
targetEl.insertBefore(containerDiv, tf.tbl);
} else {
targetEl.appendChild(containerDiv);
}
- this.loaderDiv = containerDiv;
- if (!this.loaderHtml) {
- this.loaderDiv.appendChild(createText(this.loaderText));
+ this.cont = containerDiv;
+ if (!this.html) {
+ this.cont.appendChild(createText(this.text));
} else {
- this.loaderDiv.innerHTML = this.loaderHtml;
+ this.cont.innerHTML = this.html;
}
this.show(NONE);
@@ -209,28 +255,35 @@ export class Loader extends Feature {
this.initialized = true;
}
+ /**
+ * Shows or hides activity indicator
+ * @param {String} Two possible values: '' or 'none'
+ */
show(p) {
if (!this.isEnabled()) {
return;
}
let displayLoader = () => {
- if (!this.loaderDiv) {
+ if (!this.cont) {
return;
}
- if (this.onShowLoader && p !== NONE) {
- this.onShowLoader.call(null, this);
+ if (this.onShow && p !== NONE) {
+ this.onShow.call(null, this);
}
- this.loaderDiv.style.display = p;
- if (this.onHideLoader && p === NONE) {
- this.onHideLoader.call(null, this);
+ this.cont.style.display = p;
+ if (this.onHide && p === NONE) {
+ this.onHide.call(null, this);
}
};
- let t = p === NONE ? this.loaderCloseDelay : 1;
+ let t = p === NONE ? this.closeDelay : 1;
root.setTimeout(displayLoader, t);
}
+ /**
+ * Removes feature
+ */
destroy() {
if (!this.initialized) {
return;
@@ -238,8 +291,8 @@ export class Loader extends Feature {
let emitter = this.emitter;
- removeElm(this.loaderDiv);
- this.loaderDiv = null;
+ removeElm(this.cont);
+ this.cont = null;
// Unsubscribe to events
emitter.off([
diff --git a/docs/file/src/modules/noResults.js.html b/docs/file/src/modules/noResults.js.html
index ef3d1817..54726fdf 100644
--- a/docs/file/src/modules/noResults.js.html
+++ b/docs/file/src/modules/noResults.js.html
@@ -3,7 +3,7 @@
- src/modules/noResults.js | tablefilter v0.2.45 API Document
+ src/modules/noResults.js | tablefilter v0.2.46 API Document
diff --git a/docs/file/src/modules/paging.js.html b/docs/file/src/modules/paging.js.html
index ee7f21c2..a1080c7e 100644
--- a/docs/file/src/modules/paging.js.html
+++ b/docs/file/src/modules/paging.js.html
@@ -3,7 +3,7 @@
- src/modules/paging.js | tablefilter v0.2.45 API Document
+ src/modules/paging.js | tablefilter v0.2.46 API Document
diff --git a/docs/file/src/modules/popupFilter.js.html b/docs/file/src/modules/popupFilter.js.html
index 9aae094f..209d1b7a 100644
--- a/docs/file/src/modules/popupFilter.js.html
+++ b/docs/file/src/modules/popupFilter.js.html
@@ -3,7 +3,7 @@
- src/modules/popupFilter.js | tablefilter v0.2.45 API Document
+ src/modules/popupFilter.js | tablefilter v0.2.46 API Document
diff --git a/docs/file/src/modules/rowsCounter.js.html b/docs/file/src/modules/rowsCounter.js.html
index 32d39e1d..8cb4a591 100644
--- a/docs/file/src/modules/rowsCounter.js.html
+++ b/docs/file/src/modules/rowsCounter.js.html
@@ -3,7 +3,7 @@
- src/modules/rowsCounter.js | tablefilter v0.2.45 API Document
+ src/modules/rowsCounter.js | tablefilter v0.2.46 API Document
diff --git a/docs/file/src/modules/state.js.html b/docs/file/src/modules/state.js.html
index ae9ebc4e..b670b1ba 100644
--- a/docs/file/src/modules/state.js.html
+++ b/docs/file/src/modules/state.js.html
@@ -3,7 +3,7 @@
- src/modules/state.js | tablefilter v0.2.45 API Document
+ src/modules/state.js | tablefilter v0.2.46 API Document
diff --git a/docs/file/src/modules/statusBar.js.html b/docs/file/src/modules/statusBar.js.html
index 10dc5c63..161ee97d 100644
--- a/docs/file/src/modules/statusBar.js.html
+++ b/docs/file/src/modules/statusBar.js.html
@@ -3,7 +3,7 @@
- src/modules/statusBar.js | tablefilter v0.2.45 API Document
+ src/modules/statusBar.js | tablefilter v0.2.46 API Document
diff --git a/docs/file/src/modules/storage.js.html b/docs/file/src/modules/storage.js.html
index b357486b..9ceec978 100644
--- a/docs/file/src/modules/storage.js.html
+++ b/docs/file/src/modules/storage.js.html
@@ -3,7 +3,7 @@
- src/modules/storage.js | tablefilter v0.2.45 API Document
+ src/modules/storage.js | tablefilter v0.2.46 API Document
diff --git a/docs/file/src/root.js.html b/docs/file/src/root.js.html
index b298b4b3..c145dc65 100644
--- a/docs/file/src/root.js.html
+++ b/docs/file/src/root.js.html
@@ -3,7 +3,7 @@
- src/root.js | tablefilter v0.2.45 API Document
+ src/root.js | tablefilter v0.2.46 API Document
diff --git a/docs/file/src/sort.js.html b/docs/file/src/sort.js.html
index e1b4691f..19d0f1e3 100644
--- a/docs/file/src/sort.js.html
+++ b/docs/file/src/sort.js.html
@@ -3,7 +3,7 @@
- src/sort.js | tablefilter v0.2.45 API Document
+ src/sort.js | tablefilter v0.2.46 API Document
diff --git a/docs/file/src/string.js.html b/docs/file/src/string.js.html
index 37a7e0fe..f21bfd20 100644
--- a/docs/file/src/string.js.html
+++ b/docs/file/src/string.js.html
@@ -3,7 +3,7 @@
- src/string.js | tablefilter v0.2.45 API Document
+ src/string.js | tablefilter v0.2.46 API Document
diff --git a/docs/file/src/tablefilter.js.html b/docs/file/src/tablefilter.js.html
index c41b8686..78930a32 100644
--- a/docs/file/src/tablefilter.js.html
+++ b/docs/file/src/tablefilter.js.html
@@ -3,7 +3,7 @@
- src/tablefilter.js | tablefilter v0.2.45 API Document
+ src/tablefilter.js | tablefilter v0.2.46 API Document
diff --git a/docs/file/src/types.js.html b/docs/file/src/types.js.html
index f06a3e66..653f147c 100644
--- a/docs/file/src/types.js.html
+++ b/docs/file/src/types.js.html
@@ -3,7 +3,7 @@
- src/types.js | tablefilter v0.2.45 API Document
+ src/types.js | tablefilter v0.2.46 API Document
diff --git a/docs/identifiers.html b/docs/identifiers.html
index 066d615d..f5b64706 100644
--- a/docs/identifiers.html
+++ b/docs/identifiers.html
@@ -3,7 +3,7 @@
- Index | tablefilter v0.2.45 API Document
+ Index | tablefilter v0.2.46 API Document
@@ -495,7 +495,8 @@
-
+
Highlight matched keywords upon filtering
+
@@ -520,7 +521,8 @@
|
diff --git a/docs/index.html b/docs/index.html
index 5e09f94a..9031383c 100644
--- a/docs/index.html
+++ b/docs/index.html
@@ -3,7 +3,7 @@
- tablefilter v0.2.45 API Document
+ tablefilter v0.2.46 API Document
diff --git a/docs/package.json b/docs/package.json
index 0d654134..ac4d59c2 100644
--- a/docs/package.json
+++ b/docs/package.json
@@ -1,6 +1,6 @@
{
"name": "tablefilter",
- "version": "0.2.45",
+ "version": "0.2.46",
"description": "A Javascript library making HTML tables filterable and a bit more",
"license": "MIT",
"author": {
diff --git a/docs/script/search_index.js b/docs/script/search_index.js
index 81246cdc..d5d1b0f6 100644
--- a/docs/script/search_index.js
+++ b/docs/script/search_index.js
@@ -2459,18 +2459,42 @@ window.esdocSearchIndex = [
"src/modules/loader.js",
"file"
],
+ [
+ "src/modules/loader.js~loader#closedelay",
+ "class/src/modules/loader.js~Loader.html#instance-member-closeDelay",
+ "src/modules/loader.js~Loader#closeDelay",
+ "member"
+ ],
[
"src/modules/loader.js~loader#constructor",
"class/src/modules/loader.js~Loader.html#instance-constructor-constructor",
"src/modules/loader.js~Loader#constructor",
"method"
],
+ [
+ "src/modules/loader.js~loader#cont",
+ "class/src/modules/loader.js~Loader.html#instance-member-cont",
+ "src/modules/loader.js~Loader#cont",
+ "member"
+ ],
+ [
+ "src/modules/loader.js~loader#cssclass",
+ "class/src/modules/loader.js~Loader.html#instance-member-cssClass",
+ "src/modules/loader.js~Loader#cssClass",
+ "member"
+ ],
[
"src/modules/loader.js~loader#destroy",
"class/src/modules/loader.js~Loader.html#instance-method-destroy",
"src/modules/loader.js~Loader#destroy",
"method"
],
+ [
+ "src/modules/loader.js~loader#html",
+ "class/src/modules/loader.js~Loader.html#instance-member-html",
+ "src/modules/loader.js~Loader#html",
+ "member"
+ ],
[
"src/modules/loader.js~loader#init",
"class/src/modules/loader.js~Loader.html#instance-method-init",
@@ -2484,57 +2508,15 @@ window.esdocSearchIndex = [
"member"
],
[
- "src/modules/loader.js~loader#loaderclosedelay",
- "class/src/modules/loader.js~Loader.html#instance-member-loaderCloseDelay",
- "src/modules/loader.js~Loader#loaderCloseDelay",
+ "src/modules/loader.js~loader#onhide",
+ "class/src/modules/loader.js~Loader.html#instance-member-onHide",
+ "src/modules/loader.js~Loader#onHide",
"member"
],
[
- "src/modules/loader.js~loader#loadercssclass",
- "class/src/modules/loader.js~Loader.html#instance-member-loaderCssClass",
- "src/modules/loader.js~Loader#loaderCssClass",
- "member"
- ],
- [
- "src/modules/loader.js~loader#loaderdiv",
- "class/src/modules/loader.js~Loader.html#instance-member-loaderDiv",
- "src/modules/loader.js~Loader#loaderDiv",
- "member"
- ],
- [
- "src/modules/loader.js~loader#loaderhtml",
- "class/src/modules/loader.js~Loader.html#instance-member-loaderHtml",
- "src/modules/loader.js~Loader#loaderHtml",
- "member"
- ],
- [
- "src/modules/loader.js~loader#loadertext",
- "class/src/modules/loader.js~Loader.html#instance-member-loaderText",
- "src/modules/loader.js~Loader#loaderText",
- "member"
- ],
- [
- "src/modules/loader.js~loader#loadertgtid",
- "class/src/modules/loader.js~Loader.html#instance-member-loaderTgtId",
- "src/modules/loader.js~Loader#loaderTgtId",
- "member"
- ],
- [
- "src/modules/loader.js~loader#onhideloader",
- "class/src/modules/loader.js~Loader.html#instance-member-onHideLoader",
- "src/modules/loader.js~Loader#onHideLoader",
- "member"
- ],
- [
- "src/modules/loader.js~loader#onshowloader",
- "class/src/modules/loader.js~Loader.html#instance-member-onShowLoader",
- "src/modules/loader.js~Loader#onShowLoader",
- "member"
- ],
- [
- "src/modules/loader.js~loader#prfxloader",
- "class/src/modules/loader.js~Loader.html#instance-member-prfxLoader",
- "src/modules/loader.js~Loader#prfxLoader",
+ "src/modules/loader.js~loader#onshow",
+ "class/src/modules/loader.js~Loader.html#instance-member-onShow",
+ "src/modules/loader.js~Loader#onShow",
"member"
],
[
@@ -2543,6 +2525,18 @@ window.esdocSearchIndex = [
"src/modules/loader.js~Loader#show",
"method"
],
+ [
+ "src/modules/loader.js~loader#targetid",
+ "class/src/modules/loader.js~Loader.html#instance-member-targetId",
+ "src/modules/loader.js~Loader#targetId",
+ "member"
+ ],
+ [
+ "src/modules/loader.js~loader#text",
+ "class/src/modules/loader.js~Loader.html#instance-member-text",
+ "src/modules/loader.js~Loader#text",
+ "member"
+ ],
[
"src/modules/noresults.js",
"file/src/modules/noResults.js.html",
diff --git a/docs/source.html b/docs/source.html
index 407f21de..9adccc90 100644
--- a/docs/source.html
+++ b/docs/source.html
@@ -3,7 +3,7 @@
- Source | tablefilter v0.2.45 API Document
+ Source | tablefilter v0.2.46 API Document
@@ -114,7 +114,7 @@
-Source  322/761
+ Source 340/760
@@ -135,7 +135,7 @@
| 100 %1/1 |
545 byte |
22 |
- 2016-07-07 09:34:51 (UTC) |
+ 2016-07-04 08:28:13 (UTC) |
| src/const.js |
@@ -155,7 +155,7 @@
100 %13/13 |
1133 byte |
84 |
- 2016-07-07 09:34:51 (UTC) |
+ 2016-07-04 08:28:13 (UTC) |
| src/cookie.js |
@@ -163,7 +163,7 @@
- |
1412 byte |
57 |
- 2016-07-07 09:34:51 (UTC) |
+ 2016-07-04 08:28:13 (UTC) |
| src/date.js |
@@ -172,7 +172,7 @@
100 %2/2 |
5770 byte |
183 |
- 2016-07-07 09:34:51 (UTC) |
+ 2016-07-04 08:28:13 (UTC) |
| src/dom.js |
@@ -191,7 +191,7 @@
100 %12/12 |
4787 byte |
191 |
- 2016-07-07 09:34:51 (UTC) |
+ 2016-07-04 08:28:13 (UTC) |
| src/emitter.js |
@@ -199,7 +199,7 @@
100 %6/6 |
1323 byte |
53 |
- 2016-07-07 09:34:51 (UTC) |
+ 2016-07-04 08:28:13 (UTC) |
| src/event.js |
@@ -212,7 +212,7 @@
100 %6/6 |
2378 byte |
102 |
- 2016-07-07 09:34:51 (UTC) |
+ 2016-07-04 08:28:13 (UTC) |
| src/extensions/advancedGrid/adapterEzEditTable.js |
@@ -220,7 +220,7 @@
35 %5/14 |
18245 byte |
459 |
- 2016-07-07 09:34:51 (UTC) |
+ 2016-07-04 08:28:13 (UTC) |
| src/extensions/advancedGrid/advancedGrid.js |
@@ -228,7 +228,7 @@
- |
90 byte |
2 |
- 2016-07-07 09:34:51 (UTC) |
+ 2016-07-04 08:28:13 (UTC) |
| src/extensions/colOps/colOps.js |
@@ -236,7 +236,7 @@
22 %2/9 |
12868 byte |
329 |
- 2016-07-07 09:34:51 (UTC) |
+ 2016-07-04 08:28:13 (UTC) |
| src/extensions/colsVisibility/colsVisibility.js |
@@ -244,7 +244,7 @@
17 %10/57 |
18064 byte |
546 |
- 2016-07-07 09:34:51 (UTC) |
+ 2016-07-04 08:28:13 (UTC) |
| src/extensions/filtersVisibility/filtersVisibility.js |
@@ -252,7 +252,7 @@
18 %6/33 |
6337 byte |
202 |
- 2016-07-07 09:34:51 (UTC) |
+ 2016-07-04 08:28:13 (UTC) |
| src/extensions/sort/adapterSortabletable.js |
@@ -260,7 +260,7 @@
11 %3/26 |
14150 byte |
432 |
- 2016-07-07 09:34:51 (UTC) |
+ 2016-07-04 08:28:13 (UTC) |
| src/extensions/sort/sort.js |
@@ -268,7 +268,7 @@
- |
197 byte |
8 |
- 2016-07-07 09:34:51 (UTC) |
+ 2016-07-04 08:28:13 (UTC) |
| src/feature.js |
@@ -276,7 +276,7 @@
100 %14/14 |
1761 byte |
94 |
- 2016-07-07 09:34:51 (UTC) |
+ 2016-07-04 08:28:13 (UTC) |
| src/helpers.js |
@@ -284,7 +284,7 @@
100 %1/1 |
488 byte |
23 |
- 2016-07-07 09:34:51 (UTC) |
+ 2016-07-04 08:28:13 (UTC) |
| src/modules/alternateRows.js |
@@ -292,7 +292,7 @@
88 %8/9 |
3481 byte |
137 |
- 2016-07-07 09:34:51 (UTC) |
+ 2016-07-04 08:28:13 (UTC) |
| src/modules/checkList.js |
@@ -300,15 +300,15 @@
95 %20/21 |
18566 byte |
565 |
- 2016-07-07 09:34:51 (UTC) |
+ 2016-07-04 08:28:13 (UTC) |
| src/modules/clearButton.js |
ClearButton |
88 %8/9 |
- 3055 byte |
+ 3044 byte |
124 |
- 2016-07-07 09:34:51 (UTC) |
+ 2016-07-04 08:28:13 (UTC) |
| src/modules/dropdown.js |
@@ -316,15 +316,15 @@
92 %12/13 |
13674 byte |
431 |
- 2016-07-07 09:34:51 (UTC) |
+ 2016-07-04 08:28:13 (UTC) |
| src/modules/gridLayout.js |
GridLayout |
75 %15/20 |
- 14613 byte |
+ 14618 byte |
502 |
- 2016-07-07 09:34:51 (UTC) |
+ 2016-07-04 08:28:13 (UTC) |
| src/modules/hash.js |
@@ -333,31 +333,31 @@
100 %10/10 |
2915 byte |
125 |
- 2016-07-07 09:34:51 (UTC) |
+ 2016-07-04 08:28:13 (UTC) |
| src/modules/help.js |
Help |
100 %17/17 |
- 6377 byte |
- 218 |
- 2016-07-07 09:34:51 (UTC) |
+ 6347 byte |
+ 217 |
+ 2016-07-04 08:28:13 (UTC) |
- | src/modules/highlightKeywords.js |
+ src/modules/highlightKeywords.js |
HighlightKeyword |
- 40 %4/10 |
- 4011 byte |
- 122 |
- 2016-07-07 09:34:51 (UTC) |
+ 100 %10/10 |
+ 4434 byte |
+ 147 |
+ 2016-07-04 08:28:13 (UTC) |
- | src/modules/loader.js |
+ src/modules/loader.js |
Loader |
- 6 %1/15 |
- 4565 byte |
- 155 |
- 2016-07-07 09:34:51 (UTC) |
+ 92 %13/14 |
+ 5253 byte |
+ 208 |
+ 2016-07-04 08:28:13 (UTC) |
| src/modules/noResults.js |
@@ -365,7 +365,7 @@
5 %1/20 |
3735 byte |
136 |
- 2016-07-07 09:34:51 (UTC) |
+ 2016-07-04 08:28:13 (UTC) |
| src/modules/paging.js |
@@ -373,7 +373,7 @@
23 %15/63 |
26227 byte |
757 |
- 2016-07-07 09:34:51 (UTC) |
+ 2016-07-04 08:28:13 (UTC) |
| src/modules/popupFilter.js |
@@ -381,7 +381,7 @@
35 %10/28 |
9098 byte |
276 |
- 2016-07-07 09:34:51 (UTC) |
+ 2016-07-04 08:28:13 (UTC) |
| src/modules/rowsCounter.js |
@@ -389,7 +389,7 @@
5 %1/18 |
5009 byte |
149 |
- 2016-07-07 09:34:51 (UTC) |
+ 2016-07-04 08:28:13 (UTC) |
| src/modules/state.js |
@@ -397,7 +397,7 @@
35 %13/37 |
12220 byte |
412 |
- 2016-07-07 09:34:51 (UTC) |
+ 2016-07-04 08:28:13 (UTC) |
| src/modules/statusBar.js |
@@ -405,7 +405,7 @@
3 %1/29 |
7663 byte |
222 |
- 2016-07-07 09:34:51 (UTC) |
+ 2016-07-04 08:28:13 (UTC) |
| src/modules/storage.js |
@@ -414,7 +414,7 @@
56 %9/16 |
2860 byte |
123 |
- 2016-07-07 09:34:51 (UTC) |
+ 2016-07-04 08:28:13 (UTC) |
| src/root.js |
@@ -422,7 +422,7 @@
100 %1/1 |
235 byte |
6 |
- 2016-07-07 09:34:51 (UTC) |
+ 2016-07-04 08:28:13 (UTC) |
| src/sort.js |
@@ -432,7 +432,7 @@
100 %3/3 |
930 byte |
33 |
- 2016-07-07 09:34:51 (UTC) |
+ 2016-07-04 08:28:13 (UTC) |
| src/string.js |
@@ -444,7 +444,7 @@
100 %5/5 |
1854 byte |
69 |
- 2016-07-07 09:34:51 (UTC) |
+ 2016-07-04 08:28:13 (UTC) |
| src/tablefilter.js |
@@ -452,7 +452,7 @@
36 %79/215 |
77868 byte |
2301 |
- 2016-07-07 09:34:51 (UTC) |
+ 2016-07-04 08:28:13 (UTC) |
| src/types.js |
@@ -467,7 +467,7 @@
100 %8/8 |
1451 byte |
67 |
- 2016-07-07 09:34:51 (UTC) |
+ 2016-07-04 08:28:13 (UTC) |
diff --git a/docs/variable/index.html b/docs/variable/index.html
index dacc10f0..574e0b30 100644
--- a/docs/variable/index.html
+++ b/docs/variable/index.html
@@ -3,7 +3,7 @@
- Variable | tablefilter v0.2.45 API Document
+ Variable | tablefilter v0.2.46 API Document
|