WebReportGrid

Class Overview

A report grid encapsulates titles, headers, and metric values. Each of the three axis positions (row, column, page-by) may comprise of zero or more titles, and each title may consist of zero or more headers. A metric value is found at intersection of a row, column, and page-by header.

Examples of titles include Year, Region, and Metric. Each axis may contain zero or more titles, and each title correponds to a set of headers, e.g. 2000, 2001, 2002.

WebGridHeaders is a collection of WebHeaders objects, and each WebHeaders is a collection of WebHeader objects. Each WebHeaders object from getPageHeaders (non page-tree style) corresponds to a page WebTitle. Similarly, each WebHeaders object from getColumnHeaders also corresponds to a column WebTitle. In both these cases, all the WebHeader objects in a single WebHeaders collection are associated with a single title. However, this API is optimized for laying the grid in tabular form, i.e. row by row, therefore each WebHeader in a single WebHeaders collection from getRowHeaders may correspond to a different a WebTitle (depending upon its subtitles). This correspondence remains consistent for each row WebHeaders collection.

There are also two representations of page-by headers. The one one explained in the previous paragraph assumes a normal non page-tree style, where each title is associated with a complete listing of all its available headers. In practice, many of page-header combinations between different page titles don't make sense, and therefore omitted. This means that the header selected for the a given title will determine what headers should be visible for subsequent page titles - this is is represented in a page-tree style whereby WebHeaders are encapsulated in a parent-child relationship (see getChildren()).

The drill map describes the granularity levels and views visible within a given report data set - specifically, each drill map encapsulates a set of possible drill paths (e.g. drill to child, drill to parent, drill to sibling).

Summary

[Expand] Inherited Methods
From interface com.microstrategy.web.objects.WebCssFormatContainer abstract String getCssClass() abstract WebFormat getCssFormat() Returns the format associated with this report element. abstract WebPropertyGroup getFormatPropertySets() Returns the formatting property group associated with this report element.