Providing Flash-based analysis and interactivity: Widgets

A widget is a type of Report Services control 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 to manually 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.

A document designer defines widgets in Editable Mode. However, the designer and other users can interact with widgets in Flash Mode only.

Understanding and working with widgets

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

Note: 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. You can also download widgets from the MicroStrategy Widget download site at https://resource.microstrategy.com/Support.

To create a widget that is displayed correctly in Flash Mode, you must place and position the correct number of report objects on the widget's template. For important information on the widget template requirements for each type of widget, see Data requirements for widgets: Quick reference table. 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 very similar to a standard Grid/Graph control. In fact, in the object selector in the Formatting toolbar , the widget template is considered a type of Grid/Graph control 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.

To define the widget, report objects such as attributes and metrics must be placed on the widget template. To successfully define a Cylinder widget, one attribute must be placed on the widget template'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.

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).

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 Flash Mode. In Flash Mode, 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 Flash Mode.

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.

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 information about the data and template requirements for each type of widget, see Data requirements for widgets: Quick Reference Table.

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