HighchartsOptionsJSON class
Properties
-
accessibility
↔ HighchartsAccessibilityOptions?
-
Options for configuring accessibility for the chart. Requires the
accessibility module
to be loaded. For a description of the module and information
on its features, see
Highcharts Accessibility.
getter/setter pairinherited
-
annotations
↔ List<HighchartsAnnotationsOptions>?
-
A collection of annotations to add to the chart. The basic annotation allows
adding custom labels or shapes. The items can be tied to points, axis
coordinates or chart pixel coordinates.
getter/setter pairinherited
-
boost
↔ HighchartsBoostOptions?
-
Options for the Boost module. The Boost module allows certain series types
to be rendered by WebGL instead of the default SVG. This allows hundreds of
thousands of data points to be rendered in milliseconds. In addition to the
WebGL rendering it saves time by skipping processing and inspection of the
data wherever possible. This introduces some limitations to what features are
available in boost mode. See the docs for
details.
getter/setter pairinherited
-
caption
↔ HighchartsCaptionOptions?
-
The chart's caption, which will render below the chart and will be part
of exported charts. The caption can be updated after chart initialization
through the
Chart.update or Chart.caption.update methods.
getter/setter pairinherited
-
chart
↔ HighchartsChartOptions?
-
General options for the chart.
getter/setter pairinherited
-
colorAxis
↔ List<HighchartsColorAxisOptions>?
-
A color axis for series. Visually, the color
axis will appear as a gradient or as separate items inside the
legend, depending on whether the axis is scalar or based on data
classes.
getter/setter pairinherited
-
colors
↔ List?
-
An array containing the default colors for the chart's series. When
all colors are used, new colors are pulled from the start again.
getter/setter pairinherited
-
connectors
↔ HighchartsConnectorsOptions?
-
The Pathfinder module allows you to define connections between any two
points, represented as lines - optionally with markers for the start
and/or end points. Multiple algorithms are available for calculating how
the connecting lines are drawn.
getter/setter pairinherited
-
credits
↔ HighchartsCreditsOptions?
-
Highchart by default puts a credits label in the lower right corner
of the chart. This can be changed using these options.
getter/setter pairinherited
-
data
↔ HighchartsDataOptions?
-
The Data module provides a simplified interface for adding data to
a chart from sources like CVS, HTML tables or grid views. See also
the tutorial article on the Data module.
getter/setter pairinherited
-
defs
↔ HighchartsDefsOptions?
-
Options for configuring markers for annotations.
getter/setter pairinherited
-
drilldown
↔ HighchartsDrilldownOptions?
-
Options for drill down, the concept of inspecting increasingly high
resolution data through clicking on chart items like columns or pie slices.
getter/setter pairinherited
-
exporting
↔ HighchartsExportingOptions?
-
Options for the exporting module. For an overview on the matter, see
the docs and
read our Fair Usage Policy.
getter/setter pairinherited
-
global
↔ HighchartsGlobalOptions?
-
Global options that don't apply to each chart. These options must be set
using the
Highcharts.setOptions method.
getter/setter pairinherited
-
hashCode
→ int
-
The hash code for this object.
no setterinherited
-
json
↔ Map<String, dynamic>
-
getter/setter pair
-
jsonOverrides
→ Map<String, dynamic>
-
no setter
-
lang
↔ HighchartsLangOptions?
-
An object containing language-related strings and settings. A typical setup
uses
Highcharts.setOptions to make the options apply to all charts in the
same page.
getter/setter pairinherited
-
legend
↔ HighchartsLegendOptions?
-
The legend is a box containing a symbol and name for each series
item or point item in the chart. Each series (or points in case
of pie charts) is represented by a symbol and its name in the legend.
getter/setter pairinherited
-
loading
↔ HighchartsLoadingOptions?
-
The loading options control the appearance of the loading screen
that covers the plot area on chart operations. This screen only
appears after an explicit call to
chart.showLoading(). It is a
utility for developers to communicate to the end user that something
is going on, for example while retrieving new data via an XHR connection.
The "Loading..." text itself is not part of this configuration
object, but part of the lang object.
getter/setter pairinherited
-
mapNavigation
↔ HighchartsMapNavigationOptions?
-
The
mapNavigation option handles buttons for navigation in addition to
mousewheel and doubleclick handlers for map zooming.
getter/setter pairinherited
-
mapView
↔ HighchartsMapViewOptions?
-
The
mapView options control the initial view of the chart, and how
projection is set up for raw geoJSON maps (beta as of v9.3).
getter/setter pairinherited
-
navigation
↔ HighchartsNavigationOptions?
-
A collection of options for buttons and menus appearing in the exporting
module or in Stock Tools.
getter/setter pairinherited
-
navigator
↔ HighchartsNavigatorOptions?
-
The navigator is a small series below the main series, displaying
a view of the entire data set. It provides tools to zoom in and
out on parts of the data as well as panning across the dataset.
getter/setter pairinherited
-
noData
↔ HighchartsNoDataOptions?
-
Options for displaying a message like "No data to display".
This feature requires the file no-data-to-display.js to be loaded in the
page. The actual text to display is set in the lang.noData option.
getter/setter pairinherited
-
pane
↔ List<HighchartsPaneOptions>?
-
The pane serves as a container for axes and backgrounds for circular
gauges and polar charts.
getter/setter pairinherited
-
plotOptions
↔ HighchartsPlotOptions?
-
The plotOptions is a wrapper object for config objects for each series
type. The config objects for each series can also be overridden for
each series item as given in the series array.
getter/setter pairinherited
-
rangeSelector
↔ HighchartsRangeSelectorOptions?
-
The range selector is a tool for selecting ranges to display within
the chart. It provides buttons to select preconfigured ranges in
the chart, like 1 day, 1 week, 1 month etc. It also provides input
boxes where min and max dates can be manually input.
getter/setter pairinherited
-
responsive
↔ HighchartsResponsiveOptions?
-
Allows setting a set of rules to apply for different screen or chart
sizes. Each rule specifies additional chart options.
getter/setter pairinherited
-
runtimeType
→ Type
-
A representation of the runtime type of the object.
no setterinherited
-
scrollbar
↔ HighchartsScrollbarOptions?
-
The scrollbar is a means of panning over the X axis of a stock chart.
Scrollbars can also be applied to other types of axes.
getter/setter pairinherited
-
series
↔ List<HighchartsSeries>?
-
Series options for specific data and the data itself. In TypeScript you
have to cast the series options to specific series types, to get all
possible options for a series.
getter/setter pairinherited
-
sonification
↔ HighchartsSonificationOptions?
-
Options for configuring sonification and audio charts. Requires the
sonification module
to be loaded.
getter/setter pairinherited
-
stockTools
↔ HighchartsStockToolsOptions?
-
Configure the stockTools gui strings in the chart. Requires the
stockTools module to be loaded. For a description of the module
and information on its features, see Highcharts StockTools.
getter/setter pairinherited
-
subtitle
↔ HighchartsSubtitleOptions?
-
The chart's subtitle. This can be used both to display a subtitle below
the main title, and to display random text anywhere in the chart. The
subtitle can be updated after chart initialization through the
Chart.setTitle method.
getter/setter pairinherited
-
time
↔ HighchartsTimeOptions?
-
Time options that can apply globally or to individual charts. These
settings affect how
datetime axes are laid out, how tooltips are
formatted, how series
pointIntervalUnit works and how
the Highcharts Stock range selector handles time.
getter/setter pairinherited
-
title
↔ HighchartsTitleOptions?
-
The chart's main title.
getter/setter pairinherited
-
tooltip
↔ HighchartsTooltipOptions?
-
Options for the tooltip that appears when the user hovers over a
series or point.
getter/setter pairinherited
-
xAxis
↔ List<HighchartsXAxisOptions>?
-
The X axis or category axis. Normally this is the horizontal axis,
though if the chart is inverted this is the vertical axis. In case of
multiple axes, the xAxis node is an array of configuration objects.
getter/setter pairinherited
-
yAxis
↔ List<HighchartsYAxisOptions>?
-
The Y axis or value axis. Normally this is the vertical axis,
though if the chart is inverted this is the horizontal axis.
In case of multiple axes, the yAxis node is an array of
configuration objects.
getter/setter pairinherited
-
zAxis
↔ List<HighchartsZAxisOptions>?
-
The Z axis or depth axis for 3D plots.
getter/setter pairinherited