---
schema_version: "1"
id: ae9ee5d387ee01342015cd4a54f165b93abf0ece0a89dfb98e0d4d4faaeb84f2
title: Lens State
collection: legacydeveloper
version: current
locale: en-us
portal_url: https://docs.salesforce.com/legacydeveloper/current/en-us/bi_dev_guide_rest/bi_responses_lens_state.md
canonical_url: https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest.meta/bi_dev_guide_rest/bi_responses_lens_state.htm
source_site: developer.salesforce.com
content_type: documentation
content_hash: dab4d1b3865c45f015a354bf990d41c723f9782fcdc91952f577682d6dfb48e3
description: The state for an Analytics lenses.
---
# Lens State

The state for an Analytics lenses.

## Properties

<table class="featureTable sort_table" summary="">





          <thead class="thead sorted" align="left">
            <tr>
              <th class="featureTableHeader vertical-align-top " id="d397975e55">Property Name</th>

              <th class="featureTableHeader vertical-align-top " id="d397975e58">Type</th>

              <th class="featureTableHeader vertical-align-top " id="d397975e61">Description</th>

              <th class="featureTableHeader vertical-align-top " id="d397975e64">Filter Group and Version</th>

              <th class="featureTableHeader vertical-align-top " id="d397975e67">Available Version</th>

            </tr>

          </thead>

          <tbody class="tbody">
            <tr>
              <td class="entry" headers="d397975e55" data-title="Property Name"><samp class="codeph nolang">options</samp></td>

              <td class="entry" headers="d397975e58" data-title="Type">Lens​Visualization Option</td>

              <td class="entry" headers="d397975e61" data-title="Description">The configuration options for different lens visualizations. Valid values
                are: <ul class="ul bulletList">
                  <li class="li"><a class="xref" href="#BarLensVisualizationOptions">Bar​Lens​Visualization​Options</a></li>

                  <li class="li"><a class="xref" href="#ComparisonTableLensVisualizationOptions">Comparison​Table​Lens​Visualization​Options</a></li>

                  <li class="li"><a class="xref" href="#DotLensVisualizationOptions">Dot​Lens​Visualization​Options</a></li>

                  <li class="li"><a class="xref" href="#HeatMapLensVisualizationOptions">Heat​Map​Lens​Visualization​Options</a></li>

                  <li class="li"><a class="xref" href="#MatrixLensVisualizationOptions">Matrix​Lens​Visualization​Options</a></li>

                  <li class="li"><a class="xref" href="#ParallelCoordsLensVisualizationOptions">Parallel​Coords​Lens​Visualization​Options</a></li>

                  <li class="li"><a class="xref" href="#PieLensVisualizationOptions">Pie​Lens​Visualization​Options</a></li>

                  <li class="li"><a class="xref" href="#PivotTableLensVisualizationOptions">Pivot​Table​Lens​Visualization​Options</a></li>

                  <li class="li"><a class="xref" href="#ScatterLensVisualizationOptions">Scatter​Lens​Visualization​Options</a></li>

                  <li class="li"><a class="xref" href="#StackedBarLensVisualizationOptions">Stacked​Bar​Lens​Visualization​Options</a></li>

                  <li class="li"><a class="xref" href="#TableLensVisualizationOptions">Table​Lens​Visualization​Options</a></li>

                  <li class="li"><a class="xref" href="#TimeLensVisualizationOptions">Time​Lens​Visualization​Options</a></li>

                  <li class="li"><a class="xref" href="#ValuesTableLensVisualizationOptions">Values​Table​Lens​Visualization​Options</a></li>

                </ul>

              </td>

              <td class="entry" headers="d397975e64" data-title="Filter Group and Version">Small, 36.0</td>

              <td class="entry" headers="d397975e67" data-title="Available Version">36.0</td>

            </tr>

            <tr>
              <td class="entry" headers="d397975e55" data-title="Property Name"><samp class="codeph nolang">query</samp></td>

              <td class="entry" headers="d397975e58" data-title="Type"><a class="xref" href="#Query">Query</a></td>

              <td class="entry" headers="d397975e61" data-title="Description">The SAQL query used to create this lens.</td>

              <td class="entry" headers="d397975e64" data-title="Filter Group and Version">Small, 36.0</td>

              <td class="entry" headers="d397975e67" data-title="Available Version">36.0</td>

            </tr>

          </tbody>

        </table>

## Bar​Lens​Visualization​Options

| Property Name | Type | Description | Filter Group and Version | Available Version |
| --- | --- | --- | --- | --- |
| legend | Boolean | Indicates whether to display the legend or not. | Small, 36.0 | 36.0 |
| legend​Hide​Header | Boolean | Indicates whether to hide the legend header or not. | Small, 36.0 | 36.0 |
| legend​Width | Integer | The width of the legend. | Small, 36.0 | 36.0 |
| max​Column​Width | Integer | The maximum width of the header column. | Small, 36.0 | 36.0 |
| min​Column​Width | Integer | The minimum width of the header column. | Small, 36.0 | 36.0 |
| miniBars | Integer | The width of the mini-bars, if used. | Small, 36.0 | 36.0 |
| multi​Metrics | Boolean | Indicates whether multiple measures are projected on the same chart, side by side, or if every measure is in its own chart. | Small, 36.0 | 36.0 |
| split​Axis | Boolean | Indicates whether each measure is projected on one axis or if all measures share an axis. | Small, 36.0 | 36.0 |
| sqrt | Boolean | Indicates whether the axis is sqrt scale or not. | Small, 36.0 | 36.0 |
| trellis | Boolean | Indicates whether the last group is treated as a trellis dimension or not. Every distinct value of the dimension is a chart. | Small, 36.0 | 36.0 |

## Comparison​Table​Lens​Visualization​Options

| Property Name | Type | Description | Filter Group and Version | Available Version |
| --- | --- | --- | --- | --- |
| max​Column​Width | Integer | The maximum width of the header column. | Small, 36.0 | 36.0 |
| min​Column​Width | Integer | The minimum width of the header column. | Small, 36.0 | 36.0 |
| subtotals | Boolean | Indicates whether to display subtotals in the table or not. | Small, 48.0 | 48.0 |
| totals | Boolean | Indicates whether to display totals in the table or not. | Small, 36.0 | 36.0 |

## Dot​Lens​Visualization​Options

| Property Name | Type | Description | Filter Group and Version | Available Version |
| --- | --- | --- | --- | --- |
| fit | Boolean | Indicates whether to scale the position and size of a data shape so that it's proportional to its percentage of its category or not. | Small, 36.0 | 36.0 |
| legend | Boolean | Indicates whether to display the legend or not. | Small, 36.0 | 36.0 |
| legend​Hide​Header | Boolean | Indicates whether to hide the legend header or not. | Small, 36.0 | 36.0 |
| legend​Width | Integer | The width of the legend. | Small, 36.0 | 36.0 |
| sqrt | Boolean | Indicates whether the axis is sqrt scale or not. | Small, 36.0 | 36.0 |

## Heat​Map​Lens​Visualization​Options

| Property Name | Type | Description | Filter Group and Version | Available Version |
| --- | --- | --- | --- | --- |
| legend​Hide​Header | Boolean | Indicates whether to hide the legend header or not. | Small, 36.0 | 36.0 |
| legend​Width | Integer | The width of the legend. | Small, 36.0 | 36.0 |
| sqrt | Boolean | Indicates whether the axis is sqrt scale or not. | Small, 36.0 | 36.0 |

## Matrix​Lens​Visualization​Options

| Property Name | Type | Description | Filter Group and Version | Available Version |
| --- | --- | --- | --- | --- |
| legend​Hide​Header | Boolean | Indicates whether to hide the legend header or not. | Small, 36.0 | 36.0 |
| legend​Width | Integer | The width of the legend. | Small, 36.0 | 36.0 |
| sqrt | Boolean | Indicates whether the axis is sqrt scale or not. | Small, 36.0 | 36.0 |

## Parallel​Coords​Lens​Visualization​Options

| Property Name | Type | Description | Filter Group and Version | Available Version |
| --- | --- | --- | --- | --- |
| fit | Boolean | Indicates whether to scale the position and size of a data shape so that it's proportional to its percentage of its category or not. | Small, 36.0 | 36.0 |
| legend | Boolean | Indicates whether to display the legend or not. | Small, 36.0 | 36.0 |
| legend​Hide​Header | Boolean | Indicates whether to hide the legend header or not. | Small, 36.0 | 36.0 |
| legend​Width | Integer | The width of the legend. | Small, 36.0 | 36.0 |
| sqrt | Boolean | Indicates whether the axis is sqrt scale or not. | Small, 36.0 | 36.0 |

## Pie​Lens​Visualization​Options

| Property Name | Type | Description | Filter Group and Version | Available Version |
| --- | --- | --- | --- | --- |
| legend​Hide​Header | Boolean | Indicates whether to hide the legend header or not. | Small, 36.0 | 36.0 |
| legend​Width | Integer | The width of the legend. | Small, 36.0 | 36.0 |
| sqrt | Boolean | Indicates whether the axis is sqrt scale or not. | Small, 36.0 | 36.0 |

## Pivot​Table​Lens​Visualization​Options

| Property Name | Type | Description | Filter Group and Version | Available Version |
| --- | --- | --- | --- | --- |
| column​Totals | Boolean | Indicates whether to display column totals in the table (true) or not (false). | Small, 55.0 | 55.0 |
| max​Column​Width | Integer | The maximum width of the header column. | Small, 36.0 | 36.0 |
| min​Column​Width | Integer | The minimum width of the header column. | Small, 36.0 | 36.0 |
| row​Totals | Boolean | Indicates whether to display row totals in the table (true) or not (false). | Small, 55.0 | 55.0 |
| totals | Boolean | Indicates whether to display totals in the table or not. | Small, 36.0 | 36.0 |

## Scatter​Lens​Visualization​Options

| Property Name | Type | Description | Filter Group and Version | Available Version |
| --- | --- | --- | --- | --- |
| fit | Boolean | Indicates whether to scale the position and size of a data shape so that it's proportional to its percentage of its category or not. | Small, 36.0 | 36.0 |
| legend | Boolean | Indicates whether to display the legend or not. | Small, 36.0 | 36.0 |
| legend​Hide​Header | Boolean | Indicates whether to hide the legend header or not. | Small, 36.0 | 36.0 |
| legend​Width | Integer | The width of the legend. | Small, 36.0 | 36.0 |
| sqrt | Boolean | Indicates whether the axis is sqrt scale or not. | Small, 36.0 | 36.0 |

## Stacked​Bar​Lens​Visualization​Options

| Property Name | Type | Description | Filter Group and Version | Available Version |
| --- | --- | --- | --- | --- |
| legend | Boolean | Indicates whether to display the legend or not. | Small, 36.0 | 36.0 |
| legend​Hide​Header | Boolean | Indicates whether to hide the legend header or not. | Small, 36.0 | 36.0 |
| legend​Width | Integer | The width of the legend. | Small, 36.0 | 36.0 |
| max​Column​Width | Integer | The maximum width of the header column. | Small, 36.0 | 36.0 |
| min​Column​Width | Integer | The minimum width of the header column. | Small, 36.0 | 36.0 |
| miniBars | Integer | The width of the mini-bars, if used. | Small, 36.0 | 36.0 |
| normalize | Boolean | Indicates whether to scale the position and size of data shape so that it’s proportional to its percentage of its category or not. | Small, 36.0 | 36.0 |
| sqrt | Boolean | Indicates whether the axis is sqrt scale or not. | Small, 36.0 | 36.0 |

## Table​Lens​Visualization​Options

| Property Name | Type | Description | Filter Group and Version | Available Version |
| --- | --- | --- | --- | --- |
| column​Totals | Boolean | Indicates whether to display column totals in the table (true) or not (false). | Small, 55.0 | 55.0 |
| subtotals | Boolean | Indicates whether to display subtotals in the table or not. | Small, 48.0 | 48.0 |
| row​Totals | Boolean | Indicates whether to display row totals in the table (true) or not (false). | Small, 55.0 | 55.0 |
| totals | Boolean | Indicates whether to display totals in the table or not. | Small, 36.0 | 36.0 |

## Time​Lens​Visualization​Options

| Property Name | Type | Description | Filter Group and Version | Available Version |
| --- | --- | --- | --- | --- |
| legend | Boolean | Indicates whether to display the legend or not. | Small, 36.0 | 36.0 |
| legend​Hide​Header | Boolean | Indicates whether to hide the legend header or not. | Small, 36.0 | 36.0 |
| legend​Width | Integer | The width of the legend. | Small, 36.0 | 36.0 |
| multi​Metrics | Boolean | Indicates whether multiple measures are projected on the same chart, side by side, or if every measure is in its own chart. | Small, 36.0 | 36.0 |
| sqrt | Boolean | Indicates whether the axis is sqrt scale or not. | Small, 36.0 | 36.0 |

## Values​Table​Lens​Visualization​Options

| Property Name | Type | Description | Filter Group and Version | Available Version |
| --- | --- | --- | --- | --- |
| hide​Header​Column | Boolean | Indicates whether to display header column or not. | Small, 36.0 | 36.0 |
| max​Column​Width | Integer | The maximum width of the header column. | Small, 36.0 | 36.0 |
| min​Column​Width | Integer | The minimum width of the header column. | Small, 36.0 | 36.0 |
| totals | Boolean | Indicates whether to display totals in the table or not. | Small, 36.0 | 36.0 |

## Query

| Property Name | Type | Description | Filter Group and Version | Available Version |
| --- | --- | --- | --- | --- |
| aggregate​Filters | Object | The query aggregate filters. | Small, 48.0 | 48.0 |
| limit | Object | The query limit. | Small, 48.0 | 48.0 |
| orders | Object | The query orders. | Small, 48.0 | 48.0 |
| pivot​Totals | String | The query pivot totals. | Small, 55.0 | 55.0 |
| query | String | The SAQL query text. | Small, 36.0 | 36.0 |
| source​Filters | [Compact​Form​Filter](#CompactFormFilter) | The query source filters. | Small, 48.0 | 48.0 |
| sources | [Compact​Form​Source](#CompactFormSource) | The query sources. | Small, 48.9 | 48.0 |
| totals | String | The query totals. | Small, 55.0 | 55.0 |
| version | Double | The version of this query. | Small, 36.0 | 36.0 |

## Compact​Form​Filter

| Property Name | Type | Description | Filter Group and Version | Available Version |
| --- | --- | --- | --- | --- |
| boolean​Filter​Logic | String | The boolean filter logic. | Small, 49.0 | 49.0 |
| filters | Object | The list of filters. | Small, 48.0 | 48.0 |

## Compact​Form​Source

<table class="featureTable sort_table" summary="">





          <thead class="thead sorted" align="left">
            <tr>
              <th class="featureTableHeader vertical-align-top " id="d397975e2375">Property Name</th>

              <th class="featureTableHeader vertical-align-top " id="d397975e2378">Type</th>

              <th class="featureTableHeader vertical-align-top " id="d397975e2381">Description</th>

              <th class="featureTableHeader vertical-align-top " id="d397975e2384">Filter Group and Version</th>

              <th class="featureTableHeader vertical-align-top " id="d397975e2387">Available Version</th>

            </tr>

          </thead>

          <tbody class="tbody">
            <tr>
              <td class="entry" headers="d397975e2375" data-title="Property Name"><samp class="codeph nolang">cogroup​Type</samp></td>

              <td class="entry" headers="d397975e2378" data-title="Type">Connect​Wave​Compact​Form​Cogroup​Type​Enum</td>

              <td class="entry" headers="d397975e2381" data-title="Description">The compact form source
                cogroup type. Valid values are:<ul class="ul bulletList">
                  <li class="li">Anti</li>

                  <li class="li">Inner</li>

                  <li class="li">Left</li>

                  <li class="li">Outer</li>

                  <li class="li">Right</li>

                  <li class="li">Semi</li>

                </ul>
              </td>

              <td class="entry" headers="d397975e2384" data-title="Filter Group and Version">Small, 48.0</td>

              <td class="entry" headers="d397975e2387" data-title="Available Version">48.0</td>

            </tr>

            <tr>
              <td class="entry" headers="d397975e2375" data-title="Property Name"><samp class="codeph nolang">columns</samp></td>

              <td class="entry" headers="d397975e2378" data-title="Type"><a class="xref" href="#CompactFormColumn">Compact​Form​Column</a></td>

              <td class="entry" headers="d397975e2381" data-title="Description">The compact form source columns.</td>

              <td class="entry" headers="d397975e2384" data-title="Filter Group and Version">Small, 48.0</td>

              <td class="entry" headers="d397975e2387" data-title="Available Version">48.0</td>

            </tr>

            <tr>
              <td class="entry" headers="d397975e2375" data-title="Property Name"><samp class="codeph nolang">groups</samp></td>

              <td class="entry" headers="d397975e2378" data-title="Type">Object</td>

              <td class="entry" headers="d397975e2381" data-title="Description">The compact form source groups.</td>

              <td class="entry" headers="d397975e2384" data-title="Filter Group and Version">Small, 48.0</td>

              <td class="entry" headers="d397975e2387" data-title="Available Version">48.0</td>

            </tr>

            <tr>
              <td class="entry" headers="d397975e2375" data-title="Property Name"><samp class="codeph nolang">filters</samp></td>

              <td class="entry" headers="d397975e2378" data-title="Type">Object</td>

              <td class="entry" headers="d397975e2381" data-title="Description">The compact form source column filters.</td>

              <td class="entry" headers="d397975e2384" data-title="Filter Group and Version">Small, 52.0</td>

              <td class="entry" headers="d397975e2387" data-title="Available Version">52.0</td>

            </tr>

            <tr>
              <td class="entry" headers="d397975e2375" data-title="Property Name"><samp class="codeph nolang">name</samp></td>

              <td class="entry" headers="d397975e2378" data-title="Type">String</td>

              <td class="entry" headers="d397975e2381" data-title="Description">The compact form source name.</td>

              <td class="entry" headers="d397975e2384" data-title="Filter Group and Version">Small, 48.0</td>

              <td class="entry" headers="d397975e2387" data-title="Available Version">48.0</td>

            </tr>

          </tbody>

        </table>

## Compact​Form​Column

| Property Name | Type | Description | Filter Group and Version | Available Version |
| --- | --- | --- | --- | --- |
| field | Object | The compact form column field. | Small, 48.0 | 48.0 |
| formula | String | The compact form column formula. | Small, 48.0 | 48.0 |
| name | String | The name of the compact form column. | Small, 48.0 | 48.0 |