Class OlapGauge

The OlapGauge method is called when the Gauge is needed for representing the data report values. This helps in highlighting the KPI information through the gauge visualization.Helps in rendering Gauges.

Inheritance

System.Object

OlapGauge

Namespace: Syncfusion.Windows.Gauge.Olap

Assembly: Syncfusion.OlapGauge.WPF.dll

Syntax

public class OlapGauge : ScrollViewer

Constructors

OlapGauge()

Initializes the gauge content and properties.

Declaration

public OlapGauge()

Fields

CalculatedMembersProperty

Identifies the dependency property for Calculated Members.

Declaration

public static readonly DependencyProperty CalculatedMembersProperty

Field Value

Type
System.Windows.DependencyProperty

CategoricalAxisProperty

Identifies the dependency property for Categorical Axis.

Declaration

public static readonly DependencyProperty CategoricalAxisProperty

Field Value

Type
System.Windows.DependencyProperty

ColumnsCountProperty

ColumnsCount Dependency Property

Declaration

public static readonly DependencyProperty ColumnsCountProperty

Field Value

Type
System.Windows.DependencyProperty

FrameTypeProperty

FrameType Dependency Property

Declaration

public static readonly DependencyProperty FrameTypeProperty

Field Value

Type
System.Windows.DependencyProperty

OlapDataManagerProperty

OlapDataManager Dependency Property

Declaration

public static readonly DependencyProperty OlapDataManagerProperty

Field Value

Type
System.Windows.DependencyProperty

PivotEngineProperty

PivotEngine Dependency Property

Declaration

public static readonly DependencyProperty PivotEngineProperty

Field Value

Type
System.Windows.DependencyProperty

RadiusProperty

Radius Dependency Property

Declaration

public static readonly DependencyProperty RadiusProperty

Field Value

Type
System.Windows.DependencyProperty

RowsCountProperty

RowsCount Dependency Property

Declaration

public static readonly DependencyProperty RowsCountProperty

Field Value

Type
System.Windows.DependencyProperty

SeriesAxisProperty

Identifies the dependency property for Series Axis.

Declaration

public static readonly DependencyProperty SeriesAxisProperty

Field Value

Type
System.Windows.DependencyProperty

ShowGaugeFactorsProperty

ShowGaugeFactors Dependency Property

Declaration

public static readonly DependencyProperty ShowGaugeFactorsProperty

Field Value

Type
System.Windows.DependencyProperty

ShowGaugeHeadersProperty

ShowGaugeHeaders Dependency Property

Declaration

public static readonly DependencyProperty ShowGaugeHeadersProperty

Field Value

Type
System.Windows.DependencyProperty

ShowGaugeLabelsProperty

ShowGaugeLabels Dependency Property

Declaration

public static readonly DependencyProperty ShowGaugeLabelsProperty

Field Value

Type
System.Windows.DependencyProperty

ShowMarkersTooltipProperty

ShowMarkersTooltip Dependency Property

Declaration

public static readonly DependencyProperty ShowMarkersTooltipProperty

Field Value

Type
System.Windows.DependencyProperty

ShowPointersTooltipProperty

ShowPointersTooltip Dependency Property

Declaration

public static readonly DependencyProperty ShowPointersTooltipProperty

Field Value

Type
System.Windows.DependencyProperty

SizeToContainerProperty

SizeToContainer Dependency Property

Declaration

public static readonly DependencyProperty SizeToContainerProperty

Field Value

Type
System.Windows.DependencyProperty

SlicerAxisProperty

Identifies the dependency property for Slicer Axis.

Declaration

public static readonly DependencyProperty SlicerAxisProperty

Field Value

Type
System.Windows.DependencyProperty

StatusIndicatorProperty

StatusIndicator Dependency Property

Declaration

public static readonly DependencyProperty StatusIndicatorProperty

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.

ColumnsCount

Gets or sets the columns count.

Declaration

public int ColumnsCount { get; set; }

Property Value

Type
System.Int32

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.

FrameType

Gets or sets the type of the frame and it also sets the default frame type to Circular Center Gradient

Declaration

[CLSCompliant(false)]
public GaugeFrameType FrameType { get; set; }

Property Value

Type
GaugeFrameType

KpiInfoCollection

Gets the KPI info collection.

Declaration

public KpiInfoCollection KpiInfoCollection { get; }

Property Value

Type
KpiInfoCollection

OlapDataManager

Gets or sets the OLAP data manager.

Declaration

public IOlapDataManager OlapDataManager { get; set; }

Property Value

Type
IOlapDataManager

PivotEngine

Gets or sets the pivot engine.

Declaration

public PivotEngine PivotEngine { get; set; }

Property Value

Type
PivotEngine

Radius

Gets or sets the radius and default radius value is 100.0

Declaration

public double Radius { get; set; }

Property Value

Type
System.Double

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.

RowsCount

Gets or sets the rows count.

Declaration

public int RowsCount { get; set; }

Property Value

Type
System.Int32

SeriesAxis

Gets or sets the series axis.

Declaration

public SeriesAxis SeriesAxis { get; set; }

Property Value

Type	Description
SeriesAxis	The series axis.

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.

ShowGaugeFactors

Gets or sets a value indicating whether to [show Gauge Factors].

Declaration

public bool ShowGaugeFactors { get; set; }

Property Value

Type	Description
System.Boolean	true if [show Gauge Factors]; otherwise, false.

ShowGaugeHeaders

Gets or sets a value indicating whether to [show Gauge Headers].

Declaration

public bool ShowGaugeHeaders { get; set; }

Property Value

Type	Description
System.Boolean	true if [show Gauge Headers]; otherwise, false.

ShowGaugeLabels

Gets or sets a value indicating whether to [show Gauge Labels].

Declaration

public bool ShowGaugeLabels { get; set; }

Property Value

Type	Description
System.Boolean	true if [show Gauge Labels]; otherwise, false.

ShowMarkersTooltip

Gets or sets a value indicating whether [show markers tooltip].

Declaration

public bool ShowMarkersTooltip { get; set; }

Property Value

Type	Description
System.Boolean	true if [show markers tooltip]; otherwise, false.

ShowPointersTooltip

Gets or sets a value indicating whether [show pointers tooltip].

Declaration

public bool ShowPointersTooltip { get; set; }

Property Value

Type	Description
System.Boolean	true if [show pointers tooltip]; otherwise, false.

SizeToContainer

Gets or sets a value indicating whether [size to container].

Declaration

public bool SizeToContainer { get; set; }

Property Value

Type	Description
System.Boolean	true if [size to container]; otherwise, false.

SlicerAxis

Gets or sets the slicer axis.

Declaration

public SlicerAxis SlicerAxis { get; set; }

Property Value

Type	Description
SlicerAxis	The slicer axis.

StatusIndicator

Gets or sets the Status Indicator

Declaration

public string StatusIndicator { get; set; }

Property Value

Type
System.String

VisualStyle

Gets or Sets the VisualStyle for OlapGauge

Declaration

public OlapGaugeVisualStyle VisualStyle { get; set; }

Property Value

Type
OlapGaugeVisualStyle

Methods

AddGaugeImage(GaugeImage)

Adds the gauge image.

Declaration

[CLSCompliant(false)]
public void AddGaugeImage(GaugeImage image)

Parameters

Type	Name	Description
GaugeImage	image	The gauge image.

ClearData()

Clears the OlapGrid data.

Declaration

public void ClearData()

DataBind()

Binds the OlapGauge with the information available in KpiInfoCollection

Declaration

public void DataBind()

Dispose()

Releases all the resources used by this component.

Declaration

public void Dispose()

OnApplyTemplate()

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

Declaration

public override void OnApplyTemplate()

OnOlapDataManagerChanged(DependencyObject, DependencyPropertyChangedEventArgs)

Called when [cube model changed].

Declaration

public static void OnOlapDataManagerChanged(DependencyObject dependencyObject, DependencyPropertyChangedEventArgs e)

Parameters

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