Table of Contents

Class DataProviderDrillState

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

One expanded or collapsed node of a hierarchy or of a drill down.

public sealed class DataProviderDrillState
Inheritance
object
DataProviderDrillState

Constructors

DataProviderDrillState()

Creates an empty drill state.

public DataProviderDrillState()

DataProviderDrillState(DataProviderDrillState)

Creates a copy.

public DataProviderDrillState(DataProviderDrillState drillState)

Parameters

drillState DataProviderDrillState

DataProviderDrillState(string, string, string)

Creates a drill state on one value of one dimension.

public DataProviderDrillState(string dimensionId, string value, string drillState)

Parameters

dimensionId string
value string
drillState string

DataProviderDrillState(string, string, string?, string)

Creates a drill state on one value of one dimension, in a hierarchy.

public DataProviderDrillState(string dimensionId, string value, string? hierarchyName, string drillState)

Parameters

dimensionId string
value string
hierarchyName string
drillState string

Properties

DimensionId

The dimension the value belongs to.

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

Property Value

string

DrillDimensionId

The dimension that is drilled down on, where it is not DimensionId.

[JsonPropertyName("drillDimensionId")]
public string? DrillDimensionId { get; set; }

Property Value

string

DrillState

One of DataProviderDrillStates.

[JsonPropertyName("drillState")]
public string? DrillState { 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

NextDimensionId

The dimension the node expands into, where the drill down crosses dimensions.

[JsonPropertyName("nextDimensionId")]
public string? NextDimensionId { get; set; }

Property Value

string

Position

The position in the drill path, 1-based. Left at zero, the server takes the step's place in the path it was added to, so a path built in order needs no positions.

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

Property Value

int

Value

The value that is expanded or collapsed.

[JsonPropertyName("value")]
public string? Value { get; set; }

Property Value

string