Create a new class extended from RowFilterBase. For example:
The next step is to override the onFilter(args) to provide the custom filter action. The args.action is one of the following FilterActionType enumerations:
filter
unfilter
Use it to check if the filter or unfilter action should be provided. For example:
You can use the filterButtonVisible method to control the display of the filter buttons.
<template>
<div class="sample-tutorial">
<gc-spread-sheets class="sample-spreadsheets" @workbookInitialized="initSpread">
<gc-worksheet>
</gc-worksheet>
</gc-spread-sheets>
<div class="options-container">
<div class="option-row">
<label for="filterValue">Score less than:</label>
<input id="filterValue" placeholder="Input filter score value" type="text" value="60" />
<input type="button" id="btnFilter" value="Apply filter" title="Filter score column with filter action."
@click="applyFilter($event)" />
<input type="button" id="btnClearFilter" value="Clear filter" title="Clear score column' filter."
@click="removeFilter($event)" />
</div>
</div>
</div>
</template>
<script setup>
import '@mescius/spread-sheets-vue';
import { ref } from "vue";
import GC from "@mescius/spread-sheets";
let spreadRef;
const spreadNS = GC.Spread.Sheets;
const initSpread = (spread) => {
spreadRef = spread;
var sheet = spread.getSheet(0);
sheet.suspendPaint();
sheet.setColumnWidth(0, 100);
sheet.setColumnWidth(1, 200);
sheet.setValue(1, 0, "Name");
sheet.setValue(1, 1, "Score");
var score = [
{ name: "Simon", score: 59 },
{ name: "Jack", score: 70 },
{ name: "Lily", score: 86 },
{ name: "Bob", score: 54 },
{ name: "Lucy", score: 84 },
{ name: "John", score: 99 }
];
for (var i = 0, len = score.length; i < len; i++) {
var student = score[i];
sheet.setValue(i + 2, 0, student.name);
sheet.setValue(i + 2, 1, student.score);
}
function SelectionFilter(range) {
spreadNS.Filter.RowFilterBase.call(this, range);
}
SelectionFilter.prototype = new spreadNS.Filter.RowFilterBase();
SelectionFilter.prototype.onFilter = function (args) {
var sheet = args.sheet, range = args.range,
filterRows = args.filteredRows,
action = args.action,
doFilter = action === spreadNS.Filter.FilterActionType.filter;
if (doFilter) {
if (range.col < 0) {
range.col = 0;
range.colCount = sheet.getColumnCount();
}
var activeCellSet;
for (var i = 0, len = filterRows.length; i < len; i++) {
var r = filterRows[i];
for (var c = range.col, len1 = range.col + range.colCount; c < len1; c++) {
if (!activeCellSet) {
activeCellSet = true;
sheet.setSelection(r, c, 1, 1);
} else {
sheet.addSelection(r, c, 1, 1);
}
}
}
sheet.setValue(9, 1, "Select the filtered items");
} else {
sheet.setSelection(0, 0, 1, 1);
sheet.setValue(9, 1, "No filtered items");
}
spread.focus();
};
var actionFilter = new SelectionFilter(new spreadNS.Range(2, 1, 6, 1));
sheet.rowFilter(actionFilter);
actionFilter.filterButtonVisible(false);
sheet.resumePaint();
};
const applyFilter = () => {
var sheet = spreadRef.getActiveSheet(),
filter = sheet.rowFilter(),
value = parseInt(document.getElementById("filterValue").value, 10),
col = 1;
if (filter && !isNaN(value)) {
filter.removeFilterItems(col);
var condition = new spreadNS.ConditionalFormatting.Condition(spreadNS.ConditionalFormatting.ConditionType.numberCondition, {
compareType: spreadNS.ConditionalFormatting.GeneralComparisonOperators.lessThan,
expected: value
});
filter.addFilterItem(col, condition);
filter.filter();
sheet.invalidateLayout();
sheet.repaint();
}
};
const removeFilter = () => {
var sheet = spreadRef.getActiveSheet(),
filter = sheet.rowFilter();
if (filter) {
filter.removeFilterItems(1);
}
};
</script>
<style scoped>
#app {
height: 100%;
}
.sample-tutorial {
position: relative;
height: 100%;
overflow: hidden;
}
.sample-spreadsheets {
width: calc(100% - 280px);
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;
}
input {
padding: 4px 6px;
}
label {
display: block;
margin-bottom: 6px;
}
input[type=button] {
margin-top: 6px;
}
body {
position: absolute;
top: 0;
bottom: 0;
left: 0;
right: 0;
}
</style>
<!DOCTYPE html>
<html style="height:100%;font-size:14px;">
<head>
<meta charset="utf-8" />
<meta http-equiv="X-UA-Compatible" content="IE=edge" />
<title>SpreadJS VUE</title>
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
<link rel="stylesheet" type="text/css"
href="$DEMOROOT$/en/vue3/node_modules/@mescius/spread-sheets/styles/gc.spread.sheets.excel2013white.css">
<script src="$DEMOROOT$/en/vue3/node_modules/systemjs/dist/system.src.js"></script>
<script src="./systemjs.config.js"></script>
<script src="./compiler.js" type="module"></script>
<script>
var System = SystemJS;
System.import("./src/app.js");
System.import('$DEMOROOT$/en/lib/vue3/license.js');
</script>
</head>
<body>
<div id="app"></div>
</body>
</html>
(function (global) {
SystemJS.config({
transpiler: 'plugin-babel',
babelOptions: {
es2015: true
},
paths: {
// paths serve as alias
'npm:': 'node_modules/'
},
packageConfigPaths: [
'./node_modules/*/package.json',
"./node_modules/@mescius/*/package.json",
"./node_modules/@babel/*/package.json",
"./node_modules/@vue/*/package.json"
],
map: {
'vue': "npm:vue/dist/vue.esm-browser.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",
'@mescius/spread-sheets': 'npm:@mescius/spread-sheets/index.js',
'@mescius/spread-sheets-vue': 'npm:@mescius/spread-sheets-vue/index.js'
},
meta: {
'*.css': { loader: 'systemjs-plugin-css' },
'*.vue': { loader: "../plugin-vue/index.js" }
}
});
})(this);
