com.jwebmp.plugins.jqplot.options.JQPlotHighlightOptions 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
* To use this plugin, include the js file in your source:
*
*
* A tooltip providing information about the data point is enabled by default. To disable the tooltip, set “showTooltip” to false.
*
* You can control what data is displayed in the tooltip with various options. The “tooltipAxes” option controls whether the x, y or both data values are displayed.
*
* Some chart types (e.g. hi-low-close) have more than one y value per data point. To display the additional values in the tooltip, set the “yvalues” option to the desired number
* of y values present
* (3 for a hlc chart).
*
* By default, data values will be formatted with the same formatting specifiers as used to format the axis ticks. A custom format code can be supplied with the tooltipFormatString
* option. This will
* apply to all values in the tooltip.
*
* For more complete control, the “formatString” option can be set. This Allows conplete control over tooltip formatting. Values are passed to the format string in an order
* determined by the
* “tooltipAxes” and “yvalues” options. So, if you have a hi-low-close chart and you just want to display the hi-low-close values in the tooltip, you could set a formatString
* like:
*
* @param
*
* @author mmagon
*/
public class JQPlotHighlightOptions>
extends JavaScriptPart
implements JQPlotRendererDefault
{
/**
* true to show the highlight.
*/
private Boolean show;
/**
* Renderer used to draw the marker of the highlighted point.
*/
private String markerRenderer;
@JsonProperty("markerRenderer")
private O markerRendererOptions;
/**
* true to show the marker
*/
private Boolean showMarker = false;
/**
* Pixels to add to the lineWidth of the highlight.
*/
private Integer lineWidthAdjust;
/**
* Pixels to add to the overall size of the highlight.
*/
private Integer sizeAdjust;
/**
* Show a ToolTip with data point values.
*/
private Boolean showTooltip = false;
/**
* Where to position tooltip, ‘n’, ‘ne’, ‘e’, ‘se’, ‘s’, ‘sw’, ‘w’, ‘nw’
*/
private CompassPoints tooltipLocation;
/**
* true = fade in/out tooltip, false = show/hide tooltip
*/
private Boolean fadeTooltip;
/**
* number of milliseconds.
*/
private Integer tooltipFadeSpeed;
/**
* Pixel offset of tooltip from the highlight.
*/
private Integer tooltipOffset;
/**
* Which axes to display in tooltip, ‘x’, ‘y’ or ‘both’, ‘xy’ or ‘yx’ ‘both’ and ‘xy’ are equivalent, ‘yx’ reverses order of labels.
*/
private String tooltipAxes;
/**
* Use the x and y axes formatters to format the text in the tooltip.
*/
private Boolean useAxesFormatters;
/**
* sprintf format string for the tooltip.
*/
private String tooltipFormatString;
/**
* alternative to tooltipFormatString will format the whole tooltip text, populating with x, y values as indicated by tooltipAxes option.
*/
private String formatString;
/**
* Number of y values to expect in the data point array.
*/
private Integer yvalues;
/**
* This option requires jQuery 1.4+ True to bring the series of the highlighted point to the front of other series.
*/
private Boolean bringSeriesToFront;
@JsonIgnore
private JQPlotGraph linkedGraph;
/**
* Constructs a new highlight options class with the given graph
*
* @param linkedGraph
*/
public JQPlotHighlightOptions(JQPlotGraph linkedGraph)
{
this.linkedGraph = linkedGraph;
}
/**
* true to show the highlight.
*
*
* @return Current value
*/
public Boolean isShow()
{
return show;
}
/**
* Renderer used to draw the marker of the highlighted point.
*
*
* @return The renderer used
*/
public String getMarkerRenderer()
{
return markerRenderer;
}
/**
* true to show the marker
*
*
* @return Current Value
*/
public Boolean isShowMarker()
{
return showMarker;
}
/**
* Pixels to add to the lineWidth of the highlight.
*
*
* @return The pixels adjustment
*/
public Integer getLineWidthAdjust()
{
return lineWidthAdjust;
}
/**
* Pixels to add to the lineWidth of the highlight.
*
*
* @param lineWidthAdjust
* The line adjustment width
*/
@SuppressWarnings("unchecked")
@NotNull
public J setLineWidthAdjust(Integer lineWidthAdjust)
{
this.lineWidthAdjust = lineWidthAdjust;
return (J) this;
}
/**
* Pixels to add to the overall size of the highlight.
*
*
* @return The Size Adjustment
*/
public Integer getSizeAdjust()
{
return sizeAdjust;
}
/**
* Pixels to add to the overall size of the highlight.
*
*
* @param sizeAdjust
* The size to adjust by
*/
@SuppressWarnings("unchecked")
@NotNull
public J setSizeAdjust(Integer sizeAdjust)
{
this.sizeAdjust = sizeAdjust;
return (J) this;
}
/**
* Show a tooltip with data point values
*
*
* @return
*/
public Boolean isShowTooltip()
{
return showTooltip;
}
/**
* Where to position tooltip, ‘n’, ‘ne’, ‘e’, ‘se’, ‘s’, ‘sw’, ‘w’, ‘nw’
*
*
* @return Position
*/
public CompassPoints getTooltipLocation()
{
return tooltipLocation;
}
/**
* Where to position tooltip, ‘n’, ‘ne’, ‘e’, ‘se’, ‘s’, ‘sw’, ‘w’, ‘nw’
*
*
* @param tooltipLocation
* The location
*/
@SuppressWarnings("unchecked")
@NotNull
public J setTooltipLocation(CompassPoints tooltipLocation)
{
this.tooltipLocation = tooltipLocation;
return (J) this;
}
/**
* true = fade in/out tooltip, false = show/hide tooltip
*
*
* @return Fading
*/
public Boolean isFadeTooltip()
{
return fadeTooltip;
}
/**
* number of milliseconds
*
*
* @return Number of milliseconds
*/
public Integer getTooltipFadeSpeed()
{
return tooltipFadeSpeed;
}
/**
* number of milliseconds
*
*
* @param tooltipFadeSpeed
* The fading speed in milliseconds
*/
@SuppressWarnings("unchecked")
@NotNull
public J setTooltipFadeSpeed(Integer tooltipFadeSpeed)
{
this.tooltipFadeSpeed = tooltipFadeSpeed;
return (J) this;
}
/**
* Pixel offset of tooltip from the highlight.
*
*
* @return The offset from the highlight
*/
public Integer getTooltipOffset()
{
return tooltipOffset;
}
/**
* Pixel offset of tooltip from the highlight.
*
*
* @param tooltipOffset
* The offest
*/
@SuppressWarnings("unchecked")
@NotNull
public J setTooltipOffset(Integer tooltipOffset)
{
this.tooltipOffset = tooltipOffset;
return (J) this;
}
/**
* Which axes to display in tooltip, ‘x’, ‘y’ or ‘both’, ‘xy’ or ‘yx’ ‘both’ and ‘xy’ are equivalent, ‘yx’ reverses order of labels.
*
*
* @return The Axes to use
*/
public String getTooltipAxes()
{
return tooltipAxes;
}
/**
* Which axes to display in tooltip, ‘x’, ‘y’ or ‘both’, ‘xy’ or ‘yx’ ‘both’ and ‘xy’ are equivalent, ‘yx’ reverses order of labels.
*
*
* @param tooltipAxes
*/
@SuppressWarnings("unchecked")
@NotNull
public J setTooltipAxes(String tooltipAxes)
{
this.tooltipAxes = tooltipAxes;
return (J) this;
}
/**
* Use the x and y axes formatters to format the text in the tooltip
*
*
* @return The text in the formatters
*/
public Boolean isUseAxesFormatters()
{
return useAxesFormatters;
}
/**
* sprintf format string for the tooltip.
*
*
* @return The tooltip format string
*/
public String getTooltipFormatString()
{
return tooltipFormatString;
}
/**
* sprintf format string for the tooltip.
*
*
* @param tooltipFormatString
* The sprintf format for the tooltip
*/
@SuppressWarnings("unchecked")
@NotNull
public J setTooltipFormatString(String tooltipFormatString)
{
this.tooltipFormatString = tooltipFormatString;
return (J) this;
}
/**
* Alternative to tooltipFormatString will format the whole tooltip text, populating with x, y values as indicated by tooltipAxes option.
*
*
* @return
*/
public String getFormatString()
{
return formatString;
}
/**
* Alternative to tooltipFormatString will format the whole tooltip text, populating with x, y values as indicated by tooltipAxes option.
*
*
* @param formatString
* The HTML to use as a tooltip
*/
@SuppressWarnings("unchecked")
@NotNull
public J setFormatString(String formatString)
{
this.formatString = formatString;
return (J) this;
}
/**
* Alternative to tooltipFormatString will format the whole tooltip text, populating with x, y values as indicated by tooltipAxes option.
*
*
* @param formatString
* The HTML to use as a tooltip
*/
@SuppressWarnings("unchecked")
@NotNull
public J setFormatString(Div formatString)
{
this.formatString = formatString.toString(true);
return (J) this;
}
/**
* Number of y values to expect in the data point array.
*
*
* @return
*/
public Integer getYvalues()
{
return yvalues;
}
/**
* Number of y values to expect in the data point array.
*
*
* @param yvalues
*/
@SuppressWarnings("unchecked")
@NotNull
public J setYvalues(Integer yvalues)
{
this.yvalues = yvalues;
return (J) this;
}
/**
* True to bring the series of the highlighted point to the front of other series.
*
*
* @return
*/
public Boolean isBringSeriesToFront()
{
return bringSeriesToFront;
}
/**
* true to show the highlight.
*
* @return
*/
public Boolean getShow()
{
return show;
}
/**
* True to show the highlight
*
*
* @param show
*/
@SuppressWarnings("unchecked")
@NotNull
public J setShow(Boolean show)
{
this.show = show;
return (J) this;
}
/**
* Return the marker rendering options with the highlighter
*
* @return
*/
public O getMarkerRendererOptions()
{
if (markerRendererOptions == null)
{
markerRendererOptions = (O) new JQPlotMarkerOptions(getLinkedGraph());
markerRenderer = markerRendererOptions.getMarkerRenderer();
}
return markerRendererOptions;
}
/**
* Sets the marker renderer accordingly
*
*/
@SuppressWarnings("unchecked")
@NotNull
public J setMarkerRendererOptions(O markerRendererOptions)
{
markerRenderer = markerRendererOptions.getMarkerRenderer();
this.markerRendererOptions = markerRendererOptions;
return (J) this;
}
/**
* Returns the linked graph with this object
*
* @return
*/
public JQPlotGraph getLinkedGraph()
{
return linkedGraph;
}
/**
* Whether or not to show the marker
*
* @return
*/
public Boolean getShowMarker()
{
return showMarker;
}
/**
* true to show the marker
*
*
* @param showMarker
* Show Marker Boolean
*/
@SuppressWarnings("unchecked")
@NotNull
public J setShowMarker(Boolean showMarker)
{
this.showMarker = showMarker;
return (J) this;
}
/**
* Whether or not to show the tooltip
*
* @return
*/
public Boolean getShowTooltip()
{
return showTooltip;
}
/**
* Show a tooltip with data point values.
*
*
* @param showTooltip
* To show the tooltip
*/
@SuppressWarnings("unchecked")
@NotNull
public J setShowTooltip(Boolean showTooltip)
{
this.showTooltip = showTooltip;
return (J) this;
}
/**
* whether or not to fade the tooltip
*
* @return
*/
public Boolean getFadeTooltip()
{
return fadeTooltip;
}
/**
* true = fade in/out tooltip, false = show/hide tooltip
*
*
* @param fadeTooltip
* True or False
*/
@SuppressWarnings("unchecked")
@NotNull
public J setFadeTooltip(Boolean fadeTooltip)
{
this.fadeTooltip = fadeTooltip;
return (J) this;
}
/**
* Use axes formatters for display or not
*
* @return
*/
public Boolean getUseAxesFormatters()
{
return useAxesFormatters;
}
/**
* Use the x and y axes formatters to format the text in the tooltip
*
*
* @param useAxesFormatters
* True or False
*/
@SuppressWarnings("unchecked")
@NotNull
public J setUseAxesFormatters(Boolean useAxesFormatters)
{
this.useAxesFormatters = useAxesFormatters;
return (J) this;
}
/**
* Always have the series in front
*
* @return
*/
public Boolean getBringSeriesToFront()
{
return bringSeriesToFront;
}
/**
* True to bring the series of the highlighted point to the front of other series.
*
*
* @param bringSeriesToFront
*/
@SuppressWarnings("unchecked")
@NotNull
public J setBringSeriesToFront(Boolean bringSeriesToFront)
{
this.bringSeriesToFront = bringSeriesToFront;
return (J) this;
}
@Override
public String getRenderer()
{
return "$.jqplot.Highlighter";
}
}