Built-in Style Rules
There are several built-in style rules for each taskbar type (GC.Spread.Sheets.GanttSheet.TaskbarStyleRuleName):
durationOnly
durationOnlyMilestone
finishOnly
finishOnlyMilestone
manualMilestone
manualProgress
manualSummary
manualTask
milestone
progress
projectSummary
startOnly
startOnlyMilestone
summary
task
You can get the style rule and change its style properties like so:
Configurable Style Properties
startShape: GC.Spread.Sheets.GanttSheet.TaskbarEndShape
startType: GC.Spread.Sheets.GanttSheet.TaskbarEndType
startColor: string
endShape: GC.Spread.Sheets.GanttSheet.TaskbarEndShape
endType: GC.Spread.Sheets.GanttSheet.TaskbarEndType
endColor: string
middleShape: GC.Spread.Sheets.GanttSheet.TaskbarMiddleShape
middlePattern: GC.Spread.Sheets.GanttSheet.TaskbarFillPattern
middleColor: string
leftText: string
rightText: string
topText: string
bottomText: string
insideText: string
Text properties like leftText support the data field name and column formula:
Custom Style Rules
You can create a custom style rule based on the base style rule class (GC.Spread.Sheets.GanttSheet.TaskbarStyleRule):
Then add your custom style rule to the taskbar style rule collection (GC.Spread.Sheets.GanttSheet.TaskbarStyleRules):
You can update an existing custom style rule:
<template>
<div id="split-view" class="sample-tutorial">
<gc-spread-sheets class="sample-spreadsheets split-content" @workbookInitialized="initSpread">
</gc-spread-sheets>
<div class="options-container split-panel">
<div class="option-row option-title">
Config the taskbar style rules.
</div>
<div class="option-block">
<div class="option-row selection-box">
<label for="rule-name">Rule Name</label>
<select id="rule-name" v-model="ruleName" @change="syncConfigFromStyle()">
<option value="durationOnly">durationOnly</option>
<option value="durationOnlyMilestone">durationOnlyMilestone</option>
<option value="finishOnly">finishOnly</option>
<option value="finishOnlyMilestone">finishOnlyMilestone</option>
<option value="manualMilestone">manualMilestone</option>
<option value="manualProgress">manualProgress</option>
<option value="manualSummary">manualSummary</option>
<option value="manualTask">manualTask</option>
<option value="milestone">milestone</option>
<option value="progress">progress</option>
<option value="projectSummary">projectSummary</option>
<option value="startOnly">startOnly</option>
<option value="startOnlyMilestone">startOnlyMilestone</option>
<option value="summary">summary</option>
<option value="task" selected>task</option>
</select>
</div>
<div class="option-row">
<input type="button" id="set-style" class="option-button" value="Set Taskbar Styles"
@click="setStyle()">
</div>
</div>
<div class="option-block">
<div class="option-row option-title">
Config the taskbar style.
</div>
<div class="option-block">
<div class="option-row option-title">
Start
</div>
<div class="option-row selection-box">
<label for="start-shape">Shape</label>
<select id="start-shape" v-model="startShape">
<option value=""></option>
<option value="arrowDown">arrowDown</option>
<option value="arrowUp">arrowUp</option>
<option value="caretDownTop">caretDownTop</option>
<option value="caretUpBottom">caretUpBottom</option>
<option value="circle">circle</option>
<option value="circleArrowDown">circleArrowDown</option>
<option value="circleArrowUp">circleArrowUp</option>
<option value="circleDiamond">circleDiamond</option>
<option value="circleTriangleDown">circleTriangleDown</option>
<option value="circleTriangleUp">circleTriangleUp</option>
<option value="diamond">diamond</option>
<option value="houseDown">houseDown</option>
<option value="houseUp">houseUp</option>
<option value="leftBracket">leftBracket</option>
<option value="leftFade">leftFade</option>
<option value="lineShape" selected>lineShape</option>
<option value="rightBracket">rightBracket</option>
<option value="rightFade">rightFade</option>
<option value="square">square</option>
<option value="star">star</option>
<option value="triangleDown">triangleDown</option>
<option value="triangleLeft">triangleLeft</option>
<option value="triangleRight">triangleRight</option>
<option value="triangleUp">triangleUp</option>
</select>
</div>
<div class="option-row selection-box">
<label for="start-type">Type</label>
<select id="start-type" v-model="startType">
<option value=""></option>
<option value="solid" selected>solid</option>
<option value="dashed">dashed</option>
<option value="framed">framed</option>
</select>
</div>
<div class="option-row input-box">
<label for="start-color">Color</label>
<input type="text" id="start-color" v-model="startColor" />
<div class="option-info valid">* valid value: color string</div>
</div>
</div>
<div class="option-block">
<div class="option-row option-title">
Middle
</div>
<div class="option-row selection-box">
<label for="middle-shape">Shape</label>
<select id="middle-shape" v-model="middleShape">
<option value=""></option>
<option value="lineBottom">lineBottom</option>
<option value="lineMiddle">lineMiddle</option>
<option value="lineTop">lineTop</option>
<option value="rectangleBar" selected>rectangleBar</option>
<option value="rectangleBottom">rectangleBottom</option>
<option value="rectangleMiddle">rectangleMiddle</option>
<option value="rectangleTop">rectangleTop</option>
</select>
</div>
<div class="option-row selection-box">
<label for="middle-pattern">Fill Pattern</label>
<select id="middle-pattern" v-model="middlePattern">
<option value=""></option>
<option value="darkFill">darkFill</option>
<option value="dashedBorder">dashedBorder</option>
<option value="diagonalCross">diagonalCross</option>
<option value="diagonalLeft" selected>diagonalLeft</option>
<option value="diagonalRight">diagonalRight</option>
<option value="hollow">hollow</option>
<option value="lightFill">lightFill</option>
<option value="lineCross">lineCross</option>
<option value="lineHorizontal">lineHorizontal</option>
<option value="lineVertical">lineVertical</option>
<option value="mediumFill">mediumFill</option>
<option value="solidFill">solidFill</option>
</select>
</div>
<div class="option-row input-box">
<label for="middle-color">Color</label>
<input type="text" id="middle-color" v-model="middleColor" />
<div class="option-info valid">* valid value: color string</div>
</div>
</div>
<div class="option-block">
<div class="option-row option-title">
End
</div>
<div class="option-row selection-box">
<label for="end-shape">Shape</label>
<select id="end-shape" v-model="endShape">
<option value=""></option>
<option value="arrowDown">arrowDown</option>
<option value="arrowUp">arrowUp</option>
<option value="caretDownTop">caretDownTop</option>
<option value="caretUpBottom">caretUpBottom</option>
<option value="circle">circle</option>
<option value="circleArrowDown">circleArrowDown</option>
<option value="circleArrowUp">circleArrowUp</option>
<option value="circleDiamond">circleDiamond</option>
<option value="circleTriangleDown">circleTriangleDown</option>
<option value="circleTriangleUp">circleTriangleUp</option>
<option value="diamond">diamond</option>
<option value="houseDown">houseDown</option>
<option value="houseUp">houseUp</option>
<option value="leftBracket">leftBracket</option>
<option value="leftFade">leftFade</option>
<option value="lineShape" selected>lineShape</option>
<option value="rightBracket">rightBracket</option>
<option value="rightFade">rightFade</option>
<option value="square">square</option>
<option value="star">star</option>
<option value="triangleDown">triangleDown</option>
<option value="triangleLeft">triangleLeft</option>
<option value="triangleRight">triangleRight</option>
<option value="triangleUp">triangleUp</option>
</select>
</div>
<div class="option-row selection-box">
<label for="end-type">Type</label>
<select id="end-type" v-model="endType">
<option value=""></option>
<option value="solid" selected>solid</option>
<option value="dashed">dashed</option>
<option value="framed">framed</option>
</select>
</div>
<div class="option-row input-box">
<label for="end-color">Color</label>
<input type="text" id="end-color" v-model="endColor" />
<div class="option-info valid">* valid value: color string</div>
</div>
</div>
</div>
<div class="option-block">
<div class="option-row option-title">
Config the taskbar text.
</div>
<div class="option-row input-box">
<label for="left-text">Left Text</label>
<input type="text" id="left-text" v-model="leftText" />
<div class="option-info valid">* valid value: field string or column formula</div>
</div>
<div class="option-row input-box">
<label for="right-text">Right Text</label>
<input type="text" id="right-text" v-model="rightText" />
<div class="option-info valid">* valid value: field string or column formula</div>
</div>
<div class="option-row input-box">
<label for="top-text">Top Text</label>
<input type="text" id="top-text" v-model="topText" />
<div class="option-info valid">* valid value: field string or column formula</div>
</div>
<div class="option-row input-box">
<label for="bottom-text">Bottom Text</label>
<input type="text" id="bottom-text" v-model="bottomText" />
<div class="option-info valid">* valid value: field string or column formula</div>
</div>
<div class="option-row input-box">
<label for="inside-text">Inside Text</label>
<input type="text" id="inside-text" v-model="insideText" />
<div class="option-info valid">* valid value: field string or column formula</div>
</div>
</div>
</div>
</div>
</template>
<script setup>
import GC from "@mescius/spread-sheets";
import { ref } from "vue";
import "@mescius/spread-sheets-tablesheet";
import "@mescius/spread-sheets-ganttsheet";
import "@mescius/spread-sheets-vue";
const spreadRef = ref(null);
let myTable = null;
let ganttSheet = null;
let spread = null;
const ruleName = ref("task");
const startShape = ref("");
const startType = ref("");
const startColor = ref("");
const middleShape = ref("rectangleBar");
const middlePattern = ref("diagonalLeft");
const middleColor = ref("#8abbed");
const endShape = ref("");
const endType = ref("");
const endColor = ref("");
const leftText = ref("");
const rightText = ref("");
const topText = ref("");
const bottomText = ref("");
const insideText = ref("");
function initSpread(spread) {
spreadRef.value = spread;
spread.suspendPaint();
spread.clearSheets();
initDataSource(spread);
initGanttSheet(spread);
spread.resumePaint();
initSplitView(spread);
};
function initDataSource(spread) {
var tableName = "Gantt_Id";
var baseApiUrl = getBaseApiUrl();
var apiUrl = baseApiUrl + "/" + tableName;
var dataManager = spread.dataManager();
myTable = dataManager.addTable("myTable", {
batch: true,
remote: {
read: {
url: apiUrl
}
},
schema: {
hierarchy: {
type: "Parent",
column: "parentId"
},
columns: {
id: { isPrimaryKey: true },
taskNumber: { dataType: "rowOrder" }
}
}
});
};
function initGanttSheet(spread) {
ganttSheet = spread.addSheetTab(0, "GanttSheet", GC.Spread.Sheets.SheetType.ganttSheet);
var view = myTable.addView("ganttView", [
{ value: "taskNumber", caption: "NO.", width: 60 },
{ value: "mode", caption: "Mode", width: 65 },
{ value: "name", caption: "Task Name", width: 200 },
{ value: "duration", caption: "Duration", width: 90 },
{ value: "predecessors", caption: "Predecessors", width: 120, visible: false }
]);
view.fetch().then(function () {
ganttSheet.bindGanttView(view);
}).then(function () {
let taskRule = ganttSheet.project.taskStyleRules.getRule("task");
let taskStyle = taskRule.style.taskbarStyle;
taskStyle.middleColor = "#abd08f";
taskRule.style.taskbarStyle = taskStyle;
let summaryRule = ganttSheet.project.taskStyleRules.getRule("summary");
let summaryStyle = summaryRule.style.taskbarStyle;
summaryStyle.middleColor = "#00b050";
summaryStyle.startShape = "leftBracket";
summaryStyle.startColor = "#578335";
summaryStyle.endShape = "rightBracket";
summaryStyle.endColor = "#578335";
summaryRule.style.taskbarStyle = summaryStyle;
});
};
function syncConfigFromStyle() {
var styleRuleName = ruleName.value;
var targetStyle = ganttSheet.project.taskStyleRules.getRule(styleRuleName).style.taskbarStyle;
if (targetStyle) {
startShape.value = targetStyle.startShape;
startType.value = targetStyle.startType;
startColor.value = targetStyle.startColor ? targetStyle.startColor : "";
middleShape.value = targetStyle.middleShape;
middlePattern.value = targetStyle.middlePattern;
middleColor.value = targetStyle.middleColor ? targetStyle.middleColor : "";
endShape.value = targetStyle.endShape;
endType.value = targetStyle.endType;
endColor.value = targetStyle.endColor ? targetStyle.endColor : "";
leftText.value = targetStyle.leftText || "";
rightText.value = targetStyle.rightText || "";
topText.value = targetStyle.topText || "";
bottomText.value = targetStyle.bottomText || "";
insideText.value = targetStyle.insideText || "";
}
};
function getStyleFromConfig(targetStyle) {
if (!targetStyle) {
targetStyle = {};
}
targetStyle.startShape = startShape.value;
targetStyle.startType = startType.value;
targetStyle.startColor = startColor.value;
targetStyle.middleShape = middleShape.value;
targetStyle.middlePattern = middlePattern.value;
targetStyle.middleColor = middleColor.value;
targetStyle.endShape = endShape.value;
targetStyle.endType = endType.value;
targetStyle.endColor = endColor.value;
targetStyle.leftText = leftText.value;
targetStyle.rightText = rightText.value;
targetStyle.topText = topText.value;
targetStyle.bottomText = bottomText.value;
targetStyle.insideText = insideText.value;
return targetStyle;
};
function setStyle() {
ganttSheet.suspendPaint();
var styleRuleName = ruleName.value;
var targetStyleRule = ganttSheet.project.taskStyleRules.getRule(styleRuleName);
let ruleType = ["task", "milestone", "summary", "projectSummary", "manualTask", "manualMilestone", "durationOnly", "manualSummary", "startOnly", "finishOnly", "durationOnlyMilestone", "startOnlyMilestone", "finishOnlyMilestone", "progress", "manualProgress"];
let style = targetStyleRule.style;
style.taskbarStyle = getStyleFromConfig(style.taskbarStyle);
ganttSheet.project.taskStyleRules.setItemAt(ruleType.indexOf(styleRuleName), targetStyleRule);
ganttSheet.resumePaint()
}
function initSplitView(spread) {
var host = document.getElementById("split-view");
var content = host.getElementsByClassName("split-content")[0];
var panel = host.getElementsByClassName("split-panel")[0];
new SplitView({
host: host,
content: content,
panel: panel,
refreshContent: function () {
spread.refresh();
}
});
}
function getBaseApiUrl() {
return window.location.href.match(/http.+spreadjs\/demos\//)[0] + 'server/api';
}
</script>
<style scoped>
#app {
height: 100%;
}
.sample-tutorial {
position: relative;
height: 100%;
overflow: hidden;
}
.sample-spreadsheets {
width: 100%;
height: 100%;
overflow: hidden;
float: left;
}
body {
position: absolute;
top: 0;
bottom: 0;
left: 0;
right: 0;
}
.options-container {
float: right;
width: 280px;
padding: 12px;
height: 100%;
box-sizing: border-box;
background: #fbfbfb;
overflow: auto;
box-shadow: inset 0px 0 4px 0 rgba(0, 0, 0, 0.4);
}
.option-block {
background: #fff;
padding: 8px;
margin: 12px 0;
border-radius: 4px;
border: 1px dashed #82bc00;
box-shadow: 0px 0 6px 0 rgba(0, 0, 0, 0.1);
}
.option-block.toggle {
border: 1px dotted #f7a711;
}
.option-row {
font-size: 14px;
box-sizing: border-box;
padding: 4px 0;
}
.option-title {
font-weight: bold;
color: #656565;
}
.option-info {
font-size: 12px;
color: #919191;
margin-top: 6px;
font-weight: normal;
}
.option-info.valid {
color: #82bc00;
}
.option-info.toggle {
color: #f7a711;
}
.option-button {
width: 100%;
padding: 0;
line-height: 20px;
background: #82bc00;
color: #fff;
transition: 0.3s;
cursor: pointer;
outline: none;
border-radius: 4px;
box-sizing: border-box;
box-shadow: 0 1px 4px 0 rgba(0, 0, 0, 0.3);
border: none;
}
.option-button:hover {
background: #82bc00;
color: #fff;
box-shadow: 0 3px 8px 0 rgba(0, 0, 0, 0.4);
}
.option-checkbox {
background: #fff;
border: 1px dashed #f7a711;
color: #f7a711;
padding: 2px 4px;
transition: 0.3s;
box-sizing: border-box;
cursor: pointer;
}
.option-checkbox.active {
color: #fff;
background: #f7a711;
box-shadow: 0 1px 4px 0 rgba(0, 0, 0, 0.3);
border-radius: 4px;
}
.selection-box {
position: relative;
}
.selection-box>select {
text-align: left;
width: 100%;
height: 20px;
padding: 0;
line-height: 20px;
background: transparent;
border: none;
border-bottom: 2px solid #656565;
color: #656565;
transition: 0.3s;
cursor: pointer;
outline: none;
box-sizing: border-box;
}
.selection-box>select>option {
background: white;
}
.selection-box>select:focus {
border-bottom: 2px solid #82bc00;
color: #82bc00;
box-shadow: 0 2px 6px 0 rgba(0, 0, 0, 0.3);
}
.selection-box>label {
position: absolute;
cursor: pointer;
font-size: 12px;
color: #fff;
background: #656565;
padding: 0 4px;
right: 0;
top: 6px;
box-shadow: 0 1px 4px 0 rgba(0, 0, 0, 0.3);
}
.input-box {
position: relative;
}
.input-box>input[type=text] {
width: 100%;
background: transparent;
border: none;
color: #656565;
border-bottom: 2px solid #656565;
outline: none;
box-sizing: border-box;
transition: 0.3s;
}
.input-box>input[type=text]:focus {
color: #82bc00;
border-bottom: 2px solid #82bc00;
}
.input-box>label {
cursor: pointer;
position: absolute;
right: 0;
top: 5px;
font-size: 12px;
color: #fff;
background: #656565;
padding: 0 4px;
box-shadow: 0 1px 4px 0 rgba(0, 0, 0, 0.3);
}
</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">
<link rel="stylesheet" type="text/css" href="$DEMOROOT$/spread/source/splitView/splitView.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 src="$DEMOROOT$/spread/source/splitView/SplitView.js"></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',
'@mescius/spread-sheets-tablesheet': 'npm:@mescius/spread-sheets-tablesheet/index.js',
'@mescius/spread-sheets-ganttsheet': 'npm:@mescius/spread-sheets-ganttsheet/index.js'
},
meta: {
'*.css': { loader: 'systemjs-plugin-css' },
'*.vue': { loader: "../plugin-vue/index.js" }
}
});
})(this);
