com.highsoft.highcharts.common.hichartsclasses

Class HIBreadcrumbs

java.lang.Object

java.util.Observable

com.highsoft.highcharts.core.HIFoundation

com.highsoft.highcharts.common.hichartsclasses.HIBreadcrumbs

public class HIBreadcrumbs
extends HIFoundation

Constructor Summary

Constructors

Constructor and Description
HIBreadcrumbs()

Method Summary

Modifier and Type	Method and Description
java.lang.Number	getButtonSpacing()
HISVGAttributes	getButtonTheme()
HIEvents	getEvents()
java.lang.Boolean	getFloating()
java.lang.String	getFormat()
HIFunction	getFormatter()
java.util.HashMap<java.lang.String,java.lang.Object>	getParams()
HIBreadcrumbsAlignOptions	getPosition()
java.lang.String	getRelativeTo()
java.lang.Boolean	getRtl()
HISeparator	getSeparator()
java.lang.Boolean	getShowFullPath()
HISVGAttributes	getStyle()
java.lang.Boolean	getUseHTML()
java.lang.Number	getZIndex()
void	setButtonSpacing(java.lang.Number buttonSpacing) The defaults padding for each button and separator in each direction.
void	setButtonTheme(HISVGAttributes buttonTheme) A collection of attributes for the buttons.
void	setEvents(HIEvents events)
void	setFloating(java.lang.Boolean floating) When the breadcrumbs are floating, the plot area will not move to make space for it.
void	setFormat(java.lang.String format) A format string for the breadcrumbs button.
void	setFormatter(HIFunction formatter) Callback function to format the breadcrumb text from scratch.
void	setPosition(HIBreadcrumbsAlignOptions position) Positioning for the button row.
void	setRelativeTo(java.lang.String relativeTo) What box to align the button to.
void	setRtl(java.lang.Boolean rtl) Whether to reverse the order of buttons.
void	setSeparator(HISeparator separator) Options object for Breadcrumbs separator.
void	setShowFullPath(java.lang.Boolean showFullPath) Show full path or only a single button.
void	setStyle(HISVGAttributes style) CSS styles for all breadcrumbs.
void	setUseHTML(java.lang.Boolean useHTML) Whether to use HTML to render the breadcrumbs items texts.
void	setZIndex(java.lang.Number zIndex) The z index of the breadcrumbs group.

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

HIBreadcrumbs

public HIBreadcrumbs()

Method Detail

getButtonSpacing

public java.lang.Number getButtonSpacing()

getButtonTheme

public HISVGAttributes getButtonTheme()

getEvents

public HIEvents getEvents()

getFloating

public java.lang.Boolean getFloating()

getFormat

public java.lang.String getFormat()

getFormatter

public HIFunction getFormatter()

getParams

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

Specified by:

getParams in class HIFoundation

getPosition

public HIBreadcrumbsAlignOptions getPosition()

getRelativeTo

public java.lang.String getRelativeTo()

getRtl

public java.lang.Boolean getRtl()

getSeparator

public HISeparator getSeparator()

getShowFullPath

public java.lang.Boolean getShowFullPath()

getStyle

public HISVGAttributes getStyle()

getUseHTML

public java.lang.Boolean getUseHTML()

getZIndex

public java.lang.Number getZIndex()

setButtonSpacing

public void setButtonSpacing(java.lang.Number buttonSpacing)

The defaults padding for each button and separator in each direction.

defaults:

 5

setButtonTheme

public void setButtonTheme(HISVGAttributes buttonTheme)

A collection of attributes for the buttons. The object takes SVG attributes like `fill`, `stroke`, `stroke-width`, as well as `style`, a collection of CSS properties for the text. The object can also be extended with states, so you can set presentational options for `hover`, `select` or `disabled` button states.

setEvents

public void setEvents(HIEvents events)

setFloating

public void setFloating(java.lang.Boolean floating)

When the breadcrumbs are floating, the plot area will not move to make space for it. By defaults, the chart will not make space for the buttons. This property won't work when positioned in the middle.

setFormat

public void setFormat(java.lang.String format)

A format string for the breadcrumbs button. Variables are enclosed by curly brackets. Available values are passed in the declared point options.

defaults:

 undefined

setFormatter

public void setFormatter(HIFunction formatter)

Callback function to format the breadcrumb text from scratch.

defaults:

 undefined

setPosition

public void setPosition(HIBreadcrumbsAlignOptions position)

Positioning for the button row. The breadcrumbs buttons will be aligned properly for the defaults chart layout (title, subtitle, legend, range selector) for the custom chart layout set the position properties.

setRelativeTo

public void setRelativeTo(java.lang.String relativeTo)

What box to align the button to. Can be either `plotBox` or `spacingBox`.

defaults:

 plotBox

setRtl

public void setRtl(java.lang.Boolean rtl)

Whether to reverse the order of buttons. This is common in Arabic and Hebrew.

setSeparator

public void setSeparator(HISeparator separator)

Options object for Breadcrumbs separator.

setShowFullPath

public void setShowFullPath(java.lang.Boolean showFullPath)

Show full path or only a single button.

defaults:

 True

setStyle

public void setStyle(HISVGAttributes style)

CSS styles for all breadcrumbs. In styled mode, the breadcrumbs buttons are styled by the `.highcharts-breadcrumbs-buttons .highcharts-button` rule with its different states.

setUseHTML

public void setUseHTML(java.lang.Boolean useHTML)

Whether to use HTML to render the breadcrumbs items texts.

setZIndex

public void setZIndex(java.lang.Number zIndex)

The z index of the breadcrumbs group.

defaults:

 7