Table of Contents

Class DataProviderChartValue

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

One point of a chart.

public sealed class DataProviderChartValue
Inheritance
object
DataProviderChartValue

Properties

AlertLevel

The exception level the point carries, 1-9, or null where it carries none. A chart asked for with exceptions puts the level in Color as a two-digit code, "00" meaning none

  • the same encoding the grid uses, where the server reads it for the caller.
[JsonIgnore]
public int? AlertLevel { get; }

Property Value

int?

CategoryId

The category this point belongs to.

[JsonPropertyName("categoryId")]
public string? CategoryId { get; set; }

Property Value

string

Color

The colour the point is rendered in. Where the chart was asked for exceptions, this is the two-digit exception code rather than a colour - AlertLevel reads it.

[JsonPropertyName("color")]
public string? Color { get; set; }

Property Value

string

ColumnTuples

The column tuple the point sits at, where tuples were asked for.

[JsonPropertyName("columnTuples")]
public List<DataProviderAxisData>? ColumnTuples { get; set; }

Property Value

List<DataProviderAxisData>

Currency

The currency the value is in.

[JsonPropertyName("currency")]
public string? Currency { get; set; }

Property Value

string

Data

The raw value, as the source delivered it.

[JsonPropertyName("data")]
public string? Data { get; set; }

Property Value

string

GroupId

The series this point belongs to.

[JsonPropertyName("groupId")]
public string? GroupId { get; set; }

Property Value

string

Label

The display text.

[JsonPropertyName("label")]
public string? Label { get; set; }

Property Value

string

Mwkz

The unit kind the value is in - currency, quantity or none.

[JsonPropertyName("mwkz")]
public string? Mwkz { get; set; }

Property Value

string

NumPrec

The number of digits the value is rendered with.

[JsonPropertyName("numPrec")]
public int? NumPrec { get; set; }

Property Value

int?

NumScale

The power of ten the value was divided by.

[JsonPropertyName("numScale")]
public int? NumScale { get; set; }

Property Value

int?

RowTuples

The row tuple the point sits at, where tuples were asked for.

[JsonPropertyName("rowTuples")]
public List<DataProviderAxisData>? RowTuples { get; set; }

Property Value

List<DataProviderAxisData>

Unit

The unit the value is in.

[JsonPropertyName("unit")]
public string? Unit { get; set; }

Property Value

string

Value

Data as a number, or null where the point holds none. The wire carries it as an invariant string, so this never depends on the caller's culture.

[JsonIgnore]
public double? Value { get; }

Property Value

double?