Table of Contents

Class DataProviderDimension

Namespace
BiExcellence.OpenBi.Api.DataProviders
Assembly
BiExcellence.OpenBi.Api.Client.dll

A characteristic: a column of the result that the values are grouped by.

public sealed class DataProviderDimension : DataProviderElement
Inheritance
object
DataProviderDimension
Inherited Members
Extension Methods

Constructors

DataProviderDimension()

Creates an empty dimension.

public DataProviderDimension()

DataProviderDimension(DataProviderDimension)

Creates a copy, filters, attributes and hierarchies included.

public DataProviderDimension(DataProviderDimension dimension)

Parameters

dimension DataProviderDimension

DataProviderDimension(string)

Creates a dimension with this id.

public DataProviderDimension(string id)

Parameters

id string

Properties

Attributes

The dimension's attributes, addressable by id.

[JsonPropertyName("attributes")]
public DataProviderElementCollection<DataProviderDimensionAttribute> Attributes { get; set; }

Property Value

DataProviderElementCollection<DataProviderDimensionAttribute>

Axis

The axis the dimension sits on.

[JsonPropertyName("axis")]
public DataProviderAxis Axis { get; set; }

Property Value

DataProviderAxis

CaptionAttribute

The attribute whose value is shown instead of the dimension's own text.

[JsonPropertyName("captionAttribute")]
public string? CaptionAttribute { get; set; }

Property Value

string

ContainsKeyFigures

True for the structure that carries the key figures.

[JsonPropertyName("containsKeyFigures")]
public bool ContainsKeyFigures { get; set; }

Property Value

bool

DimensionType

How the dimension gets its values.

[JsonPropertyName("dimensionType")]
public DataProviderDimensionType DimensionType { get; set; }

Property Value

DataProviderDimensionType

Filters

The filters on the dimension. All of them have to match.

[JsonPropertyName("filters")]
public List<DataProviderFilter> Filters { get; set; }

Property Value

List<DataProviderFilter>

Formula

The expression, for a Formula dimension.

[JsonPropertyName("formula")]
public string? Formula { get; set; }

Property Value

string

Hierarchies

The hierarchies the dimension offers. Not sent back on execute.

[JsonPropertyName("hierarchies")]
public List<DataProviderHierarchy>? Hierarchies { get; set; }

Property Value

List<DataProviderHierarchy>

HierarchyActive

Whether HierarchyName is in effect.

[JsonPropertyName("hierarchyActive")]
public bool HierarchyActive { get; set; }

Property Value

bool

HierarchyName

The active hierarchy, one of Hierarchies.

[JsonPropertyName("hierarchyName")]
public string? HierarchyName { get; set; }

Property Value

string

HierarchyValidTo

The key date the active hierarchy is read at.

[JsonPropertyName("hierarchyValidTo")]
public string? HierarchyValidTo { get; set; }

Property Value

string

HierarchyVersion

The version of the active hierarchy.

[JsonPropertyName("hierarchyVersion")]
public string? HierarchyVersion { get; set; }

Property Value

string

InputFormat

The date format the source delivers, for a date dimension.

[JsonPropertyName("inputFormat")]
public string? InputFormat { get; set; }

Property Value

string

IsStructure

True for a structure - a dimension whose members are defined in the query, not in the data.

[JsonPropertyName("isStructure")]
public bool IsStructure { get; set; }

Property Value

bool

IsTechnical

True where the dimension exists for the engine rather than for the reader.

[JsonPropertyName("isTechnical")]
public bool IsTechnical { get; set; }

Property Value

bool

OutputFormat

The date format the values are rendered in, for a date dimension.

[JsonPropertyName("outputFormat")]
public string? OutputFormat { get; set; }

Property Value

string

Position

The position on its axis, 1-based.

[JsonPropertyName("position")]
public int Position { get; set; }

Property Value

int

ReferenceAttribute

The attribute of ReferenceDimension this one reads, where it is not the dimension itself.

[JsonPropertyName("referenceAttribute")]
public string? ReferenceAttribute { get; set; }

Property Value

string

ReferenceDimension

The dimension this one reads, for a Reference dimension.

[JsonPropertyName("referenceDimension")]
public string? ReferenceDimension { get; set; }

Property Value

string

SortMode

How the dimension is sorted.

[JsonPropertyName("sortMode")]
public DataProviderSortMode SortMode { get; set; }

Property Value

DataProviderSortMode

SortType

What the dimension is sorted by.

[JsonPropertyName("sortType")]
public DataProviderSortType SortType { get; set; }

Property Value

DataProviderSortType

SourceFieldName

The column of the source this reads, where it differs from Id.

[JsonPropertyName("sourceFieldName")]
public string? SourceFieldName { get; set; }

Property Value

string

SumState

Whether the dimension shows its totals row.

[JsonPropertyName("sumState")]
public DataProviderSumState SumState { get; set; }

Property Value

DataProviderSumState

Type

The dimension's data type. Text unless stated otherwise - a characteristic is a key.

[JsonPropertyName("type")]
[JsonConverter(typeof(JsonStringEnumConverter<DbType>))]
public DbType Type { get; set; }

Property Value

DbType

Visible

Whether the dimension is shown. Absent means visible.

[JsonPropertyName("visible")]
public bool? Visible { get; set; }

Property Value

bool?