[]
        
(Showing Draft Content)

ISparkPoints

Interface ISparkPoints


public interface ISparkPoints
Represents the settings of the markers for points of data on a sparkline.

An ISparkPoints instance provides access to the marker settings for the first, last, highest, lowest, positive, and negative data points in a sparkline. It is typically obtained from ISparklineGroup.getPoints() and used together with ISparkColor objects to control marker color and visibility.


 worksheet.getRange("A1:D1").setValue(new Object[][] {{10, -5, 15, 8}});
 ISparklineGroup sparklineGroup = worksheet.getRange("E1").getSparklineGroups().add(SparkType.Line, "A1:D1");
 ISparkPoints sparkPoints = sparklineGroup.getPoints();
 sparkPoints.getFirstpoint().setVisible(true);
 sparkPoints.getNegative().getColor().setRgb(Color.GetRed());
 
  • Method Summary

    Modifier and Type
    Method
    Description
    Gets the ISparkColor object that represents the color and visibility of the marker for the first point of data on a sparkline.
    Gets the ISparkColor object that represents the color and visibility of the marker for the highest point of data on a sparkline.
    Gets the ISparkColor object that represents the color and visibility of the marker for the last point of data on a sparkline.
    Gets the ISparkColor object that represents the color and visibility of the marker for the lowest point of data on a sparkline.
    Gets the ISparkColor object that represents the color and visibility of markers for positive points of data on a sparkline.
    Gets the ISparkColor object that represents the color and visibility of markers for negative points of data on a sparkline.
  • Method Details

    • getFirstpoint

      ISparkColor getFirstpoint()
      Gets the ISparkColor object that represents the color and visibility of the marker for the first point of data on a sparkline.
      
       worksheet.getRange("A1:A4").setValue(new Object[][] {{5}, {2}, {7}, {3}});
       ISparklineGroup group = worksheet.getRange("B1").getSparklineGroups().add(SparkType.Line, "A1:A4");
       ISparkColor firstpoint = group.getPoints().getFirstpoint();
       firstpoint.setVisible(true);
       firstpoint.getColor().setColor(Color.GetRed());
       
      Returns:
      The ISparkColor object for the first data point marker of the sparkline.
    • getHighpoint

      ISparkColor getHighpoint()
      Gets the ISparkColor object that represents the color and visibility of the marker for the highest point of data on a sparkline.

      Use the returned object to configure whether the high-point marker is shown and which color it uses.

      
       worksheet.getRange("A1:A4").setValue(new Object[][] {{5}, {2}, {7}, {3}});
       ISparklineGroup group = worksheet.getRange("B1").getSparklineGroups().add(SparkType.Line, "A1:A4");
       ISparkColor highpoint = group.getPoints().getHighpoint();
       highpoint.setVisible(true);
       highpoint.getColor().setColor(Color.GetRed());
       
      Returns:
      The ISparkColor object for the marker of the highest data point on the sparkline.
    • getLastpoint

      ISparkColor getLastpoint()
      Gets the ISparkColor object that represents the color and visibility of the marker for the last point of data on a sparkline.
      
       worksheet.getRange("A1:A4").setValue(new Object[][] {{5}, {2}, {7}, {3}});
       ISparklineGroup group = worksheet.getRange("B1").getSparklineGroups().add(SparkType.Line, "A1:A4");
       ISparkColor lastpoint = group.getPoints().getLastpoint();
       lastpoint.setVisible(true);
       lastpoint.getColor().setColor(Color.GetBlue());
       
      Returns:
      The ISparkColor object for the marker of the last data point of the sparkline.
    • getLowpoint

      ISparkColor getLowpoint()
      Gets the ISparkColor object that represents the color and visibility of the marker for the lowest point of data on a sparkline.

      Use the returned object to control whether the lowest-point marker is displayed and to customize its color.

      
       worksheet.getRange("A1:A4").setValue(new Object[][] {{5}, {2}, {7}, {3}});
       ISparklineGroup group = worksheet.getRange("B1").getSparklineGroups().add(SparkType.Line, "A1:A4");
       ISparkColor lowpoint = group.getPoints().getLowpoint();
       lowpoint.setVisible(true);
       lowpoint.getColor().setColor(Color.GetRed());
       
      Returns:
      The ISparkColor object for the marker of the lowest data point of the sparkline.
    • getMarkers

      ISparkColor getMarkers()
      Gets the ISparkColor object that represents the color and visibility of markers for positive points of data on a sparkline.

      Use this object to configure how positive data points are displayed in the sparkline group.

      
       worksheet.getRange("A1:A4").setValue(new Object[][] {
           {10},
           {-5},
           {8},
           {12}
       });
       ISparklineGroup group = worksheet.getRange("B1").getSparklineGroups().add(SparkType.Line, "A1:A4");
       ISparkColor markers = group.getPoints().getMarkers();
       markers.getColor().setRGB(Color.GetBlue());
       markers.setVisible(true);
       
      Returns:
      The ISparkColor object for positive point markers in the sparkline.
    • getNegative

      ISparkColor getNegative()
      Gets the ISparkColor object that represents the color and visibility of markers for negative points of data on a sparkline.

      Use this object to configure how negative data points are displayed in the sparkline group.

      
       worksheet.getRange("A1:A4").setValue(new Object[][] {
           {10},
           {-5},
           {8},
           {-3}
       });
       ISparklineGroup group = worksheet.getRange("B1").getSparklineGroups().add(SparkType.Line, "A1:A4");
       ISparkColor negative = group.getPoints().getNegative();
       negative.getColor().setRGB(Color.GetRed());
       negative.setVisible(true);
       
      Returns:
      The ISparkColor object for negative point markers in the sparkline.