HighchartsTreemapSeriesBreadcrumbsOptions class
Options for the breadcrumbs, the navigation at the top leading the way up through the traversed levels.
API Docs: https://api.highcharts.com/highcharts/series.treemap.breadcrumbs
- Inheritance
-
- Object
- HighchartsOptionsBase
- HighchartsTreemapSeriesBreadcrumbsOptions
Constructors
- HighchartsTreemapSeriesBreadcrumbsOptions.new({double? buttonSpacing, HighchartsNavigationBreadcrumbsButtonThemeOptions? buttonTheme, HighchartsNavigationBreadcrumbsEventsOptions? events, bool? floating, String? format, dynamic formatter, HighchartsNavigationBreadcrumbsPositionOptions? position, String? relativeTo, bool? rtl, HighchartsNavigationBreadcrumbsSeparatorOptions? separator, bool? showFullPath, dynamic style, bool? useHTML, double? zIndex})
- Options for the breadcrumbs, the navigation at the top leading the way up through the traversed levels.
Properties
-
The default padding for each button and separator in each direction.
getter/setter pair
-
A collection of attributes for the buttons. The object takes SVG
attributes like
fill
,stroke
,stroke-width
, as well asstyle
, a collection of CSS properties for the text.getter/setter pair - events ↔ HighchartsNavigationBreadcrumbsEventsOptions?
-
Highcharts Options Widget.
getter/setter pair
- floating ↔ bool?
-
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.
getter/setter pair
- format ↔ String?
-
A format string for the breadcrumbs button. Variables are enclosed by
curly brackets. Available values are passed in the declared point
options.
getter/setter pair
- formatter ↔ dynamic
-
Callback function to format the breadcrumb text from scratch.
getter/setter pair
- hashCode → int
-
The hash code for this object.
no setterinherited
- position ↔ HighchartsNavigationBreadcrumbsPositionOptions?
-
Positioning 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.
getter/setter pair
- relativeTo ↔ String?
-
What box to align the button to. Can be either
plotBox
orspacingBox
.getter/setter pair - rtl ↔ bool?
-
Whether to reverse the order of buttons. This is common in Arabic
and Hebrew.
getter/setter pair
- runtimeType → Type
-
A representation of the runtime type of the object.
no setterinherited
- separator ↔ HighchartsNavigationBreadcrumbsSeparatorOptions?
-
Options object for Breadcrumbs separator.
getter/setter pair
- showFullPath ↔ bool?
-
Show full path or only a single button.
getter/setter pair
- style ↔ dynamic
-
CSS styles for all breadcrumbs.
getter/setter pair
- useHTML ↔ bool?
-
Whether to use HTML to render the breadcrumbs items texts.
getter/setter pair
- zIndex ↔ double?
-
The z index of the breadcrumbs group.
getter/setter pair
Methods
-
noSuchMethod(
Invocation invocation) → dynamic -
Invoked when a nonexistent method or property is accessed.
inherited
-
toJSON(
) → String -
Serializes the settings to a JSON string.
inherited
-
toOptionsJSON(
StringBuffer buffer) → void -
override
-
toString(
) → String -
A string representation of this object.
inherited
Operators
-
operator ==(
Object other) → bool -
The equality operator.
inherited