Class AxisContainer
Namespace: FastReport.Olap.Slice
Assembly: FastCube.Core.dll
Axis dimensions container
public class AxisContainer : ItemsContainer
Inheritance
object ← SliceContainer ← FieldsContainer ← ItemsContainer ← AxisContainer
Inherited Members
ItemsContainer.AxisFields, ItemsContainer.IsAxis, ItemsContainer.LevelsCount, ItemsContainer.MeasuresLevel, ItemsContainer.AddAxisField(AxisField), ItemsContainer.AddMeasuresField(), ItemsContainer.AddSliceField(SliceField), ItemsContainer.ContainSliceField(SliceField), ItemsContainer.DeleteMeasuresField(), ItemsContainer.GetIndexOfSliceField(SliceField), ItemsContainer.InsertAxisField(AxisField, int), ItemsContainer.InsertMeasuresField(int), ItemsContainer.InsertSliceFieldToPosition(SliceField, int), ItemsContainer.Load(XmlItem, int), ItemsContainer.RemoveAxisField(AxisField), ItemsContainer.Save(XmlItem), FieldsContainer.fields, FieldsContainer.BindCaptionWidth, FieldsContainer.Fields, FieldsContainer.HasMeasuresField, SliceContainer.alignment, SliceContainer.Alignment, SliceContainer.Slice, SliceContainer.SliceContainerType, SliceContainer.Load(XmlItem, int), SliceContainer.Save(XmlItem)
Properties
AdditionalGrandTotalFunctions
Gets adititonal grand total functions.
public AdditionalTotalFunctions AdditionalGrandTotalFunctions { get; }
Property Value
AxisSortType
Defines how to sort Axis nodes
public AxisSortType AxisSortType { get; set; }
Property Value
AxisType
Defines how to show Axis
public AxisType AxisType { get; set; }
Property Value
CalculateAdditionalGrandTotalEvent
Gets or sets a script method name that will be used to handle the FastReport.Olap.Slice.AxisContainer.CalculateAdditionalGrandTotal event.
public string CalculateAdditionalGrandTotalEvent { get; set; }
Property Value
Remarks
See the FastReport.Olap.Slice.AxisContainer.CalculateAdditionalGrandTotal event for more details.
GrandTotalPosition
Defines where total nodes are shown
public TotalPosition GrandTotalPosition { get; set; }
Property Value
HiddenNodesCount
Count of hidden nodes
public int HiddenNodesCount { get; }
Property Value
IsAxis
Always true
public override bool IsAxis { get; }
Property Value
LevelsCount
Number of levels in axis
public override int LevelsCount { get; }
Property Value
MeasuresLevel
"Measures" dimension level or -1
public override int MeasuresLevel { get; }
Property Value
ShowTotalAs
Defines how total nodes is shown
public ShowTotalAs ShowTotalAs { get; set; }
Property Value
UseGrandTotalPositionFromMeasure
Whether to get total position for measure from measure definition
public bool UseGrandTotalPositionFromMeasure { get; set; }
Property Value
VisibleLevelsCount
Number of visible levels in axis (some levels can be collapsed)
public int VisibleLevelsCount { get; }
Property Value
VisibleNodeCount
Count of visible nodes
public int VisibleNodeCount { get; }
Property Value
Methods
AddMeasuresField()
Add virtual "Measures" dimension to axis
public override int AddMeasuresField()
Returns
index of "Measures" field
DeleteMeasuresField()
Delete virtual "Measures" dimension from axis to Filters container
public override void DeleteMeasuresField()
GetAdditionalTotalFunctionInLevel(int, int)
Gets addtitional total function in level by index.
public AggregateFunction GetAdditionalTotalFunctionInLevel(int levelIndex, int additionalTotalIndex)
Parameters
levelIndex int
additionalTotalIndex int
Returns
GetCaption(int, int)
Get node caption at level and index
public string GetCaption(int levelIndex, int visibleIndex)
Parameters
levelIndex int
axis tree level
visibleIndex int
visible node level at index
Returns
node caption
GetCellSize(int)
Get cell width/height (depends on Axis)
public int GetCellSize(int visibleCellIndex)
Parameters
visibleCellIndex int
index of visible cell
Returns
width/height
GetCountAdditionalTotalFunctionsInLevel(int)
Gets number of additional total functions in level.
public int GetCountAdditionalTotalFunctionsInLevel(int levelIndex)
Parameters
levelIndex int
Returns
GetDimValuesId(int, int, int)
Get list of uniques ids in level from node to node
public List<int> GetDimValuesId(int levelIndex, int startVisibleIndex, int endVisibleIndex)
Parameters
levelIndex int
axis tree level
startVisibleIndex int
first visible node index at level
endVisibleIndex int
last visible node index at level
Returns
List of unique ids
GetLevelInfo(int)
Get level information structure
public AxisLevelInfo GetLevelInfo(int levelIndex)
Parameters
levelIndex int
level index
Returns
AxisLevelInfo structure
GetLevelSize(int)
Get level width/height (depends on Axis)
public int GetLevelSize(int levelIndex)
Parameters
levelIndex int
index of level
Returns
width/height
GetValue(int, int)
Get node value at level and index
public object GetValue(int levelIndex, int visibleIndex)
Parameters
levelIndex int
axis tree level
visibleIndex int
visible node index at level
Returns
node value
GetValueId(int, int)
Get node value index at level and index
public int GetValueId(int levelIndex, int visibleIndex)
Parameters
levelIndex int
axis tree level
visibleIndex int
visible node index at level
Returns
node value index
GetVisibleLevelInfo(int)
Get level information structure
public AxisLevelInfo GetVisibleLevelInfo(int visibleLevelIndex)
Parameters
visibleLevelIndex int
visible level index
Returns
AxisLevelInfo structure
GetVisibleLevelSize(int)
Get level width/height (depends on Axis)
public int GetVisibleLevelSize(int visibleLevelIndex)
Parameters
visibleLevelIndex int
index of visible level
Returns
width/height
InsertMeasuresField(int)
Insert virtual "Measures" dimension to axis at level index
public override int InsertMeasuresField(int index)
Parameters
index int
level index
Returns
index of "Measures" field
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)
Load from XML
public override void Load(XmlItem item, int version)
Parameters
item XmlItem
XML item to load from
version int
Format version
OnCalculateAdditionalGrandTotal(CalculateMeasureEventArgs)
This method fires the CalculateAdditionalGrandTotal event and the script code connected to the CalculateAdditionalGrandTotalEvent.
public void OnCalculateAdditionalGrandTotal(CalculateMeasureEventArgs e)
Parameters
Event data.
Save(XmlItem)
Save to XML
public override void Save(XmlItem item)
Parameters
item XmlItem
XML item
SetCellSize(int, int)
Set cell width/height (depends on Axis)
public void SetCellSize(int visibleCellIndex, int value)
Parameters
visibleCellIndex int
index of visible cell
value int
cell width/height
SetExpanded(int, int, int, bool)
Sets expanded flag on specified item.
public void SetExpanded(int levelIndex, int nodeIndex, int measureIndex, bool value)
Parameters
levelIndex int
nodeIndex int
measureIndex int
value bool
SetExpandedGroup(int, int, int, bool)
Sets expanded flag on specified item.
public void SetExpandedGroup(int levelIndex, int nodeIndex, int measureIndex, bool value)
Parameters
levelIndex int
nodeIndex int
measureIndex int
value bool
SetExpandedLevel(int, bool)
Sets expanded flag on specified item.
public void SetExpandedLevel(int levelIndex, bool value)
Parameters
levelIndex int
value bool
SetHidden(int, int, int, bool, int)
Hode node (mainly for use in grid)
public void SetHidden(int levelIndex, int nodeIndex, int measureIndex, bool totalCell, int additionalTotalIndex)
Parameters
levelIndex int
level index
nodeIndex int
node index
measureIndex int
index of measure
totalCell bool
flag to indicate total cell
additionalTotalIndex int
index of additional total
SetLevelSize(int, int)
Sets level width/height (depends on Axis)
public void SetLevelSize(int levelIndex, int value)
Parameters
levelIndex int
index of level
value int
width/height
SetTotalPosition(TotalPosition)
Set total position for all levels
public void SetTotalPosition(TotalPosition totalPosition)
Parameters
totalPosition TotalPosition
SetVisibleLevelSize(int, int)
Sets level width/height (depends on Axis)
public void SetVisibleLevelSize(int visibleLevelIndex, int value)
Parameters
visibleLevelIndex int
index of visible level
value int
width/height
ShowAllHidden()
Show all hidden nodes
public void ShowAllHidden()
TraverseAxis(int, int, int, SliceAxisDrawCellHandler)
Start axis traverse. drawHandler will be called for each node
public void TraverseAxis(int startLevel, int stopLevel, int startCell, SliceAxisDrawCellHandler drawHandler)
Parameters
startLevel int
Axis level to start from
stopLevel int
Axis level to stop traverse
startCell int
Cell in startLevel to start from
drawHandler SliceAxisDrawCellHandler
Handler to call for each node
CalculateAdditionalGrandTotal
Allows to calculate total value.
public event CalculateMeasureEventHandler CalculateAdditionalGrandTotal