切片器属性设置

概述本 Demo 展示了如何设置和自定义表格切片器的各项属性。Demo 创建了一个包含人员信息的表格，并基于 "Height" 列创建了切片器。通过右侧的控制面板，可以动态调整切片器的排序状态、样式、锁定状态以及动态移动和调整大小行为，同时还演示了如何创建和应用自定义切片器主题。实现思路创建表格并添加人员信息数据基于 "Height" 列创建切片器，并设置初始位置初始化两个自定义切片器主题（custom1 和 custom2），通过 spread.customSlicerThemes.add() 添加到工作簿监听切片器选中事件，当选中切片器时启用控制面板为各个表单控件绑定事件处理器，实现实时修改切片器属性代码解析创建切片器使用 sheet.slicers.add() 方法创建切片器，参数依次为切片器名称、表格名称和列名。position() 方法用于设置切片器的显示位置。创建自定义切片器主题创建自定义主题时，首先实例化 SlicerStyle 对象，可以使用 fromJSON() 方法基于现有样式创建。通过 wholeSlicerStyle() 设置切片器整体样式，最后使用 spread.customSlicerThemes.add() 将自定义主题添加到工作簿。设置切片器排序状态使用 sortState() 方法设置切片器项的排序顺序，可选值为 GC.Spread.Sheets.SortState.none、ascending 或 descending。设置动态移动和调整大小 dynamicMove(true) 和 dynamicSize(true)：切片器随单元格移动和调整大小 dynamicMove(true) 和 dynamicSize(false)：切片器随单元格移动但不调整大小 dynamicMove(false) 和 dynamicSize(true/false)：切片器不随单元格移动设置切片器样式使用 style() 方法应用内置样式或自定义主题，传入样式名称即可。运行效果点击切片器将其选中，右侧控制面板自动启用通过 "Sort State" 下拉框可以设置切片器项的排序方式（无排序、升序、降序）通过 "Styles" 下拉框可以选择 14 种内置样式或 2 个自定义主题勾选 "Protect Sheet" 并勾选 "Lock Slicer" 时，切片器被锁定，无法进行筛选操作选择不同的移动和调整大小选项，当调整行高或列宽时，切片器的行为会有所不同取消选中切片器时，控制面板自动禁用 API 参考 sheet.slicers.add(slicerName, targetName, itemName) slicerName：切片器名称 targetName：表格名称 itemName：列名 slicer.sortState(value) 获取或设置切片器的排序状态，值为 GC.Spread.Sheets.SortState 枚举。 slicer.dynamicMove(value) 和 slicer.dynamicSize(value) dynamicMove：是否随单元格移动 dynamicSize：是否随单元格调整大小 slicer.isLocked(value) 设置切片器的锁定状态，需配合工作表保护使用。 slicer.style(styleName) 设置切片器样式，可以是内置样式名称或自定义主题名称。 spread.customSlicerThemes.add(theme) 添加自定义切片器主题到工作簿。

window.onload = function () {
var spread = new GC.Spread.Sheets.Workbook(document.getElementById("ss"));
initCustomThemes(spread);
spread.suspendPaint();
var sheet = spread.getActiveSheet();
var dataColumns = ["Name", "City", "Birthday", "Sex", "Weight", "Height"];
var data = [
["Bob", "NewYork", "1968/6/8", "man", "80", "180"],
["Betty", "NewYork", "1972/7/3", "woman", "72", "168"],
["Gary", "NewYork", "1964/3/2", "man", "71", "179"],
["Hunk", "Washington", "1972/8/8", "man", "80", "171"],
["Cherry", "Washington", "1986/2/2", "woman", "58", "161"],
["Eva", "Washington", "1993/2/15", "woman", "71", "180"]];
sheet.tables.addFromDataSource("table1", 1, 1, data);
sheet.getRange(-1, 1, -1, 6).width(80);
var table = sheet.tables.findByName("table1");
table.setColumnName(0, dataColumns[0]);
table.setColumnName(1, dataColumns[1]);
table.setColumnName(2, dataColumns[2]);
table.setColumnName(3, dataColumns[3]);
table.setColumnName(4, dataColumns[4]);
table.setColumnName(5, dataColumns[5]);
var slicer1 = sheet.slicers.add("slicer1", "table1", "Height");
slicer1.position(new GC.Spread.Sheets.Point(100, 180));
bindSlicerEvent(spread);
spread.resumePaint();
_disableInput();
document.getElementById('protect_sheet').disabled = false;
clearSlicerSetting();
};
function initCustomThemes(spread) {
const theme1 = new GC.Spread.Sheets.Slicers.SlicerStyle();
theme1.fromJSON(GC.Spread.Sheets.Slicers.SlicerStyles.light1().toJSON());
theme1.name('custom1');
theme1.wholeSlicerStyle(new GC.Spread.Sheets.Slicers.SlicerStyleInfo('rgb(225, 245, 254)'));
const theme2 = new GC.Spread.Sheets.Slicers.SlicerStyle();
theme2.fromJSON(GC.Spread.Sheets.Slicers.SlicerStyles.other2().toJSON());
theme2.name('custom2');
const wholeSlicerStyle = new GC.Spread.Sheets.Slicers.SlicerStyleInfo();
wholeSlicerStyle.backColor('#e3f2fd');
theme2.wholeSlicerStyle(wholeSlicerStyle);
spread.customSlicerThemes.add(theme1);
spread.customSlicerThemes.add(theme2);
}
function bindSlicerEvent(spread) {
spread.bind(GC.Spread.Sheets.Events.SlicerChanged, function (event, args) {
var sheet = args.sheet;
var slicer = args.slicer;
if (!slicer) {
return;
}
var propertyName = args.propertyName;
if (propertyName === "isSelected") {
if (slicer.isSelected()) {
_activeInput()
initSlicerSetting(sheet, slicer);
}
else {
_disableInput();
document.getElementById('protect_sheet').disabled = false;
}
}
});
var sheet = spread.getActiveSheet();
// protect sheet
document.getElementById('protect_sheet').onchange = function (e) {
sheet.options.isProtected = e.target.checked;
};
// slicer sort state
document.getElementById('sort_state').onchange = function (e) {
setSlicerProperty({sheet: sheet}, "sortState", e.target.value);
};
// lock slicer
document.getElementById('lock_slicer').onchange = function (e) {
setSlicerProperty({sheet: sheet}, "isLocked", e.target.checked);
};
// slicer dynamic move and dynamic size
document.getElementById('slicer_move_size').onchange = function (e) {
setSlicerProperty({sheet: sheet}, "moveAndSize", e.target.checked);
};
document.getElementById('slicer_move_no_size').onchange = function (e) {
setSlicerProperty({sheet: sheet}, "moveAndNoSize", e.target.checked);
};
document.getElementById('slicer_no_move_size').onchange = function (e) {
setSlicerProperty({sheet: sheet}, "noMoveAndSize", e.target.checked);
};
document.getElementById('slicer_style').onchange = function (e) {
const styleName = document.getElementById('slicer_style').value;
if (styleName) {
setSlicerProperty({sheet: sheet}, "style", styleName);
}
};
}
function setSlicerProperty(data, property, value) {
var sheet = data && data.sheet;
if (!needChangeSlicer(sheet)) {
return;
}
var selectedSlicers = getSelectedSlicers(sheet);
for (var item in selectedSlicers) {
var slicer = selectedSlicers[item];
switch (property) {
case "sortState":
slicer.sortState(GC.Spread.Sheets.SortState[value]);
break;
case "isLocked":
slicer.isLocked(value);
break;
case "moveAndSize":
slicer.dynamicMove(true);
slicer.dynamicSize(true);
break;
case "moveAndNoSize":
slicer.dynamicMove(true);
slicer.dynamicSize(false);
break;
case "noMoveAndSize":
slicer.dynamicMove(false);
slicer.dynamicSize(false);
break;
case "style":
slicer.style(value);
break;
}
}
}
function initSlicerSetting(sheet, slicer) {
document.getElementById('sort_state').value = slicer.sortState() === 1 ? "ascending" :(slicer.sortState() === 2 ? "descending" : "");
document.getElementById('protect_sheet').checked = sheet.isProtected;
document.getElementById('lock_slicer').checked = slicer.isLocked();
var dynamicMove = slicer.dynamicMove(),
dynamicSize = slicer.dynamicSize();
if (!dynamicMove) {
document.getElementById('slicer_no_move_size').checked = true;
}
if (dynamicMove && !dynamicSize) {
document.getElementById('slicer_move_no_size').checked = true;
}
if (dynamicMove && dynamicSize) {
document.getElementById('slicer_move_size').checked = true;
}
}
function clearSlicerSetting() {
document.getElementById('sort_state').value = 'ascending';
document.getElementById('protect_sheet').checked = false;
document.getElementById('lock_slicer').checked = true;
document.getElementById('slicer_move_size').checked = true;
}
function getSelectedSlicers(sheet) {
if (!sheet) {
return null;
}
var slicers = sheet.slicers.all();
if (!slicers || _isEmptyObject(slicers)) {
return null;
}
var selectedSlicers = [];
for (var item in slicers) {
var slicer = slicers[item];
if (slicer.isSelected()) {
selectedSlicers.push(slicer);
}
}
return selectedSlicers;
}
function needChangeSlicer(sheet) {
if (!sheet) {
return false;
}
var selectedSlicers = getSelectedSlicers(sheet);
if (!selectedSlicers || selectedSlicers.length === 0) {
return false;
}
return true;
}
function _disableInput() {
var inputs = document.querySelectorAll('.option-group input, .option-group select');
for (var inputIndex = 0; inputIndex < inputs.length; inputIndex++) {
inputs[inputIndex].disabled = "disabled";
}
}
function _activeInput() {
var inputs = document.querySelectorAll('.option-group input, .option-group select');
for (var inputIndex = 0; inputIndex < inputs.length; inputIndex++) {
inputs[inputIndex].disabled = false;
}
}
function _isEmptyObject(obj) {
var name;
for (name in obj) {
return false;
}
return true;
}

<!doctype html>
<html style="height:100%;font-size:14px;">
<head>
<meta charset="utf-8" />
<meta name="spreadjs culture" content="zh-cn" />
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
<link rel="stylesheet" type="text/css" href="$DEMOROOT$/zh/purejs/node_modules/@grapecity-software/spread-sheets/styles/gc.spread.sheets.excel2013white.css">
<script src="$DEMOROOT$/zh/purejs/node_modules/@grapecity-software/spread-sheets/dist/gc.spread.sheets.all.min.js" type="text/javascript"></script>
<script src="$DEMOROOT$/zh/purejs/node_modules/@grapecity-software/spread-sheets-resources-zh/dist/gc.spread.sheets.resources.zh.min.js" type="text/javascript"></script>
<script src="$DEMOROOT$/zh/purejs/node_modules/@grapecity-software/spread-sheets-shapes/dist/gc.spread.sheets.shapes.min.js" type="text/javascript"></script>
<script src="$DEMOROOT$/zh/purejs/node_modules/@grapecity-software/spread-sheets-slicers/dist/gc.spread.sheets.slicers.min.js" type="text/javascript"></script>
<script src="$DEMOROOT$/spread/source/js/license.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 class="options-container">
<p>Select the slicer and then change the options.</p>
<div class="option-group">
<label for="sort_state">Sort State:</label>
<select id="sort_state">
<option value="none">none</option>
<option value="ascending">ascending</option>
<option value="descending">descending</option>
</select>
</div>
<div class="option-group">
<label for="slicer_style">Styles:</label>
<select id="slicer_style">
<option value="light1">Light1</option>
<option value="light2">Light2</option>
<option value="light3">Light3</option>
<option value="light4">Light4</option>
<option value="light5">Light5</option>
<option value="light6">Light6</option>
<option value="other1">Other1</option>
<option value="other2">Other2</option>
<option value="dark1">Dark1</option>
<option value="dark2">Dark2</option>
<option value="dark3">Dark3</option>
<option value="dark4">Dark4</option>
<option value="dark5">Dark5</option>
<option value="dark6">Dark6</option>
<option value="custom1">Custom1</option>
<option value="custom2">Custom2</option>
</select>
</div>
<hr>
<div class="option-group">
<input type="checkbox" id="protect_sheet" />
<label for="protect_sheet">Protect Sheet</label>
</div>
<div class="option-group">
<input type="checkbox" id="lock_slicer" checked />
<label for="lock_slicer">Lock Slicer</label>
</div>
<hr>
<div class="option-group">
<input type="radio" name="dynamic_move_size" value="move_size" id="slicer_move_size" checked />
<label for="slicer_move_size">Move and size with cells</label>
</div>
<div class="option-group">
<input type="radio" name="dynamic_move_size" value="move_no_size" id="slicer_move_no_size" />
<label for="slicer_move_no_size">Move and don't size with cells</label>
</div>
<div class="option-group">
<input type="radio" name="dynamic_move_size" value="no_move_size" id="slicer_no_move_size" />
<label for="slicer_no_move_size">Don't move and size with cells</label>
</div>
</div>
</div>
</body>
</html>

.sample-tutorial {
position: relative;
height: 100%;
overflow: hidden;
}
.sample-spreadsheets {
width: calc(100% - 280px);
height: 100%;
overflow: auto;
float: left;
}
.options-container {
float: right;
width: 280px;
padding: 12px;
height: 100%;
box-sizing: border-box;
background: #fbfbfb;
overflow: auto;
}
.option-group {
margin-bottom: 6px;
}
label {
display: inline-block;
min-width: 90px;
margin: 6px 0;
}
input {
padding: 4px 6px;
box-sizing: border-box;
margin-bottom: 6px;
}
hr {
border-color: #fff;
opacity: .2;
margin: 12px 0;
}
p {
padding: 2px 10px;
background-color: #F4F8EB;
}
body {
position: absolute;
top: 0;
bottom: 0;
left: 0;
right: 0;
}

SpreadJS 在线示例