com.highsoft.highcharts.common.hichartsclasses

Class HIStackLabels

java.lang.Object

java.util.Observable

com.highsoft.highcharts.core.HIFoundation

com.highsoft.highcharts.common.hichartsclasses.HIStackLabels

public class HIStackLabels
extends HIFoundation

Constructor Summary

Constructors

Constructor and Description
HIStackLabels()

Method Summary

Modifier and Type	Method and Description
java.lang.String	getAlign()
java.lang.Boolean	getAllowOverlap()
HIAnimationOptionsObject	getAnimation()
HIColor	getBackgroundColor()
HIColor	getBorderColor()
java.lang.Number	getBorderRadius()
java.lang.Number	getBorderWidth()
java.lang.Boolean	getCrop()
java.lang.Boolean	getEnabled()
java.lang.String	getFormat()
HIFunction	getFormatter()
java.lang.String	getOverflow()
java.util.HashMap<java.lang.String,java.lang.Object>	getParams()
java.lang.Number	getRotation()
HICSSObject	getStyle()
java.lang.String	getTextAlign()
java.lang.Boolean	getUseHTML()
java.lang.String	getVerticalAlign()
java.lang.Number	getX()
java.lang.Number	getY()
void	setAlign(java.lang.String align) Defines the horizontal alignment of the stack total label.
void	setAllowOverlap(java.lang.Boolean allowOverlap) Allow the stack labels to overlap.
void	setAnimation(HIAnimationOptionsObject animation) Enable or disable the initial animation when a series is displayed for the `stackLabels`.
void	setBackgroundColor(HIColor backgroundColor) The background color or gradient for the stack label.
void	setBorderColor(HIColor borderColor) The border color for the stack label.
void	setBorderRadius(java.lang.Number borderRadius) The border radius in pixels for the stack label.
void	setBorderWidth(java.lang.Number borderWidth) The border width in pixels for the stack label.
void	setCrop(java.lang.Boolean crop) Whether to hide stack labels that are outside the plot area.
void	setEnabled(java.lang.Boolean enabled) Enable or disable the stack total labels.
void	setFormat(java.lang.String format) A format string for the data label.
void	setFormatter(HIFunction formatter) Callback JavaScript function to format the label.
void	setOverflow(java.lang.String overflow) How to handle stack total labels that flow outside the plot area.
void	setRotation(java.lang.Number rotation) Rotation of the labels in degrees.
void	setStyle(HICSSObject style) CSS styles for the label.
void	setTextAlign(java.lang.String textAlign) The text alignment for the label.
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 labels.
void	setVerticalAlign(java.lang.String verticalAlign) Defines the vertical alignment of the stack total label.
void	setX(java.lang.Number x) The x position offset of the label relative to the left of the stacked bar.
void	setY(java.lang.Number y) The y position offset of the label relative to the tick position on the axis.

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

HIStackLabels

public HIStackLabels()

Method Detail

getAlign

public java.lang.String getAlign()

getAllowOverlap

public java.lang.Boolean getAllowOverlap()

getAnimation

public HIAnimationOptionsObject getAnimation()

getBackgroundColor

public HIColor getBackgroundColor()

getBorderColor

public HIColor getBorderColor()

getBorderRadius

public java.lang.Number getBorderRadius()

getBorderWidth

public java.lang.Number getBorderWidth()

getCrop

public java.lang.Boolean getCrop()

getEnabled

public java.lang.Boolean getEnabled()

getFormat

public java.lang.String getFormat()

getFormatter

public HIFunction getFormatter()

getOverflow

public java.lang.String getOverflow()

getParams

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

Specified by:

getParams in class HIFoundation

getRotation

public java.lang.Number getRotation()

getStyle

public HICSSObject getStyle()

getTextAlign

public java.lang.String getTextAlign()

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)

Defines the horizontal alignment of the stack total label. Can be one of `"left"`, `"center"` or `"right"`. The defaults value is calculated at runtime and depends on orientation and whether the stack is positive or negative.

setAllowOverlap

public void setAllowOverlap(java.lang.Boolean allowOverlap)

Allow the stack labels to overlap.

setAnimation

public void setAnimation(HIAnimationOptionsObject animation)

Enable or disable the initial animation when a series is displayed for the `stackLabels`. The animation can also be set as a configuration object. Please note that this option only applies to the initial animation. For other animations, see `chart.animation` and the animation parameter under the API methods. The following properties are supported: - `defer`: The animation delay time in milliseconds.

setBackgroundColor

public void setBackgroundColor(HIColor backgroundColor)

The background color or gradient for the stack label.

setBorderColor

public void setBorderColor(HIColor borderColor)

The border color for the stack label. Defaults to `undefined`.

setBorderRadius

public void setBorderRadius(java.lang.Number borderRadius)

The border radius in pixels for the stack label.

defaults:

 0

setBorderWidth

public void setBorderWidth(java.lang.Number borderWidth)

The border width in pixels for the stack label.

defaults:

 0

setCrop

public void setCrop(java.lang.Boolean crop)

Whether to hide stack labels that are outside the plot area. By defaults, the stack label is moved inside the plot area according to the `overflow` option.

defaults:

 True

setEnabled

public void setEnabled(java.lang.Boolean enabled)

Enable or disable the stack total labels.

setFormat

public void setFormat(java.lang.String format)

A format string for the data label. Available variables are the same as for `formatter`.

defaults:

 {total}

setFormatter

public void setFormatter(HIFunction formatter)

Callback JavaScript function to format the label. The value is given by `this.total`.

setOverflow

public void setOverflow(java.lang.String overflow)

How to handle stack total labels that flow outside the plot area. The defaults is set to `"justify"`, which aligns them inside the plot area. For columns and bars, this means it will be moved inside the bar. To display stack labels outside the plot area, set `crop` to `false` and `overflow` to `"allow"`.

defaults:

 justify

setRotation

public void setRotation(java.lang.Number rotation)

Rotation of the labels in degrees.

defaults:

 0

setStyle

public void setStyle(HICSSObject style)

CSS styles for the label. In styled mode, the styles are set in the `.highcharts-stack-label` class.

setTextAlign

public void setTextAlign(java.lang.String textAlign)

The text alignment for the label. While `align` determines where the texts anchor point is placed with regards to the stack, `textAlign` determines how the text is aligned against its anchor point. Possible values are `"left"`, `"center"` and `"right"`. The defaults value is calculated at runtime and depends on orientation and whether the stack is positive or negative.

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 labels.

defaults:

 false

setVerticalAlign

public void setVerticalAlign(java.lang.String verticalAlign)

Defines the vertical alignment of the stack total label. Can be one of `"top"`, `"middle"` or `"bottom"`. The defaults value is calculated at runtime and depends on orientation and whether the stack is positive or negative.

setX

public void setX(java.lang.Number x)

The x position offset of the label relative to the left of the stacked bar. The defaults value is calculated at runtime and depends on orientation and whether the stack is positive or negative.

setY

public void setY(java.lang.Number y)

The y position offset of the label relative to the tick position on the axis. The defaults value is calculated at runtime and depends on orientation and whether the stack is positive or negative.