Providing Flash-based analysis and interactivity: Widgets

A widget is a type of control, used on a Report Services document, that presents data in a visual and interactive way. You can think of widgets as interactive Flash-only graphs that dynamically update when an analyst selects a new set of data to view. Analysts can even interact with some types of widgets by clicking on the widget to select a set of data to analyze. You can use a variety of widget types, such as Gauge, Heat Map, and Interactive Stacked Area widget. Although each type of widget looks different and is used in a unique way, the main purpose of widgets is the same: to provide document analysts with a visual and interactive look into their data.

You can also display a report as a widget when it is viewed on an iPhone or iPad with MicroStrategy Mobile. For more information on iPhone and iPad widgets, see About iPad and iPhone widgets.

Understanding and working with widgets

The following list briefly summarizes each type of widget that you can use in a document.

In addition, the following widgets are available. Information to customize and use them is in the MSDL. With the MicroStrategy SDK, you can access additional MicroStrategy widgets, add third-party widgets, and create and use custom widgets. For more information and instructions, see the MicroStrategy Developer Library (MSDL), part of the MicroStrategy SDK product. For information on purchasing a MicroStrategy SDK license, contact your Account Executive.

To create a widget that is correctly displayed in MicroStrategy Web, you must place and position the correct number of report objects on the Grid/Graph. For steps to add a widget to a document, see Inserting a widget into a document.

Example: Adding and defining a widget

When you add a Cylinder widget to a document in Editable Mode, it looks similar to a standard Grid/Graph. In the object selector of the Formatting toolbar Widget template toolbar, the widget is considered a type of Grid/Graph when it is selected.

In the image below, the new Cylinder widget is shown on the right. The Dataset Objects panel is displayed on the left to give you an idea of the report and report objects with which the designer is working.

Example of adding and defining a widget

To define the widget, report objects such as attributes and metrics must be placed on the Grid/Graph. To successfully define a Cylinder widget, one attribute must be placed on the Grid/Graph's rows and one metric must be placed on the columns, as shown below. The Supplier attribute is placed on the rows and the Units Sold metric is placed on the columns.

Example of adding and defining a widget

A selector alongside the widget is very useful. In this case, the selector will be used by a document analyst to switch between different suppliers (the attribute elements of the Supplier attribute).

Example of widget with selector

The selector is designed as follows:

For more information about creating selectors (and connecting them to Grid/Graphs or panel stacks), see Inserting a selector into a document.

The Cylinder widget only becomes a visual and interactive analysis tool when it is viewed in MicroStrategy Web. In MicroStrategy Web, the Cylinder widget presents a vertical cylinder with liquid in it; the level of the liquid within the cylinder depicts a specific metric value. In this case, the metric value is the number of units sold. Notice also that the look and feel of the selector changes in MicroStrategy Web.

To display the number labels on the right of the cylinder, right-click the cylinder and select Properties. By default, the minimum and maximum values for a Cylinder widget are 0 to 100. Since the metric values are much larger on this report, you should change the maximum value to something like 700, to accommodate the largest metric values on the report.

Example of adding and defining a widget

Another convenient addition to the widget/selector combination shown above is a grid version of the report. For this example, you might add the grid report shown in the Dataset Objects panel above. The grid report allows you and document analysts to see how one attribute element's value compares against other values. You can also sort the grid report and pivot objects on it. In this example, the full grid report allows you to see how one supplier's revenue compares with other suppliers. To add a grid report next to the widget, simply drag the report from the Dataset Objects panel and drop it next to the widget.

For procedural information, see Inserting a widget into a document.

Widgets and automatic target maintenance for selectors

Selectors allow a user to display different metrics or different elements of attributes, custom groups, or consolidations in a Grid/Graph (the target of the selector). Targets can be automatically maintained in a layout. This means that when you add a Grid/Graph or widget, the Grid/Graph or widget is the target of all selectors in the same panel or document section as the Grid/Graph or widget. For more information about automatically maintaining targets for selectors, including instructions to enable and disable the functionality, see Automatically maintaining targets for selectors.