Klasse BaseAxis

java.lang.Object
com.inet.report.chart.axis.BaseAxis
Alle implementierten Schnittstellen:
Serializable
Bekannte direkte Unterklassen:
ContinuousDateAxis, DiscreteNumberAxis, GroupAxis

public class BaseAxis extends Object implements Serializable
Basic class for a chart axis. This class contains the basic properties and methods for chart axes.
To resolve which axis type is used by each chart style please see the set function of the chart plot according to your style. E.g. BarStyle belongs to the plot BarPlot. This uses a GroupAxis as category axis (see BarPlot.setCategoryAxis(GroupAxis)) and a ContinuousNumberAxis as data axis (see BarPlot.setDataAxis(ContinuousNumberAxis)).
Seit:
8.0
Siehe auch:
  • Felddetails

    • DEFAULT_TICK_LABEL_COLOR

      public static final int DEFAULT_TICK_LABEL_COLOR
      The default axis label color (the ABGR value representation).
      Siehe auch:
    • DEFAULT_TICK_LABEL_FONT

      public static final Font DEFAULT_TICK_LABEL_FONT
      The default axis tick labels font.
    • DEFAULT_GRIDLINE_COLOR

      public static final int DEFAULT_GRIDLINE_COLOR
      The default grid lines color (the ABGR value representation).
    • DEFAULT_AXIS_LINE_COLOR

      public static final int DEFAULT_AXIS_LINE_COLOR
      The default axis color (the ABGR value representation).
    • DEFAULT_TITLE

      public static final ChartTitle DEFAULT_TITLE
      Default title of this axis.
    • TOKEN_CATEGORY_AXIS

      public static final String TOKEN_CATEGORY_AXIS
      XML token for a category axis element.
      Siehe auch:
    • TOKEN_SERIES_AXIS

      public static final String TOKEN_SERIES_AXIS
      XML token for a series axis element.
      Siehe auch:
    • TOKEN_DATA_AXIS

      public static final String TOKEN_DATA_AXIS
      XML token for a data axis element.
      Siehe auch:
  • Konstruktordetails

    • BaseAxis

      public BaseAxis()
      Creates a instance of BaseAxis, sets the default properties. To disable the axis from being shown use AxisPosition.NONE.
      Seit:
      8.0
  • Methodendetails

    • isGridlinesVisible

      public boolean isGridlinesVisible()
      Returns whether or not the axis grid lines are visible.
      Gibt zurück:
      whether or not the axis grid lines are visible
      Seit:
      8.0
      Siehe auch:
    • setGridlinesVisible

      public void setGridlinesVisible(boolean gridlinesVisible)
      Sets whether or not the axis grid lines are visible.
      Parameter:
      gridlinesVisible - whether or not the axis grid lines are visible
      Seit:
      8.0
      Siehe auch:
    • getGridlineColor

      public int getGridlineColor()
      Returns the ABGR value representing the grid lines color.
      Gibt zurück:
      the grid lines color.
      Seit:
      8.0
      Siehe auch:
    • setGridlineColor

      public void setGridlineColor(int gridlineColor)
      Sets the ABGR components of the grid lines color.
      Parameter:
      gridlineColor - the color
      Löst aus:
      IllegalArgumentException - by RDC.COLOR_NO_COLOR.
      Seit:
      8.0
      Siehe auch:
    • getAxisLineColor

      public int getAxisLineColor()
      Returns the ABGR value representing the axis line color.
      Gibt zurück:
      the axis line color.
      Seit:
      8.0
      Siehe auch:
    • isInverseOrder

      public boolean isInverseOrder()
      Returns the orientation of the values on the axis.
      Gibt zurück:
      true if inverse order, false otherwise
      Seit:
      8.0
      Siehe auch:
    • setInverseOrder

      public void setInverseOrder(boolean inverseOrder)
      Sets the orientation of the values on the axis -true if inverse, false otherwise
      Parameter:
      inverseOrder - the orientation of the values on the axis
      Seit:
      8.0
      Siehe auch:
    • setAxisLineColor

      public void setAxisLineColor(int axisLineColor)
      Sets the ABGR components of the axis line color.
      Parameter:
      axisLineColor - the color
      Löst aus:
      IllegalArgumentException - by RDC.COLOR_NO_COLOR.
      Seit:
      8.0
      Siehe auch:
    • getTitle

      public ChartTitle getTitle()
      Gets the title of this axis
      Gibt zurück:
      the axis title
      Seit:
      8.0
      Siehe auch:
    • setTitle

      public void setTitle(ChartTitle title)
      Sets the title of this axis. To disable the title use setAxisPosition(AxisPosition.NONE)
      Parameter:
      title - the axis title (null not permitted)
      Seit:
      8.0
      Siehe auch:
    • getTickLabelFont

      public Font getTickLabelFont()
      Returns the font of tick labels on this axis.
      Gibt zurück:
      the tick label font.
      Seit:
      8.0
      Siehe auch:
    • setTickLabelFont

      public void setTickLabelFont(Font tickLabelFont)
      Sets the font of tick labels on this axis.
      Parameter:
      tickLabelFont - the axis tick labels font (null not permitted)
      Seit:
      8.0
      Siehe auch:
    • getTickLabelColor

      public int getTickLabelColor()
      Returns the color as ABGR value of tick labels on this axis.
      Gibt zurück:
      the ABGR value representing the label color.
      Seit:
      8.0
      Siehe auch:
    • setTickLabelColor

      public void setTickLabelColor(int tickLabelColor)
      Sets the color as ABGR value of tick labels on this axis.
      Parameter:
      tickLabelColor - ABGR components of the axis labels color
      Löst aus:
      IllegalArgumentException - by RDC.COLOR_NO_COLOR.
      Seit:
      8.0
      Siehe auch:
    • getTickLabelFormat

      public ChartFormat getTickLabelFormat()
      Returns a tick label format of this axis. The default value of this property is null, that means the chart formats the axis values automatically.
      Gibt zurück:
      the format or null to auto format
      Seit:
      8.0
      Siehe auch:
    • setTickLabelFormat

      public void setTickLabelFormat(ChartFormat tickLabelFormat)
      Sets the tick label format. The default value of this property is null, that means the chart formats the axis values automatically. Note: for charts with number values on the axis, only formats extended from NumberFormat are allowed, and date charts, only formats extended from DateFormat are allowed.
      Parameter:
      tickLabelFormat - the format (null permitted)
      Löst aus:
      IllegalArgumentException - by date format for number values
      Seit:
      8.0
      Siehe auch:
    • getAxisPosition

      public AxisPosition getAxisPosition()
      Returns the relative position of this axis on the chart. A y-axis with position AxisPosition.ON_MIN will be placed on the left side of chart.
      Gibt zurück:
      the axis position
      Seit:
      8.0
      Siehe auch:
    • setAxisPosition

      public void setAxisPosition(AxisPosition position)
      Sets the position of this axis on the chart or disables the axis from being shown, if AxisPosition.NONE is passed. A y-axis with position AxisPosition.ON_MIN will be placed on the left side of chart.
      Parameter:
      position - the axis position (null not permitted)
      Löst aus:
      IllegalArgumentException - if position is null.
      Seit:
      8.0
      Siehe auch:
    • copyTo

      public void copyTo(BaseAxis that)
      Copies the properties of this axis to the new axis.
      Parameter:
      that - the new axis to copy the properties to
      Seit:
      8.0
    • saveProperties

      public void saveProperties(PrintWriter out, int depth, String axisType)
      Writes the axis properties to the output stream as XML
      Parameter:
      out - the output stream to write to
      depth - the depth of whitespace indent to prefix each line with
      axisType - type of this axis: "category", "series" or "data"
      Seit:
      8.0
    • getSubProperties

      protected StringBuilder getSubProperties(int depth)
      Returns the serialized properties of subclasses.
      Parameter:
      depth - the depth of XML indent
      Gibt zurück:
      the properties.
      Seit:
      8.0
    • saveSubProperties

      protected void saveSubProperties(PrintWriter out, int depth)
      Writes the intern axis properties to output. Overwrites this to save intern properties direct to PrintWriter without building a StringBuilder.
      Parameter:
      out - the output
      depth - the depth of XML indent
      Seit:
      8.0
    • readProperties

      public void readProperties(Element element, Chart2 chart)
      Loads the XML properties of a chart axis.
      Parameter:
      element - DOM element to read the properties from
      chart - the chart this axis belongs to
      Seit:
      8.0
      Siehe auch:
    • getReferencedObjects

      public List<Object> getReferencedObjects()
      Get FormulaFields referenced by this Axis.
      Can be from marker (if this is MarkerAxis) or from title.
      Gibt zurück:
      a list with referenced fields, can be empty.
      Seit:
      11.2