PlotOptions (Fujion Wrapper for HighCharts 1.0.12 API)

java.lang.Object
- org.fujion.ancillary.Options
- - org.fujion.highcharts.PlotOptions

All Implemented Interfaces:

OptionMap.IOptionMapConverter

Direct Known Subclasses:

PlotArea, PlotAreaRange, PlotBar, PlotBubble, PlotGauge, PlotLine, PlotPie, PlotScatter, PlotSolidGauge, PlotSpline
```
public abstract class PlotOptions
extends Options
```
Base class for all plot types.
The plotOptions is a wrapper object for config objects for each series type. The config objects for each series can also be overridden for each series item as given in the series array. Configuration options for the series are given in three levels. Options for all series in a chart are given in the plotOptions.series object. Then options for all series of a specific type are given in the plotOptions of that type, for example plotOptions.line. Next, options for one single series are given in the series array.

Field Summary

Fields
Modifier and Type	Field and Description
`Boolean`	`allowPointSelect` Allow this series' points to be selected by clicking on the markers, bars or pie slices.
`Boolean`	`animation` Enable or disable the initial animation when a series is displayed.
`String`	`color` The main color or the series.
`Boolean`	`colorByPoint` When using automatic point colors pulled from the options.colors collection, this option determines whether the chart should receive one color per series or one color per point.
`List<String>`	`colors` A series specific or series type specific color set to apply instead of the global colors when colorByPoint is true.
`Boolean`	`connectEnds` Polar charts only.
`Boolean`	`connectNulls` Whether to connect a graph line across null points.
`Double`	`cropThreshold` When the series contains less points than the crop threshold, all points are drawn, event if the points fall outside the visible plot area at the current zoom.
`String`	`cursor` You can set the cursor to "pointer" if you have click events attached to the series, to signal to the user that the points and lines can be clicked.
`DashStyle`	`dashStyle` A name for the dash style to use for the graph.
`DataLabelOptions`	`dataLabels` Options for data labels.
`Boolean`	`enableMouseTracking` Enable or disable the mouse tracking for a specific series.
`String`	`id` An id for the series.
`Integer`	`lineWidth` Pixel with of the graph line.
`String`	`linkedTo` The id of another series to link to.
`MarkerOptions`	`marker` Options for point markers.
`String`	`negativeColor` The color for the parts of the graph or points that are below the threshold.
`Double`	`pointInterval` If no x values are given for the points in a series, pointInterval defines the interval of the x values.
`String`	`pointPlacement` Possible values: null, "on", "between".
`Double`	`pointStart` If no x values are given for the points in a series, pointStart defines on what value to start.
`Boolean`	`selected` Whether to select the series initially.
`Object`	`shadow` Boolean value whether to apply a drop shadow to the graph line.
`Boolean`	`showCheckbox` If true, a checkbox is displayed next to the legend item to allow selecting the series.
`Boolean`	`showInLegend` Whether to display this particular series or series type in the legend.
`String`	`stacking` Whether to stack the values of each series on top of each other.
`Boolean`	`stickyTracking` Sticky tracking of mouse events.
`Double`	`threshold` The threshold, also called zero level or base level.
`TooltipOptions`	`tooltip` A configuration object for the tooltip rendering of each single series.
`Integer`	`turboThreshold` When a series contains a data array that is longer than this, only one dimensional arrays of numbers, or two dimensional arrays with x and y values are allowed.
`protected String`	`type` The text identifier of the plot type.
`Boolean`	`visible` Set the initial visibility of the series.
`Integer`	`zIndex` Define the z index of the series.

Constructor Summary

Constructors
Constructor and Description

PlotOptions()

Constructors
Constructor and Description
`PlotOptions()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type Method and Description

OptionMap toMap()
If type is not null, place options under a submap indexed by the type id.
- Methods inherited from class org.fujion.ancillary.Options
  copyTo
- Methods inherited from class java.lang.Object
  clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`OptionMap`	`toMap()` If type is not null, place options under a submap indexed by the type id.

- Field Detail
  - type
```
protected transient String type
```
    The text identifier of the plot type.
  - allowPointSelect
```
public Boolean allowPointSelect
```
    Allow this series' points to be selected by clicking on the markers, bars or pie slices. Defaults to false.
  - animation
```
public Boolean animation
```
    Enable or disable the initial animation when a series is displayed. Since version 2.1, the animation can be set as a configuration object. Please note that this option only applies to the initial animation of the series itself. For other animations, see #chart.animation and the animation parameter under the API methods. The following properties are supported:
```
 duration The duration of the animation in milliseconds.
 easing When using jQuery as the set to linear or swing. More easing functions are
 available with the use of jQuery plug-ins, most notably the jQuery UI suite. See the jQuery
 docs. When using MooToos as the general framework, use the property name transition instead
 of easing.
 
```
    For polar charts, the animation is disabled in legacy IE browsers. Defaults to true.
  - color
```
public String color
```
    The main color or the series. In line type series it applies to the line and the point markers unless otherwise specified. In bar type series it applies to the bars unless a color is specified per point. The default value is pulled from the options.colors array.
  - colorByPoint
```
public Boolean colorByPoint
```
    When using automatic point colors pulled from the options.colors collection, this option determines whether the chart should receive one color per series or one color per point. Defaults to false.
  - colors
```
public List<String> colors
```
    A series specific or series type specific color set to apply instead of the global colors when colorByPoint is true.
  - connectEnds
```
public Boolean connectEnds
```
    Polar charts only. Whether to connect the ends of a line series plot across the extremes. Defaults to true.
  - connectNulls
```
public Boolean connectNulls
```
    Whether to connect a graph line across null points. Defaults to false.
  - cropThreshold
```
public Double cropThreshold
```
    When the series contains less points than the crop threshold, all points are drawn, event if the points fall outside the visible plot area at the current zoom. The advantage of drawing all points (including markers and columns), is that animation is performed on updates. On the other hand, when the series contains more points than the crop threshold, the series data is cropped to only contain points that fall within the plot area. The advantage of cropping away invisible points is to increase performance on large series. . Defaults to 300.
  - cursor
```
public String cursor
```
    You can set the cursor to "pointer" if you have click events attached to the series, to signal to the user that the points and lines can be clicked. Defaults to ''.
  - dashStyle
```
public DashStyle dashStyle
```
    A name for the dash style to use for the graph. Applies only to series type having a graph, like line, spline, area and scatter in case it has a lineWidth. The value for the dashStyle include:
    - Solid
    - ShortDash
    - ShortDot
    - ShortDashDot
    - ShortDashDotDot
    - Dot
    - Dash
    - LongDash
    - DashDot
    - LongDashDot
    - LongDashDotDot
    Defaults to null.
  - dataLabels
```
public final DataLabelOptions dataLabels
```
    Options for data labels.
    
    See Also:
    
    DataLabelOptions
  - enableMouseTracking
```
public Boolean enableMouseTracking
```
    Enable or disable the mouse tracking for a specific series. This includes point tooltips and click events on graphs and points. For large datasets it improves performance. Defaults to true.
  - id
```
public String id
```
    An id for the series. Defaults to null.
  - lineWidth
```
public Integer lineWidth
```
    Pixel with of the graph line. Defaults to 2.
  - linkedTo
```
public String linkedTo
```
    The id of another series to link to. Additionally, the value can be ":previous" to link to the previous series. When two series are linked, only the first one appears in the legend. Toggling the visibility of this also toggles the linked series.
  - marker
```
public final MarkerOptions marker
```
    Options for point markers.
    
    See Also:
    
    MarkerOptions
  - negativeColor
```
public String negativeColor
```
    The color for the parts of the graph or points that are below the threshold. Defaults to null.
  - pointInterval
```
public Double pointInterval
```
    If no x values are given for the points in a series, pointInterval defines the interval of the x values. For example, if a series contains one value every decade starting from year 0, set pointInterval to 10. Defaults to 1.
  - pointPlacement
```
public String pointPlacement
```
    Possible values: null, "on", "between". In a column chart, when pointPlacement is "on", the point will not create any padding of the X axis. In a polar column chart this means that the first column points directly north. If the pointPlacement is "between", the columns will be laid out between ticks. This is useful for example for visualising an amount between two points in time or in a certain sector of a polar chart. Defaults to null in cartesian charts, "between" in polar charts.
  - pointStart
```
public Double pointStart
```
    If no x values are given for the points in a series, pointStart defines on what value to start. For example, if a series contains one yearly value starting from 1945, set pointStart to 1945. Defaults to 0.
  - selected
```
public Boolean selected
```
    Whether to select the series initially. If showCheckbox is true, the checkbox next to the series name will be checked for a selected series. Defaults to false.
  - shadow
```
public Object shadow
```
    Boolean value whether to apply a drop shadow to the graph line. Optionally can be a ShadowOptions object. Defaults to true.
    
    See Also:
    
    ShadowOptions
  - showCheckbox
```
public Boolean showCheckbox
```
    If true, a checkbox is displayed next to the legend item to allow selecting the series. The state of the checkbox is determined by the selected option. Defaults to false.
  - showInLegend
```
public Boolean showInLegend
```
    Whether to display this particular series or series type in the legend. Defaults to true.
  - stacking
```
public String stacking
```
    Whether to stack the values of each series on top of each other. Possible values are null to disable, "normal" to stack by value or "percent". Defaults to null.
  - stickyTracking
```
public Boolean stickyTracking
```
    Sticky tracking of mouse events. When true, the mouseOut event on a series isn't triggered until the mouse moves over another series, or out of the plot area. When false, the mouseOut event on a series is triggered when the mouse leaves the area around the series' graph or markers. This also implies the tooltip. When stickyTracking is false and tooltip.shared is false, the tooltip will be hidden when moving the mouse between series. Defaults to true.
  - threshold
```
public Double threshold
```
    The threshold, also called zero level or base level. For line type series this is only used in conjunction with negativeColor. Defaults to 0.
  - tooltip
```
public final TooltipOptions tooltip
```
    A configuration object for the tooltip rendering of each single series.
  - turboThreshold
```
public Integer turboThreshold
```
    When a series contains a data array that is longer than this, only one dimensional arrays of numbers, or two dimensional arrays with x and y values are allowed. Also, only the first point is tested, and the rest are assumed to be the same format. This saves expensive data checking and indexing in long series. Defaults to 1000.
  - visible
```
public Boolean visible
```
    Set the initial visibility of the series. Defaults to true.
  - zIndex
```
public Integer zIndex
```
    Define the z index of the series. Defaults to null.
- Constructor Detail
  - PlotOptions
```
public PlotOptions()
```
- Method Detail
  - toMap
```
public OptionMap toMap()
```
    If type is not null, place options under a submap indexed by the type id.
    
    Specified by:
    
    toMap in interface OptionMap.IOptionMapConverter
    
    Overrides:
    
    toMap in class Options

Class PlotOptions

Field Summary

Constructor Summary

Method Summary

Methods inherited from class org.fujion.ancillary.Options

Methods inherited from class java.lang.Object

Field Detail

type

allowPointSelect

animation

color

colorByPoint

colors

connectEnds

connectNulls

cropThreshold

cursor

dashStyle

dataLabels

enableMouseTracking

id

lineWidth

linkedTo

marker

negativeColor

pointInterval

pointPlacement

pointStart

selected

shadow

showCheckbox

showInLegend

stacking

stickyTracking

threshold

tooltip

turboThreshold

visible

zIndex

Constructor Detail

PlotOptions

Method Detail

toMap