Package com.grapecity.documents.excel

Interface ICascadeSparkLine

public interface ICascadeSparkLine
Represents a cascade sparkLine.

  • Method Summary

    Modifier and Type
    Method
    Description
    String
    getColorNegative()
    A color that represents the first or last negative sparkline's box (this point's value is negative).
    String
    getColorPositive()
    A color that represents the color of the first or last positive sparkline's box (this point's value is positive).
    String
    getColorTotal()
    A color that represents the color of the last sparkline's box when itemTypeRange does not exist or represents the color of the resulting sparkline's box when itemTypeRange exists.
    String[]
    getItemTypes()
    Represents all the item types.
    String[]
    getLabels()
    Represents the labels.
    Double
    getMaximum()
    A number that represents the maximum values of the display area.
    Double
    getMinimum()
    A number that represents the minimum values of the display area.
    double
    getPointIndex()
    Represents the points index.
    double[]
    getPoints()
    Represents the values of the points.
    boolean
    getVertical()
    A boolean that represents whether the box's direction is vertical or horizontal.

  • Method Details

    • getPoints

      double[] getPoints()
      Represents the values of the points.

    • getPointIndex

      double getPointIndex()
      Represents the points index. The pointIndex is >= 1.

    • getLabels

      String[] getLabels()
      Represents the labels. The default value is null.

    • getMinimum

      Double getMinimum()
      A number that represents the minimum values of the display area. The default value is null.

    • getMaximum

      Double getMaximum()
      A number that represents the maximum values of the display area. The default value is null.

    • getColorPositive

      String getColorPositive()
      A color that represents the color of the first or last positive sparkline's box (this point's value is positive). The default value is '#8CBF64'.

    • getColorNegative

      String getColorNegative()
      A color that represents the first or last negative sparkline's box (this point's value is negative). The default value is '#D6604D'.

    • getVertical

      boolean getVertical()
      A boolean that represents whether the box's direction is vertical or horizontal. The default value is FALSE.

    • getItemTypes

      String[] getItemTypes()
      Represents all the item types. The values should be {"-", "+", "="}. The default value is null.

    • getColorTotal

      String getColorTotal()
      A color that represents the color of the last sparkline's box when itemTypeRange does not exist or represents the color of the resulting sparkline's box when itemTypeRange exists. The default value is null.