ISparklineGroups

Interface ISparklineGroups

All Superinterfaces:

Iterable<ISparklineGroup>

---

public interface ISparklineGroups extends Iterable<ISparklineGroup>

表示迷你图组的集合。

ISparklineGroups 对象与 IRange 关联，并提供对该区域中迷你图组的访问。使用此接口可以添加新的迷你图组、检索现有组、清除迷你图、对选中的迷你图进行分组，以及遍历集合。

 Object[][] data = new Object[][] {
     {1, 2, 3},
     {4, 5, 6},
     {7, 8, 9},
     {10, 11, 12}
 };
 worksheet.getRange("A1:C4").setValue(data);
 ISparklineGroups sparklineGroups = worksheet.getRange("D1:D4").getSparklineGroups();
 sparklineGroups.add(SparkType.Line, "A1:C4");
 ISparklineGroup sparklineGroup = sparklineGroups.get(0);
 

• Method Summary

  All MethodsInstance MethodsAbstract Methods

  Modifier and Type

  Method

  Description

  ISparklineGroup

  add(SparkType type, String sourceData)

  创建一个新的迷你图组并返回 ISparklineGroup 对象。

  void

  clear()

  清除选中的迷你图。

  void

  clearGroups()

  清除选中的迷你图组。

  ISparklineGroup

  get(int index)

  返回集合中的 ISparklineGroup 对象。

  int

  getCount()

  获取关联 IRange 对象中的迷你图组数量。

  void

  group()

  对选中的迷你图进行分组。

  void

  group(IRange Location)

  对选中的迷你图进行分组。

  void

  ungroup()

  取消所选迷你图组中迷你图的分组。

  Methods inherited from interface java.lang.Iterable

  forEach, iterator, spliterator

• Method Details

  • getCount

    int getCount()

    获取关联 IRange 对象中的迷你图组数量。

    使用此方法可以在访问单个组之前确定区域中包含多少个迷你图组。

    
     IRange range = worksheet.getRange("A1:A3");
     worksheet.getRange("B1:B3").setValue(new Object[] {1, 3, 2});
     range.getSparklineGroups().add(SparkType.Line, "B1:B3");
     int count = range.getSparklineGroups().getCount();
     

    Returns:

    关联区域中的迷你图组数量。

  • get

    ISparklineGroup get(int index)

    返回集合中的 ISparklineGroup 对象。

    使用此方法可以按当前位置从当前 ISparklineGroups 集合中检索现有迷你图组。

    
     worksheet.getRange("A1:C4").setValue(new Object[][] {
         {1, 2, 3},
         {4, 5, 6},
         {7, 8, 9},
         {10, 11, 12}
     });
     worksheet.getRange("D1:D4").getSparklineGroups().add(SparkType.Line, "A1:C4");
     ISparklineGroup sparklineGroup = worksheet.getRange("D1:D4").getSparklineGroups().get(0);
     

    Parameters:

    index - 指定集合中元素的位置。

    Returns:

    集合中指定位置的 ISparklineGroup 对象。

  • add

    ISparklineGroup add(SparkType type, String sourceData)

    创建一个新的迷你图组并返回 ISparklineGroup 对象。

    使用此方法可以从指定源数据区域在当前 ISparklineGroups 集合中创建迷你图。

    
     worksheet.getRange("A1:C4").setValue(new Object[][] {
         {1, 2, 3},
         {4, 5, 6},
         {7, 8, 9},
         {10, 11, 12}
     });
     ISparklineGroup sparklineGroup = worksheet.getRange("D1:D4").getSparklineGroups().add(SparkType.Line, "A1:C4");
     

    Parameters:

    type - 迷你图的类型。

    sourceData - 用作迷你图组源数据的区域引用字符串。

    Returns:

    新创建的 ISparklineGroup 对象。

  • clear

    void clear()

    清除选中的迷你图。

    从关联区域中的单元格移除迷你图对象，而不清除底层工作表数据。若要移除整个迷你图组，请改用 clearGroups()。

    
     Object[][] data = new Object[][] {
         {1, 2, 3},
         {4, 5, 6}
     };
     worksheet.getRange("A1:C2").setValue(data);
     worksheet.getRange("D1:D2").getSparklineGroups().add(SparkType.Line, "A1:C2");
     worksheet.getRange("D1").getSparklineGroups().clear();
     

  • clearGroups

    void clearGroups()

    清除选中的迷你图组。

    移除与选中单元格关联的迷你图组。与 clear() 不同，此方法会移除整个迷你图组，而不是仅从选中单元格中清除单个迷你图对象。

    
     worksheet.getRange("A1:B2").setValue(new Object[][] {
         {1, 2},
         {3, 4}
     });
     worksheet.getRange("D1:D2").getSparklineGroups().add(SparkType.Line, "A1:B2");
     worksheet.getRange("D1").getSparklineGroups().clearGroups();
     

  • group

    void group()

    对选中的迷你图进行分组。

    使用此方法可以将关联区域中的现有迷你图合并为一个迷你图组，使它们共享相同的组设置。

    
     IRange range = worksheet.getRange("A1:A3");
     worksheet.getRange("B1:B3").setValue(new Object[] {1, 3, 2});
     range.getSparklineGroups().add(SparkType.Line, "B1:B3");
     worksheet.getRange("D1:D3").setValue(new Object[] {2, 4, 1});
     worksheet.getRange("E1:E3").getSparklineGroups().add(SparkType.Line, "D1:D3");
     worksheet.getRange("A1:E3").getSparklineGroups().group();
     

  • group

    void group(IRange Location)

    对选中的迷你图进行分组。

    分组后的迷你图基于指定位置的迷你图。如果为 null，则该组基于集合中的第一个迷你图。

    
     Object[][] data = new Object[][] {
         {1, 2, 3}, {4, 5, 6}, {7, 8, 9}, {10, 11, 12}
     };
     worksheet.getRange("A1:C4").setValue(data);
     worksheet.getRange("D1:D4").getSparklineGroups().add(SparkType.Line, "A1:C4");
     worksheet.getRange("F1:H4").setValue(data);
     worksheet.getRange("J1:J4").getSparklineGroups().add(SparkType.Column, "F1:H4");
     worksheet.getRange("A1:J4").getSparklineGroups().group(worksheet.getRange("J2"));
     

    Parameters:

    Location - 指定新组基于哪个迷你图的区域。如果为 null，则该组基于集合中的第一个迷你图。

  • ungroup

    void ungroup()

    取消所选迷你图组中迷你图的分组。

    对此迷你图单元格关联的 ISparklineGroups 集合使用此方法，可以移除这些迷你图的当前分组。

    
     IRange range = worksheet.getRange("A1:A3");
     worksheet.getRange("B1:B3").setValue(new Object[] {1, 3, 2});
     range.getSparklineGroups().add(SparkType.Line, "B1:B3");
     range.getSparklineGroups().ungroup();