Class DataProviderViewExtensions

Extensions for data provider view.

Inheritance

object

DataProviderViewExtensions

Namespace: BiExcellence.OpenBi.Api.Commands.DataProviders

Assembly: BiExcellence.OpenBi.Api.DataProvider.dll

Syntax

public static class DataProviderViewExtensions

Methods

CreateDataCommentAsync(IDataProviderView, IKeyFigure, IEnumerable<KeyValuePair<IDimension, string>>, string, bool, CancellationToken)

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

Declaration

public static Task CreateDataCommentAsync(this IDataProviderView view, IKeyFigure keyFigure, IEnumerable<KeyValuePair<IDimension, string>> tuples, string content, bool isPrivate, CancellationToken cancellationToken = default)

Parameters

Type	Name	Description
IDataProviderView	view	The data provider view.
IKeyFigure	keyFigure	The key figure.
IEnumerable<KeyValuePair<IDimension, string>>	tuples	The tuples.
string	content	The content.
bool	isPrivate	Is private.
CancellationToken	cancellationToken	The cancellation token.

Returns

Type	Description
Task

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

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

Declaration

public static Task CreateDataCommentAsync(this IDataProviderView view, int rowIndex, int columnIndex, string content, bool isPrivate, CancellationToken cancellationToken = default)

Parameters

Type	Name	Description
IDataProviderView	view	The data provider view.
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

DeleteDataCommentAsync(IDataProviderView, string, CancellationToken)

Deletes a data comment by id.

Declaration

public static Task DeleteDataCommentAsync(this IDataProviderView view, string id, CancellationToken cancellationToken = default)

Parameters

Type	Name	Description
IDataProviderView	view	The data provider view.
string	id	The data comment id.
CancellationToken	cancellationToken	The cancellation token.

Returns

Type	Description
Task

DeleteDimensionsAsync(IDataProviderView, IEnumerable<IDimension>, CancellationToken)

Deletes dimensions from the data provider view.

Declaration

public static Task DeleteDimensionsAsync(this IDataProviderView view, IEnumerable<IDimension> dimensions, CancellationToken cancellationToken = default)

Parameters

Type	Name	Description
IDataProviderView	view	The data provider view.
IEnumerable<IDimension>	dimensions	The dimensions.
CancellationToken	cancellationToken	The cancellation token.

Returns

Type	Description
Task

DeleteKeyFiguresAsync(IDataProviderView, IEnumerable<IKeyFigure>, CancellationToken)

Deletes key figures from the data provider view.

Declaration

public static Task DeleteKeyFiguresAsync(this IDataProviderView view, IEnumerable<IKeyFigure> keyFigures, CancellationToken cancellationToken = default)

Parameters

Type	Name	Description
IDataProviderView	view	The data provider view.
IEnumerable<IKeyFigure>	keyFigures	The key figures.
CancellationToken	cancellationToken	The cancellation token.

Returns

Type	Description
Task

DeleteVariablesAsync(IDataProviderView, IEnumerable<IVariable>, CancellationToken)

Deletes variables from the data provider view.

Declaration

public static Task DeleteVariablesAsync(this IDataProviderView view, IEnumerable<IVariable> variables, CancellationToken cancellationToken = default)

Parameters

Type	Name	Description
IDataProviderView	view	The data provider view.
IEnumerable<IVariable>	variables	The variables.
CancellationToken	cancellationToken	The cancellation token.

Returns

Type	Description
Task

ExecuteAsync(IDataProviderView, IEnumerable<IAffectedDataProvider>?, CancellationToken)

Executes the data provider view and raising the Executing and Executed events.

Declaration

public static Task<IExecuteDefinition> ExecuteAsync(this IDataProviderView view, IEnumerable<IAffectedDataProvider>? affectedDataProviders, CancellationToken cancellationToken = default)

Parameters

Type	Name	Description
IDataProviderView	view	The data provider view.
IEnumerable<IAffectedDataProvider>	affectedDataProviders	The affected data providers.
CancellationToken	cancellationToken	The cancellation token.

Returns

Type	Description
Task<IExecuteDefinition>

ExecuteAsync(IDataProviderView, CancellationToken)

Executes the data provider view.

Declaration

public static Task<IExecuteDefinition> ExecuteAsync(this IDataProviderView view, CancellationToken cancellationToken = default)

Parameters

Type	Name	Description
IDataProviderView	view	The data provider view.
CancellationToken	cancellationToken	The cancellation token.

Returns

Type	Description
Task<IExecuteDefinition>

GetChartDataAsync(IDataProviderView, bool?, bool?, bool?, bool?, bool?, CancellationToken)

Returns the chart data for the data provider view.

Declaration

public static Task<IChartData> GetChartDataAsync(this IDataProviderView view, bool? switchMatrix = null, bool? suppressSums = null, bool? suppressOpenHierNodes = null, bool? showExceptions = null, bool? withTuples = null, CancellationToken cancellationToken = default)

Parameters

Type	Name	Description
IDataProviderView	view	The data provider view.
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.

Returns

Type	Description
Task<IChartData>

GetDataCommentsAsync(IDataProviderView, CancellationToken)

Returns data comments for a data provider view.

Declaration

public static Task<IList<IDataComment>> GetDataCommentsAsync(this IDataProviderView view, CancellationToken cancellationToken = default)

Parameters

Type	Name	Description
IDataProviderView	view	The data provider view.
CancellationToken	cancellationToken	The cancellation token.

Returns

Type	Description
Task<IList<IDataComment>>

GetDataProviderDefinitionAsync(IDataProviderView, CancellationToken)

Returns the data provider definition.

Declaration

public static Task<IDataProviderDefinition> GetDataProviderDefinitionAsync(this IDataProviderView view, CancellationToken cancellationToken = default)

Parameters

Type	Name	Description
IDataProviderView	view	The data provider view.
CancellationToken	cancellationToken	The cancellation token.

Returns

Type	Description
Task<IDataProviderDefinition>

GetExportDocumentAsync(IDataProviderView, string, CancellationToken)

Exports the grid data.

Declaration

public static Task<IExportDocument> GetExportDocumentAsync(this IDataProviderView view, string format, CancellationToken cancellationToken = default)

Parameters

Type	Name	Description
IDataProviderView	view	The data provider view.
string	format	The export format. E.g. XLS, XLSX, CSV
CancellationToken	cancellationToken	The cancellation token.

Returns

Type	Description
Task<IExportDocument>

GetF4ValuesAsync(IDataProviderView, IDimension, IEnumerable<IVariable>, CancellationToken)

Returns the f4values for the data provider view.

Declaration

public static Task<IF4Values> GetF4ValuesAsync(this IDataProviderView view, IDimension dimension, IEnumerable<IVariable> dataProviderVariables, CancellationToken cancellationToken = default)

Parameters

Type	Name	Description
IDataProviderView	view	The data provider view.
IDimension	dimension	The dimension.
IEnumerable<IVariable>	dataProviderVariables	The data provider variables.
CancellationToken	cancellationToken	The cancellation token.

Returns

Type	Description
Task<IF4Values>

GetF4ValuesAsync(IDataProviderView, IDimension, CancellationToken)

Returns the f4values for the data provider view.

Declaration

public static Task<IF4Values> GetF4ValuesAsync(this IDataProviderView view, IDimension dimension, CancellationToken cancellationToken = default)

Parameters

Type	Name	Description
IDataProviderView	view	The data provider view.
IDimension	dimension	The dimension.
CancellationToken	cancellationToken	The cancellation token.

Returns

Type	Description
Task<IF4Values>

GetF4ValuesAsync(IDataProviderView, IVariable, IFilter, CancellationToken)

Returns the f4values for the data provider view.

Declaration

public static Task<IF4Values> GetF4ValuesAsync(this IDataProviderView view, IVariable variable, IFilter filter, CancellationToken cancellationToken = default)

Parameters

Type	Name	Description
IDataProviderView	view	The data provider view.
IVariable	variable	The variable.
IFilter	filter	The filter.
CancellationToken	cancellationToken	The cancellation token.

Returns

Type	Description
Task<IF4Values>

GetF4ValuesAsync(IDataProviderView, IVariable, IEnumerable<IVariable>, IFilter, CancellationToken)

Returns the f4values for the data provider view.

Declaration

public static Task<IF4Values> GetF4ValuesAsync(this IDataProviderView view, IVariable variable, IEnumerable<IVariable> dataProviderVariables, IFilter filter, CancellationToken cancellationToken = default)

Parameters

Type	Name	Description
IDataProviderView	view	The data provider view.
IVariable	variable	The variable.
IEnumerable<IVariable>	dataProviderVariables	The data provider variables.
IFilter	filter	The filter.
CancellationToken	cancellationToken	The cancellation token.

Returns

Type	Description
Task<IF4Values>

GetF4ValuesAsync(IDataProviderView, IVariable, IEnumerable<IVariable>, CancellationToken)

Returns the f4values for the data provider view.

Declaration

public static Task<IF4Values> GetF4ValuesAsync(this IDataProviderView view, IVariable variable, IEnumerable<IVariable> dataProviderVariables, CancellationToken cancellationToken = default)

Parameters

Type	Name	Description
IDataProviderView	view	The data provider view.
IVariable	variable	The variable.
IEnumerable<IVariable>	dataProviderVariables	The data provider variables.
CancellationToken	cancellationToken	The cancellation token.

Returns

Type	Description
Task<IF4Values>

GetF4ValuesAsync(IDataProviderView, IVariable, CancellationToken)

Returns the f4values for the data provider view.

Declaration

public static Task<IF4Values> GetF4ValuesAsync(this IDataProviderView view, IVariable variable, CancellationToken cancellationToken = default)

Parameters

Type	Name	Description
IDataProviderView	view	The data provider view.
IVariable	variable	The variable.
CancellationToken	cancellationToken	The cancellation token.

Returns

Type	Description
Task<IF4Values>

GetGridDataAsync(IDataProviderView, bool?, bool?, bool?, CancellationToken)

Returns the grid data for the data provider view.

Declaration

public static Task<IGridData> GetGridDataAsync(this IDataProviderView view, bool? withMaps = null, bool? withTuples = null, bool? withDelta = null, CancellationToken cancellationToken = default)

Parameters

Type	Name	Description
IDataProviderView	view	The data provider view.
bool?	withMaps	Include map / geo data.
bool?	withTuples	Include grid cell tuples.
bool?	withDelta	Incldue delta.
CancellationToken	cancellationToken	The cancellation token.

Returns

Type	Description
Task<IGridData>

GetGridDataSliceAsync(IDataProviderView, bool?, bool?, bool?, int?, int?, int?, int?, CancellationToken)

Returns the grid data for the data provider view.

Declaration

public static Task<IGridData> GetGridDataSliceAsync(this IDataProviderView view, bool? withMaps = null, bool? withTuples = null, bool? withDelta = null, int? fromRow = null, int? numRows = null, int? fromColumn = null, int? numColumns = null, CancellationToken cancellationToken = default)

Parameters

Type	Name	Description
IDataProviderView	view	The data provider view.
bool?	withMaps	Include map / geo data.
bool?	withTuples	Include grid cell tuples.
bool?	withDelta	Incldue delta.
int?	fromRow	The start row.
int?	numRows	The number of rows.
int?	fromColumn	The start column.
int?	numColumns	The number of columns.
CancellationToken	cancellationToken	The cancellation token.

Returns

Type	Description
Task<IGridData>

GetGridDataSliceWithHeadersAsync(IDataProviderView, bool?, bool?, bool?, int?, int?, int?, int?, CancellationToken)

Returns the grid data for the data provider view.

Declaration

public static Task<IGridData> GetGridDataSliceWithHeadersAsync(this IDataProviderView view, bool? withMaps = null, bool? withTuples = null, bool? withDelta = null, int? fromDataRow = null, int? numRows = null, int? fromDataColumn = null, int? numColumns = null, CancellationToken cancellationToken = default)

Parameters

Type	Name	Description
IDataProviderView	view	The data provider view.
bool?	withMaps	Include map / geo data.
bool?	withTuples	Include grid cell tuples.
bool?	withDelta	Incldue delta.
int?	fromDataRow	The start data row.
int?	numRows	The number of rows.
int?	fromDataColumn	The start data column.
int?	numColumns	The number of columns.
CancellationToken	cancellationToken	The cancellation token.

Returns

Type	Description
Task<IGridData>

SaveViewAsync(IDataProviderView, string?, CancellationToken)

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

Declaration

public static Task<string> SaveViewAsync(this IDataProviderView view, string? contentId = null, CancellationToken cancellationToken = default)

Parameters

Type	Name	Description
IDataProviderView	view	The data provider view.
string	contentId	The role content element id.
CancellationToken	cancellationToken	The cancellation token.

Returns

Type	Description
Task<string>