ChartConfiguration (jqplot4java 8.13.0 API)

java.lang.Object
- org.wicketstuff.jqplot.lib.ChartConfiguration<T>

Type Parameters:

T - Type of Axis

All Implemented Interfaces:

Serializable
```
public class ChartConfiguration<T extends Serializable>
extends Object
implements Serializable
```
Base configuration of JqPlot Chart. See jqplot documention http://www.jqplot.com/docs/files/usage-txt.html

Author:

inaiat

See Also:

Serialized Form

Field Summary

Fields
Modifier and Type	Field and Description
`protected Axes<T>`	`axes` The axes.
`protected Axis<T>`	`axesDefaults` The axes defaults.
`protected Collection<Serie>`	`series` The series.
`protected Title`	`title` The title.

Constructor Summary

Constructors
Constructor and Description

ChartConfiguration()

Constructors
Constructor and Description
`ChartConfiguration()`

Method Summary

All Methods Instance Methods Concrete Methods Deprecated Methods
Modifier and Type	Method and Description
`ChartConfiguration<T>`	`addSeries(Serie serie)` Adds the series.
`Axis<T>`	`axesDefaultsInstance()` Instantiates the axes defaults.
`Axes<T>`	`axesInstance()` Instantiates the axes.
`CanvasOverlay`	`canvasOverlayInstance()` Instantiates the canvas overlay.
`Axes<T>`	`createAxes()` Deprecated. use withAxes()
`Axis<T>`	`createAxesDefaults()` Deprecated.
`Cursor`	`createCursor()` Deprecated. use withCursor()
`Grid<T>`	`createGrid()` Deprecated. use withGrid
`Highlighter`	`createHighlighter()` Deprecated.
`Collection<Serie>`	`createSeries()` Deprecated.
`Collection<String>`	`createSeriesColors()` Deprecated.
`SeriesDefaults`	`createSeriesDefaults()` Deprecated.
`XAxis<T>`	`createXAxis()` Deprecated.
`YAxis<T>`	`createYAxis()` Deprecated.
`Cursor`	`cursorInstance()` Instantiates the cursor.
`Boolean`	`getAnimate()` Gets the animate.
`Axes<T>`	`getAxes()` Gets the axes.
`Axis<T>`	`getAxesDefaults()` Gets the axes defaults.
`CanvasOverlay`	`getCanvasOverlay()` Gets the canvas overlay.
`Cursor`	`getCursor()` Gets the cursor.
`Grid<T>`	`getGrid()` Gets the grid.
`GridPadding`	`getGridPadding()` Gets gridPadding
`Highlighter`	`getHighlighter()` Gets the highlighter.
`Legend`	`getLegend()` Gets the legend.
`Collection<Serie>`	`getSeries()` Gets the series.
`Collection<String>`	`getSeriesColors()` Gets the series colors.
`SeriesDefaults`	`getSeriesDefaults()` Gets the series defaults.
`Boolean`	`getShowMarker()` Gets the show marker.
`Boolean`	`getStackSeries()` Gets the stack series.
`Title`	`getTitle()` Gets the title.
`Grid<T>`	`gridInstance()` Instantiates the grid.
`GridPadding`	`gridPaddingInstance()` Get instance of GridPadding
`Highlighter`	`highlighterInstance()`
`Boolean`	`isCaptureRightClick()` Checks if is capture right click.
`Collection<String>`	`seriesColorsInstance()`
`SeriesDefaults`	`seriesDefaultsInstance()`
`Collection<Serie>`	`seriesInstance()`
`ChartConfiguration<T>`	`setAnimate(Boolean animate)` Turns on animation for all series in this plot.
`ChartConfiguration<T>`	`setAxes(Axes<T> axes)` Sets the axes.
`ChartConfiguration<T>`	`setAxesDefaults(Axis<T> axesDefaults)` Sets the axes defaults.
`ChartConfiguration<T>`	`setCanvasOverlay(CanvasOverlay canvasOverlay)` Sets the canvas overlay.
`ChartConfiguration<T>`	`setCaptureRightClick(Boolean captureRightClick)` Sets the capture right click.
`ChartConfiguration<T>`	`setCursor(Cursor cursor)` Sets the cursor.
`ChartConfiguration<T>`	`setGrid(Grid<T> grid)` Sets the grid.
`ChartConfiguration<T>`	`setGridPadding(GridPadding gridPadding)` Sets the gridPadding
`ChartConfiguration<T>`	`setHighlighter(Highlighter highlighter)` set the highlighter.
`ChartConfiguration<T>`	`setLabelX(String label)` Sets the label x.
`ChartConfiguration<T>`	`setLabelY(String label)` Sets the label y.
`ChartConfiguration<T>`	`setLegend(Legend legend)` Sets the legend.
`ChartConfiguration<T>`	`setSeries(Collection<Serie> series)` Sets the series.
`ChartConfiguration<T>`	`setSeriesColors(Collection<String> seriesColor)` Sets the series colors.
`ChartConfiguration<T>`	`setSeriesDefaults(SeriesDefaults seriesDefaults)` Sets the series defaults.
`ChartConfiguration<T>`	`setShowMarker(Boolean showMarker)` Sets the show marker.
`ChartConfiguration<T>`	`setSimpleTitle(String title)` Sets the simple title.
`ChartConfiguration<T>`	`setStackSeries(Boolean stackSeries)` Sets the stack series.
`ChartConfiguration<T>`	`setTitle(Title title)` Sets the title.
`XAxis<T>`	`xAxisInstance()`
`YAxis<T>`	`yAxisInstance()`

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

- Field Detail
  - series
```
protected Collection<Serie> series
```
    The series.
  - axes
```
protected Axes<T extends Serializable> axes
```
    The axes.
  - title
```
protected Title title
```
    The title.
  - axesDefaults
```
protected Axis<T extends Serializable> axesDefaults
```
    The axes defaults.
- Constructor Detail
  - ChartConfiguration
```
public ChartConfiguration()
```
- Method Detail
  - isCaptureRightClick
```
public Boolean isCaptureRightClick()
```
    Checks if is capture right click.
    
    Returns:
    
    the boolean
  - setCaptureRightClick
```
public ChartConfiguration<T> setCaptureRightClick(Boolean captureRightClick)
```
    Sets the capture right click.
    
    Parameters:
    
    captureRightClick - the new capture right click
    
    Returns:
    
    ChartConfiguration
  - getLegend
```
public Legend getLegend()
```
    Gets the legend.
    
    Returns:
    
    the legend
  - setLegend
```
public ChartConfiguration<T> setLegend(Legend legend)
```
    Sets the legend.
    
    Parameters:
    
    legend - the new legend
    
    Returns:
    
    ChartConfiguration
  - setSimpleTitle
```
public ChartConfiguration<T> setSimpleTitle(String title)
```
    Sets the simple title.
    
    Parameters:
    
    title - the new simple title
    
    Returns:
    
    ChartConfiguration
  - cursorInstance
```
public Cursor cursorInstance()
```
    Instantiates the cursor.
    
    Returns:
    
    the cursor
  - gridInstance
```
public Grid<T> gridInstance()
```
    Instantiates the grid.
    
    Returns:
    
    the grid
  - axesInstance
```
public Axes<T> axesInstance()
```
    Instantiates the axes.
    
    Returns:
    
    the axes
  - axesDefaultsInstance
```
public Axis<T> axesDefaultsInstance()
```
    Instantiates the axes defaults.
    
    Returns:
    
    the axis
  - xAxisInstance
```
public XAxis<T> xAxisInstance()
```
  - yAxisInstance
```
public YAxis<T> yAxisInstance()
```
  - seriesInstance
```
public Collection<Serie> seriesInstance()
```
  - seriesDefaultsInstance
```
public SeriesDefaults seriesDefaultsInstance()
```
  - seriesColorsInstance
```
public Collection<String> seriesColorsInstance()
```
  - highlighterInstance
```
public Highlighter highlighterInstance()
```
  - createCursor
```
@Deprecated
public Cursor createCursor()
```
    Deprecated. use withCursor()
    
    Creates the cursor.
    
    Returns:
    
    the cursor
  - createGrid
```
@Deprecated
public Grid<T> createGrid()
```
    Deprecated. use withGrid
    
    Creates the grid.
    
    Returns:
    
    the grid
  - createAxes
```
@Deprecated
public Axes<T> createAxes()
```
    Deprecated. use withAxes()
    
    Creates the axes.
    
    Returns:
    
    the axes
  - createXAxis
```
@Deprecated
public XAxis<T> createXAxis()
```
    Deprecated.
    
    Creates the x axis.
    
    Returns:
    
    the x axis
  - createYAxis
```
@Deprecated
public YAxis<T> createYAxis()
```
    Deprecated.
    
    Creates the y axis.
    
    Returns:
    
    the y axis
  - createAxesDefaults
```
@Deprecated
public Axis<T> createAxesDefaults()
```
    Deprecated.
    
    Creates the axes defaults.
    
    Returns:
    
    the axis
  - setLabelX
```
public ChartConfiguration<T> setLabelX(String label)
```
    Sets the label x.
    
    Parameters:
    
    label - the new label x
    
    Returns:
    
    ChartConfiguration
  - setLabelY
```
public ChartConfiguration<T> setLabelY(String label)
```
    Sets the label y.
    
    Parameters:
    
    label - the new label y
    
    Returns:
    
    ChartConfiguration
  - createSeries
```
@Deprecated
public Collection<Serie> createSeries()
```
    Deprecated.
    
    Creates the series.
    
    Returns:
    
    the collection
  - getSeries
```
public Collection<Serie> getSeries()
```
    Gets the series.
    
    Returns:
    
    the series
  - setSeries
```
public ChartConfiguration<T> setSeries(Collection<Serie> series)
```
    Sets the series.
    
    Parameters:
    
    series - the series to set
    
    Returns:
    
    ChartConfiguration
  - addSeries
```
public ChartConfiguration<T> addSeries(Serie serie)
```
    Adds the series.
    
    Parameters:
    
    serie - the serie
    
    Returns:
    
    ChartConfiguration
  - getTitle
```
public Title getTitle()
```
    Gets the title.
    
    Returns:
    
    the title
  - setTitle
```
public ChartConfiguration<T> setTitle(Title title)
```
    Sets the title.
    
    Parameters:
    
    title - the title to set
    
    Returns:
    
    ChartConfiguration
  - getAxesDefaults
```
public Axis<T> getAxesDefaults()
```
    Gets the axes defaults.
    
    Returns:
    
    the axesDefaults
  - setAxesDefaults
```
public ChartConfiguration<T> setAxesDefaults(Axis<T> axesDefaults)
```
    Sets the axes defaults.
    
    Parameters:
    
    axesDefaults - the axesDefaults to set
    
    Returns:
    
    ChartConfiguration
  - getAxes
```
public Axes<T> getAxes()
```
    Gets the axes.
    
    Returns:
    
    the axes
  - setAxes
```
public ChartConfiguration<T> setAxes(Axes<T> axes)
```
    Sets the axes.
    
    Parameters:
    
    axes - the axes to set
    
    Returns:
    
    ChartConfiguration
  - createSeriesDefaults
```
@Deprecated
public SeriesDefaults createSeriesDefaults()
```
    Deprecated.
    
    Creates the series defaults.
    
    Returns:
    
    the series defaults
  - getSeriesDefaults
```
public SeriesDefaults getSeriesDefaults()
```
    Gets the series defaults.
    
    Returns:
    
    the seriesDefaults
  - setSeriesDefaults
```
public ChartConfiguration<T> setSeriesDefaults(SeriesDefaults seriesDefaults)
```
    Sets the series defaults.
    
    Parameters:
    
    seriesDefaults - the seriesDefaults to set
    
    Returns:
    
    ChartConfiguration
  - getStackSeries
```
public Boolean getStackSeries()
```
    Gets the stack series.
    
    Returns:
    
    the stackSeries
  - setStackSeries
```
public ChartConfiguration<T> setStackSeries(Boolean stackSeries)
```
    Sets the stack series.
    
    Parameters:
    
    stackSeries - the stackSeries to set
    
    Returns:
    
    ChartConfiguration
  - getShowMarker
```
public Boolean getShowMarker()
```
    Gets the show marker.
    
    Returns:
    
    the showMarker
  - setShowMarker
```
public ChartConfiguration<T> setShowMarker(Boolean showMarker)
```
    Sets the show marker.
    
    Parameters:
    
    showMarker - the showMarker to set
    
    Returns:
    
    ChartConfiguration
  - createSeriesColors
```
@Deprecated
public Collection<String> createSeriesColors()
```
    Deprecated.
    
    Creates the series colors.
    
    Returns:
    
    the collection
  - getSeriesColors
```
public Collection<String> getSeriesColors()
```
    Gets the series colors.
    
    Returns:
    
    the series colors
  - setSeriesColors
```
public ChartConfiguration<T> setSeriesColors(Collection<String> seriesColor)
```
    Sets the series colors.
    
    Parameters:
    
    seriesColor - the new series colors
    
    Returns:
    
    ChartConfiguration
  - getAnimate
```
public Boolean getAnimate()
```
    Gets the animate.
    
    Returns:
    
    animate property
  - setAnimate
```
public ChartConfiguration<T> setAnimate(Boolean animate)
```
    Turns on animation for all series in this plot.
    
    Parameters:
    
    animate - true, false
    
    Returns:
    
    ChartConfiguration
  - createHighlighter
```
@Deprecated
public Highlighter createHighlighter()
```
    Deprecated.
    
    Creates the highlighter.
    
    Returns:
    
    the highlighter
  - getHighlighter
```
public Highlighter getHighlighter()
```
    Gets the highlighter.
    
    Returns:
    
    hightLighter
  - setHighlighter
```
public ChartConfiguration<T> setHighlighter(Highlighter highlighter)
```
    set the highlighter.
    
    Parameters:
    
    highlighter - property
    
    Returns:
    
    ChartConfiguration
  - getGrid
```
public Grid<T> getGrid()
```
    Gets the grid.
    
    Returns:
    
    the grid
  - setGrid
```
public ChartConfiguration<T> setGrid(Grid<T> grid)
```
    Sets the grid.
    
    Parameters:
    
    grid - the new grid
    
    Returns:
    
    ChartConfiguration
  - getCursor
```
public Cursor getCursor()
```
    Gets the cursor.
    
    Returns:
    
    the cursor
  - setCursor
```
public ChartConfiguration<T> setCursor(Cursor cursor)
```
    Sets the cursor.
    
    Parameters:
    
    cursor - the new cursor
    
    Returns:
    
    ChartConfiguration
  - getGridPadding
```
public GridPadding getGridPadding()
```
    Gets gridPadding
    
    Returns:
    
    GridPadding
  - setGridPadding
```
public ChartConfiguration<T> setGridPadding(GridPadding gridPadding)
```
    Sets the gridPadding
    
    Parameters:
    
    gridPadding - the new gridPadding
    
    Returns:
    
    ChartConfiguration
  - gridPaddingInstance
```
public GridPadding gridPaddingInstance()
```
    Get instance of GridPadding
    
    Returns:
    
    GridPadding
  - canvasOverlayInstance
```
public CanvasOverlay canvasOverlayInstance()
```
    Instantiates the canvas overlay.
    
    Returns:
    
    the canvas overlay
  - getCanvasOverlay
```
public CanvasOverlay getCanvasOverlay()
```
    Gets the canvas overlay.
    
    Returns:
    
    the canvas overlay
  - setCanvasOverlay
```
public ChartConfiguration<T> setCanvasOverlay(CanvasOverlay canvasOverlay)
```
    Sets the canvas overlay.
    
    Parameters:
    
    canvasOverlay - the canvasOverlay to set
    
    Returns:
    
    ChartConfiguration

Class ChartConfiguration<T extends Serializable>

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

series

axes

title

axesDefaults

Constructor Detail

ChartConfiguration

Method Detail

isCaptureRightClick

setCaptureRightClick

getLegend

setLegend

setSimpleTitle

cursorInstance

gridInstance

axesInstance

axesDefaultsInstance

xAxisInstance

yAxisInstance

seriesInstance

seriesDefaultsInstance

seriesColorsInstance

highlighterInstance

createCursor

createGrid

createAxes

createXAxis

createYAxis

createAxesDefaults

setLabelX

setLabelY

createSeries

getSeries

setSeries

addSeries

getTitle

setTitle

getAxesDefaults

setAxesDefaults

getAxes

setAxes

createSeriesDefaults

getSeriesDefaults

setSeriesDefaults

getStackSeries

setStackSeries

getShowMarker

setShowMarker

createSeriesColors

getSeriesColors

setSeriesColors

getAnimate

setAnimate

createHighlighter

getHighlighter

setHighlighter

getGrid

setGrid

getCursor

setCursor

getGridPadding

setGridPadding

gridPaddingInstance

canvasOverlayInstance

getCanvasOverlay

setCanvasOverlay