PivotTable Theme

Theme:

SpreadJS provides 85 predefined themes - 29 light, 28 medium and 28 dark themes - that can be applied to a PivotTable. And you can add custom themes.

You can change the PivotTable theme in the following ways:

    ///* function theme(theme: string | GC.Spread.Pivot.PivotTableTheme)
    /**
     * get or set pivot table theme
     * @param {string | PivotTableTheme} theme The param is style for pivot table
     * @example
     * pivotTable.theme(GC.Spread.Pivot.PivotTableThemes.light1.name())
     */
    theme (theme: string | PivotTableTheme): PivotTableTheme | void;

    let pivotTable = sheet.pivotTables.add("PivotTable", table.name(), 0, 0, GC.Spread.Pivot.PivotTableLayoutType.outline, GC.Spread.Pivot.PivotTableThemes.medium2.name());

    pivotTable.theme(GC.Spread.Pivot.PivotTableThemes.dark2.name());

You can also add custom themes and apply them.

    GC.Spread.Sheets.Workbook {
        //...

        // Customized Pivot Table Theme Manager
        customPivotTableThemes: CustomPivotTableThemesManager;
        /**
        * Set or get the default pivot table theme.
        */
        defaultPivotTableTheme: (name?: string) => GC.Spread.Pivot.PivotTableTheme | void;
    }
    class GC.Spread.Sheets.CustomPivotTableThemesManager {
        /**
        * Get all custom pivot table themes.
        */
        all: () => Array<GC.Spread.Pivot.PivotTableTheme>;
        /**
        * Get the custom pivot table theme by name.
        */
        get: (name: string) => GC.Spread.Pivot.PivotTableTheme | void;
        /**
        * Add the custom pivot table theme by name or style object.
        */
        add: (style: GC.Spread.Pivot.PivotTableTheme | string) => void;
        /**
        * Remove the custom pivot table theme by name.
        */
        remove: (name: string) => void;
        /**
        * Update the custom pivot table theme by name or style object.
        */
        update: (oldThemeName: string, newTheme: GC.Spread.Pivot.PivotTableTheme) => void;
    }

    const customTheme = new GC.Spread.Pivot.PivotTableTheme();
    customTheme.name("custom0");
    const whoTableStyle = new GC.Spread.Pivot.PivotTableStyle('red', 'white', '16px Calibri', new GC.Spread.Sheets.LineBorder('green'));
    customTheme.wholeTableStyle(whoTableStyle);
    spread.customPivotTableThemes.add(customTheme);

    pivotTable.theme("custom0");

    pivotTable.getStyleName(); // "custom0"

    // set default pivot table theme
    spread.defaultPivotTableTheme('custom0');

Feedback

Submit and view feedback for

This Product This Page

You can change the PivotTable theme in the following ways: You can also add custom themes and apply them.

window.onload = function () {
let spread = new GC.Spread.Sheets.Workbook(document.getElementById("ss"), {sheetCount: 2});
initCustomThemes(spread);
initSpread(spread);
};
function initCustomThemes(spread) {
const theme1 = new GC.Spread.Pivot.PivotTableTheme();
theme1.name('custom1');
theme1.wholeTableStyle(new GC.Spread.Pivot.PivotTableStyle('#b2dfdb', 'Text 1'));
theme1.headerRowStyle(new GC.Spread.Pivot.PivotTableStyle('#00695c', '#fff'));
theme1.reportFilterLabelsStyle(new GC.Spread.Pivot.PivotTableStyle('Accent 1 -50', '#fff'));
theme1.reportFilterValuesStyle(new GC.Spread.Pivot.PivotTableStyle('Accent 1 -50', '#fff'));
theme1.rowSubheading1Style(new GC.Spread.Pivot.PivotTableStyle('#e0f2f1', 'Text 1'))
theme1.rowSubheading2Style(new GC.Spread.Pivot.PivotTableStyle(undefined, 'Text 1'))
theme1.secondRowStripeStyle(new GC.Spread.Pivot.PivotTableStyle('#4db6ac'));
theme1.subtotalRow1Style(new GC.Spread.Pivot.PivotTableStyle(undefined, 'Text 1'));
theme1.grandTotalRowStyle(new GC.Spread.Pivot.PivotTableStyle('#00695c', '#fff'));
const theme2 = new GC.Spread.Pivot.PivotTableTheme();
theme2.name('custom2');
theme2.wholeTableStyle(new GC.Spread.Pivot.PivotTableStyle('#ECEFF1', 'Text 1'));
theme2.headerRowStyle(new GC.Spread.Pivot.PivotTableStyle('#455A64', '#fff'));
theme2.reportFilterLabelsStyle(new GC.Spread.Pivot.PivotTableStyle('#607D8B', '#fff'));
theme2.reportFilterValuesStyle(new GC.Spread.Pivot.PivotTableStyle('#607D8B', '#fff'));
theme2.rowSubheading1Style(new GC.Spread.Pivot.PivotTableStyle('#90A4AE', 'Text 1'))
theme2.rowSubheading2Style(new GC.Spread.Pivot.PivotTableStyle(undefined, 'Text 1'))
theme2.secondRowStripeStyle(new GC.Spread.Pivot.PivotTableStyle('#CFD8DC'));
theme2.subtotalRow1Style(new GC.Spread.Pivot.PivotTableStyle(undefined, 'Text 1'));
theme2.grandTotalRowStyle(new GC.Spread.Pivot.PivotTableStyle('#455A64', '#fff'));
spread.customPivotTableThemes.add(theme1);
spread.customPivotTableThemes.add(theme2);
}
function initSpread(spread) {
spread.suspendPaint();
let sheet1 = spread.getSheet(0);
let sheet2 = spread.getSheet(1);
let tableName = getDataSource(sheet2, pivotSales);
let pivotTable = initPivotTable(sheet1, tableName);
themeOptions(spread);
bindEvent(pivotTable);
columnFit(sheet2,0,6,100);
spread.resumePaint();
}
function getDataSource(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 initPivotTable(sheet, source){
sheet.name("PivotTable");
sheet.setRowCount(1000);
let option = {
bandRows:true,
bandColumns:true
};
let pivotTable = sheet.pivotTables.add("pivotTable", source, 1, 1, GC.Spread.Pivot.PivotTableLayoutType.outline, GC.Spread.Pivot.PivotTableThemes.medium8.name(), option);
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("total", "Totals", GC.Spread.Pivot.PivotTableFieldType.valueField, GC.Pivot.SubtotalType.sum);
let style = new GC.Spread.Sheets.Style();
style.formatter = "$ #,##0";
pivotTable.setStyle({dataOnly: true}, style);
pivotTable.resumeLayout();
pivotTable.autoFitColumn();
return pivotTable;
}
function columnFit(sheet, start, end, width){
for (let i = start; i < end; i++) {
sheet.setColumnWidth(i, width);
}
}
function bindEvent(pivotTable){
document.getElementById("pivotTable-theme").addEventListener("change", function(event){
let target = event.target;
pivotTable.theme(target.value);
});
}
function themeOptions(spread){
let pivotTableTheme = document.getElementById("pivotTable-theme");
let options = `<option themeNumber = 0>light0</option>`;
let themeType = ["light","medium","dark"], checked;
for (let i = 0; i< themeType.length; i++){
let n = 1;
for (n; n <= 28; n++) {
checked = "";
if(i === 1 && n === 1){
checked = "selected";
}
options += `<option ${checked}>${themeType[i]+n}</option>`;
}
}
const customThemes = spread.customPivotTableThemes.all();
if (customThemes && customThemes.length > 0) {
customThemes.forEach((theme) => {
options += `<option>${theme.name()}</option>`;
});
}
pivotTableTheme.innerHTML = options;
}

<!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/purejs/node_modules/@mescius/spread-sheets/styles/gc.spread.sheets.excel2013white.css">
<script src="$DEMOROOT$/en/purejs/node_modules/@mescius/spread-sheets/dist/gc.spread.sheets.all.min.js" type="text/javascript"></script>
<script src="$DEMOROOT$/en/purejs/node_modules/@mescius/spread-sheets-shapes/dist/gc.spread.sheets.shapes.min.js" type="text/javascript"></script>
<script src="$DEMOROOT$/en/purejs/node_modules/@mescius/spread-sheets-pivot-addon/dist/gc.spread.pivot.pivottables.min.js" type="text/javascript"></script>
<script src="$DEMOROOT$/spread/source/data/data.js" type="text/javascript"></script>
<script src="$DEMOROOT$/spread/source/js/license.js" type="text/javascript"></script>
<script src="$DEMOROOT$/spread/source/data/pivot-data.js" type="text/javascript"></script>
<script src="app.js" type="text/javascript"></script>
<link rel="stylesheet" type="text/css" href="styles.css">
</head>
<body>
<div class="sample-tutorial">
<div id="ss" class="sample-spreadsheets"></div>
<div id="container" class="select-theme">
<div class="option-group">
<label><b>Pivot Table Theme:</b></label>
</div>
<hr>
<div class="option-group">
<select name="theme" id="pivotTable-theme"></select>
</div> 
</div>
</div>
</body>
</html>

.sample-tutorial {
position: relative;
height: 100%;
overflow: hidden;
}
.sample-spreadsheets {
width: calc(100% - 280px);
height: 100%;
overflow: hidden;
float: left;
}
body {
position: absolute;
top: 0;
bottom: 0;
left: 0;
right: 0;
}
.select-theme {
width: 280px;
height: 100%;
padding: 12px;
float: right;
box-sizing: border-box;
background: #fbfbfb;
overflow: auto;
}
#pivotTable-theme {
display: block;
width: 250px;
margin-top: 10px;
}