Class OpenBiDataProviderViewExtensions

Extensions for data provider.

Inheritance
object
OpenBiDataProviderViewExtensions
Syntax
public static class OpenBiDataProviderViewExtensions

Methods

CreateDataCommentAsync(IOpenBiSession, string, int, int, string, bool, CancellationToken)

Creates a data comment via indexes for a data provider name.

Declaration
public static Task CreateDataCommentAsync(this IOpenBiSession session, string dataProviderName, int rowIndex, int columnIndex, string content, bool isPrivate, CancellationToken cancellationToken = default)
Parameters
Type Name Description
IOpenBiSession session

The session.
string dataProviderName

The data provider name.
int rowIndex

The row index.
int columnIndex

The column index.
string content

The content.
bool isPrivate

Is private.
CancellationToken cancellationToken

The cancellation token.
Returns
Type Description
Task

CreateDataCommentAsync(IOpenBiSession, string, string?, IEnumerable<KeyValuePair<string, string>>, string, bool, CancellationToken)

Creates a data comment via tuples for a data provider name.

Declaration
public static Task CreateDataCommentAsync(this IOpenBiSession session, string dataProviderName, string? keyFigureId, IEnumerable<KeyValuePair<string, string>> tuples, string content, bool isPrivate, CancellationToken cancellationToken = default)
Returns
Type Description
Task

DeleteDataCommentAsync(IOpenBiSession, string, string, CancellationToken)

Deletes a data comment by id.

Declaration
public static Task DeleteDataCommentAsync(this IOpenBiSession session, string dataProviderName, string id, CancellationToken cancellationToken = default)
Returns
Type Description
Task

DeleteDataProviderAsync(IOpenBiSession, string, CancellationToken)

Deletes a data proivder name.

Declaration
public static Task DeleteDataProviderAsync(this IOpenBiSession session, string dataProviderName, CancellationToken cancellationToken = default)
Returns
Type Description
Task

DeleteDataProviderDimensionsAsync(IOpenBiSession, string, IEnumerable<string>, CancellationToken)

Deletes dimensions from a data provider name.

Declaration
public static Task DeleteDataProviderDimensionsAsync(this IOpenBiSession session, string dataProviderName, IEnumerable<string> ids, CancellationToken cancellationToken = default)
Returns
Type Description
Task

DeleteDataProviderKeyFiguresAsync(IOpenBiSession, string, IEnumerable<string>, CancellationToken)

Deletes key figures from a data provider name.

Declaration
public static Task DeleteDataProviderKeyFiguresAsync(this IOpenBiSession session, string dataProviderName, IEnumerable<string> ids, CancellationToken cancellationToken = default)
Returns
Type Description
Task

DeleteDataProviderVariablesAsync(IOpenBiSession, string, IEnumerable<string>, CancellationToken)

Deletes variables from a data provider name.

Declaration
public static Task DeleteDataProviderVariablesAsync(this IOpenBiSession session, string dataProviderName, IEnumerable<string> ids, CancellationToken cancellationToken = default)
Returns
Type Description
Task

ExecuteDataProviderAsync(IOpenBiSession, string, IDataProviderDefinition, IEnumerable<IAffectedDataProvider>?, CancellationToken)

Executes a data provider.

Declaration
public static Task<IExecuteDefinition> ExecuteDataProviderAsync(this IOpenBiSession session, string dataProviderName, IDataProviderDefinition dataProviderDefinition, IEnumerable<IAffectedDataProvider>? affectedDataProviders, CancellationToken cancellationToken = default)

ExecuteDataProviderAsync(IOpenBiSession, string, IDataProviderDefinition, CancellationToken)

Executes a data provider.

Declaration
public static Task<IExecuteDefinition> ExecuteDataProviderAsync(this IOpenBiSession session, string dataProviderName, IDataProviderDefinition dataProviderDefinition, CancellationToken cancellationToken = default)

GetChartDataAsync(IOpenBiSession, string, bool?, bool?, bool?, bool?, bool?, CancellationToken)

Returns the chart data for a data provider name.

Declaration
public static Task<IChartData> GetChartDataAsync(this IOpenBiSession session, string dataProviderName, bool? switchMatrix = null, bool? suppressSums = null, bool? suppressOpenHierNodes = null, bool? showExceptions = null, bool? withTuples = null, CancellationToken cancellationToken = default)
Parameters
Type Name Description
IOpenBiSession session

The sesion.
string dataProviderName

The data provider name.
bool? switchMatrix

Switch matrix.
bool? suppressSums

Suppress sums.
bool? suppressOpenHierNodes

Suppress open hierarchy nodes.
bool? showExceptions

Include exceptions.
bool? withTuples

Include category / group tuples.
CancellationToken cancellationToken

The cancellation token.

GetDataCommentsAsync(IOpenBiSession, string, CancellationToken)

Returns data comments for a data provider name.

Declaration
public static Task<IList<IDataComment>> GetDataCommentsAsync(this IOpenBiSession session, string dataProviderName, CancellationToken cancellationToken = default)

GetDataProviderDefinitionAsync(IOpenBiSession, string, CancellationToken)

Returns the data provider definition for a data provider name.

Declaration
public static Task<IDataProviderDefinition> GetDataProviderDefinitionAsync(this IOpenBiSession session, string dataProviderName, CancellationToken cancellationToken = default)

GetExportDocumentAsync(IOpenBiSession, string, string, CancellationToken)

Exports the grid data of a dataprovider.

Declaration
public static Task<IExportDocument> GetExportDocumentAsync(this IOpenBiSession session, string dataProviderName, string format, CancellationToken cancellationToken = default)
Parameters
Type Name Description
IOpenBiSession session

The session.
string dataProviderName

The data provider name.
string format

The export format. E.g. XLS, XLSX, CSV
CancellationToken cancellationToken

The cancellation token.

GetF4ValuesAsync(IOpenBiSession, string, IDimension, IEnumerable<IVariable>?, CancellationToken)

Returns the f4values for a data provider name.

Declaration
public static Task<IF4Values> GetF4ValuesAsync(this IOpenBiSession session, string dataProviderName, IDimension dimension, IEnumerable<IVariable>? dataProviderVariables, CancellationToken cancellationToken = default)

GetF4ValuesAsync(IOpenBiSession, string, IDimension, CancellationToken)

Returns the f4values for a data provider name.

Declaration
public static Task<IF4Values> GetF4ValuesAsync(this IOpenBiSession session, string dataProviderName, IDimension dimension, CancellationToken cancellationToken = default)

GetF4ValuesAsync(IOpenBiSession, string, IVariable, IFilter, CancellationToken)

Returns the f4values for a data provider name.

Declaration
public static Task<IF4Values> GetF4ValuesAsync(this IOpenBiSession session, string dataProviderName, IVariable variable, IFilter filter, CancellationToken cancellationToken = default)

GetF4ValuesAsync(IOpenBiSession, string, IVariable, IEnumerable<IVariable>?, IFilter?, CancellationToken)

Returns the f4values for a data provider name.

Declaration
public static Task<IF4Values> GetF4ValuesAsync(this IOpenBiSession session, string dataProviderName, IVariable variable, IEnumerable<IVariable>? dataProviderVariables, IFilter? filter, CancellationToken cancellationToken = default)

GetF4ValuesAsync(IOpenBiSession, string, IVariable, IEnumerable<IVariable>, CancellationToken)

Returns the f4values for a data provider name.

Declaration
public static Task<IF4Values> GetF4ValuesAsync(this IOpenBiSession session, string dataProviderName, IVariable variable, IEnumerable<IVariable> dataProviderVariables, CancellationToken cancellationToken = default)

GetF4ValuesAsync(IOpenBiSession, string, IVariable, CancellationToken)

Returns the f4values for a data provider name.

Declaration
public static Task<IF4Values> GetF4ValuesAsync(this IOpenBiSession session, string dataProviderName, IVariable variable, CancellationToken cancellationToken = default)

GetGridDataAsync(IOpenBiSession, string, bool?, bool?, bool?, CancellationToken)

Returns the grid data for a data provider name.

Declaration
public static Task<IGridData> GetGridDataAsync(this IOpenBiSession session, string dataProviderName, bool? withMaps = null, bool? withTuples = null, bool? withDelta = null, CancellationToken cancellationToken = default)
Parameters
Type Name Description
IOpenBiSession session

The sesion.
string dataProviderName

The data provider name.
bool? withMaps

Include map / geo data.
bool? withTuples

Include grid cell tuples.
bool? withDelta

Incldue delta.
CancellationToken cancellationToken

The cancellation token.

GetGridDataSliceAsync(IOpenBiSession, string, bool?, bool?, bool?, int?, int?, int?, int?, CancellationToken)

Returns a grid data subset for a data provider name.

Declaration
public static Task<IGridData> GetGridDataSliceAsync(this IOpenBiSession session, string dataProviderName, bool? withMaps = null, bool? withTuples = null, bool? withDelta = null, int? fromRow = null, int? fromColumn = null, int? numRows = null, int? numColumns = null, CancellationToken cancellationToken = default)
Parameters
Type Name Description
IOpenBiSession session

The sesion.
string dataProviderName

The data provider name.
bool? withMaps

Include map / geo data.
bool? withTuples

Include grid cell tuples.
bool? withDelta

Incldue delta.
int? fromRow

The start row.
int? fromColumn

The start column.
int? numRows

The number of rows.
int? numColumns

The number of columns.
CancellationToken cancellationToken

The cancellation token.

GetGridDataSliceWithHeadersAsync(IOpenBiSession, string, bool?, bool?, bool?, int?, int?, int?, int?, CancellationToken)

Returns a grid data subset for a data provider name.

Declaration
public static Task<IGridData> GetGridDataSliceWithHeadersAsync(this IOpenBiSession session, string dataProviderName, bool? withMaps = null, bool? withTuples = null, bool? withDelta = null, int? fromDataRow = null, int? fromDataColumn = null, int? numRows = null, int? numColumns = null, CancellationToken cancellationToken = default)
Parameters
Type Name Description
IOpenBiSession session

The sesion.
string dataProviderName

The data provider name.
bool? withMaps

Include map / geo data.
bool? withTuples

Include grid cell tuples.
bool? withDelta

Incldue delta.
int? fromDataRow

The start data row.
int? fromDataColumn

The start data column.
int? numRows

The number of rows.
int? numColumns

The number of columns.
CancellationToken cancellationToken

The cancellation token.

SaveDataProviderViewAsync(IOpenBiSession, string, string?, CancellationToken)

Saves the current data provider view state in a role content element.

Declaration
public static Task<string> SaveDataProviderViewAsync(this IOpenBiSession session, string dataProviderName, string? contentId = null, CancellationToken cancellationToken = default)
Parameters
Type Name Description
IOpenBiSession session

The session.
string dataProviderName

The data provider name.
string contentId

The role content element id.
CancellationToken cancellationToken

The cancellation token.