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
Annotations

Constructors

CandleSeries({ValueKey<String>? key, ChartSeriesRendererFactory<T, D>? onCreateRenderer, 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 = SortingOrder.none, String? xAxisName, String? yAxisName, String? name, Color bearColor = Colors.red, Color bullColor = Colors.green, bool enableSolidCandles = false, EmptyPointSettings emptyPointSettings = const EmptyPointSettings(), DataLabelSettings dataLabelSettings = const DataLabelSettings(), bool initialIsVisible = true, bool enableTooltip = true, bool enableTrackball = true, double animationDuration = 1500, double borderWidth = 2, 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<int>? initialSelectedDataIndexes, bool showIndicationForSameValues = false, List<Trendline>? trendlines, BorderRadius borderRadius = BorderRadius.zero, double width = 0.7, double spacing = 0})
Creating an argument constructor of CandleSeries 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.
finalinherited
animationDuration → double
Duration of the series animation. It takes millisecond value as input.
finalinherited
bearColor → Color
Specifies the bear color.
finalinherited
borderGradient → LinearGradient?
Fills the border of the chart series with gradient color.
finalinherited
borderRadius → BorderRadius
Customize the corners of the candle.
final
borderWidth → double
Border width of the series.
finalinherited
bullColor → Color
Specifies the bull color.
finalinherited
closeValueMapper → ChartValueMapper<T, num>?
Specifies the close value mapper.
finalinherited
color → Color?
Color of the series.
finalinherited
dashArray → List<double>?
Dashes of the series.
finalinherited
dataLabelMapper → ChartValueMapper<T, 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. If no data source is specified, empty chart will be rendered without series.
finalinherited
emptyPointSettings → EmptyPointSettings
Customizes the empty points, i.e. null data points in a series.
finalinherited
enableSolidCandles → bool
Specifies whether the solid candles.
finalinherited
enableTooltip → bool
Enables or disables the tooltip for this series. Tooltip will display more details about data points when tapping the data point region.
finalinherited
enableTrackball → bool
Enables or disables the trackball for this series. Trackball will display more details about data points when tapping the data point region.
finalinherited
gradient → LinearGradient?
Fills the chart series with gradient color.
finalinherited
hashCode → int
The hash code for this object.
no setterinherited
highValueMapper → ChartValueMapper<T, num>?
Specifies the high value mapper.
finalinherited
initialIsVisible → bool
Visibility of the series, which applies only during load time.
finalinherited
initialSelectedDataIndexes → List<int>?
List of data indexes to initially be selected.
finalinherited
isVisibleInLegend → bool
Toggles the visibility of the legend item of this specific series in the legend.
finalinherited
key → Key?
Controls how one widget replaces another widget in the tree.
finalinherited
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.
finalinherited
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.
finalinherited
lowValueMapper → ChartValueMapper<T, num>?
Specifies the low value mapper.
finalinherited
markerSettings → MarkerSettings
Indication of data points.
finalinherited
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.
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<T, D>?
Triggers when the series renderer is created.
finalinherited
opacity → double
Opacity of the series. The value ranges from 0 to 1.
finalinherited
openValueMapper → ChartValueMapper<T, num>?
Specifies the open value mapper.
finalinherited
pointColorMapper → ChartValueMapper<T, Color>?
Field in the data source, which is considered as fill color for the data points.
finalinherited
positions → List<ChartDataPointType>
no setterinherited
runtimeType → Type
A representation of the runtime type of the object.
no setterinherited
selectionBehavior → SelectionBehavior?
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
slots → Iterable<SeriesSlot>
Returns a list of all available slots.
no setterinherited
sortFieldValueMapper → ChartValueMapper<T, dynamic>?
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. The data points will be rendered in the specified order if it is set to none.
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
trendlines → List<Trendline>?
Customizes the trendlines.
finalinherited
volumeValueMapper → ChartValueMapper<T, num>?
Specifies the volume value mapper.
finalinherited
width → double
finalinherited
xAxisName → String?
Name of the x-axis to bind the series.
finalinherited
xValueMapper → ChartValueMapper<T, 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

Methods

childForSlot(SeriesSlot slot) → Widget?
Returns the widget that is currently occupying the provided slot.
inherited
createElement() → SlottedRenderObjectElement<SeriesSlot, RenderObject>
RenderObjectWidgets always inflate to a RenderObjectElement subclass.
inherited
createRenderer() → CandleSeriesRenderer<T, D>
Create the candle series renderer.
override
createRenderObject(BuildContext context) → CandleSeriesRenderer<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, int wrapWidth = 65}) → 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 CandleSeriesRenderer<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