Class OlapChart

Represents OlapChart control.

Inheritance

System.Object

OlapChart

Namespace: Syncfusion.Windows.Chart.Olap

Assembly: Syncfusion.OlapChart.WPF.dll

Syntax

[SkinType]
[SkinType]
[SkinType]
[SkinType]
[SkinType]
[SkinType]
[SkinType]
[SkinType]
[SkinType]
[SkinType]
[SkinType]
public class OlapChart : Control

Constructors

OlapChart()

Initializes a new instance of the OlapChart class.

Declaration

public OlapChart()

Fields

CalculatedMembersProperty

Identifies the dependency property for CalculatedMembers.

Declaration

public static readonly DependencyProperty CalculatedMembersProperty

Field Value

Type
System.Windows.DependencyProperty

CategoricalAxisProperty

Identifies the dependency property of CategoricalAxis.

Declaration

public static readonly DependencyProperty CategoricalAxisProperty

Field Value

Type
System.Windows.DependencyProperty

ChartTypeProperty

Identifies the ChartType dependency property.

Declaration

public static readonly DependencyProperty ChartTypeProperty

Field Value

Type
System.Windows.DependencyProperty

ColorEachSeriesProperty

Using a DependencyProperty as the backing store for ColorEachSeries.

Declaration

public static readonly DependencyProperty ColorEachSeriesProperty

Field Value

Type
System.Windows.DependencyProperty

ColorPaletteProperty

Using a DependencyProperty as the backing store for ColorPalette

Declaration

public static readonly DependencyProperty ColorPaletteProperty

Field Value

Type
System.Windows.DependencyProperty

CornerRadiusProperty

Identifies the CornerRadius dependency property.

Declaration

public static readonly DependencyProperty CornerRadiusProperty

Field Value

Type
System.Windows.DependencyProperty

EnableSeriesAnimationProperty

Using a DependencyProperty as the backing store for EnableSeriesAnimation.

Declaration

public static readonly DependencyProperty EnableSeriesAnimationProperty

Field Value

Type
System.Windows.DependencyProperty

EnableSeriesEffectsProperty

Using a DependencyProperty as the backing store for EnableSeriesEffects.

Declaration

public static readonly DependencyProperty EnableSeriesEffectsProperty

Field Value

Type
System.Windows.DependencyProperty

ExpanderStyleProperty

Identifies the dependency property for ExpanderStyle

Declaration

public static readonly DependencyProperty ExpanderStyleProperty

Field Value

Type
System.Windows.DependencyProperty

GridBackgroundProperty

Identifies the GridBackground dependency property.

Declaration

public static readonly DependencyProperty GridBackgroundProperty

Field Value

Type
System.Windows.DependencyProperty

GridLineStrokeProperty

Identifies the GridLineStroke dependency property.

Declaration

public static readonly DependencyProperty GridLineStrokeProperty

Field Value

Type
System.Windows.DependencyProperty

LabelForegroundProperty

Identifies the dependency property for LabelForeground.

Declaration

[Obsolete("This property has been deprecated. Please use ChartAxis.LabelForegroundProperty instead.")]
public static readonly DependencyProperty LabelForegroundProperty

Field Value

Type
System.Windows.DependencyProperty

LegendProperty

Identifies the Legend dependency property.

Declaration

public static readonly DependencyProperty LegendProperty

Field Value

Type
System.Windows.DependencyProperty

LegendStyleProperty

Identifies the dependency property for LegendStyle.

Declaration

public static readonly DependencyProperty LegendStyleProperty

Field Value

Type
System.Windows.DependencyProperty

OlapDataManagerProperty

Identifies the OlapDataManager dependency property.

Declaration

public static readonly DependencyProperty OlapDataManagerProperty

Field Value

Type
System.Windows.DependencyProperty

PivotEngineProperty

Identifies the dependency property for PivotEngine.

Declaration

public static readonly DependencyProperty PivotEngineProperty

Field Value

Type
System.Windows.DependencyProperty

PrimaryAxisLabelFontWeightProperty

Identifies the dependency property for PrimaryAxisLabelFontWeightProperty.

Declaration

[Obsolete("This property has been deprecated. Please use ChartAxis.LabelFontWeightProperty instead.")]
public static readonly DependencyProperty PrimaryAxisLabelFontWeightProperty

Field Value

Type
System.Windows.DependencyProperty

PrimaryAxisLabelForegroundProperty

Identifies the dependency property for PrimaryAxisLabelForegroundProperty.

Declaration

[Obsolete("This property has been deprecated. Please use ChartAxis.LabelForegroundProperty instead.")]
public static readonly DependencyProperty PrimaryAxisLabelForegroundProperty

Field Value

Type
System.Windows.DependencyProperty

PrimaryAxisLabelVisibilityProperty

Identifies the dependency property for PrimaryAxisLabelVisibility.

Declaration

public static readonly DependencyProperty PrimaryAxisLabelVisibilityProperty

Field Value

Type
System.Windows.DependencyProperty

PrimaryAxisProperty

Identifies the Primary axis dependency property.

Declaration

public static readonly DependencyProperty PrimaryAxisProperty

Field Value

Type
System.Windows.DependencyProperty

SecondaryAxisProperty

Identifies the SecondaryAxis dependency property.

Declaration

public static readonly DependencyProperty SecondaryAxisProperty

Field Value

Type
System.Windows.DependencyProperty

SeriesAnimateOneByOneProperty

Using a DependencyProperty as the backing store for SeriesAnimateOneByOne.

Declaration

public static readonly DependencyProperty SeriesAnimateOneByOneProperty

Field Value

Type
System.Windows.DependencyProperty

SeriesAnimateOptionProperty

Using a DependencyProperty as the backing store for SereiesAnimateOption.

Declaration

public static readonly DependencyProperty SeriesAnimateOptionProperty

Field Value

Type
System.Windows.DependencyProperty

SeriesAnimationDurationProperty

Using a DependencyProperty as the backing store for SeriesAnimationDuration.

Declaration

public static readonly DependencyProperty SeriesAnimationDurationProperty

Field Value

Type
System.Windows.DependencyProperty

SeriesAxisProperty

Identifies the dependency property of SeriesAxis.

Declaration

public static readonly DependencyProperty SeriesAxisProperty

Field Value

Type
System.Windows.DependencyProperty

SeriesStrokeThicknessProperty

Using a DependencyProperty as the backing store for SeriesStrokeThickness.

Declaration

public static readonly DependencyProperty SeriesStrokeThicknessProperty

Field Value

Type
System.Windows.DependencyProperty

SeriesToolTipTemplateProperty

Identifies the dependency property for SeriesToolTipTemplate.

Declaration

public static readonly DependencyProperty SeriesToolTipTemplateProperty

Field Value

Type
System.Windows.DependencyProperty

SlicerAxisProperty

Identifies the dependency property of SlicerAxis.

Declaration

public static readonly DependencyProperty SlicerAxisProperty

Field Value

Type
System.Windows.DependencyProperty

VisualStyleProperty

Visual Style Dependency Property

Declaration

public static readonly DependencyProperty VisualStyleProperty

Field Value

Type
System.Windows.DependencyProperty

Properties

CalculatedMembers

Gets or sets the calculated members.

Declaration

public CalculatedMembers CalculatedMembers { get; set; }

Property Value

Type	Description
CalculatedMembers	The calculated members.

CategoricalAxis

Gets or sets the categorical axis.

Declaration

public CategoricalAxis CategoricalAxis { get; set; }

Property Value

Type	Description
CategoricalAxis	The categorical axis.

ChartAppearance

Gets or sets the chart appearance.

Declaration

public ChartAppearanceSettings ChartAppearance { get; set; }

Property Value

Type	Description
ChartAppearanceSettings	The chart appearance.

ChartType

Gets or sets the type of the chart.

Declaration

public ChartTypes ChartType { get; set; }

Property Value

Type	Description
ChartTypes	The type of the chart.

ColorEachSeries

Gets or sets whether each series should be updated with different colors. By default false.

Declaration

public bool ColorEachSeries { get; set; }

Property Value

Type
System.Boolean

ColorModel

Gets the color model used to paint series.

Declaration

public ChartStyleModel ColorModel { get; }

Property Value

Type	Description
Syncfusion.Windows.Chart.ChartStyleModel	The color model.

ColorPalette

Gets or sets the color palette for the chart area.

Declaration

public ChartColorPalette ColorPalette { get; set; }

Property Value

Type
ChartColorPalette

CornerRadius

Gets or sets the corner radius of OLAP Chart.

Declaration

public CornerRadius CornerRadius { get; set; }

Property Value

Type	Description
System.Windows.CornerRadius	The corner radius.

CurrentCubeName

Gets or sets the name of the current cube.

Declaration

public string CurrentCubeName { get; set; }

Property Value

Type	Description
System.String	The name of the current cube.

DesignerSettings

Gets or sets the designer settings.

Declaration

public DesignerSettings DesignerSettings { get; set; }

Property Value

Type	Description
DesignerSettings	The designer settings.

DisplayMode

Gets or sets the display mode.

Declaration

public DisplayMode DisplayMode { get; set; }

Property Value

Type	Description
DisplayMode	The display mode.

EnableSeriesAnimation

Gets or sets whether enable animation for each series.

Declaration

public bool EnableSeriesAnimation { get; set; }

Property Value

Type
System.Boolean

EnableSeriesEffects

Gets or sets whether enable effect on each series. By default false.

Declaration

public bool EnableSeriesEffects { get; set; }

Property Value

Type
System.Boolean

ExpanderStyle

Gets or sets the expander style.

Declaration

public Style ExpanderStyle { get; set; }

Property Value

Type	Description
System.Windows.Style	The expander style.

GridBackground

Gets or sets the grid background.

Declaration

public Brush GridBackground { get; set; }

Property Value

Type	Description
System.Windows.Media.Brush	The grid background.

GridLineStroke

Gets or sets the grid line stroke.

Declaration

public Pen GridLineStroke { get; set; }

Property Value

Type	Description
System.Windows.Media.Pen	The grid line stroke.

IsAutoExecuteEnabled

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

Declaration

public bool IsAutoExecuteEnabled { get; set; }

Property Value

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

KpiAlignment

Gets or sets the KPI alignment.

Declaration

public KpiAlignment KpiAlignment { get; set; }

Property Value

Type	Description
KpiAlignment	The KPI alignment.

LabelForeground

Get or sets AxisLabelForegroundbrush

Declaration

[Obsolete("This property has been deprecated. Please use SecondaryAxis.LabelForeground instead.")]
public Brush LabelForeground { get; set; }

Property Value

Type
System.Windows.Media.Brush

Legend

Gets or sets the legend.

Declaration

public ChartLegend Legend { get; set; }

Property Value

Type	Description
ChartLegend	The legend.

LegendStyle

Gets or sets the LegendStyle value.

Declaration

public Style LegendStyle { get; set; }

Property Value

Type	Description
System.Windows.Style	The LegendStyle.

OlapChartArea

Gets or sets the OlapArea for OlapChart.

Declaration

public OlapArea OlapChartArea { get; set; }

Property Value

Type
OlapArea

OlapDataManager

Gets or sets the cube model.

Declaration

public IOlapDataManager OlapDataManager { get; set; }

Property Value

Type	Description
IOlapDataManager	The cube model instance.

OptimizeLargeDataLoading

Gets or sets the OptimizeLargeDataLoading property. By default, false. If it is true then Chart will be render with Minimum number of series data.

Declaration

public bool OptimizeLargeDataLoading { get; set; }

Property Value

Type
System.Boolean

PivotEngine

Gets or sets the PivotEngine for OlapChart which used to render the series in OlapArea.

Declaration

public PivotEngine PivotEngine { get; set; }

Property Value

Type
PivotEngine

PrimaryAxis

Gets or sets the primary axis.

Declaration

public OlapChartAxis PrimaryAxis { get; set; }

Property Value

Type	Description
OlapChartAxis	The primary axis.

PrimaryAxisLabelFontWeight

Get or sets PrimaryAxisLabelFontWeight

Declaration

[Obsolete("This property has been deprecated. Please use PrimaryAxis.LabelFontWeight instead.")]
public FontWeight PrimaryAxisLabelFontWeight { get; set; }

Property Value

Type
System.Windows.FontWeight

PrimaryAxisLabelForeground

Get or sets PrimaryAxisLabelForegroundbrush

Declaration

[Obsolete("This property has been deprecated. Please use PrimaryAxis.LabelForeground instead.")]
public Brush PrimaryAxisLabelForeground { get; set; }

Property Value

Type
System.Windows.Media.Brush

PrimaryAxisLabelVisibility

Gets or sets the primary axis label visibility.

Declaration

public Visibility PrimaryAxisLabelVisibility { get; set; }

Property Value

Type	Description
System.Windows.Visibility	The primary axis label visibility.

ReportName

Gets or sets the name of the report.

Declaration

public string ReportName { get; set; }

Property Value

Type	Description
System.String	The name of the report.

SecondaryAxis

Gets or sets the secondary axis.

Declaration

public ChartAxis SecondaryAxis { get; set; }

Property Value

Type	Description
ChartAxis	The secondary axis.

Series

Gets the series collection.

Declaration

public ChartSeriesCollection Series { get; }

Property Value

Type	Description
Syncfusion.Windows.Chart.ChartSeriesCollection	The series.

SeriesAnimateOneByOne

Gets or sets whether each series animate one by one. By default false.

Declaration

public bool SeriesAnimateOneByOne { get; set; }

Property Value

Type
System.Boolean

SeriesAnimateOption

Gets or sets animation option for each series.

Declaration

public AnimationOptions SeriesAnimateOption { get; set; }

Property Value

Type
AnimationOptions

SeriesAnimationDuration

Gets or sets the animation duration for each series.

Declaration

public TimeSpan SeriesAnimationDuration { get; set; }

Property Value

Type
System.TimeSpan

SeriesAxis

Gets or sets the series axis.

Declaration

public SeriesAxis SeriesAxis { get; set; }

Property Value

Type	Description
SeriesAxis	The series axis.

SeriesStrokeThickness

Gets or sets the stroke thickness for each series in the OlapChart.

Declaration

public double SeriesStrokeThickness { get; set; }

Property Value

Type
System.Double

SeriesToolTipTemplate

Gets or sets the tool tip template.

Declaration

public ControlTemplate SeriesToolTipTemplate { get; set; }

Property Value

Type	Description
System.Windows.Controls.ControlTemplate	The tool tip template.

SharedDataManagerName

Gets or sets the name of the shared data manager.

Declaration

public string SharedDataManagerName { get; set; }

Property Value

Type	Description
System.String	The name of the shared data manager.

SlicerAxis

Gets or sets the slicer axis.

Declaration

public SlicerAxis SlicerAxis { get; set; }

Property Value

Type	Description
SlicerAxis	The slicer axis.

VisualStyle

Gets or Sets the VisualStyle for OlapChart

Declaration

public OlapChartVisualStyle VisualStyle { get; set; }

Property Value

Type
OlapChartVisualStyle

Methods

DataBind()

Binds the data.

Declaration

public void DataBind()

GetChartImage()

Method used to capture and return the current state of OlapChart in a Image Format.

Declaration

public Image GetChartImage()

Returns

Type
System.Drawing.Image

OnApplyTemplate()

When overridden in a derived class, is invoked whenever application code or internal processes call System.Windows.FrameworkElement.ApplyTemplate.

Declaration

public override void OnApplyTemplate()

OnLegendStyleChanged(DependencyObject, DependencyPropertyChangedEventArgs)

Method for LegendStyleChange

Declaration

public static void OnLegendStyleChanged(DependencyObject d, DependencyPropertyChangedEventArgs args)

Parameters

Type	Name	Description
System.Windows.DependencyObject	d
System.Windows.DependencyPropertyChangedEventArgs	args

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.

OnVisualStyleChanged(DependencyObject, DependencyPropertyChangedEventArgs)

Calling method when [VisualStyle changed]

Declaration

public static void OnVisualStyleChanged(DependencyObject dependencyObject, DependencyPropertyChangedEventArgs e)

Parameters

Type	Name	Description
System.Windows.DependencyObject	dependencyObject	OLAP Chart
System.Windows.DependencyPropertyChangedEventArgs	e	The System.Windows.DependencyPropertyChangedEventArgs instance containing the event data.

SetChartAppearanceDetails(ChartAppearanceSettings)

Method to set the appearance settings of OlapChart.

Declaration

public void SetChartAppearanceDetails(ChartAppearanceSettings chartAppearance)

Parameters

Type	Name	Description
ChartAppearanceSettings	chartAppearance	Appearance settings which needs to be applied in OlapChart.

ShowAppearanceDialog()

Method to show the appearance dialog of OlapChart.

Declaration

public void ShowAppearanceDialog()

VerifyAreaAccess(String)

Verifies the area access.

Declaration

protected virtual void VerifyAreaAccess(string memberName)

Parameters

Type	Name	Description
System.String	memberName	Name of the member.

Exceptions

Type	Condition
System.NotSupportedException

Events

AfterRefresh

Occurs after OLAP area refresh.

Declaration

public event OlapRefreshEventHandler AfterRefresh

Event Type

Type
OlapRefreshEventHandler

BeforeRefresh

Occurs before area refresh.

Declaration

public event OlapRefreshEventHandler BeforeRefresh

Event Type

Type
OlapRefreshEventHandler