HCPlotBoxplotOptions class

(Highcharts) A box plot is a convenient way of depicting groups of data through their five-number summaries: the smallest observation (sample minimum), lower quartile (Q1), median (Q2), upper quartile (Q3), and largest observation (sample maximum).

Implemented types

Constructors

HCPlotBoxplotOptions({HCSeriesAccessibilityOptionsObject? accessibility, bool? allowPointSelect, dynamic animation, num? animationLimit, String? boxDashStyle, bool? centerInCategory, String? className, bool? clip, dynamic color, dynamic colorAxis, bool? colorByPoint, num? colorIndex, String? colorKey, List? colors, bool? crisp, num? cropThreshold, String? cursor, HCDictionary? custom, String? dashStyle, dynamic dataLabels, HCDataMappingOptionsObject? dataMapping, HCPlotBoxplotDataSortingOptions? dataSorting, num? depth, String? description, HCSeriesDragDropOptionsObject? dragDrop, String? edgeColor, num? edgeWidth, bool? enableMouseTracking, HCSeriesEventsOptionsObject? events, dynamic fillColor, String? findNearestPointBy, bool? getExtremesFromAll, bool? grouping, num? groupPadding, bool? inactiveOtherPoints, bool? includeInDataExport, List<String>? keys, HCSeriesLabelOptionsObject? label, String? legendSymbol, dynamic legendSymbolColor, num? lineWidth, String? linkedTo, num? maxPointWidth, dynamic medianColor, String? medianDashStyle, num? medianWidth, num? minPointLength, dynamic negativeColor, bool? nullInteraction, dynamic onPoint, num? opacity, HCPlotSeriesPointOptions? point, dynamic pointDescriptionFormat, dynamic pointDescriptionFormatter, num? pointInterval, String? pointIntervalUnit, num? pointPadding, dynamic pointPlacement, num? pointRange, dynamic pointStart, num? pointWidth, bool? relativeXValue, bool? selected, dynamic shadow, bool? showCheckbox, bool? showInLegend, bool? skipKeyboardNavigation, bool? softThreshold, HCSeriesSonificationOptions? sonification, String? stacking, dynamic stemColor, String? stemDashStyle, num? stemWidth, bool? stickyTracking, num? threshold, HCSeriesTooltipOptionsObject? tooltip, num? turboThreshold, bool? visible, dynamic whiskerColor, String? whiskerDashStyle, dynamic whiskerLength, num? whiskerWidth, String? zoneAxis, List<HCSeriesZonesOptionsObject>? zones, bool? zoomEnabled})
const

Properties

accessibility → HCSeriesAccessibilityOptionsObject?
(Highcharts) Accessibility options for a series.
final
allowPointSelect → bool?
(Highcharts) Allow this series' points to be selected by clicking on the graphic (columns, point markers, pie slices, map areas etc).
final
animation → dynamic
(Highcharts) Enable or disable the initial animation when a series is displayed. The animation can also be set as a configuration object. Please note that this option only applies to the initial animation of the series itself. For other animations, see chart.animation and the animation parameter und
final
animationLimit → num?
(Highcharts) For some series, there is a limit that shuts down animation by default when the total number of points in the chart is too high. For example, for a column chart and its derivatives, animation does not run if there is more than 250 points totally. To disable this cap, set `animationLimit
final
boxDashStyle → String?
(Highcharts) The dash style of the box.
final
centerInCategory → bool?
(Highcharts, Highstock, Gantt) When true, the columns will center in the category, ignoring null or missing points. When false, space will be reserved for null or missing points.
final
className → String?
(Highcharts) An additional class name to apply to the series' graphical elements. This option does not replace default class names of the graphical element. Changes to the series' color will also be reflected in a chart's legend and tooltip.
final
clip → bool?
(Highcharts) Disable this option to allow series rendering in the whole plotting area.
final
color → dynamic
(Highcharts) The main color of the series. In line type series it applies to the line and the point markers unless otherwise specified. In bar type series it applies to the bars unless a color is specified per point. The default value is pulled from the options.colors array.
final
colorAxis → dynamic
(Highcharts, Highstock, Highmaps) When using dual or multiple color axes, this number defines which colorAxis the particular series is connected to. It refers to either the axis id or the index of the axis in the colorAxis array, with 0 being the first. Set this option to false to prevent a series f
final
colorByPoint → bool?
(Highcharts, Highstock, Gantt) When using automatic point colors pulled from the global colors or series-specific plotOptions.column.colors collections, this option determines whether the chart should receive one color per series or one color per point.
final
colorIndex → num?
(Highcharts) Styled mode only. A specific color index to use for the series, so its graphic representations are given the class name highcharts-color-{n}.
final
colorKey → String?
(Highcharts, Highstock, Highmaps) Determines what data value should be used to calculate point color if colorAxis is used. Requires to set min and max if some custom point property is used or if approximation for data grouping is set to 'sum'.
final
colors → List?
(Highcharts, Highstock, Gantt) A series specific or series type specific color set to apply instead of the global colors when colorByPoint is true.
final
crisp → bool?
(Highcharts, Highstock, Gantt) When true, each point or column edge is rounded to its nearest pixel in order to render sharp on screen. In some cases, when there are a lot of densely packed columns, this leads to visible difference in column widths or distance between columns. In these cases, settin
final
cropThreshold → num?
(Highcharts, Highstock, Gantt) When the series contains less points than the crop threshold, all points are drawn, even if the points fall outside the visible plot area at the current zoom. The advantage of drawing all points (including markers and columns), is that animation is performed on updates
final
cursor → String?
(Highcharts) You can set the cursor to "pointer" if you have click events attached to the series, to signal to the user that the points and lines can be clicked.
final
custom → HCDictionary?
(Highcharts) A reserved subspace to store options and values for customized functionality. Here you can add additional data for your own event callbacks and formatter callbacks.
final
dashStyle → String?
(Highcharts) Name of the dash style to use for the graph, or for some series types the outline of each shape.
final
dataLabels → dynamic
(Highcharts, Highstock, Highmaps, Gantt) Options for the series data labels, appearing next to each data point.
final
dataMapping → HCDataMappingOptionsObject?
(Highcharts) The mapping between the data table and the series data points. This is used in conjunction with the dataTable option (on chart or series level) to map columns from the data table to the properties of the data points. The keys of the dataMapping object correspond to the properties of
final
dataSorting → HCPlotBoxplotDataSortingOptions?
(Highcharts, Highstock) Options for series data sorting.
final
depth → num?
(Highcharts) Depth of the columns in a 3D column chart.
final
description → String?
(Highcharts) Deprecated. Use plotOptions.series.accessibility.description instead.
final
dragDrop → HCSeriesDragDropOptionsObject?
(Highcharts) The draggable-points module allows points to be moved around or modified in the chart. In addition to the options mentioned under the dragDrop API structure, the module fires three events, point.dragStart, point.drag and point.drop.
final
edgeColor → String?
(Highcharts) 3D columns only. The color of the edges. Similar to borderColor, except it defaults to the same color as the column.
final
edgeWidth → num?
(Highcharts) 3D columns only. The width of the colored edges.
final
enableMouseTracking → bool?
(Highcharts) Enable or disable the mouse tracking for a specific series. This includes point tooltips and click events on graphs and points. For large datasets it improves performance.
final
events → HCSeriesEventsOptionsObject?
(Highcharts) General event handlers for the series items. These event hooks can also be attached to the series at run time using the Highcharts.addEvent function.
final
fillColor → dynamic
(Highcharts) The fill color of the box.
final
findNearestPointBy → String?
(Highcharts) Determines whether the series should look for the nearest point in both dimensions or just the x-dimension when hovering the series. Defaults to 'xy' for scatter series and 'x' for most other series. If the data has duplicate x-values, it is recommended to set this to 'xy' to allo
final
getExtremesFromAll → bool?
(Highcharts, Highstock, Gantt) Whether to use the Y extremes of the total chart width or only the zoomed area when zooming in on parts of the X axis. By default, the Y axis adjusts to the min and max of the visible data. Cartesian series only.
final
grouping → bool?
(Highcharts, Highstock, Gantt) Whether to group non-stacked columns or to let them render independent of each other. Non-grouped columns will be laid out individually and overlap each other.
final
groupPadding → num?
(Highcharts, Highstock, Gantt) Padding between each value groups, in x axis units.
final
hashCode → int
The hash code for this object.
no setterinherited
inactiveOtherPoints → bool?
(Highcharts) Highlight only the hovered point and fade the remaining points.
final
includeInDataExport → bool?
(Highcharts) When set to false will prevent the series data from being included in any form of data export.
final
keys → List<String>?
(Highcharts) An array specifying which option maps to which key in the data point array. This makes it convenient to work with unstructured data arrays from different sources.
final
label → HCSeriesLabelOptionsObject?
(Highcharts, Highstock, Gantt) Series labels are placed as close to the series as possible in a natural way, seeking to avoid other series. The goal of this feature is to make the chart more easily readable, like if a human designer placed the labels in the optimal position.
final
legendSymbol → String?
(Highcharts) What type of legend symbol to render for this series. Can be one of areaMarker, lineMarker or rectangle.
final
legendSymbolColor → dynamic
(Highcharts, Highstock, Highmaps) Defines the color of the legend symbol for this series. Defaults to undefined, in which case the series color is used. Does not work with styled mode.
final
lineWidth → num?
(Highcharts) The width of the line surrounding the box. If any of stemWidth, medianWidth or whiskerWidth are null, the lineWidth also applies to these lines.
final
linkedTo → String?
(Highcharts, Highstock, Gantt) The id of another series to link to. Additionally, the value can be ":previous" to link to the previous series. When two series are linked, only the first one appears in the legend. Toggling the visibility of this also toggles the linked series.
final
maxPointWidth → num?
(Highcharts, Highstock, Gantt) The maximum allowed pixel width for a column, translated to the height of a bar in a bar chart. This prevents the columns from becoming too wide when there is a small number of points in the chart.
final
medianColor → dynamic
(Highcharts) The color of the median line. If undefined, the general series color applies.
final
medianDashStyle → String?
(Highcharts) The dash style of the median.
final
medianWidth → num?
(Highcharts) The pixel width of the median line. If null, the lineWidth is used.
final
minPointLength → num?
(Highcharts, Highstock, Gantt) The minimal height for a column or width for a bar. By default, 0 values are not shown. To visualize a 0 (or close to zero) point, set the minimal point length to a pixel value like 3. In stacked column charts, minPointLength might not be respected for tightly packed
final
negativeColor → dynamic
(Highcharts) The color for the parts of the graph or points that are below the threshold. Note that zones takes precedence over the negative color. Using negativeColor is equivalent to applying a zone with value of 0.
final
nullInteraction → bool?
(Highcharts, Highstock) Whether or not data-points with the value of null should be interactive. When this is set to true, tooltips may highlight these points, and this option also enables keyboard navigation for such points. Format options for such points include nullFormat and `nullFormatter
final
onPoint → dynamic
(Highcharts) Options for the Series on point feature. Only pie and sunburst series are supported at this moment.
final
opacity → num?
(Highcharts) Opacity of a series parts: line, fill (e.g. area) and dataLabels.
final
point → HCPlotSeriesPointOptions?
(Highcharts) Properties for each single point.
final
pointDescriptionFormat → dynamic
(Highcharts) Deprecated. Use series.accessibility.point.descriptionFormat instead.
final
pointDescriptionFormatter → dynamic
(Highcharts) Deprecated. Use series.accessibility.point.descriptionFormatter instead.
final
pointInterval → num?
(Highcharts, Highstock, Gantt) If no x values are given for the points in a series, pointInterval defines the interval of the x values. For example, if a series contains one value every decade starting from year 0, set pointInterval to 10. In true datetime axes, the pointInterval is set in
final
pointIntervalUnit → String?
(Highcharts, Highstock, Gantt) On datetime series, this allows for setting the pointInterval to irregular time units, day, month and year. A day is usually the same as 24 hours, but pointIntervalUnit also takes the DST crossover into consideration when dealing with local time. Combine this o
final
pointPadding → num?
(Highcharts, Highstock, Gantt) Padding between each column or bar, in x axis units.
final
pointPlacement → dynamic
(Highcharts, Highstock, Gantt) Possible values: "on", "between", number.
final
pointRange → num?
(Highcharts, Highstock, Gantt) The X axis range that each point is valid for. This determines the width of the column. On a categorized axis, the range will be 1 by default (one category unit). On linear and datetime axes, the range will be computed as the distance between the two closest data point
final
pointStart → dynamic
(Highcharts, Highstock, Gantt) If no x values are given for the points in a series, pointStart defines on what value to start. For example, if a series contains one yearly value starting from 1945, set pointStart to 1945.
final
pointWidth → num?
(Highcharts, Highstock, Gantt) A pixel value specifying a fixed width for each column or bar point. When set to undefined, the width is calculated from the pointPadding and groupPadding. The width effects the dimension that is not based on the point value. For column series it is the horizonta
final
relativeXValue → bool?
(Highcharts, Highstock) When true, X values in the data set are relative to the current pointStart, pointInterval and pointIntervalUnit settings. This allows compression of the data for datasets with irregular X values.
final
runtimeType → Type
A representation of the runtime type of the object.
no setterinherited
selected → bool?
(Highcharts) Whether to select the series initially. If showCheckbox is true, the checkbox next to the series name in the legend will be checked for a selected series.
final
shadow → dynamic
(Highcharts) Whether to apply a drop shadow to the graph line. Since 2.3 the shadow can be an object configuration containing color, offsetX, offsetY, opacity and width.
final
showCheckbox → bool?
(Highcharts) If true, a checkbox is displayed next to the legend item to allow selecting the series. The state of the checkbox is determined by the selected option.
final
showInLegend → bool?
(Highcharts) Whether to display this particular series or series type in the legend. Standalone series are shown in legend by default, and linked series are not. Since v7.2.0 it is possible to show series that use colorAxis by setting this option to true.
final
skipKeyboardNavigation → bool?
(Highcharts) Deprecated. Use series.accessibility.keyboardNavigation instead.
final
softThreshold → bool?
(Highcharts, Highstock) When this is true, the series will not cause the Y axis to cross the zero plane (or threshold option) unless the data actually crosses the plane.
final
sonification → HCSeriesSonificationOptions?
(Highcharts) Sonification/audio chart options for a series.
final
stacking → String?
(Highcharts, Highstock) Whether to stack the values of each series on top of each other. Possible values are null to disable, "normal" to stack by value or "percent".
final
stemColor → dynamic
(Highcharts) The color of the stem, the vertical line extending from the box to the whiskers. If undefined, the series color is used.
final
stemDashStyle → String?
(Highcharts) The dash style of the stem, the vertical line extending from the box to the whiskers.
final
stemWidth → num?
(Highcharts) The width of the stem, the vertical line extending from the box to the whiskers. If undefined, the width is inherited from the lineWidth option.
final
stickyTracking → bool?
(Highcharts) Sticky tracking of mouse events. When true, the mouseOut event on a series isn't triggered until the mouse moves over another series, or out of the plot area. When false, the mouseOut event on a series is triggered when the mouse leaves the area around the series' graph or markers.
final
threshold → num?
(Highcharts) The Y axis value to serve as the base for the columns, for distinguishing between values above and below a threshold. If null, the columns extend from the padding Y axis minimum.
final
tooltip → HCSeriesTooltipOptionsObject?
(Highcharts) A configuration object for the tooltip rendering of each single series. Properties are inherited from tooltip, but only the following properties can be defined on a series level.
final
turboThreshold → num?
(Highcharts, Highstock, Gantt) When a series contains a data array that is longer than this, the Series class looks for data configurations of plain numbers or arrays of numbers. The first and last valid points are checked. If found, the rest of the data is assumed to be the same. This saves expen
final
visible → bool?
(Highcharts) Set the initial visibility of the series.
final
whiskerColor → dynamic
(Highcharts) The color of the whiskers, the horizontal lines marking low and high values. When undefined, the general series color is used.
final
whiskerDashStyle → String?
(Highcharts) The dash style of the whiskers.
final
whiskerLength → dynamic
(Highcharts) The length of the whiskers, the horizontal lines marking low and high values. It can be a numerical pixel value, or a percentage value of the box width. Set 0 to disable whiskers.
final
whiskerWidth → num?
(Highcharts) The line width of the whiskers, the horizontal lines marking low and high values. When undefined, the general lineWidth applies.
final
zoneAxis → String?
(Highcharts, Highstock) Defines the Axis on which the zones are applied.
final
zones → List<HCSeriesZonesOptionsObject>?
(Highcharts, Highstock) An array defining zones within a series. Zones can be applied to the X axis, Y axis or Z axis for bubbles, according to the zoneAxis option. The zone definitions have to be in ascending order regarding to the value.
final
zoomEnabled → bool?
(Highcharts) Whether to zoom non-cartesian series. If chart.zooming is set, the option allows to disable zooming on an individual non-cartesian series. By default zooming is enabled for all series.
final

Methods

noSuchMethod(Invocation invocation) → dynamic
Invoked when a nonexistent method or property is accessed.
inherited
toJson() → Map<String, dynamic>
override
toString() → String
A string representation of this object.
inherited

Operators

operator ==(Object other) → bool
The equality operator.
inherited