Class SfPyramidChart

Represents the pyramid chart, which is the form of a triangle with lines dividing it into sections, each section with a different width. Depending on the Y coordinates, this width indicates a level of hierarchy among other categories. It supports data label, tooltip, and selection.

Inheritance

System.Object

ChartBase

SfPyramidChart

Implements

System.IDisposable

Inherited Members

ChartBase.VisibleSeriesProperty

ChartBase.PaletteProperty

ChartBase.HeaderProperty

ChartBase.HorizontalHeaderAlignmentProperty

ChartBase.VerticalHeaderAlignmentProperty

ChartBase.ColorModelProperty

ChartBase.LegendProperty

ChartBase.SuspendSeriesNotification()

ChartBase.ResumeSeriesNotification()

ChartBase.Dispose()

ChartBase.OnApplyTemplate()

ChartBase.MeasureOverride(Size)

ChartBase.OnLostFocus(RoutedEventArgs)

ChartBase.OnGotFocus(RoutedEventArgs)

ChartBase.OnPointerCaptureLost(PointerRoutedEventArgs)

ChartBase.OnTapped(TappedRoutedEventArgs)

ChartBase.OnRightTapped(RightTappedRoutedEventArgs)

ChartBase.OnPointerWheelChanged(PointerRoutedEventArgs)

ChartBase.OnPointerExited(PointerRoutedEventArgs)

ChartBase.OnPointerEntered(PointerRoutedEventArgs)

ChartBase.OnPointerCanceled(PointerRoutedEventArgs)

ChartBase.OnKeyUp(KeyRoutedEventArgs)

ChartBase.OnKeyDown(KeyRoutedEventArgs)

ChartBase.OnHolding(HoldingRoutedEventArgs)

ChartBase.OnManipulationStarting(ManipulationStartingRoutedEventArgs)

ChartBase.OnManipulationStarted(ManipulationStartedRoutedEventArgs)

ChartBase.OnManipulationInertiaStarting(ManipulationInertiaStartingRoutedEventArgs)

ChartBase.OnManipulationCompleted(ManipulationCompletedRoutedEventArgs)

ChartBase.OnManipulationDelta(ManipulationDeltaRoutedEventArgs)

ChartBase.OnPointerPressed(PointerRoutedEventArgs)

ChartBase.OnPointerMoved(PointerRoutedEventArgs)

ChartBase.OnPointerReleased(PointerRoutedEventArgs)

ChartBase.OnDoubleTapped(DoubleTappedRoutedEventArgs)

ChartBase.OnDrop(DragEventArgs)

ChartBase.OnDragOver(DragEventArgs)

ChartBase.OnDragLeave(DragEventArgs)

ChartBase.OnDragEnter(DragEventArgs)

ChartBase.Behaviors

ChartBase.SeriesClipRect

ChartBase.VisibleSeries

ChartBase.Palette

ChartBase.SelectedSeriesIndex

ChartBase.Header

ChartBase.HorizontalHeaderAlignment

ChartBase.VerticalHeaderAlignment

ChartBase.ColorModel

ChartBase.Legend

ChartBase.SelectionChanged

ChartBase.SelectionChanging

ChartBase.SeriesBoundsChanged

Namespace: Syncfusion.UI.Xaml.Charts

Assembly: Syncfusion.Chart.WinUI.dll

Syntax

public class SfPyramidChart : ChartBase, IDisposable

Remarks

It is a single chart, representing data as portions of 100% and does not use any axes.

Examples

• MainWindow.xaml
• MainWindow.cs

    <chart:SfPyramidChart ItemsSource="{Binding Data}" XBindingPath="XValue" 
              YBindingPath="YValue">

         <chart:SfPyramidChart.DataContext>
           <local:ViewModel/>
         </chart:SfPyramidChart.DataContext>

    </chart:SfPyramidChart>

Constructors

SfPyramidChart()

Initializes a new instance of the SfPyramidChart class.

Declaration

public SfPyramidChart()

Fields

ColorValuePathProperty

Identifies the ColorValuePath dependency property.

Declaration

public static readonly DependencyProperty ColorValuePathProperty

Field Value

Type	Description
Microsoft.UI.Xaml.DependencyProperty	The identifier for ColorValuePath dependency property.

DataLabelSettingsProperty

Identifies the DataLabelSettings dependency property.

Declaration

public static readonly DependencyProperty DataLabelSettingsProperty

Field Value

Type	Description
Microsoft.UI.Xaml.DependencyProperty	The identifier for DataLabelSettings dependency property.

ExplodeIndexProperty

Identifies the ExplodeIndex dependency property.

Declaration

public static readonly DependencyProperty ExplodeIndexProperty

Field Value

Type	Description
Microsoft.UI.Xaml.DependencyProperty	The identifier for ExplodeIndex dependency property.

ExplodeOffsetProperty

Identifies the ExplodeOffset dependency property.

Declaration

public static readonly DependencyProperty ExplodeOffsetProperty

Field Value

Type	Description
Microsoft.UI.Xaml.DependencyProperty	The identifier for ExplodeOffset dependency property.

ExplodeOnTapProperty

Identifies the ExplodeOnTap dependency property.

Declaration

public static readonly DependencyProperty ExplodeOnTapProperty

Field Value

Type	Description
Microsoft.UI.Xaml.DependencyProperty	The identifier for ExplodeOnTap dependency property.

GapRatioProperty

Identifies the GapRatio dependency property.

Declaration

public static readonly DependencyProperty GapRatioProperty

Field Value

Type	Description
Microsoft.UI.Xaml.DependencyProperty	The identifier for GapRatio dependency property.

ItemsSourceProperty

Identifies the ItemsSource dependency property.

Declaration

public static readonly DependencyProperty ItemsSourceProperty

Field Value

Type	Description
Microsoft.UI.Xaml.DependencyProperty	The identifier for ItemsSource dependency property.

ModeProperty

Identifies the Mode dependency property.

Declaration

public static readonly DependencyProperty ModeProperty

Field Value

Type	Description
Microsoft.UI.Xaml.DependencyProperty	The identifier for Mode dependency property.

SelectedIndexProperty

Identifies the SelectedIndex dependency property.

Declaration

public static readonly DependencyProperty SelectedIndexProperty

Field Value

Type	Description
Microsoft.UI.Xaml.DependencyProperty	The identifier for SelectedIndex dependency property.

SelectionBrushProperty

Identifies the SelectionBrush dependency property.

Declaration

public static readonly DependencyProperty SelectionBrushProperty

Field Value

Type	Description
Microsoft.UI.Xaml.DependencyProperty	The identifier for SelectionBrush dependency property.

ShowDataLabelsProperty

Identifies the ShowDataLabels dependency property.

Declaration

public static readonly DependencyProperty ShowDataLabelsProperty

Field Value

Type	Description
Microsoft.UI.Xaml.DependencyProperty	The identifier for ShowDataLabels dependency property and its default value is false.

ShowTooltipProperty

Identifies the ShowTooltip dependency property.

Declaration

public static readonly DependencyProperty ShowTooltipProperty

Field Value

Type	Description
Microsoft.UI.Xaml.DependencyProperty	The identifier for ShowTooltip dependency property.

TooltipTemplateProperty

Identifies the TooltipTemplate dependency property.

Declaration

public static readonly DependencyProperty TooltipTemplateProperty

Field Value

Type	Description
Microsoft.UI.Xaml.DependencyProperty	The identifier for TooltipTemplate dependency property.

XBindingPathProperty

Identifies the XBindingPath dependency property.

Declaration

public static readonly DependencyProperty XBindingPathProperty

Field Value

Type	Description
Microsoft.UI.Xaml.DependencyProperty	The identifier for XBindingPath dependency property.

YBindingPathProperty

Identifies the YBindingPath dependency property.

Declaration

public static readonly DependencyProperty YBindingPathProperty

Field Value

Type	Description
Microsoft.UI.Xaml.DependencyProperty	The identifier for YBindingPath dependency property.

Properties

ColorValuePath

Gets or sets the property binding path for segment color.

Declaration

public string ColorValuePath { get; set; }

Property Value

Type	Description
System.String	The string that represents the property name for segment color. The default value is null.

DataLabelSettings

Gets or sets data labels for the series. This allows us to customize the appearance of a data point by displaying labels, shapes and connector lines.

Declaration

public PyramidDataLabelSettings DataLabelSettings { get; set; }

Property Value

Type	Description
PyramidDataLabelSettings	The ChartDataLabelSettings value.

Examples

• MainWindow.xaml
• MainWindow.cs

    <chart:SfPyramidChart ItemsSource="{Binding Data}" XBindingPath="XValue" YBindingPath="YValue" ShowDataLabels="True">

         <chart:SfPyramidChart.DataContext>
           <local:ViewModel/>
         </chart:SfPyramidChart.DataContext>

         <syncfusion:SfPyramidChart.DataLabelSettings>
               <chart:PyramidDataLabelSettings/>
         <syncfusion:SfPyramidChart.DataLabelSettings>

    </chart:SfPyramidChart>

ExplodeIndex

Gets or sets the index of data point (or segment) of chart series to be exploded.

Declaration

public int ExplodeIndex { get; set; }

Property Value

Type	Description
System.Int32	Default value is -1.

ExplodeOffset

Gets or sets the distance where the segment is exploded from its origination positions when ExplodeAll is true or ExplodeIndex value is given.

Declaration

public double ExplodeOffset { get; set; }

Property Value

Type	Description
System.Double	Default value is 40.

ExplodeOnTap

Gets or sets a value indicating whether segment slices will explode on clicking or tappping.

Declaration

public bool ExplodeOnTap { get; set; }

Property Value

Type	Description
System.Boolean	if true, the segment will explode on clicking or tappping.

GapRatio

Gets or sets the ratio of distance between the pyramid segment blocks.

Declaration

public double GapRatio { get; set; }

Property Value

Type	Description
System.Double	Default value is 0 and its value ranges from 0 to 1.

Remarks

Its used to provide the spacing between the segments.

Examples

• MainWindow.xaml
• MainWindow.cs

    <chart:SfPyramidChart GapRatio="0.5" YBindingPath="YValue" 
              XBindingPath="XValue" ItemsSource="{Binding Data}">

         <chart:SfPyramidChart.DataContext>
           <local:ViewModel/>
         </chart:SfPyramidChart.DataContext>

    </chart:SfPyramidChart>

ItemsSource

Gets or sets a collection of data points used to generate chart.

Declaration

public object ItemsSource { get; set; }

Property Value

Type	Description
System.Object	The ItemsSource value.

Examples

• MainWindow.xaml
• MainWindow.cs

    <chart:SfPyramidChart ItemsSource="{Binding Data}" XBindingPath="XValue" 
              YBindingPath="YValue">

         <chart:SfPyramidChart.DataContext>
           <local:ViewModel/>
         </chart:SfPyramidChart.DataContext>

    </chart:SfPyramidChart>

Mode

Gets or sets a value indicating whether the y value should interpret the length or surface of the pyramid block.

Declaration

public ChartPyramidMode Mode { get; set; }

Property Value

Type	Description
ChartPyramidMode	One of the ChartPyramidMode enumeration values. The default value is Linear

SelectedIndex

Gets or sets the index of the first segment in the current selection or returns negative one (-1) if the selection is empty.

Declaration

public int SelectedIndex { get; set; }

Property Value

Type	Description
System.Int32	The index of first segment in the current selection. The default value is negative one (-1).

See Also

SelectionBrush

SelectionBrush

Gets or sets the interior (brush) for the selected segment(s).

Declaration

public Brush SelectionBrush { get; set; }

Property Value

Type	Description
Microsoft.UI.Xaml.Media.Brush	The Microsoft.UI.Xaml.Media.Brush value.

ShowDataLabels

Gets or sets a value that indicates to enable the data labels for the pyramid chart.

Declaration

public bool ShowDataLabels { get; set; }

Property Value

Type	Description
System.Boolean	It takes the bool value and its default value is false.

ShowTooltip

Gets or sets a value indicating whether to show or hide the tooltip for series.

Declaration

public bool ShowTooltip { get; set; }

Property Value

Type	Description
System.Boolean	if true, the series tooltip will show on clicking or tapping the series area.

TooltipTemplate

Gets or sets the DataTemplate used to customize the tooltip appearence.

Declaration

public DataTemplate TooltipTemplate { get; set; }

Property Value

Type	Description
Microsoft.UI.Xaml.DataTemplate	This accepts a Microsoft.UI.Xaml.DataTemplate value.

Examples

  <syncfusion:SfPyramidChart ShowTooltip="True" ItemsSource="{Binding Demands} XBindingPath="Demand" YBindingPath="Year2010">
     <syncfusion:SfPyramidChart.TooltipTemplate>
       <DataTemplate>
           <Border Background="DarkGreen" CornerRadius="5" BorderThickness="2" BorderBrush="Black" Width="50" Height="30">
               <TextBlock Text="{Binding Item.Year2010}" Foreground="White" FontWeight="Bold"  HorizontalAlignment="Center" VerticalAlignment="Center"/>
           </Border>
       </DataTemplate>
     </syncfusion:SfPyramidChart.TooltipTemplate>
  </syncfusion:SfPyramidChart>        

XBindingPath

Gets or sets the property name that associates the primary axis with a property in the itemssource.

Declaration

public string XBindingPath { get; set; }

Property Value

Type	Description
System.String	The string that represents the property name for primary axis. The default value is null.

Examples

• MainWindow.xaml
• MainWindow.cs

    <chart:SfPyramidChart XBindingPath="XValue" 
              YBindingPath="YValue" ItemsSource="{Binding Data}">

         <chart:SfPyramidChart.DataContext>
           <local:ViewModel/>
         </chart:SfPyramidChart.DataContext>

    </chart:SfPyramidChart>

YBindingPath

Gets or sets the property name that associates the secondary axis with a property in the itemssource.

Declaration

public string YBindingPath { get; set; }

Property Value

Type	Description
System.String	The string that represents the property name for secondary axis. The default value is null.

Examples

• MainWindow.xaml
• MainWindow.cs

    <chart:SfPyramidChart YBindingPath="YValue" 
              XBindingPath="XValue" ItemsSource="{Binding Data}">

         <chart:SfPyramidChart.DataContext>
           <local:ViewModel/>
         </chart:SfPyramidChart.DataContext>

    </chart:SfPyramidChart>

Methods

Dispose(Boolean)

Disposing chart objects.

Declaration

protected override void Dispose(bool disposing)

Parameters

Type	Name	Description
System.Boolean	disposing	Used to indicate perform dispose or not.

Overrides

ChartBase.Dispose(Boolean)

Implements

System.IDisposable