Table of Contents

Class DataProviderF4Value

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

One value a dimension or a variable can be filtered on.

public sealed class DataProviderF4Value
Inheritance
object
DataProviderF4Value

Properties

Attributes

The dimension's attributes for this value, where they were asked for.

[JsonPropertyName("attributes")]
public Dictionary<string, JsonElement>? Attributes { get; set; }

Property Value

Dictionary<string, JsonElement>

Chavl

The key.

[JsonPropertyName("chavl")]
public string? Chavl { get; set; }

Property Value

string

ChavlExt

The external, formatted form of the key.

[JsonPropertyName("chavlExt")]
public string? ChavlExt { get; set; }

Property Value

string

ChavlExtNc

The external key without conversion, for a flat value.

[JsonPropertyName("chavlExtNc")]
public string? ChavlExtNc { get; set; }

Property Value

string

ChavlNc

The key without conversion, for a flat value.

[JsonPropertyName("chavlNc")]
public string? ChavlNc { get; set; }

Property Value

string

HierarchyDate

The key date that hierarchy was read at.

[JsonPropertyName("hierarchyDate")]
public string? HierarchyDate { get; set; }

Property Value

string

HierarchyName

The hierarchy the node belongs to.

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

Property Value

string

HierarchyVersion

The version of that hierarchy.

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

Property Value

string

IconId

The icon the source suggests for the value.

[JsonPropertyName("iconId")]
public string? IconId { get; set; }

Property Value

string

ImageUrl

An image to render next to the value.

[JsonPropertyName("imageUrl")]
public string? ImageUrl { get; set; }

Property Value

string

IsFolder

True where the node is a folder rather than a value, so it cannot be filtered on.

[JsonPropertyName("isFolder")]
public bool IsFolder { get; set; }

Property Value

bool

Latitude

The latitude, where coordinates were asked for.

[JsonPropertyName("latitude")]
public string? Latitude { get; set; }

Property Value

string

Longitude

The longitude, where coordinates were asked for.

[JsonPropertyName("longitude")]
public string? Longitude { get; set; }

Property Value

string

Niobjnm

The dimension the node's value belongs to, where a hierarchy mixes dimensions.

[JsonPropertyName("niobjnm")]
public string? Niobjnm { get; set; }

Property Value

string

NodeId

The value's own id, for a flat value.

[JsonPropertyName("nodeId")]
public string? NodeId { get; set; }

Property Value

string

NodeKey

The node key, for a hierarchy value.

[JsonPropertyName("nodeKey")]
public string? NodeKey { get; set; }

Property Value

string

ParentNodeKey

The key of the node this one sits under, for a hierarchy value.

[JsonPropertyName("parentNodeKey")]
public string? ParentNodeKey { get; set; }

Property Value

string

Text

The display text.

[JsonPropertyName("text")]
public string? Text { get; set; }

Property Value

string

Methods

ToFilter(DataProviderFilterSign)

Builds the filter that selects this value.

public DataProviderFilter ToFilter(DataProviderFilterSign sign = DataProviderFilterSign.Include)

Parameters

sign DataProviderFilterSign

Returns

DataProviderFilter