Class OlapArea

Represents OLAP Chart area class.

Inheritance
System.Object
ChartArea
OlapArea
Implements
System.IDisposable
Inherited Members
Namespace: Syncfusion.Windows.Chart.Olap
Assembly: Syncfusion.OlapChart.WPF.dll
Syntax
public sealed class OlapArea : ChartArea, IDisposable, IChartSerializer

Constructors

OlapArea()

Initializes a new instance of the OlapArea class.

Declaration
public OlapArea()
Remarks

Primary and secondary axes are being created automatically.

Fields

ChartTypeProperty

Identifies the ChartType dependency property.

Declaration
public static readonly DependencyProperty ChartTypeProperty
Field Value
Type Description
System.Windows.DependencyProperty

IsKpiElement

Boolean property to check whether the element is KPI element or not.

Declaration
public static bool IsKpiElement
Field Value
Type Description
System.Boolean

IsRealTimeUpdateProperty

Identifies the dependency property for IsRealTimeUpdate.

Declaration
public static readonly DependencyProperty IsRealTimeUpdateProperty
Field Value
Type Description
System.Windows.DependencyProperty

OlapDataManagerProperty

Identifies the OlapDataManager dependency property.

Declaration
public static readonly DependencyProperty OlapDataManagerProperty
Field Value
Type Description
System.Windows.DependencyProperty

PivotEngineProperty

Identifies the PivotEngine dependency property.

Declaration
public static readonly DependencyProperty PivotEngineProperty
Field Value
Type Description
System.Windows.DependencyProperty

PivotEnginePropertyKey

Declaration
public static DependencyPropertyKey PivotEnginePropertyKey
Field Value
Type Description
System.Windows.DependencyPropertyKey

Properties

ChartType

Gets or sets the ChartType. This is a dependency property.

Declaration
public ChartTypes ChartType { get; set; }
Property Value
Type Description
ChartTypes

The ChartType.

IsRealTimeUpdate

Gets or Sets whether RealTime updating is enabled or disabled.

Declaration
public bool IsRealTimeUpdate { get; set; }
Property Value
Type Description
System.Boolean

OlapDataManager

Gets or sets the cube model.

Declaration
public OlapDataManager OlapDataManager { get; set; }
Property Value
Type Description
OlapDataManager

The cube model.

PivotEngine

Gets the value of the PivotEngine. This is a dependency property.

Declaration
public PivotEngine PivotEngine { get; }
Property Value
Type Description
PivotEngine

PrimaryAxis

Gets or sets the primary axis.

Declaration
public ChartAxis PrimaryAxis { get; set; }
Property Value
Type Description
ChartAxis

The primay axis.

Series

Gets or sets the Syncfusion.Windows.Chart.ChartSeriesCollection series.

Declaration
public ChartSeriesCollection Series { get; set; }
Property Value
Type Description
Syncfusion.Windows.Chart.ChartSeriesCollection

The series.

Methods

DataBind()

Generates the CellSet which in turns generates PivotEngine for rendering the data to OlapArea.

Declaration
public void DataBind()

IsToolTipSupported(ChartTypes)

Determines whether ToolTip is supported for the specified chart type.

Declaration
public static bool IsToolTipSupported(ChartTypes chartType)
Parameters
Type Name Description
ChartTypes chartType

Type of the chart.
Returns
Type Description
System.Boolean

true if ToolTip is supported for the specified chart type; otherwise, false.

OnApplyTemplate()

Invoked whenever application code or internal processes call System.Windows.FrameworkElement.ApplyTemplate.

Declaration
public override void OnApplyTemplate()
Overrides

OnPropertyChanged(DependencyPropertyChangedEventArgs)

Invoked whenever the effective value of any dependency property on this System.Windows.FrameworkElement has been updated. The specific dependency property that changed is reported in the arguments parameter. Overrides System.Windows.DependencyObject.OnPropertyChanged(System.Windows.DependencyPropertyChangedEventArgs).

Declaration
protected override void OnPropertyChanged(DependencyPropertyChangedEventArgs e)
Parameters
Type Name Description
System.Windows.DependencyPropertyChangedEventArgs e

The event data that describes the property that changed, as well as old and new values.
Overrides

UpdateKPIAlignment()

Updates the KPI alignment.

Declaration
public void UpdateKPIAlignment()

UpdateKPIValues(PivotCellDescriptor, ChartSeries)

Updates the KPI values.

Declaration
public void UpdateKPIValues(PivotCellDescriptor cellDescriptor, ChartSeries series)
Parameters
Type Name Description
PivotCellDescriptor cellDescriptor

The cell descriptor.
ChartSeries series

The series.

Events

AfterRefresh

Raised after OlapArea got refreshed.

Declaration
public event OlapRefreshEventHandler AfterRefresh
Event Type
Type Description
OlapRefreshEventHandler

BeforeRefresh

Raised before refreshing OlapArea.

Declaration
public event OlapRefreshEventHandler BeforeRefresh
Event Type
Type Description
OlapRefreshEventHandler

Implements

System.IDisposable