HighchartsExportingButtonsContextButtonOptions class

Options for the export button.

In styled mode, export button styles can be applied with the .highcharts-contextbutton class.

API Docs: https://api.highcharts.com/highcharts/exporting.buttons.contextButton

Inheritance

Constructors

HighchartsExportingButtonsContextButtonOptions.new({String? className, String? menuClassName, List<String>? menuItems, dynamic onclick, String? symbol, String? symbolFill, String? titleKey, double? x, String? align, double? buttonSpacing, bool? enabled, double? height, double? symbolSize, String? symbolStroke, double? symbolStrokeWidth, double? symbolX, double? symbolY, String? text, HighchartsNavigationButtonThemeOptions? theme, bool? useHTML, String? verticalAlign, double? width, double? y})
Options for the export button.

Properties

align ↔ String?
Alignment for the buttons.
getter/setter pair
buttonSpacing ↔ double?
The pixel spacing between buttons, and between the context button and the title.
getter/setter pair
className ↔ String?
The class name of the context button.
getter/setter pair
enabled ↔ bool?
Whether to enable buttons.
getter/setter pair
hashCode → int
The hash code for this object.
no setterinherited
height ↔ double?
Pixel height of the buttons.
getter/setter pair
The class name of the menu appearing from the button.
getter/setter pair
A collection of strings pointing to config options for the menu items. The config options are defined in the menuItemDefinitions option.
getter/setter pair
onclick ↔ dynamic
A click handler callback to use on the button directly instead of the popup menu.
getter/setter pair
runtimeType → Type
A representation of the runtime type of the object.
no setterinherited
symbol ↔ String?
The symbol for the button. Points to a definition function in the Highcharts.Renderer.symbols collection. The default menu function is part of the exporting module. Possible values are "circle", "square", "diamond", "triangle", "triangle-down", "menu", "menuball" or custom shape.
getter/setter pair
symbolFill ↔ String?
See navigation.buttonOptions.symbolFill.
getter/setter pair
symbolSize ↔ double?
The pixel size of the symbol on the button.
getter/setter pair
symbolStroke ↔ String?
The color of the symbol's stroke or line.
getter/setter pair
symbolStrokeWidth ↔ double?
The pixel stroke width of the symbol on the button.
getter/setter pair
symbolX ↔ double?
The x position of the center of the symbol inside the button.
getter/setter pair
symbolY ↔ double?
The y position of the center of the symbol inside the button.
getter/setter pair
text ↔ String?
A text string to add to the individual button.
getter/setter pair
theme ↔ HighchartsNavigationButtonThemeOptions?
A configuration object for the button theme. The object accepts SVG properties like stroke-width, stroke and fill. Tri-state button styles are supported by the states.hover and states.select objects.
getter/setter pair
titleKey ↔ String?
The key to a lang option setting that is used for the button's title tooltip. When the key is contextButtonTitle, it refers to lang.contextButtonTitle that defaults to "Chart context menu".
getter/setter pair
useHTML ↔ bool?
Whether to use HTML for rendering the button. HTML allows for things like inline CSS or image-based icons.
getter/setter pair
verticalAlign ↔ String?
The vertical alignment of the buttons. Can be one of "top", "middle" or "bottom".
getter/setter pair
width ↔ double?
The pixel width of the button.
getter/setter pair
x ↔ double?
The horizontal position of the button relative to the align option.
getter/setter pair
y ↔ double?
The vertical offset of the button's position relative to its verticalAlign. By default adjusted for the chart title alignment.
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