com.highsoft.highcharts.core

Class HIChartView

java.lang.Object

RelativeLayout

com.highsoft.highcharts.core.HIChartView

public class HIChartView
extends RelativeLayout

Highcharts Chart View Class. Initialize this as a normal view and set required properties.

Field Summary

Fields

Modifier and Type	Field and Description
HIGlobal	global Global object.
HILang	lang Language object.
java.util.List<java.lang.String>	plugins Additional plugins to load into chart after preloading.
java.lang.String	theme Theme name to load from file system after preloading.

Constructor Summary

Constructors

Constructor and Description
HIChartView(Context c) Basic constructor with default chart size
HIChartView(Context c, AttributeSet attrs) Another basic constructor, this one is called automatically when you create view in XML

Method Summary

Modifier and Type	Method and Description
void	addAnnotation(HIAnnotations annotations) Add an annotation to the chart after render time.
void	addAnnotation(HIAnnotations annotations, boolean redraw) Add an annotation to the chart after render time.
void	addCredits(HICredits options) Set a new credits label for the chart.
void	addFont(int id)
void	addSeries(HISeries options) Add a series to the chart after render time.
void	addSeries(HISeries options, boolean redraw) Add a series to the chart after render time.
void	addSeries(HISeries options, boolean redraw, HIAnimationOptionsObject animation) Add a series to the chart after render time.
void	addSeriesAsDrilldown(HIPoint point, HISeries options) Add a series to the chart as drilldown from a specific point in the parent series.
void	addXAxis(HIXAxis options) Add an axis to the chart after render time.
void	addXAxis(HIXAxis options, boolean redraw) Add an axis to the chart after render time.
void	addXAxis(HIXAxis options, boolean redraw, HIAnimationOptionsObject animation) Add an axis to the chart after render time.
void	addYAxis(HIYAxis options) Add an axis to the chart after render time.
void	addYAxis(HIYAxis options, boolean redraw) Add an axis to the chart after render time.
void	addYAxis(HIYAxis options, boolean redraw, HIAnimationOptionsObject animation) Add an axis to the chart after render time.
void	cancelSonify() Cancel current sonification and reset cursor.
void	cancelSonify(boolean fadeOut) Cancel current sonification and reset cursor.
void	destroy() Remove the chart and purge memory.
void	drillUp() When the chart is drilled down to a child series, calling chart.drillUp() will drill up to the parent series.
HIOptions	getOptions()
void	hideLoading() Hide the loading layer.
void	loadJSONOptions(java.util.HashMap<java.lang.String,java.lang.Object> options)
void	openInCloud() Experimental function to send a chart's config to the Cloud for editing.
void	pauseSonify() Pause the running sonification.
void	pauseSonify(boolean fadeOut) Pause the running sonification.
void	print() Exporting module required.
void	redraw() Redraw the chart after changes have been done to the data, axis extremes chart size or chart elements.
void	redraw(HIAnimationOptionsObject animation) Redraw the chart after changes have been done to the data, axis extremes chart size or chart elements.
void	reload() Deprecated.
void	removeAnnotation(HIAnnotations annotation) Remove an annotation from the chart.
void	removeAnnotationById(java.lang.String id) Remove an annotation from the chart.
void	resetSonifyCursor() Reset cursor to start.
void	resetSonifyCursorEnd() Reset cursor to end.
void	setOnFocusChangeListener(OnFocusChangeListener l)
void	setOptions(HIOptions options) Options are main configuration entry point for chart view, for more information read API documentation.
void	setSonifyCursor(HIPoint point) Set the cursor to a point in different series
void	setSonifyCursor(java.util.List<HIPoint> points) Set the cursor to set of points in different series.
void	setSubtitle(HISubtitle options) Shortcut to set the subtitle options.
void	setTitle(HISubtitle titleOptions, HISubtitle subtitleOptions, boolean redraw) Set a new title or subtitle for the chart.
void	showLoading(java.lang.String str) Dim the chart and show a loading text.
void	sonify(java.util.Map options) Sonify a chart.
void	update(HIOptions options) A generic function to update any element of the chart.
void	update(HIOptions options, boolean redraw) A generic function to update any element of the chart.
void	update(HIOptions options, boolean redraw, boolean oneToOne) A generic function to update any element of the chart.
void	update(HIOptions options, boolean redraw, boolean oneToOne, HIAnimationOptionsObject animation) A generic function to update any element of the chart.
void	viewData() Export-data module required.
void	zoomOut() Zoom the chart out after a user has zoomed in.

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

global

public HIGlobal global

Global object. It contains global options that apply to the chart view but are not within other classes,

lang

public HILang lang

Language object. It is used for all language specific matters.

plugins

public java.util.List<java.lang.String> plugins

Additional plugins to load into chart after preloading.

theme

public java.lang.String theme

Theme name to load from file system after preloading.

Constructor Detail

HIChartView

public HIChartView(Context c)

Basic constructor with default chart size

Parameters:

c - Context from Layout which will be containing chart

HIChartView

public HIChartView(Context c,
                   AttributeSet attrs)

Another basic constructor, this one is called automatically when you create view in XML

Parameters:

c - app context

attrs - attributes from xml

Method Detail

addAnnotation

public void addAnnotation(HIAnnotations annotations)

Add an annotation to the chart after render time.

Parameters:

annotations - The annotation options for the new, detailed annotation.

addAnnotation

public void addAnnotation(HIAnnotations annotations,
                          boolean redraw)

Add an annotation to the chart after render time.

Parameters:

annotations - The annotation options for the new, detailed annotation.

redraw - Whether to redraw the chart after adding.

addCredits

public void addCredits(HICredits options)

Set a new credits label for the chart.

Parameters:

options - A configuration object for the new credits.

addFont

public void addFont(int id)

addSeries

public void addSeries(HISeries options)

Add a series to the chart after render time. Note that this method should never be used when adding data synchronously at chart render time, as it adds expense to the calculations and rendering. When adding data at the same time as the chart is initialized, add the series as a configuration option instead. With multiple axes, the offset is dynamically adjusted.

Parameters:

options - The config options for the series.

addSeries

public void addSeries(HISeries options,
                      boolean redraw)

Add a series to the chart after render time. Note that this method should never be used when adding data synchronously at chart render time, as it adds expense to the calculations and rendering. When adding data at the same time as the chart is initialized, add the series as a configuration option instead. With multiple axes, the offset is dynamically adjusted.

Parameters:

options - The config options for the series.

redraw - Whether to redraw the chart after adding.

addSeries

public void addSeries(HISeries options,
                      boolean redraw,
                      HIAnimationOptionsObject animation)

Add a series to the chart after render time. Note that this method should never be used when adding data synchronously at chart render time, as it adds expense to the calculations and rendering. When adding data at the same time as the chart is initialized, add the series as a configuration option instead. With multiple axes, the offset is dynamically adjusted.

Parameters:

options - The config options for the series.

redraw - Whether to redraw the chart after adding.

animation - Whether to apply animation, and optionally animation configuration.

addSeriesAsDrilldown

public void addSeriesAsDrilldown(HIPoint point,
                                 HISeries options)

Add a series to the chart as drilldown from a specific point in the parent series. This method is used for async drilldown, when clicking a point in a series should result in loading and displaying a more high-resolution series. When not async, the setup is simpler using the drilldown.series options structure.

Parameters:

point - The point from which the drilldown will start.

options - The series options for the new, detailed series.

addXAxis

public void addXAxis(HIXAxis options)

Add an axis to the chart after render time. Note that this method should never be used when adding data synchronously at chart render time, as it adds expense to the calculations and rendering. When adding data at the same time as the chart is initialized, add the axis as a configuration option instead.

Parameters:

options - The axis options.

addXAxis

public void addXAxis(HIXAxis options,
                     boolean redraw)

Add an axis to the chart after render time. Note that this method should never be used when adding data synchronously at chart render time, as it adds expense to the calculations and rendering. When adding data at the same time as the chart is initialized, add the axis as a configuration option instead.

Parameters:

options - The axis options.

redraw - Whether to redraw the chart after adding.

addXAxis

public void addXAxis(HIXAxis options,
                     boolean redraw,
                     HIAnimationOptionsObject animation)

Add an axis to the chart after render time. Note that this method should never be used when adding data synchronously at chart render time, as it adds expense to the calculations and rendering. When adding data at the same time as the chart is initialized, add the axis as a configuration option instead.

Parameters:

options - The axis options.

redraw - Whether to redraw the chart after adding.

animation - Whether and how to apply animation in the redraw.

addYAxis

public void addYAxis(HIYAxis options)

Add an axis to the chart after render time. Note that this method should never be used when adding data synchronously at chart render time, as it adds expense to the calculations and rendering. When adding data at the same time as the chart is initialized, add the axis as a configuration option instead.

Parameters:

options - The axis options.

addYAxis

public void addYAxis(HIYAxis options,
                     boolean redraw)

Add an axis to the chart after render time. Note that this method should never be used when adding data synchronously at chart render time, as it adds expense to the calculations and rendering. When adding data at the same time as the chart is initialized, add the axis as a configuration option instead.

Parameters:

options - The axis options.

redraw - Whether to redraw the chart after adding.

addYAxis

public void addYAxis(HIYAxis options,
                     boolean redraw,
                     HIAnimationOptionsObject animation)

Add an axis to the chart after render time. Note that this method should never be used when adding data synchronously at chart render time, as it adds expense to the calculations and rendering. When adding data at the same time as the chart is initialized, add the axis as a configuration option instead.

Parameters:

options - The axis options.

redraw - Whether to redraw the chart after adding.

animation - Whether and how to apply animation in the redraw.

cancelSonify

public void cancelSonify()

Cancel current sonification and reset cursor.

cancelSonify

public void cancelSonify(boolean fadeOut)

Cancel current sonification and reset cursor.

Parameters:

fadeOut - Fade out as we pause to avoid clicks.

destroy

public void destroy()

Remove the chart and purge memory. This method is called internally before adding a second chart into the same container, as well as on window unload to prevent leaks.

drillUp

public void drillUp()

When the chart is drilled down to a child series, calling chart.drillUp() will drill up to the parent series. Requires the drilldown module.

getOptions

public HIOptions getOptions()

hideLoading

public void hideLoading()

Hide the loading layer.

loadJSONOptions

public void loadJSONOptions(java.util.HashMap<java.lang.String,java.lang.Object> options)

openInCloud

public void openInCloud()

Experimental function to send a chart's config to the Cloud for editing. Limitations: All functions (formatters and callbacks) are removed since they're not JSON.

pauseSonify

public void pauseSonify()

Pause the running sonification.

pauseSonify

public void pauseSonify(boolean fadeOut)

Pause the running sonification.

Parameters:

fadeOut - Fade out as we pause to avoid clicks.

print

public void print()

Exporting module required. Clears away other elements in the page and prints the chart as it is displayed. By default, when the exporting module is enabled, a context button with a drop down menu in the upper right corner accesses this function.

redraw

public void redraw()

Redraw the chart after changes have been done to the data, axis extremes chart size or chart elements. All methods for updating axes, series or points have a parameter for redrawing the chart. This is true by default. But in many cases you want to do more than one operation on the chart before redrawing, for example add a number of points. In those cases it is a waste of resources to redraw the chart for each new point added. So you add the points and call HIChartView.redraw() after.

redraw

public void redraw(HIAnimationOptionsObject animation)

Redraw the chart after changes have been done to the data, axis extremes chart size or chart elements. All methods for updating axes, series or points have a parameter for redrawing the chart. This is true by default. But in many cases you want to do more than one operation on the chart before redrawing, for example add a number of points. In those cases it is a waste of resources to redraw the chart for each new point added. So you add the points and call HIChartView.redraw() after.

Parameters:

animation - If or how to apply animation to the redraw.

reload

@Deprecated
public void reload()

Deprecated.

Method to reload the chart. Use it after updating the chart options.

removeAnnotation

public void removeAnnotation(HIAnnotations annotation)

Remove an annotation from the chart.

Parameters:

annotation - Direct annotation object.

removeAnnotationById

public void removeAnnotationById(java.lang.String id)

Remove an annotation from the chart.

Parameters:

id - The annotation's id

resetSonifyCursor

public void resetSonifyCursor()

Reset cursor to start. Requires series.sonify or chart.sonify to have been played at some point earlier.

resetSonifyCursorEnd

public void resetSonifyCursorEnd()

Reset cursor to end. Requires series.sonify or chart.sonify to have been played at some point earlier.

setOnFocusChangeListener

public void setOnFocusChangeListener(OnFocusChangeListener l)

setOptions

public void setOptions(HIOptions options)

Options are main configuration entry point for chart view, for more information read API documentation.

setSonifyCursor

public void setSonifyCursor(HIPoint point)

Set the cursor to a point in different series

Parameters:

point - The point to set the cursor to.

setSonifyCursor

public void setSonifyCursor(java.util.List<HIPoint> points)

Set the cursor to set of points in different series.

Parameters:

points - The points to set the cursor to. The points have to be in different series that are being played simultaneously.

setSubtitle

public void setSubtitle(HISubtitle options)

Shortcut to set the subtitle options.

Parameters:

options - New subtitle options. The subtitle text itself is set by the options.text property.

setTitle

public void setTitle(HISubtitle titleOptions,
                     HISubtitle subtitleOptions,
                     boolean redraw)

Set a new title or subtitle for the chart.

Parameters:

titleOptions - New subtitle options. The subtitle text itself is set by the options.text property.

subtitleOptions - New subtitle options. The subtitle text itself is set by the subtitleOptions.text property.

redraw - Whether to redraw the chart or wait for a later call to HIChartView.redraw().

showLoading

public void showLoading(java.lang.String str)

Dim the chart and show a loading text. Options for the loading screen are defined in the loading options.

Parameters:

str - A text to show in the loading label instead of the default one. The default text is set in HILang.loading.

sonify

public void sonify(java.util.Map options)

Sonify a chart.

Parameters:

options - The options for sonifying this chart.

update

public void update(HIOptions options)

A generic function to update any element of the chart. Elements can be enabled and disabled, moved, re-styled, re-formatted etc. A special case is configuration objects that take arrays, for example xAxis, yAxis or series. For these collections, an id option is used to map the new option set to an existing object. If an existing object of the same id is not found, the corresponding item is updated. So for example, running chart.update with a series item without an id, will cause the existing chart's series with the same index in the series array to be updated. When the oneToOne parameter is true, chart.update will also take care of adding and removing items from the collection. Read more under the parameter description below. Note that when changing series data, chart.update may mutate the passed data options.

Parameters:

options - A configuration object for the new chart options.

update

public void update(HIOptions options,
                   boolean redraw)

A generic function to update any element of the chart. Elements can be enabled and disabled, moved, re-styled, re-formatted etc. A special case is configuration objects that take arrays, for example xAxis, yAxis or series. For these collections, an id option is used to map the new option set to an existing object. If an existing object of the same id is not found, the corresponding item is updated. So for example, running chart.update with a series item without an id, will cause the existing chart's series with the same index in the series array to be updated. When the oneToOne parameter is true, chart.update will also take care of adding and removing items from the collection. Read more under the parameter description below. Note that when changing series data, chart.update may mutate the passed data options.

Parameters:

options - A configuration object for the new chart options.

redraw - Whether to redraw the chart.

update

public void update(HIOptions options,
                   boolean redraw,
                   boolean oneToOne)

A generic function to update any element of the chart. Elements can be enabled and disabled, moved, re-styled, re-formatted etc. A special case is configuration objects that take arrays, for example xAxis, yAxis or series. For these collections, an id option is used to map the new option set to an existing object. If an existing object of the same id is not found, the corresponding item is updated. So for example, running chart.update with a series item without an id, will cause the existing chart's series with the same index in the series array to be updated. When the oneToOne parameter is true, chart.update will also take care of adding and removing items from the collection. Read more under the parameter description below. Note that when changing series data, chart.update may mutate the passed data options.

Parameters:

options - A configuration object for the new chart options.

redraw - Whether to redraw the chart.

oneToOne - When true, the series, xAxis and yAxis collections will be updated one to one, and items will be either added or removed to match the new updated options. For example, if the chart has two series and we call chart.update with a configuration containing three series, one will be added. If we call chart.update with one series, one will be removed. Setting an empty series array will remove all series, but leaving out the series property will leave all series untouched. If the series have id's, the new series options will be matched by id, and the remaining ones removed.

update

public void update(HIOptions options,
                   boolean redraw,
                   boolean oneToOne,
                   HIAnimationOptionsObject animation)

A generic function to update any element of the chart. Elements can be enabled and disabled, moved, re-styled, re-formatted etc. A special case is configuration objects that take arrays, for example xAxis, yAxis or series. For these collections, an id option is used to map the new option set to an existing object. If an existing object of the same id is not found, the corresponding item is updated. So for example, running chart.update with a series item without an id, will cause the existing chart's series with the same index in the series array to be updated. When the oneToOne parameter is true, chart.update will also take care of adding and removing items from the collection. Read more under the parameter description below. Note that when changing series data, chart.update may mutate the passed data options.

Parameters:

options - A configuration object for the new chart options.

redraw - Whether to redraw the chart.

oneToOne - When true, the series, xAxis and yAxis collections will be updated one to one, and items will be either added or removed to match the new updated options. For example, if the chart has two series and we call chart.update with a configuration containing three series, one will be added. If we call chart.update with one series, one will be removed. Setting an empty series array will remove all series, but leaving out the series property will leave all series untouched. If the series have id's, the new series options will be matched by id, and the remaining ones removed.

animation - Whether to apply animation, and optionally animation configuration.

viewData

public void viewData()

Export-data module required. View the data in a table below the chart.

zoomOut

public void zoomOut()

Zoom the chart out after a user has zoomed in. See also Axis.setExtremes.