概述
本 Demo 展示了如何在 SpreadJS 中创建和使用迷你图。Demo 演示了三种迷你图类型(折线、柱形、胜负)的创建方式,并对比了带日期轴和不带日期轴的效果差异。同时提供了交互界面,用户可以选择数据范围并自定义迷你图类型和方向。
实现思路
准备示例数据,包括数值系列和对应的日期轴数据
创建迷你图设置对象 SparklineSetting,配置显示选项(标记、轴线、高低点等)
使用 setSparkline 方法创建 6 个迷你图,分别展示:
三种类型的不带日期轴的迷你图
三种类型的带日期轴的迷你图
绑定选区变化事件,当用户选中迷你图时更新界面信息
提供添加和移除迷你图的按钮,实现动态交互
代码解析
创建迷你图设置对象
这段代码创建了迷你图的配置对象。通过 options 属性可以控制迷你图的显示样式,如是否显示数据标记、轴线、以及是否用不同颜色突出显示特定数据点(首尾点、高低点、负值等)。
创建不带日期轴的迷你图
这段代码创建了一个折线迷你图。参数依次为:
2, 5: 迷你图所在的单元格位置
dataRange: 数据源范围(Range 对象)
DataOrientation.vertical: 数据方向为垂直
SparklineType.line: 迷你图类型为折线图
setting: 配置对象
创建带日期轴的迷你图
这段代码在创建迷你图时额外指定了日期轴范围。日期轴可以按照实际日期顺序排列数据点,而不是按照数据在表格中的位置顺序。
动态添加迷你图
这段代码从界面获取用户选择的参数,然后调用 setSparkline 方法创建迷你图。用户可以选择数据范围、目标单元格、迷你图类型和方向。
移除迷你图
这段代码遍历选区中的所有单元格,调用 removeSparkline 方法移除迷你图。
运行效果
页面加载后,表格上方显示数值数据(A 列)和日期数据(B 列)
中间区域展示 6 个迷你图示例:上方 3 个不带日期轴,下方 3 个带日期轴
每组包含折线、柱形、胜负三种类型,对比展示不同效果
点击任意迷你图单元格,右侧面板会显示该迷你图的位置、类型和方向信息
在右侧面板中选择数据范围,输入目标单元格位置,选择类型和方向后,点击"添加迷你图"按钮即可创建新的迷你图
点击"清除迷你图"按钮可移除选中的迷你图
API 参考
setSparkline 方法
row, col: 迷你图所在的单元格位置
dataRange: 数据源范围,Range 对象
dataOrientation: 数据方向,DataOrientation 枚举(Vertical 或 Horizontal)
sparklineType: 迷你图类型,SparklineType 枚举(line、column、winloss)
sparklineSetting: 配置对象,SparklineSetting 实例
dateAxisRange: 可选,日期轴范围
dateAxisOrientation: 可选,日期轴方向
SparklineType 枚举
line: 折线迷你图
column: 柱形迷你图
winloss: 胜负迷你图
SparklineSetting 类
用于配置迷你图的显示选项:
options.showMarkers: 是否显示数据标记
options.lineWeight: 线条宽度
options.displayXAxis: 是否显示 X 轴
options.showFirst: 是否高亮第一个点
options.showLast: 是否高亮最后一个点
options.showLow: 是否高亮最低点
options.showHigh: 是否高亮最高点
options.showNegative: 是否高亮负值点
removeSparkline 方法
移除指定单元格的迷你图。
getSparkline 方法
获取指定单元格的迷你图对象,返回 Sparkline 实例。
var spreadNS = GC.Spread.Sheets;
window.onload = function () {
var spread = new GC.Spread.Sheets.Workbook(document.getElementById("ss"));
initSpread(spread);
};
function initSpread(spread) {
var sheet = spread.getSheet(0);
sheet.suspendPaint();
sheet.options.allowCellOverflow = true;
var data = [1,-2,-1,6,4,-4,3,8];
var dateAxis = [new Date(2011, 0, 5),new Date(2011, 0, 1),new Date(2011, 1, 11),new Date(2011, 2, 1),
new Date(2011, 1, 1),new Date(2011, 1, 3),new Date(2011, 2, 6),new Date(2011, 1, 19)];
sheet.setValue(0, 0, "Series 1");
sheet.setValue(0, 1, "Series 2");
for(let i=0;i<8;i++)
{
sheet.setValue(i+1, 0,data[i]);
sheet.getCell(i+1, 1).value(dateAxis[i]).formatter("yyyy-mm-dd");
}
sheet.setColumnWidth(1,100);
sheet.setValue(11, 0, "*Data Range is A2-A9");
sheet.setValue(12, 0, "*Date axis range is B2-B9");
var dataRange = new spreadNS.Range(1, 0, 8, 1);
var dateAxisRange = new spreadNS.Range(1, 1, 8, 1);
sheet.getCell(0, 5).text("Sparkline without dateAxis:");
sheet.getCell(1, 5).text("(1) Line");
sheet.getCell(1, 8).text("(2) Column");
sheet.getCell(1, 11).text("(3) Winloss");
sheet.getCell(7, 5).text("Sparkline with dateAxis:");
sheet.getCell(8, 5).text("(1) Line");
sheet.getCell(8, 8).text("(2) Column");
sheet.getCell(8, 11).text("(3) Winloss");
//sparkline settings
var setting = new spreadNS.Sparklines.SparklineSetting();
setting.options.showMarkers = true;
setting.options.lineWeight = 3;
setting.options.displayXAxis = true;
setting.options.showFirst = true;
setting.options.showLast = true;
setting.options.showLow = true;
setting.options.showHigh = true;
setting.options.showNegative = true;
//line
sheet.addSpan(2, 5, 4, 3);
sheet.setSparkline(2, 5, dataRange
, spreadNS.Sparklines.DataOrientation.vertical
, spreadNS.Sparklines.SparklineType.line
, setting
);
sheet.addSpan(9, 5, 4, 3);
sheet.setSparkline(9, 5, dataRange
, GC.Spread.Sheets.Sparklines.DataOrientation.vertical
, GC.Spread.Sheets.Sparklines.SparklineType.line
, setting
, dateAxisRange
, GC.Spread.Sheets.Sparklines.DataOrientation.vertical
);
//column
sheet.addSpan(2, 8, 4, 3);
sheet.setSparkline(2, 8, dataRange
, spreadNS.Sparklines.DataOrientation.vertical
, spreadNS.Sparklines.SparklineType.column
, setting
);
sheet.addSpan(9, 8, 4, 3);
sheet.setSparkline(9, 8, dataRange
, GC.Spread.Sheets.Sparklines.DataOrientation.vertical
, GC.Spread.Sheets.Sparklines.SparklineType.column
, setting
, dateAxisRange
, GC.Spread.Sheets.Sparklines.DataOrientation.vertical
);
//winloss
sheet.addSpan(2, 11, 4, 3);
sheet.setSparkline(2, 11, dataRange
, spreadNS.Sparklines.DataOrientation.vertical
, spreadNS.Sparklines.SparklineType.winloss
, setting
);
sheet.addSpan(9, 11, 4, 3);
sheet.setSparkline(9, 11, dataRange
, GC.Spread.Sheets.Sparklines.DataOrientation.vertical
, GC.Spread.Sheets.Sparklines.SparklineType.winloss
, setting
, dateAxisRange
, GC.Spread.Sheets.Sparklines.DataOrientation.vertical
);
sheet.bind(spreadNS.Events.SelectionChanged, selectionChangedCallback);
sheet.resumePaint();
function selectionChangedCallback() {
var sheet = spread.getActiveSheet();
var sparkline = sheet.getSparkline(sheet.getActiveRowIndex(), sheet.getActiveColumnIndex());
if (sparkline) {
updateSetting(sparkline);
} else {
initSetting();
}
}
function updateSetting(sparkline) {
var type = sparkline.sparklineType(), orientation = sparkline.dataOrientation(),
row = sparkline.row, column = sparkline.column;
_getElementById("line_position").value = row + "," + column;
var line_type = _getElementById("line_type");
_selectOption(line_type, type + "");
var line_orientation = _getElementById("line_orientation");
_selectOption(line_orientation, orientation + "");
}
function initSetting() {
_getElementById("line_position").value = '';
var line_type = _getElementById("line_type");
_selectOption(line_type, '0');
var line_orientation = _getElementById("line_orientation");
_selectOption(line_orientation, '0');
}
function getActualCellRange(cellRange, rowCount, columnCount) {
if (cellRange.row == -1 && cellRange.col == -1) {
return new spreadNS.Range(0, 0, rowCount, columnCount);
}
else if (cellRange.row == -1) {
return new spreadNS.Range(0, cellRange.col, rowCount, cellRange.colCount);
}
else if (cellRange.col == -1) {
return new spreadNS.Range(cellRange.row, 0, cellRange.rowCount, columnCount);
}
return cellRange;
};
_getElementById("btnAddSparkline").addEventListener('click',function () {
var sheet = spread.getActiveSheet();
var range = getActualCellRange(sheet.getSelections()[0], sheet.getRowCount(), sheet.getColumnCount());
var rc = _getElementById("line_position").value.split(",");
var r = parseInt(rc[0]);
var c = parseInt(rc[1]);
var orientation = parseInt(_getElementById("line_orientation").value);
var type = parseInt(_getElementById("line_type").value);
if (!isNaN(r) && !isNaN(c)) {
sheet.setSparkline(r, c, range, orientation, type, setting);
}
});
_getElementById("btnClearSparkline").addEventListener('click',function () {
var sheet = spread.getActiveSheet();
var range = getActualCellRange(sheet.getSelections()[0], sheet.getRowCount(), sheet.getColumnCount());
for (var r = 0; r < range.rowCount; r++) {
for (var c = 0; c < range.colCount; c++) {
sheet.removeSparkline(r + range.row, c + range.col);
}
}
});
}
function _getElementById(id){
return document.getElementById(id);
}
function _selectOption(select, value) {
for (var i = 0; i < select.length; i++) {
var op = select.options[i];
if (op.value === value) {
op.selected = true;
} else {
op.selected = false;
}
}
}
<!doctype html>
<html style="height:100%;font-size:14px;">
<head>
<meta name="spreadjs culture" content="zh-cn" />
<meta charset="utf-8" />
<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$/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">
<div class="option-group">
<label><b>添加迷你图：</b></label>
</div>
<hr>
<div class="option-group">
<label>1. 在工作表中选择数据范围</label>
</div>
<div class="option-group">
<label for="line_position">2. 输入目标单元格（行,列索引）</label>
<input id="line_position" value="0,0" />
</div>
<div class="option-group">
<label for="line_position">3. 更改类型和方向</label>
</div>
<div class="option-group">
<label for="line_type" style="width: auto;">类型：</label>
<select id="line_type" class="position">
<option value="0">折线</option>
<option value="1">柱形</option>
<option value="2">胜负</option>
</select>
</div>
<div class="option-group">
<label for="line_orientation">方向：</label>
<select id="line_orientation" class="position">
<option value="0">垂直</option>
<option value="1">水平</option>
</select>
</div>
<div class="option-group">
<label for="line_position">4. 点击“添加迷你图”按钮</label>
</div>
<div class="option-group">
<input type="button" value="添加迷你图" id="btnAddSparkline">
</div>
<br>
<div>
<label><b>移除迷你图：</b></label>
</div>
<hr>
<div class="option-group">
<label>1. 选择迷你图</label>
</div>
<div class="option-group">
<label for="line_position">2. 点击“清除迷你图”按钮</label>
</div>
<div class="option-group">
<input type="button" value="清除迷你图" id="btnClearSparkline">
</div>
</div>
</div>
</body>
</html>
.sample {
position: relative;
height: 100%;
overflow: auto;
}
.sample::after {
display: block;
content: "";
clear: both;
}
.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;
}
.option-row {
font-size: 14px;
padding: 5px;
margin-top: 10px;
}
.option-group {
margin-bottom: 8px;
}
input,
select {
margin-top: 6px;
padding: 4px 4px;
width: 100%;
box-sizing: border-box;
}
body {
position: absolute;
top: 0;
bottom: 0;
left: 0;
right: 0;
}
