java.lang.Object
- org.zkoss.chart.Optionable
- - org.zkoss.chart.Breadcrumbs

All Implemented Interfaces:

Serializable, OptionDataListener, org.zkoss.json.JSONAware
```
public class Breadcrumbs
extends Optionable
```
Options for the breadcrumbs, the navigation at the top leading the way up through the traversed levels.
All the options in this class support DynamicalAttribute.

Since:

10.2.1.0

Author:

jumperchen

See Also:

Serialized Form

Field Summary
- Fields inherited from class org.zkoss.chart.Optionable
  NOT_NULL_VALUE, options

Constructor Summary

Constructors
Constructor Description

Breadcrumbs()

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`Number`	`getButtonSpacing()`	Returns the default padding for each button and separator in each direction.
`<K,V> Map<K,V>`	`getButtonTheme()`	Returns the collection of attributes for the buttons.
`String`	`getFormat()`	Returns a format string for the breadcrumbs button.
`org.zkoss.json.JavaScriptValue`	`getFormatter()`	Returns the callback JavaScript function to format the breadcrumb text from scratch.
`Position`	`getPosition()`	Returns the position for the button row.
`String`	`getRelativeTo()`	What box to align the button to.
`Separator`	`getSeparator()`	Returns the options object for Breadcrumbs separator.
`<K,V> Map<K,V>`	`getStyle()`	Returns CSS styles for all breadcrumbs.
`Number`	`getZIndex()`	Returns the z index of the breadcrumbs group.
`boolean`	`isFloating()`	When the breadcrumbs are floating, the plot area will not move to make space for it.
`boolean`	`isRtl()`	Returns whether to reverse the order of buttons.
`boolean`	`isShowFullPath()`	Show full path or only a single button.
`boolean`	`isUseHTML()`	Returns whether to use HTML to render the breadcrumbs items texts.
`void`	`setButtonSpacing(Number buttonSpacing)`	Sets the default padding for each button and separator in each direction.
`void`	`setButtonTheme(String buttonTheme)`	Sets the collection of attributes for the buttons.
`<K,V> void`	`setButtonTheme(Map<K,V> buttonTheme)`	Sets the collection of attributes for the buttons.
`void`	`setFloating(boolean floating)`	When the breadcrumbs are floating, the plot area will not move to make space for it.
`void`	`setFormat(String format)`	Sets a format string for the breadcrumbs button.
`void`	`setFormatter(org.zkoss.json.JavaScriptValue formatter)`	Sets the callback JavaScript function to format the breadcrumb text from scratch.
`void`	`setPosition(Position position)`	Sets the position for the button row.
`void`	`setRelativeTo(String relativeTo)`	What box to align the button to.
`void`	`setRtl(boolean rtl)`	Returns whether to reverse the order of buttons.
`void`	`setSeparator(Separator separator)`	Sets the options object for Breadcrumbs separator.
`void`	`setShowFullPath(boolean showFullPath)`	Show full path or only a single button.
`void`	`setStyle(String style)`	Sets CSS styles for all breadcrumbs.
`<K,V> void`	`setStyle(Map<K,V> style)`	Sets CSS styles for all breadcrumbs.
`void`	`setUseHTML(boolean useHTML)`	Sets whether to use HTML to render the breadcrumbs items texts.
`void`	`setZIndex(Number zIndex)`	Sets the z index of the breadcrumbs group.

Methods inherited from class org.zkoss.chart.Optionable
addExtraAttr, addOptionDataListener, clearOptonDataListener, clone, containsKey, fireEvent, fireEvent, fireEvent, fireEvent, fireEvent, getAttr, getAttr, getClientState, getExtraAttr, merge, onChange, removeExtraAttr, removeKey, removeOptionDataListener, setAttr, setAttr, setAttr, setAttr, toJSONString, toString

Methods inherited from class java.lang.Object
equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

- Constructor Detail
  - Breadcrumbs
```
public Breadcrumbs()
```
- Method Detail
  - getButtonSpacing
```
public Number getButtonSpacing()
```
    Returns the default padding for each button and separator in each direction.
    Default: 5
  - setButtonSpacing
```
public void setButtonSpacing(Number buttonSpacing)
```
    Sets the default padding for each button and separator in each direction.
    Default: 5
  - getButtonTheme
```
public <K,V> Map<K,V> getButtonTheme()
```
    Returns the 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.
    Default: null
  - setButtonTheme
```
public void setButtonTheme(String buttonTheme)
```
    Sets the 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.
  - setButtonTheme
```
public <K,V> void setButtonTheme(Map<K,V> buttonTheme)
```
    Sets the 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.
  - isFloating
```
public boolean isFloating()
```
    When the breadcrumbs are floating, the plot area will not move to make space for it. By default, the chart will not make space for the buttons. This property won't work when positioned in the middle.
    Defaults to false.
  - setFloating
```
public void setFloating(boolean floating)
```
    When the breadcrumbs are floating, the plot area will not move to make space for it. By default, the chart will not make space for the buttons. This property won't work when positioned in the middle.
    Defaults to false.
  - getFormat
```
public String getFormat()
```
    Returns a format string for the breadcrumbs button. Variables are enclosed by curly brackets. Available values are passed in the declared point options.
    Default: null
  - setFormat
```
public void setFormat(String format)
```
    Sets a format string for the breadcrumbs button. Variables are enclosed by curly brackets. Available values are passed in the declared point options.
  - getFormatter
```
public org.zkoss.json.JavaScriptValue getFormatter()
```
    Returns the callback JavaScript function to format the breadcrumb text from scratch.
    Default: null
  - setFormatter
```
public void setFormatter(org.zkoss.json.JavaScriptValue formatter)
```
    Sets the callback JavaScript function to format the breadcrumb text from scratch.
    Default: null
  - getPosition
```
public Position getPosition()
```
    Returns the position for the button row. The breadcrumbs buttons will be aligned properly for the default chart layout (title, subtitle, legend, range selector) for the custom chart layout set the position properties.
    Default: null
  - setPosition
```
public void setPosition(Position position)
```
    Sets the position for the button row. The breadcrumbs buttons will be aligned properly for the default chart layout (title, subtitle, legend, range selector) for the custom chart layout set the position properties.
    Default: null
  - getRelativeTo
```
public String getRelativeTo()
```
    What box to align the button to. Can be either plotBox or spacingBox.
    Defaults to "plotBox".
  - setRelativeTo
```
public void setRelativeTo(String relativeTo)
```
    What box to align the button to. Can be either plotBox or spacingBox.
    Defaults to "plotBox".
  - isRtl
```
public boolean isRtl()
```
    Returns whether to reverse the order of buttons. This is common in Arabic and Hebrew.
    Defaults to false.
  - setRtl
```
public void setRtl(boolean rtl)
```
    Returns whether to reverse the order of buttons. This is common in Arabic and Hebrew.
    Defaults to false.
  - getSeparator
```
public Separator getSeparator()
```
    Returns the options object for Breadcrumbs separator.
    Default: null
  - setSeparator
```
public void setSeparator(Separator separator)
```
    Sets the options object for Breadcrumbs separator.
    Default: null
  - isShowFullPath
```
public boolean isShowFullPath()
```
    Show full path or only a single button.
    Default: true
  - setShowFullPath
```
public void setShowFullPath(boolean showFullPath)
```
    Show full path or only a single button.
    Default: true
  - getStyle
```
public <K,V> Map<K,V> getStyle()
```
    Returns CSS styles for all breadcrumbs.
    Default: null
  - setStyle
```
public void setStyle(String style)
```
    Sets CSS styles for all breadcrumbs.
    Default: null
  - setStyle
```
public <K,V> void setStyle(Map<K,V> style)
```
    Sets CSS styles for all breadcrumbs.
    Default: null
  - isUseHTML
```
public boolean isUseHTML()
```
    Returns whether to use HTML to render the breadcrumbs items texts.
    Default: false.
  - setUseHTML
```
public void setUseHTML(boolean useHTML)
```
    Sets whether to use HTML to render the breadcrumbs items texts.
    Default: false.
  - getZIndex
```
public Number getZIndex()
```
    Returns the z index of the breadcrumbs group.
    Default: 7
  - setZIndex
```
public void setZIndex(Number zIndex)
```
    Sets the z index of the breadcrumbs group.
    Default: 7

Class Breadcrumbs

Field Summary

Fields inherited from class org.zkoss.chart.Optionable

Constructor Summary

Method Summary

Methods inherited from class org.zkoss.chart.Optionable

Methods inherited from class java.lang.Object

Constructor Detail

Breadcrumbs

Method Detail

getButtonSpacing

setButtonSpacing

getButtonTheme

setButtonTheme

setButtonTheme

isFloating

setFloating

getFormat

setFormat

getFormatter

setFormatter

getPosition

setPosition

getRelativeTo

setRelativeTo

isRtl

setRtl

getSeparator

setSeparator

isShowFullPath

setShowFullPath

getStyle

setStyle

setStyle

isUseHTML

setUseHTML

getZIndex

setZIndex