ICascadeSparkLine

Interface ICascadeSparkLine

public interface ICascadeSparkLine

表示级联迷你图。

级联迷你图公开由 CASCADESPARKLINE 公式解析得到的数据和显示设置，包括点值、标签、点索引、边界、项类型和颜色。


 worksheet.getRange("A2:B4").setValue(new Object[][] {
     {"Salary", 3500},
     {"Bonus", 1200},
     {"Expense", -800}
 });
 worksheet.getRange("C2").setFormula("=CASCADESPARKLINE(B2:B4,1,A2:A4,,,\"#8CBF64\",\"#D6604D\",FALSE)");
 ICascadeSparkLine sparkLine = (ICascadeSparkLine) worksheet.getRange("C2").getValue();
 double[] points = sparkLine.getPoints();

Method Summary

Modifier and Type

Method

Description

String

getColorNegative()

获取第一个或最后一个负值迷你图框的颜色。

String

getColorPositive()

获取第一个或最后一个正值迷你图框的颜色。

String

getColorTotal()

获取总计迷你图框的颜色。

String[]

getItemTypes()

获取所有项类型。

String[]

getLabels()

获取级联迷你图的标签。

Double

getMaximum()

获取显示区域的最大值。

Double

getMinimum()

获取显示区域的最小值。

double

getPointIndex()

获取级联迷你图的点索引。

double[]

getPoints()

获取点的值。

boolean

getVertical()

获取级联迷你图框方向是垂直还是水平。

Method Details

getPoints

double[] getPoints()

获取点的值。

返回的数组包含级联迷你图中各点表示的数值。


 worksheet.getRange("A2:B4").setValue(new Object[][] {
     {"Salary", 3500},
     {"Bonus", 1200},
     {"Expense", -800}
 });
 worksheet.getRange("C2").setFormula("=CASCADESPARKLINE(B2:B4,1,A2:A4,,,\"#8CBF64\",\"#D6604D\",FALSE)");
 ICascadeSparkLine sparkLine = (ICascadeSparkLine) worksheet.getRange("C2").getValue();
 double[] points = sparkLine.getPoints();

Returns:: 包含点值的数组。

getPointIndex

double getPointIndex()

获取级联迷你图的点索引。

表示点的索引。点索引大于或等于 1。


 worksheet.getRange("A2:A4").setValue(new Object[] {"Start", "Increase", "End"});
 worksheet.getRange("B2:B4").setValue(new Object[] {100, 50, 150});
 worksheet.getRange("C2").setFormula("=CASCADESPARKLINE(B2:B4,1,A2:A4,,,\"#8CBF64\",\"#D6604D\",FALSE)");
 ICascadeSparkLine sparkLine = (ICascadeSparkLine) worksheet.getRange("C2").getValue();
 double pointIndex = sparkLine.getPointIndex();

Returns:: 级联迷你图的点索引。

getLabels

String[] getLabels()

获取级联迷你图的标签。

返回的数组包含与迷你图数据点关联的标签。默认值为 null。


 worksheet.getRange("A2:B4").setValue(new Object[][] {
     {"Salary", 3500},
     {"Bonus", 1200},
     {"Expense", -800}
 });
 worksheet.getRange("C2").setFormula("=CASCADESPARKLINE(B2:B4,1,A2:A4,,,\"#8CBF64\",\"#D6604D\",FALSE)");
 ICascadeSparkLine sparkLine = (ICascadeSparkLine) worksheet.getRange("C2").getValue();
 String[] labels = sparkLine.getLabels();

Returns:: 包含级联迷你图标签的数组；如果未指定标签，则为 null。

getMinimum

Double getMinimum()

获取显示区域的最小值。

此值定义用于显示级联迷你图的下限。默认值为 null。


 worksheet.getRange("A2:B4").setValue(new Object[][] {
     {"Salary", 3500},
     {"Bonus", 1200},
     {"Expense", -800}
 });
 worksheet.getRange("C2").setFormula("=CASCADESPARKLINE(B2:B4,1,A2:A4,-1000,,\"#8CBF64\",\"#D6604D\",FALSE)");
 ICascadeSparkLine sparkLine = (ICascadeSparkLine) worksheet.getRange("C2").getValue();
 Double minimum = sparkLine.getMinimum();

Returns:: 表示显示区域最小值的数字；如果未指定最小值，则为 null。

getMaximum

Double getMaximum()

获取显示区域的最大值。

此值定义用于显示级联迷你图的上限。默认值为 null。


 worksheet.getRange("A2:B4").setValue(new Object[][] {
     {"Salary", 3500},
     {"Bonus", 1200},
     {"Expense", -800}
 });
 worksheet.getRange("C2").setFormula("=CASCADESPARKLINE(B2:B4,1,A2:A4,,4000,\"#8CBF64\",\"#D6604D\",FALSE)");
 ICascadeSparkLine sparkLine = (ICascadeSparkLine) worksheet.getRange("C2").getValue();
 Double maximum = sparkLine.getMaximum();

Returns:: 表示显示区域最大值的数字；如果未指定最大值，则为 null。

getColorPositive

String getColorPositive()

获取第一个或最后一个正值迷你图框的颜色。

此颜色用于点值为正数的框。默认值为 "#8CBF64"。


 worksheet.getRange("A2:B4").setValue(new Object[][] {
     {"Salary", 3500},
     {"Bonus", 1200},
     {"Expense", -800}
 });
 worksheet.getRange("C2").setFormula("=CASCADESPARKLINE(B2:B4,1,A2:A4,,,\"#8CBF64\",\"#D6604D\",FALSE)");
 ICascadeSparkLine sparkLine = (ICascadeSparkLine) worksheet.getRange("C2").getValue();
 String color = sparkLine.getColorPositive();

Returns:: 第一个或最后一个正值迷你图框的颜色字符串。

getColorNegative

String getColorNegative()

获取第一个或最后一个负值迷你图框的颜色。

此颜色用于点值为负数的框。默认值为 "#D6604D"。


 worksheet.getRange("A2:B4").setValue(new Object[][] {
     {"Salary", 3500},
     {"Expense", -800},
     {"Bonus", 1200}
 });
 worksheet.getRange("C2").setFormula("=CASCADESPARKLINE(B2:B4,2,A2:A4,,,\"#8CBF64\",\"#D6604D\",FALSE)");
 ICascadeSparkLine sparkLine = (ICascadeSparkLine) worksheet.getRange("C2").getValue();
 String color = sparkLine.getColorNegative();

Returns:: 第一个或最后一个负值迷你图框的颜色字符串。

getVertical

boolean getVertical()

获取级联迷你图框方向是垂直还是水平。

true 表示框垂直显示，false 表示框水平显示。默认值为 false。


 worksheet.getRange("A2:A4").setValue(new Object[] {"Start", "Increase", "End"});
 worksheet.getRange("B2:B4").setValue(new Object[] {100, 50, 150});
 worksheet.getRange("C2").setFormula("=CASCADESPARKLINE(B2:B4,1,A2:A4,,,\"#8CBF64\",\"#D6604D\",TRUE)");
 ICascadeSparkLine sparkLine = (ICascadeSparkLine) worksheet.getRange("C2").getValue();
 boolean vertical = sparkLine.getVertical();

Returns:: 如果迷你图框垂直显示，则为 true；否则为 false。

getItemTypes

String[] getItemTypes()

获取所有项类型。

返回的项类型标识级联迷你图中每一项使用的标记。值应为 "-"、"+" 或 "="。默认值为 null。


 worksheet.getRange("A2:B4").setValue(new Object[][] {
     {"Income", 500},
     {"Expense", -200},
     {"Balance", 300}
 });
 worksheet.getRange("D2:D4").setValue(new Object[][] { { "+" }, { "-" }, { "=" } });
 worksheet.getRange("C2").setFormula("=CASCADESPARKLINE(B2:B4,3,A2:A4,,,\"#8CBF64\",\"#D6604D\",FALSE,D2:D4,\"#4F81BD\")");
 ICascadeSparkLine sparkLine = (ICascadeSparkLine) worksheet.getRange("C2").getValue();
 String[] itemTypes = sparkLine.getItemTypes();

Returns:: 包含级联迷你图项类型的数组；如果没有可用的项类型，则为 null。

getColorTotal

String getColorTotal()

获取总计迷你图框的颜色。

当 itemTypeRange 不存在时，此颜色表示最后一个迷你图框的颜色；当 itemTypeRange 存在时，此颜色表示结果迷你图框的颜色。默认值为 null。


 worksheet.getRange("A2:B4").setValue(new Object[][] {
     {"Income", 500},
     {"Expense", -200},
     {"Balance", 300}
 });
 worksheet.getRange("D2:D4").setValue(new Object[][] { { "+" }, { "-" }, { "=" } });
 worksheet.getRange("C2").setFormula("=CASCADESPARKLINE(B2:B4,3,A2:A4,,,\"#8CBF64\",\"#D6604D\",FALSE,D2:D4,\"#4F81BD\")");
 ICascadeSparkLine sparkLine = (ICascadeSparkLine) worksheet.getRange("C2").getValue();
 String color = sparkLine.getColorTotal();

Returns:: 总计迷你图框的颜色字符串；如果未指定总计颜色，则为 null。