ChartOptions (Fujion Wrapper for HighCharts 1.1.8 API)

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

All Implemented Interfaces:

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

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`	`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`	`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.
`Object`	`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.
`protected String`	`renderTo` Id of the parent element that will host the chart.
`Object`	`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.
`Boolean`	`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 String`	`type` The series 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
  copyTo, toMap
- Methods inherited from class java.lang.Object
  clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Field Detail
  - alignTicks
```
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
```
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 a configuration 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
```
public String backgroundColor
```
    The background color or gradient for the outer chart area. Defaults to "#FFFFFF".
  - borderColor
```
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
```
public Integer borderRadius
```
    The corner radius of the outer chart border. Defaults to 5.
  - borderWidth
```
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
```
public String className
```
    A CSS class name to apply to the charts container div, allowing unique CSS styling for each chart. Defaults to "".
  - height
```
public Integer 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
```
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
```
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
```
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
```
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
```
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
```
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
```
public final ThreeDOptions options3d
```
    Options to render charts in 3 dimensions. This feature requires highcharts-3d.js.
  - plotBackgroundColor
```
public String plotBackgroundColor
```
    The background color or gradient for the plot area. Defaults to null.
  - plotBackgroundImage
```
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
```
public String plotBorderColor
```
    The color of the inner chart or plot area border. Defaults to "#C0C0C0".
  - plotBorderWidth
```
public Integer plotBorderWidth
```
    The pixel width of the plot area border. Defaults to 0.
  - plotShadow
```
public Object plotShadow
```
    Whether to apply a drop shadow to the plot area. Requires that plotBackgroundColor be set. The shadow can be a ShadowOptions object. Defaults to false.
    
    See Also:
    
    ShadowOptions
  - polar
```
public Boolean polar
```
    When true, Cartesian charts like line, spline, area and column are transformed into the polar coordinate system.
  - reflow
```
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.
  - renderTo
```
protected String renderTo
```
    Id of the parent element that will host the chart. This will be set automatically.
  - resetZoomButton
```
public Object resetZoomButton
```
    The button that appears after a selection zoom, allowing the user to reset zoom.
  - selectionMarkerFill
```
public String selectionMarkerFill
```
    The background color of the marker square when selecting (zooming in on) an area of the chart. Defaults to rgba(69,114,167,0.25). Defaults to rgba(69114,167,0.25).
  - shadow
```
public Boolean shadow
```
    Whether to apply a drop shadow to the outer chart area. Requires that backgroundColor be set. The shadow can be a ShadowOptions object. Defaults to false.
    
    See Also:
    
    ShadowOptions
  - showAxes
```
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
```
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
```
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
```
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
```
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
```
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
```
protected String type
```
    The series type. Defaults to "line".
  - width
```
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
```
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

Field Summary

Constructor Summary

Method Summary

Methods inherited from class org.fujion.ancillary.Options

Methods inherited from class java.lang.Object

Field Detail

alignTicks

animation

backgroundColor

borderColor

borderRadius

borderWidth

className

height

ignoreHiddenSeries

inverted

marginBottom

marginLeft

marginRight

marginTop

options3d

plotBackgroundColor

plotBackgroundImage

plotBorderColor

plotBorderWidth

plotShadow

polar

reflow

renderTo

resetZoomButton

selectionMarkerFill

shadow

showAxes

spacingBottom

spacingLeft

spacingRight

spacingTop

style

type

width

zoomType

Constructor Detail

ChartOptions