Working with Regular Reports

This section describes operations that are used for specialized work with specific entities of regular report. These operations minimize size of requests to be sent and speed up their execution. The operations enable the user to execute the following actions:

Change the list of report data sources, change the list and settings of data slices based on these sources.
Work with analytical data area, based on which work with source data is executed.
Work with the collection of regular report sheets.
Work with visualizers and charts on sheets.
Work with controls.

Operations

	Operation	Brief description
	OpenPrxMeta	The OpenPrxMeta operation opens regular report and allows access to work with its metadata.
	GetPrxMeta	The GetPrxMeta operation gets regular report metadata.
	GetPrxMetaOptions	The GetPrxMetaOptions operation gets regular report settings.
	GetUpdateSettings	The GetUpdateSettings operation gets parameters of regular report automatic update.
	SetActiveReport	The SetActiveReport operation sets an active regular report for the current user session.
	SetPrxMeta	The SetPrxMeta operation changes regular report metadata.
	SetPrxMetaOptions	The SetPrxMetaOptions operation changes regular report settings.
	SetUpdateSettings	The SetUpdateSettings operation changes parameters of regular report automatic update.
	ClosePrxMeta	The ClosePrxMeta operation closes regular report instance.
	PrxMetaRefreshDataSources	The PrxMetaRefreshDataSources operation reopens data sources of regular report.
	PrxMetaReportExport	The PrxMetaReportExport operation exports regular report to external file.
	PrxMetaReportRecalc	The PrxMetaReportRecalc operation calculates regular report instance.
	PrxMetaToolbarReset	The PrxMetaToolbarReset operation resets regular report toolbar settings.
	PrxObjectCreate	The PrxObjectCreate operation creates a new object on a regular report sheet.

Operations for working with report sheets:

	Operation	Brief description
	GetPrxMetaJsPlugin	The GetPrxMetaJsPlugin operation gets settings of the regular report sheet created using a JS plugin.
	GetPrxMetaSheetPageSettings	The GetPrxMetaSheetPageSettings operation gets print options for regular report sheet.
	PrxMetaSheetAutoFilter	The PrxMetaSheetAutoFilter operation enables or disables autofilter on a regular report sheet.
	PrxMetaSheetRecalc	The PrxMetaSheetRecalc operation calculates regular report sheet.
	PrxMetaSheetsAdd	The PrxMetaSheetsAdd operation adds a new sheet to regular report.
	PrxMetaSheetsDelete	The PrxMetaSheetsDelete operation deletes regular report sheet.
	PrxMetaSheetsDuplicate	The PrxMetaSheetsDuplicate operation creates a regular report sheet duplicate.
	PrxMetaSheetsMove	The PrxMetaSheetsMove operation moves regular report sheets.
	SetPrxMetaJsPlugin	The SetPrxMetaJsPlugin operation changes settings of the regular report sheet created using a JS plugin.
	SetPrxMetaSheetPageSettings	The SetPrxMetaSheetPageSettings operation changes print options for regular report sheet.

Operations for working with controls:

	Operation	Brief description
	PrxMetaControlsAdd	The PrxMetaControlsAdd operation creates a regular report control.
	PrxMetaControlsDelete	The PrxMetaControlsDelete operation deletes regular report control.
	PrxMetaControlsMove	The PrxMetaControlsMove operation moves regular report control.

Operations for working with visualizers:

	Operation	Brief description
	DataAreaGridRefreshPart	The DataAreaGridRefreshPart operation refreshes the specified table area.
	DataAreaViewsDelete	The DataAreaViewsDelete operation deletes regular report visualizer.
	DrillAction	The DrillAction operation drills down data.
	DrillCheck	The DrillCheck operation checks if data can be drilled down.
	EmulateGridHyperlinkClick	The EmulateGridHyperlinkClick operation emulates a hyperlink click in data area table cell.
	GetDataAreaGridAttachments	The GetDataAreaGridAttachments operation gets a list of table cell attachments.
	GetDataAreaGridDimRanges	The GetDataAreaGridDimRanges operation gets information about cell ranges corresponding to heading and sidehead dimensions.
	GetDataAreaGridMetaData	The GetDataAreaGridMetaData operation gets metadata of the Table visualizer.
	GetEaxGridHeaderProperties	The GetEaxGridHeaderProperties operation gets table visualizer header properties.
	GetEaxGridHeaderSettings	The GetEaxGridHeaderSettings operation gets table visualizer header settings.
	PrxMetaViewsAdd	The PrxMetaViewsAdd operation adds a visualizer to regular report.
	SetDataAreaGridAttachments	The SetDataAreaGridAttachments operation changes the list of table cell attachments.
	SetDataAreaGridMetaData	The SetDataAreaGridMetaData operation changes metadata of the Table visualizer.
	SetEaxGridHeaderProperties	The SetEaxGridHeaderProperties operation changes table visualizer header properties.
	SetEaxGridHeaderSettings	The SetEaxGridHeaderSettings operation changes table visualizer header settings.

Operations for working with charts:

	Operation	Brief description
	GetPrxMetaChart	The GetPrxMetaChart operation gets metadata of the chart located on a regular report sheet.
	GetPrxMetaChartsInfo	The GetPrxMetaChartsInfo operation gets information about regular report charts.
	GetSeriesGroupTree	The GetSeriesGroupTree operation gets a tree of histogram series grouping.
	MoveSeriesGroupTreeElem	The MoveSeriesGroupTreeElem operation moves a series from one group to another group in a histogram.
	SetPrxMetaChart	The SetPrxMetaChart operation changes metadata of the chart located on a regular report sheet.
	SeriesGroupFastFormat	The SeriesGroupFastFormat operation changes histogram series grouping.

Operations for working with analytical data area:

	Operation	Brief description
	GetDataAreaSources	The GetDataAreaSources operation gets information about analytical area data sources.
	SetDataAreaSources	The SetDataAreaSources operation changes data sources of analytical data area.
	DataAreaSourcesAdd	The DataAreaSourcesAdd operation adds a new data source for analytical data area.
	DataAreaSourcesDelete	The DataAreaSourcesDelete operation deletes data source of analytical data area.
	DataAreaSlicesAdd	The DataAreaSlicesAdd operation creates a new data slice for data source of analytical data area.
	DataAreaSlicesDelete	The DataAreaSlicesDelete operation deletes data slice of data source.

Operations for working with data slice base:

	Operation	Brief description
	GetPivotDimensionMetaData	The GetPivotDimensionMetaData operation gets information about data slice dimension.
	GetPivotDimensionSettingsExMetaData	The GetPivotDimensionSettingsExMetaData operation gets advanced settings of data slice dimension.
	GetPivotDimLevelMetaData	The GetPivotDimLevelMetaData operation gets information about data slice dimension level.
	GetPivotEvaluatorTotalsMetaData	The GetPivotEvaluatorTotalsMetaData operation gets total calculation options.
	GetPivotFilterMetaData	The GetPivotFilterMetaData operation gets data filtering settings specified for data slice.
	GetPivotHeaderFilterMetaData	The GetPivotHeaderFilterMetaData operation gets filtering settings for data slice header.
	GetPivotHeaderMetaData	The GetPivotHeaderMetaData operation gets information about data slice header.
	GetPivotMetaData	The GetPivotMetaData operation gets base for creating a data source slice of analytical data area.
	SetPivotDimensionMetaData	The SetPivotDimensionMetaData operation changes data slice dimension.
	SetPivotDimensionSettingsExMetaData	The SetPivotDimensionSettingsExMetaData operation changes advanced settings of data slice dimension.
	SetPivotDimLevelMetaData	The SetPivotDimLevelMetaData operation changes data slice dimension level parameters.
	SetPivotEvaluatorTotalsMetaData	The SetPivotEvaluatorTotalsMetaData operation changes total calculation options.
	SetPivotFilterMetaData	The SetPivotFilterMetaData operation changes data filtering settings specified for data slice.
	SetPivotHeaderFilterMetaData	The SetPivotHeaderFilterMetaData operation changes filtering settings for data slice header.
	SetPivotHeaderMetaData	The SetPivotHeaderMetaData operation changes data slice header settings.
	SetPivotMetaData	The SetPivotMetaData operation changes base of data slice.
	PivotChangeDimHeader	The PivotChangeDimHeader operation changes dimension location.
	PivotMoveDimToIndex	The PivotMoveDimToIndex operation moves dimension in header.
	UpdateDataAreaExternalTransformations	The UpdateDataAreaExternalTransformations operation is used to work with calculation algorithms used in data slices.

Operations for working with regular report units:

	Operation	Brief description
	PrxMetaAssembliesAdd	The PrxMetaAssembliesAdd operation adds a development environment unit to the list of units used in regular report.
	PrxMetaAssembliesRemove	The PrxMetaAssembliesRemove operation removes the unit from the list of units used in regular report.

Operations for working with regular report settings:

	Operation	Brief description
	GetFormulaErrorOptions	The GetFormulaErrorOptions operation gets regular report formulas settings.
	ResetSkippedErrors	The ResetSkippedErrors operation resets skipped errors in cells.
	SetFormulaErrorOptions	The SetFormulaErrorOptions operation changes regular report formulas settings.

Operations for working with a styles table used in regular report:

	Operation	Brief description
	GetPrxStyleSheet	The GetPrxStyleSheet operation gets a styles table connected in regular report.
	ResetPrxStyleSheet	The ResetPrxStyleSheet operation disables the repository styles table used in regular report.
	SetPrxStyleSheet	The SetPrxStyleSheet operation connects a repository styles table to a regular report.

Operations for working with named ranges:

	Operation	Brief description
	AddTabNamedRegion	The AddTabNamedRegion operation creates a named range on a regular report sheet.
	ChangeTabNamedRegion	The ChangeTabNamedRegion operation changes a table named range.
	DeleteTabNamedRegion	The DeleteTabNamedRegion operation deletes named range from a regular report sheet.
	GetPrxAllNamedRegions	The GetPrxAllNamedRegions operation gets the collection of named ranges created on regular report sheets.

Operation for working with user buttons:

	Operation	Brief description
	PrxMetaUserButtonsUpdate	The PrxMetaUserButtonsUpdate operation updates the collection of user buttons in a regular report.

Operations for working with formula descriptions:

	Operation	Brief description
	GetEaxFormulaDescriptions	The GetEaxFormulaDescriptions operation gets information about the formulas that are used to calculate table cell value.
	GetEaxFormulaDescriptionUsedAttrs	The GetEaxFormulaDescriptionUsedAttrs operation gets settings of displaying detailed information about formula terms.
	GetEaxTermDescriptions	The GetEaxTermDescriptions operation gets information about terms used in a formula for calculation of table cell value.
	SetEaxFormulaDescriptionUsedAttrs	The SetEaxFormulaDescriptionUsedAttrs operation changes settings of displaying of detailed information about formula terms.
	SetEaxUsedAttributesIdMap	The SetEaxUsedAttributesIdMap operation loads previously saved settings of displaying dimension elements in formula description.

Operations for working with shapes:

	Operation	Brief description
	GetPrxShape	The GetPrxShape operation gets metadata of the shape located on a regular report sheet.
	InsertPrxShape	The InsertPrxShape operation inserts a shape to a regular report sheet.
	SetPrxShape	The SetPrxShape operation changes settings of the shape located on a regular report sheet.

Operations for data import to regular report:

	Operation	Brief description
	ImportXlsx	The ImportXlsx operation imports data to regular report from Microsoft Excel (*.xlsx) file.