Package com.vaadin.flow.component.charts.model

Class Breadcrumbs

java.lang.Object
com.vaadin.flow.component.charts.model.AbstractConfigurationObject
com.vaadin.flow.component.charts.model.Breadcrumbs
All Implemented Interfaces:
Serializable
public class Breadcrumbs extends AbstractConfigurationObject
Options for the breadcrumbs, the navigation at the top leading the way up through the drilldown levels.
See Also:

  • Constructor Details

    • Breadcrumbs

      public Breadcrumbs()

  • Method Details

    • getButtonSpacing

      public Number getButtonSpacing()
      Returns:
      The space between individual breadcrumb buttons in pixels.

    • setButtonSpacing

      public void setButtonSpacing(Number buttonSpacing)
      Sets the space between individual breadcrumb buttons in pixels.

    • getButtonTheme

      public ButtonTheme getButtonTheme()
      Returns:
      Theme options for the breadcrumb buttons.

    • setButtonTheme

      public void setButtonTheme(ButtonTheme buttonTheme)
      Sets theme options for the breadcrumb buttons.

    • isFloating

      public Boolean isFloating()
      Returns:
      Whether the breadcrumbs should float above the chart.

    • setFloating

      public void setFloating(Boolean floating)
      Sets whether the breadcrumbs should float above the chart.

    • getFormat

      public String getFormat()
      Returns:
      Format string for the breadcrumb text.

    • setFormat

      public void setFormat(String format)
      Sets the format string for the breadcrumb text.

    • getFormatter

      public String getFormatter()
      Returns:
      Custom JavaScript formatter function for breadcrumb text.

    • setFormatter

      public void setFormatter(String formatter)
      Sets a custom JavaScript formatter function for breadcrumb text.

    • getPosition

      public BreadcrumbsPosition getPosition()
      Returns:
      Positioning options for the breadcrumbs navigation.

    • setPosition

      public void setPosition(BreadcrumbsPosition position)
      Sets positioning options for the breadcrumbs navigation.

    • getRelativeTo

      public ButtonRelativeTo getRelativeTo()
      Returns:
      What box to align the breadcrumbs to.

    • setRelativeTo

      public void setRelativeTo(ButtonRelativeTo relativeTo)
      Sets what box to align the breadcrumbs to.

    • isRtl

      public Boolean isRtl()
      Returns:
      Whether to use right-to-left text direction.

    • setRtl

      public void setRtl(Boolean rtl)
      Sets whether to use right-to-left text direction.

    • getSeparator

      public Separator getSeparator()
      Returns the separator configuration for breadcrumbs, which defines the visual separator between breadcrumb items.
      Returns:
      the separator configuration

    • setSeparator

      public void setSeparator(Separator separator)
      Sets the separator configuration for breadcrumbs, which defines the visual separator between breadcrumb items.
      Parameters:
      separator - the separator configuration

    • isShowFullPath

      public Boolean isShowFullPath()
      Returns whether the full path should be shown in breadcrumbs, including all drilldown levels.
      Returns:
      true if full path is shown, false otherwise

    • setShowFullPath

      public void setShowFullPath(Boolean showFullPath)
      Sets whether the full path should be shown in breadcrumbs, including all drilldown levels.
      Parameters:
      showFullPath - true to show full path, false otherwise

    • getStyle

      public Style getStyle()
      Returns the CSS styles for the breadcrumb text. This can be used to customize font, color, spacing, and other visual aspects of the breadcrumb labels.
      Returns:
      the style configuration for breadcrumb text

    • setStyle

      public void setStyle(Style style)
      Sets the CSS styles for the breadcrumb text. This can be used to customize font, color, spacing, and other visual aspects of the breadcrumb labels.
      Parameters:
      style - the style configuration for breadcrumb text

    • isUseHTML

      public Boolean isUseHTML()
      Returns whether to use HTML to render the breadcrumb labels.
      Returns:
      true if HTML is used, false otherwise

    • setUseHTML

      public void setUseHTML(Boolean useHTML)
      Sets whether to use HTML to render the breadcrumb labels.
      Parameters:
      useHTML - true to use HTML, false otherwise

    • getzIndex

      public Number getzIndex()
      Returns the z-index for the breadcrumbs navigation, controlling its stacking order.
      Returns:
      the z-index value

    • setzIndex

      public void setzIndex(Number zIndex)
      Sets the z-index for the breadcrumbs navigation, controlling its stacking order.
      Parameters:
      zIndex - the z-index value