org.fujion.highcharts

Class Chart

java.lang.Object

org.fujion.component.BaseComponent

org.fujion.component.BaseUIComponent

org.fujion.highcharts.Chart

All Implemented Interfaces:

IDisable, IElementIdentifier, OptionMap.IOptionMapConverter

@Component(tag="hchart",
           widgetModule="fujion-hchart",
           widgetClass="HChart",
           parentTag="*",
           description="Fujion wrapper for HighCharts component.")
public class Chart
extends BaseUIComponent
implements OptionMap.IOptionMapConverter

Fujion wrapper for HighCharts component.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	Chart.ChartSettings Top level chart settings.

Nested classes/interfaces inherited from class org.fujion.component.BaseComponent

BaseComponent.SubComponent

Field Summary

Fields

Modifier and Type	Field and Description
Chart.ChartSettings	options

Constructor Summary

Constructors

Constructor and Description
Chart() Create default chart (line plot, single x- and y-axis).

Method Summary

Modifier and Type	Method and Description
Series	addSeries() Adds a new series to the chart using the chart's default type.
Series	addSeries(String type) Adds a new series to the chart using the specified type.
Axis	addXAxis() Adds an additional x axis.
Axis	addYAxis() Adds an additional y axis.
void	clear() Removes all series and data points and destroys the client graph.
void	export() Calls the exportChart function on the chart.
String	getSubtitle() Convenience method for getting subtitle.
String	getTitle() Convenience method for getting title.
String	getType() Returns the chart type.
Axis	getXAxis() Convenience method for returning the x-axis.
Axis	getYAxis() Convenience method for returning the y-axis.
boolean	isRunning() Returns true if a chart is currently running on the client.
void	print() Calls the print function on the chart.
void	redraw() Force a redraw of the chart.
void	run() Build the graph on the client.
void	setDefaultColors(String... colors) Sets the default colors for the chart's series.
void	setSubtitle(String text) Convenience method for setting subtitle.
void	setTitle(String text) Convenience method for setting title.
void	setType(String type) Sets the chart type.
OptionMap	toMap() Converts all options to map for sending to client.

Methods inherited from class org.fujion.component.BaseUIComponent

_syncClasses, _syncStyles, addClass, addMask, addMask, addMask, addStyle, addStyles, afterRemoveChild, focus, getBalloon, getClasses, getContext, getCss, getDragid, getDropid, getFirstVisibleChild, getFirstVisibleChild, getFlex, getHeight, getHint, getKeycapture, getPopup, getStyle, getStyles, getTabindex, getWidth, hide, isDisabled, isVisible, removeClass, removeMask, removeStyle, scrollIntoView, setBalloon, setClasses, setContext, setCss, setDisabled, setDragid, setDropid, setFlex, setFocus, setHeight, setHint, setKeycapture, setPopup, setStyles, setTabindex, setVisible, setWidth, show, toggleClass

Methods inherited from class org.fujion.component.BaseComponent

_attach, _initProps, addChild, addChild, addChild, addChildren, addEventForward, addEventForward, addEventForward, addEventForward, addEventListener, addEventListener, addEventListener, addEventListener, afterAddChild, afterSetParent, areEqual, beforeAddChild, beforeRemoveChild, beforeSetParent, bringToFront, defaultify, destroy, destroyChildren, detach, finalize, findAttribute, findByName, findByName, findChildByData, findChildByLabel, fireEvent, fireEvent, getAncestor, getAncestor, getAttribute, getAttribute, getAttribute, getAttributes, getChild, getChildAt, getChildCount, getChildCount, getChildren, getChildren, getContent, getController, getControllers, getData, getData, getDefinition, getFirstChild, getId, getIndex, getLastChild, getName, getNamespace, getNextSibling, getPage, getParent, getPreviousSibling, getRoot, hasAttribute, hasEventListener, hasEventListener, invoke, invoke, invokeIfAttached, isAncestor, isContainer, isContentSynced, isDead, isNamespace, notifyAncestors, notifyDescendants, nullify, onAttach, onDestroy, propertyChange, removeAttribute, removeChild, removeEventForward, removeEventForward, removeEventForward, removeEventForward, removeEventListener, removeEventListener, removeEventListener, removeEventListener, setAttribute, setContent, setContentSynced, setData, setIndex, setName, setParent, sub, swapChildren, sync, toString, trimify, validate, validate, validateChild, validateIsChild, validatePage, validateParent, wireController

Methods inherited from class java.lang.Object

clone, equals, getClass, hashCode, notify, notifyAll, wait, wait, wait

Field Detail

options

public final Chart.ChartSettings options

Constructor Detail

Chart

public Chart()

Create default chart (line plot, single x- and y-axis).

Method Detail

setDefaultColors

public void setDefaultColors(String... colors)

Sets the default colors for the chart's series. When all colors are used, new colors are pulled from the start again.

Parameters:

colors - List of default colors. If null or empty, the Highcharts defaults are used.

getType

@Component.PropertyGetter(value="type",
                          description="The chart type.")
public String getType()

Returns the chart type.

Returns:

The chart type.

setType

@Component.PropertySetter(value="type",
                          defaultValue="line",
                          description="The chart type.")
public void setType(String type)

Sets the chart type. This will remove any existing series.

Parameters:

type - One of the supported chart types.

getXAxis

public Axis getXAxis()

Convenience method for returning the x-axis. If there are no x-axes, returns null. If there are multiple x-axes, returns the first only.

Returns:

The x-axis.

getYAxis

public Axis getYAxis()

Convenience method for returning the y-axis. If there are no y-axes, returns null. If there are multiple y-axes, returns the first only.

Returns:

The y-axis.

addSeries

public Series addSeries()

Adds a new series to the chart using the chart's default type.

Returns:

The newly created series.

addSeries

public Series addSeries(String type)

Adds a new series to the chart using the specified type.

Parameters:

type - The plot type.

Returns:

The newly created series.

addXAxis

public Axis addXAxis()

Adds an additional x axis.

Returns:

The newly added axis.

addYAxis

public Axis addYAxis()

Adds an additional y axis.

Returns:

The newly added axis.

run

public void run()

Build the graph on the client.

isRunning

public boolean isRunning()

Returns true if a chart is currently running on the client.

Returns:

True if a chart is running.

clear

public void clear()

Removes all series and data points and destroys the client graph.

redraw

public void redraw()

Force a redraw of the chart.

toMap

public OptionMap toMap()

Converts all options to map for sending to client.

Specified by:

toMap in interface OptionMap.IOptionMapConverter

getTitle

@Component.PropertyGetter(value="title",
                          description="The title text.")
public String getTitle()

Convenience method for getting title.

Returns:

Title text

setTitle

@Component.PropertySetter(value="title",
                          description="The title text.")
public void setTitle(String text)

Convenience method for setting title.

Parameters:

text - Title text

getSubtitle

@Component.PropertyGetter(value="subtitle",
                          description="The subtitle text.")
public String getSubtitle()

Convenience method for getting subtitle.

Returns:

Subtitle text

setSubtitle

@Component.PropertySetter(value="subtitle",
                          description="The subtitle text.")
public void setSubtitle(String text)

Convenience method for setting subtitle.

Parameters:

text - Subtitle text

export

public void export()

Calls the exportChart function on the chart.

print

public void print()

Calls the print function on the chart.