Class AxisField
Namespace: FastReport.Olap.Slice
Assembly: FastCube.Core.dll
Represents a Dimension
public class AxisField : ContainerField
Inheritance
object ← ContainerField ← AxisField
Derived
Inherited Members
ContainerField.alignment, ContainerField.bindCaptionWidth, ContainerField.caption, ContainerField.captionWidth, ContainerField.container, ContainerField.name, ContainerField.Alignment, ContainerField.BindCaptionWidth, ContainerField.Caption, ContainerField.CaptionWidth, ContainerField.DisplayFormat, ContainerField.Index, ContainerField.Name, ContainerField.Width, ContainerField.BeginUpdate(), ContainerField.EndUpdate(), ContainerField.Load(XmlItem, int), ContainerField.Save(XmlItem), ContainerField.FullRebuildChanged(), ContainerField.FullRedrawChanged(), ContainerField.LightRedrawChanged()
Constructors
AxisField(Slice)
Creates a new instance.
public AxisField(Slice slice)
Parameters
slice Slice
AxisField(Slice, SliceField, string, string)
Creates a new instnace.
public AxisField(Slice slice, SliceField sliceField, string name, string caption)
Parameters
slice Slice
sliceField SliceField
name string
caption string
Fields
isMeasuresField
Indicates that field is measures.
protected bool isMeasuresField
Field Value
isSubGroup
Indicates that is sub group.
protected bool isSubGroup
Field Value
Properties
AdditionalTotalFunctions
Additional totals array
public AdditionalTotalFunctions AdditionalTotalFunctions { get; }
Property Value
CalculateTotalEvent
Gets or sets a script method name that will be used to handle the FastReport.Olap.Slice.AxisField.CalculateTotal event.
public string CalculateTotalEvent { get; set; }
Property Value
Remarks
See the FastReport.Olap.Slice.AxisField.CalculateTotal event for more details.
DataType
Gets data time or string type if the field is measures.
public DataType DataType { get; }
Property Value
DisplayFormat
Gets or sets display format.
public override FormatBase DisplayFormat { get; set; }
Property Value
ExpressionTotals
Gets or sets an expression that calculates total values.
public string ExpressionTotals { get; set; }
Property Value
GroupsCount
Number of groups in dimension
public virtual int GroupsCount { get; }
Property Value
HasGroups
True if dimension has groups
public virtual bool HasGroups { get; }
Property Value
IsMeasuresField
True if field is a vritual "Measures" dimension
public bool IsMeasuresField { get; }
Property Value
IsSubGroup
True if field is a subgroup of another dimension
public bool IsSubGroup { get; }
Property Value
ItemsContainer
Reference to container
public ItemsContainer ItemsContainer { get; }
Property Value
SliceField
Base slice field
public SliceField SliceField { get; }
Property Value
SortDirection
Sorting direction
public SortDirection SortDirection { get; set; }
Property Value
TopNProcessor
Reference to TopN engine
public TopNProcessor TopNProcessor { get; }
Property Value
TotalPosition
Position of totals
public TotalPosition TotalPosition { get; set; }
Property Value
UseTotalPositionFromMeasure
True if totals use position defined in Measure
public bool UseTotalPositionFromMeasure { get; set; }
Property Value
Width
Width of field in Grid. Can be changed by user
public override int Width { get; set; }
Property Value
WidthSubGroup
Gets or sets width of subgroup.
public int WidthSubGroup { get; set; }
Property Value
Methods
GetExpressions()
Gets list of expressions.
public Expression[] GetExpressions()
Returns
GetGroupName(int)
Group name by group identifier
public virtual string GetGroupName(int groupId)
Parameters
groupId int
Group identifier
Returns
Group name
GetGroupNameByOrder(int)
Group name by position
public virtual string GetGroupNameByOrder(int index)
Parameters
index int
Position
Returns
Group name
InvokeEvent(string, object)
Invokes script event.
public void InvokeEvent(string name, object param)
Parameters
name string
Name of the event to invoke.
param object
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, int)
Loads from XML
public override void Load(XmlItem item, int version)
Parameters
item XmlItem
XML item to load from
version int
Format version
OnCalculateTotal(CalculateMeasureEventArgs)
Gets all expressions contained in the object.
public void OnCalculateTotal(CalculateMeasureEventArgs e)
Parameters
Event data.
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.
Save(XmlItem)
Save to XML
public override void Save(XmlItem item)
Parameters
item XmlItem
XML item to save
SetGroupName(int, string)
Sets group name by group identifier
public virtual void SetGroupName(int groupId, string groupName)
Parameters
groupId int
Group identifier
groupName string
New name
SetGroupNameByOrder(int, string)
Sets group name by position
public virtual void SetGroupNameByOrder(int index, string groupName)
Parameters
index int
Position
groupName string
New name
CalculateTotal
Allows to calculate total value.
public event CalculateMeasureEventHandler CalculateTotal