2.2.4.116 GridHeaderItem

  • Article

Namespace: http://www.microsoft.com/performancepoint/scorecards

The GridHeaderItem complex type specifies the header that represents a row or a column node in a scorecard.

 <xs:complexType name="GridHeaderItem" xmlns:xs="http://www.w3.org/2001/XMLSchema">
   <xs:sequence>
     <xs:element minOccurs="0" maxOccurs="1" name="HeaderFormatInfo" type="tns:GridFormatInfo"/>
     <xs:element minOccurs="0" maxOccurs="1" name="CellFormatInfo" type="tns:GridFormatInfo"/>
     <xs:element minOccurs="0" maxOccurs="1" name="Children" type="tns:ArrayOfGridHeaderItem"/>
     <xs:element minOccurs="0" maxOccurs="1" name="SerializeTag"/>
     <xs:element minOccurs="0" maxOccurs="1" name="DimensionMember" type="tns:Member"/>
     <xs:element minOccurs="0" maxOccurs="1" name="OverrideIndicatorLocation" type="tns:RepositoryLocation"/>
     <xs:element minOccurs="0" maxOccurs="1" name="Banding" type="tns:Banding"/>
     <xs:element minOccurs="0" maxOccurs="1" name="LinkedKpiLocation" type="tns:RepositoryLocation"/>
     <xs:element minOccurs="0" maxOccurs="1" name="BpmProperties" type="tns:ArrayOfBpmProperty"/>
     <xs:element minOccurs="0" maxOccurs="1" name="TargetSettings" type="tns:GridTargetSettings"/>
     <xs:element minOccurs="0" maxOccurs="1" name="TrendIndicatorLocation" type="tns:RepositoryLocation"/>
   </xs:sequence>
   <xs:attribute name="Id" type="xs:int" use="required"/>
   <xs:attribute name="Guid" xmlns:s1="http://microsoft.com/wsdl/types/" type="s1:guid" use="required"/>
   <xs:attribute name="DefinitionGuid" xmlns:s1="http://microsoft.com/wsdl/types/" type="s1:guid" use="required"/>
   <xs:attribute name="DisplayText" type="xs:string"/>
   <xs:attribute name="DimensionName" type="xs:string"/>
   <xs:attribute name="DimensionValue" type="xs:string"/>
   <xs:attribute name="HeaderType" type="tns:ScorecardNodeTypes" use="required"/>
   <xs:attribute name="GroupId" type="xs:int" use="required"/>
   <xs:attribute name="Depth" type="xs:int" use="required"/>
   <xs:attribute name="DescendantSpan" type="xs:int" use="required"/>
   <xs:attribute name="LeafSpan" type="xs:int" use="required"/>
   <xs:attribute name="IsCollapsed" type="xs:boolean" use="required"/>
   <xs:attribute name="IsDynamicCellExpansionEnabled" type="xs:boolean" use="required"/>
   <xs:attribute name="IsDrillEnabled" type="xs:boolean" use="required"/>
   <xs:attribute name="IsDrillDownDisabled" type="xs:boolean" use="required"/>
   <xs:attribute name="IsDrillUpDisabled" type="xs:boolean" use="required"/>
   <xs:attribute name="IsDynamicallyExpandedHeader" type="xs:boolean" use="required"/>
   <xs:attribute name="IsCellHidden" type="xs:boolean" use="required"/>
   <xs:attribute name="IsPathHidden" type="xs:boolean" use="required"/>
   <xs:attribute name="IsHiddenBasedOnFilterStatus" type="xs:boolean" use="required"/>
   <xs:attribute name="NamedSetExpression" type="xs:string"/>
   <xs:attribute name="CustomSetFormula" type="xs:string"/>
   <xs:attribute name="IsNamedSetInError" type="xs:boolean" use="required"/>
   <xs:attribute name="IsNamedSetEmpty" type="xs:boolean" use="required"/>
   <xs:attribute name="NamedSetType" type="tns:ScorecardNamedSetType" use="required"/>
   <xs:attribute name="UseLinkedElementDisplayText" type="xs:boolean" use="required"/>
   <xs:attribute name="Hyperlink" type="xs:string"/>
   <xs:attribute name="ShowHyperlinkInNewWindow" type="xs:boolean" use="required"/>
   <xs:attribute name="IsHierarchyHeader" type="xs:boolean" use="required"/>
   <xs:attribute name="IsColumnHeader" type="xs:boolean" use="required"/>
   <xs:attribute name="AppendFilterInfoToHyperlink" type="xs:boolean" use="required"/>
   <xs:attribute name="Weight" type="xs:decimal" use="required"/>
   <xs:attribute name="KpiTargetName" type="xs:string"/>
   <xs:attribute name="AggregationType" type="tns:HeaderAggregationTypes" use="required"/>
 </xs:complexType>

HeaderFormatInfo: This property, as defined in the GridFormatInfo complex type (section 2.2.4.115), overrides the format information set for GridHeaderItem, under either the GridViewDefinition (section 2.2.4.122) or GridViewData (section 2.2.4.121) complex types, for GridHeaderItem.

CellFormatInfo: This property, as defined in GridFormatInfo, overrides the format information set under GridHeaderItem.HeaderFormatInfo for GridHeaderItem.

Children: Specifies an array of GridHeaderItem, as defined in the ArrayOfGridHeaderItem complex type (section 2.2.4.37).

SerializeTag: A general purpose tag for GridHeaderItem defined as a generic object.

DimensionMember: Dimension member (section 2.2.4.90) associated with this header, as defined in the Member complex type (section 2.2.4.134).

OverrideIndicatorLocation: The location of the override Indicator complex type (section 2.2.4.125) for rollups as defined in the RepositoryLocation complex type (section 2.2.4.161). If null, the default rollup indicator location, as mentioned under GridViewDefinition or GridViewData will be used.

Banding: Banding settings, as defined in the Banding complex type (section 2.2.4.60). When null, the Banding.Type is Normalized.

LinkedKpiLocation: Location of the linked Kpi complex type (section 2.2.4.128), as defined in RepositoryLocation.

BpmProperties: Collection of element properties, as defined in the ArrayOfBpmProperty complex type (section 2.2.4.23).

TargetSettings: Target column settings, as defined in GridTargetSettings complex type (section 2.2.4.119).

TrendIndicatorLocation: If the header type is aggregate and TrendIndicatorLocation points to a valid location as defined in RepositoryLocation, this header item represents a trend column. The TrendIndicatorLocation MUST point to the location of the indicator used to show the trend.

Id: Unique integer identifier for this header.

Guid: Global unique identifier for GridHeaderItem.

DefinitionGuid: Global unique identifier that links a data header back to the definition header.

DisplayText: Display text for GridHeaderItem.

DimensionName: Dimension name is set based on the header type. The following table specifies the allowable dimension names for different scorecard header types.

Header type

Dimension name

Member

Member Dimension name.

Kpi

Scorecard__

KpiActual

Scorecard_Measures__

KpiTarget

Scorecard_Measures__

Aggregate

Scorecard_Aggregates__

ScorecardDetails

Scorecard_Details__

DocumentLinks

Scorecard_DocumentLinks__

NamedSet

null

None

null

DimensionValue: Dimension value is set based on the header type. The following table specifies the allowable dimension values for different scorecard header types.

Header type

Dimension value

Member

Member unique name.

Kpi

RepositoryLocation of the Kpi.

KpiActual

This value equals the BpmPropertyText.Text value.

KpiTarget

This value equals the BpmPropertyText.Text value.

Aggregate

AggregateType as specified by the AggregateTypeEnum simple type (section 2.2.5.1).

ScorecardDetails

Only the values "Description", "Name", or "Person Responsible" are supported.

DocumentLinks

GUID.

NamedSet

null

None

null

HeaderType: The type of GridHeaderItem as defined in the ScorecardNodeTypes simple type (section 2.2.5.44).

GroupId: An integer identifier to identify all members (2) in a set. The GroupId is positive if the header type is Member or NamedSet and has a negative value when no hierarchy (for example, a flat list (1) of members). Root headers are an exception to this rule because their GroupId value is zero.

Depth: Depth of the GridHeaderItem in the tree. It starts with value zero for the root level node and keeps incrementing moving towards the leaves.

DescendantSpan: Maximum number of header levels for all descendant leaves.

LeafSpan: Number of leaves under GridHeaderItem.

IsCollapsed: This attribute MUST be TRUE if the header node is collapsed; otherwise, this attribute is FALSE.

IsDynamicCellExpansionEnabled: This attribute MUST be TRUE if the dynamic expansion (named set expansion) setting is enabled for this header node; otherwise, this attribute is FALSE. This setting is valid only for Dimension members.

IsDrillEnabled: This attribute MUST be TRUE if the drill operations are enabled for GridHeaderItem; otherwise, this attribute is FALSE. This setting is valid only for Dimension members.

IsDrillDownDisabled: This attribute MUST be TRUE if the drilldown operation is disabled for GridHeaderItem; otherwise, this attribute is FALSE. This gets set if it is the leaf node in the Hierarchy complex type (section 2.2.4.124).

IsDrillUpDisabled: This attribute MUST be TRUE if the drill up operation is disabled for this header; otherwise, the attribute is FALSE. This attribute gets set if it is the top most node in the Hierarchy.

IsDynamicallyExpandedHeader: This attribute MUST be TRUE if GridHeaderItem was created through dynamic expansion (named set expansion); otherwise, this attribute is FALSE. The header item can be dynamically expanded only if the IsDynamicCellExpansionEnabled attribute and the corresponding ConfiguredView (section 2.2.4.77) setting (AllowDynamicRowMemberExpansion for rows and AllowDynamicColumnMemberExpansion for columns) are set to TRUE.

IsCellHidden: This attribute MUST be TRUE if the header cell is hidden; otherwise, this attribute is FALSE.

IsPathHidden: This attribute MUST be TRUE if the header path is hidden; otherwise, this attribute is FALSE.

IsHiddenBasedOnFilterStatus: This attribute MUST be TRUE if this GridHeaderItem is hidden by Filter (section 2.2.4.98) status; otherwise, this attribute is FALSE.

NamedSetExpression: When the NamedSetType is NamedSet, this MUST conform to a valid MDX set expression. When the type is CustomFormula, the CustomSetFormula and NamedSetExpression properties are equal. For the TimeFormula type, this MUST be an empty string.

CustomSetFormula: When the NamedSetType is TimeFormula, this MUST be a valid time intelligence formula. When the type is CustomFormula, the NamedSetExpression properties are equal.

IsNamedSetInError: This attribute MUST be TRUE if the named set expression is in an error state; otherwise, this attribute is FALSE.

IsNamedSetEmpty: This attribute MUST be TRUE if the named set expression returned an empty set; otherwise, this attribute is FALSE.

NamedSetType: It identifies whether it is a named set header, custom formula, time formula, or none, as defined in the ScorecardNamedSetType simple type (section 2.2.5.43).

UseLinkedElementDisplayText: This attribute MUST be TRUE if the linked Kpi name is used as the display text for GridHeaderItem; otherwise, this attribute is FALSE.

Hyperlink: Obsolete.

ShowHyperlinkInNewWindow: Obsolete.

IsHierarchyHeader: This attribute MUST be TRUE if the header is part of a Hierarchy collection, or FALSE if the header is part of a linear list (1).

IsColumnHeader: This attribute MUST be TRUE if this is a column header, or FALSE if this is a row header.

AppendFilterInfoToHyperlink: This attribute MUST be TRUE if the filter information MUST be appended to the hyperlink; otherwise, this attribute is FALSE.

Weight: Display value weight that gets used for Kpi headers.

KpiTargetName: Kpi actual or Target (section 2.2.4.170) display name for GridHeaderItem.

AggregationType: Specifies the aggregation types, as defined in the HeaderAggregationTypes simple type (section 2.2.5.26).