CandleSeries<T, D> class
This class holds the properties of the candle series.
To render a candle chart, create an instance of CandleSeries, and add it to the series
collection property of SfCartesianChart.
The candle chart represents the hollow rectangle with the open, close, high and low value in the given data.
It has the bearColor
and bullColor
properties to change the appearance of the candle series.
Provides options for color, opacity, border color, and border width to customize the appearance.
- Inheritance
-
- Object
- ChartSeries<
T, D> - CartesianSeries<
T, D> - XyDataSeries<
T, D> - CandleSeries
Constructors
-
CandleSeries({ValueKey<
String> ? key, ChartSeriesRendererFactory<T, D> ? onCreateRenderer, required List<T> dataSource, required ChartValueMapper<T, D> xValueMapper, required ChartValueMapper<T, num> lowValueMapper, required ChartValueMapper<T, num> highValueMapper, required ChartValueMapper<T, num> openValueMapper, required ChartValueMapper<T, num> closeValueMapper, ChartValueMapper<T, dynamic> ? sortFieldValueMapper, ChartValueMapper<T, Color> ? pointColorMapper, ChartValueMapper<T, String> ? dataLabelMapper, SortingOrder? sortingOrder, String? xAxisName, String? yAxisName, String? name, Color? bearColor, Color? bullColor, bool? enableSolidCandles, EmptyPointSettings? emptyPointSettings, DataLabelSettings? dataLabelSettings, bool? isVisible, bool? enableTooltip, double? animationDuration, double? borderWidth, SelectionSettings? selectionSettings, SelectionBehavior? selectionBehavior, bool? isVisibleInLegend, LegendIconType? legendIconType, String? legendItemText, List<double> ? dashArray, double? opacity, SeriesRendererCreatedCallback? onRendererCreated, List<int> ? initialSelectedDataIndexes, bool? showIndicationForSameValues, List<Trendline> ? trendlines}) - Creating an argument constructor of CandleSeries class.
Properties
- animationDuration → double
-
Duration of the series animation. It takes millisecond value as input.
finalinherited
- bearColor → Color?
-
finalinherited
- borderColor → Color
-
Border color of the series.
finalinherited
- borderGradient → LinearGradient?
-
Fills the border of the chart series with gradient color.
finalinherited
- borderWidth → double
-
Border width of the series.
finalinherited
- bullColor → Color?
-
finalinherited
-
closeValueMapper
→ ChartIndexedValueMapper<
num?> ? -
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
- enableSolidCandles → bool?
-
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 setterinherited
-
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
- 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
- onRendererCreated → SeriesRendererCreatedCallback?
-
Triggers when the series renderer is created.
finalinherited
- opacity → double
-
Opacity of the series.
finalinherited
-
openValueMapper
→ ChartIndexedValueMapper<
num?> ? -
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
- selectionSettings → SelectionSettings
-
Customizes the data points or series on selection.
finalinherited
- showIndicationForSameValues → bool
-
If it is set to true, a small vertical line will be rendered. Else nothing will
be rendered for that specific data point and left as a blank area.
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. The value ranges from 0 to 1.
1 represents 100% and 0 represents 0% of the available space.
finalinherited
-
totalSumPredicate
→ ChartIndexedValueMapper<
bool> ? -
A boolean value, based on which the data point will be considered as total sum or not.
finalinherited
-
trendlines
→ List<
Trendline> ? -
Customizes the trendlines.
finalinherited
-
volumeValueMapper
→ ChartIndexedValueMapper<
num> ? -
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) → CandleSeriesRenderer - Create the candle 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.
inherited