> ## Documentation Index
> Fetch the complete documentation index at: https://speckle-assistant.mintlify.site/llms.txt
> Use this file to discover all available pages before exploring further.

# Dashboards

> Create interactive dashboards to analyze and visualize your model data.

<Note>
  **Currently in Public Beta**: Dashboards is now in public beta and available to all users with a paid workspace plan.
  If you encounter any issues or have feedback, please reach out via the [Speckle Community](https://speckle.community/).
</Note>

Dashboards let you create custom, interactive views of your model data. Analyze properties, compare versions, and share insights with your team—all without leaving Speckle.

## Getting Started

<Steps>
  <Step title="Access Dashboards">
    From your Speckle workspace, click **Intelligence** in the top left to open the workspace dashboards page.
  </Step>

  <Step title="Create your first dashboard">
    Click **Add dashboard** to create a new dashboard. You'll be taken to the dashboard editor.
  </Step>

  <Step title="Add a model viewer">
    Drag a **Model Viewer** widget from the left sidebar onto the canvas. Select a project and model to display. The model viewer acts as the data source for other widgets.
  </Step>

  <Step title="Add analysis widgets">
    Drag additional widgets (charts, tables, etc.) from the left sidebar. Widgets will automatically display data from the model you've added.
  </Step>

  <Step title="Configure interactions">
    Click on widgets to configure their settings. Widgets can filter data, colorize the model, and interact with each other.
  </Step>
</Steps>

<div style={{ position: 'relative', paddingBottom: '56.25%', height: 0, overflow: 'hidden' }}>
  <iframe
    src="https://player.vimeo.com/video/1121557795"
    allowFullScreen
    loading="lazy"
    style={{
  position: 'absolute',
  top: 0,
  left: 0,
  width: '100%',
  height: '100%',
}}
  />
</div>

<AccordionGroup>
  <Accordion title="What can I do with dashboards?">
    Dashboards let you analyze model data through charts, tables, and 3D visualizations. You can track properties, compare model versions, identify changes, and create visual reports for your team.
  </Accordion>

  <Accordion title="Do I need special access to use dashboards?">
    No, dashboards are available to all users in public beta. You just need access to the workspace and projects you want to analyze.
  </Accordion>

  <Accordion title="Can I share dashboards with my team?">
    Yes, dashboards are shared at the workspace level. Anyone with access to your workspace can view and edit dashboards.
  </Accordion>
</AccordionGroup>

## Working with Models

### Adding models to your dashboard

Each dashboard needs at least one model viewer widget. The model viewer displays your 3D model and provides data to other widgets on the dashboard.

To add a model:

1. Drag the **Model Viewer** widget onto the canvas
2. Select a project from the dropdown
3. Select a model from that project
4. Choose whether to load the latest version automatically or pin to a specific version

<AccordionGroup>
  <Accordion title="Can I add multiple models to one dashboard?">
    Yes, you can add multiple model viewer widgets to a dashboard. Other widgets can then connect to any of these models as their data source.
  </Accordion>

  <Accordion title="Should I pin to a specific version or use 'latest'?">
    Use "latest" if you want the dashboard to automatically update when new versions are published. Pin to a specific version if you need to analyze a particular state of the model.
  </Accordion>

  <Accordion title="Can I add models from different projects?">
    Yes, you can add models from any project you have access to within the workspace, including models from different projects or disciplines.
  </Accordion>
</AccordionGroup>

### Comparing models and versions

Some widgets support multiple data sources, letting you compare:

* Different versions of the same model
* Models from different disciplines
* Models from different projects

Widgets with multiple sources offer two modes:

**Aggregate Mode**: Combines data from all sources into a unified view. Use this to analyze data across multiple models or versions together.

**Compare Mode**: Shows differences between sources. Use this to identify what's changed between versions or what differs between models.

<AccordionGroup>
  <Accordion title="How do I compare two model versions?">
    Add a widget that supports multiple sources (like a chart or table), then connect it to the same model but select different versions. Switch to Compare mode to see the differences.
  </Accordion>

  <Accordion title="Can I compare models from different software?">
    Yes, as long as both models are in Speckle, you can compare them. The comparison works on shared properties between the models.
  </Accordion>
</AccordionGroup>

## Filtering and Analysis

### Page-level filters

Filters let you focus on specific parts of your data. When you apply a filter from a widget, it becomes a page-level filter that affects all widgets on the dashboard.

* Multiple filters can be active at once
* Active filters appear at the top of the dashboard
* Click the X on a filter chip to remove it
* Individual widgets can opt out of page-level filters in their settings

<AccordionGroup>
  <Accordion title="How do I create a filter?">
    Click on a value in any chart or table widget. That value becomes a filter that applies to the whole dashboard. You can also use the filter icon on widgets to create custom filter rules.
  </Accordion>

  <Accordion title="Why isn't a filter affecting a widget?">
    The widget may be set to opt out of page-level filters. Check the widget settings to see if "Apply page filters" is disabled.
  </Accordion>

  <Accordion title="Can I save filter combinations?">
    Filters are part of the dashboard state. When you save or share a dashboard, the active filters are saved with it.
  </Accordion>
</AccordionGroup>

### Widget-level filtering

Many widgets have their own local filters that don't affect other widgets. Use local filters to focus a specific widget on a subset of data.

Filter types available:

**Text filters:**

* Contains - Find items with matching text
* Does not contain - Exclude items with text
* Is like - Pattern matching with wildcards (e.g., "Wall%")
* Equal to - Match exact text
* Not equal to - Exclude exact matches

**Number filters:**

* Greater than - Values above a threshold
* Less than - Values below a threshold
* In range - Values between two numbers
* Equal to - Exact match

**List filters:**

* In list - Match any value in a comma-separated list
* Not in list - Exclude values in a list

**Special filters:**

* Exists - Item has this property
* Has value - Property is not empty
* Is true/Is false - For boolean properties

<AccordionGroup>
  <Accordion title="When should I use widget filters vs page filters?">
    Use page filters when you want to focus the entire dashboard on specific data. Use widget filters when you want one widget to show different data than the rest of the dashboard.
  </Accordion>

  <Accordion title="Can I filter by properties that don't exist in all models?">
    Yes, but the filter will only apply to objects that have that property. Objects without the property are automatically excluded.
  </Accordion>
</AccordionGroup>

## Model Viewer Features

### Ghost mode

Ghost mode shows filtered-out objects as semi-transparent, providing context for the objects you're analyzing.

To enable ghost mode:

1. Select the model viewer widget
2. Toggle **Ghost mode** in the widget settings

<AccordionGroup>
  <Accordion title="When should I use ghost mode?">
    Use ghost mode when you need to see how filtered objects relate to the rest of the model. For example, viewing selected walls in the context of the full building.
  </Accordion>
</AccordionGroup>

### Colorizing the model

Model viewers can colorize objects based on widget data. When you select "Color Model By" on a chart or table widget, the 3D model updates to show the data visually.

<AccordionGroup>
  <Accordion title="Can I colorize by multiple properties at once?">
    No, only one colorization can be active at a time. The most recent "Color Model By" action takes precedence.
  </Accordion>

  <Accordion title="How do I remove colorization?">
    Click the active colorization control in the widget or filter bar to turn it off.
  </Accordion>
</AccordionGroup>

## Widget Management

All widgets share common controls:

* **Remove** - Delete the widget from the dashboard
* **Change Data Source** - Connect to a different model or version
* **Full Screen** - Expand widget to full screen
* **Settings** - Access widget-specific options

Chart widgets have additional options:

* **Chart Style** - Switch between different visualization types (bar, line, pie, etc.)
* **Local Filters** - Apply filters that only affect this widget

<AccordionGroup>
  <Accordion title="Can I duplicate a widget?">
    Not directly, but you can drag a new widget of the same type from the sidebar and configure it with the same settings.
  </Accordion>

  <Accordion title="Is there a limit to how many widgets I can add?">
    There's no hard limit, but dashboard performance may decrease with very large numbers of widgets.
  </Accordion>

  <Accordion title="Can I resize widgets?">
    Yes, drag the edges or corners of any widget to resize it on the canvas.
  </Accordion>
</AccordionGroup>

## Getting Help

For questions about dashboards, visit the [Speckle Community](https://speckle.community/).