HighchartsChartOptions class

General options for the chart.

API Docs: https://api.highcharts.com/highcharts/chart

Inheritance

Constructors

HighchartsChartOptions.new({bool? alignThresholds, bool? alignTicks, bool? allowMutatingData, dynamic animation, double? axisLayoutRuns, String? backgroundColor, String? borderColor, double? borderRadius, double? borderWidth, String? className, double? colorCount, bool? displayErrors, HighchartsChartEventsOptions? events, dynamic height, bool? ignoreHiddenSeries, bool? inverted, dynamic map, dynamic mapTransforms, List<double>? margin, double? marginBottom, double? marginLeft, double? marginRight, double? marginTop, dynamic numberFormatter, HighchartsChart3DOptions? options3d, String? panKey, HighchartsChartPanningOptions? panning, HighchartsChartParallelAxesOptions? parallelAxes, bool? parallelCoordinates, String? pinchType, String? plotBackgroundColor, String? plotBackgroundImage, String? plotBorderColor, double? plotBorderWidth, Map<String, dynamic>? plotShadow, bool? polar, dynamic proj4, bool? reflow, String? renderTo, HighchartsChartResetZoomButtonOptions? resetZoomButton, HighchartsChartScrollablePlotAreaOptions? scrollablePlotArea, Map<String, dynamic>? selectionMarkerFill, Map<String, dynamic>? shadow, bool? showAxes, List<double>? spacing, double? spacingBottom, double? spacingLeft, double? spacingRight, double? spacingTop, Map<String, String>? style, bool? styledMode, String? type, dynamic width, String? zoomKey, String? zoomType, HighchartsChartZoomingOptions? zooming})
General options for the chart.

Properties

alignThresholds ↔ bool?
When using multiple axes, align the thresholds. When this is true, other ticks will also be aligned.
getter/setter pair
alignTicks ↔ bool?
When using multiple axes, the ticks of two or more opposite axes will automatically be aligned by adding ticks to the axis or axes with the least ticks, as if tickAmount were specified.
getter/setter pair
allowMutatingData ↔ bool?
By default, (because of memory and performance reasons) the chart does not copy the data but keeps it as a reference. In some cases, this might result in mutating the original data source. In order to prevent that, set that property to false. Please note that changing that might decrease performance, especially with bigger sets of data.
getter/setter pair
animation ↔ dynamic
Set the overall animation for all chart updating. Animation can be disabled throughout the chart by setting it to false here. It can be overridden for each individual API method as a function parameter. The only animation not affected by this option is the initial series animation, see plotOptions.series.animation.
getter/setter pair
axisLayoutRuns ↔ double?
When a chart with an x and a y-axis is rendered, we first pre-render the labels of both in order to measure them. Then, if either of the axis labels take up so much space that it significantly affects the length of the other axis, we repeat the process.
getter/setter pair
backgroundColor ↔ String?
The background color or gradient for the outer chart area.
getter/setter pair
borderColor ↔ String?
The color of the outer chart border.
getter/setter pair
borderRadius ↔ double?
The corner radius of the outer chart border.
getter/setter pair
borderWidth ↔ double?
The pixel width of the outer chart border.
getter/setter pair
className ↔ String?
A CSS class name to apply to the charts container div, allowing unique CSS styling for each chart.
getter/setter pair
colorCount ↔ double?
In styled mode, this sets how many colors the class names should rotate between. With ten colors, series (or points) are given class names like highcharts-color-0, highcharts-color-1 ... highcharts-color-9. The equivalent in non-styled mode is to set colors using the colors setting.
getter/setter pair
displayErrors ↔ bool?
Whether to display errors on the chart. When false, the errors will be shown only in the console.
getter/setter pair
events ↔ HighchartsChartEventsOptions?
Event listeners for the chart.
getter/setter pair
hashCode → int
The hash code for this object.
no setterinherited
height ↔ dynamic
An explicit height for the chart. If a number, the height is given in pixels. If given a percentage string (for example '56%'), the height is given as the percentage of the actual chart width. This allows for preserving the aspect ratio across responsive sizes.
getter/setter pair
ignoreHiddenSeries ↔ bool?
If true, the axes will scale to the remaining visible series once one series is hidden. If false, hiding and showing a series will not affect the axes or the other series. For stacks, once one series within the stack is hidden, the rest of the stack will close in around it even if the axis is not affected.
getter/setter pair
inverted ↔ bool?
Whether to invert the axes so that the x axis is vertical and y axis is horizontal. When true, the x axis is reversed by default.
getter/setter pair
map ↔ dynamic
Default mapData for all series, in terms of a GeoJSON or TopoJSON object. If set to a string, it functions as an index into the Highcharts.maps array.
getter/setter pair
mapTransforms ↔ dynamic
Set lat/lon transformation definitions for the chart. If not defined, these are extracted from the map data.
getter/setter pair
margin ↔ List<double>?
The margin between the outer edge of the chart and the plot area. The numbers in the array designate top, right, bottom and left respectively. Use the options marginTop, marginRight, marginBottom and marginLeft for shorthand setting of one option.
getter/setter pair
marginBottom ↔ double?
The margin between the bottom outer edge of the chart and the plot area. Use this to set a fixed pixel value for the margin as opposed to the default dynamic margin. See also spacingBottom.
getter/setter pair
marginLeft ↔ double?
The margin between the left outer edge of the chart and the plot area. Use this to set a fixed pixel value for the margin as opposed to the default dynamic margin. See also spacingLeft.
getter/setter pair
marginRight ↔ double?
The margin between the right outer edge of the chart and the plot area. Use this to set a fixed pixel value for the margin as opposed to the default dynamic margin. See also spacingRight.
getter/setter pair
marginTop ↔ double?
The margin between the top outer edge of the chart and the plot area. Use this to set a fixed pixel value for the margin as opposed to the default dynamic margin. See also spacingTop.
getter/setter pair
numberFormatter ↔ dynamic
Callback function to override the default function that formats all the numbers in the chart. Returns a string with the formatted number.
getter/setter pair
options3d ↔ HighchartsChart3DOptions?
Options to render charts in 3 dimensions. This feature requires highcharts-3d.js, found in the download package or online at code.highcharts.com/highcharts-3d.js.
getter/setter pair
panKey ↔ String?
Allows setting a key to switch between zooming and panning. Can be one of alt, ctrl, meta (the command key on Mac and Windows key on Windows) or shift. The keys are mapped directly to the key properties of the click event argument (event.altKey, event.ctrlKey, event.metaKey and event.shiftKey).
getter/setter pair
panning ↔ HighchartsChartPanningOptions?
Allow panning in a chart. Best used with panKey to combine zooming and panning.
getter/setter pair
parallelAxes ↔ HighchartsChartParallelAxesOptions?
Common options for all yAxes rendered in a parallel coordinates plot. This feature requires modules/parallel-coordinates.js.
getter/setter pair
parallelCoordinates ↔ bool?
Flag to render charts as a parallel coordinates plot. In a parallel coordinates plot (||-coords) by default all required yAxes are generated and the legend is disabled. This feature requires modules/parallel-coordinates.js.
getter/setter pair
pinchType ↔ String?
Equivalent to zoomType, but for multitouch gestures only. By default, the pinchType is the same as the zoomType setting. However, pinching can be enabled separately in some cases, for example in stock charts where a mouse drag pans the chart, while pinching is enabled. When tooltip.followTouchMove is true, pinchType only applies to two-finger touches.
getter/setter pair
plotBackgroundColor ↔ String?
The background color or gradient for the plot area.
getter/setter pair
plotBackgroundImage ↔ String?
The URL for an image to use as the plot background. To set an image as the background for the entire chart, set a CSS background image to the container element. Note that for the image to be applied to exported charts, its URL needs to be accessible by the export server.
getter/setter pair
plotBorderColor ↔ String?
The color of the inner chart or plot area border.
getter/setter pair
plotBorderWidth ↔ double?
The pixel width of the plot area border.
getter/setter pair
plotShadow ↔ Map<String, dynamic>?
Whether to apply a drop shadow to the plot area. Requires that plotBackgroundColor be set. The shadow can be an object configuration containing color, offsetX, offsetY, opacity and width.
getter/setter pair
polar ↔ bool?
When true, cartesian charts like line, spline, area and column are transformed into the polar coordinate system. This produces polar charts, also known as radar charts.
getter/setter pair
proj4 ↔ dynamic
Allows to manually load the proj4 library from Highcharts options instead of the window. In case of loading the library from a script tag, this option is not needed, it will be loaded from there by default.
getter/setter pair
reflow ↔ bool?
Whether to reflow the chart to fit the width of the container div on resizing the window.
getter/setter pair
renderTo ↔ String?
The HTML element where the chart will be rendered. If it is a string, the element by that id is used. The HTML element can also be passed by direct reference, or as the first argument of the chart constructor, in which case the option is not needed.
getter/setter pair
resetZoomButton ↔ HighchartsChartResetZoomButtonOptions?
The button that appears after a selection zoom, allowing the user to reset zoom. This option is deprecated in favor of zooming.
getter/setter pair
runtimeType → Type
A representation of the runtime type of the object.
no setterinherited
scrollablePlotArea ↔ HighchartsChartScrollablePlotAreaOptions?
Options for a scrollable plot area. This feature provides a minimum size for the plot area of the chart. If the size gets smaller than this, typically on mobile devices, a native browser scrollbar is presented. This scrollbar provides smooth scrolling for the contents of the plot area, whereas the title, legend and unaffected axes are fixed.
getter/setter pair
selectionMarkerFill ↔ Map<String, dynamic>?
The background color of the marker square when selecting (zooming in on) an area of the chart.
getter/setter pair
shadow ↔ Map<String, dynamic>?
Whether to apply a drop shadow to the outer chart area. Requires that backgroundColor be set. The shadow can be an object configuration containing color, offsetX, offsetY, opacity and width.
getter/setter pair
showAxes ↔ bool?
Whether to show the axes initially. This only applies to empty charts where series are added dynamically, as axes are automatically added to cartesian series.
getter/setter pair
spacing ↔ List<double>?
The distance between the outer edge of the chart and the content, like title or legend, or axis title and labels if present. The numbers in the array designate top, right, bottom and left respectively. Use the options spacingTop, spacingRight, spacingBottom and spacingLeft options for shorthand setting of one option.
getter/setter pair
spacingBottom ↔ double?
The space between the bottom edge of the chart and the content (plot area, axis title and labels, title, subtitle or legend in top position).
getter/setter pair
spacingLeft ↔ double?
The space between the left edge of the chart and the content (plot area, axis title and labels, title, subtitle or legend in top position).
getter/setter pair
spacingRight ↔ double?
The space between the right edge of the chart and the content (plot area, axis title and labels, title, subtitle or legend in top position).
getter/setter pair
spacingTop ↔ double?
The space between the top edge of the chart and the content (plot area, axis title and labels, title, subtitle or legend in top position).
getter/setter pair
style ↔ Map<String, String>?
Additional CSS styles to apply inline to the container div and the root SVG.
getter/setter pair
styledMode ↔ bool?
Whether to apply styled mode. When in styled mode, no presentational attributes or CSS are applied to the chart SVG. Instead, CSS rules are required to style the chart. The default style sheet is available from https://code.highcharts.com/css/highcharts.css.
getter/setter pair
type ↔ String?
The default series type for the chart. Can be any of the chart types listed under plotOptions and series or can be a series provided by an additional module.
getter/setter pair
width ↔ dynamic
An explicit width for the chart. By default (when null) the width is calculated from the offset width of the containing element.
getter/setter pair
zooming ↔ HighchartsChartZoomingOptions?
Chart zooming options.
getter/setter pair
zoomKey ↔ String?
Set a key to hold when dragging to zoom the chart. This is useful to avoid zooming while moving points. Should be set different than chart.panKey.
getter/setter pair
zoomType ↔ String?
Decides in what dimensions the user can zoom by dragging the mouse. Can be one of x, y or xy.
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