Class AxisContainer

Axis dimensions container

Inheritance

System.Object

SliceContainer

FieldsContainer

ItemsContainer

AxisContainer

Inherited Members

ItemsContainer.AddAxisField(AxisField)

ItemsContainer.InsertAxisField(AxisField, Int32)

ItemsContainer.AxisFields

ItemsContainer.ContainSliceField(SliceField)

ItemsContainer.GetIndexOfSliceField(SliceField)

ItemsContainer.RemoveAxisField(AxisField)

ItemsContainer.InsertSliceFieldToPosition(SliceField, Int32)

ItemsContainer.AddSliceField(SliceField)

FieldsContainer.fields

FieldsContainer.Fields

FieldsContainer.HasMeasuresField

FieldsContainer.BindCaptionWidth

SliceContainer.alignment

SliceContainer.SliceContainerType

SliceContainer.Slice

SliceContainer.Alignment

Namespace: FastReport.Olap.Slice

Assembly: FastReport.Olap.dll

Syntax

public class AxisContainer : ItemsContainer

Properties

AdditionalGrandTotalFunctions

Declaration

public AdditionalTotalFunctions AdditionalGrandTotalFunctions { get; }

Property Value

Type	Description
AdditionalTotalFunctions

AxisSortType

Defines how to sort Axis nodes

Declaration

public AxisSortType AxisSortType { get; set; }

Property Value

Type	Description
AxisSortType

AxisType

Defines how to show Axis

Declaration

public AxisType AxisType { get; set; }

Property Value

Type	Description
AxisType

CalculateAdditionalGrandTotalEvent

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

Declaration

public string CalculateAdditionalGrandTotalEvent { get; set; }

Property Value

Type	Description
System.String

Remarks

See the event for more details.

GrandTotalPosition

Defines where total nodes are shown

Declaration

public TotalPosition GrandTotalPosition { get; set; }

Property Value

Type	Description
TotalPosition

HiddenNodesCount

Count of hidden nodes

Declaration

public int HiddenNodesCount { get; }

Property Value

Type	Description
System.Int32

IsAxis

Always true

Declaration

public override bool IsAxis { get; }

Property Value

Type	Description
System.Boolean

Overrides

ItemsContainer.IsAxis

LevelsCount

Number of levels in axis

Declaration

public override int LevelsCount { get; }

Property Value

Type	Description
System.Int32

Overrides

ItemsContainer.LevelsCount

MeasuresLevel

"Measures" dimension level or -1

Declaration

public override int MeasuresLevel { get; }

Property Value

Type	Description
System.Int32

Overrides

ItemsContainer.MeasuresLevel

ShowTotalAs

Defines how total nodes is shown

Declaration

public ShowTotalAs ShowTotalAs { get; set; }

Property Value

Type	Description
ShowTotalAs

UseGrandTotalPositionFromMeasure

Whether to get total position for measure from measure definition

Declaration

public bool UseGrandTotalPositionFromMeasure { get; set; }

Property Value

Type	Description
System.Boolean

VisibleLevelsCount

Number of visible levels in axis (some levels can be collapsed)

Declaration

public int VisibleLevelsCount { get; }

Property Value

Type	Description
System.Int32

VisibleNodeCount

Count of visible nodes

Declaration

public int VisibleNodeCount { get; }

Property Value

Type	Description
System.Int32

Methods

AddMeasuresField()

Add virtual "Measures" dimension to axis

Declaration

public override int AddMeasuresField()

Returns

Type	Description
System.Int32	index of "Measures" field

Overrides

ItemsContainer.AddMeasuresField()

DeleteMeasuresField()

Delete virtual "Measures" dimension from axis to Filters container

Declaration

public override void DeleteMeasuresField()

Overrides

ItemsContainer.DeleteMeasuresField()

GetAdditionalTotalFunctionInLevel(Int32, Int32)

Declaration

public AggregateFunction GetAdditionalTotalFunctionInLevel(int levelIndex, int additionalTotalIndex)

Parameters

Type	Name	Description
System.Int32	levelIndex
System.Int32	additionalTotalIndex

Returns

Type	Description
AggregateFunction

GetCaption(Int32, Int32)

Get node caption at level and index

Declaration

public string GetCaption(int levelIndex, int visibleIndex)

Parameters

Type	Name	Description
System.Int32	levelIndex	axis tree level
System.Int32	visibleIndex	visible node level at index

Returns

Type	Description
System.String	node caption

GetCellSize(Int32)

Get cell width/height (depends on Axis)

Declaration

public int GetCellSize(int visibleCellIndex)

Parameters

Type	Name	Description
System.Int32	visibleCellIndex	index of visible cell

Returns

Type	Description
System.Int32	width/height

GetCountAdditionalTotalFunctionsInLevel(Int32)

Declaration

public int GetCountAdditionalTotalFunctionsInLevel(int levelIndex)

Parameters

Type	Name	Description
System.Int32	levelIndex

Returns

Type	Description
System.Int32

GetDimValuesId(Int32, Int32, Int32)

Get list of uniques ids in level from node to node

Declaration

public List<int> GetDimValuesId(int levelIndex, int startVisibleIndex, int endVisibleIndex)

Parameters

Type	Name	Description
System.Int32	levelIndex
System.Int32	startVisibleIndex	first visible node index at level
System.Int32	endVisibleIndex	last visible node index at level

Returns

Type	Description
System.Collections.Generic.List<System.Int32>	List of unique ids

GetLevelInfo(Int32)

Get level information structure

Declaration

public AxisLevelInfo GetLevelInfo(int levelIndex)

Parameters

Type	Name	Description
System.Int32	levelIndex	level index

Returns

Type	Description
AxisLevelInfo	AxisLevelInfo structure

GetLevelSize(Int32)

Get level width/height (depends on Axis)

Declaration

public int GetLevelSize(int levelIndex)

Parameters

Type	Name	Description
System.Int32	levelIndex	index of level

Returns

Type	Description
System.Int32	width/height

GetValue(Int32, Int32)

Get node value at level and index

Declaration

public Variant GetValue(int levelIndex, int visibleIndex)

Parameters

Type	Name	Description
System.Int32	levelIndex	axis tree level
System.Int32	visibleIndex	visible node index at level

Returns

Type	Description
Variant	node value

GetValueId(Int32, Int32)

Get node value index at level and index

Declaration

public int GetValueId(int levelIndex, int visibleIndex)

Parameters

Type	Name	Description
System.Int32	levelIndex	axis tree level
System.Int32	visibleIndex	visible node index at level

Returns

Type	Description
System.Int32	node value index

GetVisibleLevelInfo(Int32)

Get level information structure

Declaration

public AxisLevelInfo GetVisibleLevelInfo(int visibleLevelIndex)

Parameters

Type	Name	Description
System.Int32	visibleLevelIndex

Returns

Type	Description
AxisLevelInfo	AxisLevelInfo structure

GetVisibleLevelSize(Int32)

Get level width/height (depends on Axis)

Declaration

public int GetVisibleLevelSize(int visibleLevelIndex)

Parameters

Type	Name	Description
System.Int32	visibleLevelIndex

Returns

Type	Description
System.Int32	width/height

InsertMeasuresField(Int32)

Insert virtual "Measures" dimension to axis at level index

Declaration

public override int InsertMeasuresField(int index)

Parameters

Type	Name	Description
System.Int32	index	level index

Returns

Type	Description
System.Int32	index of "Measures" field

Overrides

ItemsContainer.InsertMeasuresField(Int32)

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)

Load 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

ItemsContainer.Load(XmlItem, Int32)

OnCalculateAdditionalGrandTotal(CalculateMeasureEventArgs)

This method fires the CalculateAdditionalGrandTotal event and the script code connected to the CalculateAdditionalGrandTotalEvent.

Declaration

public void OnCalculateAdditionalGrandTotal(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

Overrides

ItemsContainer.Save(XmlItem)

SetCellSize(Int32, Int32)

Set cell width/height (depends on Axis)

Declaration

public void SetCellSize(int visibleCellIndex, int value)

Parameters

Type	Name	Description
System.Int32	visibleCellIndex	index of visible cell
System.Int32	value	cell width/height

SetExpanded(Int32, Int32, Int32, Boolean)

Declaration

public void SetExpanded(int levelIndex, int nodeIndex, int measureIndex, bool value)

Parameters

Type	Name	Description
System.Int32	levelIndex
System.Int32	nodeIndex
System.Int32	measureIndex
System.Boolean	value

SetExpandedGroup(Int32, Int32, Int32, Boolean)

Declaration

public void SetExpandedGroup(int levelIndex, int nodeIndex, int measureIndex, bool value)

Parameters

Type	Name	Description
System.Int32	levelIndex
System.Int32	nodeIndex
System.Int32	measureIndex
System.Boolean	value

SetExpandedLevel(Int32, Boolean)

Declaration

public void SetExpandedLevel(int levelIndex, bool value)

Parameters

Type	Name	Description
System.Int32	levelIndex
System.Boolean	value

SetHidden(Int32, Int32, Int32, Boolean, Int32)

Hode node (mainly for use in grid)

Declaration

public void SetHidden(int levelIndex, int nodeIndex, int measureIndex, bool totalCell, int additionalTotalIndex)

Parameters

Type	Name	Description
System.Int32	levelIndex	level index
System.Int32	nodeIndex	node index
System.Int32	measureIndex	index of measure
System.Boolean	totalCell	flag to indicate total cell
System.Int32	additionalTotalIndex	index of additional total

SetLevelSize(Int32, Int32)

Sets level width/height (depends on Axis)

Declaration

public void SetLevelSize(int levelIndex, int value)

Parameters

Type	Name	Description
System.Int32	levelIndex	index of level
System.Int32	value	width/height

SetTotalPosition(TotalPosition)

Set total position for all levels

Declaration

public void SetTotalPosition(TotalPosition totalPosition)

Parameters

Type	Name	Description
TotalPosition	totalPosition

SetVisibleLevelSize(Int32, Int32)

Sets level width/height (depends on Axis)

Declaration

public void SetVisibleLevelSize(int visibleLevelIndex, int value)

Parameters

Type	Name	Description
System.Int32	visibleLevelIndex
System.Int32	value	width/height

ShowAllHidden()

Show all hidden nodes

Declaration

public void ShowAllHidden()

TraverseAxis(Int32, Int32, Int32, SliceAxisDrawCellHandler)

Start axis traverse. drawHandler will be called for each node

Declaration

public void TraverseAxis(int startLevel, int stopLevel, int startCell, SliceAxisDrawCellHandler drawHandler)

Parameters

Type	Name	Description
System.Int32	startLevel	Axis level to start from
System.Int32	stopLevel	Axis level to stop traverse
System.Int32	startCell	Cell in startLevel to start from
SliceAxisDrawCellHandler	drawHandler	Handler to call for each node

Events

CalculateAdditionalGrandTotal

Allows to calculate total value.

Declaration

public event CalculateMeasureEventHandler CalculateAdditionalGrandTotal

Event Type

Type	Description
CalculateMeasureEventHandler