Class SfPivotChart

Represents the control that visualizes multidimensional data from OLAP data source.

Inheritance

System.Object

SfPivotChart

Implements

System.IDisposable

Namespace: Syncfusion.UI.Xaml.PivotChart

Assembly: Syncfusion.SfPivotChart.UWP.dll

Syntax

public class SfPivotChart : Control, IDisposable

Constructors

SfPivotChart()

Initializes a new instance of the SfPivotChart class.

Declaration

public SfPivotChart()

Fields

AdornmentsInfoProperty

Dependency property for AdornmentsInfo property.

Declaration

public static DependencyProperty AdornmentsInfoProperty

Field Value

Type
Windows.UI.Xaml.DependencyProperty

AnimationDurationProperty

Identifies the AnimationDuration dependency property.

Declaration

public static DependencyProperty AnimationDurationProperty

Field Value

Type
Windows.UI.Xaml.DependencyProperty

AnnotationsProperty

Dependency property for Annotations property.

Declaration

public static DependencyProperty AnnotationsProperty

Field Value

Type
Windows.UI.Xaml.DependencyProperty

ChartTypeProperty

Identifies the ChartType dependency property.

Declaration

public static DependencyProperty ChartTypeProperty

Field Value

Type
Windows.UI.Xaml.DependencyProperty

ChartVisualStyleProperty

Identifies the ChartVisualStyle dependency property.

Declaration

public static DependencyProperty ChartVisualStyleProperty

Field Value

Type
Windows.UI.Xaml.DependencyProperty

ColorPaletteProperty

Identifies the ColorPalette dependency property.

Declaration

public static DependencyProperty ColorPaletteProperty

Field Value

Type
Windows.UI.Xaml.DependencyProperty

CustomBrushesProperty

Identifies the CustomBrushes dependency property.

Declaration

public static DependencyProperty CustomBrushesProperty

Field Value

Type
Windows.UI.Xaml.DependencyProperty

EnableAnimationProperty

Identifies the EnableAnimation dependency property.

Declaration

public static DependencyProperty EnableAnimationProperty

Field Value

Type
Windows.UI.Xaml.DependencyProperty

EnableAntiAliasingProperty

Identifies the EnableAntiAliasing dependency property.

Declaration

public static DependencyProperty EnableAntiAliasingProperty

Field Value

Type	Description
Windows.UI.Xaml.DependencyProperty	The identifier for the EnableAntiAliasing dependency property.

EnableAutoExecuteProperty

Identifies the EnableAutoExecute dependency property.

Declaration

public static DependencyProperty EnableAutoExecuteProperty

Field Value

Type
Windows.UI.Xaml.DependencyProperty

ItemSourceProperty

Identifies the ItemSource dependency property.

Declaration

public static DependencyProperty ItemSourceProperty

Field Value

Type	Description
Windows.UI.Xaml.DependencyProperty	The identifier for the ItemSource dependency property.

LegendProperty

Identifies the Legend dependency property.

Declaration

public static DependencyProperty LegendProperty

Field Value

Type
Windows.UI.Xaml.DependencyProperty

OlapDataManagerProperty

Identifies the OlapDataManager dependency property.

Declaration

public static DependencyProperty OlapDataManagerProperty

Field Value

Type
Windows.UI.Xaml.DependencyProperty

PivotAxisProperty

Identifies the PivotAxis dependency property.

Declaration

public static DependencyProperty PivotAxisProperty

Field Value

Type	Description
Windows.UI.Xaml.DependencyProperty	The identifier for the PivotAxis dependency property.

PivotCalculationsProperty

Identifies the PivotCalculations dependency property.

Declaration

public static DependencyProperty PivotCalculationsProperty

Field Value

Type	Description
Windows.UI.Xaml.DependencyProperty	The identifier for the PivotCalculations dependency property.

PivotLegendProperty

Identifies the PivotLegend dependency property.

Declaration

public static DependencyProperty PivotLegendProperty

Field Value

Type	Description
Windows.UI.Xaml.DependencyProperty	The identifier for the PivotLegend dependency property.

PrimaryAxisStyleProperty

Identifies the PrimaryAxisStyle dependency property.

Declaration

public static DependencyProperty PrimaryAxisStyleProperty

Field Value

Type
Windows.UI.Xaml.DependencyProperty

ScatterHeightProperty

Identifies the ScatterHeight dependency property.

Declaration

public static DependencyProperty ScatterHeightProperty

Field Value

Type	Description
Windows.UI.Xaml.DependencyProperty	The identifier for the ScatterHeight dependency property.

ScatterWidthProperty

Identifies the ScatterWidth dependency property.

Declaration

public static DependencyProperty ScatterWidthProperty

Field Value

Type	Description
Windows.UI.Xaml.DependencyProperty	The identifier for the ScatterWidth dependency property.

SecondaryAxisStyleProperty

Identifies the SecondaryAxisStyle dependency property.

Declaration

public static DependencyProperty SecondaryAxisStyleProperty

Field Value

Type
Windows.UI.Xaml.DependencyProperty

ShowProcessingBarProperty

Identifies the ShowProcessingBar dependency property.

Declaration

public static DependencyProperty ShowProcessingBarProperty

Field Value

Type
Windows.UI.Xaml.DependencyProperty

ShowToolTipProperty

Identifies the ShowToolTip dependency property.

Declaration

public static DependencyProperty ShowToolTipProperty

Field Value

Type
Windows.UI.Xaml.DependencyProperty

ToolTipTemplateProperty

Identifies the ToolTipTemplate dependency property.

Declaration

public static DependencyProperty ToolTipTemplateProperty

Field Value

Type
Windows.UI.Xaml.DependencyProperty

WatermarkProperty

Identifies the Watermark dependency property.

Declaration

public static DependencyProperty WatermarkProperty

Field Value

Type
Windows.UI.Xaml.DependencyProperty

ZoomPanBehaviorProperty

Identifies the ZoomPanBehavior dependency property.

Declaration

public static DependencyProperty ZoomPanBehaviorProperty

Field Value

Type
Windows.UI.Xaml.DependencyProperty

Properties

AdornmentsInfo

Gets or sets the data labels for the chart series.

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

Declaration

public PivotChartAdornmentsInfo AdornmentsInfo { get; set; }

Property Value

Type
PivotChartAdornmentsInfo

AnimationDuration

Gets or sets the duration for animation.

Declaration

public TimeSpan AnimationDuration { get; set; }

Property Value

Type
System.TimeSpan

Annotations

Gets or sets the collection of PivotChartAnnotation instances.

Declaration

public PivotChartAnnotationCollection Annotations { get; set; }

Property Value

Type
PivotChartAnnotationCollection

ChartAppearance

Gets or sets the Chart appearance and report settings.

Declaration

public ChartAppearanceSettings ChartAppearance { get; set; }

Property Value

Type
ChartAppearanceSettings

ChartType

Gets or sets the chart type to plot data.

Declaration

public PivotChartType ChartType { get; set; }

Property Value

Type
PivotChartType

ChartVisualStyle

Gets or sets the visual style for pivot chart.

Declaration

public PivotChartVisualStyle ChartVisualStyle { get; set; }

Property Value

Type
PivotChartVisualStyle

ColorPalette

Gets or sets the pivot chart color palette.

Declaration

public PivotChartColorPalette ColorPalette { get; set; }

Property Value

Type	Description
PivotChartColorPalette	The pivot chart color palette.

CurrentReport

Gets the current report that is assigned for Pivot Chart control.

Declaration

public OlapReport CurrentReport { get; }

Property Value

Type
OlapReport

CustomBrushes

Gets or sets the list of custom palette brushes.

Declaration

public List<Brush> CustomBrushes { get; set; }

Property Value

Type
System.Collections.Generic.List<Windows.UI.Xaml.Media.Brush>

EnableAnimation

Gets or sets a value indicating whether pivot chart animation is enabled.

Declaration

public bool EnableAnimation { get; set; }

Property Value

Type
System.Boolean

EnableAntiAliasing

Gets or sets a value indicating whether to enable the anti aliasing for the fast bitmap series, to draw smooth edges.

Declaration

public bool EnableAntiAliasing { get; set; }

Property Value

Type
System.Boolean

Remarks

This is applicable only for FastLineBitmap chart and FastStepLineBitmap chart.

EnableAutoExecute

Gets or sets whether the elements will automatically execute the query.

Declaration

public bool EnableAutoExecute { get; set; }

Property Value

Type	Description
System.Boolean	Returns true if [EnableAutoExecute]; otherwise, false.

ItemSource

Gets or sets source of data for this PivotTable. This object should be either an IEnumerable List.

Declaration

public object ItemSource { get; set; }

Property Value

Type
System.Object

Legend

Gets or sets the legend that identifies chart series elements.

Declaration

public PivotChartLegend Legend { get; set; }

Property Value

Type
PivotChartLegend

OlapDataManager

Gets or sets the OlapDataManager which manages OLAP data source.

Declaration

public OlapDataManager OlapDataManager { get; set; }

Property Value

Type
OlapDataManager

PivotAxis

Gets or sets the collection of PivotItems of PivotRows when using relational data source

Declaration

public ObservableCollection<PivotItem> PivotAxis { get; set; }

Property Value

Type
System.Collections.ObjectModel.ObservableCollection<PivotItem>

PivotCalculations

Gets the collection of PivotCalculations when using relational data source.

Declaration

public ObservableCollection<PivotComputationInfo> PivotCalculations { get; set; }

Property Value

Type
System.Collections.ObjectModel.ObservableCollection<PivotComputationInfo>

PivotEngine

Gets or sets the pivot engine.

Declaration

public object PivotEngine { get; set; }

Property Value

Type
System.Object

PivotLegend

Gets or sets the collection of PivotItems of PivotColumns when using the relational data source.

Declaration

public ObservableCollection<PivotItem> PivotLegend { get; set; }

Property Value

Type
System.Collections.ObjectModel.ObservableCollection<PivotItem>

PrimaryAxis

Gets the primary axis of Pivot Chart control.

Declaration

public PivotChartAxis PrimaryAxis { get; }

Property Value

Type
PivotChartAxis

PrimaryAxisStyle

Gets or sets the style for primary axis.

Declaration

public PivotChartAxisStyle PrimaryAxisStyle { get; set; }

Property Value

Type
PivotChartAxisStyle

ScatterHeight

Gets or sets the height of scatter segments.

Declaration

public int ScatterHeight { get; set; }

Property Value

Type
System.Int32

Remarks

This is applicable only for FastScatterBitmap chart and Scatter chart

ScatterWidth

Gets or sets the width of scatter segments.

Declaration

public int ScatterWidth { get; set; }

Property Value

Type
System.Int32

Remarks

This is applicable only for FastScatterBitmap chart and Scatter chart

SecondaryAxis

Gets the secondary axis of Pivot Chart control.

Declaration

public PivotChartAxis SecondaryAxis { get; }

Property Value

Type
PivotChartAxis

SecondaryAxisStyle

Gets or sets the style for secondary axis.

Declaration

public PivotChartAxisStyle SecondaryAxisStyle { get; set; }

Property Value

Type
PivotChartAxisStyle

ShowProcessingBar

Gets or sets a value indicating whether the progressing bar should be shown.

Declaration

public bool ShowProcessingBar { get; set; }

Property Value

Type
System.Boolean

ShowToolTip

Gets or sets a value indicating whether the tooltip should be shown on series.

Declaration

public bool ShowToolTip { get; set; }

Property Value

Type
System.Boolean

ToolTipTemplate

Gets or sets the template for series tooltip.

Declaration

public DataTemplate ToolTipTemplate { get; set; }

Property Value

Type
Windows.UI.Xaml.DataTemplate

Watermark

Gets or sets the watermark content for Pivot Chart control.

Declaration

public PivotChartWatermark Watermark { get; set; }

Property Value

Type
PivotChartWatermark

ZoomPanBehavior

Gets or sets the operations of zooming and panning over Pivot Chart control.

Declaration

public PivotChartZoomPanBehavior ZoomPanBehavior { get; set; }

Property Value

Type
PivotChartZoomPanBehavior

Methods

add_AfterDataRefresh(PivotDataRefreshEventHandler)

Declaration

public void add_AfterDataRefresh(PivotDataRefreshEventHandler value)

Parameters

Type	Name	Description
PivotDataRefreshEventHandler	value

add_BeforeDataRefresh(PivotDataRefreshEventHandler)

Declaration

public void add_BeforeDataRefresh(PivotDataRefreshEventHandler value)

Parameters

Type	Name	Description
PivotDataRefreshEventHandler	value

add_LabelExpanderClick(PivotChartLabelClickEventHandler)

Declaration

public void add_LabelExpanderClick(PivotChartLabelClickEventHandler value)

Parameters

Type	Name	Description
PivotChartLabelClickEventHandler	value

add_RefreshCompleted(PivotDataRefreshEventHandler)

Declaration

public void add_RefreshCompleted(PivotDataRefreshEventHandler value)

Parameters

Type	Name	Description
PivotDataRefreshEventHandler	value

add_RefreshStarted(PivotDataRefreshEventHandler)

Declaration

public void add_RefreshStarted(PivotDataRefreshEventHandler value)

Parameters

Type	Name	Description
PivotDataRefreshEventHandler	value

DataBind()

Binds the data to the Pivot Chart control.

Declaration

public void DataBind()

Deserialize()

Deserialize the XML file format into SfPivotChart control.

Declaration

public void Deserialize()

Deserialize(Stream)

Deserialize the PivotChart from the specified file stream.

Stream

Declaration

public void Deserialize(Stream stream)

Parameters

Type	Name	Description
System.IO.Stream	stream

Deserialize(String)

Deserialize the XML string format into SfPivotChart control.

Declaration

public void Deserialize(string xmlString)

Parameters

Type	Name	Description
System.String	xmlString

Deserialize(StorageFile)

Deserialize the PivotChart from the specified storage file.

StorageFile

Declaration

public void Deserialize(StorageFile storageFile)

Parameters

Type	Name	Description
Windows.Storage.StorageFile	storageFile

Dispose()

Performs application-defined tasks associated with freeing, releasing, or resetting unmanaged resources.

Declaration

public void Dispose()

GetChartImageAsync()

Gets the chart control as image.

Declaration

public Task<BitmapImage> GetChartImageAsync()

Returns

Type	Description
System.Threading.Tasks.Task<Windows.UI.Xaml.Media.Imaging.BitmapImage>	The object source type for image.

MeasureOverride(Size)

Measures the size required for child elements in layout and determines a size for this element.

Declaration

protected override Size MeasureOverride(Size availableSize)

Parameters

Type	Name	Description
Windows.Foundation.Size	availableSize	The size that is available to child elements. Infinity can be specified as a value to indicate that the element will size to whatever content is available.

Returns

Type	Description
Windows.Foundation.Size	The size that this element needs during layout, which is based on the calculations of child element's sizes.

OnApplyTemplate()

Builds the visual tree for this control when a new template is applied.

Declaration

protected override void OnApplyTemplate()

remove_AfterDataRefresh(PivotDataRefreshEventHandler)

Declaration

public void remove_AfterDataRefresh(PivotDataRefreshEventHandler value)

Parameters

Type	Name	Description
PivotDataRefreshEventHandler	value

remove_BeforeDataRefresh(PivotDataRefreshEventHandler)

Declaration

public void remove_BeforeDataRefresh(PivotDataRefreshEventHandler value)

Parameters

Type	Name	Description
PivotDataRefreshEventHandler	value

remove_LabelExpanderClick(PivotChartLabelClickEventHandler)

Declaration

public void remove_LabelExpanderClick(PivotChartLabelClickEventHandler value)

Parameters

Type	Name	Description
PivotChartLabelClickEventHandler	value

remove_RefreshCompleted(PivotDataRefreshEventHandler)

Declaration

public void remove_RefreshCompleted(PivotDataRefreshEventHandler value)

Parameters

Type	Name	Description
PivotDataRefreshEventHandler	value

remove_RefreshStarted(PivotDataRefreshEventHandler)

Declaration

public void remove_RefreshStarted(PivotDataRefreshEventHandler value)

Parameters

Type	Name	Description
PivotDataRefreshEventHandler	value

SaveToImageAsync()

Saves the Pivot Chart control as an image.

Declaration

public void SaveToImageAsync()

Serialize()

Serialize some specific properties in SfPivotChart control.

Declaration

public void Serialize()

Serialize(Stream)

Serialize some specific properties in SfPivotChart control from the file stream.

Stream

Declaration

public void Serialize(Stream stream)

Parameters

Type	Name	Description
System.IO.Stream	stream

Serialize(StorageFile)

Serialize the PivotChart from the specified storage file.

StorageFile

Declaration

public void Serialize(StorageFile storageFile)

Parameters

Type	Name	Description
Windows.Storage.StorageFile	storageFile

SerializeToXml()

Serialize some specific properties in SfPivotChart control into string format.

Declaration

public string SerializeToXml()

Returns

Type
System.String

Events

AfterDataRefresh

Occurs after the data gets refreshed.

Declaration

public event PivotDataRefreshEventHandler AfterDataRefresh

Event Type

Type
PivotDataRefreshEventHandler

BeforeDataRefresh

Occurs before the data gets refreshed.

Declaration

public event PivotDataRefreshEventHandler BeforeDataRefresh

Event Type

Type
PivotDataRefreshEventHandler

LabelExpanderClick

Occurs when the primary axis label's expander is clicked.

Declaration

public event PivotChartLabelClickEventHandler LabelExpanderClick

Event Type

Type
PivotChartLabelClickEventHandler

RefreshCompleted

Occurs when the pivot data refresh completed.

Declaration

public event PivotDataRefreshEventHandler RefreshCompleted

Event Type

Type
PivotDataRefreshEventHandler

RefreshStarted

Occurs when the pivot data refresh started.

Declaration

public event PivotDataRefreshEventHandler RefreshStarted

Event Type

Type
PivotDataRefreshEventHandler

Implements

System.IDisposable

Extension Methods

DateTimeExtension.ToDateTime(Object)