Architecture of the Scorecard Run-Time Object in PerformancePoint Services
In PerformancePoint Services in Microsoft SharePoint Server 2010, a scorecard view incorporates many objects from the object model. This topic describes the architecture and components of the run-time object that is used to render a scorecard view on a dashboard page.
Applies to: SharePoint Server 2010
GridViewData Object
A GridViewData object is the primary component of the scorecard run-time object. It is produced at run time by evaluating a GridViewDefinition object, and it defines the dataset and structure of the scorecard view.
Note
GridViewDefinition is stored in the PerformancePoint Services repository as part of the scorecard definition. It is a design-time object that defines the structure and formatting of a scorecard, but it does not contain information about cell data.
GridViewData defines the basic structural elements of a scorecard view: two hierarchy trees that represent the column and row headers, and a two-dimensional array that represents the cells at the intersection points of the headers. Row headers render on the left side of the scorecard view, and column headers render across the top. This grid structure is shown in the following diagram.
Figure 1. GridViewData structure
.gif "GridViewData structure")
Note
GridViewData is returned by the GenerateView method, and it is used to generate the HTML for a scorecard view. Custom applications can consume GridViewData to obtain information about a scorecard, and custom scorecard transforms can programmatically manipulate its properties. For more information about scorecard transforms, see Overview of PerformancePoint Services Scorecard Transforms.
GridViewData properties store configuration information that is defined in PerformancePoint Dashboard Designer by the scorecard's author. GridViewData is a complex object, and many of its properties return other PerformancePoint Services objects, as shown in the following diagram.
Figure 2. GridViewData properties that return PerformancePoint Services objects
.gif "Components of a GridViewData object")
The following sections describe the component objects of a GridViewData object and the properties that return them.
GridHeaderItem Objects
Represent the scorecard’s row and column header cells, which display the name of a KPI, metric, or dimension member. Each row header aligns to a row, but only column headers at the leaf level align to a column. Leaf-level column headers typically contain metrics such as Actual and Target. Column headers above the leaf level are aggregates for the headers that represent their child elements. For example, in Figure 1, CY2009 represents the aggregate of the Actual and Target metrics below it. GridHeaderItem objects define the header hierarchy and some properties of the items in the cell, such as the indicator and display and format settings.
The following list contains the GridViewData properties that return GridHeaderItem objects:
RootColumnHeader The root column header cell of the scorecard view.
RootRowHeader The root row header cell of the scorecard view.
You can access root headers by using the RootColumnHeader and RootRowHeader properties, and you can access descendant headers by using the GridHeaderItem.Children property of the root headers.
Note
RootRowHeader represents the row that contains the column headers. It is discarded during rendering and only its child elements are rendered.
GridCellSet and GridCell Objects
Represent the scorecard's data cells, which are derived from the intersections of column and row headers.
The GridViewData.Cells property returns a GridCellSet object, which is a collection of GridCell objects that define properties such as the cell's value, calculations, annotation, and display and format settings.
GridFormatInfo Objects
Represent the format settings for the header and body cells in a scorecard view. Default settings for a scorecard view are defined at the GridViewData object, but they can be overridden at the header or cell level.
The following list contains the GridViewData properties that return GridFormatInfo objects:
DefaultCellFormatInfo The default format settings for scorecard data cells.
DefaultColumnHeaderFormatInfo The default format settings for column header cells.
DefaultRowHeaderFormatInfo The default format settings for row header cells.
RepositoryLocation Objects
Represent the locations of content types (which represent first class objects) in the repository. The PerformancePoint Services repository comprises SharePoint document libraries and lists.
The following list contains the GridViewData properties that return RepositoryLocation objects:
ScorecardLocation The location of the underlying scorecard object in the repository.
DefaultRollupIndicatorLocation The location of the default rollup indicator in the repository.
GridViewTransformReferenceCollection Objects
Represent the transforms that are applied to the scorecard view. GridViewTransformReferenceCollection returns a collection of GridViewTransformReference objects that represent references to the transforms. Transforms can change the appearance, contents, or functionality of scorecards.
The following list contains the GridViewData properties that return GridViewTransformReferenceCollection objects:
PreQueryTransforms A set of transform operations that are applied before retrieving data from the data source.
PostQueryTransforms A set of transform operations that are applied after retrieving data from the data source.
PreRenderTransforms A set of transform operations that are applied immediately before rendering the scorecard view.
For more information about scorecard transforms, see Overview of PerformancePoint Services Scorecard Transforms.
MemberCollection Objects
Represent page filters, which are the members that are used to slice the values in the scorecard view. The PageFilters property returns a MemberCollection object.
Note
Other GridViewData properties that filter scorecard data are TICurrentDateTime and TIFormula.