FILTER function

The FILTER function allows you to filter a range of data based on criteria you define.

Description
app.vue
index.html
styles.css
Copy to CodeMine

The FILTER function filters an array based on a boolean (true/false) array. For example:

=FILTER(array, include, if_empty?)
Argument Required Description
array Y The array, or range to filter
include Y A Boolean array whose height or width is the same as the array
[if_empty] N The value to return if all values in the included array are empty (filter returns nothing)

Note:

  • The FILTER function is only valid when allowDynamicArray is true.
  • The FILTER function will retun an array, which will spill if it's the final result of a formula.
  • If your dataset has the potential of returning an empty value, then use the 3rd argument ([if_empty]). Otherwise, a #CALC! error will result.
  • If any value of the include argument is an error (#N/A, #VALUE, etc) or cannot be converted to a boolean, the FILTER function will return an error.
The FILTER function filters an array based on a boolean (true/false) array. For example: Argument Required Description array Y The array, or range to filter include Y A Boolean array whose height or width is the same as the array [if_empty] N The value to return if all values in the included array are empty (filter returns nothing) Note: The FILTER function is only valid when allowDynamicArray is true. The FILTER function will retun an array, which will spill if it's the final result of a formula. If your dataset has the potential of returning an empty value, then use the 3rd argument ([if_empty]). Otherwise, a #CALC! error will result. If any value of the include argument is an error (#N/A, #VALUE, etc) or cannot be converted to a boolean, the FILTER function will return an error.
<template> <div class="sample-tutorial"> <gc-spread-sheets class="sample-spreadsheets" @workbookInitialized="initSpread"> <gc-worksheet> </gc-worksheet> </gc-spread-sheets> </div> </template> <script> import Vue from 'vue'; import '@mescius/spread-sheets-vue' import GC from '@mescius/spread-sheets'; import './styles.css'; const demoData = [ ["Region","Sales Rep","Product","Units"], ["East","Tom","Apple",6380], ["West","Fred","Grape", 5619], ["North ","Amy","Pear", 4565], ["South","Sal","Banana", 5323], ["East","Fritz","Apple", 4394], ["West","Sravan","Grape", 7195], ["North ","Xi","Pear", 5231], ["South","Hector","Banana", 2427], ["East","Tom","Banana", 4213], ["West","Fred","Pear", 3239], ["North ","Amy","Grape", 6420], ["South","Sal","Apple", 1310], ["East","Fritz","Banana", 6274], ["West","Sravan","Pear", 4894], ["North ","Xi","Grape", 7580], ["South","Hector","Apple", 9814] ]; let App = Vue.extend({ name: "app", methods:{ initSpread: function (spread) { this.spread = spread; spread.options.allowDynamicArray = true; var sheet = spread.getActiveSheet(); spread.suspendPaint(); spread.suspendCalcService(); sheet.name('FILTER'); sheet.defaults.colWidth = 80; sheet.setColumnWidth(5, 20); sheet.setColumnWidth(7, 20); sheet.setText(0, 0, 'The FILTER function filters a range or array based on criteria you specify. Syntax: FILTER(array,include,[if_empty])'); var row = 2; var col = 1; var rowCount = 17; this.applyTableStyleForRange(sheet, row, col, rowCount, 4); this.applyTableStyleForRange(sheet, row, 6, 2, 1); sheet.setArray(row, col, demoData); sheet.setArray(row, 6, [["Criterion", "", "Product", "Units", "", "Total:"], [5000]]); var formatter = '#,##0'; sheet.getRange(row + 1, col + 3, rowCount - 1, 1).formatter(formatter); sheet.getCell(row + 1, 6).formatter(formatter); sheet.getRange(row + 1, 9, rowCount, 1).formatter(formatter); var formula = 'SUM(IF(E4:E19>G4,1,0))'; sheet.setFormula(row + 1, 11, formula); // can't get value when calc service is suspended, use evaluateFormula instead // rowCount = sheet.getValue(row + 1, 11) + 1; rowCount = GC.Spread.Sheets.CalcEngine.evaluateFormula(sheet, formula) + 1; this.applyTableStyleForRange(sheet, row, 8, rowCount, 2); sheet.setArray(row, 6, [["Criterion", "", "Product", "Units", "", "Total:"], [5000]]); sheet.setFormula(row + 1, 8, 'FILTER(D4:E19,E4:E19>G4,"")'); spread.resumeCalcService(); spread.resumePaint(); }, applyTableStyleForRange: function (sheet, row, col, rowCount, colCount, options) { var tableName = "tmpTable"; var TableThemes = GC.Spread.Sheets.Tables.TableThemes; // use table to help set style then remove like convert table to range in Excel sheet.tables.add(tableName, row, col, rowCount, colCount, TableThemes.medium7, options); sheet.tables.remove(tableName, 2 /* keep style */); } } }); new Vue({ render: h => h(App) }).$mount('#app'); </script>
<!doctype html> <html style="height:100%;font-size:14px;"> <head> <meta charset="utf-8" /> <meta name="viewport" content="width=device-width, initial-scale=1.0" /> <link rel="stylesheet" type="text/css" href="$DEMOROOT$/en/vue/node_modules/@mescius/spread-sheets/styles/gc.spread.sheets.excel2013white.css"> <!-- SystemJS --> <script src="$DEMOROOT$/en/vue/node_modules/systemjs/dist/system.src.js"></script> <script src="systemjs.config.js"></script> <script> System.import('./src/app.vue'); System.import('$DEMOROOT$/en/lib/vue/license.js'); </script> </head> <body> <div id="app"></div> </body> </html>
.sample-tutorial { position: relative; height: 100%; overflow: hidden; } .sample-spreadsheets { width: 100%; height: 100%; overflow: hidden; float: left; } .options-container { float: right; width: 280px; padding: 12px; height: 100%; box-sizing: border-box; background: #fbfbfb; overflow: auto; } .option-row { font-size: 14px; padding: 5px; margin-top: 10px; } #switchAutoMergeMode { margin: 10px 0px; } body { position: absolute; top: 0; bottom: 0; left: 0; right: 0; }
(function (global) { System.config({ transpiler: 'plugin-babel', babelOptions: { es2015: true }, meta: { '*.css': { loader: 'css' }, '*.vue': { loader: 'vue-loader' } }, paths: { // paths serve as alias 'npm:': 'node_modules/' }, // map tells the System loader where to look for things map: { '@mescius/spread-sheets': 'npm:@mescius/spread-sheets/index.js', '@mescius/spread-sheets-vue': 'npm:@mescius/spread-sheets-vue/index.js', '@grapecity/jsob-test-dependency-package/react-components': 'npm:@grapecity/jsob-test-dependency-package/react-components/index.js', 'jszip': 'npm:jszip/dist/jszip.js', 'css': 'npm:systemjs-plugin-css/css.js', 'vue': 'npm:vue/dist/vue.min.js', 'vue-loader': 'npm:systemjs-vue-browser/index.js', 'tiny-emitter': 'npm:tiny-emitter/index.js', 'plugin-babel': 'npm:systemjs-plugin-babel/plugin-babel.js', 'systemjs-babel-build':'npm:systemjs-plugin-babel/systemjs-babel-browser.js' }, // packages tells the System loader how to load when no filename and/or no extension packages: { src: { defaultExtension: 'js' }, rxjs: { defaultExtension: 'js' }, "node_modules": { defaultExtension: 'js' } } }); })(this);