com.highsoft.highcharts.common.hichartsclasses

Class HIAnnotation

java.lang.Object

java.util.Observable

com.highsoft.highcharts.core.HIFoundation

com.highsoft.highcharts.common.hichartsclasses.HIAnnotation

public class HIAnnotation
extends HIFoundation

Constructor Summary

Constructors

Constructor and Description
HIAnnotation()

Method Summary

Modifier and Type	Method and Description
void	adjustLabelVisibility(HILabels item) Hide or show annotaiton attached to points.
void	adjustShapeVisibility(HIShapes item) Hide or show annotaiton attached to points.
void	destroy() Destroy the annotation.
void	destroyLabelItem(HILabels item) Destroy a single item.
void	destroyShapeItem(HIShapes item) Destroy a single item.
HISVGElement	getGroup()
HISVGElement	getLabelsGroup()
java.lang.Object	getOptions()
java.util.HashMap<java.lang.String,java.lang.Object>	getParams()
HISVGElement	getShapesGroup()
java.lang.Object	getUserOptions()
void	initLabel(HILabels item) Initialisation of a single label
void	initShape(HIShapes item) Initialisation of a single shape
void	redrawLabelItem(HILabels item) Redraw a single item.
void	redrawLabelItem(HILabels item, boolean animation) Redraw a single item.
void	redrawLabelItems(java.util.List<HILabels> items)
void	redrawLabelItems(java.util.List<HILabels> items, boolean animation)
void	redrawShapeItem(HIShapes item) Redraw a single item.
void	redrawShapeItem(HIShapes item, boolean animation) Redraw a single item.
void	redrawShapeItems(java.util.List<HIShapes> items)
void	redrawShapeItems(java.util.List<HIShapes> items, boolean animation)
void	remove() See HIAnnotations destroy() method
void	setGroup(HISVGElement group) The group svg element.
void	setLabelsGroup(HISVGElement labelsGroup) The group svg element of the annotation's labels.
void	setOptions() Set an annotation options.
void	setOptions(java.lang.Object options) The options for the annotations.
void	setShapesGroup(HISVGElement shapesGroup) The group svg element of the annotation's shapes.
void	setUserOptions(java.lang.Object userOptions) The user options for the annotations.
void	setVisibility() Set the annotation's visibility.
void	setVisibility(boolean visible) Set the annotation's visibility.

Methods inherited from class java.util.Observable

addObserver, countObservers, deleteObserver, deleteObservers, hasChanged, notifyObservers, notifyObservers

Methods inherited from class java.lang.Object

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

Constructor Detail

HIAnnotation

public HIAnnotation()

Method Detail

adjustLabelVisibility

public void adjustLabelVisibility(HILabels item)

Hide or show annotaiton attached to points.

adjustShapeVisibility

public void adjustShapeVisibility(HIShapes item)

Hide or show annotaiton attached to points.

destroy

public void destroy()

Destroy the annotation. This function does not touch the chart that the annotation belongs to (all annotations are kept in the chart.annotations array) - it is recommended to use HIChartView removeAnnotation() instead.

destroyLabelItem

public void destroyLabelItem(HILabels item)

Destroy a single item.

destroyShapeItem

public void destroyShapeItem(HIShapes item)

Destroy a single item.

getGroup

public HISVGElement getGroup()

getLabelsGroup

public HISVGElement getLabelsGroup()

getOptions

public java.lang.Object getOptions()

getParams

public java.util.HashMap<java.lang.String,java.lang.Object> getParams()

Specified by:

getParams in class HIFoundation

getShapesGroup

public HISVGElement getShapesGroup()

getUserOptions

public java.lang.Object getUserOptions()

initLabel

public void initLabel(HILabels item)

Initialisation of a single label

initShape

public void initShape(HIShapes item)

Initialisation of a single shape

Parameters:

item - a confg object for a single shape

redrawLabelItem

public void redrawLabelItem(HILabels item)

Redraw a single item.

redrawLabelItem

public void redrawLabelItem(HILabels item,
                            boolean animation)

Redraw a single item.

redrawLabelItems

public void redrawLabelItems(java.util.List<HILabels> items)

redrawLabelItems

public void redrawLabelItems(java.util.List<HILabels> items,
                             boolean animation)

redrawShapeItem

public void redrawShapeItem(HIShapes item)

Redraw a single item.

redrawShapeItem

public void redrawShapeItem(HIShapes item,
                            boolean animation)

Redraw a single item.

redrawShapeItems

public void redrawShapeItems(java.util.List<HIShapes> items)

redrawShapeItems

public void redrawShapeItems(java.util.List<HIShapes> items,
                             boolean animation)

remove

public void remove()

See HIAnnotations destroy() method

setGroup

public void setGroup(HISVGElement group)

The group svg element.

setLabelsGroup

public void setLabelsGroup(HISVGElement labelsGroup)

The group svg element of the annotation's labels.

setOptions

public void setOptions()

Set an annotation options.

setOptions

public void setOptions(java.lang.Object options)

The options for the annotations.

setShapesGroup

public void setShapesGroup(HISVGElement shapesGroup)

The group svg element of the annotation's shapes.

setUserOptions

public void setUserOptions(java.lang.Object userOptions)

The user options for the annotations.

setVisibility

public void setVisibility()

Set the annotation's visibility.

setVisibility

public void setVisibility(boolean visible)

Set the annotation's visibility.

Parameters:

visible - Whether to show or hide an annotation. If the param is omitted, the annotation's visibility is toggled.