You can set different filters to get the data that you need.
The user can set a filter as follows:
You can use the Label Filter as follows:
You can use the Value Filter as follows:
SpreadJS PivotTable supports five conditions:
For date filter operator, we also support month to date and quarter to date.
conType: Used to describe the type of condition
operator: Used to describe the operate type of filter; setting up an operator corresponds to the type of conType
SpreadJS PivotTables support two filters, and users can set filters using the following two data types, for example:
<template>
<div class="sample-tutorial">
<gc-spread-sheets class="sample-spreadsheets" @workbookInitialized="initSpread">
</gc-spread-sheets>
<div class="options-container">
<div class="whole-field">The following operations all work on <b>Salesperson</b> Field:</div>
<div>Label Filter:</div>
<div class="pivottable-filter label-filter">
<select name="labelFilter" id="labelFilter" class="pivot-filter" v-model="labelFilterRef">
<option value=1>equalsTo</option>
<option value=2>notEqualsTo</option>
<option value=3>beginsWith</option>
<option value=4>doesNotBeginWith</option>
<option value=5>endsWith</option>
<option value=6>doesNotEndWith</option>
<option value=7>contains</option>
<option value=8>doesNotContain</option>
<option value=9>greaterThan</option>
<option value=10>greaterThanOrEqualsTo</option>
<option value=11>lessThan</option>
<option value=12>lessThanOrEqualsTo</option>
<option value=13>between</option>
<option value=14>notBetween</option>
</select>
<input type="text" class="label-filter-input filter-input" id="label-val1" placeholder="value1"
v-model="label1Ref" />
<input type="text" class="label-filter-input filter-input" id="label-val2" placeholder="value2"
v-model="label2Ref" />
</div>
<input type="button" class="set-label-filter set-filter" id="set-label-filter" value="Set Label Filter"
@click="updatePivotLabelFilter" />
<br />
<input type="button" class="set-label-filter set-filter" id="clear-label-filter" value="Clear Label Filter"
@click="clearPivotLabelFilter" />
<br />
<hr />
<div class="value-filter-label">Value Filter:</div>
<div class="pivottable-filter value-filter">
<select name="valueFilter" id="valueFilter" class="pivot-filter" v-model="valueFilterRef">
<option value=1>equalsTo</option>
<option value=2>notEqualsTo</option>
<option value=3>greaterThan</option>
<option value=4>greaterThanOrEqualsTo</option>
<option value=5>lessThan</option>
<option value=6>lessThanOrEqualsTo</option>
<option value=7>between</option>
<option value=8>notBetween</option>
</select>
<input type="text" class="value-filter-input filter-input" id="value-val1" placeholder="value1"
v-model="value1Ref" />
<input type="text" class="value-filter-input filter-input" id="value-val2" placeholder="value2"
v-model="value2Ref" />
</div>
<input type="button" class="set-value-filter set-filter" id="set-value-filter" value="Set Value Filter"
@click="updatePivotValueFilter" />
<br />
<input type="button" class="clear-value-filter set-filter" id="clear-value-filter" value="Clear Value Filter"
@click="clearPivotValueFilter" />
<br />
<hr />
</div>
</div>
</template>
<script setup>
import GC from "@mescius/spread-sheets";
import "@mescius/spread-sheets-shapes";
import "@mescius/spread-sheets-vue";
import { shallowRef } from "vue";
import "@mescius/spread-sheets-pivot-addon";
let autoGenerateColumnsRef = shallowRef(false);
let autoMergeModeRef = shallowRef(GC.Spread.Sheets.AutoMerge.AutoMergeMode.restricted);
let autoMergeSelectionModeRef = shallowRef(GC.Spread.Sheets.AutoMerge.SelectionMode.merged);
let spreadRef = shallowRef(null);
let pivotTableRef = shallowRef(null);
let labelFilterRef = shallowRef(1);
let label1Ref = shallowRef(null);
let label2Ref = shallowRef(null);
let valueFilterRef = shallowRef(1);
let value1Ref = shallowRef(null);
let value2Ref = shallowRef(null);
async function initSpread(spread) {
spreadRef.value = spread;
spread.suspendPaint();
spread.setSheetCount(2);
let sheet1 = spread.getSheet(0);
let sheet2 = spread.getSheet(1);
let tableName = getSource(sheet2, pivotSales);
let pivotTable = addPivotTable(sheet1, tableName);
pivotTableRef.value = pivotTable;
spread.resumePaint();
}
function clearPivotLabelFilter () {
let spread = spreadRef.value;
let pivotTable = pivotTableRef.value;
spread.suspendPaint();
pivotTable.labelFilter("Salesperson", null);
label1Ref.value = "";
label2Ref.value = "";
labelFilterRef.value = 1;
spread.resumePaint();
}
function updatePivotLabelFilter () {
let spread = spreadRef.value;
let pivotTable = pivotTableRef.value;
spread.suspendPaint();
let labelType = labelFilterRef.value, labelFilterValue1 = label1Ref.value, labelFilterValue2 = label2Ref.value;
if (labelType) {
if (labelType < 13) {
labelFilterValue2 = null;
}
pivotTable.labelFilter("Salesperson", { condition: { conType: GC.Pivot.PivotConditionType.caption, val: [labelFilterValue1, labelFilterValue2], operator: labelType - 1 } });
} else {
pivotTable.labelFilter("Salesperson", null);
}
spread.resumePaint();
}
function clearPivotValueFilter () {
let spread = spreadRef.value;
let pivotTable = pivotTableRef.value;
spread.suspendPaint();
pivotTable.valueFilter("Salesperson", null);
value1Ref.value = null;
value2Ref.value = null;
valueFilterRef.value = 1;
spread.resumePaint();
}
function updatePivotValueFilter () {
let spread = spreadRef.value;
let pivotTable = pivotTableRef.value;
spread.suspendPaint();
let valueType = valueFilterRef.value, valueFilterValue1 = +value1Ref.value, valueFilterValue2 = +value2Ref.value;
if (valueType) {
if (valueType < 7) {
valueFilterValue2 = null;
}
pivotTable.valueFilter("Salesperson", { condition: { conType: GC.Pivot.PivotConditionType.value, val: [valueFilterValue1, valueFilterValue2], operator: valueType - 1 }, conditionByName: "Quantity" });
} else {
pivotTable.valueFilter("Salesperson", null);
}
spread.resumePaint();
}
function updatePivotSort (sortType) {
let spread = spreadRef.value;
let pivotTable = pivotTableRef.value;
spread.suspendPaint();
if (!sortType) {
pivotTable.sort("Salesperson", { sortType: GC.Pivot.SortType.asc });
} else {
pivotTable.sort("Salesperson", { sortType: GC.Pivot.SortType.desc });
}
spread.resumePaint();
}
function getSource (sheet, tableSource) {
sheet.name("DataSource");
sheet.setRowCount(117);
sheet.setColumnWidth(0, 120);
sheet.getCell(-1, 0).formatter("YYYY-mm-DD");
sheet.getRange(-1, 4, 0, 2).formatter("$ #,##0");
let table = sheet.tables.add('table', 0, 0, 117, 6);
for (let i = 2; i <= 117; i++) {
sheet.setFormula(i - 1, 5, '=D' + i + '*E' + i)
}
table.style(GC.Spread.Sheets.Tables.TableThemes["none"]);
sheet.setArray(0, 0, tableSource);
return table.name();
}
function addPivotTable (sheet, source) {
sheet.suspendPaint();
sheet.name("PivotTable");
sheet.setRowCount(10000);
let pivotTable = sheet.pivotTables.add("PivotTable", source, 1, 1, GC.Spread.Pivot.PivotTableLayoutType.outline, GC.Spread.Pivot.PivotTableThemes.light8);
pivotTable.suspendLayout();
pivotTable.add("salesperson", "Salesperson", GC.Spread.Pivot.PivotTableFieldType.rowField);
pivotTable.add("car", "Cars", GC.Spread.Pivot.PivotTableFieldType.rowField);
let groupInfo = { originFieldName: "date", dateGroups: [{ by: GC.Pivot.DateGroupType.quarters }] };
pivotTable.group(groupInfo);
pivotTable.add("Quarters (date)", "Quarters (date)", GC.Spread.Pivot.PivotTableFieldType.columnField);
pivotTable.add("quantity", "Quantity", GC.Spread.Pivot.PivotTableFieldType.valueField, GC.Pivot.SubtotalType.sum);
pivotTable.resumeLayout();
sheet.resumePaint();
pivotTable.autoFitColumn();
return pivotTable;
}
</script>
<style scoped>
.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;
font-size: 14px;
}
.pivottable-filter{
height: 100px;
}
.pivot-filter{
width: 200px;
height: 25px;
display: block;
margin-bottom: 10px;
float: left;
}
.filter-input{
width: 200px;
height: 20px;
display: block;
margin-top: 10px;
}
.set-filter{
width: 200px;
margin-top: 20px;
}
.value-filter-label{
margin-top: 25px;
}
.sort-type{
width: 200px;
margin-top: 25px;
display: block;
}
.sort{
width: 200px;
margin-top: 10px;
display: block;
}
body {
position: absolute;
top: 0;
bottom: 0;
left: 0;
right: 0;
}
.whole-field{
margin-bottom: 10px;
}
#app {
height: 100%;
}
</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$/spread/source/data/pivot-data.js" type="text/javascript"></script>
<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-resources-en': 'npm:@mescius/spread-sheets-resources-en/index.js',
'@mescius/spread-sheets-vue': 'npm:@mescius/spread-sheets-vue/index.js',
'@mescius/spread-sheets-pivot-addon': 'npm:@mescius/spread-sheets-pivot-addon/index.js',
'@mescius/spread-sheets-shapes': 'npm:@mescius/spread-sheets-shapes/index.js'
},
meta: {
'*.css': { loader: 'systemjs-plugin-css' },
'*.vue': { loader: "../plugin-vue/index.js" }
}
});
})(this);