com.jwebmp.plugins.jqplot.options.JQPlotCursorOptions 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
implements JQPlotRendererDefault
{
/**
* CSS spec for cursor style
*/
private Cursors style;
/**
* Whether to show the cursor or not.
*/
private Boolean show;
/**
* Show tooltip or not
*/
private Boolean showTooltip;
/**
* Tooltip follows the mouse, it is not at a fixed location.
*/
private Boolean followMouse;
/**
* Where to position tooltip.
*/
private String tooltipLocation;
/**
* Pixel offset of tooltip from the grid boudaries or cursor center.
*/
private Integer tooltipOffset;
/**
* show the grid pixel coordinates of the mouse.
*/
private Boolean showTooltipGridPosition;
/**
* show the unit (data) coordinates of the mouse.
*/
private Boolean showTooltipUnitPosition;
/**
* Used with showVerticalLine to show intersecting data points in the tooltip.
*/
private Boolean showTooltipDataPosition;
/**
* sprintf format string for the tooltip.
*/
private String tooltipFormatString;
/**
* Use the x and y axes formatters to format the text in the tooltip.
*/
private Boolean useAxesFormatters;
/**
* Show position for the specified axes
* This is an array like [[‘xaxis’, ‘yaxis’], [‘xaxis’, ‘y2axis’]] Default is to compute automatically for all visible axes.
*/
private List tooltipAxisGroups;
/**
* Enable plot zooming.
*/
private Boolean zoom;
/**
* Will expand zoom range to provide more rounded tick values.
*/
private Boolean looseZoom;
/**
* Will reset plot zoom if single click on plot without drag.
*/
private Boolean clickReset;
/**
* Will reset plot zoom if double click on plot without drag.
*/
private Boolean dblClickReset;
/**
* draw a vertical line across the plot which follows the cursor.
*/
private Boolean showVerticalLine;
/**
* draw a horizontal line across the plot which follows the cursor.
*/
private Boolean showHorizontalLine;
/**
* ‘none’, ‘x’ or ‘y’
*/
private String constrainZoomTo;
/**
* pixel distance from data point or marker to consider cursor lines intersecting with point.
*/
private Integer intersectionThreshold;
/**
* Replace the plot legend with an enhanced legend displaying intersection information.
*/
private Boolean showCursorLegend;
/**
* Format string used in the cursor legend.
*/
private String cursorLegendFormatString;
/**
* True to limit actual zoom area to edges of grid, even when zooming outside of plot area.
*/
private Boolean constrainOutsideZoom;
/**
* True will keep updating the tooltip when zooming of the grid.
*/
private Boolean showTooltipOutsideZoom;
@JsonIgnore
private JQPlotGraph linkedGraph;
/**
* Constructs a new instance of the cursor object
*
* @param linkedGraph
*/
public JQPlotCursorOptions(JQPlotGraph linkedGraph)
{
this.linkedGraph = linkedGraph;
}
/**
* Gets the linked graph
*
* @return
*/
public JQPlotGraph getLinkedGraph()
{
return linkedGraph;
}
/**
* Set the linked graph and adds the reference
*
* @param linkedGraph
*/
@SuppressWarnings("unchecked")
@NotNull
public J setLinkedGraph(JQPlotGraph linkedGraph)
{
this.linkedGraph = linkedGraph;
return (J) this;
}
/**
* CSS spec for cursor style
*
* @return
*/
public Cursors getStyle()
{
return style;
}
/**
* CSS spec for cursor style
*
* @param style
*/
@SuppressWarnings("unchecked")
@NotNull
public J setStyle(Cursors style)
{
this.style = style;
return (J) this;
}
/**
* Whether to show the cursor or not.
*
* @return
*/
public Boolean isShow()
{
return show;
}
/**
* Whether to show the cursor or not.
*
* @param show
*/
@SuppressWarnings("unchecked")
@NotNull
public J setShow(Boolean show)
{
this.show = show;
return (J) this;
}
/**
* Show tooltip or not
*
* @return
*/
public Boolean isShowTooltip()
{
return showTooltip;
}
/**
* Show tooltip or not
*
* @param showTooltip
*/
@SuppressWarnings("unchecked")
@NotNull
public J setShowTooltip(Boolean showTooltip)
{
this.showTooltip = showTooltip;
return (J) this;
}
/**
* Tooltip follows the mouse, it is not at a fixed location.
*
* @return
*/
public Boolean isFollowMouse()
{
return followMouse;
}
/**
* Tooltip follows the mouse, it is not at a fixed location.
*
* @param followMouse
*/
@SuppressWarnings("unchecked")
@NotNull
public J setFollowMouse(Boolean followMouse)
{
this.followMouse = followMouse;
return (J) this;
}
/**
* Where to position tooltip. 'n' etc
*
* @return
*/
public String getTooltipLocation()
{
return tooltipLocation;
}
/**
* Where to position tooltip.
*
* @param tooltipLocation
*/
@SuppressWarnings("unchecked")
@NotNull
public J setTooltipLocation(String tooltipLocation)
{
this.tooltipLocation = tooltipLocation;
return (J) this;
}
/**
* Pixel offset of tooltip from the grid boundaries or cursor center.
*
*
* @return
*/
public Integer getTooltipOffset()
{
return tooltipOffset;
}
/**
* Pixel offset of tooltip from the grid boundaries or cursor center.
*
*
* @param tooltipOffset
*/
@SuppressWarnings("unchecked")
@NotNull
public J setTooltipOffset(Integer tooltipOffset)
{
this.tooltipOffset = tooltipOffset;
return (J) this;
}
/**
* show the grid pixel coordinates of the mouse.
*
*
* @return
*/
public Boolean isShowTooltipGridPosition()
{
return showTooltipGridPosition;
}
/**
* show the grid pixel coordinates of the mouse.
*
*
* @param showTooltipGridPosition
*/
@SuppressWarnings("unchecked")
@NotNull
public J setShowTooltipGridPosition(Boolean showTooltipGridPosition)
{
this.showTooltipGridPosition = showTooltipGridPosition;
return (J) this;
}
/**
* show the unit (data) coordinates of the mouse.
*
*
* @return
*/
public Boolean isShowTooltipUnitPosition()
{
return showTooltipUnitPosition;
}
/**
* show the unit (data) coordinates of the mouse.
*
*
* @param showTooltipUnitPosition
*/
@SuppressWarnings("unchecked")
@NotNull
public J setShowTooltipUnitPosition(Boolean showTooltipUnitPosition)
{
this.showTooltipUnitPosition = showTooltipUnitPosition;
return (J) this;
}
/**
* Used with showVerticalLine to show intersecting data points in the tooltip.
*
*
* @return
*/
public Boolean isShowTooltipDataPosition()
{
return showTooltipDataPosition;
}
/**
* Used with showVerticalLine to show intersecting data points in the tooltip.
*
*
* @param showTooltipDataPosition
*/
@SuppressWarnings("unchecked")
@NotNull
public J setShowTooltipDataPosition(Boolean showTooltipDataPosition)
{
this.showTooltipDataPosition = showTooltipDataPosition;
return (J) this;
}
/**
* sprintf format string for the tooltip.
*
*
* @return
*/
public String getTooltipFormatString()
{
return tooltipFormatString;
}
/**
* sprintf format string for the tooltip.
*
*
* @param tooltipFormatString
*/
@SuppressWarnings("unchecked")
@NotNull
public J setTooltipFormatString(String tooltipFormatString)
{
this.tooltipFormatString = tooltipFormatString;
return (J) this;
}
/**
* Use the x and y axes formatters to format the text in the tooltip.
*
*
* @return
*/
public Boolean getUseAxesFormatters()
{
return useAxesFormatters;
}
/**
* Use the x and y axes formatters to format the text in the tooltip.
*
*
* @param useAxesFormatters
*/
@SuppressWarnings("unchecked")
@NotNull
public J setUseAxesFormatters(Boolean useAxesFormatters)
{
this.useAxesFormatters = useAxesFormatters;
return (J) this;
}
/**
* Enable plot zooming.
*
*
* @return
*/
public Boolean isZoom()
{
return zoom;
}
/**
* Enable plot zooming.
*
*
* @param zoom
*/
@SuppressWarnings("unchecked")
@NotNull
public J setZoom(Boolean zoom)
{
this.zoom = zoom;
return (J) this;
}
/**
* Will expand zoom range to provide more rounded tick values.
*
*
* @return
*/
public Boolean isLooseZoom()
{
return looseZoom;
}
/**
* Will expand zoom range to provide more rounded tick values.
*
*
* @param looseZoom
*/
@SuppressWarnings("unchecked")
@NotNull
public J setLooseZoom(Boolean looseZoom)
{
this.looseZoom = looseZoom;
return (J) this;
}
/**
* Will reset plot zoom if single click on plot without drag.
*
*
* @return
*/
public Boolean isClickReset()
{
return clickReset;
}
/**
* Will reset plot zoom if single click on plot without drag.
*
*
* @param clickReset
*/
@SuppressWarnings("unchecked")
@NotNull
public J setClickReset(Boolean clickReset)
{
this.clickReset = clickReset;
return (J) this;
}
/**
* Will reset plot zoom if double click on plot without drag.
*
*
* @return
*/
public Boolean isDblClickReset()
{
return dblClickReset;
}
/**
* Will reset plot zoom if double click on plot without drag.
*
*
* @param dblClickReset
*/
@SuppressWarnings("unchecked")
@NotNull
public J setDblClickReset(Boolean dblClickReset)
{
this.dblClickReset = dblClickReset;
return (J) this;
}
/**
* draw a vertical line across the plot which follows the cursor.
*
*
* @return
*/
public Boolean isShowVerticalLine()
{
return showVerticalLine;
}
/**
* draw a vertical line across the plot which follows the cursor.
*
*
* @param showVerticalLine
*/
@SuppressWarnings("unchecked")
@NotNull
public J setShowVerticalLine(Boolean showVerticalLine)
{
this.showVerticalLine = showVerticalLine;
return (J) this;
}
/**
* draw a horizontal line across the plot which follows the cursor.
*
*
* @return
*/
public Boolean isShowHorizontalLine()
{
return showHorizontalLine;
}
/**
* draw a horizontal line across the plot which follows the cursor.
*
*
* @param showHorizontalLine
*/
@SuppressWarnings("unchecked")
@NotNull
public J setShowHorizontalLine(Boolean showHorizontalLine)
{
this.showHorizontalLine = showHorizontalLine;
return (J) this;
}
/**
* ‘none’, ‘x’ or ‘y’
*
*
* @return
*/
public String getConstrainZoomTo()
{
return constrainZoomTo;
}
/**
* ‘none’, ‘x’ or ‘y’
*
*
* @param constrainZoomTo
*/
@SuppressWarnings("unchecked")
@NotNull
public J setConstrainZoomTo(String constrainZoomTo)
{
this.constrainZoomTo = constrainZoomTo;
return (J) this;
}
/**
* pixel distance from data point or marker to consider cursor lines intersecting with point.
*
*
* @return
*/
public Integer getIntersectionThreshold()
{
return intersectionThreshold;
}
/**
* pixel distance from data point or marker to consider cursor lines intersecting with point.
*
*
* @param intersectionThreshold
*/
@SuppressWarnings("unchecked")
@NotNull
public J setIntersectionThreshold(Integer intersectionThreshold)
{
this.intersectionThreshold = intersectionThreshold;
return (J) this;
}
/**
* Replace the plot legend with an enhanced legend displaying intersection information.
*
*
* @return
*/
public Boolean isShowCursorLegend()
{
return showCursorLegend;
}
/**
* Replace the plot legend with an enhanced legend displaying intersection information.
*
*
* @param showCursorLegend
*/
@SuppressWarnings("unchecked")
@NotNull
public J setShowCursorLegend(Boolean showCursorLegend)
{
this.showCursorLegend = showCursorLegend;
return (J) this;
}
/**
* Format string used in the cursor legend.
*
*
* @return
*/
public String getCursorLegendFormatString()
{
return cursorLegendFormatString;
}
/**
* Format string used in the cursor legend.
*
*
* @param cursorLegendFormatString
*/
@SuppressWarnings("unchecked")
@NotNull
public J setCursorLegendFormatString(String cursorLegendFormatString)
{
this.cursorLegendFormatString = cursorLegendFormatString;
return (J) this;
}
/**
* True to limit actual zoom area to edges of grid, even when zooming outside of plot area.
*
*
* @return
*/
public Boolean isConstrainOutsideZoom()
{
return constrainOutsideZoom;
}
/**
* True to limit actual zoom area to edges of grid, even when zooming outside of plot area.
*
*
* @param constrainOutsideZoom
*/
@SuppressWarnings("unchecked")
@NotNull
public J setConstrainOutsideZoom(Boolean constrainOutsideZoom)
{
this.constrainOutsideZoom = constrainOutsideZoom;
return (J) this;
}
/**
* True will keep updating the tooltip when zooming of the grid.
*
*
* @return
*/
public Boolean isShowTooltipOutsideZoom()
{
return showTooltipOutsideZoom;
}
/**
* True will keep updating the tooltip when zooming of the grid.
*
*
* @param showTooltipOutsideZoom
*/
@SuppressWarnings("unchecked")
@NotNull
public J setShowTooltipOutsideZoom(Boolean showTooltipOutsideZoom)
{
this.showTooltipOutsideZoom = showTooltipOutsideZoom;
return (J) this;
}
@Override
public String getRenderer()
{
return "$.jqplot.Cursor";
}
/**
* Show position for the specified axes
* This is an array like [[‘xaxis’, ‘yaxis’], [‘xaxis’, ‘y2axis’]] Default is to compute automatically for all visible axes.
*
* @return
*/
public List getTooltipAxisGroups()
{
if (tooltipAxisGroups == null)
{
tooltipAxisGroups = new ArrayList<>();
}
return tooltipAxisGroups;
}
/**
* Show position for the specified axes
* This is an array like [[‘xaxis’, ‘yaxis’], [‘xaxis’, ‘y2axis’]] Default is to compute automatically for all visible axes.
*
* @param tooltipAxisGroups
*/
@SuppressWarnings("unchecked")
@NotNull
public J setTooltipAxisGroups(List tooltipAxisGroups)
{
this.tooltipAxisGroups = tooltipAxisGroups;
return (J) this;
}
}