Package org.knowm.xchart.style

Class Styler

  • Direct Known Subclasses:
    AxesChartStyler, DialStyler, PieStyler, RadarStyler
    public abstract class Styler
extends java.lang.Object
    The styler is used to manage all things related to styling of the vast number of Chart components

    • Field Detail

      • theme

        Theme theme
        the default Theme

      • baseFont

        private java.awt.Font baseFont

      • chartBackgroundColor

        private java.awt.Color chartBackgroundColor

      • chartFontColor

        private java.awt.Color chartFontColor

      • chartPadding

        private int chartPadding

      • seriesColors

        private java.awt.Color[] seriesColors

      • seriesLines

        private java.awt.BasicStroke[] seriesLines

      • seriesMarkers

        private Marker[] seriesMarkers

      • chartTitleFont

        private java.awt.Font chartTitleFont

      • isChartTitleVisible

        private boolean isChartTitleVisible

      • isChartTitleBoxVisible

        private boolean isChartTitleBoxVisible

      • chartTitleBoxBackgroundColor

        private java.awt.Color chartTitleBoxBackgroundColor

      • chartTitleBoxBorderColor

        private java.awt.Color chartTitleBoxBorderColor

      • chartTitlePadding

        private int chartTitlePadding

      • isLegendVisible

        private boolean isLegendVisible

      • legendBackgroundColor

        private java.awt.Color legendBackgroundColor

      • legendBorderColor

        private java.awt.Color legendBorderColor

      • legendFont

        private java.awt.Font legendFont

      • legendPadding

        private int legendPadding

      • legendSeriesLineLength

        private int legendSeriesLineLength

      • plotBackgroundColor

        private java.awt.Color plotBackgroundColor

      • plotBorderColor

        private java.awt.Color plotBorderColor

      • isPlotBorderVisible

        private boolean isPlotBorderVisible

      • plotContentSize

        private double plotContentSize

      • annotationTextPanelBackgroundColor

        private java.awt.Color annotationTextPanelBackgroundColor

      • annotationTextPanelBorderColor

        private java.awt.Color annotationTextPanelBorderColor

      • annotationTextPanelFont

        private java.awt.Font annotationTextPanelFont

      • annotationTextPanelFontColor

        private java.awt.Color annotationTextPanelFontColor

      • annotationTextPanelPadding

        private int annotationTextPanelPadding

      • annotationTextFont

        private java.awt.Font annotationTextFont

      • annotationTextFontColor

        private java.awt.Color annotationTextFontColor

      • annotationLineStroke

        private java.awt.BasicStroke annotationLineStroke

      • annotationLineColor

        private java.awt.Color annotationLineColor

      • chartButtonBackgroundColor

        private java.awt.Color chartButtonBackgroundColor

      • chartButtonBorderColor

        private java.awt.Color chartButtonBorderColor

      • chartButtonFontColor

        private java.awt.Color chartButtonFontColor

      • chartButtonFont

        private java.awt.Font chartButtonFont

      • chartButtonMargin

        private int chartButtonMargin

      • isToolTipsEnabled

        private boolean isToolTipsEnabled

      • isToolTipsAlwaysVisible

        private boolean isToolTipsAlwaysVisible

      • toolTipBackgroundColor

        private java.awt.Color toolTipBackgroundColor

      • toolTipBorderColor

        private java.awt.Color toolTipBorderColor

      • toolTipFont

        private java.awt.Font toolTipFont

      • toolTipHighlightColor

        private java.awt.Color toolTipHighlightColor

      • antiAlias

        private boolean antiAlias

      • decimalPattern

        private java.lang.String decimalPattern

      • yAxisAlignmentMap

        private final java.util.HashMap<java.lang.Integer,​Styler.YAxisPosition> yAxisAlignmentMap

      • yAxisLeftWidthHint

        private int yAxisLeftWidthHint

      • showWithinAreaPoint

        private boolean showWithinAreaPoint

      • xAxisTitleColor

        private java.awt.Color xAxisTitleColor

      • yAxisTitleColor

        private java.awt.Color yAxisTitleColor

      • yAxisGroupTitleColorMap

        private final java.util.Map<java.lang.Integer,​java.awt.Color> yAxisGroupTitleColorMap

      • markerSize

        private int markerSize

    • Constructor Detail

      • Styler

        public Styler()

    • Method Detail

      • setAllStyles

        void setAllStyles()

      • getBaseFont

        public java.awt.Font getBaseFont()

      • setBaseFont

        public Styler setBaseFont​(java.awt.Font baseFont)
        Set the base font
        Parameters:
        baseFont -
        Returns:
        styler

      • getChartBackgroundColor

        public java.awt.Color getChartBackgroundColor()

      • setChartBackgroundColor

        public Styler setChartBackgroundColor​(java.awt.Color color)
        Set the chart background color - the part around the edge of the chart
        Parameters:
        color -

      • getChartFontColor

        public java.awt.Color getChartFontColor()

      • setChartFontColor

        public Styler setChartFontColor​(java.awt.Color color)
        Set the chart font color. includes: Chart title, axes label, legend
        Parameters:
        color -

      • getChartPadding

        public int getChartPadding()

      • setChartPadding

        public Styler setChartPadding​(int chartPadding)
        Set the chart padding
        Parameters:
        chartPadding -

      • getSeriesColors

        public java.awt.Color[] getSeriesColors()

      • setSeriesColors

        public Styler setSeriesColors​(java.awt.Color[] seriesColors)

      • getSeriesLines

        public java.awt.BasicStroke[] getSeriesLines()

      • setSeriesLines

        public Styler setSeriesLines​(java.awt.BasicStroke[] seriesLines)

      • getSeriesMarkers

        public Marker[] getSeriesMarkers()

      • setSeriesMarkers

        public Styler setSeriesMarkers​(Marker[] seriesMarkers)

      • getChartTitleFont

        public java.awt.Font getChartTitleFont()

      • setChartTitleFont

        public Styler setChartTitleFont​(java.awt.Font chartTitleFont)
        Set the chart title font
        Parameters:
        chartTitleFont -
        Returns:

      • isChartTitleVisible

        public boolean isChartTitleVisible()

      • setChartTitleVisible

        public Styler setChartTitleVisible​(boolean isChartTitleVisible)
        Set the chart title visibility
        Parameters:
        isChartTitleVisible -

      • isChartTitleBoxVisible

        public boolean isChartTitleBoxVisible()

      • setChartTitleBoxVisible

        public Styler setChartTitleBoxVisible​(boolean isChartTitleBoxVisible)
        Set the chart title box visibility
        Parameters:
        isChartTitleBoxVisible -

      • getChartTitleBoxBackgroundColor

        public java.awt.Color getChartTitleBoxBackgroundColor()

      • setChartTitleBoxBackgroundColor

        public Styler setChartTitleBoxBackgroundColor​(java.awt.Color chartTitleBoxBackgroundColor)
        set the chart title box background color
        Parameters:
        chartTitleBoxBackgroundColor -

      • getChartTitleBoxBorderColor

        public java.awt.Color getChartTitleBoxBorderColor()

      • setChartTitleBoxBorderColor

        public Styler setChartTitleBoxBorderColor​(java.awt.Color chartTitleBoxBorderColor)
        set the chart title box border color
        Parameters:
        chartTitleBoxBorderColor -

      • getChartTitlePadding

        public int getChartTitlePadding()

      • setChartTitlePadding

        public Styler setChartTitlePadding​(int chartTitlePadding)
        set the chart title padding; the space between the chart title and the plot area
        Parameters:
        chartTitlePadding -

      • isLegendVisible

        public boolean isLegendVisible()

      • setLegendVisible

        public Styler setLegendVisible​(boolean isLegendVisible)
        Set the chart legend visibility
        Parameters:
        isLegendVisible -

      • getLegendBackgroundColor

        public java.awt.Color getLegendBackgroundColor()

      • setLegendBackgroundColor

        public Styler setLegendBackgroundColor​(java.awt.Color color)
        Set the chart legend background color
        Parameters:
        color -

      • getLegendBorderColor

        public java.awt.Color getLegendBorderColor()
        Set the chart legend border color
        Returns:

      • setLegendBorderColor

        public Styler setLegendBorderColor​(java.awt.Color legendBorderColor)

      • getLegendFont

        public java.awt.Font getLegendFont()

      • setLegendFont

        public Styler setLegendFont​(java.awt.Font font)
        Set the chart legend font
        Parameters:
        font -

      • getLegendPadding

        public int getLegendPadding()

      • setLegendPadding

        public Styler setLegendPadding​(int legendPadding)
        Set the chart legend padding
        Parameters:
        legendPadding -

      • getLegendSeriesLineLength

        public int getLegendSeriesLineLength()

      • setLegendSeriesLineLength

        public Styler setLegendSeriesLineLength​(int legendSeriesLineLength)
        Set the chart legend series line length
        Parameters:
        legendSeriesLineLength -
        Returns:

      • setLegendPosition

        public Styler setLegendPosition​(Styler.LegendPosition legendPosition)
        sets the legend position
        Parameters:
        legendPosition -

      • getLegendLayout

        public Styler.LegendLayout getLegendLayout()
        Set the legend layout
        Returns:

      • getPlotBackgroundColor

        public java.awt.Color getPlotBackgroundColor()

      • setPlotBackgroundColor

        public Styler setPlotBackgroundColor​(java.awt.Color plotBackgroundColor)
        set the plot area's background color
        Parameters:
        plotBackgroundColor -

      • getPlotBorderColor

        public java.awt.Color getPlotBorderColor()

      • setPlotBorderColor

        public Styler setPlotBorderColor​(java.awt.Color plotBorderColor)
        set the plot area's border color
        Parameters:
        plotBorderColor -

      • isPlotBorderVisible

        public boolean isPlotBorderVisible()

      • setPlotBorderVisible

        public Styler setPlotBorderVisible​(boolean isPlotBorderVisible)
        sets the visibility of the border around the plot area
        Parameters:
        isPlotBorderVisible -

      • getPlotContentSize

        public double getPlotContentSize()

      • setPlotContentSize

        public Styler setPlotContentSize​(double plotContentSize)
        Sets the content size of the plot inside the plot area of the chart. To fill the area 100%, use a value of 1.0.
        Parameters:
        plotContentSize - - Valid range is between 0 and 1.

      • getAnnotationTextPanelBackgroundColor

        public java.awt.Color getAnnotationTextPanelBackgroundColor()

      • setAnnotationTextPanelBackgroundColor

        public Styler setAnnotationTextPanelBackgroundColor​(java.awt.Color color)

      • getAnnotationTextPanelBorderColor

        public java.awt.Color getAnnotationTextPanelBorderColor()

      • setAnnotationTextPanelBorderColor

        public Styler setAnnotationTextPanelBorderColor​(java.awt.Color borderColor)

      • getAnnotationTextPanelFont

        public java.awt.Font getAnnotationTextPanelFont()

      • setAnnotationTextPanelFont

        public Styler setAnnotationTextPanelFont​(java.awt.Font font)

      • getAnnotationTextPanelFontColor

        public java.awt.Color getAnnotationTextPanelFontColor()

      • setAnnotationTextPanelFontColor

        public Styler setAnnotationTextPanelFontColor​(java.awt.Color annotationTextPanelFontColor)

      • getAnnotationTextPanelPadding

        public int getAnnotationTextPanelPadding()

      • setAnnotationTextPanelPadding

        public Styler setAnnotationTextPanelPadding​(int annotationTextPanelPadding)

      • getAnnotationTextFont

        public java.awt.Font getAnnotationTextFont()

      • setAnnotationTextFont

        public Styler setAnnotationTextFont​(java.awt.Font annotationTextFont)

      • getAnnotationTextFontColor

        public java.awt.Color getAnnotationTextFontColor()

      • setAnnotationTextFontColor

        public Styler setAnnotationTextFontColor​(java.awt.Color annotationTextFontColor)

      • getAnnotationLineStroke

        public java.awt.BasicStroke getAnnotationLineStroke()

      • setAnnotationLineStroke

        public Styler setAnnotationLineStroke​(java.awt.BasicStroke annotationLineStroke)

      • getAnnotationLineColor

        public java.awt.Color getAnnotationLineColor()

      • setAnnotationLineColor

        public Styler setAnnotationLineColor​(java.awt.Color annotationLineColor)

      • getChartButtonBackgroundColor

        public java.awt.Color getChartButtonBackgroundColor()

      • setChartButtonBackgroundColor

        public Styler setChartButtonBackgroundColor​(java.awt.Color chartButtonBackgroundColor)

      • getChartButtonBorderColor

        public java.awt.Color getChartButtonBorderColor()

      • setChartButtonBorderColor

        public Styler setChartButtonBorderColor​(java.awt.Color chartButtonBorderColor)

      • getChartButtonFontColor

        public java.awt.Color getChartButtonFontColor()

      • setChartButtonFontColor

        public Styler setChartButtonFontColor​(java.awt.Color chartButtonFontColor)

      • getChartButtonFont

        public java.awt.Font getChartButtonFont()

      • setChartButtonFont

        public Styler setChartButtonFont​(java.awt.Font chartButtonFont)

      • getChartButtonMargin

        public int getChartButtonMargin()

      • setChartButtonMargin

        public Styler setChartButtonMargin​(int chartButtonMargin)

      • isToolTipsEnabled

        public boolean isToolTipsEnabled()

      • setToolTipsEnabled

        public Styler setToolTipsEnabled​(boolean toolTipsEnabled)

      • isToolTipsAlwaysVisible

        public boolean isToolTipsAlwaysVisible()

      • setToolTipsAlwaysVisible

        public Styler setToolTipsAlwaysVisible​(boolean toolTipsAlwaysVisible)

      • getToolTipBackgroundColor

        public java.awt.Color getToolTipBackgroundColor()

      • setToolTipBackgroundColor

        public Styler setToolTipBackgroundColor​(java.awt.Color toolTipBackgroundColor)

      • getToolTipBorderColor

        public java.awt.Color getToolTipBorderColor()

      • setToolTipBorderColor

        public Styler setToolTipBorderColor​(java.awt.Color toolTipBorderColor)

      • getToolTipFont

        public java.awt.Font getToolTipFont()

      • setToolTipFont

        public Styler setToolTipFont​(java.awt.Font toolTipFont)

      • getToolTipHighlightColor

        public java.awt.Color getToolTipHighlightColor()

      • setToolTipHighlightColor

        public Styler setToolTipHighlightColor​(java.awt.Color toolTipHighlightColor)

      • getDecimalPattern

        public java.lang.String getDecimalPattern()

      • setDecimalPattern

        public Styler setDecimalPattern​(java.lang.String decimalPattern)
        Set the decimal formatter for all numbers on the chart
        Parameters:
        decimalPattern - - the pattern describing the decimal format

      • setYAxisGroupPosition

        public Styler setYAxisGroupPosition​(int yAxisGroup,
                                    Styler.YAxisPosition yAxisPosition)
        Set the Y-Axis group position.
        Parameters:
        yAxisGroup -
        yAxisPosition -

      • getAntiAlias

        public boolean getAntiAlias()

      • setAntiAlias

        public Styler setAntiAlias​(boolean newVal)

      • getYAxisLeftWidthHint

        public int getYAxisLeftWidthHint()

      • setYAxisLeftWidthHint

        public Styler setYAxisLeftWidthHint​(int yAxisLeftWidthHint)
        Set the width of the Y-Axis tick labels on the left side of the chart. This can help to align the start of the X-Axis for two or more charts that are arranged in a column of charts.
        Parameters:
        yAxisLeftWidthHint -

      • setShowWithinAreaPoint

        public Styler setShowWithinAreaPoint​(boolean showWithinAreaPoint)

      • getShowWithinAreaPoint

        public boolean getShowWithinAreaPoint()

      • getXAxisTitleColor

        public java.awt.Color getXAxisTitleColor()

      • setXAxisTitleColor

        public Styler setXAxisTitleColor​(java.awt.Color xAxisTitleColor)

      • getYAxisTitleColor

        public java.awt.Color getYAxisTitleColor()

      • setYAxisTitleColor

        public Styler setYAxisTitleColor​(java.awt.Color yAxisColor)

      • getYAxisGroupTitleColor

        public java.awt.Color getYAxisGroupTitleColor​(int yAxisGroup)

      • setYAxisGroupTitleColor

        public Styler setYAxisGroupTitleColor​(int yAxisGroup,
                                      java.awt.Color yAxisColor)

      • getMarkerSize

        public int getMarkerSize()

      • setMarkerSize

        public Styler setMarkerSize​(int markerSize)
        Sets the size of the markers (in pixels)
        Parameters:
        markerSize -

      • getTheme

        public Theme getTheme()