To add conditional formatting in SpreadJS, first use the conditionalFormats method to get the conditional format for the sheet. Then you can create a conditional rule and use the addRule method to add it. Also you can use the specified rule's add method, like addSpecificTextRule, addCellValueRule, and so on. For example:
After you add rules to the sheet, you can use the getRule method to return the rule using the rule index or get all the conditional rules. For example:
If you want to remove the conditional rule, use the removeRule, removeRuleByRange, or clearRule methods. For example:
<template>
<div class="sample-tutorial">
<gc-spread-sheets class="sample-spreadsheets" @workbook-initialized="initSpread">
<gc-worksheet></gc-worksheet>
</gc-spread-sheets>
<div class="options-container">
<p>Select cell(s) that contains rule(s):</p>
<div class="option-row">
<input id="ruleCount" style="border: none;" :value="ruleCountDescription" />
</div>
<div class="option-row">
<input type="button" id="removeRule" value="Remove the selection's rule" @click="removeRule" />
<input type="button" id="clearRule" value="Remove all the rules" @click="clearRule" />
</div>
</div>
</div>
</template>
<script setup>
import { ref } from 'vue';
import '@mescius/spread-sheets-vue';
import GC from '@mescius/spread-sheets';
const spread = ref(null);
const ruleCountDescription = ref('');
const initSpread = (spreadInstance) => {
spread.value = spreadInstance;
const spreadNS = GC.Spread.Sheets;
const sheet = spreadInstance.getSheet(0);
sheet.suspendPaint();
const cfs = sheet.conditionalFormats;
// sample title
sheet.addSpan(1, 1, 1, 7);
sheet.setValue(1, 1, "Conditional Format Samples");
sheet.getCell(1, 1).font("24px sans-serif");
sheet.getCell(1, 1).hAlign(spreadNS.HorizontalAlign.center);
sheet.setRowHeight(1, 35);
// cell value rule
let r = 2;
let c = 1;
let w = 3;
let h = 4;
sheet.addSpan(r, c, 1, w);
sheet.setValue(r, c, "Displays green background: value > 50:");
sheet.getCell(r, c).wordWrap(true);
sheet.setRowHeight(r, 40);
let increase = 0;
for (let row = 0; row < h - 1; row++) {
for (let col = 0; col < w; col++) {
sheet.setValue(row + 3, col + 1, increase);
increase += 10;
}
}
sheet.getRange(r, c, h, w).setBorder(
new spreadNS.LineBorder("Black", spreadNS.LineStyle.dashed),
{ all: true }
);
let style = new spreadNS.Style();
style.backColor = "#CCFFCC";
cfs.addCellValueRule(
spreadNS.ConditionalFormatting.ComparisonOperators.greaterThan,
50,
0,
style,
[new spreadNS.Range(r + 1, c, h - 1, w)]
);
r = 2;
c = 5;
sheet.addSpan(r, c, 1, w);
sheet.setValue(r, c, "Displays red background: value >= 60 and value <= 70:");
sheet.getCell(r, c).wordWrap(true);
sheet.setRowHeight(r, 40);
increase = 0;
for (let row = 0; row < h - 1; row++) {
for (let col = 0; col < w; col++) {
sheet.setValue(row + r + 1, col + c, increase);
increase += 10;
}
}
sheet.getRange(r, c, h, w).setBorder(
new spreadNS.LineBorder("Black", spreadNS.LineStyle.dashed),
{ all: true }
);
style = new spreadNS.Style();
style.backColor = "#FFCCCC";
cfs.addCellValueRule(
spreadNS.ConditionalFormatting.ComparisonOperators.between,
60,
70,
style,
[new spreadNS.Range(r + 1, c, h - 1, w)]
);
// 2 color scale rule
r = 7;
c = 1;
sheet.addSpan(r, c, 1, w);
sheet.setValue(r, c, "Displays two color gradient represents cell value:");
sheet.getCell(r, c).wordWrap(true);
sheet.setRowHeight(r, 40);
increase = 0;
for (let row = 0; row < h - 1; row++) {
for (let col = 0; col < w; col++) {
sheet.setValue(row + r + 1, col + c, increase);
increase += 10;
}
}
sheet.getRange(r, c, h, w).setBorder(
new spreadNS.LineBorder("Black", spreadNS.LineStyle.dashed),
{ all: true }
);
cfs.add2ScaleRule(
spreadNS.ConditionalFormatting.ScaleValueType.lowestValue,
null,
"#FF9999",
spreadNS.ConditionalFormatting.ScaleValueType.highestValue,
null,
"#9999FF",
[new spreadNS.Range(r + 1, c, h - 1, w)]
);
// 3 color scale rule
r = 7;
c = 5;
sheet.addSpan(r, c, 1, w);
sheet.setValue(r, c, "Displays three color gradient represents cell value:");
sheet.getCell(r, c).wordWrap(true);
sheet.setRowHeight(r, 40);
increase = 0;
for (let row = 0; row < h - 1; row++) {
for (let col = 0; col < w; col++) {
sheet.setValue(row + r + 1, col + c, increase);
increase += 10;
}
}
sheet.getRange(r, c, h, w).setBorder(
new spreadNS.LineBorder("Black", spreadNS.LineStyle.dashed),
{ all: true }
);
cfs.add3ScaleRule(
spreadNS.ConditionalFormatting.ScaleValueType.lowestValue,
null,
"#FF9999",
spreadNS.ConditionalFormatting.ScaleValueType.number,
100,
"#99FF99",
spreadNS.ConditionalFormatting.ScaleValueType.highestValue,
null,
"#9999FF",
[new spreadNS.Range(r + 1, c, h - 1, w)]
);
r = 12;
c = 1;
sheet.addSpan(r, c, 1, w);
sheet.setValue(r, c, "Display blue background if cell value is in next week:");
sheet.getCell(r, c).wordWrap(true);
sheet.setRowHeight(r, 40);
increase = 0;
for (let row = 0; row < h - 1; row++) {
for (let col = 0; col < w; col++) {
sheet.setValue(row + r + 1, col + c, addDays(new Date(), increase));
sheet.setFormatter(row + r + 1, col + c, "yyyy/mm/dd", spreadNS.SheetArea.viewport);
increase += 1;
}
}
sheet.getRange(r, c, h, w).setBorder(
new spreadNS.LineBorder("Black", spreadNS.LineStyle.dashed),
{ all: true }
);
style = new spreadNS.Style();
style.backColor = "#CCCCFF";
cfs.addDateOccurringRule(
spreadNS.ConditionalFormatting.DateOccurringType.nextWeek,
style,
[new spreadNS.Range(r + 1, c, h - 1, w)]
);
// specific text rule
r = 12;
c = 5;
sheet.addSpan(r, c, 1, w);
sheet.setValue(r, c, 'Display red foreground if cell value contains "o":');
sheet.getCell(r, c).wordWrap(true);
sheet.setRowHeight(r, 40);
let data = [
"The", "quick", "brown", "fox", "jumps", "over", "the", "lazy", "dog",
"The", "quick", "brown", "fox", "jumps", "over", "the", "lazy", "dog"
];
increase = 0;
for (let row = 0; row < h - 1; row++) {
for (let col = 0; col < w; col++) {
sheet.setValue(row + r + 1, col + c, data[increase]);
increase += 1;
}
}
sheet.getRange(r, c, h, w).setBorder(
new spreadNS.LineBorder("Black", spreadNS.LineStyle.dashed),
{ all: true }
);
style = new spreadNS.Style();
style.foreColor = "Red";
style.font = "bold 12px sans-serif";
cfs.addSpecificTextRule(
spreadNS.ConditionalFormatting.TextComparisonOperators.contains,
"o",
style,
[new spreadNS.Range(r + 1, c, h - 1, w)]
);
// data bar rule
r = 17;
c = 1;
sheet.addSpan(r, c, 1, w);
sheet.setValue(r, c, "Display a colored data bar represents cell value:");
sheet.getCell(r, c).wordWrap(true);
sheet.setRowHeight(r, 40);
increase = 0;
for (let row = 0; row < h - 1; row++) {
for (let col = 0; col < w; col++) {
sheet.setValue(row + r + 1, col + c, increase);
increase += 10;
}
}
sheet.getRange(r, c, h, w).setBorder(
new spreadNS.LineBorder("Black", spreadNS.LineStyle.dashed),
{ all: true }
);
let dataBarRule = cfs.addDataBarRule(
spreadNS.ConditionalFormatting.ScaleValueType.lowestValue,
null,
spreadNS.ConditionalFormatting.ScaleValueType.highestValue,
null,
"green",
[new spreadNS.Range(r + 1, c, h - 1, w)]
);
dataBarRule.gradient(true);
dataBarRule.showBorder(false);
dataBarRule.showBarOnly(false);
// icon set rule
r = 17;
c = 5;
sheet.addSpan(r, c, 1, w);
sheet.setValue(r, c, "Displays an icon represents cell value:");
sheet.getCell(r, c).wordWrap(true);
sheet.setRowHeight(r, 40);
increase = 0;
for (let row = 0; row < h - 1; row++) {
for (let col = 0; col < w; col++) {
sheet.setValue(row + r + 1, col + c, increase);
increase += 10;
}
}
sheet.getRange(r, c, h, w).setBorder(
new spreadNS.LineBorder("Black", spreadNS.LineStyle.dashed),
{ all: true }
);
let iconSetRule = cfs.addIconSetRule(
spreadNS.ConditionalFormatting.IconSetType.fiveArrowsColored,
[new spreadNS.Range(r + 1, c, h - 1, w)]
);
iconSetRule.iconSetType();
iconSetRule.reverseIconOrder(false);
iconSetRule.showIconOnly(false);
sheet.resumePaint();
updateRuleCount();
};
const addDays = (date, days) => {
let dt = new Date(date.getFullYear(), date.getMonth(), date.getDate() + days);
if (days) {
if (dt.getDate() === date.getDate()) {
dt = new Date(date.getFullYear(), date.getMonth(), date.getDate());
dt.setTime(dt.getTime() + days * 24 * 3600 * 1000);
}
}
return dt;
};
const removeRule = () => {
const sheet = spread.value.getSheet(0);
const cfs = sheet.conditionalFormats;
const sels = sheet.getSelections();
if (sels && sels.length > 0) {
const sel = sels[0];
cfs.removeRuleByRange(sel.row, sel.col, sel.rowCount, sel.colCount);
updateRuleCount();
}
};
const clearRule = () => {
const sheet = spread.value.getSheet(0);
const cfs = sheet.conditionalFormats;
cfs.clearRule();
updateRuleCount();
};
const updateRuleCount = () => {
const sheet = spread.value.getSheet(0);
const cfs = sheet.conditionalFormats;
ruleCountDescription.value = "Rule Count: " + cfs.count();
};
</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;
overflow: auto;
padding: 12px;
height: 100%;
box-sizing: border-box;
background: #fbfbfb;
}
.option-row {
padding-top: 6px;
}
input {
padding: 4px 8px;
margin-bottom: 6px;
box-sizing: border-box;
}
body {
position: absolute;
top: 0;
bottom: 0;
left: 0;
right: 0;
}
</style>
<!DOCTYPE html>
<html lang="en">
<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);
