com.jwebmp.plugins.jqplot.options.JQPlotOptions Maven / Gradle / Ivy
/*
* Copyright (C) 2017 Marc Magon
*
* This program is free software: you can redistribute it and/or modify
* it under the terms of the GNU General Public License as published by
* the Free Software Foundation, either version 3 of the License, or
* (at your option) any later version.
*
* This program is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
* GNU General Public License for more details.
*
* You should have received a copy of the GNU General Public License
* along with this program. If not, see >
extends JavaScriptPart
{
/**
* Version 1
*/
@JsonIgnore
private JQPlotGraph linkedGraph;
/**
* True to animate the series on initial plot draw (renderer dependent).
*/
@JsonIgnore
private Boolean animate;
/**
* True to animate series after a call to the replot() method. Replots can happen very frequently under certain circumstances (e.g. resizing, dragging points) and animation in
* these situations can
* cause problems.
*/
private Boolean animateReplot;
/**
* false to not sort the data passed in by the user.
*/
private Boolean sortData;
/**
* true or false, creates a stack or “mountain” plot.
*/
private Boolean stackSeries;
/**
* if true, right-click events are intercepted and a jqplotRightClick event will be fired. This will also block the context menu.
*/
private Boolean captureRightClick;
/**
* The Highlighter Plugin Options
*/
private JQPlotHighlightOptions highlighter;
/**
* The title options available
*/
private JQPlotTitleOptions title;
/**
* The cursor options available
*/
private JQPlotCursorOptions cursor;
/**
* A grouping of colours
*/
private List seriesColours;
/**
* A grouping of colours
*/
private List negativeSeriesColours;
/**
* The default options for all series
*/
private JQPlotSeriesOptions seriesDefaults;
/**
* Each series configuration in order of display
*/
private List series;
/**
* An array of all the axis available. Can be up to 9. Example [x,y,z] or [x,y1,x2,y2,y3,y4,y5,y6]
*/
private JQPlotAxes axes;
/**
* The default legendOptions
*/
@JsonProperty("legend")
private JQPlotLegendOptions legendOptions;
/**
* The grid canvas options
*/
private JQPlotGridOptionsCanvasGrid gridOptions;
/**
* The default axis configuration
*/
private JQPlotAxisOptions axesDefaults;
/**
* The graph options available. This is the complete set
*
*
* @param linkedGraph
* A linked graph if required
*/
public JQPlotOptions(JQPlotGraph linkedGraph)
{
this.linkedGraph = linkedGraph;
}
/**
* Gets the Title Part for this Graph
*
*
* @return The Graph Title Part
*/
public JQPlotTitleOptions getTitle()
{
if (title == null)
{
title = new JQPlotTitleOptions("", linkedGraph);
}
return title;
}
/**
* Sets the Graph Title Part for this Graph
*
*
* @param title
* The title object to set
*/
@SuppressWarnings("unchecked")
@NotNull
public J setTitle(JQPlotTitleOptions title)
{
this.title = title;
return (J) this;
}
/**
* Gets the Highlighter associated with this graph
*
*
* @return
*/
public JQPlotHighlightOptions getHighlighter()
{
if (highlighter == null)
{
highlighter = new JQPlotHighlightOptions(linkedGraph);
}
return highlighter;
}
/**
* Sets the Highlighter for this graph
*
*
* @param highlighter
* The highlighting to use
*/
@SuppressWarnings("unchecked")
@NotNull
public J setHighlighter(JQPlotHighlightOptions highlighter)
{
this.highlighter = highlighter;
return (J) this;
}
/**
* Get the cursor option associated with this graph
*
*
* @return
*/
public JQPlotCursorOptions getCursor()
{
if (cursor == null)
{
cursor = new JQPlotCursorOptions(linkedGraph);
}
return cursor;
}
/**
* Sets the Cursor options associated with this graph
*
*
* @param cursor
*/
@SuppressWarnings("unchecked")
@NotNull
public J setCursor(JQPlotCursorOptions cursor)
{
this.cursor = cursor;
return (J) this;
}
/**
* Returns the series Colours that are associated with this Graph
*
*
* @return
*/
public List getSeriesColours()
{
if (seriesColours == null)
{
seriesColours = new ArrayList<>();
}
return seriesColours;
}
/**
* Set the series Colours to be used for this graph
*
*
* @param seriesColours
*/
@SuppressWarnings("unchecked")
@NotNull
public J setSeriesColours(List seriesColours)
{
this.seriesColours = seriesColours;
return (J) this;
}
/**
* Returns the series Colours that are associated with this Graph when negative
*
*
* @return
*/
public List getNegativeSeriesColours()
{
if (negativeSeriesColours == null)
{
negativeSeriesColours = new ArrayList<>();
}
return negativeSeriesColours;
}
/**
* Set the series Colours to be used for this graph when negative
*
*
* @param negativeSeriesColours
*/
@SuppressWarnings("unchecked")
@NotNull
public J setNegativeSeriesColours(List negativeSeriesColours)
{
this.negativeSeriesColours = negativeSeriesColours;
return (J) this;
}
/**
* Returns the current allocated series defaults
*
*
* @return Null if not applied or is Line Graph
*/
public JQPlotSeriesOptions getSeriesDefaults()
{
if (seriesDefaults == null)
{
seriesDefaults = new JQPlotSeriesOptions(linkedGraph);
}
return seriesDefaults;
}
/**
* Sets the current allocated Series Defaults.
*
*
* @param seriesDefaults
*/
@SuppressWarnings("unchecked")
@NotNull
public J setSeriesDefaults(JQPlotSeriesOptions seriesDefaults)
{
this.seriesDefaults = seriesDefaults;
return (J) this;
}
/**
* Gets the array list of each series different options in order of addition
*
*
* @return
*/
public List getSeries()
{
if (series == null)
{
series = new ArrayList<>();
}
return series;
}
/**
* Sets the series configuration
*
*
* @param series
*/
@SuppressWarnings("unchecked")
@NotNull
public J setSeries(List series)
{
this.series = series;
return (J) this;
}
/**
* Gets the Axes Defaults
*
*
* @return
*/
public JQPlotAxisOptions getAxesDefaults()
{
if (axesDefaults == null)
{
axesDefaults = new JQPlotAxisOptions(getLinkedGraph());
}
return axesDefaults;
}
/**
* Sets the Axes Defaults
*
*
* @param axesDefaults
*/
@SuppressWarnings("unchecked")
@NotNull
public J setAxesDefaults(JQPlotAxisOptions axesDefaults)
{
this.axesDefaults = axesDefaults;
return (J) this;
}
/**
* Gets the linked graph
*
* @return
*/
public JQPlotGraph getLinkedGraph()
{
return linkedGraph;
}
/**
* Sets the linked graph
*
* @param linkedGraph
*/
@SuppressWarnings("unchecked")
@NotNull
public J setLinkedGraph(JQPlotGraph linkedGraph)
{
this.linkedGraph = linkedGraph;
return (J) this;
}
/**
* Returns the legendOptions options
*
*
* @return
*/
public JQPlotLegendOptions getLegendOptions()
{
if (legendOptions == null)
{
legendOptions = new JQPlotLegendOptions(getLinkedGraph());
}
return legendOptions;
}
/**
* Sets the legendOptions options
*
*
* @param legendOptions
*/
@SuppressWarnings("unchecked")
@NotNull
public J setLegendOptions(JQPlotLegendOptions legendOptions)
{
this.legendOptions = legendOptions;
return (J) this;
}
/**
* Gets the grid options
*
*
* @return
*/
public JQPlotGridOptionsCanvasGrid getGridOptions()
{
if (gridOptions == null)
{
gridOptions = new JQPlotGridOptionsCanvasGrid(getLinkedGraph());
}
return gridOptions;
}
/**
* Sets the grid options
*
*
* @param gridOptions
*/
@SuppressWarnings("unchecked")
@NotNull
public J setGridOptions(JQPlotGridOptionsCanvasGrid gridOptions)
{
this.gridOptions = gridOptions;
return (J) this;
}
@JsonProperty(value = "animate")
@JsonRawValue
/**
* True to animate the series on initial plot draw (renderer dependent).
*
* @return
*/ public String getAnimate()
{
if (animate == null)
{
return null;
}
if (animate)
{
return "!$.jqplot.use_excanvas";
}
else
{
return "false";
}
}
/**
* True to animate the series on initial plot draw (renderer dependent).
*
*
* @param animate
*/
@SuppressWarnings("unchecked")
@NotNull
public J setAnimate(Boolean animate)
{
this.animate = animate;
return (J) this;
}
/**
* True to animate series after a call to the replot() method. Replots can happen very frequently under certain circumstances (e.g. resizing, dragging points) and animation in
* these situations can
* cause problems.
*
*
* @return
*/
public Boolean getAnimateReplot()
{
return animateReplot;
}
/**
* True to animate series after a call to the replot() method. Replots can happen very frequently under certain circumstances (e.g. resizing, dragging points) and animation in
* these situations can
* cause problems.
*
*
* @param animateReplot
*/
@SuppressWarnings("unchecked")
@NotNull
public J setAnimateReplot(Boolean animateReplot)
{
this.animateReplot = animateReplot;
return (J) this;
}
/**
* false to not sort the data passed in by the user.
*
*
* @return
*/
public Boolean getSortData()
{
return sortData;
}
/**
* false to not sort the data passed in by the user.
*
*
* @param sortData
*/
@SuppressWarnings("unchecked")
@NotNull
public J setSortData(Boolean sortData)
{
this.sortData = sortData;
return (J) this;
}
/**
* true or false, creates a stack or “mountain” plot.
*
*
* @return
*/
public Boolean getStackSeries()
{
return stackSeries;
}
/**
* true or false, creates a stack or “mountain” plot.
*
*
* @param stackSeries
*/
@SuppressWarnings("unchecked")
@NotNull
public J setStackSeries(Boolean stackSeries)
{
this.stackSeries = stackSeries;
return (J) this;
}
/**
* if true, right-click events are intercepted and a jqplotRightClick event will be fired. This will also block the context menu.
*
*
* @return
*/
public Boolean getCaptureRightClick()
{
return captureRightClick;
}
/**
* if true, right-click events are intercepted and a jqplotRightClick event will be fired. This will also block the context menu.
*
*
* @param captureRightClick
*/
@SuppressWarnings("unchecked")
@NotNull
public J setCaptureRightClick(Boolean captureRightClick)
{
this.captureRightClick = captureRightClick;
return (J) this;
}
/**
* An array of all the axis available. Can be up to 9. Example [x,y,z] or [x,y1,x2,y2,y3,y4,y5,y6]
*
*
* @return A map in order for the options render
*/
public JQPlotAxes getAxes()
{
if (axes == null)
{
axes = new JQPlotAxes(linkedGraph);
}
return axes;
}
/**
* Sets the map in order
*
*
* @param axes
*/
@SuppressWarnings("unchecked")
@NotNull
public J setAxes(JQPlotAxes axes)
{
this.axes = axes;
return (J) this;
}
}