Table of Contents

Class DataProviderKeyFigure

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

A number the dataprovider reads: a column of the source or a formula over them.

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

Constructors

DataProviderKeyFigure()

Creates an empty key figure.

public DataProviderKeyFigure()

DataProviderKeyFigure(DataProviderKeyFigure)

Creates a copy, filters, alert levels and sort tuples included.

public DataProviderKeyFigure(DataProviderKeyFigure keyFigure)

Parameters

keyFigure DataProviderKeyFigure

DataProviderKeyFigure(string)

Creates a key figure with this id.

public DataProviderKeyFigure(string id)

Parameters

id string

Properties

Aggregation

How the values are aggregated.

[JsonPropertyName("aggregation")]
public DataProviderAggregation Aggregation { get; set; }

Property Value

DataProviderAggregation

AlertLevels

The exception ranges defined on the key figure.

[JsonPropertyName("alertLevels")]
public List<DataProviderAlertLevel>? AlertLevels { get; set; }

Property Value

List<DataProviderAlertLevel>

CalculationTime

When Formula is evaluated. Only meaningful for a calculated key figure, and null on one read back from the server that has no formula. After aggregation unless stated otherwise.

[JsonPropertyName("calculationTime")]
public DataProviderCalculationTime? CalculationTime { get; set; }

Property Value

DataProviderCalculationTime?

Decimals

The number of decimal places. Absent means the type's default.

[JsonPropertyName("decimals")]
public int? Decimals { get; set; }

Property Value

int?

DimensionId

The key figure structure this belongs to, where the source has one.

[JsonPropertyName("dimensionId")]
public string? DimensionId { get; set; }

Property Value

string

Filters

The filters on the key figure's own values.

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

Property Value

List<DataProviderFilter>

Formula

The expression, for a calculated key figure. Dimensions and key figures are named in brackets.

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

Property Value

string

Position

The position among the key figures, 1-based.

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

Property Value

int

Prefix

Text rendered in front of the value.

[JsonPropertyName("prefix")]
public string? Prefix { get; set; }

Property Value

string

Scaling

The power of ten the value is divided by before it is shown.

[JsonPropertyName("scaling")]
public int Scaling { get; set; }

Property Value

int

SortMode

How the grid is sorted by this key figure.

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

Property Value

DataProviderSortMode

SortTuples

The dimension values the sort is restricted to, where the key figure sorts the grid.

[JsonPropertyName("sortTuples")]
public List<DataProviderSortTuple>? SortTuples { get; set; }

Property Value

List<DataProviderSortTuple>

SourceFieldName

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

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

Property Value

string

Suffix

Text rendered after the value - a unit, say.

[JsonPropertyName("suffix")]
public string? Suffix { get; set; }

Property Value

string

Type

The key figure's data type. A number unless stated otherwise.

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

Property Value

DbType

Visible

Whether the key figure is shown. Absent means visible.

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

Property Value

bool?