ISparkline

Interface ISparkline

public interface ISparkline

表示单个迷你图。

ISparkline 定义工作表中的一个迷你图项，包括显示迷你图的单元格以及用于生成迷你图的源区域。单个迷你图通常从 ISparklineGroup 获取。


 worksheet.getRange("A1:C1").setValue(new Object[] {10, 20, 15});
 ISparklineGroup group = worksheet.getRange("D1").getSparklineGroups().add(SparkType.Line, "A1:C1");
 ISparkline sparkline = group.get(0);
 IRange location = sparkline.getLocation();
 String sourceData = sparkline.getSourceData();

Method Summary

Modifier and Type

Method

Description

void

fromJson(String json)

从 JSON 字符串生成迷你图。

IRange

getLocation()

获取单个迷你图的位置。

String

getSourceData()

获取包含单个迷你图源数据的区域。

void

setLocation(IRange value)

设置单个迷你图的位置。

void

setSourceData(String value)

设置包含单个迷你图源数据的区域。

String

toJson()

从迷你图生成 JSON 字符串。

Method Details

getLocation

IRange getLocation()

获取单个迷你图的位置。

返回表示显示迷你图的单元格的 IRange。


 worksheet.getRange("A1:B2").setValue(new Object[][] {
     {10, 20},
     {30, 40}
 });
 ISparkline sparkline = worksheet.getRange("D1").getSparklineGroups().add(SparkType.Line, "A1:B1").get(0);
 IRange location = sparkline.getLocation();

Returns:: 表示单个迷你图位置的 IRange 对象。

setLocation

void setLocation(IRange value)

设置单个迷你图的位置。

使用此方法可通过指定表示其显示位置的 IRange，将迷你图移动到另一个单元格。


 worksheet.getRange("A1:C1").setValue(new Object[] {1, 3, 2});
 ISparklineGroup group = worksheet.getRange("D1").getSparklineGroups().add(SparkType.Line, "A1:C1");
 ISparkline sparkline = group.get(0);
 sparkline.setLocation(worksheet.getRange("E1"));

Parameters:: value - 表示迷你图位置的 IRange 对象。

getSourceData

String getSourceData()
获取包含单个迷你图源数据的区域。
使用此方法可获取迷你图当前使用的区域引用字符串。若要更改源区域，请使用 setSourceData(String)。
```
 worksheet.getRange("A1:C1").setValue(new Object[] {1, 3, 2});
 ISparklineGroup group = worksheet.getRange("D1").getSparklineGroups().add(SparkType.Line, "A1:C1");
 ISparkline sparkline = group.get(0);
 String sourceData = sparkline.getSourceData();
 
```
Returns:

包含迷你图源数据的区域引用字符串。

setSourceData

void setSourceData(String value)

设置包含单个迷你图源数据的区域。


 worksheet.getRange("A1:D1").setValue(new Object[] {1, 3, 2, 4});
 ISparklineGroup group = worksheet.getRange("D1").getSparklineGroups().add(SparkType.Line, "A1:C1");
 ISparkline sparkline = group.get(0);
 sparkline.setSourceData("A1:D1");

Parameters:: value - 包含迷你图源数据的区域引用字符串。

fromJson

void fromJson(String json)

从 JSON 字符串生成迷你图。

使用此方法可从 toJson() 创建的 JSON 字符串还原迷你图。


 worksheet.getRange("A1:C1").setValue(new Object[] {1, 3, 2});
 ISparklineGroup group = worksheet.getRange("D1").getSparklineGroups().add(SparkType.Line, "A1:C1");
 ISparkline sparkline = group.get(0);
 String json = sparkline.toJson();
 sparkline.fromJson(json);

Parameters:: json - 表示迷你图的 JSON 字符串。

toJson

String toJson()

从迷你图生成 JSON 字符串。

使用此方法可序列化当前迷你图，以便将其传递给 fromJson(String) 来还原迷你图配置。


 worksheet.getRange("A1:C1").setValue(new Object[] {1, 3, 2});
 ISparklineGroup group = worksheet.getRange("D1").getSparklineGroups().add(SparkType.Line, "A1:C1");
 ISparkline sparkline = group.get(0);
 String json = sparkline.toJson();

Returns:: 表示迷你图的 JSON 字符串。