Example
...
// as boolean
search: true
// as a object with one or more options
search: {
callback: myNewCallbackFunction,
queryMethod: myNewQueryMethod,
searchResultClass: 'customClass'
}
// Access to search plugin instance:
var searchPlugin = hot.getPlugin('search');
// Set callback programmatically:
searchPlugin.setCallback(myNewCallbackFunction);
// Set query method programmatically:
searchPlugin.setQueryMethod(myNewQueryMethod);
// Set search result cells class programmatically:
searchPlugin.setSearchResultClass(customClass);
...
Members
-
callbackfunction
-
Function called during querying for each cell from the
DataMap
. -
queryMethodfunction
-
Query function is responsible for determining whether a query matches the value stored in a cell.
-
searchResultClassString
-
Class name added to each cell that belongs to the searched query.
Methods
-
handsontable/src/plugins/search/search.js, line 281
destroy()
-
Destroy plugin instance.
-
handsontable/src/plugins/search/search.js, line 104
disablePlugin()
-
Disable plugin for this Handsontable instance.
-
handsontable/src/plugins/search/search.js, line 88
enablePlugin()
-
Enable plugin for this Handsontable instance.
-
handsontable/src/plugins/search/search.js, line 172
getCallback(){function}
-
Get callback function.
Returns: {function} Return the callback function.
-
handsontable/src/plugins/search/search.js, line 190
getQueryMethod(){function}
-
Get queryMethod function.
Returns: {function} Return the query method.
-
handsontable/src/plugins/search/search.js, line 208
getSearchResultClass(){String}
-
Get search result cells class.
Returns: {String} Return the cell class.
-
handsontable/src/plugins/search/search.js, line 81
isEnabled(){Boolean}
-
Check if the plugin is enabled in the Handsontable settings.
Returns: {Boolean}
-
handsontable/src/plugins/search/search.js, line 134
query(queryStr, callback, queryMethod){Array}
-
Query method - used inside search input listener.
Parameters:
Name Type Description queryStr
String Searched value.
callback
function optional Callback function performed on cells with values which matches to the searched query.
queryMethod
function optional Query function responsible for determining whether a query matches the value stored in a cell.
Returns: {Array} Return array of objects with
row
,col
,data
properties or empty array. -
handsontable/src/plugins/search/search.js, line 181
setCallback(newCallback)
-
Set callback function.
Parameters:
Name Type Description newCallback
function -
handsontable/src/plugins/search/search.js, line 199
setQueryMethod(newQueryMethod)
-
Set queryMethod function.
Parameters:
Name Type Description newQueryMethod
function -
handsontable/src/plugins/search/search.js, line 217
setSearchResultClass(newElementClass)
-
Set search result cells class.
Parameters:
Name Type Description newElementClass
String -
handsontable/src/plugins/search/search.js, line 118
updatePlugin()
-
Updates the plugin to use the latest options you have specified.