[]
DEMOS DOCS API PRICING
FREE TRIAL
(Showing Draft Content)

SparkScale

Enum Class SparkScale

java.lang.Object
java.lang.Enum<SparkScale>
com.grapecity.documents.excel.SparkScale
All Implemented Interfaces:
Serializable, Comparable<SparkScale>, Constable
public enum SparkScale extends Enum<SparkScale>
Specifies how the minimum or maximum value of a sparkline vertical axis is scaled relative to other sparklines in the group.

Use this enum with the vertical axis settings of a sparkline group to control whether all sparklines share the same scale, each sparkline uses its own calculated scale, or a custom axis value is applied.


 worksheet.getRange("A1:C3").setValue(new Object[][] {
     {2, 4, 6}, {3, 9, 1}, {5, 7, 8}
 });
 ISparklineGroup group = worksheet.getRange("D1:D3").getSparklineGroups().add(SparkType.Line, "A1:C3");
 group.getAxes().getVertical().setMinScaleType(SparkScale.SparkScaleGroup);
 group.getAxes().getVertical().setMaxScaleType(SparkScale.SparkScaleCustom);
 group.getAxes().getVertical().setCustomMaxScaleValue(10);

  • Enum Constant Details

    • SparkScaleGroup

      public static final SparkScale SparkScaleGroup
      Specifies that the minimum or maximum value for the vertical axes of all of the sparklines in the group have the same value.

    • SparkScaleSingle

      public static final SparkScale SparkScaleSingle
      Specifies that the minimum or maximum value for the vertical axis of each sparkline in the group is automatically set to its own calculated value.

    • SparkScaleCustom

      public static final SparkScale SparkScaleCustom
      Specifies that the minimum or maximum value for the vertical axis of the sparkline has a user-defined value.

  • Method Details

    • values

      public static SparkScale[] values()
      Returns an array containing the constants of this enum class, in the order they are declared.
      Returns:
      an array containing the constants of this enum class, in the order they are declared

    • valueOf

      public static SparkScale valueOf(String name)
      Returns the enum constant of this class with the specified name. The string must match exactly an identifier used to declare an enum constant in this class. (Extraneous whitespace characters are not permitted.)
      Parameters:
      name - the name of the enum constant to be returned.
      Returns:
      the enum constant with the specified name
      Throws:
      IllegalArgumentException - if this enum class has no constant with the specified name
      NullPointerException - if the argument is null