Package org.knowm.xchart.internal.chartpart

Class Chart<ST extends Styler,S extends Series>

java.lang.Object

org.knowm.xchart.internal.chartpart.Chart<ST,S>

Direct Known Subclasses:

BoxChart, BubbleChart, CategoryChart, DialChart, HeatMapChart, OHLCChart, PieChart, RadarChart, XYChart

public abstract class Chart<ST extends Styler,S extends Series>
extends java.lang.Object

An XChart Chart

Field Summary

Fields

Modifier and Type	Field	Description
protected java.util.ArrayList<ChartPart>	annotations
protected AxisPair	axisPair	Chart Parts
protected ChartTitle<ST,S>	chartTitle
private int	height
protected Legend_<ST,S>	legend
protected Plot_<ST,S>	plot
protected java.util.Map<java.lang.String,S>	seriesMap
protected ST	styler
private java.lang.String	title
private int	width	Meta Data
private java.lang.String	xAxisTitle
private java.util.Map<java.lang.Integer,java.lang.String>	yAxisGroupTitleMap
private java.lang.String	yAxisTitle

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	Chart(int width, int height, ST styler)	Constructor

Method Summary

Modifier and Type	Method	Description
void	addAnnotation(Annotation annotation)
(package private) AxisPair	getAxisPair()
(package private) ChartTitle<ST,S>	getChartTitle()	Chart Parts Getters
double	getChartXFromCoordinate(int screenX)
double	getChartYFromCoordinate(int screenY)
double	getChartYFromCoordinate(int screenY, int yIndex)
int	getHeight()
(package private) Legend_<ST,S>	getLegend()
(package private) Plot_<ST,S>	getPlot()
double	getScreenXFromChart(double xValue)
double	getScreenYFromChart(double yValue)
double	getScreenYFromChart(double yValue, int yIndex)
java.util.Map<java.lang.String,S>	getSeriesMap()
ST	getStyler()	Gets the Chart's styler, which can be used to customize the Chart's appearance
java.lang.String	getTitle()
int	getWidth()	Getters and Setters
(package private) Axis	getXAxis()
(package private) java.text.Format	getXAxisFormat()
java.lang.String	getXAxisTitle()
(package private) Axis	getYAxis()
(package private) Axis	getYAxis(int yIndex)
(package private) java.text.Format	getYAxisFormat()
(package private) java.text.Format	getYAxisFormat(java.lang.String yAxisDecimalPattern)
java.lang.String	getYAxisGroupTitle(int yAxisGroup)
double	getYAxisLeftWidth()
java.lang.String	getYAxisTitle()
abstract void	paint(java.awt.Graphics2D g, int width, int height)
protected void	paintBackground(java.awt.Graphics2D g)
S	removeSeries(java.lang.String seriesName)
void	setCustomXAxisTickLabelsFormatter(java.util.function.Function<java.lang.Double,java.lang.String> customFormattingFunction)
void	setCustomYAxisTickLabelsFormatter(java.util.function.Function<java.lang.Double,java.lang.String> customFormattingFunction)
protected void	setHeight(int height)
void	setTitle(java.lang.String title)
protected void	setWidth(int width)
void	setXAxisTitle(java.lang.String xAxisTitle)
void	setYAxisGroupTitle(int yAxisGroup, java.lang.String yAxisTitle)
void	setYAxisTitle(java.lang.String yAxisTitle)

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

styler

protected final ST extends Styler styler

chartTitle

protected final ChartTitle<ST extends Styler,S extends Series> chartTitle

seriesMap

protected final java.util.Map<java.lang.String,S extends Series> seriesMap

annotations

protected final java.util.ArrayList<ChartPart> annotations

axisPair

protected AxisPair axisPair

Chart Parts

plot

protected Plot_<ST extends Styler,S extends Series> plot

legend

protected Legend_<ST extends Styler,S extends Series> legend

width

private int width

Meta Data

height

private int height

title

private java.lang.String title

xAxisTitle

private java.lang.String xAxisTitle

yAxisTitle

private java.lang.String yAxisTitle

yAxisGroupTitleMap

private final java.util.Map<java.lang.Integer,java.lang.String> yAxisGroupTitleMap

Constructor Detail

Chart

protected Chart(int width,
                int height,
                ST styler)

Constructor

Parameters:

width -

height -

styler -

Method Detail

paint

public abstract void paint(java.awt.Graphics2D g,
                           int width,
                           int height)

paintBackground

protected void paintBackground(java.awt.Graphics2D g)

getStyler

public ST getStyler()

Gets the Chart's styler, which can be used to customize the Chart's appearance

Returns:

the styler

removeSeries

public S removeSeries(java.lang.String seriesName)

getWidth

public int getWidth()

Getters and Setters

setWidth

protected void setWidth(int width)

getHeight

public int getHeight()

setHeight

protected void setHeight(int height)

getTitle

public java.lang.String getTitle()

setTitle

public void setTitle(java.lang.String title)

getXAxisTitle

public java.lang.String getXAxisTitle()

setXAxisTitle

public void setXAxisTitle(java.lang.String xAxisTitle)

getYAxisTitle

public java.lang.String getYAxisTitle()

setYAxisTitle

public void setYAxisTitle(java.lang.String yAxisTitle)

getYAxisGroupTitle

public java.lang.String getYAxisGroupTitle(int yAxisGroup)

setYAxisGroupTitle

public void setYAxisGroupTitle(int yAxisGroup,
                               java.lang.String yAxisTitle)

addAnnotation

public void addAnnotation(Annotation annotation)

setCustomXAxisTickLabelsFormatter

public void setCustomXAxisTickLabelsFormatter(java.util.function.Function<java.lang.Double,java.lang.String> customFormattingFunction)

Parameters:

customFormattingFunction -

setCustomYAxisTickLabelsFormatter

public void setCustomYAxisTickLabelsFormatter(java.util.function.Function<java.lang.Double,java.lang.String> customFormattingFunction)

Parameters:

customFormattingFunction -

getChartTitle

ChartTitle<ST,S> getChartTitle()

Chart Parts Getters

getLegend

Legend_<ST,S> getLegend()

getPlot

Plot_<ST,S> getPlot()

getXAxis

Axis getXAxis()

getYAxis

Axis getYAxis()

getYAxis

Axis getYAxis(int yIndex)

getAxisPair

AxisPair getAxisPair()

getXAxisFormat

java.text.Format getXAxisFormat()

getYAxisFormat

java.text.Format getYAxisFormat()

getYAxisFormat

java.text.Format getYAxisFormat(java.lang.String yAxisDecimalPattern)

getChartXFromCoordinate

public double getChartXFromCoordinate(int screenX)

getChartYFromCoordinate

public double getChartYFromCoordinate(int screenY)

getChartYFromCoordinate

public double getChartYFromCoordinate(int screenY,
                                      int yIndex)

getScreenXFromChart

public double getScreenXFromChart(double xValue)

getScreenYFromChart

public double getScreenYFromChart(double yValue)

getScreenYFromChart

public double getScreenYFromChart(double yValue,
                                  int yIndex)

getYAxisLeftWidth

public double getYAxisLeftWidth()

getSeriesMap

public java.util.Map<java.lang.String,S> getSeriesMap()