--- title: "Heatmap" slug: "heatmap" updated: 2025-02-06T20:45:24Z published: 2025-02-06T20:45:24Z --- > ## Documentation Index > Fetch the complete documentation index at: https://docs.revealdata.com/llms.txt > Use this file to discover all available pages before exploring further. # Heatmap The **Heatmap** accessed under the Dashboard displays the co-occurrence of top or selected terms of one type of data (or search list) with another type of data. By default, the top terms of one type of metadata (that is, those returning the highest counts) with the top values of a second type of metadata. With color emphasis indicating “heat” or preponderance of intersections within the grid, users can see at a glance the strength of relationships between one type of data and another. ![131 - 01 - Heatmap](https://5796933.fs1.hubspotusercontent-na1.net/hub/5796933/hubfs/DOCUMENTATION/ARTICLE%20SCREENSHOTS/131%20-%2001%20-%20Heatmap.png?width=1371&quality=high) The above Heatmap is configured with *Custodian* metadata for rows and *Extension* metadata for columns, as confirmed by the **Options** button labeled ***Custodian + Extension*** in the upper left. Gliding a pointer over any box will display its meaning, for example *1170 hits for “msg” and “kaminski, vince”*. There is also a button in the upper right to *Export to CSV*, which will export the labels and values of the Heatmap table. Cells in the grid may be selected to be added to a search. Clicking to select cells activates the **Add to Search** button. ![131 - 02 - Heatmap with selections](https://5796933.fs1.hubspotusercontent-na1.net/hub/5796933/hubfs/DOCUMENTATION/ARTICLE%20SCREENSHOTS/131%20-%2002%20-%20Heatmap%20with%20selections.png?width=643&quality=high) Selected items will be added to a search as an “***Advanced***” pill, which may be expanded to examine the search items. ![131 - 02a - Heatmap selections Advanced Search](https://5796933.fs1.hubspotusercontent-na1.net/hub/5796933/hubfs/DOCUMENTATION/ARTICLE%20SCREENSHOTS/131%20-%2002a%20-%20Heatmap%20selections%20Advanced%20Search.png?width=1200&quality=high) The **Options** button allows the Heatmap to be configured to show the relationships most useful to the user, which may not necessarily be the default *Custodian + Extension*. The modal opens to the **Rows** tab, initially set to the *Custodian* field, with settings to change the Heatmap values. ## **Rows Settings** There is no practical limit to the number of rows that can be addressed in the Heatmap. Settings for the number of rows per page will split the retrieved set across as many pages as required. The number of rows per page determines how many row values may be ***sorted***or ***exported*** at the same time, since these actions will not address all rows in the Heatmap for performance reasons. ![131 - 03g - Heapmap Template Share](https://5796933.fs1.hubspotusercontent-na1.net/hub/5796933/hubfs/DOCUMENTATION/ARTICLE%20SCREENSHOTS/131%20-%2003g%20-%20Heapmap%20Template%20Share.png?width=723&quality=high) - **Template –**Given the number of options available for Heatmap visualization, the option to save, name and recall (or delete) a set of settings allows users to efficiently map and jump between a series of grids easily. You may pick a saved Heatmap option template from the list, Save or Delete current settings, or click **+** to add save current settings. Templates may be shared with selected Users or Teams in ReadOnly (default) or Editable mode. ![131 - 03 - Heatmap options - Rows-3](https://5796933.fs1.hubspotusercontent-na1.net/hub/5796933/hubfs/DOCUMENTATION/ARTICLE%20SCREENSHOTS/131%20-%2003%20-%20Heatmap%20options%20-%20Rows-3.png?width=721&quality=high) - **Data Type** - ***Text Field***is the default, to display values from the metadata field selected below. - **Data** – For the ***Text Field*****Data Type, choose the field from the list of all those available in the currently selected Field Profile. - **Selection** – Choose what will be displayed for the row labels: - ***Custom Selection*****offers selection of specific values from the Data field, as well as *Any Value* or *No Value*. See the illustration under **Columns.** - ***Top Values***is the default, which will display the values with the highest number of records corresponding to the Columns values, up to the number set as maximum below. - **Maximum Number of Rows** – Sets the depth of values to be displayed as rows for each page of the Heatmap. This will determine how many row values may be sorted (by clicking on a column heading, once for ascending, twice for descending) or exported at once. Higher maximums may significantly slow performance. - **Show Totals, by Row** – Option to total across the row for the Columns values. - ***Search Terms*** opens a Term List dialog, where RQL or keyword search terms may be entered, one per line, - in a text list,... ![131 - 03c - Heatmap options - Rows (Search Term with Sort)-4](https://5796933.fs1.hubspotusercontent-na1.net/hub/5796933/hubfs/DOCUMENTATION/ARTICLE%20SCREENSHOTS/131%20-%2003c%20-%20Heatmap%20options%20-%20Rows%20(Search%20Term%20with%20Sort)-4.png?width=723&quality=high) - ... or added in a table. In either case, the results may be sorted by term order (the order in which the terms were listed) or by result count, using a toggle at the bottom of the screen. Search retrieval will address up to 1,000 terms (1000 rows as paginated according to the **Rows per Page** setting) as of Reveal 11.8. ![131 - 03a - Heatmap options - Rows (Search Terms)-Oct-06-2023-06-31-02-3160-PM](https://5796933.fs1.hubspotusercontent-na1.net/hub/5796933/hubfs/DOCUMENTATION/ARTICLE%20SCREENSHOTS/131%20-%2003a%20-%20Heatmap%20options%20-%20Rows%20(Search%20Terms)-Oct-06-2023-06-31-02-3160-PM.png?width=723&quality=high) - Search terms are validated as each line is entered, alerting you of issues with the syntax of that entered term. ![131 - 03d - Heatmap options - Rows (Search Term Validation)-4](https://5796933.fs1.hubspotusercontent-na1.net/hub/5796933/hubfs/DOCUMENTATION/ARTICLE%20SCREENSHOTS/131%20-%2003d%20-%20Heatmap%20options%20-%20Rows%20(Search%20Term%20Validation)-4.png?width=722&quality=high) - The search terms will be applied to the values selected for the Columns. ![131 - 03b - Heatmap options - Rows (Search Term Heatmap)](https://5796933.fs1.hubspotusercontent-na1.net/hub/5796933/hubfs/DOCUMENTATION/ARTICLE%20SCREENSHOTS/131%20-%2003b%20-%20Heatmap%20options%20-%20Rows%20(Search%20Term%20Heatmap).png?width=783&quality=high) - ***Date/Time Field*** adds the following specifications to analyze selected chronological metadata in the Heatmap. Here you specify the following new values: ![131 - 03e - Heatmap options - Rows (DateTime Field)-1](https://5796933.fs1.hubspotusercontent-na1.net/hub/5796933/hubfs/DOCUMENTATION/ARTICLE%20SCREENSHOTS/131%20-%2003e%20-%20Heatmap%20options%20-%20Rows%20(DateTime%20Field)-1.png?width=723&quality=high) Date time rows display in chronological order. A sample of date time values as specified above set against columns configured to display Custodian data would look something like this: ![131 - 03f - DateTime Heatmap table sample](https://5796933.fs1.hubspotusercontent-na1.net/hub/5796933/hubfs/DOCUMENTATION/ARTICLE%20SCREENSHOTS/131%20-%2003f%20-%20DateTime%20Heatmap%20table%20sample.png?width=1116&quality=high) - **Field** – Select a date, time or date/time metadata field. - **Time Interval** – Like the Timeline visualization, the default of ***Auto*****will offer the best fit for the volume and values selected. The other alternatives that may be specified (and reported using *Export to CSV*) are: ***Day, Week, Month, Quarter*** or ***Year***. ## **Columns Settings** This is a simpler set of options to keep the Heatmap manageable and efficient. ![131 - 04 - Heatmap options - Columns (Custom Selection)-2](https://5796933.fs1.hubspotusercontent-na1.net/hub/5796933/hubfs/DOCUMENTATION/ARTICLE%20SCREENSHOTS/131%20-%2004%20-%20Heatmap%20options%20-%20Columns%20(Custom%20Selection)-2.png?width=722&quality=high) - **Data** – Choose the field from the list of all those available in the currently selected Field Profile. (The Search Terms Data Type is not an option for Columns.) - **Selection** – Choose what will be displayed for the row labels: - ***Custom Selection*****expands the Columns Options to offer selection of specific values from the Data field, as well as *Any Value* or *No Value*. Selections are summarized in a box noting selections may include up to 38000 documents. - ***Top Values***is the default, which will display the values with the highest number of records corresponding to the Columns values, up to the number set as maximum below. - **Maximum Number of Columns** – *[Not shown in above illustration]*Sets the depth of values to be displayed as columns. Higher maximums may significantly slow performance. ## Related - [Review Grid](/grid.md) - [Brain Explorer](/brain-explorer.md) - [Clusters](/clusters.md) - [Candy Bar](/candy-bar.md) - [Communications](/communications.md)