PyramidSeries<T, D> class

Renders the pyramid series.

To render a pyramid chart, create an instance of PyramidSeries, and add it to the series property of SfPyramidChart, it is the form of a triangle with lines dividing it into sections.

Provides the property of color, opacity, border color and border width for customizing the appearance.

Inheritance

Constructors

PyramidSeries({ValueKey<String>? key, ChartSeriesRendererFactory<T, D>? onCreateRenderer, PyramidSeriesRendererCreatedCallback<T, D>? onRendererCreated, ChartPointInteractionCallback? onPointTap, ChartPointInteractionCallback? onPointDoubleTap, ChartPointInteractionCallback? onPointLongPress, List<T>? dataSource, ChartValueMapper<T, D>? xValueMapper, ChartValueMapper<T, num>? yValueMapper, ChartValueMapper<T, Color>? pointColorMapper, ChartValueMapper<T, String>? textFieldMapper, String? name, num? explodeIndex, String height = '80%', String width = '80%', PyramidMode pyramidMode = PyramidMode.linear, double gapRatio = 0, EmptyPointSettings emptyPointSettings = const EmptyPointSettings(), String explodeOffset = '10%', bool explode = false, ActivationMode explodeGesture = ActivationMode.singleTap, Color borderColor = Colors.transparent, double borderWidth = 2.0, LegendIconType legendIconType = LegendIconType.seriesType, DataLabelSettings dataLabelSettings = const DataLabelSettings(), double animationDuration = 1500, double animationDelay = 0, double opacity = 1.0, SelectionBehavior? selectionBehavior, List<int>? initialSelectedDataIndexes})
Creates an instance of pyramid series base.
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
borderColor → Color
final
borderWidth → double
Border width of the series.
finalinherited
color → Color?
Color 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
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
explode → bool
Enables or disables the explode of slices on tap.
final
explodeGesture → ActivationMode
Gesture for activating the explode.
final
explodeIndex → num?
Index of the slice to explode it at the initial rendering.
final
explodeOffset → String
Offset of exploded slice. The value ranges from 0% to 100%.
final
gapRatio → double
Gap ratio between the segments of pyramid. Ranges from 0 to 1.
final
hashCode → int
The hash code for this object.
no setterinherited
height → String
Height of the series.
final
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
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.
final
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 → PyramidSeriesRendererCreatedCallback<T, D>?
Triggers when the series renderer is created. Using this callback, able to get the ChartSeriesController instance, which is used to access the public methods in the series.
final
opacity → double
Opacity of the series. The value ranges from 0 to 1.
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 setteroverride
pyramidMode → PyramidMode
Specifies the rendering type of pyramid.
final
runtimeType → Type
A representation of the runtime type of the object.
no setterinherited
selectionBehavior → SelectionBehavior?
Customizes the data points or series on selection.
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
width → String
Width of the series.
final
xValueMapper → ChartValueMapper<T, D>?
Field in the data source, which is considered as x-value.
finalinherited
yValueMapper → ChartValueMapper<T, num>?
Maps the field name, which will be considered as y-values.
final

Methods

childForSlot(SeriesSlot slot) → Widget?
Returns the widget that is currently occupying the provided slot.
override
createElement() → SlottedRenderObjectElement<SeriesSlot, RenderObject>
RenderObjectWidgets always inflate to a RenderObjectElement subclass.
inherited
createRenderer() → PyramidSeriesRenderer<T, D>
override
createRenderObject(BuildContext context) → PyramidSeriesRenderer<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}) → 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
updateRenderObject(BuildContext context, covariant PyramidSeriesRenderer<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