Package org.knowm.xchart.style

Class AxesChartStyler

java.lang.Object
org.knowm.xchart.style.Styler
org.knowm.xchart.style.AxesChartStyler
Direct Known Subclasses:
BoxStyler, BubbleStyler, CategoryStyler, HeatMapStyler, OHLCStyler, XYStyler
public abstract class AxesChartStyler
extends Styler

  • Constructor Details

    • AxesChartStyler

      public AxesChartStyler()

  • Method Details

    • isXAxisTitleVisible

      public boolean isXAxisTitleVisible()

    • setXAxisTitleVisible

      public AxesChartStyler setXAxisTitleVisible​(boolean xAxisTitleVisible)
      Set the x-axis title visibility
      Parameters:
      xAxisTitleVisible -

    • isYAxisTitleVisible

      public boolean isYAxisTitleVisible()

    • setYAxisTitleVisible

      public AxesChartStyler setYAxisTitleVisible​(boolean yAxisTitleVisible)
      Set the y-axis title visibility
      Parameters:
      yAxisTitleVisible -

    • setAxisTitlesVisible

      public AxesChartStyler setAxisTitlesVisible​(boolean isVisible)
      Set the x- and y-axis titles visibility
      Parameters:
      isVisible -

    • getAxisTitleFont

      public Font getAxisTitleFont()

    • setAxisTitleFont

      public AxesChartStyler setAxisTitleFont​(Font axisTitleFont)
      Set the x- and y-axis title font
      Parameters:
      axisTitleFont -

    • isXAxisTicksVisible

      public boolean isXAxisTicksVisible()

    • setXAxisTicksVisible

      public AxesChartStyler setXAxisTicksVisible​(boolean xAxisTicksVisible)
      Set the x-axis tick marks and labels visibility
      Parameters:
      xAxisTicksVisible -

    • isYAxisTicksVisible

      public boolean isYAxisTicksVisible()

    • setYAxisTicksVisible

      public AxesChartStyler setYAxisTicksVisible​(boolean yAxisTicksVisible)
      Set the y-axis tick marks and labels visibility
      Parameters:
      yAxisTicksVisible -

    • setAxisTicksVisible

      public AxesChartStyler setAxisTicksVisible​(boolean isVisible)
      Set the x- and y-axis tick marks and labels visibility
      Parameters:
      isVisible -

    • getAxisTickLabelsFont

      public Font getAxisTickLabelsFont()

    • setAxisTickLabelsFont

      public AxesChartStyler setAxisTickLabelsFont​(Font axisTicksFont)
      Set the x- and y-axis tick label font
      Parameters:
      axisTicksFont -

    • getAxisTickMarkLength

      public int getAxisTickMarkLength()

    • setAxisTickMarkLength

      public AxesChartStyler setAxisTickMarkLength​(int axisTickMarkLength)
      Set the axis tick mark length (in pixels)
      Parameters:
      axisTickMarkLength -

    • getAxisTickPadding

      public int getAxisTickPadding()

    • setAxisTickPadding

      public AxesChartStyler setAxisTickPadding​(int axisTickPadding)
      sets the padding (in pixels) between the tick labels and the tick marks
      Parameters:
      axisTickPadding -

    • getAxisTickMarksColor

      public Color getAxisTickMarksColor()

    • setAxisTickMarksColor

      public AxesChartStyler setAxisTickMarksColor​(Color axisTickColor)
      sets the axis tick mark color
      Parameters:
      axisTickColor -

    • getAxisTickMarksStroke

      public BasicStroke getAxisTickMarksStroke()

    • setAxisTickMarksStroke

      public AxesChartStyler setAxisTickMarksStroke​(BasicStroke axisTickMarksStroke)
      sets the axis tick marks Stroke
      Parameters:
      axisTickMarksStroke -

    • getAxisTickLabelsColor

      public Color getAxisTickLabelsColor()

    • setAxisTickLabelsColor

      public AxesChartStyler setAxisTickLabelsColor​(Color axisTickLabelsColor)
      sets the axis tick label color
      Parameters:
      axisTickLabelsColor -

    • isAxisTicksLineVisible

      public boolean isAxisTicksLineVisible()

    • setAxisTicksLineVisible

      public AxesChartStyler setAxisTicksLineVisible​(boolean isAxisTicksLineVisible)
      sets the visibility of the line parallel to the plot edges that go along with the tick marks
      Parameters:
      isAxisTicksLineVisible -

    • isAxisTicksMarksVisible

      public boolean isAxisTicksMarksVisible()

    • setAxisTicksMarksVisible

      public AxesChartStyler setAxisTicksMarksVisible​(boolean isAxisTicksMarksVisible)
      sets the visibility of the tick marks
      Parameters:
      isAxisTicksMarksVisible -

    • getPlotMargin

      public int getPlotMargin()

    • setPlotMargin

      public AxesChartStyler setPlotMargin​(int plotMargin)
      sets the margin (in pixels) around the plot area
      Parameters:
      plotMargin -

    • getAxisTitlePadding

      public int getAxisTitlePadding()

    • setAxisTitlePadding

      public AxesChartStyler setAxisTitlePadding​(int axisTitlePadding)
      sets the padding (in pixels) between the axis title and the tick labels
      Parameters:
      axisTitlePadding -

    • getXAxisTickMarkSpacingHint

      public int getXAxisTickMarkSpacingHint()

    • setXAxisTickMarkSpacingHint

      public AxesChartStyler setXAxisTickMarkSpacingHint​(int xAxisTickMarkSpacingHint)
      set the spacing (in pixels) between tick marks for the X-Axis
      Parameters:
      xAxisTickMarkSpacingHint -

    • getYAxisTickMarkSpacingHint

      public int getYAxisTickMarkSpacingHint()

    • setYAxisTickMarkSpacingHint

      public AxesChartStyler setYAxisTickMarkSpacingHint​(int yAxisTickMarkSpacingHint)
      set the spacing (in pixels) between tick marks for the Y-Axis
      Parameters:
      yAxisTickMarkSpacingHint -

    • isXAxisLogarithmic

      public boolean isXAxisLogarithmic()

    • setXAxisLogarithmic

      public AxesChartStyler setXAxisLogarithmic​(boolean isXAxisLogarithmic)
      sets the X-Axis to be rendered with a logarithmic scale or not
      Parameters:
      isXAxisLogarithmic -

    • isYAxisLogarithmic

      public boolean isYAxisLogarithmic()

    • setYAxisLogarithmic

      public AxesChartStyler setYAxisLogarithmic​(boolean isYAxisLogarithmic)
      sets the Y-Axis to be rendered with a logarithmic scale or not
      Parameters:
      isYAxisLogarithmic -

    • getXAxisMin

      public Double getXAxisMin()

    • setXAxisMin

      public AxesChartStyler setXAxisMin​(Double xAxisMin)

    • getXAxisMax

      public Double getXAxisMax()

    • setXAxisMax

      public AxesChartStyler setXAxisMax​(Double xAxisMax)

    • setYAxisMin

      public AxesChartStyler setYAxisMin​(Integer yAxisGroup, Double yAxisMin)

    • getYAxisMin

      public Double getYAxisMin()

    • setYAxisMin

      public AxesChartStyler setYAxisMin​(Double yAxisMin)

    • getYAxisMin

      public Double getYAxisMin​(Integer yAxisGroup)

    • setYAxisMax

      public AxesChartStyler setYAxisMax​(Integer yAxisGroup, Double yAxisMax)

    • getYAxisMax

      public Double getYAxisMax()

    • setYAxisMax

      public AxesChartStyler setYAxisMax​(Double yAxisMax)

    • getYAxisMax

      public Double getYAxisMax​(Integer yAxisGroup)

    • getXAxisMaxLabelCount

      public int getXAxisMaxLabelCount()

    • setXAxisMaxLabelCount

      public void setXAxisMaxLabelCount​(int xAxisMaxLabelCount)

    • isPlotGridLinesVisible

      public boolean isPlotGridLinesVisible()

    • setPlotGridLinesVisible

      public AxesChartStyler setPlotGridLinesVisible​(boolean isPlotGridLinesVisible)
      sets the visibility of the gridlines inside the plot area
      Parameters:
      isPlotGridLinesVisible -

    • isPlotGridHorizontalLinesVisible

      public boolean isPlotGridHorizontalLinesVisible()

    • setPlotGridHorizontalLinesVisible

      public AxesChartStyler setPlotGridHorizontalLinesVisible​(boolean isPlotGridHorizontalLinesVisible)
      sets the visibility of the horizontal gridlines on the plot area
      Parameters:
      isPlotGridHorizontalLinesVisible -

    • isPlotGridVerticalLinesVisible

      public boolean isPlotGridVerticalLinesVisible()

    • setPlotGridVerticalLinesVisible

      public AxesChartStyler setPlotGridVerticalLinesVisible​(boolean isPlotGridVerticalLinesVisible)
      sets the visibility of the vertical gridlines on the plot area
      Parameters:
      isPlotGridVerticalLinesVisible -

    • isPlotTicksMarksVisible

      public boolean isPlotTicksMarksVisible()

    • setPlotTicksMarksVisible

      public AxesChartStyler setPlotTicksMarksVisible​(boolean isPlotTicksMarksVisible)
      sets the visibility of the ticks marks inside the plot area
      Parameters:
      isPlotTicksMarksVisible -

    • getPlotGridLinesColor

      public Color getPlotGridLinesColor()

    • setPlotGridLinesColor

      public AxesChartStyler setPlotGridLinesColor​(Color plotGridLinesColor)
      set the plot area's grid lines color
      Parameters:
      plotGridLinesColor -

    • getPlotGridLinesStroke

      public BasicStroke getPlotGridLinesStroke()

    • setPlotGridLinesStroke

      public AxesChartStyler setPlotGridLinesStroke​(BasicStroke plotGridLinesStroke)
      set the plot area's grid lines Stroke
      Parameters:
      plotGridLinesStroke -

    • getErrorBarsColor

      public Color getErrorBarsColor()

    • setErrorBarsColor

      public AxesChartStyler setErrorBarsColor​(Color errorBarsColor)
      Sets the color of the error bars
      Parameters:
      errorBarsColor -

    • isErrorBarsColorSeriesColor

      public boolean isErrorBarsColorSeriesColor()

    • setErrorBarsColorSeriesColor

      public AxesChartStyler setErrorBarsColorSeriesColor​(boolean isErrorBarsColorSeriesColor)
      Set true if the the error bar color should match the series color
      Returns:

    • getLocale

      public Locale getLocale()

    • setLocale

      public AxesChartStyler setLocale​(Locale locale)
      Set the locale to use for rendering the chart
      Parameters:
      locale - - the locale to use when formatting Strings and dates for the axis tick labels

    • getTimezone

      public TimeZone getTimezone()

    • setTimezone

      public AxesChartStyler setTimezone​(TimeZone timezone)
      Set the timezone to use for formatting Date axis tick labels
      Parameters:
      timezone - the timezone to use when formatting date data

    • getDatePattern

      public String getDatePattern()

    • setDatePattern

      public AxesChartStyler setDatePattern​(String datePattern)
      Set the String formatter for Data x-axis
      Parameters:
      datePattern - - the pattern describing the date and time format

    • getXAxisDecimalPattern

      public String getXAxisDecimalPattern()

    • setXAxisDecimalPattern

      public AxesChartStyler setXAxisDecimalPattern​(String xAxisDecimalPattern)
      Set the decimal formatting pattern for the X-Axis
      Parameters:
      xAxisDecimalPattern -

    • getYAxisDecimalPattern

      public String getYAxisDecimalPattern()

    • setYAxisDecimalPattern

      public AxesChartStyler setYAxisDecimalPattern​(String yAxisDecimalPattern)
      Set the decimal formatting pattern for the Y-Axis
      Parameters:
      yAxisDecimalPattern -

    • getYAxisGroupDecimalPatternMap

      public Map<Integer,​String> getYAxisGroupDecimalPatternMap()

    • putYAxisGroupDecimalPatternMap

      public void putYAxisGroupDecimalPatternMap​(int yIndex, String yAxisDecimalPattern)

    • isXAxisLogarithmicDecadeOnly

      public boolean isXAxisLogarithmicDecadeOnly()

    • setXAxisLogarithmicDecadeOnly

      public AxesChartStyler setXAxisLogarithmicDecadeOnly​(boolean xAxisLogarithmicDecadeOnly)
      Set the decade only support for logarithmic Y-Axis
      Parameters:
      xAxisLogarithmicDecadeOnly -

    • isYAxisLogarithmicDecadeOnly

      public boolean isYAxisLogarithmicDecadeOnly()

    • setYAxisLogarithmicDecadeOnly

      public AxesChartStyler setYAxisLogarithmicDecadeOnly​(boolean yAxisLogarithmicDecadeOnly)
      Set the decade only support for logarithmic Y-Axis
      Parameters:
      yAxisLogarithmicDecadeOnly -

    • getxAxisTickLabelsFormattingFunction

      public Function<Double,​String> getxAxisTickLabelsFormattingFunction()

    • setxAxisTickLabelsFormattingFunction

      public void setxAxisTickLabelsFormattingFunction​(Function<Double,​String> xAxisTickLabelsFormattingFunction)

    • getyAxisTickLabelsFormattingFunction

      public Function<Double,​String> getyAxisTickLabelsFormattingFunction()

    • setyAxisTickLabelsFormattingFunction

      public void setyAxisTickLabelsFormattingFunction​(Function<Double,​String> yAxisTickLabelsFormattingFunction)

    • getXAxisTickLabelsColor

      public Color getXAxisTickLabelsColor()

    • setXAxisTickLabelsColor

      public AxesChartStyler setXAxisTickLabelsColor​(Color xAxisTickLabelsColor)

    • getYAxisTickLabelsColor

      public Color getYAxisTickLabelsColor()

    • setYAxisTickLabelsColor

      public AxesChartStyler setYAxisTickLabelsColor​(Color yAxisTickLabelsColor)

    • getXAxisTickMarksColor

      public Color getXAxisTickMarksColor()

    • setXAxisTickMarksColor

      public AxesChartStyler setXAxisTickMarksColor​(Color xAxisTickMarksColor)

    • getYAxisTickMarksColor

      public Color getYAxisTickMarksColor()

    • setYAxisTickMarksColor

      public AxesChartStyler setYAxisTickMarksColor​(Color yAxisTickMarksColor)

    • getYAxisGroupTickLabelsColorMap

      public Color getYAxisGroupTickLabelsColorMap​(int yAxisGroup)

    • setYAxisGroupTickLabelsColorMap

      public AxesChartStyler setYAxisGroupTickLabelsColorMap​(int yAxisGroup, Color yAxisTickLabelsColor)

    • getYAxisGroupTickMarksColorMap

      public Color getYAxisGroupTickMarksColorMap​(int yAxisGroup)

    • setYAxisGroupTickMarksColorMap

      public AxesChartStyler setYAxisGroupTickMarksColorMap​(int yAxisGroup, Color yAxisTickMarksColor)

    • getXAxisLabelAlignment

      public AxesChartStyler.TextAlignment getXAxisLabelAlignment()

    • setXAxisLabelAlignment

      public void setXAxisLabelAlignment​(AxesChartStyler.TextAlignment xAxisLabelAlignment)

    • getXAxisLabelAlignmentVertical

      public AxesChartStyler.TextAlignment getXAxisLabelAlignmentVertical()

    • setXAxisLabelAlignmentVertical

      public void setXAxisLabelAlignmentVertical​(AxesChartStyler.TextAlignment xAxisLabelAlignmentVertical)

    • getYAxisLabelAlignment

      public AxesChartStyler.TextAlignment getYAxisLabelAlignment()

    • setYAxisLabelAlignment

      public AxesChartStyler setYAxisLabelAlignment​(AxesChartStyler.TextAlignment yAxisLabelAlignment)

    • getXAxisLabelRotation

      public int getXAxisLabelRotation()

    • setXAxisLabelRotation

      public AxesChartStyler setXAxisLabelRotation​(int xAxisLabelRotation)