RangeColumnSeries<T, D> class
Renders the range column series.
To render a range column chart, create an instance of RangeColumnSeries and add to the series collection property of SfCartesianChart.
RangeColumnSeries is similar to column series but requires two Y values for a point, your data should contain high and low values. High and low value specify the maximum and minimum range of the point.
- highValueMapper - Field in the data source, which is considered as high value for the data points.
- lowValueMapper - Field in the data source, which is considered as low value for the data points.
- Inheritance
-
- Object
- ChartSeries<
T, D> - CartesianSeries<
T, D> - XyDataSeries<
T, D> - RangeColumnSeries
- Annotations
Constructors
-
RangeColumnSeries({ValueKey<
String> ? key, ChartSeriesRendererFactory<T, D> ? onCreateRenderer, required List<T> dataSource, required ChartValueMapper<T, D> xValueMapper, required ChartValueMapper<T, num> highValueMapper, required ChartValueMapper<T, num> lowValueMapper, ChartValueMapper<T, dynamic> ? sortFieldValueMapper, ChartValueMapper<T, Color> ? pointColorMapper, ChartValueMapper<T, String> ? dataLabelMapper, SortingOrder? sortingOrder, bool isTrackVisible = false, String? xAxisName, String? yAxisName, String? name, Color? color, double? width, double spacing = 0, MarkerSettings? markerSettings, EmptyPointSettings? emptyPointSettings, DataLabelSettings? dataLabelSettings, bool? isVisible, LinearGradient? gradient, LinearGradient? borderGradient, BorderRadius borderRadius = BorderRadius.zero, bool? enableTooltip, double? animationDuration, Color trackColor = Colors.grey, Color trackBorderColor = Colors.transparent, double trackBorderWidth = 1, double trackPadding = 0, Color? borderColor, List<Trendline> ? trendlines, double? borderWidth, SelectionBehavior? selectionBehavior, bool? isVisibleInLegend, LegendIconType? legendIconType, String? legendItemText, double? opacity, double? animationDelay, List<double> ? dashArray, SeriesRendererCreatedCallback? onRendererCreated, ChartPointInteractionCallback? onPointTap, ChartPointInteractionCallback? onPointDoubleTap, ChartPointInteractionCallback? onPointLongPress, CartesianShaderCallback? onCreateShader, List<int> ? initialSelectedDataIndexes}) - Creating an argument constructor of RangeColumnSeries class.
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.
finalinherited
- animationDuration → double
-
Duration of the series animation. It takes millisecond value as input.
finalinherited
- borderColor → Color
-
Border color of the series.
finalinherited
- borderGradient → LinearGradient?
-
Fills the border of the chart series with gradient color.
finalinherited
- borderRadius → BorderRadius
-
Customizes the corners of the range column.
final
- borderWidth → double
-
Border width of the series.
finalinherited
- color → Color?
-
Color of the series.
finalinherited
-
dashArray
→ List<
double> -
Dashes of the series.
finalinherited
-
dataLabelMapper
→ ChartIndexedValueMapper<
String> ? -
Field in the data source, which is considered as text for the data points.
finalinherited
- dataLabelSettings → DataLabelSettings
-
Customizes the data labels in a series. Data label is a text, which displays
the details about the data point.
finalinherited
-
dataSource
→ List<
T> -
Data required for rendering the series.
finalinherited
- emptyPointSettings → EmptyPointSettings
-
Customizes the empty points, i.e. null data points in a series.
finalinherited
- enableTooltip → bool
-
Enables or disables the tooltip for this series.
finalinherited
- gradient → LinearGradient?
-
Fills the chart series with gradient color.
finalinherited
- hashCode → int
-
The hash code for this object.
no setteroverride
-
highValueMapper
→ ChartIndexedValueMapper<
num> ? -
Field in the data source, which is considered as high value for the data points.
finalinherited
-
initialSelectedDataIndexes
→ List<
int> ? -
List of data indexes to initially be selected.
finalinherited
-
intermediateSumPredicate
→ ChartIndexedValueMapper<
bool> ? -
A boolean value, based on which the data point will be considered as intermediate sum or not.
finalinherited
- isTrackVisible → bool
-
Renders range column with track.
final
- isVisible → bool
-
Toggles the visibility of the series.
finalinherited
- isVisibleInLegend → bool
-
Toggles the visibility of the legend item of this specific series in the legend.
finalinherited
-
key
→ ValueKey<
String> ? -
Key to identify a series in a collection.
finalinherited
- legendIconType → LegendIconType
-
Shape of the legend icon.
finalinherited
- legendItemText → String?
-
Text to be displayed in legend.
finalinherited
-
lowValueMapper
→ ChartIndexedValueMapper<
num> ? -
Field in the data source, which is considered as low value for the data points.
finalinherited
- markerSettings → MarkerSettings
-
Indication of data points.
finalinherited
- name → String?
-
Name of the series.
finalinherited
-
onCreateRenderer
→ ChartSeriesRendererFactory<
T, D> ? -
Used to create the renderer for custom series.
finalinherited
- onCreateShader → CartesianShaderCallback?
-
Fills the data points with the gradient and image shaders.
finalinherited
- onPointDoubleTap → ChartPointInteractionCallback?
-
Called when double tapped on the chart data point.
finalinherited
- onPointLongPress → ChartPointInteractionCallback?
-
Called when long pressed on the chart data point.
finalinherited
- onPointTap → ChartPointInteractionCallback?
-
Called when tapped on the chart data point.
finalinherited
- onRendererCreated → SeriesRendererCreatedCallback?
-
Triggers when the series renderer is created.
finalinherited
- opacity → double
-
Opacity of the series.
finalinherited
-
pointColorMapper
→ ChartIndexedValueMapper<
Color> ? -
Field in the data source, which is considered as fill color for the data points.
finalinherited
- runtimeType → Type
-
A representation of the runtime type of the object.
no setterinherited
- selectionBehavior → SelectionBehavior
-
Customizes the data points or series on selection.
finalinherited
-
sizeValueMapper
→ ChartIndexedValueMapper<
num> ? -
Field in the data source, which is considered as size of the bubble for
all the data points.
finalinherited
- sortFieldValueMapper → ChartIndexedValueMapper?
-
Field in the data source, which is considered for sorting the data points.
finalinherited
- sortingOrder → SortingOrder
-
The data points in the series can be sorted in ascending or descending order.
finalinherited
- spacing → double
-
Spacing between the columns.
final
-
totalSumPredicate
→ ChartIndexedValueMapper<
bool> ? -
A boolean value, based on which the data point will be considered as total sum or not.
finalinherited
- trackBorderColor → Color
-
Color of the track border.
final
- trackBorderWidth → double
-
Width of the track border.
final
- trackColor → Color
-
Color of the track.
final
- trackPadding → double
-
Padding of the track.
final
-
trendlines
→ List<
Trendline> ? -
Customizes the trendlines.
finalinherited
- width → double?
-
Width of the series.
finalinherited
- xAxisName → String?
-
Name of the x-axis to bind the series.
finalinherited
-
xValueMapper
→ ChartIndexedValueMapper<
D> ? -
Field in the data source, which is considered as x-value.
finalinherited
- yAxisName → String?
-
Name of the y-axis to bind the series.
finalinherited
- yValueMapper → ChartIndexedValueMapper?
-
Field in the data source, which is considered as y-value.
finalinherited
Methods
-
createRenderer(
ChartSeries< T, D> series) → RangeColumnSeriesRenderer - Create the range column series renderer.
-
noSuchMethod(
Invocation invocation) → dynamic -
Invoked when a nonexistent method or property is accessed.
inherited
-
toString(
) → String -
A string representation of this object.
inherited
Operators
-
operator ==(
Object other) → bool -
The equality operator.
override