@qikdev/sdk 1.0.4 → 1.0.6

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
package/dist/filter.html CHANGED
@@ -27,7 +27,7 @@
27
27
 
28
28
  <nav >
29
29
 
30
- <h2><a href="index.html">Home</a></h2><h3>Classes</h3><ul><li><a href="access.html">access</a><ul class='methods'><li data-type='method'><a href="access.html#.actionableScopes">actionableScopes</a></li><li data-type='method'><a href="access.html#.actionableScopes">actionableScopes</a></li><li data-type='method'><a href="access.html#.allPermissions">allPermissions</a></li><li data-type='method'><a href="access.html#.allPermissions">allPermissions</a></li><li data-type='method'><a href="access.html#.allPermissionTypes">allPermissionTypes</a></li><li data-type='method'><a href="access.html#.allPermissionTypes">allPermissionTypes</a></li><li data-type='method'><a href="access.html#.allUserScopes">allUserScopes</a></li><li data-type='method'><a href="access.html#.allUserScopes">allUserScopes</a></li><li data-type='method'><a href="access.html#.canCreate">canCreate</a></li><li data-type='method'><a href="access.html#.canCreate">canCreate</a></li><li data-type='method'><a href="access.html#.canDeleteItem">canDeleteItem</a></li><li data-type='method'><a href="access.html#.canDeleteItem">canDeleteItem</a></li><li data-type='method'><a href="access.html#.canEditItem">canEditItem</a></li><li data-type='method'><a href="access.html#.canEditItem">canEditItem</a></li><li data-type='method'><a href="access.html#.canEraseItem">canEraseItem</a></li><li data-type='method'><a href="access.html#.canEraseItem">canEraseItem</a></li><li data-type='method'><a href="access.html#.canKnowOf">canKnowOf</a></li><li data-type='method'><a href="access.html#.canKnowOf">canKnowOf</a></li><li data-type='method'><a href="access.html#.canListItem">canListItem</a></li><li data-type='method'><a href="access.html#.canListItem">canListItem</a></li><li data-type='method'><a href="access.html#.canRestoreItem">canRestoreItem</a></li><li data-type='method'><a href="access.html#.canRestoreItem">canRestoreItem</a></li><li data-type='method'><a href="access.html#.canViewItem">canViewItem</a></li><li data-type='method'><a href="access.html#.canViewItem">canViewItem</a></li><li data-type='method'><a href="access.html#.checkActionAccess">checkActionAccess</a></li><li data-type='method'><a href="access.html#.checkActionAccess">checkActionAccess</a></li><li data-type='method'><a href="access.html#.getAllDescendants">getAllDescendants</a></li><li data-type='method'><a href="access.html#.getAllDescendants">getAllDescendants</a></li><li data-type='method'><a href="access.html#.has">has</a></li><li data-type='method'><a href="access.html#.has">has</a></li><li data-type='method'><a href="access.html#.hasFeature">hasFeature</a></li><li data-type='method'><a href="access.html#.hasFeature">hasFeature</a></li><li data-type='method'><a href="access.html#.hashPermissions">hashPermissions</a></li><li data-type='method'><a href="access.html#.hashPermissions">hashPermissions</a></li><li data-type='method'><a href="access.html#.isAdministrator">isAdministrator</a></li><li data-type='method'><a href="access.html#.isAdministrator">isAdministrator</a></li><li data-type='method'><a href="access.html#.isAssignee">isAssignee</a></li><li data-type='method'><a href="access.html#.isAssignee">isAssignee</a></li><li data-type='method'><a href="access.html#.isOwner">isOwner</a></li><li data-type='method'><a href="access.html#.isOwner">isOwner</a></li></ul></li><li></li><li><a href="api.html">api</a><ul class='methods'><li data-type='method'><a href="api.html#.generateEndpointURL">generateEndpointURL</a></li><li data-type='method'><a href="api.html#.generateEndpointURL">generateEndpointURL</a></li></ul></li><li></li><li><a href="auth.html">auth</a><ul class='methods'><li data-type='method'><a href="auth.html#.changeOrganisation">changeOrganisation</a></li><li data-type='method'><a href="auth.html#.changeOrganisation">changeOrganisation</a></li><li data-type='method'><a href="auth.html#.ensureValidToken">ensureValidToken</a></li><li data-type='method'><a href="auth.html#.ensureValidToken">ensureValidToken</a></li><li data-type='method'><a href="auth.html#.getCurrentToken">getCurrentToken</a></li><li data-type='method'><a href="auth.html#.getCurrentToken">getCurrentToken</a></li><li data-type='method'><a href="auth.html#.getCurrentUser">getCurrentUser</a></li><li data-type='method'><a href="auth.html#.getCurrentUser">getCurrentUser</a></li><li data-type='method'><a href="auth.html#.impersonate">impersonate</a></li><li data-type='method'><a href="auth.html#.impersonate">impersonate</a></li><li data-type='method'><a href="auth.html#.login">login</a></li><li data-type='method'><a href="auth.html#.login">login</a></li><li data-type='method'><a href="auth.html#.logout">logout</a></li><li data-type='method'><a href="auth.html#.logout">logout</a></li><li data-type='method'><a href="auth.html#.retrieveUserFromResetToken">retrieveUserFromResetToken</a></li><li data-type='method'><a href="auth.html#.retrieveUserFromResetToken">retrieveUserFromResetToken</a></li><li data-type='method'><a href="auth.html#.sendResetPasswordRequest">sendResetPasswordRequest</a></li><li data-type='method'><a href="auth.html#.sendResetPasswordRequest">sendResetPasswordRequest</a></li><li data-type='method'><a href="auth.html#.set">set</a></li><li data-type='method'><a href="auth.html#.set">set</a></li><li data-type='method'><a href="auth.html#.sync">sync</a></li><li data-type='method'><a href="auth.html#.sync">sync</a></li><li data-type='method'><a href="auth.html#.updateUserWithToken">updateUserWithToken</a></li><li data-type='method'><a href="auth.html#.updateUserWithToken">updateUserWithToken</a></li></ul></li><li></li><li><a href="cache.html">cache</a><ul class='methods'><li data-type='method'><a href="cache.html#.get">get</a></li><li data-type='method'><a href="cache.html#.get">get</a></li><li data-type='method'><a href="cache.html#.reset">reset</a></li><li data-type='method'><a href="cache.html#.reset">reset</a></li></ul></li><li></li><li><a href="content.html">content</a><ul class='methods'><li data-type='method'><a href="content.html#.create">create</a></li><li data-type='method'><a href="content.html#.create">create</a></li><li data-type='method'><a href="content.html#.delete">delete</a></li><li data-type='method'><a href="content.html#.delete">delete</a></li><li data-type='method'><a href="content.html#.get">get</a></li><li data-type='method'><a href="content.html#.get">get</a></li><li data-type='method'><a href="content.html#.getFromSlug">getFromSlug</a></li><li data-type='method'><a href="content.html#.getFromSlug">getFromSlug</a></li><li data-type='method'><a href="content.html#.glossary">glossary</a></li><li data-type='method'><a href="content.html#.glossary">glossary</a></li><li data-type='method'><a href="content.html#.list">list</a></li><li data-type='method'><a href="content.html#.list">list</a></li><li data-type='method'><a href="content.html#.patch">patch</a></li><li data-type='method'><a href="content.html#.patch">patch</a></li><li data-type='method'><a href="content.html#.restore">restore</a></li><li data-type='method'><a href="content.html#.restore">restore</a></li><li data-type='method'><a href="content.html#.scopeGlossary">scopeGlossary</a></li><li data-type='method'><a href="content.html#.scopeGlossary">scopeGlossary</a></li><li data-type='method'><a href="content.html#.update">update</a></li><li data-type='method'><a href="content.html#.update">update</a></li><li data-type='method'><a href="content.html#.validateField">validateField</a></li><li data-type='method'><a href="content.html#.validateField">validateField</a></li><li data-type='method'><a href="content.html#.variables">variables</a></li><li data-type='method'><a href="content.html#.variables">variables</a></li></ul></li><li></li><li><a href="files.html">files</a><ul class='methods'><li data-type='method'><a href="files.html#.downloadUrl">downloadUrl</a></li><li data-type='method'><a href="files.html#.downloadUrl">downloadUrl</a></li><li data-type='method'><a href="files.html#.duration">duration</a></li><li data-type='method'><a href="files.html#.duration">duration</a></li><li data-type='method'><a href="files.html#.filesize">filesize</a></li><li data-type='method'><a href="files.html#.filesize">filesize</a></li><li data-type='method'><a href="files.html#.getBinaryTypeFromMime">getBinaryTypeFromMime</a></li><li data-type='method'><a href="files.html#.getBinaryTypeFromMime">getBinaryTypeFromMime</a></li><li data-type='method'><a href="files.html#.mediaUrl">mediaUrl</a></li><li data-type='method'><a href="files.html#.mediaUrl">mediaUrl</a></li></ul></li><li></li><li><a href="filter.html">filter</a><ul class='methods'><li data-type='method'><a href="filter.html#.activeFilterKeys">activeFilterKeys</a></li><li data-type='method'><a href="filter.html#.activeFilterKeys">activeFilterKeys</a></li><li data-type='method'><a href="filter.html#.activeFilterKeys">activeFilterKeys</a></li><li data-type='method'><a href="filter.html#.activeFilterKeys">activeFilterKeys</a></li><li data-type='method'><a href="filter.html#.activeFilterOperators">activeFilterOperators</a></li><li data-type='method'><a href="filter.html#.activeFilterOperators">activeFilterOperators</a></li><li data-type='method'><a href="filter.html#.activeFilters">activeFilters</a></li><li data-type='method'><a href="filter.html#.activeFilters">activeFilters</a></li><li data-type='method'><a href="filter.html#.activeFilterValues">activeFilterValues</a></li><li data-type='method'><a href="filter.html#.activeFilterValues">activeFilterValues</a></li><li data-type='method'><a href="filter.html#.filterChangeString">filterChangeString</a></li><li data-type='method'><a href="filter.html#.filterChangeString">filterChangeString</a></li><li data-type='method'><a href="filter.html#.isValidFilter">isValidFilter</a></li><li data-type='method'><a href="filter.html#.isValidFilter">isValidFilter</a></li></ul></li><li></li><li><a href="geo.html">geo</a><ul class='methods'><li data-type='method'><a href="geo.html#.distance">distance</a></li><li data-type='method'><a href="geo.html#.distance">distance</a></li><li data-type='method'><a href="geo.html#.getDefaultCountry">getDefaultCountry</a></li><li data-type='method'><a href="geo.html#.getDefaultCountry">getDefaultCountry</a></li><li data-type='method'><a href="geo.html#.getDefaultTimezone">getDefaultTimezone</a></li><li data-type='method'><a href="geo.html#.getDefaultTimezone">getDefaultTimezone</a></li><li data-type='method'><a href="geo.html#.getPosition">getPosition</a></li><li data-type='method'><a href="geo.html#.getPosition">getPosition</a></li><li data-type='method'><a href="geo.html#.stopWatchPosition">stopWatchPosition</a></li><li data-type='method'><a href="geo.html#.stopWatchPosition">stopWatchPosition</a></li><li data-type='method'><a href="geo.html#.stopWatchPosition">stopWatchPosition</a></li><li data-type='method'><a href="geo.html#.stopWatchPosition">stopWatchPosition</a></li></ul></li><li></li><li><a href="module-QikStorage-CookieStorageAdapter.html">CookieStorageAdapter</a><ul class='methods'><li data-type='method'><a href="module-QikStorage-CookieStorageAdapter.html#getCookieOptions">getCookieOptions</a></li><li data-type='method'><a href="module-QikStorage-CookieStorageAdapter.html#getCookieOptions">getCookieOptions</a></li><li data-type='method'><a href="module-QikStorage-CookieStorageAdapter.html#isCookieMode">isCookieMode</a></li><li data-type='method'><a href="module-QikStorage-CookieStorageAdapter.html#isCookieMode">isCookieMode</a></li></ul></li><li></li><li><a href="module-QikStorage-LocalStorageAdapter.html">LocalStorageAdapter</a></li><li></li><li><a href="module-QikStorage-StorageAdapter.html">StorageAdapter</a><ul class='methods'><li data-type='method'><a href="module-QikStorage-StorageAdapter.html#clearUser">clearUser</a></li><li data-type='method'><a href="module-QikStorage-StorageAdapter.html#clearUser">clearUser</a></li><li data-type='method'><a href="module-QikStorage-StorageAdapter.html#getAccessToken">getAccessToken</a></li><li data-type='method'><a href="module-QikStorage-StorageAdapter.html#getAccessToken">getAccessToken</a></li><li data-type='method'><a href="module-QikStorage-StorageAdapter.html#getRefreshToken">getRefreshToken</a></li><li data-type='method'><a href="module-QikStorage-StorageAdapter.html#getRefreshToken">getRefreshToken</a></li><li data-type='method'><a href="module-QikStorage-StorageAdapter.html#getTokenExpiry">getTokenExpiry</a></li><li data-type='method'><a href="module-QikStorage-StorageAdapter.html#getTokenExpiry">getTokenExpiry</a></li><li data-type='method'><a href="module-QikStorage-StorageAdapter.html#getUser">getUser</a></li><li data-type='method'><a href="module-QikStorage-StorageAdapter.html#getUser">getUser</a></li><li data-type='method'><a href="module-QikStorage-StorageAdapter.html#isAvailable">isAvailable</a></li><li data-type='method'><a href="module-QikStorage-StorageAdapter.html#isAvailable">isAvailable</a></li><li data-type='method'><a href="module-QikStorage-StorageAdapter.html#setUser">setUser</a></li><li data-type='method'><a href="module-QikStorage-StorageAdapter.html#setUser">setUser</a></li></ul></li><li></li><li><a href="socket.html">socket</a><ul class='methods'><li data-type='method'><a href="socket.html#.channel">channel</a></li><li data-type='method'><a href="socket.html#.channel">channel</a></li><li data-type='method'><a href="socket.html#.close">close</a></li><li data-type='method'><a href="socket.html#.close">close</a></li><li data-type='method'><a href="socket.html#.connect">connect</a></li><li data-type='method'><a href="socket.html#.connect">connect</a></li><li data-type='method'><a href="socket.html#.reconnect">reconnect</a></li><li data-type='method'><a href="socket.html#.reconnect">reconnect</a></li><li data-type='method'><a href="socket.html#.subscribe">subscribe</a></li><li data-type='method'><a href="socket.html#.subscribe">subscribe</a></li><li data-type='method'><a href="socket.html#.unsubscribe">unsubscribe</a></li><li data-type='method'><a href="socket.html#.unsubscribe">unsubscribe</a></li></ul></li><li></li><li><a href="system.html">system</a><ul class='methods'><li data-type='method'><a href="system.html#.countries">countries</a></li><li data-type='method'><a href="system.html#.countries">countries</a></li></ul></li><li></li></ul><h3>Modules</h3><ul><li><a href="module-QikStorage.html">QikStorage</a><ul class='methods'><li data-type='method'><a href="module-QikStorage.html#.createStorageAdapter">createStorageAdapter</a></li><li data-type='method'><a href="module-QikStorage.html#.createStorageAdapter">createStorageAdapter</a></li></ul></li><li></li></ul><h3>Global</h3><ul><li><a href="global.html#EventDispatcher">EventDispatcher</a></li></ul>
30
+ <h2><a href="index.html">Home</a></h2><h3>Classes</h3><ul><li><a href="access.html">access</a><ul class='methods'><li data-type='method'><a href="access.html#.actionableScopes">actionableScopes</a></li><li data-type='method'><a href="access.html#.allPermissions">allPermissions</a></li><li data-type='method'><a href="access.html#.allPermissionTypes">allPermissionTypes</a></li><li data-type='method'><a href="access.html#.allUserScopes">allUserScopes</a></li><li data-type='method'><a href="access.html#.canCreate">canCreate</a></li><li data-type='method'><a href="access.html#.canDeleteItem">canDeleteItem</a></li><li data-type='method'><a href="access.html#.canEditItem">canEditItem</a></li><li data-type='method'><a href="access.html#.canEraseItem">canEraseItem</a></li><li data-type='method'><a href="access.html#.canKnowOf">canKnowOf</a></li><li data-type='method'><a href="access.html#.canListItem">canListItem</a></li><li data-type='method'><a href="access.html#.canRestoreItem">canRestoreItem</a></li><li data-type='method'><a href="access.html#.canViewItem">canViewItem</a></li><li data-type='method'><a href="access.html#.checkActionAccess">checkActionAccess</a></li><li data-type='method'><a href="access.html#.getAllDescendants">getAllDescendants</a></li><li data-type='method'><a href="access.html#.has">has</a></li><li data-type='method'><a href="access.html#.hasFeature">hasFeature</a></li><li data-type='method'><a href="access.html#.hashPermissions">hashPermissions</a></li><li data-type='method'><a href="access.html#.isAdministrator">isAdministrator</a></li><li data-type='method'><a href="access.html#.isAssignee">isAssignee</a></li><li data-type='method'><a href="access.html#.isOwner">isOwner</a></li></ul></li><li><a href="api.html">api</a><ul class='methods'><li data-type='method'><a href="api.html#.generateEndpointURL">generateEndpointURL</a></li></ul></li><li><a href="auth.html">auth</a><ul class='methods'><li data-type='method'><a href="auth.html#.changeOrganisation">changeOrganisation</a></li><li data-type='method'><a href="auth.html#.ensureValidToken">ensureValidToken</a></li><li data-type='method'><a href="auth.html#.getCurrentToken">getCurrentToken</a></li><li data-type='method'><a href="auth.html#.getCurrentUser">getCurrentUser</a></li><li data-type='method'><a href="auth.html#.impersonate">impersonate</a></li><li data-type='method'><a href="auth.html#.login">login</a></li><li data-type='method'><a href="auth.html#.logout">logout</a></li><li data-type='method'><a href="auth.html#.retrieveUserFromResetToken">retrieveUserFromResetToken</a></li><li data-type='method'><a href="auth.html#.sendResetPasswordRequest">sendResetPasswordRequest</a></li><li data-type='method'><a href="auth.html#.set">set</a></li><li data-type='method'><a href="auth.html#.sync">sync</a></li><li data-type='method'><a href="auth.html#.updateUserWithToken">updateUserWithToken</a></li></ul></li><li><a href="cache.html">cache</a><ul class='methods'><li data-type='method'><a href="cache.html#.get">get</a></li><li data-type='method'><a href="cache.html#.reset">reset</a></li></ul></li><li><a href="content.html">content</a><ul class='methods'><li data-type='method'><a href="content.html#.create">create</a></li><li data-type='method'><a href="content.html#.delete">delete</a></li><li data-type='method'><a href="content.html#.get">get</a></li><li data-type='method'><a href="content.html#.getFromSlug">getFromSlug</a></li><li data-type='method'><a href="content.html#.glossary">glossary</a></li><li data-type='method'><a href="content.html#.list">list</a></li><li data-type='method'><a href="content.html#.patch">patch</a></li><li data-type='method'><a href="content.html#.restore">restore</a></li><li data-type='method'><a href="content.html#.scopeGlossary">scopeGlossary</a></li><li data-type='method'><a href="content.html#.update">update</a></li><li data-type='method'><a href="content.html#.validateField">validateField</a></li><li data-type='method'><a href="content.html#.variables">variables</a></li></ul></li><li><a href="files.html">files</a><ul class='methods'><li data-type='method'><a href="files.html#.downloadUrl">downloadUrl</a></li><li data-type='method'><a href="files.html#.duration">duration</a></li><li data-type='method'><a href="files.html#.filesize">filesize</a></li><li data-type='method'><a href="files.html#.getBinaryTypeFromMime">getBinaryTypeFromMime</a></li><li data-type='method'><a href="files.html#.mediaUrl">mediaUrl</a></li></ul></li><li><a href="filter.html">filter</a><ul class='methods'><li data-type='method'><a href="filter.html#.activeFilterComparators">activeFilterComparators</a></li><li data-type='method'><a href="filter.html#.activeFilterKeys">activeFilterKeys</a></li><li data-type='method'><a href="filter.html#.activeFilterOperators">activeFilterOperators</a></li><li data-type='method'><a href="filter.html#.activeFilters">activeFilters</a></li><li data-type='method'><a href="filter.html#.activeFilterValues">activeFilterValues</a></li><li data-type='method'><a href="filter.html#.filterChangeString">filterChangeString</a></li><li data-type='method'><a href="filter.html#.isValidFilter">isValidFilter</a></li></ul></li><li><a href="geo.html">geo</a><ul class='methods'><li data-type='method'><a href="geo.html#.distance">distance</a></li><li data-type='method'><a href="geo.html#.getDefaultCountry">getDefaultCountry</a></li><li data-type='method'><a href="geo.html#.getDefaultTimezone">getDefaultTimezone</a></li><li data-type='method'><a href="geo.html#.getPosition">getPosition</a></li><li data-type='method'><a href="geo.html#.stopWatchPosition">stopWatchPosition</a></li><li data-type='method'><a href="geo.html#.watchPosition">watchPosition</a></li></ul></li><li><a href="module-QikStorage-CookieStorageAdapter.html">CookieStorageAdapter</a><ul class='methods'><li data-type='method'><a href="module-QikStorage-CookieStorageAdapter.html#getCookieOptions">getCookieOptions</a></li><li data-type='method'><a href="module-QikStorage-CookieStorageAdapter.html#isCookieMode">isCookieMode</a></li></ul></li><li><a href="module-QikStorage-LocalStorageAdapter.html">LocalStorageAdapter</a></li><li><a href="module-QikStorage-StorageAdapter.html">StorageAdapter</a><ul class='methods'><li data-type='method'><a href="module-QikStorage-StorageAdapter.html#clearUser">clearUser</a></li><li data-type='method'><a href="module-QikStorage-StorageAdapter.html#getAccessToken">getAccessToken</a></li><li data-type='method'><a href="module-QikStorage-StorageAdapter.html#getRefreshToken">getRefreshToken</a></li><li data-type='method'><a href="module-QikStorage-StorageAdapter.html#getTokenExpiry">getTokenExpiry</a></li><li data-type='method'><a href="module-QikStorage-StorageAdapter.html#getUser">getUser</a></li><li data-type='method'><a href="module-QikStorage-StorageAdapter.html#isAvailable">isAvailable</a></li><li data-type='method'><a href="module-QikStorage-StorageAdapter.html#setUser">setUser</a></li></ul></li><li><a href="socket.html">socket</a><ul class='methods'><li data-type='method'><a href="socket.html#.channel">channel</a></li><li data-type='method'><a href="socket.html#.close">close</a></li><li data-type='method'><a href="socket.html#.connect">connect</a></li><li data-type='method'><a href="socket.html#.reconnect">reconnect</a></li><li data-type='method'><a href="socket.html#.subscribe">subscribe</a></li><li data-type='method'><a href="socket.html#.unsubscribe">unsubscribe</a></li></ul></li><li><a href="system.html">system</a><ul class='methods'><li data-type='method'><a href="system.html#.countries">countries</a></li></ul></li><li><a href="utils.html">utils</a><ul class='methods'><li data-type='method'><a href="utils.html#.cleanValue">cleanValue</a></li><li data-type='method'><a href="utils.html#.comma">comma</a></li><li data-type='method'><a href="utils.html#.errorMessage">errorMessage</a></li><li data-type='method'><a href="utils.html#.exists">exists</a></li><li data-type='method'><a href="utils.html#.extractFromArray">extractFromArray</a></li><li data-type='method'><a href="utils.html#.formatCurrency">formatCurrency</a></li><li data-type='method'><a href="utils.html#.getTypeFromID">getTypeFromID</a></li><li data-type='method'><a href="utils.html#.guid">guid</a></li><li data-type='method'><a href="utils.html#.hash">hash</a></li><li data-type='method'><a href="utils.html#.id">id</a></li><li data-type='method'><a href="utils.html#.ids">ids</a></li><li data-type='method'><a href="utils.html#.isValidEmailAddress">isValidEmailAddress</a></li><li data-type='method'><a href="utils.html#.loadExternalScript">loadExternalScript</a></li><li data-type='method'><a href="utils.html#.loadExternalStyle">loadExternalStyle</a></li><li data-type='method'><a href="utils.html#.machineName">machineName</a></li><li data-type='method'><a href="utils.html#.mapParameters">mapParameters</a></li><li data-type='method'><a href="utils.html#.matchInArray">matchInArray</a></li><li data-type='method'><a href="utils.html#.parseBoolean">parseBoolean</a></li><li data-type='method'><a href="utils.html#.parseDate">parseDate</a></li><li data-type='method'><a href="utils.html#.parseEmail">parseEmail</a></li><li data-type='method'><a href="utils.html#.parseInt">parseInt</a></li><li data-type='method'><a href="utils.html#.parseNumber">parseNumber</a></li><li data-type='method'><a href="utils.html#.parseURL">parseURL</a></li></ul></li></ul><h3>Modules</h3><ul><li><a href="module-QikStorage.html">QikStorage</a><ul class='methods'><li data-type='method'><a href="module-QikStorage.html#.createStorageAdapter">createStorageAdapter</a></li></ul></li></ul><h3>Global</h3><ul><li><a href="global.html#EventDispatcher">EventDispatcher</a></li></ul>
31
31
  </nav>
32
32
 
33
33
  <div id="main">
@@ -167,7 +167,7 @@
167
167
 
168
168
 
169
169
 
170
- <h4 class="name" id=".activeFilterKeys"><span class="type-signature">(static) </span>activeFilterKeys<span class="signature">(filterConfiguration)</span><span class="type-signature"></span></h4>
170
+ <h4 class="name" id=".activeFilterComparators"><span class="type-signature">(static) </span>activeFilterComparators<span class="signature">(filterConfiguration)</span><span class="type-signature"></span></h4>
171
171
 
172
172
 
173
173
 
@@ -179,7 +179,7 @@
179
179
 
180
180
  <dt class="tag-source">Source:</dt>
181
181
  <dd class="tag-source"><ul class="dummy"><li>
182
- <a href="qik.filter.js.html">qik.filter.js</a>, <a href="qik.filter.js.html#line301">line 301</a>
182
+ <a href="qik.filter.js.html">qik.filter.js</a>, <a href="qik.filter.js.html#line361">line 361</a>
183
183
  </li></ul></dd>
184
184
 
185
185
 
@@ -219,7 +219,7 @@
219
219
 
220
220
 
221
221
  <div class="description usertext">
222
- Returns an array of all keys that are being actively filtered on
222
+ Returns an array of all comparators that are being actively filtered
223
223
  </div>
224
224
 
225
225
 
@@ -258,7 +258,7 @@
258
258
  }
259
259
 
260
260
  const activeFilters = sdk.filter.activeFilterKeys(filterConfiguration);
261
- // Returns ['formData.person.firstName', 'formData.person.lastName']</code></pre>
261
+ // Returns ['startswith', 'endswith']</code></pre>
262
262
 
263
263
 
264
264
 
@@ -346,7 +346,7 @@ const activeFilters = sdk.filter.activeFilterKeys(filterConfiguration);
346
346
 
347
347
  <dt class="tag-source">Source:</dt>
348
348
  <dd class="tag-source"><ul class="dummy"><li>
349
- <a href="qik.filter.js.html">qik.filter.js</a>, <a href="qik.filter.js.html#line361">line 361</a>
349
+ <a href="qik.filter.js.html">qik.filter.js</a>, <a href="qik.filter.js.html#line301">line 301</a>
350
350
  </li></ul></dd>
351
351
 
352
352
 
@@ -386,7 +386,7 @@ const activeFilters = sdk.filter.activeFilterKeys(filterConfiguration);
386
386
 
387
387
 
388
388
  <div class="description usertext">
389
- Returns an array of all comparators that are being actively filtered
389
+ Returns an array of all keys that are being actively filtered on
390
390
  </div>
391
391
 
392
392
 
@@ -425,7 +425,7 @@ const activeFilters = sdk.filter.activeFilterKeys(filterConfiguration);
425
425
  }
426
426
 
427
427
  const activeFilters = sdk.filter.activeFilterKeys(filterConfiguration);
428
- // Returns ['startswith', 'endswith']</code></pre>
428
+ // Returns ['formData.person.firstName', 'formData.person.lastName']</code></pre>
429
429
 
430
430
 
431
431
 
@@ -501,7 +501,7 @@ const activeFilters = sdk.filter.activeFilterKeys(filterConfiguration);
501
501
 
502
502
 
503
503
 
504
- <h4 class="name" id=".activeFilterKeys"><span class="type-signature">(static) </span>activeFilterKeys<span class="signature">(filterConfiguration)</span><span class="type-signature"></span></h4>
504
+ <h4 class="name" id=".activeFilterOperators"><span class="type-signature">(static) </span>activeFilterOperators<span class="signature">(filterConfiguration)</span><span class="type-signature"></span></h4>
505
505
 
506
506
 
507
507
 
@@ -513,7 +513,7 @@ const activeFilters = sdk.filter.activeFilterKeys(filterConfiguration);
513
513
 
514
514
  <dt class="tag-source">Source:</dt>
515
515
  <dd class="tag-source"><ul class="dummy"><li>
516
- <a href="qik.filter.js.html">qik.filter.js</a>, <a href="qik.filter.js.html#line301">line 301</a>
516
+ <a href="qik.filter.js.html">qik.filter.js</a>, <a href="qik.filter.js.html#line411">line 411</a>
517
517
  </li></ul></dd>
518
518
 
519
519
 
@@ -553,7 +553,7 @@ const activeFilters = sdk.filter.activeFilterKeys(filterConfiguration);
553
553
 
554
554
 
555
555
  <div class="description usertext">
556
- Returns an array of all keys that are being actively filtered on
556
+ Returns an array of all comparators that are being actively filtered
557
557
  </div>
558
558
 
559
559
 
@@ -570,7 +570,7 @@ const activeFilters = sdk.filter.activeFilterKeys(filterConfiguration);
570
570
  "operator": "and",
571
571
  "filters": [
572
572
  {
573
- "operator": "and",
573
+ "operator": "nor",
574
574
  "filters": [
575
575
  {
576
576
  "key": "formData.person.firstName",
@@ -591,8 +591,8 @@ const activeFilters = sdk.filter.activeFilterKeys(filterConfiguration);
591
591
  ]
592
592
  }
593
593
 
594
- const activeFilters = sdk.filter.activeFilterKeys(filterConfiguration);
595
- // Returns ['formData.person.firstName', 'formData.person.lastName']</code></pre>
594
+ const activeFilterOperators = sdk.filter.activeFilterOperators(filterConfiguration);
595
+ // Returns ['and', 'nor']</code></pre>
596
596
 
597
597
 
598
598
 
@@ -668,7 +668,7 @@ const activeFilters = sdk.filter.activeFilterKeys(filterConfiguration);
668
668
 
669
669
 
670
670
 
671
- <h4 class="name" id=".activeFilterKeys"><span class="type-signature">(static) </span>activeFilterKeys<span class="signature">(filterConfiguration)</span><span class="type-signature"></span></h4>
671
+ <h4 class="name" id=".activeFilters"><span class="type-signature">(static) </span>activeFilters<span class="signature">(filterConfiguration)</span><span class="type-signature"></span></h4>
672
672
 
673
673
 
674
674
 
@@ -680,7 +680,7 @@ const activeFilters = sdk.filter.activeFilterKeys(filterConfiguration);
680
680
 
681
681
  <dt class="tag-source">Source:</dt>
682
682
  <dd class="tag-source"><ul class="dummy"><li>
683
- <a href="qik.filter.js.html">qik.filter.js</a>, <a href="qik.filter.js.html#line361">line 361</a>
683
+ <a href="qik.filter.js.html">qik.filter.js</a>, <a href="qik.filter.js.html#line234">line 234</a>
684
684
  </li></ul></dd>
685
685
 
686
686
 
@@ -720,7 +720,7 @@ const activeFilters = sdk.filter.activeFilterKeys(filterConfiguration);
720
720
 
721
721
 
722
722
  <div class="description usertext">
723
- Returns an array of all comparators that are being actively filtered
723
+ Returns an array of all active filters
724
724
  </div>
725
725
 
726
726
 
@@ -758,175 +758,19 @@ const activeFilters = sdk.filter.activeFilterKeys(filterConfiguration);
758
758
  ]
759
759
  }
760
760
 
761
- const activeFilters = sdk.filter.activeFilterKeys(filterConfiguration);
762
- // Returns ['startswith', 'endswith']</code></pre>
763
-
764
-
765
-
766
-
767
- <h5>Parameters:</h5>
768
-
769
-
770
- <table class="params">
771
- <thead>
772
- <tr>
773
-
774
- <th>Name</th>
775
-
776
-
777
- <th>Type</th>
778
-
779
-
780
-
781
-
782
-
783
- <th class="last">Description</th>
784
- </tr>
785
- </thead>
786
-
787
- <tbody>
788
-
789
-
790
- <tr>
791
-
792
- <td class="name"><code>filterConfiguration</code></td>
793
-
794
-
795
- <td class="type">
796
-
797
-
798
- <span class="param-type">Object</span>
799
-
800
-
801
-
802
- </td>
803
-
804
-
805
-
806
-
807
-
808
- <td class="description last">A filter configuration object</td>
809
- </tr>
810
-
811
-
812
- </tbody>
813
- </table>
814
-
815
-
816
-
817
-
818
-
819
-
820
-
821
-
822
-
823
-
824
-
825
-
826
-
827
-
828
-
829
-
830
-
831
-
832
-
833
-
834
-
835
-
836
-
837
-
838
- <h4 class="name" id=".activeFilterOperators"><span class="type-signature">(static) </span>activeFilterOperators<span class="signature">(filterConfiguration)</span><span class="type-signature"></span></h4>
839
-
840
-
841
-
842
-
843
-
844
-
845
- <dl class="details">
846
-
847
-
848
- <dt class="tag-source">Source:</dt>
849
- <dd class="tag-source"><ul class="dummy"><li>
850
- <a href="qik.filter.js.html">qik.filter.js</a>, <a href="qik.filter.js.html#line411">line 411</a>
851
- </li></ul></dd>
852
-
853
-
854
-
855
-
856
-
857
-
858
-
859
-
860
-
861
-
862
-
863
-
864
-
865
-
866
-
867
-
868
-
869
-
870
-
871
-
872
-
873
-
874
-
875
-
876
-
877
-
878
-
879
-
880
-
881
-
882
-
883
- </dl>
884
-
885
-
886
-
887
-
888
-
889
- <div class="description usertext">
890
- Returns an array of all comparators that are being actively filtered
891
- </div>
892
-
893
-
894
-
895
-
896
-
897
-
898
-
899
-
761
+ const activeFilters = sdk.filter.activeFilters(filterConfiguration);
900
762
 
901
- <h5>Example</h5>
902
-
903
- <pre class="prettyprint"><code>const filterConfiguration = {
904
- "operator": "and",
905
- "filters": [
906
- {
907
- "operator": "nor",
908
- "filters": [
763
+ const returns = [
909
764
  {
910
765
  "key": "formData.person.firstName",
911
766
  "comparator": "startswith",
912
767
  "value": "c"
913
- },
914
- {
915
- "key": "invalid no comparator",
916
- "value": "e"
917
- }
768
+ },
918
769
  {
919
770
  "key": "formData.person.lastName",
920
771
  "comparator": "endswith",
921
772
  "value": "e"
922
- }
923
- ]
924
- }
925
- ]
926
- }
927
-
928
- const activeFilterOperators = sdk.filter.activeFilterOperators(filterConfiguration);
929
- // Returns ['and', 'nor']</code></pre>
773
+ }]</code></pre>
930
774
 
931
775
 
932
776
 
@@ -1002,7 +846,7 @@ const activeFilterOperators = sdk.filter.activeFilterOperators(filterConfigurati
1002
846
 
1003
847
 
1004
848
 
1005
- <h4 class="name" id=".activeFilterOperators"><span class="type-signature">(static) </span>activeFilterOperators<span class="signature">(filterConfiguration)</span><span class="type-signature"></span></h4>
849
+ <h4 class="name" id=".activeFilterValues"><span class="type-signature">(static) </span>activeFilterValues<span class="signature">(filterConfiguration)</span><span class="type-signature"></span></h4>
1006
850
 
1007
851
 
1008
852
 
@@ -1014,7 +858,7 @@ const activeFilterOperators = sdk.filter.activeFilterOperators(filterConfigurati
1014
858
 
1015
859
  <dt class="tag-source">Source:</dt>
1016
860
  <dd class="tag-source"><ul class="dummy"><li>
1017
- <a href="qik.filter.js.html">qik.filter.js</a>, <a href="qik.filter.js.html#line411">line 411</a>
861
+ <a href="qik.filter.js.html">qik.filter.js</a>, <a href="qik.filter.js.html#line461">line 461</a>
1018
862
  </li></ul></dd>
1019
863
 
1020
864
 
@@ -1054,7 +898,7 @@ const activeFilterOperators = sdk.filter.activeFilterOperators(filterConfigurati
1054
898
 
1055
899
 
1056
900
  <div class="description usertext">
1057
- Returns an array of all comparators that are being actively filtered
901
+ Returns an array of all values that are being actively used by a filter
1058
902
  </div>
1059
903
 
1060
904
 
@@ -1085,15 +929,15 @@ const activeFilterOperators = sdk.filter.activeFilterOperators(filterConfigurati
1085
929
  {
1086
930
  "key": "formData.person.lastName",
1087
931
  "comparator": "endswith",
1088
- "value": "e"
932
+ "value": "a"
1089
933
  }
1090
934
  ]
1091
935
  }
1092
936
  ]
1093
937
  }
1094
938
 
1095
- const activeFilterOperators = sdk.filter.activeFilterOperators(filterConfiguration);
1096
- // Returns ['and', 'nor']</code></pre>
939
+ const activeFilterValues = sdk.filter.activeFilterValues(filterConfiguration);
940
+ // Returns ['c', 'a']</code></pre>
1097
941
 
1098
942
 
1099
943
 
@@ -1169,7 +1013,7 @@ const activeFilterOperators = sdk.filter.activeFilterOperators(filterConfigurati
1169
1013
 
1170
1014
 
1171
1015
 
1172
- <h4 class="name" id=".activeFilters"><span class="type-signature">(static) </span>activeFilters<span class="signature">(filterConfiguration)</span><span class="type-signature"></span></h4>
1016
+ <h4 class="name" id=".filterChangeString"><span class="type-signature">(static) </span>filterChangeString<span class="signature">(filterConfiguration)</span><span class="type-signature"></span></h4>
1173
1017
 
1174
1018
 
1175
1019
 
@@ -1181,7 +1025,7 @@ const activeFilterOperators = sdk.filter.activeFilterOperators(filterConfigurati
1181
1025
 
1182
1026
  <dt class="tag-source">Source:</dt>
1183
1027
  <dd class="tag-source"><ul class="dummy"><li>
1184
- <a href="qik.filter.js.html">qik.filter.js</a>, <a href="qik.filter.js.html#line234">line 234</a>
1028
+ <a href="qik.filter.js.html">qik.filter.js</a>, <a href="qik.filter.js.html#line528">line 528</a>
1185
1029
  </li></ul></dd>
1186
1030
 
1187
1031
 
@@ -1221,7 +1065,8 @@ const activeFilterOperators = sdk.filter.activeFilterOperators(filterConfigurati
1221
1065
 
1222
1066
 
1223
1067
  <div class="description usertext">
1224
- Returns an array of all active filters
1068
+ Returns an string representation of a filter configuration.
1069
+ Often used to check if a user has changed the filter in any way, the string only takes into consideration active valid filters
1225
1070
  </div>
1226
1071
 
1227
1072
 
@@ -1238,7 +1083,7 @@ const activeFilterOperators = sdk.filter.activeFilterOperators(filterConfigurati
1238
1083
  "operator": "and",
1239
1084
  "filters": [
1240
1085
  {
1241
- "operator": "and",
1086
+ "operator": "nor",
1242
1087
  "filters": [
1243
1088
  {
1244
1089
  "key": "formData.person.firstName",
@@ -1252,26 +1097,15 @@ const activeFilterOperators = sdk.filter.activeFilterOperators(filterConfigurati
1252
1097
  {
1253
1098
  "key": "formData.person.lastName",
1254
1099
  "comparator": "endswith",
1255
- "value": "e"
1100
+ "value": "a"
1256
1101
  }
1257
1102
  ]
1258
1103
  }
1259
1104
  ]
1260
1105
  }
1261
1106
 
1262
- const activeFilters = sdk.filter.activeFilters(filterConfiguration);
1263
-
1264
- const returns = [
1265
- {
1266
- "key": "formData.person.firstName",
1267
- "comparator": "startswith",
1268
- "value": "c"
1269
- },
1270
- {
1271
- "key": "formData.person.lastName",
1272
- "comparator": "endswith",
1273
- "value": "e"
1274
- }]</code></pre>
1107
+ // Watch this string for changes
1108
+ const changeString = sdk.filter.filterChangeString(filterConfiguration); </code></pre>
1275
1109
 
1276
1110
 
1277
1111
 
@@ -1343,3458 +1177,6 @@ const returns = [
1343
1177
 
1344
1178
 
1345
1179
 
1346
-
1347
-
1348
-
1349
-
1350
- <h4 class="name" id=".activeFilters"><span class="type-signature">(static) </span>activeFilters<span class="signature">(filterConfiguration)</span><span class="type-signature"></span></h4>
1351
-
1352
-
1353
-
1354
-
1355
-
1356
-
1357
- <dl class="details">
1358
-
1359
-
1360
- <dt class="tag-source">Source:</dt>
1361
- <dd class="tag-source"><ul class="dummy"><li>
1362
- <a href="qik.filter.js.html">qik.filter.js</a>, <a href="qik.filter.js.html#line234">line 234</a>
1363
- </li></ul></dd>
1364
-
1365
-
1366
-
1367
-
1368
-
1369
-
1370
-
1371
-
1372
-
1373
-
1374
-
1375
-
1376
-
1377
-
1378
-
1379
-
1380
-
1381
-
1382
-
1383
-
1384
-
1385
-
1386
-
1387
-
1388
-
1389
-
1390
-
1391
-
1392
-
1393
-
1394
-
1395
- </dl>
1396
-
1397
-
1398
-
1399
-
1400
-
1401
- <div class="description usertext">
1402
- Returns an array of all active filters
1403
- </div>
1404
-
1405
-
1406
-
1407
-
1408
-
1409
-
1410
-
1411
-
1412
-
1413
- <h5>Example</h5>
1414
-
1415
- <pre class="prettyprint"><code>const filterConfiguration = {
1416
- "operator": "and",
1417
- "filters": [
1418
- {
1419
- "operator": "and",
1420
- "filters": [
1421
- {
1422
- "key": "formData.person.firstName",
1423
- "comparator": "startswith",
1424
- "value": "c"
1425
- },
1426
- {
1427
- "key": "invalid no comparator",
1428
- "value": "e"
1429
- }
1430
- {
1431
- "key": "formData.person.lastName",
1432
- "comparator": "endswith",
1433
- "value": "e"
1434
- }
1435
- ]
1436
- }
1437
- ]
1438
- }
1439
-
1440
- const activeFilters = sdk.filter.activeFilters(filterConfiguration);
1441
-
1442
- const returns = [
1443
- {
1444
- "key": "formData.person.firstName",
1445
- "comparator": "startswith",
1446
- "value": "c"
1447
- },
1448
- {
1449
- "key": "formData.person.lastName",
1450
- "comparator": "endswith",
1451
- "value": "e"
1452
- }]</code></pre>
1453
-
1454
-
1455
-
1456
-
1457
- <h5>Parameters:</h5>
1458
-
1459
-
1460
- <table class="params">
1461
- <thead>
1462
- <tr>
1463
-
1464
- <th>Name</th>
1465
-
1466
-
1467
- <th>Type</th>
1468
-
1469
-
1470
-
1471
-
1472
-
1473
- <th class="last">Description</th>
1474
- </tr>
1475
- </thead>
1476
-
1477
- <tbody>
1478
-
1479
-
1480
- <tr>
1481
-
1482
- <td class="name"><code>filterConfiguration</code></td>
1483
-
1484
-
1485
- <td class="type">
1486
-
1487
-
1488
- <span class="param-type">Object</span>
1489
-
1490
-
1491
-
1492
- </td>
1493
-
1494
-
1495
-
1496
-
1497
-
1498
- <td class="description last">A filter configuration object</td>
1499
- </tr>
1500
-
1501
-
1502
- </tbody>
1503
- </table>
1504
-
1505
-
1506
-
1507
-
1508
-
1509
-
1510
-
1511
-
1512
-
1513
-
1514
-
1515
-
1516
-
1517
-
1518
-
1519
-
1520
-
1521
-
1522
-
1523
-
1524
-
1525
-
1526
-
1527
-
1528
- <h4 class="name" id=".activeFilterValues"><span class="type-signature">(static) </span>activeFilterValues<span class="signature">(filterConfiguration)</span><span class="type-signature"></span></h4>
1529
-
1530
-
1531
-
1532
-
1533
-
1534
-
1535
- <dl class="details">
1536
-
1537
-
1538
- <dt class="tag-source">Source:</dt>
1539
- <dd class="tag-source"><ul class="dummy"><li>
1540
- <a href="qik.filter.js.html">qik.filter.js</a>, <a href="qik.filter.js.html#line461">line 461</a>
1541
- </li></ul></dd>
1542
-
1543
-
1544
-
1545
-
1546
-
1547
-
1548
-
1549
-
1550
-
1551
-
1552
-
1553
-
1554
-
1555
-
1556
-
1557
-
1558
-
1559
-
1560
-
1561
-
1562
-
1563
-
1564
-
1565
-
1566
-
1567
-
1568
-
1569
-
1570
-
1571
-
1572
-
1573
- </dl>
1574
-
1575
-
1576
-
1577
-
1578
-
1579
- <div class="description usertext">
1580
- Returns an array of all values that are being actively used by a filter
1581
- </div>
1582
-
1583
-
1584
-
1585
-
1586
-
1587
-
1588
-
1589
-
1590
-
1591
- <h5>Example</h5>
1592
-
1593
- <pre class="prettyprint"><code>const filterConfiguration = {
1594
- "operator": "and",
1595
- "filters": [
1596
- {
1597
- "operator": "nor",
1598
- "filters": [
1599
- {
1600
- "key": "formData.person.firstName",
1601
- "comparator": "startswith",
1602
- "value": "c"
1603
- },
1604
- {
1605
- "key": "invalid no comparator",
1606
- "value": "e"
1607
- }
1608
- {
1609
- "key": "formData.person.lastName",
1610
- "comparator": "endswith",
1611
- "value": "a"
1612
- }
1613
- ]
1614
- }
1615
- ]
1616
- }
1617
-
1618
- const activeFilterValues = sdk.filter.activeFilterValues(filterConfiguration);
1619
- // Returns ['c', 'a']</code></pre>
1620
-
1621
-
1622
-
1623
-
1624
- <h5>Parameters:</h5>
1625
-
1626
-
1627
- <table class="params">
1628
- <thead>
1629
- <tr>
1630
-
1631
- <th>Name</th>
1632
-
1633
-
1634
- <th>Type</th>
1635
-
1636
-
1637
-
1638
-
1639
-
1640
- <th class="last">Description</th>
1641
- </tr>
1642
- </thead>
1643
-
1644
- <tbody>
1645
-
1646
-
1647
- <tr>
1648
-
1649
- <td class="name"><code>filterConfiguration</code></td>
1650
-
1651
-
1652
- <td class="type">
1653
-
1654
-
1655
- <span class="param-type">Object</span>
1656
-
1657
-
1658
-
1659
- </td>
1660
-
1661
-
1662
-
1663
-
1664
-
1665
- <td class="description last">A filter configuration object</td>
1666
- </tr>
1667
-
1668
-
1669
- </tbody>
1670
- </table>
1671
-
1672
-
1673
-
1674
-
1675
-
1676
-
1677
-
1678
-
1679
-
1680
-
1681
-
1682
-
1683
-
1684
-
1685
-
1686
-
1687
-
1688
-
1689
-
1690
-
1691
-
1692
-
1693
-
1694
-
1695
- <h4 class="name" id=".activeFilterValues"><span class="type-signature">(static) </span>activeFilterValues<span class="signature">(filterConfiguration)</span><span class="type-signature"></span></h4>
1696
-
1697
-
1698
-
1699
-
1700
-
1701
-
1702
- <dl class="details">
1703
-
1704
-
1705
- <dt class="tag-source">Source:</dt>
1706
- <dd class="tag-source"><ul class="dummy"><li>
1707
- <a href="qik.filter.js.html">qik.filter.js</a>, <a href="qik.filter.js.html#line461">line 461</a>
1708
- </li></ul></dd>
1709
-
1710
-
1711
-
1712
-
1713
-
1714
-
1715
-
1716
-
1717
-
1718
-
1719
-
1720
-
1721
-
1722
-
1723
-
1724
-
1725
-
1726
-
1727
-
1728
-
1729
-
1730
-
1731
-
1732
-
1733
-
1734
-
1735
-
1736
-
1737
-
1738
-
1739
-
1740
- </dl>
1741
-
1742
-
1743
-
1744
-
1745
-
1746
- <div class="description usertext">
1747
- Returns an array of all values that are being actively used by a filter
1748
- </div>
1749
-
1750
-
1751
-
1752
-
1753
-
1754
-
1755
-
1756
-
1757
-
1758
- <h5>Example</h5>
1759
-
1760
- <pre class="prettyprint"><code>const filterConfiguration = {
1761
- "operator": "and",
1762
- "filters": [
1763
- {
1764
- "operator": "nor",
1765
- "filters": [
1766
- {
1767
- "key": "formData.person.firstName",
1768
- "comparator": "startswith",
1769
- "value": "c"
1770
- },
1771
- {
1772
- "key": "invalid no comparator",
1773
- "value": "e"
1774
- }
1775
- {
1776
- "key": "formData.person.lastName",
1777
- "comparator": "endswith",
1778
- "value": "a"
1779
- }
1780
- ]
1781
- }
1782
- ]
1783
- }
1784
-
1785
- const activeFilterValues = sdk.filter.activeFilterValues(filterConfiguration);
1786
- // Returns ['c', 'a']</code></pre>
1787
-
1788
-
1789
-
1790
-
1791
- <h5>Parameters:</h5>
1792
-
1793
-
1794
- <table class="params">
1795
- <thead>
1796
- <tr>
1797
-
1798
- <th>Name</th>
1799
-
1800
-
1801
- <th>Type</th>
1802
-
1803
-
1804
-
1805
-
1806
-
1807
- <th class="last">Description</th>
1808
- </tr>
1809
- </thead>
1810
-
1811
- <tbody>
1812
-
1813
-
1814
- <tr>
1815
-
1816
- <td class="name"><code>filterConfiguration</code></td>
1817
-
1818
-
1819
- <td class="type">
1820
-
1821
-
1822
- <span class="param-type">Object</span>
1823
-
1824
-
1825
-
1826
- </td>
1827
-
1828
-
1829
-
1830
-
1831
-
1832
- <td class="description last">A filter configuration object</td>
1833
- </tr>
1834
-
1835
-
1836
- </tbody>
1837
- </table>
1838
-
1839
-
1840
-
1841
-
1842
-
1843
-
1844
-
1845
-
1846
-
1847
-
1848
-
1849
-
1850
-
1851
-
1852
-
1853
-
1854
-
1855
-
1856
-
1857
-
1858
-
1859
-
1860
-
1861
-
1862
- <h4 class="name" id=".filterChangeString"><span class="type-signature">(static) </span>filterChangeString<span class="signature">(filterConfiguration)</span><span class="type-signature"></span></h4>
1863
-
1864
-
1865
-
1866
-
1867
-
1868
-
1869
- <dl class="details">
1870
-
1871
-
1872
- <dt class="tag-source">Source:</dt>
1873
- <dd class="tag-source"><ul class="dummy"><li>
1874
- <a href="qik.filter.js.html">qik.filter.js</a>, <a href="qik.filter.js.html#line528">line 528</a>
1875
- </li></ul></dd>
1876
-
1877
-
1878
-
1879
-
1880
-
1881
-
1882
-
1883
-
1884
-
1885
-
1886
-
1887
-
1888
-
1889
-
1890
-
1891
-
1892
-
1893
-
1894
-
1895
-
1896
-
1897
-
1898
-
1899
-
1900
-
1901
-
1902
-
1903
-
1904
-
1905
-
1906
-
1907
- </dl>
1908
-
1909
-
1910
-
1911
-
1912
-
1913
- <div class="description usertext">
1914
- Returns an string representation of a filter configuration.
1915
- Often used to check if a user has changed the filter in any way, the string only takes into consideration active valid filters
1916
- </div>
1917
-
1918
-
1919
-
1920
-
1921
-
1922
-
1923
-
1924
-
1925
-
1926
- <h5>Example</h5>
1927
-
1928
- <pre class="prettyprint"><code>const filterConfiguration = {
1929
- "operator": "and",
1930
- "filters": [
1931
- {
1932
- "operator": "nor",
1933
- "filters": [
1934
- {
1935
- "key": "formData.person.firstName",
1936
- "comparator": "startswith",
1937
- "value": "c"
1938
- },
1939
- {
1940
- "key": "invalid no comparator",
1941
- "value": "e"
1942
- }
1943
- {
1944
- "key": "formData.person.lastName",
1945
- "comparator": "endswith",
1946
- "value": "a"
1947
- }
1948
- ]
1949
- }
1950
- ]
1951
- }
1952
-
1953
- // Watch this string for changes
1954
- const changeString = sdk.filter.filterChangeString(filterConfiguration); </code></pre>
1955
-
1956
-
1957
-
1958
-
1959
- <h5>Parameters:</h5>
1960
-
1961
-
1962
- <table class="params">
1963
- <thead>
1964
- <tr>
1965
-
1966
- <th>Name</th>
1967
-
1968
-
1969
- <th>Type</th>
1970
-
1971
-
1972
-
1973
-
1974
-
1975
- <th class="last">Description</th>
1976
- </tr>
1977
- </thead>
1978
-
1979
- <tbody>
1980
-
1981
-
1982
- <tr>
1983
-
1984
- <td class="name"><code>filterConfiguration</code></td>
1985
-
1986
-
1987
- <td class="type">
1988
-
1989
-
1990
- <span class="param-type">Object</span>
1991
-
1992
-
1993
-
1994
- </td>
1995
-
1996
-
1997
-
1998
-
1999
-
2000
- <td class="description last">A filter configuration object</td>
2001
- </tr>
2002
-
2003
-
2004
- </tbody>
2005
- </table>
2006
-
2007
-
2008
-
2009
-
2010
-
2011
-
2012
-
2013
-
2014
-
2015
-
2016
-
2017
-
2018
-
2019
-
2020
-
2021
-
2022
-
2023
-
2024
-
2025
-
2026
-
2027
-
2028
-
2029
-
2030
- <h4 class="name" id=".filterChangeString"><span class="type-signature">(static) </span>filterChangeString<span class="signature">(filterConfiguration)</span><span class="type-signature"></span></h4>
2031
-
2032
-
2033
-
2034
-
2035
-
2036
-
2037
- <dl class="details">
2038
-
2039
-
2040
- <dt class="tag-source">Source:</dt>
2041
- <dd class="tag-source"><ul class="dummy"><li>
2042
- <a href="qik.filter.js.html">qik.filter.js</a>, <a href="qik.filter.js.html#line528">line 528</a>
2043
- </li></ul></dd>
2044
-
2045
-
2046
-
2047
-
2048
-
2049
-
2050
-
2051
-
2052
-
2053
-
2054
-
2055
-
2056
-
2057
-
2058
-
2059
-
2060
-
2061
-
2062
-
2063
-
2064
-
2065
-
2066
-
2067
-
2068
-
2069
-
2070
-
2071
-
2072
-
2073
-
2074
-
2075
- </dl>
2076
-
2077
-
2078
-
2079
-
2080
-
2081
- <div class="description usertext">
2082
- Returns an string representation of a filter configuration.
2083
- Often used to check if a user has changed the filter in any way, the string only takes into consideration active valid filters
2084
- </div>
2085
-
2086
-
2087
-
2088
-
2089
-
2090
-
2091
-
2092
-
2093
-
2094
- <h5>Example</h5>
2095
-
2096
- <pre class="prettyprint"><code>const filterConfiguration = {
2097
- "operator": "and",
2098
- "filters": [
2099
- {
2100
- "operator": "nor",
2101
- "filters": [
2102
- {
2103
- "key": "formData.person.firstName",
2104
- "comparator": "startswith",
2105
- "value": "c"
2106
- },
2107
- {
2108
- "key": "invalid no comparator",
2109
- "value": "e"
2110
- }
2111
- {
2112
- "key": "formData.person.lastName",
2113
- "comparator": "endswith",
2114
- "value": "a"
2115
- }
2116
- ]
2117
- }
2118
- ]
2119
- }
2120
-
2121
- // Watch this string for changes
2122
- const changeString = sdk.filter.filterChangeString(filterConfiguration); </code></pre>
2123
-
2124
-
2125
-
2126
-
2127
- <h5>Parameters:</h5>
2128
-
2129
-
2130
- <table class="params">
2131
- <thead>
2132
- <tr>
2133
-
2134
- <th>Name</th>
2135
-
2136
-
2137
- <th>Type</th>
2138
-
2139
-
2140
-
2141
-
2142
-
2143
- <th class="last">Description</th>
2144
- </tr>
2145
- </thead>
2146
-
2147
- <tbody>
2148
-
2149
-
2150
- <tr>
2151
-
2152
- <td class="name"><code>filterConfiguration</code></td>
2153
-
2154
-
2155
- <td class="type">
2156
-
2157
-
2158
- <span class="param-type">Object</span>
2159
-
2160
-
2161
-
2162
- </td>
2163
-
2164
-
2165
-
2166
-
2167
-
2168
- <td class="description last">A filter configuration object</td>
2169
- </tr>
2170
-
2171
-
2172
- </tbody>
2173
- </table>
2174
-
2175
-
2176
-
2177
-
2178
-
2179
-
2180
-
2181
-
2182
-
2183
-
2184
-
2185
-
2186
-
2187
-
2188
-
2189
-
2190
-
2191
-
2192
-
2193
-
2194
-
2195
-
2196
-
2197
-
2198
- <h4 class="name" id=".isValidFilter"><span class="type-signature">(static) </span>isValidFilter<span class="signature">(filter)</span><span class="type-signature"></span></h4>
2199
-
2200
-
2201
-
2202
-
2203
-
2204
-
2205
- <dl class="details">
2206
-
2207
-
2208
- <dt class="tag-source">Source:</dt>
2209
- <dd class="tag-source"><ul class="dummy"><li>
2210
- <a href="qik.filter.js.html">qik.filter.js</a>, <a href="qik.filter.js.html#line67">line 67</a>
2211
- </li></ul></dd>
2212
-
2213
-
2214
-
2215
-
2216
-
2217
-
2218
-
2219
-
2220
-
2221
-
2222
-
2223
-
2224
-
2225
-
2226
-
2227
-
2228
-
2229
-
2230
-
2231
-
2232
-
2233
-
2234
-
2235
-
2236
-
2237
-
2238
-
2239
-
2240
-
2241
-
2242
-
2243
- </dl>
2244
-
2245
-
2246
-
2247
-
2248
-
2249
- <div class="description usertext">
2250
- Check if an object is a valid filter
2251
- </div>
2252
-
2253
-
2254
-
2255
-
2256
-
2257
-
2258
-
2259
-
2260
-
2261
- <h5>Example</h5>
2262
-
2263
- <pre class="prettyprint"><code>// Missing a 'key'
2264
- const invalidFilter = sdk.filter.isValidFilter({comparator:'in', values:['Red', 'Green', 'Blue']})
2265
- // returns false
2266
-
2267
- const validFilter = sdk.filter.isValidFilter({key:'favoriteColor', comparator:'in', values:['Red', 'Green', 'Blue']})
2268
- // returns true</code></pre>
2269
-
2270
-
2271
-
2272
-
2273
- <h5>Parameters:</h5>
2274
-
2275
-
2276
- <table class="params">
2277
- <thead>
2278
- <tr>
2279
-
2280
- <th>Name</th>
2281
-
2282
-
2283
- <th>Type</th>
2284
-
2285
-
2286
-
2287
-
2288
-
2289
- <th class="last">Description</th>
2290
- </tr>
2291
- </thead>
2292
-
2293
- <tbody>
2294
-
2295
-
2296
- <tr>
2297
-
2298
- <td class="name"><code>filter</code></td>
2299
-
2300
-
2301
- <td class="type">
2302
-
2303
-
2304
- <span class="param-type">Object</span>
2305
-
2306
-
2307
-
2308
- </td>
2309
-
2310
-
2311
-
2312
-
2313
-
2314
- <td class="description last">The filter block to check</td>
2315
- </tr>
2316
-
2317
-
2318
- </tbody>
2319
- </table>
2320
-
2321
-
2322
-
2323
-
2324
-
2325
-
2326
-
2327
-
2328
-
2329
-
2330
-
2331
-
2332
-
2333
-
2334
-
2335
-
2336
-
2337
-
2338
-
2339
-
2340
-
2341
-
2342
-
2343
-
2344
- <h4 class="name" id=".isValidFilter"><span class="type-signature">(static) </span>isValidFilter<span class="signature">(filter)</span><span class="type-signature"></span></h4>
2345
-
2346
-
2347
-
2348
-
2349
-
2350
-
2351
- <dl class="details">
2352
-
2353
-
2354
- <dt class="tag-source">Source:</dt>
2355
- <dd class="tag-source"><ul class="dummy"><li>
2356
- <a href="qik.filter.js.html">qik.filter.js</a>, <a href="qik.filter.js.html#line67">line 67</a>
2357
- </li></ul></dd>
2358
-
2359
-
2360
-
2361
-
2362
-
2363
-
2364
-
2365
-
2366
-
2367
-
2368
-
2369
-
2370
-
2371
-
2372
-
2373
-
2374
-
2375
-
2376
-
2377
-
2378
-
2379
-
2380
-
2381
-
2382
-
2383
-
2384
-
2385
-
2386
-
2387
-
2388
-
2389
- </dl>
2390
-
2391
-
2392
-
2393
-
2394
-
2395
- <div class="description usertext">
2396
- Check if an object is a valid filter
2397
- </div>
2398
-
2399
-
2400
-
2401
-
2402
-
2403
-
2404
-
2405
-
2406
-
2407
- <h5>Example</h5>
2408
-
2409
- <pre class="prettyprint"><code>// Missing a 'key'
2410
- const invalidFilter = sdk.filter.isValidFilter({comparator:'in', values:['Red', 'Green', 'Blue']})
2411
- // returns false
2412
-
2413
- const validFilter = sdk.filter.isValidFilter({key:'favoriteColor', comparator:'in', values:['Red', 'Green', 'Blue']})
2414
- // returns true</code></pre>
2415
-
2416
-
2417
-
2418
-
2419
- <h5>Parameters:</h5>
2420
-
2421
-
2422
- <table class="params">
2423
- <thead>
2424
- <tr>
2425
-
2426
- <th>Name</th>
2427
-
2428
-
2429
- <th>Type</th>
2430
-
2431
-
2432
-
2433
-
2434
-
2435
- <th class="last">Description</th>
2436
- </tr>
2437
- </thead>
2438
-
2439
- <tbody>
2440
-
2441
-
2442
- <tr>
2443
-
2444
- <td class="name"><code>filter</code></td>
2445
-
2446
-
2447
- <td class="type">
2448
-
2449
-
2450
- <span class="param-type">Object</span>
2451
-
2452
-
2453
-
2454
- </td>
2455
-
2456
-
2457
-
2458
-
2459
-
2460
- <td class="description last">The filter block to check</td>
2461
- </tr>
2462
-
2463
-
2464
- </tbody>
2465
- </table>
2466
-
2467
-
2468
-
2469
-
2470
-
2471
-
2472
-
2473
-
2474
-
2475
-
2476
-
2477
-
2478
-
2479
-
2480
-
2481
-
2482
-
2483
-
2484
-
2485
-
2486
-
2487
-
2488
-
2489
-
2490
-
2491
- </article>
2492
-
2493
- </section>
2494
-
2495
-
2496
-
2497
-
2498
-
2499
-
2500
-
2501
- <section>
2502
-
2503
- <header>
2504
-
2505
- <h2>
2506
- filter
2507
- </h2>
2508
-
2509
- <div class="class-description usertext">Provides functions helpful for interacting with the filtering system</div>
2510
-
2511
-
2512
- </header>
2513
-
2514
- <article>
2515
-
2516
- <div class="container-overview">
2517
-
2518
-
2519
-
2520
-
2521
- <h2>Constructor</h2>
2522
-
2523
-
2524
- <h4 class="name" id="filter"><span class="type-signature"></span>new filter<span class="signature">()</span><span class="type-signature"></span></h4>
2525
-
2526
-
2527
-
2528
-
2529
-
2530
-
2531
- <dl class="details">
2532
-
2533
-
2534
- <dt class="tag-source">Source:</dt>
2535
- <dd class="tag-source"><ul class="dummy"><li>
2536
- <a href="qik.filter.js.html">qik.filter.js</a>, <a href="qik.filter.js.html#line1">line 1</a>
2537
- </li></ul></dd>
2538
-
2539
-
2540
-
2541
-
2542
-
2543
-
2544
-
2545
-
2546
-
2547
-
2548
-
2549
-
2550
-
2551
-
2552
-
2553
-
2554
-
2555
-
2556
-
2557
-
2558
-
2559
-
2560
-
2561
-
2562
-
2563
-
2564
-
2565
-
2566
-
2567
-
2568
-
2569
- </dl>
2570
-
2571
-
2572
-
2573
-
2574
-
2575
-
2576
-
2577
-
2578
-
2579
-
2580
-
2581
-
2582
-
2583
-
2584
-
2585
-
2586
-
2587
-
2588
-
2589
-
2590
-
2591
-
2592
-
2593
-
2594
-
2595
-
2596
-
2597
-
2598
-
2599
-
2600
-
2601
-
2602
-
2603
- </div>
2604
-
2605
-
2606
-
2607
-
2608
-
2609
-
2610
-
2611
-
2612
-
2613
-
2614
-
2615
-
2616
-
2617
-
2618
-
2619
-
2620
-
2621
- <h3 class="subsection-title">Methods</h3>
2622
-
2623
-
2624
-
2625
-
2626
-
2627
-
2628
- <h4 class="name" id=".activeFilterKeys"><span class="type-signature">(static) </span>activeFilterKeys<span class="signature">(filterConfiguration)</span><span class="type-signature"></span></h4>
2629
-
2630
-
2631
-
2632
-
2633
-
2634
-
2635
- <dl class="details">
2636
-
2637
-
2638
- <dt class="tag-source">Source:</dt>
2639
- <dd class="tag-source"><ul class="dummy"><li>
2640
- <a href="qik.filter.js.html">qik.filter.js</a>, <a href="qik.filter.js.html#line301">line 301</a>
2641
- </li></ul></dd>
2642
-
2643
-
2644
-
2645
-
2646
-
2647
-
2648
-
2649
-
2650
-
2651
-
2652
-
2653
-
2654
-
2655
-
2656
-
2657
-
2658
-
2659
-
2660
-
2661
-
2662
-
2663
-
2664
-
2665
-
2666
-
2667
-
2668
-
2669
-
2670
-
2671
-
2672
-
2673
- </dl>
2674
-
2675
-
2676
-
2677
-
2678
-
2679
- <div class="description usertext">
2680
- Returns an array of all keys that are being actively filtered on
2681
- </div>
2682
-
2683
-
2684
-
2685
-
2686
-
2687
-
2688
-
2689
-
2690
-
2691
- <h5>Example</h5>
2692
-
2693
- <pre class="prettyprint"><code>const filterConfiguration = {
2694
- "operator": "and",
2695
- "filters": [
2696
- {
2697
- "operator": "and",
2698
- "filters": [
2699
- {
2700
- "key": "formData.person.firstName",
2701
- "comparator": "startswith",
2702
- "value": "c"
2703
- },
2704
- {
2705
- "key": "invalid no comparator",
2706
- "value": "e"
2707
- }
2708
- {
2709
- "key": "formData.person.lastName",
2710
- "comparator": "endswith",
2711
- "value": "e"
2712
- }
2713
- ]
2714
- }
2715
- ]
2716
- }
2717
-
2718
- const activeFilters = sdk.filter.activeFilterKeys(filterConfiguration);
2719
- // Returns ['formData.person.firstName', 'formData.person.lastName']</code></pre>
2720
-
2721
-
2722
-
2723
-
2724
- <h5>Parameters:</h5>
2725
-
2726
-
2727
- <table class="params">
2728
- <thead>
2729
- <tr>
2730
-
2731
- <th>Name</th>
2732
-
2733
-
2734
- <th>Type</th>
2735
-
2736
-
2737
-
2738
-
2739
-
2740
- <th class="last">Description</th>
2741
- </tr>
2742
- </thead>
2743
-
2744
- <tbody>
2745
-
2746
-
2747
- <tr>
2748
-
2749
- <td class="name"><code>filterConfiguration</code></td>
2750
-
2751
-
2752
- <td class="type">
2753
-
2754
-
2755
- <span class="param-type">Object</span>
2756
-
2757
-
2758
-
2759
- </td>
2760
-
2761
-
2762
-
2763
-
2764
-
2765
- <td class="description last">A filter configuration object</td>
2766
- </tr>
2767
-
2768
-
2769
- </tbody>
2770
- </table>
2771
-
2772
-
2773
-
2774
-
2775
-
2776
-
2777
-
2778
-
2779
-
2780
-
2781
-
2782
-
2783
-
2784
-
2785
-
2786
-
2787
-
2788
-
2789
-
2790
-
2791
-
2792
-
2793
-
2794
-
2795
- <h4 class="name" id=".activeFilterKeys"><span class="type-signature">(static) </span>activeFilterKeys<span class="signature">(filterConfiguration)</span><span class="type-signature"></span></h4>
2796
-
2797
-
2798
-
2799
-
2800
-
2801
-
2802
- <dl class="details">
2803
-
2804
-
2805
- <dt class="tag-source">Source:</dt>
2806
- <dd class="tag-source"><ul class="dummy"><li>
2807
- <a href="qik.filter.js.html">qik.filter.js</a>, <a href="qik.filter.js.html#line361">line 361</a>
2808
- </li></ul></dd>
2809
-
2810
-
2811
-
2812
-
2813
-
2814
-
2815
-
2816
-
2817
-
2818
-
2819
-
2820
-
2821
-
2822
-
2823
-
2824
-
2825
-
2826
-
2827
-
2828
-
2829
-
2830
-
2831
-
2832
-
2833
-
2834
-
2835
-
2836
-
2837
-
2838
-
2839
-
2840
- </dl>
2841
-
2842
-
2843
-
2844
-
2845
-
2846
- <div class="description usertext">
2847
- Returns an array of all comparators that are being actively filtered
2848
- </div>
2849
-
2850
-
2851
-
2852
-
2853
-
2854
-
2855
-
2856
-
2857
-
2858
- <h5>Example</h5>
2859
-
2860
- <pre class="prettyprint"><code>const filterConfiguration = {
2861
- "operator": "and",
2862
- "filters": [
2863
- {
2864
- "operator": "and",
2865
- "filters": [
2866
- {
2867
- "key": "formData.person.firstName",
2868
- "comparator": "startswith",
2869
- "value": "c"
2870
- },
2871
- {
2872
- "key": "invalid no comparator",
2873
- "value": "e"
2874
- }
2875
- {
2876
- "key": "formData.person.lastName",
2877
- "comparator": "endswith",
2878
- "value": "e"
2879
- }
2880
- ]
2881
- }
2882
- ]
2883
- }
2884
-
2885
- const activeFilters = sdk.filter.activeFilterKeys(filterConfiguration);
2886
- // Returns ['startswith', 'endswith']</code></pre>
2887
-
2888
-
2889
-
2890
-
2891
- <h5>Parameters:</h5>
2892
-
2893
-
2894
- <table class="params">
2895
- <thead>
2896
- <tr>
2897
-
2898
- <th>Name</th>
2899
-
2900
-
2901
- <th>Type</th>
2902
-
2903
-
2904
-
2905
-
2906
-
2907
- <th class="last">Description</th>
2908
- </tr>
2909
- </thead>
2910
-
2911
- <tbody>
2912
-
2913
-
2914
- <tr>
2915
-
2916
- <td class="name"><code>filterConfiguration</code></td>
2917
-
2918
-
2919
- <td class="type">
2920
-
2921
-
2922
- <span class="param-type">Object</span>
2923
-
2924
-
2925
-
2926
- </td>
2927
-
2928
-
2929
-
2930
-
2931
-
2932
- <td class="description last">A filter configuration object</td>
2933
- </tr>
2934
-
2935
-
2936
- </tbody>
2937
- </table>
2938
-
2939
-
2940
-
2941
-
2942
-
2943
-
2944
-
2945
-
2946
-
2947
-
2948
-
2949
-
2950
-
2951
-
2952
-
2953
-
2954
-
2955
-
2956
-
2957
-
2958
-
2959
-
2960
-
2961
-
2962
- <h4 class="name" id=".activeFilterKeys"><span class="type-signature">(static) </span>activeFilterKeys<span class="signature">(filterConfiguration)</span><span class="type-signature"></span></h4>
2963
-
2964
-
2965
-
2966
-
2967
-
2968
-
2969
- <dl class="details">
2970
-
2971
-
2972
- <dt class="tag-source">Source:</dt>
2973
- <dd class="tag-source"><ul class="dummy"><li>
2974
- <a href="qik.filter.js.html">qik.filter.js</a>, <a href="qik.filter.js.html#line301">line 301</a>
2975
- </li></ul></dd>
2976
-
2977
-
2978
-
2979
-
2980
-
2981
-
2982
-
2983
-
2984
-
2985
-
2986
-
2987
-
2988
-
2989
-
2990
-
2991
-
2992
-
2993
-
2994
-
2995
-
2996
-
2997
-
2998
-
2999
-
3000
-
3001
-
3002
-
3003
-
3004
-
3005
-
3006
-
3007
- </dl>
3008
-
3009
-
3010
-
3011
-
3012
-
3013
- <div class="description usertext">
3014
- Returns an array of all keys that are being actively filtered on
3015
- </div>
3016
-
3017
-
3018
-
3019
-
3020
-
3021
-
3022
-
3023
-
3024
-
3025
- <h5>Example</h5>
3026
-
3027
- <pre class="prettyprint"><code>const filterConfiguration = {
3028
- "operator": "and",
3029
- "filters": [
3030
- {
3031
- "operator": "and",
3032
- "filters": [
3033
- {
3034
- "key": "formData.person.firstName",
3035
- "comparator": "startswith",
3036
- "value": "c"
3037
- },
3038
- {
3039
- "key": "invalid no comparator",
3040
- "value": "e"
3041
- }
3042
- {
3043
- "key": "formData.person.lastName",
3044
- "comparator": "endswith",
3045
- "value": "e"
3046
- }
3047
- ]
3048
- }
3049
- ]
3050
- }
3051
-
3052
- const activeFilters = sdk.filter.activeFilterKeys(filterConfiguration);
3053
- // Returns ['formData.person.firstName', 'formData.person.lastName']</code></pre>
3054
-
3055
-
3056
-
3057
-
3058
- <h5>Parameters:</h5>
3059
-
3060
-
3061
- <table class="params">
3062
- <thead>
3063
- <tr>
3064
-
3065
- <th>Name</th>
3066
-
3067
-
3068
- <th>Type</th>
3069
-
3070
-
3071
-
3072
-
3073
-
3074
- <th class="last">Description</th>
3075
- </tr>
3076
- </thead>
3077
-
3078
- <tbody>
3079
-
3080
-
3081
- <tr>
3082
-
3083
- <td class="name"><code>filterConfiguration</code></td>
3084
-
3085
-
3086
- <td class="type">
3087
-
3088
-
3089
- <span class="param-type">Object</span>
3090
-
3091
-
3092
-
3093
- </td>
3094
-
3095
-
3096
-
3097
-
3098
-
3099
- <td class="description last">A filter configuration object</td>
3100
- </tr>
3101
-
3102
-
3103
- </tbody>
3104
- </table>
3105
-
3106
-
3107
-
3108
-
3109
-
3110
-
3111
-
3112
-
3113
-
3114
-
3115
-
3116
-
3117
-
3118
-
3119
-
3120
-
3121
-
3122
-
3123
-
3124
-
3125
-
3126
-
3127
-
3128
-
3129
- <h4 class="name" id=".activeFilterKeys"><span class="type-signature">(static) </span>activeFilterKeys<span class="signature">(filterConfiguration)</span><span class="type-signature"></span></h4>
3130
-
3131
-
3132
-
3133
-
3134
-
3135
-
3136
- <dl class="details">
3137
-
3138
-
3139
- <dt class="tag-source">Source:</dt>
3140
- <dd class="tag-source"><ul class="dummy"><li>
3141
- <a href="qik.filter.js.html">qik.filter.js</a>, <a href="qik.filter.js.html#line361">line 361</a>
3142
- </li></ul></dd>
3143
-
3144
-
3145
-
3146
-
3147
-
3148
-
3149
-
3150
-
3151
-
3152
-
3153
-
3154
-
3155
-
3156
-
3157
-
3158
-
3159
-
3160
-
3161
-
3162
-
3163
-
3164
-
3165
-
3166
-
3167
-
3168
-
3169
-
3170
-
3171
-
3172
-
3173
-
3174
- </dl>
3175
-
3176
-
3177
-
3178
-
3179
-
3180
- <div class="description usertext">
3181
- Returns an array of all comparators that are being actively filtered
3182
- </div>
3183
-
3184
-
3185
-
3186
-
3187
-
3188
-
3189
-
3190
-
3191
-
3192
- <h5>Example</h5>
3193
-
3194
- <pre class="prettyprint"><code>const filterConfiguration = {
3195
- "operator": "and",
3196
- "filters": [
3197
- {
3198
- "operator": "and",
3199
- "filters": [
3200
- {
3201
- "key": "formData.person.firstName",
3202
- "comparator": "startswith",
3203
- "value": "c"
3204
- },
3205
- {
3206
- "key": "invalid no comparator",
3207
- "value": "e"
3208
- }
3209
- {
3210
- "key": "formData.person.lastName",
3211
- "comparator": "endswith",
3212
- "value": "e"
3213
- }
3214
- ]
3215
- }
3216
- ]
3217
- }
3218
-
3219
- const activeFilters = sdk.filter.activeFilterKeys(filterConfiguration);
3220
- // Returns ['startswith', 'endswith']</code></pre>
3221
-
3222
-
3223
-
3224
-
3225
- <h5>Parameters:</h5>
3226
-
3227
-
3228
- <table class="params">
3229
- <thead>
3230
- <tr>
3231
-
3232
- <th>Name</th>
3233
-
3234
-
3235
- <th>Type</th>
3236
-
3237
-
3238
-
3239
-
3240
-
3241
- <th class="last">Description</th>
3242
- </tr>
3243
- </thead>
3244
-
3245
- <tbody>
3246
-
3247
-
3248
- <tr>
3249
-
3250
- <td class="name"><code>filterConfiguration</code></td>
3251
-
3252
-
3253
- <td class="type">
3254
-
3255
-
3256
- <span class="param-type">Object</span>
3257
-
3258
-
3259
-
3260
- </td>
3261
-
3262
-
3263
-
3264
-
3265
-
3266
- <td class="description last">A filter configuration object</td>
3267
- </tr>
3268
-
3269
-
3270
- </tbody>
3271
- </table>
3272
-
3273
-
3274
-
3275
-
3276
-
3277
-
3278
-
3279
-
3280
-
3281
-
3282
-
3283
-
3284
-
3285
-
3286
-
3287
-
3288
-
3289
-
3290
-
3291
-
3292
-
3293
-
3294
-
3295
-
3296
- <h4 class="name" id=".activeFilterOperators"><span class="type-signature">(static) </span>activeFilterOperators<span class="signature">(filterConfiguration)</span><span class="type-signature"></span></h4>
3297
-
3298
-
3299
-
3300
-
3301
-
3302
-
3303
- <dl class="details">
3304
-
3305
-
3306
- <dt class="tag-source">Source:</dt>
3307
- <dd class="tag-source"><ul class="dummy"><li>
3308
- <a href="qik.filter.js.html">qik.filter.js</a>, <a href="qik.filter.js.html#line411">line 411</a>
3309
- </li></ul></dd>
3310
-
3311
-
3312
-
3313
-
3314
-
3315
-
3316
-
3317
-
3318
-
3319
-
3320
-
3321
-
3322
-
3323
-
3324
-
3325
-
3326
-
3327
-
3328
-
3329
-
3330
-
3331
-
3332
-
3333
-
3334
-
3335
-
3336
-
3337
-
3338
-
3339
-
3340
-
3341
- </dl>
3342
-
3343
-
3344
-
3345
-
3346
-
3347
- <div class="description usertext">
3348
- Returns an array of all comparators that are being actively filtered
3349
- </div>
3350
-
3351
-
3352
-
3353
-
3354
-
3355
-
3356
-
3357
-
3358
-
3359
- <h5>Example</h5>
3360
-
3361
- <pre class="prettyprint"><code>const filterConfiguration = {
3362
- "operator": "and",
3363
- "filters": [
3364
- {
3365
- "operator": "nor",
3366
- "filters": [
3367
- {
3368
- "key": "formData.person.firstName",
3369
- "comparator": "startswith",
3370
- "value": "c"
3371
- },
3372
- {
3373
- "key": "invalid no comparator",
3374
- "value": "e"
3375
- }
3376
- {
3377
- "key": "formData.person.lastName",
3378
- "comparator": "endswith",
3379
- "value": "e"
3380
- }
3381
- ]
3382
- }
3383
- ]
3384
- }
3385
-
3386
- const activeFilterOperators = sdk.filter.activeFilterOperators(filterConfiguration);
3387
- // Returns ['and', 'nor']</code></pre>
3388
-
3389
-
3390
-
3391
-
3392
- <h5>Parameters:</h5>
3393
-
3394
-
3395
- <table class="params">
3396
- <thead>
3397
- <tr>
3398
-
3399
- <th>Name</th>
3400
-
3401
-
3402
- <th>Type</th>
3403
-
3404
-
3405
-
3406
-
3407
-
3408
- <th class="last">Description</th>
3409
- </tr>
3410
- </thead>
3411
-
3412
- <tbody>
3413
-
3414
-
3415
- <tr>
3416
-
3417
- <td class="name"><code>filterConfiguration</code></td>
3418
-
3419
-
3420
- <td class="type">
3421
-
3422
-
3423
- <span class="param-type">Object</span>
3424
-
3425
-
3426
-
3427
- </td>
3428
-
3429
-
3430
-
3431
-
3432
-
3433
- <td class="description last">A filter configuration object</td>
3434
- </tr>
3435
-
3436
-
3437
- </tbody>
3438
- </table>
3439
-
3440
-
3441
-
3442
-
3443
-
3444
-
3445
-
3446
-
3447
-
3448
-
3449
-
3450
-
3451
-
3452
-
3453
-
3454
-
3455
-
3456
-
3457
-
3458
-
3459
-
3460
-
3461
-
3462
-
3463
- <h4 class="name" id=".activeFilterOperators"><span class="type-signature">(static) </span>activeFilterOperators<span class="signature">(filterConfiguration)</span><span class="type-signature"></span></h4>
3464
-
3465
-
3466
-
3467
-
3468
-
3469
-
3470
- <dl class="details">
3471
-
3472
-
3473
- <dt class="tag-source">Source:</dt>
3474
- <dd class="tag-source"><ul class="dummy"><li>
3475
- <a href="qik.filter.js.html">qik.filter.js</a>, <a href="qik.filter.js.html#line411">line 411</a>
3476
- </li></ul></dd>
3477
-
3478
-
3479
-
3480
-
3481
-
3482
-
3483
-
3484
-
3485
-
3486
-
3487
-
3488
-
3489
-
3490
-
3491
-
3492
-
3493
-
3494
-
3495
-
3496
-
3497
-
3498
-
3499
-
3500
-
3501
-
3502
-
3503
-
3504
-
3505
-
3506
-
3507
-
3508
- </dl>
3509
-
3510
-
3511
-
3512
-
3513
-
3514
- <div class="description usertext">
3515
- Returns an array of all comparators that are being actively filtered
3516
- </div>
3517
-
3518
-
3519
-
3520
-
3521
-
3522
-
3523
-
3524
-
3525
-
3526
- <h5>Example</h5>
3527
-
3528
- <pre class="prettyprint"><code>const filterConfiguration = {
3529
- "operator": "and",
3530
- "filters": [
3531
- {
3532
- "operator": "nor",
3533
- "filters": [
3534
- {
3535
- "key": "formData.person.firstName",
3536
- "comparator": "startswith",
3537
- "value": "c"
3538
- },
3539
- {
3540
- "key": "invalid no comparator",
3541
- "value": "e"
3542
- }
3543
- {
3544
- "key": "formData.person.lastName",
3545
- "comparator": "endswith",
3546
- "value": "e"
3547
- }
3548
- ]
3549
- }
3550
- ]
3551
- }
3552
-
3553
- const activeFilterOperators = sdk.filter.activeFilterOperators(filterConfiguration);
3554
- // Returns ['and', 'nor']</code></pre>
3555
-
3556
-
3557
-
3558
-
3559
- <h5>Parameters:</h5>
3560
-
3561
-
3562
- <table class="params">
3563
- <thead>
3564
- <tr>
3565
-
3566
- <th>Name</th>
3567
-
3568
-
3569
- <th>Type</th>
3570
-
3571
-
3572
-
3573
-
3574
-
3575
- <th class="last">Description</th>
3576
- </tr>
3577
- </thead>
3578
-
3579
- <tbody>
3580
-
3581
-
3582
- <tr>
3583
-
3584
- <td class="name"><code>filterConfiguration</code></td>
3585
-
3586
-
3587
- <td class="type">
3588
-
3589
-
3590
- <span class="param-type">Object</span>
3591
-
3592
-
3593
-
3594
- </td>
3595
-
3596
-
3597
-
3598
-
3599
-
3600
- <td class="description last">A filter configuration object</td>
3601
- </tr>
3602
-
3603
-
3604
- </tbody>
3605
- </table>
3606
-
3607
-
3608
-
3609
-
3610
-
3611
-
3612
-
3613
-
3614
-
3615
-
3616
-
3617
-
3618
-
3619
-
3620
-
3621
-
3622
-
3623
-
3624
-
3625
-
3626
-
3627
-
3628
-
3629
-
3630
- <h4 class="name" id=".activeFilters"><span class="type-signature">(static) </span>activeFilters<span class="signature">(filterConfiguration)</span><span class="type-signature"></span></h4>
3631
-
3632
-
3633
-
3634
-
3635
-
3636
-
3637
- <dl class="details">
3638
-
3639
-
3640
- <dt class="tag-source">Source:</dt>
3641
- <dd class="tag-source"><ul class="dummy"><li>
3642
- <a href="qik.filter.js.html">qik.filter.js</a>, <a href="qik.filter.js.html#line234">line 234</a>
3643
- </li></ul></dd>
3644
-
3645
-
3646
-
3647
-
3648
-
3649
-
3650
-
3651
-
3652
-
3653
-
3654
-
3655
-
3656
-
3657
-
3658
-
3659
-
3660
-
3661
-
3662
-
3663
-
3664
-
3665
-
3666
-
3667
-
3668
-
3669
-
3670
-
3671
-
3672
-
3673
-
3674
-
3675
- </dl>
3676
-
3677
-
3678
-
3679
-
3680
-
3681
- <div class="description usertext">
3682
- Returns an array of all active filters
3683
- </div>
3684
-
3685
-
3686
-
3687
-
3688
-
3689
-
3690
-
3691
-
3692
-
3693
- <h5>Example</h5>
3694
-
3695
- <pre class="prettyprint"><code>const filterConfiguration = {
3696
- "operator": "and",
3697
- "filters": [
3698
- {
3699
- "operator": "and",
3700
- "filters": [
3701
- {
3702
- "key": "formData.person.firstName",
3703
- "comparator": "startswith",
3704
- "value": "c"
3705
- },
3706
- {
3707
- "key": "invalid no comparator",
3708
- "value": "e"
3709
- }
3710
- {
3711
- "key": "formData.person.lastName",
3712
- "comparator": "endswith",
3713
- "value": "e"
3714
- }
3715
- ]
3716
- }
3717
- ]
3718
- }
3719
-
3720
- const activeFilters = sdk.filter.activeFilters(filterConfiguration);
3721
-
3722
- const returns = [
3723
- {
3724
- "key": "formData.person.firstName",
3725
- "comparator": "startswith",
3726
- "value": "c"
3727
- },
3728
- {
3729
- "key": "formData.person.lastName",
3730
- "comparator": "endswith",
3731
- "value": "e"
3732
- }]</code></pre>
3733
-
3734
-
3735
-
3736
-
3737
- <h5>Parameters:</h5>
3738
-
3739
-
3740
- <table class="params">
3741
- <thead>
3742
- <tr>
3743
-
3744
- <th>Name</th>
3745
-
3746
-
3747
- <th>Type</th>
3748
-
3749
-
3750
-
3751
-
3752
-
3753
- <th class="last">Description</th>
3754
- </tr>
3755
- </thead>
3756
-
3757
- <tbody>
3758
-
3759
-
3760
- <tr>
3761
-
3762
- <td class="name"><code>filterConfiguration</code></td>
3763
-
3764
-
3765
- <td class="type">
3766
-
3767
-
3768
- <span class="param-type">Object</span>
3769
-
3770
-
3771
-
3772
- </td>
3773
-
3774
-
3775
-
3776
-
3777
-
3778
- <td class="description last">A filter configuration object</td>
3779
- </tr>
3780
-
3781
-
3782
- </tbody>
3783
- </table>
3784
-
3785
-
3786
-
3787
-
3788
-
3789
-
3790
-
3791
-
3792
-
3793
-
3794
-
3795
-
3796
-
3797
-
3798
-
3799
-
3800
-
3801
-
3802
-
3803
-
3804
-
3805
-
3806
-
3807
-
3808
- <h4 class="name" id=".activeFilters"><span class="type-signature">(static) </span>activeFilters<span class="signature">(filterConfiguration)</span><span class="type-signature"></span></h4>
3809
-
3810
-
3811
-
3812
-
3813
-
3814
-
3815
- <dl class="details">
3816
-
3817
-
3818
- <dt class="tag-source">Source:</dt>
3819
- <dd class="tag-source"><ul class="dummy"><li>
3820
- <a href="qik.filter.js.html">qik.filter.js</a>, <a href="qik.filter.js.html#line234">line 234</a>
3821
- </li></ul></dd>
3822
-
3823
-
3824
-
3825
-
3826
-
3827
-
3828
-
3829
-
3830
-
3831
-
3832
-
3833
-
3834
-
3835
-
3836
-
3837
-
3838
-
3839
-
3840
-
3841
-
3842
-
3843
-
3844
-
3845
-
3846
-
3847
-
3848
-
3849
-
3850
-
3851
-
3852
-
3853
- </dl>
3854
-
3855
-
3856
-
3857
-
3858
-
3859
- <div class="description usertext">
3860
- Returns an array of all active filters
3861
- </div>
3862
-
3863
-
3864
-
3865
-
3866
-
3867
-
3868
-
3869
-
3870
-
3871
- <h5>Example</h5>
3872
-
3873
- <pre class="prettyprint"><code>const filterConfiguration = {
3874
- "operator": "and",
3875
- "filters": [
3876
- {
3877
- "operator": "and",
3878
- "filters": [
3879
- {
3880
- "key": "formData.person.firstName",
3881
- "comparator": "startswith",
3882
- "value": "c"
3883
- },
3884
- {
3885
- "key": "invalid no comparator",
3886
- "value": "e"
3887
- }
3888
- {
3889
- "key": "formData.person.lastName",
3890
- "comparator": "endswith",
3891
- "value": "e"
3892
- }
3893
- ]
3894
- }
3895
- ]
3896
- }
3897
-
3898
- const activeFilters = sdk.filter.activeFilters(filterConfiguration);
3899
-
3900
- const returns = [
3901
- {
3902
- "key": "formData.person.firstName",
3903
- "comparator": "startswith",
3904
- "value": "c"
3905
- },
3906
- {
3907
- "key": "formData.person.lastName",
3908
- "comparator": "endswith",
3909
- "value": "e"
3910
- }]</code></pre>
3911
-
3912
-
3913
-
3914
-
3915
- <h5>Parameters:</h5>
3916
-
3917
-
3918
- <table class="params">
3919
- <thead>
3920
- <tr>
3921
-
3922
- <th>Name</th>
3923
-
3924
-
3925
- <th>Type</th>
3926
-
3927
-
3928
-
3929
-
3930
-
3931
- <th class="last">Description</th>
3932
- </tr>
3933
- </thead>
3934
-
3935
- <tbody>
3936
-
3937
-
3938
- <tr>
3939
-
3940
- <td class="name"><code>filterConfiguration</code></td>
3941
-
3942
-
3943
- <td class="type">
3944
-
3945
-
3946
- <span class="param-type">Object</span>
3947
-
3948
-
3949
-
3950
- </td>
3951
-
3952
-
3953
-
3954
-
3955
-
3956
- <td class="description last">A filter configuration object</td>
3957
- </tr>
3958
-
3959
-
3960
- </tbody>
3961
- </table>
3962
-
3963
-
3964
-
3965
-
3966
-
3967
-
3968
-
3969
-
3970
-
3971
-
3972
-
3973
-
3974
-
3975
-
3976
-
3977
-
3978
-
3979
-
3980
-
3981
-
3982
-
3983
-
3984
-
3985
-
3986
- <h4 class="name" id=".activeFilterValues"><span class="type-signature">(static) </span>activeFilterValues<span class="signature">(filterConfiguration)</span><span class="type-signature"></span></h4>
3987
-
3988
-
3989
-
3990
-
3991
-
3992
-
3993
- <dl class="details">
3994
-
3995
-
3996
- <dt class="tag-source">Source:</dt>
3997
- <dd class="tag-source"><ul class="dummy"><li>
3998
- <a href="qik.filter.js.html">qik.filter.js</a>, <a href="qik.filter.js.html#line461">line 461</a>
3999
- </li></ul></dd>
4000
-
4001
-
4002
-
4003
-
4004
-
4005
-
4006
-
4007
-
4008
-
4009
-
4010
-
4011
-
4012
-
4013
-
4014
-
4015
-
4016
-
4017
-
4018
-
4019
-
4020
-
4021
-
4022
-
4023
-
4024
-
4025
-
4026
-
4027
-
4028
-
4029
-
4030
-
4031
- </dl>
4032
-
4033
-
4034
-
4035
-
4036
-
4037
- <div class="description usertext">
4038
- Returns an array of all values that are being actively used by a filter
4039
- </div>
4040
-
4041
-
4042
-
4043
-
4044
-
4045
-
4046
-
4047
-
4048
-
4049
- <h5>Example</h5>
4050
-
4051
- <pre class="prettyprint"><code>const filterConfiguration = {
4052
- "operator": "and",
4053
- "filters": [
4054
- {
4055
- "operator": "nor",
4056
- "filters": [
4057
- {
4058
- "key": "formData.person.firstName",
4059
- "comparator": "startswith",
4060
- "value": "c"
4061
- },
4062
- {
4063
- "key": "invalid no comparator",
4064
- "value": "e"
4065
- }
4066
- {
4067
- "key": "formData.person.lastName",
4068
- "comparator": "endswith",
4069
- "value": "a"
4070
- }
4071
- ]
4072
- }
4073
- ]
4074
- }
4075
-
4076
- const activeFilterValues = sdk.filter.activeFilterValues(filterConfiguration);
4077
- // Returns ['c', 'a']</code></pre>
4078
-
4079
-
4080
-
4081
-
4082
- <h5>Parameters:</h5>
4083
-
4084
-
4085
- <table class="params">
4086
- <thead>
4087
- <tr>
4088
-
4089
- <th>Name</th>
4090
-
4091
-
4092
- <th>Type</th>
4093
-
4094
-
4095
-
4096
-
4097
-
4098
- <th class="last">Description</th>
4099
- </tr>
4100
- </thead>
4101
-
4102
- <tbody>
4103
-
4104
-
4105
- <tr>
4106
-
4107
- <td class="name"><code>filterConfiguration</code></td>
4108
-
4109
-
4110
- <td class="type">
4111
-
4112
-
4113
- <span class="param-type">Object</span>
4114
-
4115
-
4116
-
4117
- </td>
4118
-
4119
-
4120
-
4121
-
4122
-
4123
- <td class="description last">A filter configuration object</td>
4124
- </tr>
4125
-
4126
-
4127
- </tbody>
4128
- </table>
4129
-
4130
-
4131
-
4132
-
4133
-
4134
-
4135
-
4136
-
4137
-
4138
-
4139
-
4140
-
4141
-
4142
-
4143
-
4144
-
4145
-
4146
-
4147
-
4148
-
4149
-
4150
-
4151
-
4152
-
4153
- <h4 class="name" id=".activeFilterValues"><span class="type-signature">(static) </span>activeFilterValues<span class="signature">(filterConfiguration)</span><span class="type-signature"></span></h4>
4154
-
4155
-
4156
-
4157
-
4158
-
4159
-
4160
- <dl class="details">
4161
-
4162
-
4163
- <dt class="tag-source">Source:</dt>
4164
- <dd class="tag-source"><ul class="dummy"><li>
4165
- <a href="qik.filter.js.html">qik.filter.js</a>, <a href="qik.filter.js.html#line461">line 461</a>
4166
- </li></ul></dd>
4167
-
4168
-
4169
-
4170
-
4171
-
4172
-
4173
-
4174
-
4175
-
4176
-
4177
-
4178
-
4179
-
4180
-
4181
-
4182
-
4183
-
4184
-
4185
-
4186
-
4187
-
4188
-
4189
-
4190
-
4191
-
4192
-
4193
-
4194
-
4195
-
4196
-
4197
-
4198
- </dl>
4199
-
4200
-
4201
-
4202
-
4203
-
4204
- <div class="description usertext">
4205
- Returns an array of all values that are being actively used by a filter
4206
- </div>
4207
-
4208
-
4209
-
4210
-
4211
-
4212
-
4213
-
4214
-
4215
-
4216
- <h5>Example</h5>
4217
-
4218
- <pre class="prettyprint"><code>const filterConfiguration = {
4219
- "operator": "and",
4220
- "filters": [
4221
- {
4222
- "operator": "nor",
4223
- "filters": [
4224
- {
4225
- "key": "formData.person.firstName",
4226
- "comparator": "startswith",
4227
- "value": "c"
4228
- },
4229
- {
4230
- "key": "invalid no comparator",
4231
- "value": "e"
4232
- }
4233
- {
4234
- "key": "formData.person.lastName",
4235
- "comparator": "endswith",
4236
- "value": "a"
4237
- }
4238
- ]
4239
- }
4240
- ]
4241
- }
4242
-
4243
- const activeFilterValues = sdk.filter.activeFilterValues(filterConfiguration);
4244
- // Returns ['c', 'a']</code></pre>
4245
-
4246
-
4247
-
4248
-
4249
- <h5>Parameters:</h5>
4250
-
4251
-
4252
- <table class="params">
4253
- <thead>
4254
- <tr>
4255
-
4256
- <th>Name</th>
4257
-
4258
-
4259
- <th>Type</th>
4260
-
4261
-
4262
-
4263
-
4264
-
4265
- <th class="last">Description</th>
4266
- </tr>
4267
- </thead>
4268
-
4269
- <tbody>
4270
-
4271
-
4272
- <tr>
4273
-
4274
- <td class="name"><code>filterConfiguration</code></td>
4275
-
4276
-
4277
- <td class="type">
4278
-
4279
-
4280
- <span class="param-type">Object</span>
4281
-
4282
-
4283
-
4284
- </td>
4285
-
4286
-
4287
-
4288
-
4289
-
4290
- <td class="description last">A filter configuration object</td>
4291
- </tr>
4292
-
4293
-
4294
- </tbody>
4295
- </table>
4296
-
4297
-
4298
-
4299
-
4300
-
4301
-
4302
-
4303
-
4304
-
4305
-
4306
-
4307
-
4308
-
4309
-
4310
-
4311
-
4312
-
4313
-
4314
-
4315
-
4316
-
4317
-
4318
-
4319
-
4320
- <h4 class="name" id=".filterChangeString"><span class="type-signature">(static) </span>filterChangeString<span class="signature">(filterConfiguration)</span><span class="type-signature"></span></h4>
4321
-
4322
-
4323
-
4324
-
4325
-
4326
-
4327
- <dl class="details">
4328
-
4329
-
4330
- <dt class="tag-source">Source:</dt>
4331
- <dd class="tag-source"><ul class="dummy"><li>
4332
- <a href="qik.filter.js.html">qik.filter.js</a>, <a href="qik.filter.js.html#line528">line 528</a>
4333
- </li></ul></dd>
4334
-
4335
-
4336
-
4337
-
4338
-
4339
-
4340
-
4341
-
4342
-
4343
-
4344
-
4345
-
4346
-
4347
-
4348
-
4349
-
4350
-
4351
-
4352
-
4353
-
4354
-
4355
-
4356
-
4357
-
4358
-
4359
-
4360
-
4361
-
4362
-
4363
-
4364
-
4365
- </dl>
4366
-
4367
-
4368
-
4369
-
4370
-
4371
- <div class="description usertext">
4372
- Returns an string representation of a filter configuration.
4373
- Often used to check if a user has changed the filter in any way, the string only takes into consideration active valid filters
4374
- </div>
4375
-
4376
-
4377
-
4378
-
4379
-
4380
-
4381
-
4382
-
4383
-
4384
- <h5>Example</h5>
4385
-
4386
- <pre class="prettyprint"><code>const filterConfiguration = {
4387
- "operator": "and",
4388
- "filters": [
4389
- {
4390
- "operator": "nor",
4391
- "filters": [
4392
- {
4393
- "key": "formData.person.firstName",
4394
- "comparator": "startswith",
4395
- "value": "c"
4396
- },
4397
- {
4398
- "key": "invalid no comparator",
4399
- "value": "e"
4400
- }
4401
- {
4402
- "key": "formData.person.lastName",
4403
- "comparator": "endswith",
4404
- "value": "a"
4405
- }
4406
- ]
4407
- }
4408
- ]
4409
- }
4410
-
4411
- // Watch this string for changes
4412
- const changeString = sdk.filter.filterChangeString(filterConfiguration); </code></pre>
4413
-
4414
-
4415
-
4416
-
4417
- <h5>Parameters:</h5>
4418
-
4419
-
4420
- <table class="params">
4421
- <thead>
4422
- <tr>
4423
-
4424
- <th>Name</th>
4425
-
4426
-
4427
- <th>Type</th>
4428
-
4429
-
4430
-
4431
-
4432
-
4433
- <th class="last">Description</th>
4434
- </tr>
4435
- </thead>
4436
-
4437
- <tbody>
4438
-
4439
-
4440
- <tr>
4441
-
4442
- <td class="name"><code>filterConfiguration</code></td>
4443
-
4444
-
4445
- <td class="type">
4446
-
4447
-
4448
- <span class="param-type">Object</span>
4449
-
4450
-
4451
-
4452
- </td>
4453
-
4454
-
4455
-
4456
-
4457
-
4458
- <td class="description last">A filter configuration object</td>
4459
- </tr>
4460
-
4461
-
4462
- </tbody>
4463
- </table>
4464
-
4465
-
4466
-
4467
-
4468
-
4469
-
4470
-
4471
-
4472
-
4473
-
4474
-
4475
-
4476
-
4477
-
4478
-
4479
-
4480
-
4481
-
4482
-
4483
-
4484
-
4485
-
4486
-
4487
-
4488
- <h4 class="name" id=".filterChangeString"><span class="type-signature">(static) </span>filterChangeString<span class="signature">(filterConfiguration)</span><span class="type-signature"></span></h4>
4489
-
4490
-
4491
-
4492
-
4493
-
4494
-
4495
- <dl class="details">
4496
-
4497
-
4498
- <dt class="tag-source">Source:</dt>
4499
- <dd class="tag-source"><ul class="dummy"><li>
4500
- <a href="qik.filter.js.html">qik.filter.js</a>, <a href="qik.filter.js.html#line528">line 528</a>
4501
- </li></ul></dd>
4502
-
4503
-
4504
-
4505
-
4506
-
4507
-
4508
-
4509
-
4510
-
4511
-
4512
-
4513
-
4514
-
4515
-
4516
-
4517
-
4518
-
4519
-
4520
-
4521
-
4522
-
4523
-
4524
-
4525
-
4526
-
4527
-
4528
-
4529
-
4530
-
4531
-
4532
-
4533
- </dl>
4534
-
4535
-
4536
-
4537
-
4538
-
4539
- <div class="description usertext">
4540
- Returns an string representation of a filter configuration.
4541
- Often used to check if a user has changed the filter in any way, the string only takes into consideration active valid filters
4542
- </div>
4543
-
4544
-
4545
-
4546
-
4547
-
4548
-
4549
-
4550
-
4551
-
4552
- <h5>Example</h5>
4553
-
4554
- <pre class="prettyprint"><code>const filterConfiguration = {
4555
- "operator": "and",
4556
- "filters": [
4557
- {
4558
- "operator": "nor",
4559
- "filters": [
4560
- {
4561
- "key": "formData.person.firstName",
4562
- "comparator": "startswith",
4563
- "value": "c"
4564
- },
4565
- {
4566
- "key": "invalid no comparator",
4567
- "value": "e"
4568
- }
4569
- {
4570
- "key": "formData.person.lastName",
4571
- "comparator": "endswith",
4572
- "value": "a"
4573
- }
4574
- ]
4575
- }
4576
- ]
4577
- }
4578
-
4579
- // Watch this string for changes
4580
- const changeString = sdk.filter.filterChangeString(filterConfiguration); </code></pre>
4581
-
4582
-
4583
-
4584
-
4585
- <h5>Parameters:</h5>
4586
-
4587
-
4588
- <table class="params">
4589
- <thead>
4590
- <tr>
4591
-
4592
- <th>Name</th>
4593
-
4594
-
4595
- <th>Type</th>
4596
-
4597
-
4598
-
4599
-
4600
-
4601
- <th class="last">Description</th>
4602
- </tr>
4603
- </thead>
4604
-
4605
- <tbody>
4606
-
4607
-
4608
- <tr>
4609
-
4610
- <td class="name"><code>filterConfiguration</code></td>
4611
-
4612
-
4613
- <td class="type">
4614
-
4615
-
4616
- <span class="param-type">Object</span>
4617
-
4618
-
4619
-
4620
- </td>
4621
-
4622
-
4623
-
4624
-
4625
-
4626
- <td class="description last">A filter configuration object</td>
4627
- </tr>
4628
-
4629
-
4630
- </tbody>
4631
- </table>
4632
-
4633
-
4634
-
4635
-
4636
-
4637
-
4638
-
4639
-
4640
-
4641
-
4642
-
4643
-
4644
-
4645
-
4646
-
4647
-
4648
-
4649
-
4650
-
4651
-
4652
-
4653
-
4654
-
4655
-
4656
- <h4 class="name" id=".isValidFilter"><span class="type-signature">(static) </span>isValidFilter<span class="signature">(filter)</span><span class="type-signature"></span></h4>
4657
-
4658
-
4659
-
4660
-
4661
-
4662
-
4663
- <dl class="details">
4664
-
4665
-
4666
- <dt class="tag-source">Source:</dt>
4667
- <dd class="tag-source"><ul class="dummy"><li>
4668
- <a href="qik.filter.js.html">qik.filter.js</a>, <a href="qik.filter.js.html#line67">line 67</a>
4669
- </li></ul></dd>
4670
-
4671
-
4672
-
4673
-
4674
-
4675
-
4676
-
4677
-
4678
-
4679
-
4680
-
4681
-
4682
-
4683
-
4684
-
4685
-
4686
-
4687
-
4688
-
4689
-
4690
-
4691
-
4692
-
4693
-
4694
-
4695
-
4696
-
4697
-
4698
-
4699
-
4700
-
4701
- </dl>
4702
-
4703
-
4704
-
4705
-
4706
-
4707
- <div class="description usertext">
4708
- Check if an object is a valid filter
4709
- </div>
4710
-
4711
-
4712
-
4713
-
4714
-
4715
-
4716
-
4717
-
4718
-
4719
- <h5>Example</h5>
4720
-
4721
- <pre class="prettyprint"><code>// Missing a 'key'
4722
- const invalidFilter = sdk.filter.isValidFilter({comparator:'in', values:['Red', 'Green', 'Blue']})
4723
- // returns false
4724
-
4725
- const validFilter = sdk.filter.isValidFilter({key:'favoriteColor', comparator:'in', values:['Red', 'Green', 'Blue']})
4726
- // returns true</code></pre>
4727
-
4728
-
4729
-
4730
-
4731
- <h5>Parameters:</h5>
4732
-
4733
-
4734
- <table class="params">
4735
- <thead>
4736
- <tr>
4737
-
4738
- <th>Name</th>
4739
-
4740
-
4741
- <th>Type</th>
4742
-
4743
-
4744
-
4745
-
4746
-
4747
- <th class="last">Description</th>
4748
- </tr>
4749
- </thead>
4750
-
4751
- <tbody>
4752
-
4753
-
4754
- <tr>
4755
-
4756
- <td class="name"><code>filter</code></td>
4757
-
4758
-
4759
- <td class="type">
4760
-
4761
-
4762
- <span class="param-type">Object</span>
4763
-
4764
-
4765
-
4766
- </td>
4767
-
4768
-
4769
-
4770
-
4771
-
4772
- <td class="description last">The filter block to check</td>
4773
- </tr>
4774
-
4775
-
4776
- </tbody>
4777
- </table>
4778
-
4779
-
4780
-
4781
-
4782
-
4783
-
4784
-
4785
-
4786
-
4787
-
4788
-
4789
-
4790
-
4791
-
4792
-
4793
-
4794
-
4795
-
4796
-
4797
-
4798
1180
 
4799
1181
 
4800
1182
 
@@ -4960,7 +1342,7 @@ const validFilter = sdk.filter.isValidFilter({key:'favoriteColor', comparator:'i
4960
1342
  <br class="clear">
4961
1343
 
4962
1344
  <footer>
4963
- Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.6.11</a> on Mon Jun 01 2026 23:37:17 GMT+1000 (Australian Eastern Standard Time) using the <a href="https://github.com/clenemt/docdash">docdash</a> theme.
1345
+ Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.6.11</a> on Mon Jul 13 2026 18:49:48 GMT+1000 (Australian Eastern Standard Time) using the <a href="https://github.com/clenemt/docdash">docdash</a> theme.
4964
1346
  </footer>
4965
1347
 
4966
1348
  <script>prettyPrint();</script>