Metric |
The DTO object for a MetricSet.
Inheritance HierarchySystemObject
Dundas.BI.WebApi.ModelsBaseDataContract
Dundas.BI.WebApi.ModelsFileData
Dundas.BI.WebApi.ModelsEntityBaseData
Dundas.BI.WebApi.ModelsMetricSetData
Dundas.BI.WebApi.ModelsBaseDataContract
Dundas.BI.WebApi.ModelsFileData
Dundas.BI.WebApi.ModelsEntityBaseData
Dundas.BI.WebApi.ModelsMetricSetData
Namespace: Dundas.BI.WebApi.Models
Assembly: Dundas.BI.WebApiCore (in Dundas.BI.WebApiCore.dll) Version: 2.0.0.0 (26.2.0.1000)
SyntaxThe MetricSetData type exposes the following members.
Constructors| Name | Description | |
|---|---|---|
 | MetricSetData | Initializes a new instance of the MetricSetData class. |
Properties| Name | Description | |
|---|---|---|
 | Alignment | Gets or sets the script alignment behavior. |
| AnalysisStructureId | Gets the ID of the analysis structure on which the current instance is based. |
| CheckedOutTo |
Gets information about the account to which the object is checked out.
(Inherited from FileData) |
| ChildCount | Gets the number of direct children contained in the entry. (Inherited from FileData) |
| ColumnHierarchies | Gets the column hierarchies usage information. |
| CreatedBy |
Gets the account information for the user which created the entry.
(Inherited from FileData) |
| CreatedTime |
Gets the time, in coordinated universal time (UTC), at which the entry was created.
(Inherited from FileData) |
| CurrentRevision | Gets the highest revision number associated with this file. (Inherited from FileData) |
| DataRetrievalFormat | Gets or sets the data retrieval format. |
| DependencyMetricSets | Gets the Dependency Metric Sets. |
| Description |
Gets an optional description associated with the entry.
(Inherited from FileData) |
| DrillDownParameter | Gets the member drill down information. |
| EffectiveCallerPrivileges |
Gets the effective caller privileges so the UI can do checks based on this.
(Inherited from FileData) |
| Elements | Gets all the elements usage information. |
| EnforceHierarchyCubeCheck | Gets or sets a value indicating whether the parent cubes of the hierarchies are also checked when determining hierarchy compatibilities. |
| Files |
Gets the files contained in the entry.
(Inherited from FileData) |
| Folders | Gets the folders contained in the entry. (Inherited from FileData) |
| FriendlyFullName |
Gets the full path of the entry (friendly).
(Inherited from FileData) |
| FriendlyLocation |
Gets the location of the entry (friendly representation).
(Inherited from FileData) |
| FriendlyLocationElements |
Gets a read-only list of distinct path elements which compose FriendlyLocation.
(Inherited from FileData) |
| FriendlyName | Gets the name of the entry (friendly representation). (Inherited from FileData) |
| FullName |
Gets the full path of the entry.
(Inherited from FileData) |
| HierarchyMemberGroups | Gets the custom hierarchy member groups. |
| Id |
Gets the unique identifier of the entry.
(Inherited from FileData) |
| InheritedTags |
Gets the inherited tags, if there are any.
(Inherited from FileData) |
| IsCheckedOut | Gets a value indicating whether the file is checked out. (Inherited from FileData) |
| IsCheckedOutToCaller |
Gets a value indicating whether the file is checked out to caller.
(Inherited from FileData) |
| IsCustomLocalizationApplied | Gets or sets a value indicating whether the custom localization applied on this entity. (Inherited from EntityBaseData) |
| IsFormulaMetricSet | Gets or sets a value indicating whether this Metric Set is a Formula Metric Set or not. |
| IsInactive |
Gets a value indicating whether the file is inactive.
(Inherited from FileData) |
| IsProtected | Gets a value indicating whether the entry is protected. (Inherited from FileData) |
| IsRecycled | Gets a value indicating whether the entry is recycled. (Inherited from FileData) |
| IsRelationshipsAvailable | Gets or sets a value indicating whether this metric set supported getting the relationships for the underlying analysis structure or not. |
| IsResultTransposed | Gets or sets a value indicating whether the current instance requires the result to be transposed. |
| IsSubentry |
Gets a value indicating whether the entry is contained by a File.
(Inherited from FileData) |
| IsTemporary |
Gets a value indicating whether the entry resides under a temporary folder.
(Inherited from FileData) |
| IsTransient | Gets a value indicating whether the file is transient. (Inherited from FileData) |
| LastCheckedInTime | Gets the time when the file was last checked in. (Inherited from FileData) |
| LastModifiedTime |
Gets the time, in coordinated universal time (UTC), at which the entry was last modified.
(Inherited from FileData) |
| Location | Gets the location of the entry. (Inherited from FileData) |
| Measures | Gets the measures usage information. |
| Metadata | Gets arbitrary metadata associated with the entry. (Inherited from FileData) |
| Name |
Gets the name of the entry.
(Inherited from FileData) |
| ObjectType |
Gets the type of the entry.
(Inherited from FileData) |
| OtherGroupSettings | Gets the "Other" group settings for the current instance, if available. |
| Overwrite |
Gets or sets a value indicating whether the file should be overwritten if the file was already created.
(Inherited from FileData) |
| Parameters | Gets all the parameters exposed by the metric set. |
| ParentId |
Gets the ID of the item's parent.
(Inherited from FileData) |
| PreventDataExport | Gets or sets a value indicating whether the metric set's data can be exported to Excel or CSV. |
| PrimaryEntryId | Gets the ID of the primary object which contains the entry. (Inherited from FileData) |
| PrivilegeInheritanceBehavior |
Gets the privilege inheritance behavior.
(Inherited from FileData) |
| Privileges |
Gets the entry's privilege assignments.
(Inherited from FileData) |
| ProjectId |
Gets the ID of the project containing the entry.
(Inherited from FileData) |
| QueryHintValues | Gets the query hint values for the current instance. |
| Revision | Gets the revision of this instance. (Inherited from EntityBaseData) |
| RowHierarchies | Gets the row hierarchies usage information. |
| ShownTotals | Gets or sets the value indicating what totals are requested. |
| SlicerHierarchies | Gets the slicer hierarchies usage information. |
| StateGroups | Gets the state groups. |
| Subtype | Gets or sets the type-specific sub-type of the entry. (Inherited from FileData) |
| Tags |
Gets a collection of explicit tags associated with the entry.
(Inherited from FileData) |
| TenantId |
Gets the ID of the tenant associated with the entry.
(Inherited from FileData) |
| TopBottomSettings | Gets the top / bottom settings for the current instance, if available. |
| UIClassName |
Gets or sets the name of the UI class (used for auto de-serialization).
(Inherited from BaseDataContract) |
| UndoContext |
If available, the current undo context for the entity.
(Inherited from EntityBaseData) |
| Visualization | Gets or sets the visualization. This is stored as a string (JSON for JavaScript) for efficiency purposes. |
| Warnings |
Gets the warnings for the current instance, as well as for any dependency objects.
(Inherited from FileData) |
Methods| Name | Description | |
|---|---|---|
 | FromDataContractMappings | The mapping between MetricSetData and MetricSet. |
| ToDataContractMappings | The mapping between MetricSet and MetricSetData. |
Extension Methods| Name | Description | |
|---|---|---|
 | SetUIClassName |
Sets the name of the file data UI class.
(Defined by ModelDataExtensions) |
See Also