Class OlapReport

Represents the report information like axis elements, visibility of expanders, paging options, drill functionalities, etc.,.

Inheritance
System.Object
OlapReport
Implements
Inherited Members
System.Object.ToString()
System.Object.Equals(System.Object)
System.Object.Equals(System.Object, System.Object)
System.Object.ReferenceEquals(System.Object, System.Object)
System.Object.GetHashCode()
System.Object.GetType()
System.Object.MemberwiseClone()
Namespace: Syncfusion.Olap.Reports
Assembly: Syncfusion.Olap.Base.dll
Syntax
public class OlapReport : ICloneable<OlapReport>

Constructors

OlapReport()

Initializes a new instance of the OlapReport class.

Declaration
public OlapReport()

OlapReport(String)

Initializes a new instance of the OlapReport class.

Declaration
public OlapReport(string name)
Parameters
Type Name Description
System.String name

The name.

Properties

CalculatedMembers

Gets or sets the collection of calculated members.

Declaration
public Items CalculatedMembers { get; set; }
Property Value
Type Description
Items

The collection of calculated members.

CategoricalElements

Gets or sets the collection of categorical elements.

Declaration
public Items CategoricalElements { get; set; }
Property Value
Type Description
Items

The collection of categorical elements.

ChartSettings

Gets or sets the chart settings.

Declaration
public ChartAppearanceSettings ChartSettings { get; set; }
Property Value
Type Description
ChartAppearanceSettings

The chart settings.

ConnectionString

Gets or sets the connection string.

Declaration
public string ConnectionString { get; set; }
Property Value
Type Description
System.String

The connection string.

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.

CurrentMdxQuery

Gets or sets the current MDX query.

Declaration
public string CurrentMdxQuery { get; set; }
Property Value
Type Description
System.String

The current MDX query.

DisplayMeasuresInDesiredOrder

Gets or sets a value indicating whether the measure elements are displayed in desired order.

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

DrilledCells

Gets or sets the drilled cells.

Declaration
public SerializableDictionary<string, HeaderPositionsInfo> DrilledCells { get; set; }
Property Value
Type Description
SerializableDictionary<System.String, HeaderPositionsInfo>

The drilled cells.

DrillType

Gets or sets the drill type.

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

The drill type.

EnablePaging

Gets or sets a value indicating whether to enable the paging.

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

true if the paging is enabled; otherwise, false.

EngineVersion

Gets or sets the version of query builder engine.

Declaration
public QueryBuilderEngineVersions EngineVersion { get; set; }
Property Value
Type Description
QueryBuilderEngineVersions

The version of query builder engine.

FilterElements

Gets or sets the collection of filter elements.

Declaration
public Items FilterElements { get; set; }
Property Value
Type Description
Items

The collection of filter elements.

ForceWhereClauseForSlicing

Gets or sets a value indicating whether to generate MDX query having only "Where" clause while slicing.

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

GridSettings

Gets or sets the grid settings.

Declaration
public GridAppearanceSettings GridSettings { get; set; }
Property Value
Type Description
GridAppearanceSettings

The grid settings.

Name

Gets or sets the name of the OLAP report.

Declaration
public string Name { get; set; }
Property Value
Type Description
System.String

The name of the OLAP report.

PagerOptions

Gets or sets the pager options.

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

The pager options.

SeriesElements

Gets or sets the collection of series elements.

Declaration
public Items SeriesElements { get; set; }
Property Value
Type Description
Items

The collection of series elements.

ShowCalculatedMembersFromCube

Gets or sets a value indicating whether to show calculated members from cube.

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

true

ShowEmptyColumnData

Gets or sets a value indicating whether to show empty column data.

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

true if the empty column data are shown; otherwise, false.

ShowEmptyRowData

Gets or sets a value indicating whether to show empty row data.

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

true if the empty row data are shown; otherwise, false.

ShowExpanders

Gets or sets a value indicating whether to show expanders.

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

true if the expanders are shown; otherwise, false.

SlicerElements

Gets or sets the collection of slicer elements.

Declaration
public Items SlicerElements { get; set; }
Property Value
Type Description
Items

The collection of slicer elements.

SlicerRangeFilters

Gets or sets the list that filters the slicer element by using the range with the format of "dimension name:hierarchy name:level name:start value:end value". Unique names can also be passed in those fields.

Declaration
public List<SlicerRangeFiltersInfo> SlicerRangeFilters { get; set; }
Property Value
Type Description
System.Collections.Generic.List<SlicerRangeFiltersInfo>

Tag

Gets or sets the tag.

Declaration
public object Tag { get; set; }
Property Value
Type Description
System.Object

The tag.

TogglePivot

Gets or sets a value indicating whether to enable toggle pivot.

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

true if toggle pivot is enabled; otherwise, false.

UseDefaultMember

Gets or sets a value indicating whether to use default member i.e., to avoid the results with its All member.

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

UseWhereClauseForSlicing

Gets or set a value indicating whether to use 'Where' clause for slicing.

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

VirtualKpiElements

Gets or sets the collection of virtual KPI elements.

Declaration
public Items VirtualKpiElements { get; set; }
Property Value
Type Description
Items

VisualTotalVisibility

Gets or sets the visibility of VisualTotals.

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

Methods

Clone()

Clones this instance.

Declaration
public OlapReport Clone()
Returns
Type Description
OlapReport

A copy of this instance.

Implements