Package io.keikai.axyra.sheets.content

Record Class ErrorBars

java.lang.Object
java.lang.Record
io.keikai.axyra.sheets.content.ErrorBars
public record ErrorBars(String direction, String barType, String valueType, Double value, boolean endCap) extends Record
Series error bars (ECMA-376 §21.2.2.55). direction is x | y; barType is both | minus | plus; valueType is fixedVal | percentage | stdDev | stdErr | cust with value carrying the magnitude / multiplier.

Error bars are honored by the in-memory model and the chart renderer, and persist to the saved workbook (re-emitted as <c:errBars> per ECMA-376 §21.2.2.55).

  • Constructor Summary

    Constructors
    Constructor
    Description
    ErrorBars(String direction, String barType, String valueType, Double value, boolean endCap)
    Creates an instance of a ErrorBars record class.

  • Method Summary

    Modifier and Type
    Method
    Description
    String
    barType()
    Returns the value of the barType record component.
    String
    direction()
    Returns the value of the direction record component.
    boolean
    endCap()
    Returns the value of the endCap record component.
    final boolean
    equals(Object o)
    Indicates whether some other object is "equal to" this one.
    static ErrorBars
    fixed(double magnitude)
    Fixed-magnitude Y error bars in both directions.
    final int
    hashCode()
    Returns a hash code value for this object.
    static ErrorBars
    percentage(double percent)
    Percentage Y error bars in both directions.
    final String
    toString()
    Returns a string representation of this record class.
    Double
    value()
    Returns the value of the value record component.
    String
    valueType()
    Returns the value of the valueType record component.

    Methods inherited from class java.lang.Object

    clone, finalize, getClass, notify, notifyAll, wait, wait, wait

  • Constructor Details

    • ErrorBars

      public ErrorBars(String direction, String barType, String valueType, Double value, boolean endCap)
      Creates an instance of a ErrorBars record class.
      Parameters:
      direction - the value for the direction record component
      barType - the value for the barType record component
      valueType - the value for the valueType record component
      value - the value for the value record component
      endCap - the value for the endCap record component

  • Method Details

    • fixed

      public static ErrorBars fixed(double magnitude)
      Fixed-magnitude Y error bars in both directions.

    • percentage

      public static ErrorBars percentage(double percent)
      Percentage Y error bars in both directions.

    • 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.

    • direction

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

    • barType

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

    • valueType

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

    • value

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

    • endCap

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