BoxAndWhiskerSeries<T, D> class

This class holds the properties of the box and whisker series.

To render a box and whisker chart, create an instance of BoxAndWhiskerSeries, and add it to the series collection property of SfCartesianChart. The box and whisker chart represents the hollow rectangle with the lower quartile, upper quartile, maximum and minimum value in the given data.

Provides options for color, opacity, border color, and border width to customize the appearance.

Inheritance

• Object
• DiagnosticableTree
• Widget
• RenderObjectWidget
• SlottedMultiChildRenderObjectWidget<SeriesSlot, RenderObject>
• ChartSeries<T, D>
• CartesianSeries<T, D>
• BoxAndWhiskerSeries

Annotations

• @immutable

Constructors

BoxAndWhiskerSeries({ValueKey<String>? key, ChartSeriesRendererFactory<T, D>? onCreateRenderer, List<T>? dataSource, required ChartValueMapper<T, D>? xValueMapper, required ChartValueMapper<T, List<num?>>? yValueMapper, ChartValueMapper<T, dynamic>? sortFieldValueMapper, ChartValueMapper<T, Color>? pointColorMapper, ChartValueMapper<T, String>? dataLabelMapper, SortingOrder sortingOrder = SortingOrder.none, String? xAxisName, String? yAxisName, String? name, Color? color, double width = 0.7, double spacing = 0.0, MarkerSettings markerSettings = const MarkerSettings(), DataLabelSettings dataLabelSettings = const DataLabelSettings(), bool initialIsVisible = true, bool enableTooltip = true, double animationDuration = 1500, Color? borderColor, double borderWidth = 1.0, LinearGradient? gradient, LinearGradient? borderGradient, SelectionBehavior? selectionBehavior, bool isVisibleInLegend = true, LegendIconType legendIconType = LegendIconType.seriesType, String? legendItemText, List<double>? dashArray, double opacity = 1.0, double animationDelay = 0, SeriesRendererCreatedCallback<T, D>? onRendererCreated, ChartPointInteractionCallback? onPointTap, ChartPointInteractionCallback? onPointDoubleTap, ChartPointInteractionCallback? onPointLongPress, CartesianShaderCallback? onCreateShader, List<Trendline>? trendlines, BoxPlotMode boxPlotMode = BoxPlotMode.normal, bool showMean = true})

Creating an argument constructor of BoxAndWhiskerSeries class.

const

Properties

animationDelay → double

Delay duration of the series animation.It takes a millisecond value as input. By default, the series will get animated for the specified duration. If animationDelay is specified, then the series will begin to animate after the specified duration.

final, inherited

animationDuration → double

Duration of the series animation. It takes millisecond value as input.

final, inherited

borderColor → Color?

final

borderGradient → LinearGradient?

Fills the border of the chart series with gradient color.

final, inherited

borderWidth → double

Border width of the series.

final, inherited

boxPlotMode → BoxPlotMode

To change the box plot rendering mode.

final

color → Color?

Color of the series.

final, inherited

dashArray → List<double>?

Dashes of the series.

final, inherited

dataLabelMapper → ChartValueMapper<T, String>?

Field in the data source, which is considered as text for the data points.

final, inherited

dataLabelSettings → DataLabelSettings

Customizes the data labels in a series. Data label is a text, which displays the details about the data point.

final, inherited

dataSource → List<T>?

Data required for rendering the series. If no data source is specified, empty chart will be rendered without series.

final, inherited

emptyPointSettings → EmptyPointSettings

Customizes the empty points, i.e. null data points in a series.

final, inherited

enableTooltip → bool

Enables or disables the tooltip for this series. Tooltip will display more details about data points when tapping the data point region.

final, inherited

gradient → LinearGradient?

Fills the chart series with gradient color.

final, inherited

hashCode → int

The hash code for this object.

no setter, inherited

initialIsVisible → bool

Visibility of the series, which applies only during load time.

final, inherited

initialSelectedDataIndexes → List<int>?

List of data indexes to initially be selected.

final, inherited

isVisibleInLegend → bool

Toggles the visibility of the legend item of this specific series in the legend.

final, inherited

key → Key?

Controls how one widget replaces another widget in the tree.

final, inherited

legendIconType → LegendIconType

Shape of the legend icon. Any shape in the LegendIconType can be applied to this property. By default, icon will be rendered based on the type of the series.

final, inherited

legendItemText → String?

Text to be displayed in legend. By default, the series name will be displayed in the legend. You can change this by setting values to this property.

final, inherited

markerSettings → MarkerSettings

Indication of data points.

final, inherited

name → String?

Name of the series. The name will be displayed in legend item by default. If name is not specified for the series, then the current series index with ‘series’ text prefix will be considered as series name.

final, inherited

onCreateRenderer → ChartSeriesRendererFactory<T, D>?

Used to create the renderer for custom series.

final, inherited

onCreateShader → CartesianShaderCallback?

Fills the data points with the gradient and image shaders.

final, inherited

onPointDoubleTap → ChartPointInteractionCallback?

Called when double tapped on the chart data point.

final, inherited

onPointLongPress → ChartPointInteractionCallback?

Called when long pressed on the chart data point.

final, inherited

onPointTap → ChartPointInteractionCallback?

Called when tapped on the chart data point.

final, inherited

onRendererCreated → SeriesRendererCreatedCallback<T, D>?

Triggers when the series renderer is created.

final, inherited

opacity → double

Opacity of the series. The value ranges from 0 to 1.

final, inherited

pointColorMapper → ChartValueMapper<T, Color>?

Field in the data source, which is considered as fill color for the data points.

final, inherited

positions → List<ChartDataPointType>

no setter, override

runtimeType → Type

A representation of the runtime type of the object.

no setter, inherited

selectionBehavior → SelectionBehavior?

Customizes the data points or series on selection.

final, inherited

showMean → bool

Indication for mean value in box plot.

final

slots → Iterable<SeriesSlot>

Returns a list of all available slots.

no setter, inherited

sortFieldValueMapper → ChartValueMapper<T, dynamic>?

Field in the data source, which is considered for sorting the data points.

final, inherited

sortingOrder → SortingOrder

The data points in the series can be sorted in ascending or descending order. The data points will be rendered in the specified order if it is set to none.

final, inherited

spacing → double

Spacing between the box plots.

final

trendlines → List<Trendline>?

Customizes the trendlines.

final, inherited

width → double

final

xAxisName → String?

Name of the x-axis to bind the series.

final, inherited

xValueMapper → ChartValueMapper<T, D>?

Field in the data source, which is considered as x-value.

final, inherited

yAxisName → String?

Name of the y-axis to bind the series.

final, inherited

yValueMapper → ChartValueMapper<T, List<num?>>?

final

Methods

childForSlot(SeriesSlot slot) → Widget?

Returns the widget that is currently occupying the provided slot.

override

createElement() → SlottedRenderObjectElement<SeriesSlot, RenderObject>

RenderObjectWidgets always inflate to a RenderObjectElement subclass.

inherited

createRenderer() → BoxAndWhiskerSeriesRenderer<T, D>

Create the Box and Whisker series renderer.

override

createRenderObject(BuildContext context) → BoxAndWhiskerSeriesRenderer<T, D>

Creates an instance of the RenderObject class that this RenderObjectWidget represents, using the configuration described by this RenderObjectWidget.

override

debugDescribeChildren() → List<DiagnosticsNode>

Returns a list of DiagnosticsNode objects describing this node's children.

inherited

debugFillProperties(DiagnosticPropertiesBuilder properties) → void

Add additional properties associated with the node.

inherited

didUnmountRenderObject(covariant RenderObject renderObject) → void

A render object previously associated with this widget has been removed from the tree. The given RenderObject will be of the same type as returned by this object's createRenderObject.

inherited

noSuchMethod(Invocation invocation) → dynamic

Invoked when a nonexistent method or property is accessed.

inherited

toDiagnosticsNode({String? name, DiagnosticsTreeStyle? style}) → DiagnosticsNode

Returns a debug representation of the object that is used by debugging tools and by DiagnosticsNode.toStringDeep.

inherited

toString({DiagnosticLevel minLevel = DiagnosticLevel.info}) → String

A string representation of this object.

inherited

toStringDeep({String prefixLineOne = '', String? prefixOtherLines, DiagnosticLevel minLevel = DiagnosticLevel.debug}) → String

Returns a string representation of this node and its descendants.

inherited

toStringShallow({String joiner = ', ', DiagnosticLevel minLevel = DiagnosticLevel.debug}) → String

Returns a one-line detailed description of the object.

inherited

toStringShort() → String

A short, textual description of this widget.

inherited

transposed() → bool

inherited

updateRenderObject(BuildContext context, covariant BoxAndWhiskerSeriesRenderer<T, D> renderObject) → void

Copies the configuration described by this RenderObjectWidget to the given RenderObject, which will be of the same type as returned by this object's createRenderObject.

override

Operators

operator ==(Object other) → bool

The equality operator.

inherited