com.highsoft.highcharts.common.hichartsclasses

Class HICaption

java.lang.Object

java.util.Observable

com.highsoft.highcharts.core.HIFoundation

com.highsoft.highcharts.common.hichartsclasses.HICaption

public class HICaption
extends HIFoundation

Constructor Summary

Constructors

Constructor and Description
HICaption()

Method Summary

Modifier and Type	Method and Description
java.lang.String	getAlign()
java.lang.Boolean	getFloating()
java.lang.Number	getMargin()
java.util.HashMap<java.lang.String,java.lang.Object>	getParams()
HICSSObject	getStyle()
java.lang.String	getText()
java.lang.Boolean	getUseHTML()
java.lang.String	getVerticalAlign()
java.lang.Number	getX()
java.lang.Number	getY()
void	setAlign(java.lang.String align) The horizontal alignment of the caption.
void	setFloating(java.lang.Boolean floating) When the caption is floating, the plot area will not move to make space for it.
void	setMargin(java.lang.Number margin) The margin between the caption and the plot area.
void	setStyle(HICSSObject style) CSS styles for the caption.
void	setText(java.lang.String text) The caption text of the chart.
void	setUseHTML(java.lang.Boolean useHTML) Whether to [use HTML](https://www.highcharts.com/docs/chart-concepts/labels-and-string-formatting#html) to render the text.
void	setVerticalAlign(java.lang.String verticalAlign) The vertical alignment of the caption.
void	setX(java.lang.Number x) The x position of the caption relative to the alignment within `chart.spacingLeft` and `chart.spacingRight`.
void	setY(java.lang.Number y) The y position of the caption relative to the alignment within `chart.spacingTop` and `chart.spacingBottom`.

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

HICaption

public HICaption()

Method Detail

getAlign

public java.lang.String getAlign()

getFloating

public java.lang.Boolean getFloating()

getMargin

public java.lang.Number getMargin()

getParams

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

Specified by:

getParams in class HIFoundation

getStyle

public HICSSObject getStyle()

getText

public java.lang.String getText()

getUseHTML

public java.lang.Boolean getUseHTML()

getVerticalAlign

public java.lang.String getVerticalAlign()

getX

public java.lang.Number getX()

getY

public java.lang.Number getY()

setAlign

public void setAlign(java.lang.String align)

The horizontal alignment of the caption. Can be one of "left", "center" and "right".

defaults:

 left

setFloating

public void setFloating(java.lang.Boolean floating)

When the caption is floating, the plot area will not move to make space for it.

defaults:

 false

setMargin

public void setMargin(java.lang.Number margin)

The margin between the caption and the plot area.

defaults:

 15

setStyle

public void setStyle(HICSSObject style)

CSS styles for the caption. In styled mode, the caption style is given in the `.highcharts-caption` class.

defaults:

 {"color": "#666666"}

setText

public void setText(java.lang.String text)

The caption text of the chart.

setUseHTML

public void setUseHTML(java.lang.Boolean useHTML)

Whether to [use HTML](https://www.highcharts.com/docs/chart-concepts/labels-and-string-formatting#html) to render the text.

defaults:

 false

setVerticalAlign

public void setVerticalAlign(java.lang.String verticalAlign)

The vertical alignment of the caption. Can be one of `"top"`, `"middle"` and `"bottom"`. When middle, the caption behaves as floating.

defaults:

 bottom

setX

public void setX(java.lang.Number x)

The x position of the caption relative to the alignment within `chart.spacingLeft` and `chart.spacingRight`.

defaults:

 0

setY

public void setY(java.lang.Number y)

The y position of the caption relative to the alignment within `chart.spacingTop` and `chart.spacingBottom`.