Class AxisField

Represents a Dimension

Inheritance
System.Object
ContainerField
AxisField
MeasuresField
SubGroupField
Inherited Members
Namespace: FastReport.Olap.Slice
Assembly: FastReport.Olap.dll
Syntax
public class AxisField : ContainerField

Constructors

AxisField(Slice)

Declaration
public AxisField(Slice slice)
Parameters
Type Name Description
Slice slice

AxisField(Slice, SliceField, String, String)

Declaration
public AxisField(Slice slice, SliceField sliceField, string name, string caption)
Parameters
Type Name Description
Slice slice
SliceField sliceField
System.String name
System.String caption

Fields

isMeasuresField

Declaration
protected bool isMeasuresField
Field Value
Type Description
System.Boolean

isSubGroup

Declaration
protected bool isSubGroup
Field Value
Type Description
System.Boolean

Properties

AdditionalTotalFunctions

Additional totals array

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

CalculateTotalEvent

Gets or sets a script method name that will be used to handle the CalculateTotal event.

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

See the CalculateTotal event for more details.

DataType

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

DisplayFormat

Declaration
public override FormatBase DisplayFormat { get; set; }
Property Value
Type Description
FormatBase
Overrides

ExpressionTotals

Gets or sets an expression that calculates total values.

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

GroupsCount

Number of groups in dimension

Declaration
public virtual int GroupsCount { get; }
Property Value
Type Description
System.Int32

HasGroups

True if dimension has groups

Declaration
public virtual bool HasGroups { get; }
Property Value
Type Description
System.Boolean

IsMeasuresField

True if field is a vritual "Measures" dimension

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

IsSubGroup

True if field is a subgroup of another dimension

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

ItemsContainer

Reference to container

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

SliceField

Base slice field

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

SortDirection

Sorting direction

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

TopNProcessor

Reference to TopN engine

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

TotalPosition

Position of totals

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

UseTotalPositionFromMeasure

True if totals use position defined in Measure

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

Width

Declaration
public override int Width { get; set; }
Property Value
Type Description
System.Int32
Overrides

WidthSubGroup

Declaration
public int WidthSubGroup { get; set; }
Property Value
Type Description
System.Int32

Methods

GetExpressions()

Gets all expressions contained in the object.

Declaration
public Expression[] GetExpressions()
Returns
Type Description
Expression[]

Array of expressions or null if object contains no expressions.
Remarks

Do not call this method directly.

This method is called by FastCube each time before building a slice. FastCube do this to collect all expressions and compile them.

GetGroupName(Int32)

Group name by group identifier

Declaration
public virtual string GetGroupName(int groupId)
Parameters
Type Name Description
System.Int32 groupId

Group identifier
Returns
Type Description
System.String

Group name

GetGroupNameByOrder(Int32)

Group name by position

Declaration
public virtual string GetGroupNameByOrder(int index)
Parameters
Type Name Description
System.Int32 index

Position
Returns
Type Description
System.String

Group name

InvokeEvent(String, Object)

Invokes script event.

Declaration
public void InvokeEvent(string name, object param)
Parameters
Type Name Description
System.String name

Name of the event to invoke.
System.Object param

Event parameters.
Remarks

Do not call this method directly. You should use it if you are developing a new aggregate function for FastCube.

Use this method to call an event handler that is located in the slice's script.

Load(XmlItem, Int32)

Loads from XML

Declaration
public override void Load(XmlItem item, int version)
Parameters
Type Name Description
XmlItem item

XML item to load from
System.Int32 version

Format version
Overrides

OnCalculateTotal(CalculateMeasureEventArgs)

This method fires the CalculateTotal event and the script code connected to the CalculateTotalEvent.

Declaration
public void OnCalculateTotal(CalculateMeasureEventArgs e)
Parameters
Type Name Description
CalculateMeasureEventArgs e

Event data.

Save(XmlItem)

Save to XML

Declaration
public override void Save(XmlItem item)
Parameters
Type Name Description
XmlItem item

XML item to save
Overrides

SetGroupName(Int32, String)

Sets group name by group identifier

Declaration
public virtual void SetGroupName(int groupId, string groupName)
Parameters
Type Name Description
System.Int32 groupId

Group identifier
System.String groupName

New name

SetGroupNameByOrder(Int32, String)

Sets group name by position

Declaration
public virtual void SetGroupNameByOrder(int index, string groupName)
Parameters
Type Name Description
System.Int32 index

Position
System.String groupName

New name

Events

CalculateTotal

Allows to calculate total value.

Declaration
public event CalculateMeasureEventHandler CalculateTotal
Event Type
Type Description
CalculateMeasureEventHandler