backgrid-filter
Version:
Search box widget extension for Backgrid.js. Supports server-side, client-side and full-text searching.
424 lines (420 loc) • 11.4 kB
JavaScript
Docs = {
"data": {
"classes": [
{
"name": "Backgrid.Extension.ServerSideFilter",
"extends": null,
"private": null,
"icon": "icon-class"
},
{
"name": "Backgrid.Extension.ClientSideFilter",
"extends": "Backgrid.Extension.ServerSideFilter",
"private": null,
"icon": "icon-class"
},
{
"name": "Backgrid.Extension.LunrFilter",
"extends": "Backgrid.Extension.ClientSideFilter",
"private": null,
"icon": "icon-class"
}
],
"guides": [
],
"videos": [
],
"examples": [
],
"search": [
{
"name": "Extension.ServerSideFilter",
"fullName": "Backgrid.Extension.ServerSideFilter",
"icon": "icon-class",
"url": "#!/api/Backgrid.Extension.ServerSideFilter",
"meta": {
},
"sort": 1
},
{
"name": "tagName",
"fullName": "Backgrid.Extension.ServerSideFilter.tagName",
"icon": "icon-property",
"url": "#!/api/Backgrid.Extension.ServerSideFilter-property-tagName",
"meta": {
},
"sort": 3
},
{
"name": "className",
"fullName": "Backgrid.Extension.ServerSideFilter.className",
"icon": "icon-property",
"url": "#!/api/Backgrid.Extension.ServerSideFilter-property-className",
"meta": {
},
"sort": 3
},
{
"name": "template",
"fullName": "Backgrid.Extension.ServerSideFilter.template",
"icon": "icon-property",
"url": "#!/api/Backgrid.Extension.ServerSideFilter-property-template",
"meta": {
},
"sort": 3
},
{
"name": "events",
"fullName": "Backgrid.Extension.ServerSideFilter.events",
"icon": "icon-property",
"url": "#!/api/Backgrid.Extension.ServerSideFilter-property-events",
"meta": {
},
"sort": 3
},
{
"name": "name",
"fullName": "Backgrid.Extension.ServerSideFilter.name",
"icon": "icon-property",
"url": "#!/api/Backgrid.Extension.ServerSideFilter-property-name",
"meta": {
},
"sort": 3
},
{
"name": "value",
"fullName": "Backgrid.Extension.ServerSideFilter.value",
"icon": "icon-property",
"url": "#!/api/Backgrid.Extension.ServerSideFilter-property-value",
"meta": {
},
"sort": 3
},
{
"name": "placeholder",
"fullName": "Backgrid.Extension.ServerSideFilter.placeholder",
"icon": "icon-property",
"url": "#!/api/Backgrid.Extension.ServerSideFilter-property-placeholder",
"meta": {
},
"sort": 3
},
{
"name": "initialize",
"fullName": "Backgrid.Extension.ServerSideFilter.initialize",
"icon": "icon-method",
"url": "#!/api/Backgrid.Extension.ServerSideFilter-method-initialize",
"meta": {
},
"sort": 3
},
{
"name": "clearSearchBox",
"fullName": "Backgrid.Extension.ServerSideFilter.clearSearchBox",
"icon": "icon-method",
"url": "#!/api/Backgrid.Extension.ServerSideFilter-method-clearSearchBox",
"meta": {
},
"sort": 3
},
{
"name": "showClearButtonMaybe",
"fullName": "Backgrid.Extension.ServerSideFilter.showClearButtonMaybe",
"icon": "icon-method",
"url": "#!/api/Backgrid.Extension.ServerSideFilter-method-showClearButtonMaybe",
"meta": {
},
"sort": 3
},
{
"name": "searchBox",
"fullName": "Backgrid.Extension.ServerSideFilter.searchBox",
"icon": "icon-method",
"url": "#!/api/Backgrid.Extension.ServerSideFilter-method-searchBox",
"meta": {
},
"sort": 3
},
{
"name": "clearButton",
"fullName": "Backgrid.Extension.ServerSideFilter.clearButton",
"icon": "icon-method",
"url": "#!/api/Backgrid.Extension.ServerSideFilter-method-clearButton",
"meta": {
},
"sort": 3
},
{
"name": "query",
"fullName": "Backgrid.Extension.ServerSideFilter.query",
"icon": "icon-method",
"url": "#!/api/Backgrid.Extension.ServerSideFilter-method-query",
"meta": {
},
"sort": 3
},
{
"name": "search",
"fullName": "Backgrid.Extension.ServerSideFilter.search",
"icon": "icon-method",
"url": "#!/api/Backgrid.Extension.ServerSideFilter-method-search",
"meta": {
},
"sort": 3
},
{
"name": "clear",
"fullName": "Backgrid.Extension.ServerSideFilter.clear",
"icon": "icon-method",
"url": "#!/api/Backgrid.Extension.ServerSideFilter-method-clear",
"meta": {
},
"sort": 3
},
{
"name": "render",
"fullName": "Backgrid.Extension.ServerSideFilter.render",
"icon": "icon-method",
"url": "#!/api/Backgrid.Extension.ServerSideFilter-method-render",
"meta": {
"chainable": true
},
"sort": 3
},
{
"name": "Extension.ClientSideFilter",
"fullName": "Backgrid.Extension.ClientSideFilter",
"icon": "icon-class",
"url": "#!/api/Backgrid.Extension.ClientSideFilter",
"meta": {
},
"sort": 1
},
{
"name": "events",
"fullName": "Backgrid.Extension.ClientSideFilter.events",
"icon": "icon-property",
"url": "#!/api/Backgrid.Extension.ClientSideFilter-property-events",
"meta": {
},
"sort": 3
},
{
"name": "fields",
"fullName": "Backgrid.Extension.ClientSideFilter.fields",
"icon": "icon-property",
"url": "#!/api/Backgrid.Extension.ClientSideFilter-property-fields",
"meta": {
},
"sort": 3
},
{
"name": "wait",
"fullName": "Backgrid.Extension.ClientSideFilter.wait",
"icon": "icon-property",
"url": "#!/api/Backgrid.Extension.ClientSideFilter-property-wait",
"meta": {
},
"sort": 3
},
{
"name": "initialize",
"fullName": "Backgrid.Extension.ClientSideFilter.initialize",
"icon": "icon-method",
"url": "#!/api/Backgrid.Extension.ClientSideFilter-method-initialize",
"meta": {
},
"sort": 3
},
{
"name": "makeRegExp",
"fullName": "Backgrid.Extension.ClientSideFilter.makeRegExp",
"icon": "icon-method",
"url": "#!/api/Backgrid.Extension.ClientSideFilter-method-makeRegExp",
"meta": {
},
"sort": 3
},
{
"name": "makeMatcher",
"fullName": "Backgrid.Extension.ClientSideFilter.makeMatcher",
"icon": "icon-method",
"url": "#!/api/Backgrid.Extension.ClientSideFilter-method-makeMatcher",
"meta": {
},
"sort": 3
},
{
"name": "search",
"fullName": "Backgrid.Extension.ClientSideFilter.search",
"icon": "icon-method",
"url": "#!/api/Backgrid.Extension.ClientSideFilter-method-search",
"meta": {
},
"sort": 3
},
{
"name": "clear",
"fullName": "Backgrid.Extension.ClientSideFilter.clear",
"icon": "icon-method",
"url": "#!/api/Backgrid.Extension.ClientSideFilter-method-clear",
"meta": {
},
"sort": 3
},
{
"name": "Extension.LunrFilter",
"fullName": "Backgrid.Extension.LunrFilter",
"icon": "icon-class",
"url": "#!/api/Backgrid.Extension.LunrFilter",
"meta": {
},
"sort": 1
},
{
"name": "ref",
"fullName": "Backgrid.Extension.LunrFilter.ref",
"icon": "icon-property",
"url": "#!/api/Backgrid.Extension.LunrFilter-property-ref",
"meta": {
},
"sort": 3
},
{
"name": "fields",
"fullName": "Backgrid.Extension.LunrFilter.fields",
"icon": "icon-property",
"url": "#!/api/Backgrid.Extension.LunrFilter-property-fields",
"meta": {
},
"sort": 3
},
{
"name": "initialize",
"fullName": "Backgrid.Extension.LunrFilter.initialize",
"icon": "icon-method",
"url": "#!/api/Backgrid.Extension.LunrFilter-method-initialize",
"meta": {
},
"sort": 3
},
{
"name": "resetIndex",
"fullName": "Backgrid.Extension.LunrFilter.resetIndex",
"icon": "icon-method",
"url": "#!/api/Backgrid.Extension.LunrFilter-method-resetIndex",
"meta": {
},
"sort": 3
},
{
"name": "addToIndex",
"fullName": "Backgrid.Extension.LunrFilter.addToIndex",
"icon": "icon-method",
"url": "#!/api/Backgrid.Extension.LunrFilter-method-addToIndex",
"meta": {
},
"sort": 3
},
{
"name": "removeFromIndex",
"fullName": "Backgrid.Extension.LunrFilter.removeFromIndex",
"icon": "icon-method",
"url": "#!/api/Backgrid.Extension.LunrFilter-method-removeFromIndex",
"meta": {
},
"sort": 3
},
{
"name": "updateIndex",
"fullName": "Backgrid.Extension.LunrFilter.updateIndex",
"icon": "icon-method",
"url": "#!/api/Backgrid.Extension.LunrFilter-method-updateIndex",
"meta": {
},
"sort": 3
},
{
"name": "search",
"fullName": "Backgrid.Extension.LunrFilter.search",
"icon": "icon-method",
"url": "#!/api/Backgrid.Extension.LunrFilter-method-search",
"meta": {
},
"sort": 3
}
],
"guideSearch": {
},
"tests": false,
"signatures": [
{
"long": "abstract",
"short": "ABS",
"key": "abstract"
},
{
"long": "chainable",
"short": ">",
"key": "chainable"
},
{
"long": "deprecated",
"short": "DEP",
"key": "deprecated"
},
{
"long": "★",
"short": "★",
"key": "new"
},
{
"long": "preventable",
"short": "PREV",
"key": "preventable"
},
{
"long": "private",
"short": "PRI",
"key": "private"
},
{
"long": "protected",
"short": "PRO",
"key": "protected"
},
{
"long": "readonly",
"short": "R O",
"key": "readonly"
},
{
"long": "removed",
"short": "REM",
"key": "removed"
},
{
"long": "required",
"short": "REQ",
"key": "required"
},
{
"long": "static",
"short": "STA",
"key": "static"
},
{
"long": "template",
"short": "TMP",
"key": "template"
}
],
"localStorageDb": "docs",
"showPrintButton": false,
"touchExamplesUi": false,
"source": false,
"commentsUrl": null,
"commentsDomain": null,
"message": ""
}
};