Package io.keikai.axyra.sheets.content

Record Class SparklineGroup

java.lang.Object
java.lang.Record
io.keikai.axyra.sheets.content.SparklineGroup
public record SparklineGroup(String type, boolean showMarkers, boolean showHigh, boolean showLow, boolean showFirst, boolean showLast, boolean showNegative, String seriesColor, String negativeColor, String axisColor, String markersColor, String firstColor, String lastColor, String highColor, String lowColor, String minAxisType, String maxAxisType, Double manualMin, Double manualMax, String dateAxisRange, List<Sparkline> sparklines) extends Record
A sparkline group: a set of same-styled mini inline charts (ECMA-376 Part 4 §18.3.1.32, x14:sparklineGroup). type is "line" / "column" / "stacked"; the boolean flags are the basic point-highlight style (markers and high/low/first/last/negative emphasis); seriesColor is the series ARGB (or "theme:N"), or null. Each Sparkline carries its data range and draw location. "stacked" is Excel's Win/Loss sparkline. Read the groups with Sheet.sparklines(); the record is a snapshot.

  • Constructor Details

    • SparklineGroup

      public SparklineGroup(String type, boolean showMarkers, boolean showHigh, boolean showLow, boolean showFirst, boolean showLast, boolean showNegative, String seriesColor, String negativeColor, String axisColor, String markersColor, String firstColor, String lastColor, String highColor, String lowColor, String minAxisType, String maxAxisType, Double manualMin, Double manualMax, String dateAxisRange, List<Sparkline> sparklines)
      Creates an instance of a SparklineGroup record class.
      Parameters:
      type - the value for the type record component
      showMarkers - the value for the showMarkers record component
      showHigh - the value for the showHigh record component
      showLow - the value for the showLow record component
      showFirst - the value for the showFirst record component
      showLast - the value for the showLast record component
      showNegative - the value for the showNegative record component
      seriesColor - the value for the seriesColor record component
      negativeColor - the value for the negativeColor record component
      axisColor - the value for the axisColor record component
      markersColor - the value for the markersColor record component
      firstColor - the value for the firstColor record component
      lastColor - the value for the lastColor record component
      highColor - the value for the highColor record component
      lowColor - the value for the lowColor record component
      minAxisType - the value for the minAxisType record component
      maxAxisType - the value for the maxAxisType record component
      manualMin - the value for the manualMin record component
      manualMax - the value for the manualMax record component
      dateAxisRange - the value for the dateAxisRange record component
      sparklines - the value for the sparklines record component

  • Method Details

    • style

      public SparklineStyle style()
      The group's style, for Sheet.setSparklineStyle. That call replaces every field, so a null color in the style clears that color. A theme color is read back without its tint, so re-applying this style loses the tint.

    • fromJson

      public static SparklineGroup fromJson(String json)
      Parse the engine's sparkline-group JSON. Not part of the public API.

    • toString

      public final String toString()
      Returns a string representation of this record class. The representation contains the name of the class, followed by the name and value of each of the record components.
      Specified by:
      toString in class Record
      Returns:
      a string representation of this object

    • hashCode

      public final int hashCode()
      Returns a hash code value for this object. The value is derived from the hash code of each of the record components.
      Specified by:
      hashCode in class Record
      Returns:
      a hash code value for this object

    • equals

      public final boolean equals(Object o)
      Indicates whether some other object is "equal to" this one. The objects are equal if the other object is of the same class and if all the record components are equal. Reference components are compared with Objects::equals(Object,Object); primitive components are compared with '=='.
      Specified by:
      equals in class Record
      Parameters:
      o - the object with which to compare
      Returns:
      true if this object is the same as the o argument; false otherwise.

    • type

      public String type()
      Returns the value of the type record component.
      Returns:
      the value of the type record component

    • showMarkers

      public boolean showMarkers()
      Returns the value of the showMarkers record component.
      Returns:
      the value of the showMarkers record component

    • showHigh

      public boolean showHigh()
      Returns the value of the showHigh record component.
      Returns:
      the value of the showHigh record component

    • showLow

      public boolean showLow()
      Returns the value of the showLow record component.
      Returns:
      the value of the showLow record component

    • showFirst

      public boolean showFirst()
      Returns the value of the showFirst record component.
      Returns:
      the value of the showFirst record component

    • showLast

      public boolean showLast()
      Returns the value of the showLast record component.
      Returns:
      the value of the showLast record component

    • showNegative

      public boolean showNegative()
      Returns the value of the showNegative record component.
      Returns:
      the value of the showNegative record component

    • seriesColor

      public String seriesColor()
      Returns the value of the seriesColor record component.
      Returns:
      the value of the seriesColor record component

    • negativeColor

      public String negativeColor()
      Returns the value of the negativeColor record component.
      Returns:
      the value of the negativeColor record component

    • axisColor

      public String axisColor()
      Returns the value of the axisColor record component.
      Returns:
      the value of the axisColor record component

    • markersColor

      public String markersColor()
      Returns the value of the markersColor record component.
      Returns:
      the value of the markersColor record component

    • firstColor

      public String firstColor()
      Returns the value of the firstColor record component.
      Returns:
      the value of the firstColor record component

    • lastColor

      public String lastColor()
      Returns the value of the lastColor record component.
      Returns:
      the value of the lastColor record component

    • highColor

      public String highColor()
      Returns the value of the highColor record component.
      Returns:
      the value of the highColor record component

    • lowColor

      public String lowColor()
      Returns the value of the lowColor record component.
      Returns:
      the value of the lowColor record component

    • minAxisType

      public String minAxisType()
      Returns the value of the minAxisType record component.
      Returns:
      the value of the minAxisType record component

    • maxAxisType

      public String maxAxisType()
      Returns the value of the maxAxisType record component.
      Returns:
      the value of the maxAxisType record component

    • manualMin

      public Double manualMin()
      Returns the value of the manualMin record component.
      Returns:
      the value of the manualMin record component

    • manualMax

      public Double manualMax()
      Returns the value of the manualMax record component.
      Returns:
      the value of the manualMax record component

    • dateAxisRange

      public String dateAxisRange()
      Returns the value of the dateAxisRange record component.
      Returns:
      the value of the dateAxisRange record component

    • sparklines

      public List<Sparkline> sparklines()
      Returns the value of the sparklines record component.
      Returns:
      the value of the sparklines record component