PyramidSeries<T, D> class
Null safety
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
- Object
- ChartSeries<
T, D> - PyramidSeries
Constructors
-
PyramidSeries({ValueKey<
String> ? key, ChartSeriesRendererFactory<T, D> ? onCreateRenderer, PyramidSeriesRendererCreatedCallback? onRendererCreated, List<T> ? dataSource, ChartValueMapper<T, D> ? xValueMapper, ChartValueMapper<T, num> ? yValueMapper, ChartValueMapper<T, Color> ? pointColorMapper, ChartValueMapper<T, String> ? textFieldMapper, String? name, String? height, String? width, PyramidMode? pyramidMode, double? gapRatio, LegendIconType? legendIconType, EmptyPointSettings? emptyPointSettings, DataLabelSettings? dataLabelSettings, double? animationDuration, double? opacity, Color? borderColor, double? borderWidth, bool? explode, num? explodeIndex, ActivationMode? explodeGesture, String? explodeOffset, SelectionSettings? selectionSettings, SelectionBehavior? selectionBehavior, List<int> ? initialSelectedDataIndexes}) - Creating an argument constructor of PyramidSeries class.
Properties
- animationDuration → double
-
Duration for animating the data points. [...]
final, inherited
- borderColor → Color
-
Border color of the data points in the series. [...]
final, inherited
- borderWidth → double
-
Border width of the data points in the series. [...]
final, inherited
-
dataLabelMapper
→ ChartIndexedValueMapper<
String> ? -
Field in the data source, which is considered as text for the data points. [...]
final, inherited
- dataLabelSettings → DataLabelSettings
-
Enables the dataLabel of the series [...]
final, inherited
-
dataSource
→ List<
T> ? -
A collection of data required for rendering the series. If no data source is specified,
empty chart will be rendered without series. [...]
final, inherited
- emptyPointSettings → EmptyPointSettings
-
Customizes the empty data points in the series [...]
final, inherited
- enableTooltip → bool
-
Enables or disables the tooltip for this series. Tooltip will display more details
about data points when tapping the data point region. [...]
final, inherited
- explode → bool
-
Enables or disables the explode of slices on tap. [...]
final, inherited
- explodeGesture → ActivationMode
-
Gesture for activating the explode. Explode can be activated in tap, double tap,
and long press. [...]
final, inherited
- explodeIndex → num?
-
Index of the slice to explode it at the initial rendering. [...]
final, inherited
- explodeOffset → String
-
Offset of exploded slice. The value ranges from 0% to 100%. [...]
final, inherited
- gapRatio → double
-
Gap ratio between the segments of pyramid. Ranges from 0 to 1 [...]
final, inherited
- hashCode → int
-
The hash code for this object. [...]
read-only, inherited
- height → String
-
Height of the series. [...]
final, inherited
-
initialSelectedDataIndexes
↔ List<
int> -
List of data indexes initially selected [...]
read / write, inherited
- isVisible → bool?
-
Visibility of the series [...]
final, inherited
-
key
→ ValueKey<
String> ? -
Key to identify a series in a collection. [...]
final, inherited
- 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. [...]
final, inherited
- 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. [...]
final, inherited
- name → String?
-
Name of the series. [...]
final, inherited
-
onCreateRenderer
→ ChartSeriesRendererFactory<
T, D> ? -
Used to create the renderer for custom series. [...]
final, inherited
- onRendererCreated → PyramidSeriesRendererCreatedCallback?
-
Triggers when the series renderer is created. [...]
final, inherited
- opacity → double
-
Opacity of the series. The value ranges from 0 to 1. [...]
final, inherited
-
pointColorMapper
→ ChartIndexedValueMapper<
Color> ? -
Maps the field name, which will be considered as data point color. [...]
final, inherited
- pyramidMode → PyramidMode
-
Specifies the rendering type of pyramid. [...]
final, inherited
- runtimeType → Type
-
A representation of the runtime type of the object.
read-only, inherited
- selectionBehavior → SelectionBehavior
-
Customizes the selection of series. [...]
final, inherited
- selectionSettings → SelectionSettings
-
Customizes the selection of series. [...]
final, inherited
- sortFieldValueMapper → ChartIndexedValueMapper?
-
Field in the data source, which is considered for sorting the data points. [...]
final, inherited
- 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. [...]
final, inherited
-
textFieldMapper
→ ChartIndexedValueMapper<
String> ? -
Maps the field name, which will be considered as text for data label. [...]
final, inherited
- width → String
-
Width of the series. [...]
final, inherited
-
xValueMapper
→ ChartIndexedValueMapper<
D> ? -
Maps the field name, which will be considered as x-values. [...]
final, inherited
-
yValueMapper
→ ChartIndexedValueMapper<
num> ? -
Maps the field name, which will be considered as y-values. [...]
final, inherited
Methods
-
calculateEmptyPointValue(
int pointIndex, dynamic currentPoint, dynamic seriesRenderer) → void -
to calculte the values of the empty points.
inherited
-
createRenderer(
PyramidSeries< T, D> series) → PyramidSeriesRenderer - Create the pie series renderer.
-
noSuchMethod(
Invocation invocation) → dynamic -
Invoked when a non-existent method or property is accessed. [...]
inherited
-
toString(
) → String -
A string representation of this object. [...]
inherited
Operators
-
operator ==(
Object other) → bool -
The equality operator. [...]
inherited