LineChart (Slothsoft Charts)

java.lang.Object
- de.slothsoft.charts.Chart
- - de.slothsoft.charts.linechart.LineChart

```
public class LineChart
extends Chart
```
This class represents a Chart that displays lines of some sort inside a coordinate system. It's structure looks like this:

Since:

0.1.0

Author:

Stef Schulz

Constructor Summary

Constructors
Constructor and Description

LineChart()
Default constructor.

Constructors
Constructor and Description
`LineChart()` Default constructor.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`void`	`addLine(Line line)` Adds a line to the chart.
`void`	`addLines(Line... addedLines)` Adds some lines to the chart.
`Area`	`calculateDisplayedArea()` Calculates the displayed area via `getDisplayedArea()` or the added lines.
`double`	`convertToChartX(double graphX)` Converts a graph coordinate to a chart one.
`double`	`convertToChartY(double graphY)` Converts a graph coordinate to a chart one.
`double[]`	`convertToGraphCoordinates(double chartX, double chartY)` Converts chart coordinates to a graph ones.
`double`	`convertToGraphX(double chartX)` Converts a chart coordinate to a graph one.
`double`	`convertToGraphY(double chartY)` Converts a chart coordinate to a graph one.
`LineChart`	`displayedArea(Area newDisplayedArea)` Sets the displayed area of this chart, i.e.
`Area`	`getDisplayedArea()` Returns the displayed area of this chart, i.e.
`XAxis`	`getXAxis()` Returns the x axis of this line chart.
`YAxis`	`getYAxis()` Returns the y axis of this line chart.
`double`	`getZoomFactor()` Returns the factor which should be used to zoom the graph area.
`void`	`moveDisplayedAreaByChartCoordinates(double xIncrement, double yIncrement)` Moves the displayed area of this `Chart` by the coordinates used for the entire chart.
`void`	`paintOn(GraphicContext gc, PaintInstructions instructions)` Paints the current content onto the graphic context.
`void`	`removeLine(Line line)` Removes a line from the chart.
`void`	`removeLines(Line... removedLines)` Removes some lines to the chart.
`void`	`resetDisplayedArea()` Resets the displayed area.
`void`	`setDisplayedArea(Area displayedArea)` Sets the displayed area of this chart, i.e.
`void`	`setZoomFactor(double zoomFactor)` Sets the factor which should be used to zoom the graph area.
`void`	`zoomDisplayedAreaInByChartCoordinates(double chartX, double chartY)` Zooms the graph area in using the chart's coordinates.
`void`	`zoomDisplayedAreaInByGraphCoordinates(double graphX, double graphY)` Zooms the graph area in using the graph's coordinates.
`void`	`zoomDisplayedAreaOutByChartCoordinates(double chartX, double chartY)` Zooms the graph area out using the chart's coordinates.
`void`	`zoomDisplayedAreaOutByGraphCoordinates(double graphX, double graphY)` Zooms the graph area out using the graph's coordinates.
`LineChart`	`zoomFactor(double newZoomFactor)` Sets the factor which should be used to zoom the graph area.

Methods inherited from class de.slothsoft.charts.Chart
addRefreshListener, backgroundColor, calculateGraphArea, getBackgroundColor, getBorder, getTitle, removeRefreshListener, setBackgroundColor

Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Constructor Detail
  - LineChart
```
public LineChart()
```
    Default constructor.
- Method Detail
  - paintOn
```
public void paintOn(GraphicContext gc,
                    PaintInstructions instructions)
```
    Description copied from class: Chart
    
    Paints the current content onto the graphic context. Checks the instructions for what to paint. The instructions contain the area in display coordinates, starting from the top left with 0|0 and ending bottom right with something like 800|600.
    
    Overrides:
    
    paintOn in class Chart
    
    Parameters:
    
    gc - graphic context; coordinates are relative to the screen
    
    instructions - additional instructions like the area to paint on
  - calculateDisplayedArea
```
public Area calculateDisplayedArea()
```
    Calculates the displayed area via getDisplayedArea() or the added lines.
    
    Returns:
    
    the displayed area
    
    Since:
    
    0.2.0
    
    See Also:
    
    getDisplayedArea(), addLine(Line), addLines(Line[])
  - addLine
```
public void addLine(Line line)
```
    Adds a line to the chart.
    
    Parameters:
    
    line - a line to add
  - addLines
```
public void addLines(Line... addedLines)
```
    Adds some lines to the chart.
    
    Parameters:
    
    addedLines - lines to add
  - removeLine
```
public void removeLine(Line line)
```
    Removes a line from the chart.
    
    Parameters:
    
    line - a line to add
  - removeLines
```
public void removeLines(Line... removedLines)
```
    Removes some lines to the chart.
    
    Parameters:
    
    removedLines - lines to add
  - moveDisplayedAreaByChartCoordinates
```
public void moveDisplayedAreaByChartCoordinates(double xIncrement,
                                                double yIncrement)
```
    Moves the displayed area of this Chart by the coordinates used for the entire chart. Let's say the chart is painted on an area 1000x1000 pixels, but the graph only displays something between the coordinates 0 and 1. If you move 100pixels in the chart scale, you only need to move the graph 0.1 points.
    
    Parameters:
    
    xIncrement - the x movement
    
    yIncrement - the y movement
    
    Throws:
    
    IllegalArgumentException - if graph was never painted before
  - zoomDisplayedAreaInByChartCoordinates
```
public void zoomDisplayedAreaInByChartCoordinates(double chartX,
                                                  double chartY)
```
    Zooms the graph area in using the chart's coordinates.
    
    Parameters:
    
    chartX - the x coordinate in the chart's coordinate system
    
    chartY - the y coordinate in the chart's coordinate system
    
    See Also:
    
    convertToGraphCoordinates(double, double), convertToGraphX(double), convertToGraphY(double), zoomDisplayedAreaOutByChartCoordinates(double, double)
  - zoomDisplayedAreaInByGraphCoordinates
```
public void zoomDisplayedAreaInByGraphCoordinates(double graphX,
                                                  double graphY)
```
    Zooms the graph area in using the graph's coordinates.
    
    Parameters:
    
    graphX - the x coordinate in the graph's coordinate system
    
    graphY - the y coordinate in the graph's coordinate system
    
    See Also:
    
    convertToGraphCoordinates(double, double), convertToGraphX(double), convertToGraphY(double), zoomDisplayedAreaOutByGraphCoordinates(double, double)
  - zoomDisplayedAreaOutByChartCoordinates
```
public void zoomDisplayedAreaOutByChartCoordinates(double chartX,
                                                   double chartY)
```
    Zooms the graph area out using the chart's coordinates.
    
    Parameters:
    
    chartX - the x coordinate in the chart's coordinate system
    
    chartY - the y coordinate in the chart's coordinate system
    
    Throws:
    
    IllegalArgumentException - if graph was never painted before
    
    See Also:
    
    convertToGraphCoordinates(double, double), convertToGraphX(double), convertToGraphY(double), zoomDisplayedAreaOutByChartCoordinates(double, double)
  - zoomDisplayedAreaOutByGraphCoordinates
```
public void zoomDisplayedAreaOutByGraphCoordinates(double graphX,
                                                   double graphY)
```
    Zooms the graph area out using the graph's coordinates.
    
    Parameters:
    
    graphX - the x coordinate in the graph's coordinate system
    
    graphY - the y coordinate in the graph's coordinate system
    
    Throws:
    
    IllegalArgumentException - if graph was never painted before
    
    See Also:
    
    convertToGraphCoordinates(double, double), convertToGraphX(double), convertToGraphY(double), zoomDisplayedAreaInByGraphCoordinates(double, double)
  - convertToGraphCoordinates
```
public double[] convertToGraphCoordinates(double chartX,
                                          double chartY)
```
    Converts chart coordinates to a graph ones. The chart is everything and x and y move from the top left to the bottom right. The graph is the area with the lines and moves from bottom left to top right.
    
    Parameters:
    
    chartX - the x coordinate in the chart's coordinate system
    
    chartY - the y coordinate in the chart's coordinate system
    
    Throws:
    
    IllegalArgumentException - if graph was never painted before
    
    See Also:
    
    convertToGraphX(double), convertToGraphY(double)
  - convertToGraphX
```
public double convertToGraphX(double chartX)
```
    Converts a chart coordinate to a graph one. The chart is everything and x and y move from the top left to the bottom right. The graph is the area with the lines and moves from bottom left to top right.
    
    Parameters:
    
    chartX - the x coordinate in the chart's coordinate system
    
    Throws:
    
    IllegalArgumentException - if graph was never painted before
    
    See Also:
    
    convertToGraphCoordinates(double, double), convertToGraphY(double)
  - convertToGraphY
```
public double convertToGraphY(double chartY)
```
    Converts a chart coordinate to a graph one. The chart is everything and x and y move from the top left to the bottom right. The graph is the area with the lines and moves from bottom left to top right.
    
    Parameters:
    
    chartY - the y coordinate in the chart's coordinate system
    
    Throws:
    
    IllegalArgumentException - if graph was never painted before
    
    See Also:
    
    convertToGraphCoordinates(double, double), convertToGraphX(double)
  - convertToChartX
```
public double convertToChartX(double graphX)
```
    Converts a graph coordinate to a chart one. The chart is everything and x and y move from the top left to the bottom right. The graph is the area with the lines and moves from bottom left to top right.
    
    Parameters:
    
    graphX - the x coordinate in the graph's coordinate system
    
    Throws:
    
    IllegalArgumentException - if graph was never painted before
    
    See Also:
    
    convertToChartY(double)
  - convertToChartY
```
public double convertToChartY(double graphY)
```
    Converts a graph coordinate to a chart one. The chart is everything and x and y move from the top left to the bottom right. The graph is the area with the lines and moves from bottom left to top right.
    
    Parameters:
    
    graphY - the y coordinate in the graph's coordinate system
    
    Throws:
    
    IllegalArgumentException - if graph was never painted before
    
    See Also:
    
    convertToChartX(double)
  - resetDisplayedArea
```
public void resetDisplayedArea()
```
    Resets the displayed area.
    
    See Also:
    
    setDisplayedArea(Area)
  - getDisplayedArea
```
public Area getDisplayedArea()
```
    Returns the displayed area of this chart, i.e. the coordinates to display. null is used to indicate the value is calculated by questioning the Lines.
    
    Returns:
    
    the displayed area
  - displayedArea
```
public LineChart displayedArea(Area newDisplayedArea)
```
    Sets the displayed area of this chart, i.e. the coordinates to display. null is used to indicate the value is calculated by questioning the Lines.
    
    Parameters:
    
    newDisplayedArea - the displayed area
    
    Returns:
    
    this instance
  - setDisplayedArea
```
public void setDisplayedArea(Area displayedArea)
```
    Sets the displayed area of this chart, i.e. the coordinates to display. null is used to indicate the value is calculated by questioning the Lines.
    
    Parameters:
    
    displayedArea - the displayed area
  - getZoomFactor
```
public double getZoomFactor()
```
    Returns the factor which should be used to zoom the graph area. A value of 0.25 means it gets zoomed by 25%.
    
    Returns:
    
    the zoom factor
    
    See Also:
    
    zoomDisplayedAreaInByChartCoordinates(double, double), zoomDisplayedAreaInByGraphCoordinates(double, double), zoomDisplayedAreaOutByChartCoordinates(double, double), zoomDisplayedAreaOutByGraphCoordinates(double, double)
  - zoomFactor
```
public LineChart zoomFactor(double newZoomFactor)
```
    Sets the factor which should be used to zoom the graph area. A value of 0.25 means it gets zoomed by 25%.
    
    Parameters:
    
    newZoomFactor - the zoom factor
    
    Returns:
    
    this instance
    
    See Also:
    
    zoomDisplayedAreaInByChartCoordinates(double, double), zoomDisplayedAreaInByGraphCoordinates(double, double), zoomDisplayedAreaOutByChartCoordinates(double, double), zoomDisplayedAreaOutByGraphCoordinates(double, double)
  - setZoomFactor
```
public void setZoomFactor(double zoomFactor)
```
    Sets the factor which should be used to zoom the graph area. A value of 0.25 means it gets zoomed by 25%.
    
    Parameters:
    
    zoomFactor - the zoom factor
    
    See Also:
    
    zoomDisplayedAreaInByChartCoordinates(double, double), zoomDisplayedAreaInByGraphCoordinates(double, double), zoomDisplayedAreaOutByChartCoordinates(double, double), zoomDisplayedAreaOutByGraphCoordinates(double, double)
  - getXAxis
```
public XAxis getXAxis()
```
    Returns the x axis of this line chart.
    
    Returns:
    
    the x axis
  - getYAxis
```
public YAxis getYAxis()
```
    Returns the y axis of this line chart.
    
    Returns:
    
    the y axis

Class LineChart

Constructor Summary

Method Summary

Methods inherited from class de.slothsoft.charts.Chart

Methods inherited from class java.lang.Object

Constructor Detail

LineChart

Method Detail

paintOn

calculateDisplayedArea

addLine

addLines

removeLine

removeLines

moveDisplayedAreaByChartCoordinates

zoomDisplayedAreaInByChartCoordinates

zoomDisplayedAreaInByGraphCoordinates

zoomDisplayedAreaOutByChartCoordinates

zoomDisplayedAreaOutByGraphCoordinates

convertToGraphCoordinates

convertToGraphX

convertToGraphY

convertToChartX

convertToChartY

resetDisplayedArea

getDisplayedArea

displayedArea

setDisplayedArea

getZoomFactor

zoomFactor

setZoomFactor

getXAxis

getYAxis