WaterfallSeries<T, D> class

Renders the waterfall series.

To render a waterfall chart, create an instance of WaterfallSeries and add to the series collection property of SfCartesianChart.

WaterfallSeries is similar to range column series, in range column high and low value should be there, but in waterfall we have find the endValue and originValue of each data point.

Inheritance

Constructors

WaterfallSeries({ValueKey<String> key, ChartSeriesRendererFactory<T, D> onCreateRenderer, @required List<T> dataSource, @required ChartValueMapper<T, D> xValueMapper, @required ChartValueMapper<T, num> yValueMapper, ChartValueMapper<T, bool> intermediateSumPredicate, ChartValueMapper<T, bool> totalSumPredicate, Color negativePointsColor, Color intermediateSumColor, Color totalSumColor, ChartValueMapper<T, dynamic> sortFieldValueMapper, ChartValueMapper<T, Color> pointColorMapper, ChartValueMapper<T, String> dataLabelMapper, SortingOrder sortingOrder, WaterfallConnectorLineSettings connectorLineSettings, String xAxisName, String yAxisName, String name, Color color, double width, double spacing, MarkerSettings markerSettings, DataLabelSettings dataLabelSettings, bool isVisible, LinearGradient gradient, LinearGradient borderGradient, BorderRadius borderRadius, bool enableTooltip, double animationDuration, Color borderColor, List<Trendline> trendlines, double borderWidth, SelectionSettings selectionSettings, SelectionBehavior selectionBehavior, bool isVisibleInLegend, LegendIconType legendIconType, String legendItemText, double opacity, List<double> dashArray, SeriesRendererCreatedCallback onRendererCreated, List<int> initialSelectedDataIndexes})
Creating an argument constructor of WaterfallSeries class.

Properties

animationDuration double
Duration of the series animation. It takes millisecond value as input. [...]
final, inherited
borderColor Color
Border color of the series. [...]
final, inherited
borderGradient LinearGradient
Fills the border of the chart series with gradient color. [...]
final, inherited
borderRadius BorderRadius
Customizes the corners of the waterfall. [...]
final
borderWidth double
Border width of the series. [...]
final, inherited
color Color
Color of the series. [...]
final, inherited
connectorLineSettings WaterfallConnectorLineSettings
Options to customize the waterfall chart connector line. [...]
final
dashArray List<double>
Dashes of the series. [...]
final, inherited
dataLabelMapper ChartIndexedValueMapper<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. [...]
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. [...]
final, inherited
gradient LinearGradient
Fills the chart series with gradient color. [...]
final, inherited
hashCode int
The hash code for this object. [...]
read-only, inherited
highValueMapper ChartIndexedValueMapper<num>
Field in the data source, which is considered as high value for the data points. [...]
final, inherited
initialSelectedDataIndexes List<int>
List of data indexes to initially be selected [...]
final, inherited
intermediateSumColor Color
Color of the intermediate sum points in the series. [...]
final
intermediateSumPredicate ChartIndexedValueMapper<bool>
A boolean value, based on which the data point will be considered as intermediate sum or not. [...]
final, inherited
isVisible bool
Toggles the visibility of the series. [...]
final, inherited
isVisibleInLegend bool
Toggles the visibility of the legend item of this specific series in the legend. [...]
final, inherited
key ValueKey<String>
Key to identify a series in a collection. [...]
final, inherited
legendIconType LegendIconType
Shape of the legend icon. [...]
final, inherited
legendItemText String
Text to be displayed in legend. [...]
final, inherited
lowValueMapper ChartIndexedValueMapper<num>
Field in the data source, which is considered as low value for the data points. [...]
final, inherited
markerSettings MarkerSettings
Indication of data points. [...]
final, inherited
name String
Name of the series. [...]
final, inherited
negativePointsColor Color
Color of the negative data points in the series. [...]
final
onCreateRenderer ChartSeriesRendererFactory<T, D>
Used to create the renderer for custom series. [...]
final, inherited
onRendererCreated SeriesRendererCreatedCallback
Triggers when the series renderer is created. [...]
final, inherited
opacity double
Opacity of the series. [...]
final, inherited
pointColorMapper ChartIndexedValueMapper<Color>
Field in the data source, which is considered as fill color for the data points. [...]
final, inherited
runtimeType Type
A representation of the runtime type of the object.
read-only, inherited
selectionBehavior SelectionBehavior
Customizes the data points or series on selection. [...]
final, inherited
selectionSettings SelectionSettings
Customizes the data points or series on selection. [...]
final, inherited
sizeValueMapper ChartIndexedValueMapper<num>
Field in the data source, which is considered as size of the bubble for all the data points. [...]
final, inherited
sortFieldValueMapper ChartIndexedValueMapper
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. [...]
final, inherited
spacing double
Spacing between the data points in waterfall chart. [...]
final
totalSumColor Color
Color of the total sum points in the series. [...]
final
totalSumPredicate ChartIndexedValueMapper<bool>
A boolean value, based on which the data point will be considered as total sum or not. [...]
final, inherited
trendlines List<Trendline>
Customizes the trendlines. [...]
final, inherited
width double
Width of the series. [...]
final, inherited
xAxisName String
Name of the x-axis to bind the series. [...]
final, inherited
xValueMapper ChartIndexedValueMapper<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 ChartIndexedValueMapper
Field in the data source, which is considered as y-value. [...]
final, inherited

Methods

createRenderer(ChartSeries<T, D> series) WaterfallSeriesRenderer
Create the waterfall series renderer.
noSuchMethod(Invocation invocation) → dynamic
Invoked when a non-existent method or property is accessed. [...]
inherited
toString() String
Returns a string representation of this object.
inherited

Operators

operator ==(Object other) bool
The equality operator. [...]
inherited