• Article

Adding a Document Map

You can use a document map in a report to provide users with a way to navigate to certain areas of the report. When you view a report that includes a document map, a separate side pane appears next to the report. Report sections and groups are arranged in a hierarchy of links. Clicking items in the document map refreshes the report and displays the area of the report that corresponds to the item in the document map.

The document map is intended for use in the HTML rendering extension. Other rendering extensions have different ways of articulating a document map:

  • PDF renders a document map as the Bookmarks pane.

  • Excel renders a document map as a named worksheet that includes a hierarchy of links. Report sections are rendered in separate worksheets that are included with the document map in the same workbook.

  • Word includes a document map as the table of contents.

  • TIFF, XML ,and CSV ignore document maps.

For more information, see Comparing Interactive Functionality for Different Report Rendering Extensions.

To create a document map, add document map labels to those report items that should appear in the map, such as report items and groups. If any report items have a value set for the document map label, a document map is automatically generated when a user views the report.

To toggle the document map on and off, use the Document Map button on the report viewer toolbar. For reports rendered in HTML, you can specify whether to show the document map or not when the report is opened via a URL. The following example initially hides the document map for the report DocumentMapReport:

https://localhost/ReportServer/Pages/ReportViewer.aspx?%2fDocumentMapReport&rs:Command=Render&rc:DocMap=False

For more information, see URL Access.

An example of a document map is provided in the Product Catalog sample report. To see how each rendering extension displays the document map, you can open the report and then export it to PDF and Excel. For more information, see Reporting Services Samples.

To view instructions about creating document maps, see How to: Add Items to a Document Map (Reporting Services).