Package com.inet.report.chart.axis

Class GroupAxis

java.lang.Object
com.inet.report.chart.axis.BaseAxis
com.inet.report.chart.axis.GroupAxis
All Implemented Interfaces:
Serializable
public class GroupAxis extends BaseAxis
The axis which displays the category and series group values.
Since:
8.0
See Also:

  • Field Details

    • DEFAULT_MAXIMUM_LINES

      public static final Integer DEFAULT_MAXIMUM_LINES
      The default value for maximum lines of label.

    • DEFAULT_ROTATION_ANGLE

      public static final Double DEFAULT_ROTATION_ANGLE
      The default value for rotation angle (in radians).

    • DEFAULT_WIDTH_RATIO

      public static final Float DEFAULT_WIDTH_RATIO
      The default value for width ratio.

  • Constructor Details

    • GroupAxis

      public GroupAxis()
      Creates a discrete GroupAxis, sets the default properties.
      Since:
      8.0

  • Method Details

    • isAutoFitTickLabel

      public boolean isAutoFitTickLabel()
      Returns whether or not the axis tick labels are automatically adjusted to fit the axis space.
      Returns:
      whether or not the axis tick labels are automatically adjusted to fit the axis space.
      Since:
      8.0
      See Also:

    • setAutoFitTickLabel

      public void setAutoFitTickLabel(boolean autoFitTickLabel)
      Sets whether or not the axis tick labels are automatically adjusted (e.g. by rotating or truncating) to fit the axis space.
      Parameters:
      autoFitTickLabel - whether to automatically adjust the labels (e.g. by rotating or truncating) so that they fit the axis space
      Since:
      8.0
      See Also:

    • getTickLabelRotationAngle

      public Double getTickLabelRotationAngle()
      Returns the tick label rotation angle (in radians).
      Returns:
      the angle of the tick label rotation
      Since:
      8.0
      See Also:

    • setTickLabelRotationAngle

      public void setTickLabelRotationAngle(Double tickLabelRotationAngle)
      Sets the tick label rotation angle (in radians).
      Note: to use this property turn off the automatic label fitting.
      Parameters:
      tickLabelRotationAngle - the angle or null to ignore this property (should be < Math.PI / 2.0)
      Since:
      8.0
      See Also:

    • getTickLabelWidthRatio

      public Float getTickLabelWidthRatio()
      Returns the tick label width ratio, i.e. how much of the label to display.
      Returns:
      the width ratio
      Since:
      8.0
      See Also:

    • setTickLabelWidthRatio

      public void setTickLabelWidthRatio(Float tickLabelWidthRatio)
      Sets the tick label width ratio, i.e. how much of the label to display. 1 would be the entire label, anything less causes the tick labels to be truncated. 0 means there should be no explicit setting for the maximum label width. Anything greater than 1 will be interpreted as 1.
      Note: to use this property turn off the auto label fitting.
      Parameters:
      tickLabelWidthRatio - the width ratio, i.e. how much of the tick label to display or null to ignore this property
      Since:
      8.0
      See Also:

    • getTickLabelMaximumLines

      public Integer getTickLabelMaximumLines()
      Returns the maximum number of lines to use for each tick label.
      Returns:
      the maximum number of lines
      Since:
      8.0
      See Also:

    • setTickLabelMaximumLines

      public void setTickLabelMaximumLines(Integer tickLabelMaximumLines)
      Sets the maximum number of lines to use for each tick label.
      Note: to use this property turn off the auto label fitting.
      Parameters:
      tickLabelMaximumLines - the maximum number of lines or null to ignore this property
      Since:
      8.0
      See Also:

    • getShowEachNthTickLabel

      public int getShowEachNthTickLabel()
      Returns the number for show each nth tick labels. The value 1 means each label will be shown.
      Returns:
      the number
      Since:
      8.0
      See Also:

    • setShowEachNthTickLabel

      public void setShowEachNthTickLabel(int showEachNthTickLabel)
      Sets the number for show each nth tick labels. The value 1 means each label will be shown.
      Parameters:
      showEachNthTickLabel - the number, the value should be greater zero
      Throws:
      IllegalArgumentException - by negative or zero value
      Since:
      8.0
      See Also:

    • getShowEachNthTickLabelFormula

      public FormulaField getShowEachNthTickLabelFormula()
      Get the showEachNthTickLabelFormula of the GroupAxis. This formula is used to determine the ShowEachNthLabel value. When null, the result of getShowEachNthTickLabel() is used.
      Returns:
      the showEachNthTickLabelFormula of the GroupAxis, can be null.
      Since:
      i-net Clear Reports 13.0
      See Also:

    • setShowEachNthTickLabelFormula

      public void setShowEachNthTickLabelFormula(FormulaField showEachNthTickLabelFormula)
      Set the showEachNthTickLabelFormula of the GroupAxis. This formula is used to determine the ShowEachNthLabel value. When null, the value set to setShowEachNthTickLabel(int) is used.
      Parameters:
      showEachNthTickLabelFormula - the showEachNthTickLabelFormula of the GroupAxis, can be null.
      Since:
      i-net Clear Reports 13.0
      See Also:

    • getSubProperties

      protected StringBuilder getSubProperties(int depth)
      Returns the serialized properties of subclasses.
      Overrides:
      getSubProperties in class BaseAxis
      Parameters:
      depth - the depth of the whitespace indent to prefix each line with
      Returns:
      the properties as XML
      Since:
      8.0

    • readProperties

      public void readProperties(Element element, Chart2 chart)
      Loads the XML properties of a chart axis.
      Overrides:
      readProperties in class BaseAxis
      Parameters:
      element - DOM element to read the properties from
      chart - the chart this axis belongs to
      See Also:

    • getReferencedObjects

      public List<Object> getReferencedObjects()
      Get FormulaFields referenced by this Axis.
      Can be from marker (if this is MarkerAxis) or from title.
      Overrides:
      getReferencedObjects in class BaseAxis
      Returns:
      a list with referenced fields, can be empty.