Class CubeField

Namespace: FastReport.Olap.Cube
Assembly: FastCube.Core.dll

Cube field.

public class CubeField

Inheritance

object ← CubeField

Constructors

CubeField(DataType, string)

Creates a new instance.

public CubeField(DataType dataType, string name)

Parameters

dataType DataType

name string

CubeField(DataType, string, string)

Creates a new instance.

public CubeField(DataType dataType, string name, string caption)

Parameters

dataType DataType

name string

caption string

CubeField(DataType, string, CubeFields)

Creates a new instance.

public CubeField(DataType dataType, string name, CubeFields cubeFields)

Parameters

dataType DataType

name string

cubeFields CubeFields

CubeField(DataType, string, string, CubeFields)

Creates a new instance.

public CubeField(DataType dataType, string name, string caption, CubeFields cubeFields)

Parameters

dataType DataType

name string

caption string

cubeFields CubeFields

CubeField(BaseField, CubeFields, CubeField, AttributeType)

Creates a new instance.

public CubeField(BaseField dsField, CubeFields cubeFields, CubeField parent, AttributeType attributeType = AttributeType.None)

Parameters

dsField BaseField

cubeFields CubeFields

parent CubeField

attributeType AttributeType

CubeField(CubeFieldProperties, CubeFields)

Creates a new instance.

public CubeField(CubeFieldProperties cubeFieldProperties, CubeFields cubeFields)

Parameters

cubeFieldProperties CubeFieldProperties

cubeFields CubeFields

Properties

AttributeType

Gets attribute type.

public AttributeType AttributeType { get; }

Property Value

AttributeType

CalculateAfterAll

Gets that need to calculate after all.

public bool CalculateAfterAll { get; }

Property Value

bool

CanUseDateTimeSplit

Gets that can use datetime split.

public bool CanUseDateTimeSplit { get; }

Property Value

bool

Caption

Gets or sets caption.

public string Caption { get; set; }

Property Value

string

Children

Gets list of children.

public List<CubeField> Children { get; }

Property Value

List<CubeField>

DataType

Gets current data type.

public DataType DataType { get; }

Property Value

DataType

DateTimePart

Gets current datetime part.

public DateTimePart DateTimePart { get; }

Property Value

DateTimePart

DateTimeSplitsCount

Gets number of children with datetime part.

public int DateTimeSplitsCount { get; }

Property Value

int

DisplayFormat

Gets or sets display format.

public FormatBase DisplayFormat { get; set; }

Property Value

FormatBase

GroupsCount

Gets number of groups.

public int GroupsCount { get; }

Property Value

int

GroupsManager

Gets groups manager.

public GroupsManager GroupsManager { get; }

Property Value

GroupsManager

HasGroups

Gets that groups is not empty.

public bool HasGroups { get; }

Property Value

bool

Index

Gets current index.

public int Index { get; }

Property Value

int

Level

Gets current level.

public int Level { get; }

Property Value

int

Name

Gets or sets name.

public string Name { get; set; }

Property Value

string

Remarks

if caption is equal name, caption will be updated with name.

NeedHolder

Gets that need holder.

public bool NeedHolder { get; }

Property Value

bool

Parent

Gets cube field parent reference.

public CubeField Parent { get; }

Property Value

CubeField

Values

Gets unique values.

public CommonUniqueValues Values { get; }

Property Value

CommonUniqueValues

VarType

Gets current data type variable type.

public VarType VarType { get; }

Property Value

VarType

Methods

AddDateTimeSplit(DateTimePart)

Adds datetime split.

public bool AddDateTimeSplit(DateTimePart dateTimePart)

Parameters

dateTimePart DateTimePart

Returns

bool

CanCreateDateTimeSplit(DateTimePart)

Returns that can create datetime split.

public bool CanCreateDateTimeSplit(DateTimePart dateTimePart)

Parameters

dateTimePart DateTimePart

Returns

bool

Check(DateTimePart, CubeFieldProperties)

Checks field for datetime part and checks cube field properties.

public bool Check(DateTimePart dateTimePart, CubeFieldProperties cubeFieldProperties)

Parameters

dateTimePart DateTimePart

cubeFieldProperties CubeFieldProperties

Returns

bool

Check(AttributeType, CubeFieldProperties)

Checks field for attribute type and checks cube field properties.

public bool Check(AttributeType attributeType, CubeFieldProperties cubeFieldProperties)

Parameters

attributeType AttributeType

cubeFieldProperties CubeFieldProperties

Returns

bool

Check(CubeFieldProperties)

Checks obly cube field properties.

public bool Check(CubeFieldProperties cubeFieldProperties)

Parameters

cubeFieldProperties CubeFieldProperties

Returns

bool

CreateAttributeField(AttributeType, CubeFieldProperties)

Creates cube field by attribute type.

public CubeField CreateAttributeField(AttributeType attributeType, CubeFieldProperties cubeFieldProperties)

Parameters

attributeType AttributeType

cubeFieldProperties CubeFieldProperties

Returns

CubeField

CreateDatePart(DateTimePart, string, string)

Creates a date part cube field.

public CubeField CreateDatePart(DateTimePart dateTimePart, string name, string caption)

Parameters

dateTimePart DateTimePart

name string

caption string

Returns

CubeField

CreateDatePart(DateTimePart, CubeFieldProperties)

Creates a date part cube field.

public CubeField CreateDatePart(DateTimePart dateTimePart, CubeFieldProperties cubeFieldProperties)

Parameters

dateTimePart DateTimePart

cubeFieldProperties CubeFieldProperties

Returns

CubeField

CreateUniqueValues()

Creats unique values for the current type of field.

public void CreateUniqueValues()

GetCountValuesInGroup(int)

Gets number of group children by group id.

public int GetCountValuesInGroup(int groupId)

Parameters

groupId int

Returns

int

GetDateTimeSplitField(DateTimePart)

Gets datetime split field.

public CubeField GetDateTimeSplitField(DateTimePart dateTimePart)

Parameters

dateTimePart DateTimePart

Returns

CubeField

GetFieldByName(string)

Gets field by child name.

public CubeField GetFieldByName(string name)

Parameters

name string

Returns

CubeField

GetGroupIdByOrder(int)

Gets id of group by order (by index).

public int GetGroupIdByOrder(int index)

Parameters

index int

Returns

int

GetGroupName(int)

Gets group name by id.

public string GetGroupName(int groupId)

Parameters

groupId int

Returns

string

GetGroupNameByOrder(int)

Gets group name by order (by index).

public string GetGroupNameByOrder(int index)

Parameters

index int

Returns

string

GetUnGroupedUniqueValueIdByOrder(int)

Gets ungrouped unique values by group order (by group index).

public int GetUnGroupedUniqueValueIdByOrder(int index)

Parameters

index int

Returns

int

GetUnGroupedUniqueValuesCount()

Gets number of ungrouped unique values.

public int GetUnGroupedUniqueValuesCount()

Returns

int

GetUniqueValueIdInGroupByOrder(int, int)

Gets unique value id in the group by order (by index).

public int GetUniqueValueIdInGroupByOrder(int groupId, int index)

Parameters

groupId int

index int

Returns

int

HaveDateTimeSplit(DateTimePart)

Returns that has datetime split.

public bool HaveDateTimeSplit(DateTimePart dateTimePart)

Parameters

dateTimePart DateTimePart

Returns

bool

RemoveDateTimeSplit(DateTimePart)

Removes datetime split.

public bool RemoveDateTimeSplit(DateTimePart dateTimePart)

Parameters

dateTimePart DateTimePart

Returns

bool

SetGroupName(int, string)

Sets group name by id.

public void SetGroupName(int groupId, string groupName)

Parameters

groupId int

groupName string

SetGroupNameByOrder(int, string)

Sets group name by order (by index).

public void SetGroupNameByOrder(int index, string groupName)

Parameters

index int

groupName string