PlotBand class

Render plot band.

Plot bands are also known as strip lines, which are used to shade the different ranges in plot area with different colors to improve the readability of the chart.

Plot bands are drawn based on the axis, you have to add plot bands using the plotBands property of the respective axis. You can also add multiple plot bands to an axis.

Provides the property of visible, opacity, start, end, color, border color, and border width to customize the appearance.

Annotations

Constructors

PlotBand({bool isVisible = true, dynamic start, dynamic end, Color color = Colors.grey, double opacity = 1.0, Color borderColor = Colors.transparent, double borderWidth = 0, String? text, TextStyle? textStyle, bool isRepeatable = false, dynamic repeatEvery = 1, String? verticalTextPadding, String? horizontalTextPadding, dynamic repeatUntil, double? textAngle, bool shouldRenderAboveSeries = false, DateTimeIntervalType sizeType = DateTimeIntervalType.auto, List<double> dashArray = const <double>[0, 0], dynamic size, dynamic associatedAxisStart, dynamic associatedAxisEnd, TextAnchor verticalTextAlignment = TextAnchor.middle, TextAnchor horizontalTextAlignment = TextAnchor.middle, LinearGradient? gradient})
Creating an argument constructor of PlotBand class.

Properties

associatedAxisEnd → dynamic
Perpendicular axis end value.
final
associatedAxisStart → dynamic
Perpendicular axis start value.
final
borderColor Color
Color of the plot band border.
final
borderWidth double
Width of the plot band border.
final
color Color
Color of the plot band.
final
dashArray List<double>
Dashes of the series. Any number of values can be provided in the list. Odd value is considered as rendering size and even value is considered as gap.
final
end → dynamic
Specifies the end value of plot band.
final
gradient LinearGradient?
Fills the plot band with gradient color.
final
hashCode int
The hash code for this object.
no setteroverride
horizontalTextAlignment TextAnchor
Horizontal text alignment of the plot band text.
final
horizontalTextPadding String?
To move the plot band text horizontally.
final
isRepeatable bool
Specifies the plot band need to be repeated in specified interval.
final
isVisible bool
Toggles the visibility of the plot band.
final
opacity double
Opacity of the plot band. The value ranges from 0 to 1.
final
repeatEvery → dynamic
Interval of the plot band need to be repeated.
final
repeatUntil → dynamic
End of the plot band need to be repeated.
final
runtimeType Type
A representation of the runtime type of the object.
no setterinherited
shouldRenderAboveSeries bool
Specifies whether the plot band needs to be rendered above the series.
final
size → dynamic
Size of the plot band.
final
sizeType DateTimeIntervalType
Date time interval type of the plot band.
final
start → dynamic
Specifies the start value of plot band.
final
text String?
Text to be displayed in the plot band segment.
final
textAngle double?
Angle of the plot band text.
final
textStyle TextStyle?
Customizes the text style of plot band.
final
verticalTextAlignment TextAnchor
Vertical text alignment of the plot band text.
final
verticalTextPadding String?
To move the plot band text vertically.
final

Methods

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