Scorecard Formatting in PerformancePoint Services
In PerformancePoint Services in Microsoft SharePoint Server 2010, a common scenario for using scorecard transforms is to modify the format settings of a scorecard view based on a set of conditions. This topic describes the objects that define format settings, the inheritance hierarchy for format settings, and the rendering process for scorecard formatting.
Applies to: SharePoint Server 2010
Objects that Define Scorecard Formatting
Several objects in the PerformancePoint Services object model are used to define formatting for a scorecard view. Format settings follow an inheritance hierarchy with default settings defined at the scorecard level. Default settings are overridden by header (row then column) settings, which in turn are overridden by cell-level settings.
The following objects contain formatting properties that you can access programmatically:
GridViewData Represents a scorecard view.
GridHeaderItem Represents row and column header cells.
GridCell Represents data cells at the intersections of row and column headers.
The following table describes the formatting properties for a scorecard view, ordered from global (default) settings to cell-level settings.
Table 1. Formatting properties for a scorecard view
Formatting property |
Description |
|---|---|
The default format settings for scorecard cells. |
|
The default format settings for column header cells. |
|
The default format settings for row header cells. |
|
The format settings to use to render column or row header cells. These settings are the result of evaluating the settings defined by GridHeaderItem.HeaderFormatInfo, GridViewData.DefaultColumnHeaderFormatInfo or GridViewData.DefaultRowHeaderFormatInfo and GridViewData.DefaultCellFormatInfo. Note This property is created after GridViewData is generated. Therefore, it cannot be changed by using a transform. |
|
The format settings for headers that are defined at design time by dashboard authors. |
|
The format settings for the data cells that belong to a column or row. |
|
The format settings for cells that are defined at design time by dashboard authors. |
|
The format settings to use to render data cells. These settings are the result of evaluating the settings defined by GridCell.FormatInfo, GridHeaderItem.CellFormatInfo for the column header, GridHeaderItem.CellFormatInfo for the row header, and GridViewData.DefaultCellFormatInfo. Note This property is created after GridViewData is generated. Therefore, it cannot be changed by using a transform. |
The formatting properties described in the previous table return GridFormatInfo objects, which specify settings for the distinct formatting properties such as background color and font style.
GridFormatInfo Objects
The properties of a GridFormatInfo object represent the format settings that are available to a scorecard view. The following table describes these properties.
Table 2. GridFormatInfo properties
Property |
Description |
|---|---|
The background color of the cell, represented by a GridColor object. |
|
The font family, style, and size for the cell contents, represented by a GridFontInfo object. |
|
The font color of the cell contents, represented by a GridColor object. |
|
The horizontal alignment of the cell contents, represented by a GridFormatInfo.HorizontalAlignments object. |
|
Indicates whether the cell contents can wrap, represented by a Trinary object. |
|
The vertical alignment of the cell contents, represented by a GridFormatInfo.VerticalAlignments object. |
Rendering Process for Cell Formatting
During the rendering process for a scorecard view, PerformancePoint Services follows a reverse-inheritance order to find format settings for each scorecard cell. Settings at the cell level override settings at the column header level, settings at the column header level override settings at the row header level, and settings at the row header level override settings at the scorecard level.
Note
The process for rendering header formatting is similar to rendering cell formatting, but it does not include cell-level checks and starts by evaluating the GridHeaderItem.HeaderFormatInfo property.
The following procedure describes the process for determining the format settings for a rendered cell:
The cell is checked for explicit values for format settings, which are specified in the GridCell.FormatInfo property.
If the cell defines any format settings—that is, if any settings are undefined—then the values for those formatting properties are used to render the cell. For example, if the cell defines Bold as the font style, then the cell text is rendered in a bold format. This value overrides any font style settings that are defined at the header or scorecard level.
The column header is checked for explicit values for any format settings that are undefined for the cell. Column header settings are specified by the GridHeaderItem.CellFormatInfo property for the column header.
If the column header explicitly defines any settings that are undefined for the cell, then those settings are used.
The row header is checked for explicit values for any format settings that are undefined for the cell and column header. Row header settings are specified by the GridHeaderItem.CellFormatInfo property for the row header.
If the row header explicitly defines any settings that are undefined for the cell or column header, then those settings are used.
The scorecard is checked for explicit values for any format settings that are undefined for the cell, column header, and row header. Scorecard-level settings are specified by the GridViewData.DefaultCellFormatInfo property.
Scorecard-level settings are used for any format settings that are undefined for the cell, column header, and row header.
See Also
Tasks
How to: Create Scorecard Transforms for PerformancePoint Services