AnalysisElementUsageData Class

The DTO class for AnalysisElementUsage.

The DTO class for HierarchyUsage.

The DTO class for MeasureUsage.

Inheritance Hierarchy

SystemObject
Dundas.BI.WebApi.ModelsBaseDataContract
Dundas.BI.WebApi.ModelsAnalysisElementUsageData

Namespace: Dundas.BI.WebApi.Models
Assembly: Dundas.BI.WebApiCore (in Dundas.BI.WebApiCore.dll) Version: 2.0.0.0 (24.2.0.1000)

Syntax

C++

Copy

[DataContractAttribute]
public class AnalysisElementUsageData : BaseDataContract

<DataContractAttribute>
Public Class AnalysisElementUsageData
	Inherits BaseDataContract

[DataContractAttribute]
public ref class AnalysisElementUsageData : public BaseDataContract

[<DataContractAttribute>]
type AnalysisElementUsageData =  
    class
        inherit BaseDataContract
    end

The AnalysisElementUsageData type exposes the following members.

Constructors

	Name	Description
	AnalysisElementUsageData	Initializes a new instance of the AnalysisElementUsageData class.

Top

Properties

	Name	Description
	Aggregator	Gets or sets the measure aggregator.
	AnalysisElement	Gets the parent IAnalysisElement.
	Caption	Gets or sets the usage element caption.
	ColumnTotalsCalculationRule	Gets the custom calculation rules that replace the standard aggregator when used for column totals.
	DerivedParameters	Gets the derived parameters, when the underlying measure is a DerivedMeasure.
	Expression	Gets the script expression, if the usage element is based on a CalculatedMeasure.
	FormatInfo	Gets the numeric format for the current instance.
	IsDataCorrectionAllowed	Gets or sets a value indicating whether this instance allows user data correction.
	IsDisabledForExpandedMembers	Gets or sets a flag that disables the computations for expanded hierarchy members.
	IsExcludedFromDataExport	Gets or sets a value indicating whether this element is exported in non-image exports.
	IsHidden	Gets or sets a value indicating whether this instance is hidden. If hidden, the data is still retrieved and used in any computations, but it is not present in the result cellset.
	IsHierarchy	Gets a value indicating whether this instance is a hierarchy.
	IsMeasure	Gets a value indicating whether this instance is a measure.
	IsNotVisualized	Gets or sets a value indicating whether this instance is not visualized by default in new visualizations.
	IsSorted	Gets a value indicating whether this instance is sorted.
	IsTimeHierarchy	Gets a value indicating whether this instance is a time hierarchy.
	IsUnknownMemberCaptionBlank	Gets or sets a value indicating whether the unknown member caption is blank or not.
	LevelParameter	Gets the associated hierarchy level parameter for a column or row hierarchy.
	MeasureKind	Gets the underlying measure kind.
	MissingDataRule	Gets the missing data rule.
	Parameter	Gets the associated data parameter.
	ParentEntityId	Gets or sets the parent entity ID.
	Placement	Gets the element placement.
	RetrieveAllMemberOnly	Gets or sets a value indicating whether all of this hierarchy's values should be collapsed into a single All Member when displayed.
	RetrieveUnknownMembers	Gets or sets a value indicating whether unknown members should be retrieved or not.
	ReturnAllParallelPeriodComparisonData	Gets or sets a value indicating whether all comparison data should be returned. By default this is , which means that parallel period values for which there are no current coordinates are not returned.
	RowTotalsCalculationRule	Gets the custom calculation rule that replace the standard aggregator when used for row totals.
	ShownTotals	Gets or sets how the totals are displayed for the current instance.
	SortPolicy	Gets the sorting behavior for the hierarchy.
	SourceElement	Gets or sets the element that is the source of the analysis element.
	TargetHierarchyParameter	Gets the associated dynamic hierarchy parameter, when the underlying hierarchy is a dynamic hierarchy.
	TargetMeasureParameter	Gets the associated dynamic measure parameter, when the underlying measure is dynamic.
	UIClassName	Gets or sets the name of the UI class (used for auto de-serialization). (Inherited from BaseDataContract.)
	UniqueName	Gets the unique name of the underlying analysis element.
	UnknownMemberCaption	Gets or sets the override for the unknown member caption.

Top

Methods

	Name	Description
	FromDataContractMappings	The mapping between AnalysisElementUsageData and AnalysisElementUsage.
	ToDataContractMappings	The mapping between AnalysisElementUsage and AnalysisElementUsageData.

Top

Extension Methods

	Name	Description
	SetUIClassName	Sets the name of the analysis element usage UI class. (Defined by ModelDataExtensions.)

Top

Reference

Dundas.BI.WebApi.Models Namespace