ChartOptions (Fujion Wrapper for HighCharts 2.1.0 API)

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

All Implemented Interfaces:

OptionMap.IOptionMapConverter, IClientTransform
```
public class ChartOptions
extends Options
```
Options regarding the chart area and plot area as well as general chart options.

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

static class ChartOptions.ResetZoomButtonOptions
Options for the zoom reset button.

Nested Classes
Modifier and Type	Class and Description
`static class`	`ChartOptions.ResetZoomButtonOptions` Options for the zoom reset button.

Field Summary

Fields
Modifier and Type	Field and Description
`Boolean`	`alignTicks` When using multiple axis, the ticks of two or more opposite axes will automatically be aligned by adding ticks to the axis or axes with the least ticks.
`Object`	`animation` Set the overall animation for all chart updating.
`String`	`backgroundColor` The background color or gradient for the outer chart area.
`String`	`borderColor` The color of the outer chart border.
`Integer`	`borderRadius` The corner radius of the outer chart border.
`Integer`	`borderWidth` The pixel width of the outer chart border.
`String`	`className` A CSS class name to apply to the charts container div, allowing unique CSS styling for each chart.
`Integer`	`colorCount` In styled mode, this sets how many colors the class names should rotate between.
`String`	`description` A text description of the chart.
`String`	`height` An explicit height for the chart.
`Boolean`	`ignoreHiddenSeries` If true, the axes will scale to the remaining visible series once one series is hidden.
`Boolean`	`inverted` Whether to invert the axes so that the x axis is vartical and y axis is horizontal.
`Integer`	`marginBottom` The margin between the bottom outer edge of the chart and the plot area.
`Integer`	`marginLeft` The margin between the left outer edge of the chart and the plot area.
`Integer`	`marginRight` The margin between the right outer edge of the chart and the plot area.
`Integer`	`marginTop` The margin between the top outer edge of the chart and the plot area.
`ThreeDOptions`	`options3d` Options to render charts in 3 dimensions.
`String`	`panKey` Allows setting a key to switch between zooming and panning.
`Boolean`	`panning` Allow panning in a chart.
`String`	`pinchType` Equivalent to `zoomType`, but for multi-touch gestures only.
`String`	`plotBackgroundColor` The background color or gradient for the plot area.
`String`	`plotBackgroundImage` The URL for an image to use as the plot background.
`String`	`plotBorderColor` The color of the inner chart or plot area border.
`Integer`	`plotBorderWidth` The pixel width of the plot area border.
`ShadowOptions`	`plotShadow` Whether to apply a drop shadow to the plot area.
`Boolean`	`polar` When true, Cartesian charts like line, spline, area and column are transformed into the polar coordinate system.
`protected Boolean`	`reflow` Whether to reflow the chart to fit the width of the container div on resizing the window.
`ChartOptions.ResetZoomButtonOptions`	`resetZoomButton` The button that appears after a selection zoom, allowing the user to reset zoom.
`String`	`selectionMarkerFill` The background color of the marker square when selecting (zooming in on) an area of the chart.
`ShadowOptions`	`shadow` Whether to apply a drop shadow to the outer chart area.
`Boolean`	`showAxes` Whether to show the axes initially.
`Integer`	`spacingBottom` The space between the bottom edge of the chart and the content (plot area, axis title and labels, title, subtitle or legend in top position).
`Integer`	`spacingLeft` The space between the left edge of the chart and the content (plot area, axis title and labels, title, subtitle or legend in top position).
`Integer`	`spacingRight` The space between the right edge of the chart and the content (plot area, axis title and labels, title, subtitle or legend in top position).
`Integer`	`spacingTop` The space between the top edge of the chart and the content (plot area, axis title and labels, title, subtitle or legend in top position).
`StyleOptions`	`style` Additional CSS styles to apply inline to the container div.
`protected PlotType`	`type` The series type.
`String`	`typeDescription` A text description of the chart type.
`Integer`	`width` An explicit width for the chart.
`ZoomType`	`zoomType` Decides in what dimensions the user can zoom by dragging the mouse.

Constructor Summary

Constructors
Constructor and Description

ChartOptions()

Constructors
Constructor and Description
`ChartOptions()`

Method Summary
- Methods inherited from class org.fujion.ancillary.Options
  toMap
- Methods inherited from class java.lang.Object
  clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
- Methods inherited from interface org.fujion.ancillary.OptionMap.IOptionMapConverter
  transformForClient

- Field Detail
  - alignTicks
```
@Option
public Boolean alignTicks
```
    When using multiple axis, the ticks of two or more opposite axes will automatically be aligned by adding ticks to the axis or axes with the least ticks. This can be prevented by setting alignTicks to false. If the grid lines look messy, it's a good idea to hide them for the secondary axis by setting gridLineWidth to 0. Defaults to true.
  - animation
```
@Option
public Object animation
```
    Set the overall animation for all chart updating. Animation can be disabled throughout the chart by setting it to false here. It can be overridden for each individual API method as a function parameter. The only animation not affected by this option is the initial series animation, see plotOptions.series => animation. The animation can either be set as a boolean or an AnimationOptions object. If true, it will use the 'swing' jQuery easing and a duration of 500 ms. If used as a configuration object, the following properties are supported:
    - duration - The duration of the animation in milliseconds.
    - easing - When using jQuery as the general framework, the easing can be 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 MooTools as the general framework, use the property name transition instead of easing.
    Defaults to true.
  - backgroundColor
```
@Option
public String backgroundColor
```
    The background color or gradient for the outer chart area. Defaults to "#FFFFFF".
  - borderColor
```
@Option
public String borderColor
```
    The color of the outer chart border. The border is painted using vector graphic techniques to allow rounded corners. Defaults to "#4572A7".
  - borderRadius
```
@Option
public Integer borderRadius
```
    The corner radius of the outer chart border. Defaults to 5.
  - borderWidth
```
@Option
public Integer borderWidth
```
    The pixel width of the outer chart border. The border is painted using vector graphic techniques to allow rounded corners. Defaults to 0.
  - className
```
@Option
public String className
```
    A CSS class name to apply to the charts container div, allowing unique CSS styling for each chart. Defaults to "".
  - colorCount
```
@Option
public Integer colorCount
```
    In styled mode, this sets how many colors the class names should rotate between. With ten colors, series (or points) are given class names like highcharts-color-0, highcharts-color-0 [...] highcharts-color-9. The equivalent in non-styled mode is to set colors using the colors setting. Defaults to 10.
  - description
```
@Option
public String description
```
    A text description of the chart. If the Accessibility module is loaded, this is included by default as a long description of the chart and its contents in the hidden screen reader information region. Defaults to undefined.
  - height
```
@Option
public String height
```
    An explicit height for the chart. By default the height is calculated from the offset height of the containing element. Defaults to null.
  - ignoreHiddenSeries
```
@Option
public Boolean ignoreHiddenSeries
```
    If true, the axes will scale to the remaining visible series once one series is hidden. If false, hiding and showing a series will not affect the axes or the other series. For stacks, once one series within the stack is hidden, the rest of the stack will close in around it even if the axis is not affected. Defaults to true.
  - inverted
```
@Option
public Boolean inverted
```
    Whether to invert the axes so that the x axis is vartical and y axis is horizontal. When true, the x axis is reversed by default. If a bar series is present in the chart, it will be inverted automatically. Defaults to false.
  - marginBottom
```
@Option
public Integer marginBottom
```
    The margin between the bottom outer edge of the chart and the plot area. Use this to set a fixed pixel value for the margin as opposed to the default dynamic margin. See also spacingBottom. Defaults to 70.
  - marginLeft
```
@Option
public Integer marginLeft
```
    The margin between the left outer edge of the chart and the plot area. Use this to set a fixed pixel value for the margin as opposed to the default dynamic margin. See also spacingLeft. Defaults to 80.
  - marginRight
```
@Option
public Integer marginRight
```
    The margin between the right outer edge of the chart and the plot area. Use this to set a fixed pixel value for the margin as opposed to the default dynamic margin. See also spacingRight. Defaults to 50.
  - marginTop
```
@Option
public Integer marginTop
```
    The margin between the top outer edge of the chart and the plot area. Use this to set a fixed pixel value for the margin as opposed to the default dynamic margin. See also spacingTop. Defaults to null.
  - options3d
```
@Option
public final ThreeDOptions options3d
```
    Options to render charts in 3 dimensions. This feature requires highcharts-3d.js.
  - panKey
```
@Option
public String panKey
```
    Allows setting a key to switch between zooming and panning. Can be one of alt, ctrl, meta (the command key on Mac and Windows key on Windows) or shift. The keys are mapped directly to the key properties of the click event argument (event.altKey, event.ctrlKey, event.metaKey and event.shiftKey). Defaults to undefined.
  - panning
```
@Option
public Boolean panning
```
    Allow panning in a chart. Best used with panKey to combine zooming and panning. On touch devices, when the tooltip.followTouchMove option is true (default), panning requires two fingers. To allow panning with one finger, set followTouchMove to false. Defaults to false.
  - pinchType
```
@Option
public String pinchType
```
    Equivalent to zoomType, but for multi-touch gestures only. By default, the pinchType is the same as the zoomType setting. However, pinching can be enabled separately in some cases, for example in stock charts where a mouse drag pans the chart, while pinching is enabled. When tooltip.followTouchMove is true, pinchType only applies to two-finger touches. Defaults to null.
  - plotBackgroundColor
```
@Option
public String plotBackgroundColor
```
    The background color or gradient for the plot area. Defaults to null.
  - plotBackgroundImage
```
@Option
public String plotBackgroundImage
```
    The URL for an image to use as the plot background. To set an image as the background for the entire chart, set a CSS background image to the container element. Defaults to null.
  - plotBorderColor
```
@Option
public String plotBorderColor
```
    The color of the inner chart or plot area border. Defaults to "#C0C0C0".
  - plotBorderWidth
```
@Option
public Integer plotBorderWidth
```
    The pixel width of the plot area border. Defaults to 0.
  - plotShadow
```
@Option
public ShadowOptions plotShadow
```
    Whether to apply a drop shadow to the plot area. Requires that plotBackgroundColor be set. Defaults to no shadow.
    
    See Also:
    
    ShadowOptions
  - polar
```
@Option
public Boolean polar
```
    When true, Cartesian charts like line, spline, area and column are transformed into the polar coordinate system.
  - reflow
```
@Option
protected final Boolean reflow
```
    Whether to reflow the chart to fit the width of the container div on resizing the window. Under Fujion, the container handles resizing, so this option is forced to false.
  - resetZoomButton
```
@Option
public final ChartOptions.ResetZoomButtonOptions resetZoomButton
```
    The button that appears after a selection zoom, allowing the user to reset zoom.
  - selectionMarkerFill
```
@Option
public String selectionMarkerFill
```
    The background color of the marker square when selecting (zooming in on) an area of the chart. Defaults to rgba(51,92,173,0.25).
  - shadow
```
@Option
public ShadowOptions shadow
```
    Whether to apply a drop shadow to the outer chart area. Requires that backgroundColor be set. Defaults to no shadow
    
    See Also:
    
    ShadowOptions
  - showAxes
```
@Option
public Boolean showAxes
```
    Whether to show the axes initially. This only applies to empty charts where series are added dynamically, as axes are automatically added to Cartesian series. Defaults to false.
  - spacingBottom
```
@Option
public Integer spacingBottom
```
    The space between the bottom edge of the chart and the content (plot area, axis title and labels, title, subtitle or legend in top position). Defaults to 15.
  - spacingLeft
```
@Option
public Integer spacingLeft
```
    The space between the left edge of the chart and the content (plot area, axis title and labels, title, subtitle or legend in top position). Defaults to 10.
  - spacingRight
```
@Option
public Integer spacingRight
```
    The space between the right edge of the chart and the content (plot area, axis title and labels, title, subtitle or legend in top position). Defaults to 10.
  - spacingTop
```
@Option
public Integer spacingTop
```
    The space between the top edge of the chart and the content (plot area, axis title and labels, title, subtitle or legend in top position). . Defaults to 10.
  - style
```
@Option
public final StyleOptions style
```
    Additional CSS styles to apply inline to the container div. Note that since the default font styles are applied in the renderer, it is ignorant of the individual chart options and must be set globally. Defaults to:
```
     fontFamily: '"Lucida Grande", "Lucida Sans Unicode", Verdana, Arial, Helvetica, sans-serif'
     fontSize: '12px'
 
```
  - type
```
@Option
protected PlotType type
```
    The series type. Defaults to LINE.
  - typeDescription
```
@Option
public String typeDescription
```
    A text description of the chart type. If the Accessibility module is loaded, this will be included in the description of the chart in the screen reader information region. Highcharts will by default attempt to guess the chart type, but for more complex charts it is recommended to specify this property for clarity. Defaults to undefined.
  - width
```
@Option
public Integer width
```
    An explicit width for the chart. By default the width is calculated from the offset width of the containing element. Defaults to null.
  - zoomType
```
@Option
public ZoomType zoomType
```
    Decides in what dimensions the user can zoom by dragging the mouse. Can be one of x, y or xy. Defaults to null.
- Constructor Detail
  - ChartOptions
```
public ChartOptions()
```

Class ChartOptions

Nested Class Summary

Field Summary

Constructor Summary

Method Summary

Methods inherited from class org.fujion.ancillary.Options

Methods inherited from class java.lang.Object

Methods inherited from interface org.fujion.ancillary.OptionMap.IOptionMapConverter

Field Detail

alignTicks

animation

backgroundColor

borderColor

borderRadius

borderWidth

className

colorCount

description

height

ignoreHiddenSeries

inverted

marginBottom

marginLeft

marginRight

marginTop

options3d

panKey

panning

pinchType

plotBackgroundColor

plotBackgroundImage

plotBorderColor

plotBorderWidth

plotShadow

polar

reflow

resetZoomButton

selectionMarkerFill

shadow

showAxes

spacingBottom

spacingLeft

spacingRight

spacingTop

style

type

typeDescription

width

zoomType

Constructor Detail

ChartOptions