Step-by-step guides for quantity takeoff, share of total, version comparison, validation, portfolio analysis, calculated fields, presenting to clients, and Context site maps.
Pick a goal below and follow the steps. Each workflow assumes you’re in the dashboard editor and can add widgets from
the sidebar. For concepts and widget choices, see Dashboards. Not sure which
widget to add? See Choosing the right widget on the
Overview.
Choose how to validate
Use Validation Widgets in Dashboards to choose
between a Property checker widget on a dashboard and a saved Data Validation check.
Run a quantity takeoff
When to use: One model; you need element counts and optional area or length totals (e.g. for cost or schedule).
1
Load your model
Drag Model Viewer onto the canvas. Select your project and model; pin a version if you need
a specific state.
2
Add Element count for total elements
Drag Element count onto the canvas. It shows the total count; use page-level filters to
filter by level, category, or family.
3
Add a breakdown widget
Add Total property value for area/length sums or Count by property for counts by
Category, Type, or Family (Revit: Categories, Types, Families). On Total widgets,
open Settings and set Aggregation to Sum, Average, Min, Max, or Median. Use Rounding
and, for area properties, Display unit if you need a different area unit on the chart.
4
Filter the dashboard
Click a value in any chart or table to filter the whole dashboard (e.g. one level, one
category).
5
Browse elements in a table
Add Elements table to see rows; customise columns, filter, and sort. Filter state is saved
with the dashboard.
Outcome: Counts and breakdowns tied to the 3D model; filter state saved with the dashboard.
When to use: You already have a number on each element (for example area or length)
and you want each one’s share of the project total — as a fraction or percentage — for
tables, charts, or filters.This uses two calculated fields: an
Aggregate for the total, then Arithmetic to divide each element’s value by that
total.
1
Load your model
Drag Model Viewer onto the canvas and select the project and model. Apply any page-level
filters you want the “whole” to respect.
2
Create an Aggregate field for the total
Open Calculated Fields, click New calculated field, and choose Aggregate. Pick the
number property (for example area), choose Sum (or another operation), and set the
population: All data for a fixed project total, or Current view if the total should
follow dashboard filters. Save and keep the field on this dashboard.
3
Create an Arithmetic field for the share
Create another calculated field and choose Arithmetic. Write a formula such as a / b (or
(a / b) * 100 for a percentage). Bind a to the element property and b to your Aggregate
field. Save.
4
Show the share in a table or chart
Add Elements table or a chart widget and pick the Arithmetic field as a column or value. You
can also filter or colour by it.
Outcome: Each element has a share of the chosen total, without changing the model. The
Aggregate value is the same on every element — that is expected; the Arithmetic field
is what varies per element.
Use Aggregate + Arithmetic for shares. An All data or Current view Aggregate field in a
Ratio widget can inflate the result. See Things to watch out
for.
For comparisons between two models, use Dashboard constants.
To correct area units, create a Unit conversion field and use it in both calculations.
Compare totals from two models
When to use: You want one intensity figure that mixes two models — for example power
load per square metre of IT room, desks per floor area, or people per workplace — and
you want that figure to remain fixed when someone filters the charts.This uses dashboard constants
in Calculated Fields (Aggregate → Population → Dashboard constant).
1
Load both models
Add a Model Viewer for each model so both appear on the dashboard — for example an equipment or
rack model and a rooms or architecture model.
2
Create the comparison constants
Open Calculated Fields, create an Aggregate field, and set Population to Dashboard
constant. Example: Sum of rack IT load from one model, and Sum of IT room area from the other.
Pick a property that belongs to the model you mean, so the other model does not get mixed in by
accident.
3
Show the comparison
Add a Ratio Value widget and pick those two constants as the two sides of the ratio (load ÷
area). Or create an Arithmetic field that only uses those constants (for example a / b).
Outcome: One clear intensity figure such as load per m². It does not change when
people filter the dashboard. For limits and safer Ratio patterns, see
Dashboard constants.
Compare two versions of the same model
When to use: You want to see what changed between two versions (e.g. before/after a design round).
1
Load both model versions
Add a Dual viewer and load both versions (first model / second model), or add two Model
Viewer widgets and select the same project/model with different versions (pin each to a
version).
2
Add widgets that support Compare mode
Add Element count or Total property value (or Count by property). In the widget’s
data source setting, select both viewers and choose Compare mode.
3
Synchronize the cameras
If you have two viewers side by side, turn on Sync camera in each viewer’s sidebar so
pan/zoom stays aligned.
Outcome: Side-by-side or compared counts and totals so you can see what changed between versions.
Show a site model while analyzing design options
When to use: You want a site or existing-conditions model visible in the 3D view while charts and tables
tabulate only your design schemes (for example several Grasshopper-generated options).
1
Load the site and design schemes
Drag Model Viewer onto the canvas. Load your site model, then use Add model in the
sidebar Models panel to add each design scheme.
2
Mark the site as a context model
Open the ⋯ menu on the site model row and choose Use as context model. The site stays
visible when you filter the schemes in the viewer.
3
Connect widgets to design schemes
Add charts or tables (for example Element count or Count by property). In each widget’s
data source setting, select only the design scheme data sources—not the site model.
4
Filter and compare schemes on the canvas
Click values in charts to add page-level filters. The site model remains fully visible in the
viewer while filters isolate objects in your schemes.
Outcome: Site geometry for spatial context in the 3D view; counts and breakdowns driven only by the schemes you
connect to analysis widgets.
Perform portfolio analysis
When to use: Multiple projects or models; you want combined totals or differences across them.
1
Load the projects or models
Add a Model Viewer for each project (or key model) and select project/model for each.
2
Add widgets that support multiple data sources
Add Element count or Count by property and connect them to several viewers (use the
widget’s data source setting).
3
Choose Aggregate or Compare mode
Use Aggregate mode to see combined totals across models; use Compare mode to see
differences.
4
Group widgets with sections
Add Section widgets to group areas (e.g. by project or by metric).
5
Share the dashboard
Share via workspace access. Stakeholders see the same layout and
data.
Outcome: One dashboard for portfolio-level counts and comparisons; stakeholders see the same view.
When to use: You want to check one or more properties against a rule (e.g. “doors must have fire rating”) and see
pass/fail in the dashboard.
1
Load your model
Drag Model Viewer onto the canvas and select project and model.
2
Add Property checker
Drag Property checker from the Basics group. In the widget settings, choose the property and
define the rule (e.g. “exists”, “equals”, “matches pattern”).
3
View results and colorize the model
The widget shows pass/fail counts. Use the widget option to colorize the 3D viewer so you can
see which elements pass or fail.
4
Add more rules
For several rules that run on every new version, author a Data Validation check instead. See
Data Validation.
Outcome: Pass/fail view for one property in the dashboard, with optional colorization in the
viewer.
Find models that use a specific family or type
When to use: You need to identify which models or elements use a given family (or category/type) so you can fix
or flag them (e.g. auditing families, pre-upgrade checks).
1
Add a model breakdown widget
Load the model(s). Use Model structure or Families (Revit) or Count by property to
see family/category/type.
2
Search or filter by family name
Use the widget to search or filter by family name (or category/type).
3
Use Matches pattern in a filter
Add a filter with Matches pattern (e.g. family name *ProblemFamily* or %ProblemFamily%)
to find matches.
4
Save a reusable validation rule
To flag this family in future, add Property checker and define a rule, or author a Data
Validation check. See Data Validation.
5
Pin the model version
Pin the model version so the result is reproducible.
Outcome: List or count of models/elements using that family; path to validation if you want rules.
Turn model codes into clear labels for charts
When to use: The model stores short codes (classification, type, zone, and similar),
and you have a spreadsheet that maps each code to a clearer name. You want charts,
filters, and colour-by in plain language — without changing the published model.This workflow uses Lookup tables and a
Calculated fieldsMap lookup. If you only
need maths, unit changes, or simple groups (and no spreadsheet), skip the table and
create a calculated field of another type instead.
1
Load your model
Drag Model Viewer onto the canvas and select the project and model.
2
Create a Map lookup calculated field
Open Calculated Fields, click New calculated field, and choose Map lookup. Pick the
model property that holds the code. Import your CSV or Excel list from the dialog (Import new
table if tables already exist), or choose a table you already imported. Set the match column,
the return column, and a fallback for codes not in the list. Save the field and make sure it is
on this dashboard.
3
Chart or list by the new label
Add Count by property, Total value by property, or Elements table. In the widget
settings, pick your calculated field instead of the raw code property.
4
Filter or colour the model
Use the calculated field in a filter, or colour the viewer by it, so stakeholders see the
friendly labels rather than the codes.
5
Add further calculated fields
Need areas in another unit for filters or further maths? Add a Unit conversion field, then
build on it. For chart labels only, use widget Display unit instead (see Aggregation and
numeric display). Need
pass/fail-style labels for a table column? Add a Logical field. See Calculated
fields.
Outcome: Charts and filters use clear labels from your list; the model itself is
unchanged. Update the lookup table later when the list changes — fields that use it
pick up the new rows when the dashboard reloads the data.
Present a dashboard to a client
When to use: You want to share a read-only view or embed the dashboard in a presentation (e.g. Notion, Miro).
1
Arrange the layout and apply a theme
Resize and reorder widgets; add Section widgets to group content. In the Themes panel,
pick a built-in or custom theme so chart and validation colors stay consistent. See
Layout for scopes and editing.
2
Use the view link
Share the dashboard view link (not the edit URL). Recipients always open in presentation
mode — view mode and shared mode are the same read-only experience. See
Sharing for share links and presentation mode.
3
Embed the dashboard
You can embed dashboards in Notion, Miro, and other tools. For step-by-step guides, see
Tutorials (filter by Dashboards & Insights).
Outcome: A shareable or embeddable dashboard in presentation mode, with a clear layout
and theme.
Show your model on a map with Context
When to use: You want to place a Speckle model on a pitched 3D map at a real-world site.
Models do not need geographic metadata.Context is the widget that draws Speckle geometry on OpenFreeMap at the dashboard site
location. It is not the same as marking a model as a
context model in the Model Viewer.
Context is experimental and is not in the widget panel for every workspace.
This workflow adds a Model Viewer, Context, and optionally Map to the same dashboard — each uses
one or more browser rendering contexts. On a dashboard that already has several viewer or map
widgets, you can hit your browser’s limit. See 3D viewer widget
limit.
1
Load your model
Drag Model Viewer onto the canvas and select your project and model. Context reuses geometry
from an existing viewer on the dashboard when one is available.
2
Add Context
Drag Context from the widget panel onto the canvas.
3
Set the dashboard site location
In the Context sidebar, open Site and enter latitude and longitude (optional elevation and
rotation). Select Apply to save the placement. The site location is owned by the dashboard —
you do not need geographic data on the model. You can also set the site from a Map widget;
both share the same site.
4
Add a map for location pins
Drag Map from Presentation if you want a lighter map with location bookmarks only (no
Speckle geometry). Search for a place, then add, rename, or remove pins from Locations.
5
Tune filters, colour, and the map
Use Context sidebar controls as needed: local Filters, Apply global filters, Apply
color by, and Include nested objects (same idea as Model Viewer). Save a starting
viewpoint with Focus or Camera → Save current. Use the bulldozer control to hide basemap
buildings that overlap the model; set Building clearance and optionally Show clearance
boundary. Clip model to ground hides Speckle geometry below the map surface (on by
default).
Outcome: Context shows your Speckle model on a pitched 3D map at the dashboard site. Map (if
used) shows site markers and optional pins only.The Map widget shows site markers and location pins. Use Context to show model geometry
on the map. The Model Viewer keeps its local coordinates. Context also saves location bookmarks
and a starting camera position.
Context is experimental. Avoid relying on it for production-critical dashboards.
Map tiles require an internet connection, and OpenFreeMap attribution stays visible. Deleting a
Map or Context widget does not clear the dashboard site location.
See also
Filters — Filter levels, operators, and colorizing the model
Calculated fields — Add your own values for charts, filters, and colour-by
{"docsConfig":{"theme":"mint","$schema":"https://mintlify.com/docs.json","name":"Speckle Docs","colors":{"primary":"#155DFC","light":"#51A2FF","dark":"#2B7FFF"},"logo":{"light":"https://mintcdn.com/speckle/8FGkkbZZbcuHzOBq/logo/light.svg?fit=max\u0026auto=format\u0026n=8FGkkbZZbcuHzOBq\u0026q=85\u0026s=9fc87cac252fa8cc443a9828ecbace70","dark":"https://mintcdn.com/speckle/8FGkkbZZbcuHzOBq/logo/dark.svg?fit=max\u0026auto=format\u0026n=8FGkkbZZbcuHzOBq\u0026q=85\u0026s=560ffcf355d3abfde56e5f8e514a64b7"},"favicon":"https://mintcdn.com/speckle/H0UAly7sy_Ci378-/favicon-docs.svg?fit=max\u0026auto=format\u0026n=H0UAly7sy_Ci378-\u0026q=85\u0026s=024a646efe6d1f271e2e537e4e58a606","background":{"color":{"light":"#FAFAFA","dark":"#09090B"}},"navbar":{"links":[{"href":"https://speckle.systems/","label":"Website"},{"href":"https://speckle.community/","label":"Community"}],"primary":{"type":"button","label":"Open Speckle","href":"https://app.speckle.systems/?utm_source=Docs\u0026utm_medium=SignUp\u0026utm_campaign=Docs"}},"footer":{"socials":{"linkedin":"https://www.linkedin.com/company/specklesystems","youtube":"https://www.youtube.com/@SpeckleSystems","github":"https://github.com/specklesystems","instagram":"https://www.instagram.com/specklesystems"}},"icons":{"library":"fontawesome"},"integrations":{"ga4":{"measurementId":"G-05WEYFZ28C"},"intercom":{"appId":"hoiaq4wn"},"mixpanel":{"projectToken":"acd87c5a50b56df91a795e999812a3a4"}},"contextual":{"options":["copy","chatgpt","claude"],"display":"header"},"metadata":{"timestamp":true},"markdown":{"instructions":["These docs describe Speckle as it works today, including everything released in 2026.9. Treat page content as current unless the page or section says it applies only to versions published before 2026.9.","Content scoped to versions published before 2026.9 (the object graph and root object, Proxies, Receive2, operations.receive, object.children) applies only to model versions in that earlier data format. For versions published in 2026.9, answer from the Object model pages and the SDK migration guides.","The What's new pages summarise what changed in 2026.9 and link to the page that documents each change. Answer from the linked page rather than from the summary. Legacy (v2) connectors are retired; send questions about them to the community help forum.","Match guidance to the customer's deployment, model data format, connector, plan and permissions. Self-hosted servers on a release before 2026.9 follow Data model migration for developers. If an unknown version or data format changes the answer, ask one focused question; do not infer the deployment version from the date alone."]},"styling":{"latex":false},"navigation":{"pages":[]}},"deployment":{"deploymentMetadataValue":{"subdomain":"speckle","hasAudioNarration":false,"actualSubdomain":"speckle","customDomains":["docs.speckle.systems"],"gitSource":{"type":"github","owner":"specklesystems","repo":"speckle-docs-new","deployBranch":"main","contentDirectory":"","isPrivate":false,"mountPath":"","label":""},"feedback":{"issues":true},"entitlements":{},"buildId":"6b008de1a4b04c90ff544085","clientVersion":"0.0.4270","searchFilterCounts":[{"language":"default","tag":"Developers","count":213},{"language":"default","tag":"User Guides","count":96},{"language":"default","tag":"SDKs","count":65},{"language":"default","tag":"API Reference","count":54},{"language":"default","tag":"Viewer","count":50},{"language":"default","tag":"Connectors","count":40},{"language":"default","tag":"Publishing \u0026 Loading","count":38},{"language":"default","tag":"C# .NET","count":33},{"language":"default","tag":"Python","count":30},{"language":"default","tag":"Interfaces","count":29}]},"assistantConfig":{},"basePath":"","hasChatPermissions":false,"hasWebMcpPermissions":false,"toggles":[{"name":"kill-isr","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"custom-rbac-roles","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"agent-mintlify-slack","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"agent-integrations-settings","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"rbac-expansion","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automations-pr-grouping","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"custom-prefix","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"analytics-v7","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"user-flows-analytics","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"no-publish-flow","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-onboarding","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"snapshot-serving-live","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"stripTemperatureMiddleware","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"support-platform-pylon-zendesk","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"snapshot-serving","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"instant-rollback","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"granular-notifications-server","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"granular-notifications","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automations-fable","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"fixed-ai-action-pricing","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"site-roles","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automation-resolve-merge-conflict","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"scoped-publishing","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"mintql","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"page-level-analytics","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"editor-version-history-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"billing-page-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"full-page-search","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workspace-projects","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"assistant-v5","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"fork-pr-previews","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"revalidation-jwt","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-sso-scim","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"hobby-abuse-scan","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"dashboard-inbox","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-signup","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"turbopuffer-dual-write","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-enabled","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"approve-review-flow","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"editor-metadata","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"sso-setup-deadline-banner","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"turbopuffer-serve","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"live-agents","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"starter-pricing","enabled":true,"variant":{"name":"control","enabled":true,"payload":{"type":"string","value":"control"},"feature_enabled":true},"impressionData":false},{"name":"llms-txt-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"wildcard-email-auth","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false}],"googleFontsInlined":false},"customCss":[{"filePath":"style.css","content":"#footer div:first-child>div:first-child>div:first-child{display:none}.header-link+p{margin-top:0.6rem}li .frame{margin-top:1rem;margin-bottom:1.5rem}div:has(>.frame)+div:has(>.frame){margin-top:0.75rem}:root{--sp-surface-0: #fafafa;--sp-surface-1: #fcfcfc;--sp-border: #e4e4e7;--sp-bg-elevated: #f4f4f5;--sp-text-highlighted: #18181b;--sp-text-muted: #71717b;--sp-header-height: 56px}:root.dark{--sp-surface-0: #09090b;--sp-surface-1: #111113;--sp-border: #27272a;--sp-bg-elevated: #27272a;--sp-text-highlighted: #ffffff;--sp-text-muted: #9f9fa9}#sidebar [class*=\"bg-linear-to-b\"]{background-image:linear-gradient(to bottom, var(--sp-surface-1), transparent)!important}#sidebar [class*=\"bg-neutral-50\"][class*=\"rounded-full\"]{background:transparent!important}#sidebar li[data-active]>a{background:var(--sp-bg-elevated)!important;color:var(--sp-text-highlighted)!important}@media (min-width: 1024px){:root{--mintlify-slot-header-height: calc(var(--sp-header-height) + var(--topbar-tabs-height, 0rem))}div:has(>#sidebar){max-width:none!important;margin-left:0!important;margin-right:0!important;padding-left:0!important}#sidebar{background:var(--sp-surface-1);border-right:1px solid var(--sp-border)}#sidebar>div{left:16px!important;right:8px!important}div:has(>[data-layout-item=\"content\"]){max-width:1184px;margin-left:auto;margin-right:auto;padding-inline:48px}#navbar [class*=\"max-w-8xl\"]{max-width:none!important}body:has(#sidebar) #navbar #navbar-transition{border-bottom:1px solid var(--sp-border)!important;background:linear-gradient(\n to right,\n var(--sp-surface-1) 0,\n var(--sp-surface-1) calc(var(--sidebar-width, 18rem) - 1px),\n var(--sp-border) calc(var(--sidebar-width, 18rem) - 1px),\n var(--sp-border) var(--sidebar-width, 18rem),\n var(--sp-surface-0) var(--sidebar-width, 18rem)\n )!important}#navbar div:has(>div>div>a>img.nav-logo){height:var(--sp-header-height)!important;padding-left:32px!important}#navbar div:has(>div>div>a>img.nav-logo)>div{border-bottom:0!important}#navbar img.nav-logo{height:28px!important}#navbar div:has(>div>div>a>img.nav-logo)>div>div:first-child{flex:1 1 auto!important}#navbar div:has(>div>div>a>img.nav-logo)>div>div:nth-child(2){flex:0 0 auto!important;margin-left:auto;width:32px}#navbar div:has(>div>div>a>img.nav-logo)>div>div:nth-child(3){flex:0 0 auto!important;margin-left:16px}#navbar div:has(>div>div>a>img.nav-logo)>div>div:nth-child(3) a:has(>[class*=\"bg-primary\"]){height:32px!important;padding-top:0!important;padding-bottom:0!important}#search-bar-entry{width:32px!important;height:32px!important;padding:0!important;justify-content:center!important;border:0!important;border-radius:6px!important;background:transparent!important;box-shadow:none!important}#search-bar-entry:hover{background:var(--sp-bg-elevated)!important}#search-bar-entry [data-search-item=\"trigger-icon\"]{width:16px!important;height:16px!important;color:var(--sp-text-muted)!important}#search-bar-entry:hover [data-search-item=\"trigger-icon\"]{color:var(--sp-text-highlighted)!important}#search-bar-entry [data-search-item=\"trigger-label\"],#search-bar-entry [data-search-item=\"trigger-hint\"]{display:none!important}body:has(#sidebar) #navbar div:has(>.nav-tabs){padding-left:calc(var(--sidebar-width, 18rem) + 32px)!important}}@media (min-width: 1440px){:root,body,body *{--topbar-tabs-height: 0rem !important}body:has(.nav-tabs) #navbar div:has(>div>.nav-tabs){display:grid!important}body:has(.nav-tabs) #navbar div:has(>div>.nav-tabs)>*{grid-area:1 / 1}#navbar div:has(>.nav-tabs){height:var(--sp-header-height)!important;pointer-events:none;align-items:stretch}#navbar .nav-tabs{pointer-events:auto}#content-side-layout{top:calc(var(--sp-header-height) + 48px)!important}}"}]}
{"page":{"pagePath":"analytics/dashboards/common-workflows","slug":"/analytics/dashboards/common-workflows","pageMetadata":{"title":"Common workflows","sidebarTitle":"Common workflows","description":"Step-by-step guides for quantity takeoff, share of total, version comparison, validation, portfolio analysis, calculated fields, presenting to clients, and Context site maps.","href":"/analytics/dashboards/common-workflows"},"description":{"compiledSource":"\"use strict\";\nconst {jsx: _jsx} = arguments[0];\nconst {useMDXComponents: _provideComponents} = arguments[0];\nfunction _createMdxContent(props) {\n const _components = {\n p: \"p\",\n ..._provideComponents(),\n ...props.components\n };\n return _jsx(_components.p, {\n children: \"Step-by-step guides for quantity takeoff, share of total, version comparison, validation, portfolio analysis, calculated fields, presenting to clients, and Context site maps.\"\n });\n}\nfunction MDXContent(props = {}) {\n const {wrapper: MDXLayout} = {\n ..._provideComponents(),\n ...props.components\n };\n return MDXLayout ? _jsx(MDXLayout, {\n ...props,\n children: _jsx(_createMdxContent, {\n ...props\n })\n }) : _createMdxContent(props);\n}\nreturn {\n default: MDXContent\n};\n","frontmatter":{},"scope":{}},"pageType":"default","mdx":{"mdxSource":{"compiledSource":"\"use strict\";const{Fragment:_Fragment,jsx:_jsx,jsxs:_jsxs}=arguments[0];const{useMDXComponents:_provideComponents}=arguments[0];function _createMdxContent(props){const _components={a:`a`,code:`code`,li:`li`,p:`p`,strong:`strong`,ul:`ul`,..._provideComponents(),...props.components},{Heading,Note,Step,Steps,Tip,Warning}=_components;if(!Heading)_missingMdxReference(`Heading`,true);if(!Note)_missingMdxReference(`Note`,true);if(!Step)_missingMdxReference(`Step`,true);if(!Steps)_missingMdxReference(`Steps`,true);if(!Tip)_missingMdxReference(`Tip`,true);if(!Warning)_missingMdxReference(`Warning`,true);return _jsxs(_Fragment,{children:[_jsxs(_components.p,{children:[`Pick a goal below and follow the steps. Each workflow assumes you’re in the dashboard editor and can add widgets from\nthe sidebar. For concepts and widget choices, see `,_jsx(_components.a,{href:`/analytics/intelligence-dashboards`,children:`Dashboards`}),`. Not sure which\nwidget to add? See `,_jsx(_components.a,{href:`/analytics/intelligence-dashboards#choosing-the-right-widget`,children:`Choosing the right widget`}),` on the\nOverview.`]}),`\n`,_jsx(Heading,{level:`2`,id:`choose-how-to-validate`,children:`Choose how to validate`}),`\n`,_jsxs(_components.p,{children:[`Use `,_jsx(_components.a,{href:`/analytics/dashboards/validation-widgets`,children:`Validation Widgets in Dashboards`}),` to choose\nbetween a `,_jsx(_components.strong,{children:`Property checker`}),` widget on a dashboard and a saved Data Validation check.`]}),`\n`,_jsx(Heading,{level:`2`,id:`run-a-quantity-takeoff`,children:`Run a quantity takeoff`}),`\n`,_jsxs(_components.p,{children:[_jsx(_components.strong,{children:`When to use:`}),` One model; you need element counts and optional area or length totals (e.g. for cost or schedule).`]}),`\n`,_jsxs(Steps,{children:[_jsx(Step,{title:`Load your model`,children:_jsxs(_components.p,{children:[`Drag `,_jsx(_components.strong,{children:`Model Viewer`}),` onto the canvas. Select your project and model; pin a version if you need\na specific state.`]})}),_jsx(Step,{title:`Add Element count for total elements`,children:_jsxs(_components.p,{children:[`Drag `,_jsx(_components.strong,{children:`Element count`}),` onto the canvas. It shows the total count; use page-level filters to\nfilter by level, category, or family.`]})}),_jsx(Step,{title:`Add a breakdown widget`,children:_jsxs(_components.p,{children:[`Add `,_jsx(_components.strong,{children:`Total property value`}),` for area/length sums or `,_jsx(_components.strong,{children:`Count by property`}),` for counts by\nCategory, Type, or Family (Revit: `,_jsx(_components.strong,{children:`Categories`}),`, `,_jsx(_components.strong,{children:`Types`}),`, `,_jsx(_components.strong,{children:`Families`}),`). On Total widgets,\nopen `,_jsx(_components.strong,{children:`Settings`}),` and set `,_jsx(_components.strong,{children:`Aggregation`}),` to Sum, Average, Min, Max, or Median. Use `,_jsx(_components.strong,{children:`Rounding`}),`\nand, for area properties, `,_jsx(_components.strong,{children:`Display unit`}),` if you need a different area unit on the chart.`]})}),_jsx(Step,{title:`Filter the dashboard`,children:_jsx(_components.p,{children:`Click a value in any chart or table to filter the whole dashboard (e.g. one level, one\ncategory).`})}),_jsx(Step,{title:`Browse elements in a table`,children:_jsxs(_components.p,{children:[`Add `,_jsx(_components.strong,{children:`Elements table`}),` to see rows; customise columns, filter, and sort. Filter state is saved\nwith the dashboard.`]})})]}),`\n`,_jsx(_components.p,{children:`Outcome: Counts and breakdowns tied to the 3D model; filter state saved with the dashboard.`}),`\n`,_jsx(Tip,{children:_jsxs(_components.p,{children:[`With Speckle Intelligence, you can ask for a priced takeoff in plain language instead — see `,_jsx(_components.a,{href:`/workflows/take-off-quantities`,children:`Take\noff quantities and cost with Speckle Intelligence`}),`.`]})}),`\n`,_jsx(Heading,{level:`2`,id:`show-each-element-as-a-share-of-the-whole`,children:`Show each element as a share of the whole`}),`\n`,_jsxs(_components.p,{children:[_jsx(_components.strong,{children:`When to use:`}),` You already have a number on each element (for example area or length)\nand you want each one’s share of the project total — as a fraction or percentage — for\ntables, charts, or filters.`]}),`\n`,_jsxs(_components.p,{children:[`This uses two `,_jsx(_components.a,{href:`/analytics/dashboards/calculated-fields`,children:`calculated fields`}),`: an\n`,_jsx(_components.strong,{children:`Aggregate`}),` for the total, then `,_jsx(_components.strong,{children:`Arithmetic`}),` to divide each element’s value by that\ntotal.`]}),`\n`,_jsxs(Steps,{children:[_jsx(Step,{title:`Load your model`,children:_jsxs(_components.p,{children:[`Drag `,_jsx(_components.strong,{children:`Model Viewer`}),` onto the canvas and select the project and model. Apply any page-level\nfilters you want the “whole” to respect.`]})}),_jsx(Step,{title:`Create an Aggregate field for the total`,children:_jsxs(_components.p,{children:[`Open `,_jsx(_components.strong,{children:`Calculated Fields`}),`, click `,_jsx(_components.strong,{children:`New calculated field`}),`, and choose `,_jsx(_components.strong,{children:`Aggregate`}),`. Pick the\nnumber property (for example area), choose `,_jsx(_components.strong,{children:`Sum`}),` (or another operation), and set the\npopulation: `,_jsx(_components.strong,{children:`All data`}),` for a fixed project total, or `,_jsx(_components.strong,{children:`Current view`}),` if the total should\nfollow dashboard filters. Save and keep the field on this dashboard.`]})}),_jsx(Step,{title:`Create an Arithmetic field for the share`,children:_jsxs(_components.p,{children:[`Create another calculated field and choose `,_jsx(_components.strong,{children:`Arithmetic`}),`. Write a formula such as `,_jsx(_components.code,{children:`a / b`}),` (or\n`,_jsx(_components.code,{children:`(a / b) * 100`}),` for a percentage). Bind `,_jsx(_components.code,{children:`a`}),` to the element property and `,_jsx(_components.code,{children:`b`}),` to your Aggregate\nfield. Save.`]})}),_jsx(Step,{title:`Show the share in a table or chart`,children:_jsxs(_components.p,{children:[`Add `,_jsx(_components.strong,{children:`Elements table`}),` or a chart widget and pick the Arithmetic field as a column or value. You\ncan also filter or colour by it.`]})})]}),`\n`,_jsx(_components.p,{children:`Outcome: Each element has a share of the chosen total, without changing the model. The\nAggregate value is the same on every element — that is expected; the Arithmetic field\nis what varies per element.`}),`\n`,_jsx(Tip,{children:_jsxs(_components.p,{children:[`Use Aggregate + Arithmetic for shares. An `,_jsx(_components.strong,{children:`All data`}),` or `,_jsx(_components.strong,{children:`Current view`}),` Aggregate field in a\n`,_jsx(_components.strong,{children:`Ratio`}),` widget can inflate the result. See `,_jsx(_components.a,{href:`/analytics/dashboards/calculated-fields#things-to-watch-out-for`,children:`Things to watch out\nfor`}),`.`]})}),`\n`,_jsxs(_components.p,{children:[`For comparisons between two models, use `,_jsx(_components.a,{href:`/analytics/dashboards/calculated-fields#dashboard-constants`,children:`Dashboard constants`}),`.\nTo correct area units, create a `,_jsx(_components.strong,{children:`Unit conversion`}),` field and use it in both calculations.`]}),`\n`,_jsx(Heading,{level:`2`,id:`compare-totals-from-two-models`,children:`Compare totals from two models`}),`\n`,_jsxs(_components.p,{children:[_jsx(_components.strong,{children:`When to use:`}),` You want one intensity figure that mixes two models — for example power\nload per square metre of IT room, desks per floor area, or people per workplace — and\nyou want that figure to remain fixed when someone filters the charts.`]}),`\n`,_jsxs(_components.p,{children:[`This uses `,_jsx(_components.a,{href:`/analytics/dashboards/calculated-fields#dashboard-constants`,children:`dashboard constants`}),`\nin `,_jsx(_components.strong,{children:`Calculated Fields`}),` (Aggregate → `,_jsx(_components.strong,{children:`Population`}),` → `,_jsx(_components.strong,{children:`Dashboard constant`}),`).`]}),`\n`,_jsxs(Steps,{children:[_jsx(Step,{title:`Load both models`,children:_jsx(_components.p,{children:`Add a Model Viewer for each model so both appear on the dashboard — for example an equipment or\nrack model and a rooms or architecture model.`})}),_jsx(Step,{title:`Create the comparison constants`,children:_jsxs(_components.p,{children:[`Open `,_jsx(_components.strong,{children:`Calculated Fields`}),`, create an `,_jsx(_components.strong,{children:`Aggregate`}),` field, and set `,_jsx(_components.strong,{children:`Population`}),` to `,_jsx(_components.strong,{children:`Dashboard\nconstant`}),`. Example: Sum of rack IT load from one model, and Sum of IT room area from the other.\nPick a property that belongs to the model you mean, so the other model does not get mixed in by\naccident.`]})}),_jsx(Step,{title:`Show the comparison`,children:_jsxs(_components.p,{children:[`Add a `,_jsx(_components.strong,{children:`Ratio Value`}),` widget and pick those two constants as the two sides of the ratio (load ÷\narea). Or create an `,_jsx(_components.strong,{children:`Arithmetic`}),` field that only uses those constants (for example `,_jsx(_components.code,{children:`a / b`}),`).`]})})]}),`\n`,_jsxs(_components.p,{children:[`Outcome: One clear intensity figure such as load per m². It does not change when\npeople filter the dashboard. For limits and safer Ratio patterns, see\n`,_jsx(_components.a,{href:`/analytics/dashboards/calculated-fields#dashboard-constants`,children:`Dashboard constants`}),`.`]}),`\n`,_jsx(Heading,{level:`2`,id:`compare-two-versions-of-the-same-model`,children:`Compare two versions of the same model`}),`\n`,_jsxs(_components.p,{children:[_jsx(_components.strong,{children:`When to use:`}),` You want to see what changed between two versions (e.g. before/after a design round).`]}),`\n`,_jsxs(Steps,{children:[_jsx(Step,{title:`Load both model versions`,children:_jsxs(_components.p,{children:[`Add a `,_jsx(_components.strong,{children:`Dual viewer`}),` and load both versions (first model / second model), or add two `,_jsx(_components.strong,{children:`Model\nViewer`}),` widgets and select the same project/model with different versions (pin each to a\nversion).`]})}),_jsx(Step,{title:`Add widgets that support Compare mode`,children:_jsxs(_components.p,{children:[`Add `,_jsx(_components.strong,{children:`Element count`}),` or `,_jsx(_components.strong,{children:`Total property value`}),` (or `,_jsx(_components.strong,{children:`Count by property`}),`). In the widget’s\ndata source setting, select both viewers and choose `,_jsx(_components.strong,{children:`Compare`}),` mode.`]})}),_jsx(Step,{title:`Synchronize the cameras`,children:_jsxs(_components.p,{children:[`If you have two viewers side by side, turn on `,_jsx(_components.strong,{children:`Sync camera`}),` in each viewer’s sidebar so\npan/zoom stays aligned.`]})})]}),`\n`,_jsx(_components.p,{children:`Outcome: Side-by-side or compared counts and totals so you can see what changed between versions.`}),`\n`,_jsx(Heading,{level:`2`,id:`show-a-site-model-while-analyzing-design-options`,children:`Show a site model while analyzing design options`}),`\n`,_jsxs(_components.p,{children:[_jsx(_components.strong,{children:`When to use:`}),` You want a site or existing-conditions model visible in the 3D view while charts and tables\ntabulate only your design schemes (for example several Grasshopper-generated options).`]}),`\n`,_jsxs(Steps,{children:[_jsx(Step,{title:`Load the site and design schemes`,children:_jsxs(_components.p,{children:[`Drag `,_jsx(_components.strong,{children:`Model Viewer`}),` onto the canvas. Load your site model, then use `,_jsx(_components.strong,{children:`Add model`}),` in the\nsidebar `,_jsx(_components.strong,{children:`Models`}),` panel to add each design scheme.`]})}),_jsx(Step,{title:`Mark the site as a context model`,children:_jsxs(_components.p,{children:[`Open the `,_jsx(_components.strong,{children:`⋯`}),` menu on the site model row and choose `,_jsx(_components.strong,{children:`Use as context model`}),`. The site stays\nvisible when you filter the schemes in the viewer.`]})}),_jsx(Step,{title:`Connect widgets to design schemes`,children:_jsxs(_components.p,{children:[`Add charts or tables (for example `,_jsx(_components.strong,{children:`Element count`}),` or `,_jsx(_components.strong,{children:`Count by property`}),`). In each widget’s\ndata source setting, select only the design scheme data sources—not the site model.`]})}),_jsx(Step,{title:`Filter and compare schemes on the canvas`,children:_jsx(_components.p,{children:`Click values in charts to add page-level filters. The site model remains fully visible in the\nviewer while filters isolate objects in your schemes.`})})]}),`\n`,_jsx(_components.p,{children:`Outcome: Site geometry for spatial context in the 3D view; counts and breakdowns driven only by the schemes you\nconnect to analysis widgets.`}),`\n`,_jsx(Heading,{level:`2`,id:`perform-portfolio-analysis`,children:`Perform portfolio analysis`}),`\n`,_jsxs(_components.p,{children:[_jsx(_components.strong,{children:`When to use:`}),` Multiple projects or models; you want combined totals or differences across them.`]}),`\n`,_jsxs(Steps,{children:[_jsx(Step,{title:`Load the projects or models`,children:_jsxs(_components.p,{children:[`Add a `,_jsx(_components.strong,{children:`Model Viewer`}),` for each project (or key model) and select project/model for each.`]})}),_jsx(Step,{title:`Add widgets that support multiple data sources`,children:_jsxs(_components.p,{children:[`Add `,_jsx(_components.strong,{children:`Element count`}),` or `,_jsx(_components.strong,{children:`Count by property`}),` and connect them to several viewers (use the\nwidget’s data source setting).`]})}),_jsx(Step,{title:`Choose Aggregate or Compare mode`,children:_jsxs(_components.p,{children:[`Use `,_jsx(_components.strong,{children:`Aggregate`}),` mode to see combined totals across models; use `,_jsx(_components.strong,{children:`Compare`}),` mode to see\ndifferences.`]})}),_jsx(Step,{title:`Group widgets with sections`,children:_jsxs(_components.p,{children:[`Add `,_jsx(_components.strong,{children:`Section`}),` widgets to group areas (e.g. by project or by metric).`]})}),_jsx(Step,{title:`Share the dashboard`,children:_jsxs(_components.p,{children:[`Share via `,_jsx(_components.a,{href:`/workspaces/roles-and-seats`,children:`workspace access`}),`. Stakeholders see the same layout and\ndata.`]})})]}),`\n`,_jsx(_components.p,{children:`Outcome: One dashboard for portfolio-level counts and comparisons; stakeholders see the same view.`}),`\n`,_jsx(Tip,{children:_jsxs(_components.p,{children:[`If you want to compare one project against a benchmark library rather than watch several live\nprojects at once, see `,_jsx(_components.a,{href:`/workflows/benchmark-against-your-portfolio`,children:`Benchmark a project against your portfolio with Speckle\nIntelligence`}),`.`]})}),`\n`,_jsx(Heading,{level:`2`,id:`run-a-quick-validation-check`,children:`Run a quick validation check`}),`\n`,_jsxs(_components.p,{children:[_jsx(_components.strong,{children:`When to use:`}),` You want to check one or more properties against a rule (e.g. “doors must have fire rating”) and see\npass/fail in the dashboard.`]}),`\n`,_jsxs(Steps,{children:[_jsx(Step,{title:`Load your model`,children:_jsxs(_components.p,{children:[`Drag `,_jsx(_components.strong,{children:`Model Viewer`}),` onto the canvas and select project and model.`]})}),_jsx(Step,{title:`Add Property checker`,children:_jsxs(_components.p,{children:[`Drag `,_jsx(_components.strong,{children:`Property checker`}),` from the Basics group. In the widget settings, choose the property and\ndefine the rule (e.g. “exists”, “equals”, “matches pattern”).`]})}),_jsx(Step,{title:`View results and colorize the model`,children:_jsx(_components.p,{children:`The widget shows pass/fail counts. Use the widget option to colorize the 3D viewer so you can\nsee which elements pass or fail.`})}),_jsx(Step,{title:`Add more rules`,children:_jsxs(_components.p,{children:[`For several rules that run on every new version, author a Data Validation check instead. See\n`,_jsx(_components.a,{href:`/analytics/data-validation/overview`,children:`Data Validation`}),`.`]})})]}),`\n`,_jsx(_components.p,{children:`Outcome: Pass/fail view for one property in the dashboard, with optional colorization in the\nviewer.`}),`\n`,_jsx(Heading,{level:`2`,id:`find-models-that-use-a-specific-family-or-type`,children:`Find models that use a specific family or type`}),`\n`,_jsxs(_components.p,{children:[_jsx(_components.strong,{children:`When to use:`}),` You need to identify which models or elements use a given family (or category/type) so you can fix\nor flag them (e.g. auditing families, pre-upgrade checks).`]}),`\n`,_jsxs(Steps,{children:[_jsx(Step,{title:`Add a model breakdown widget`,children:_jsxs(_components.p,{children:[`Load the model(s). Use `,_jsx(_components.strong,{children:`Model structure`}),` or `,_jsx(_components.strong,{children:`Families`}),` (Revit) or `,_jsx(_components.strong,{children:`Count by property`}),` to\nsee family/category/type.`]})}),_jsx(Step,{title:`Search or filter by family name`,children:_jsx(_components.p,{children:`Use the widget to search or filter by family name (or category/type).`})}),_jsx(Step,{title:`Use Matches pattern in a filter`,children:_jsxs(_components.p,{children:[`Add a filter with `,_jsx(_components.strong,{children:`Matches pattern`}),` (e.g. family name `,_jsx(_components.code,{children:`*ProblemFamily*`}),` or `,_jsx(_components.code,{children:`%ProblemFamily%`}),`)\nto find matches.`]})}),_jsx(Step,{title:`Save a reusable validation rule`,children:_jsxs(_components.p,{children:[`To flag this family in future, add `,_jsx(_components.strong,{children:`Property checker`}),` and define a rule, or author a Data\nValidation check. See `,_jsx(_components.a,{href:`/analytics/data-validation/overview`,children:`Data Validation`}),`.`]})}),_jsx(Step,{title:`Pin the model version`,children:`Pin the model version so the result is reproducible.`})]}),`\n`,_jsx(_components.p,{children:`Outcome: List or count of models/elements using that family; path to validation if you want rules.`}),`\n`,_jsx(Heading,{level:`2`,id:`turn-model-codes-into-clear-labels-for-charts`,children:`Turn model codes into clear labels for charts`}),`\n`,_jsxs(_components.p,{children:[_jsx(_components.strong,{children:`When to use:`}),` The model stores short codes (classification, type, zone, and similar),\nand you have a spreadsheet that maps each code to a clearer name. You want charts,\nfilters, and colour-by in plain language — without changing the published model.`]}),`\n`,_jsxs(_components.p,{children:[`This workflow uses `,_jsx(_components.a,{href:`/analytics/dashboards/lookup-tables`,children:`Lookup tables`}),` and a\n`,_jsx(_components.a,{href:`/analytics/dashboards/calculated-fields`,children:`Calculated fields`}),` `,_jsx(_components.strong,{children:`Map lookup`}),`. If you only\nneed maths, unit changes, or simple groups (and no spreadsheet), skip the table and\ncreate a calculated field of another type instead.`]}),`\n`,_jsxs(Steps,{children:[_jsx(Step,{title:`Load your model`,children:_jsxs(_components.p,{children:[`Drag `,_jsx(_components.strong,{children:`Model Viewer`}),` onto the canvas and select the project and model.`]})}),_jsx(Step,{title:`Create a Map lookup calculated field`,children:_jsxs(_components.p,{children:[`Open `,_jsx(_components.strong,{children:`Calculated Fields`}),`, click `,_jsx(_components.strong,{children:`New calculated field`}),`, and choose `,_jsx(_components.strong,{children:`Map lookup`}),`. Pick the\nmodel property that holds the code. Import your CSV or Excel list from the dialog (`,_jsx(_components.strong,{children:`Import new\ntable`}),` if tables already exist), or choose a table you already imported. Set the match column,\nthe return column, and a fallback for codes not in the list. Save the field and make sure it is\non this dashboard.`]})}),_jsx(Step,{title:`Chart or list by the new label`,children:_jsxs(_components.p,{children:[`Add `,_jsx(_components.strong,{children:`Count by property`}),`, `,_jsx(_components.strong,{children:`Total value by property`}),`, or `,_jsx(_components.strong,{children:`Elements table`}),`. In the widget\nsettings, pick your calculated field instead of the raw code property.`]})}),_jsx(Step,{title:`Filter or colour the model`,children:_jsx(_components.p,{children:`Use the calculated field in a filter, or colour the viewer by it, so stakeholders see the\nfriendly labels rather than the codes.`})}),_jsx(Step,{title:`Add further calculated fields`,children:_jsxs(_components.p,{children:[`Need areas in another unit for filters or further maths? Add a `,_jsx(_components.strong,{children:`Unit conversion`}),` field, then\nbuild on it. For chart labels only, use widget `,_jsx(_components.strong,{children:`Display unit`}),` instead (see `,_jsx(_components.a,{href:`/analytics/intelligence-dashboards#aggregation-and-numeric-display`,children:`Aggregation and\nnumeric display`}),`). Need\npass/fail-style labels for a table column? Add a `,_jsx(_components.strong,{children:`Logical`}),` field. See `,_jsx(_components.a,{href:`/analytics/dashboards/calculated-fields`,children:`Calculated\nfields`}),`.`]})})]}),`\n`,_jsx(_components.p,{children:`Outcome: Charts and filters use clear labels from your list; the model itself is\nunchanged. Update the lookup table later when the list changes — fields that use it\npick up the new rows when the dashboard reloads the data.`}),`\n`,_jsx(Heading,{level:`2`,id:`present-a-dashboard-to-a-client`,children:`Present a dashboard to a client`}),`\n`,_jsxs(_components.p,{children:[_jsx(_components.strong,{children:`When to use:`}),` You want to share a read-only view or embed the dashboard in a presentation (e.g. Notion, Miro).`]}),`\n`,_jsxs(Steps,{children:[_jsx(Step,{title:`Arrange the layout and apply a theme`,children:_jsxs(_components.p,{children:[`Resize and reorder widgets; add `,_jsx(_components.strong,{children:`Section`}),` widgets to group content. In the `,_jsx(_components.strong,{children:`Themes`}),` panel,\npick a built-in or custom theme so chart and validation colors stay consistent. See\n`,_jsx(_components.a,{href:`/analytics/dashboards/layout#themes`,children:`Layout`}),` for scopes and editing.`]})}),_jsx(Step,{title:`Use the view link`,children:_jsxs(_components.p,{children:[`Share the dashboard `,_jsx(_components.strong,{children:`view`}),` link (not the edit URL). Recipients always open in `,_jsx(_components.strong,{children:`presentation\nmode`}),` — view mode and shared mode are the same read-only experience. See\n`,_jsx(_components.a,{href:`/analytics/dashboards/sharing`,children:`Sharing`}),` for share links and presentation mode.`]})}),_jsx(Step,{title:`Embed the dashboard`,children:_jsxs(_components.p,{children:[`You can embed dashboards in Notion, Miro, and other tools. For step-by-step guides, see\n`,_jsx(_components.a,{href:`https://speckle.systems/tutorials`,children:`Tutorials`}),` (filter by `,_jsx(_components.strong,{children:`Dashboards \u0026 Insights`}),`).`]})})]}),`\n`,_jsx(_components.p,{children:`Outcome: A shareable or embeddable dashboard in presentation mode, with a clear layout\nand theme.`}),`\n`,_jsx(Heading,{level:`2`,id:`show-your-model-on-a-map-with-context`,children:`Show your model on a map with Context`}),`\n`,_jsxs(_components.p,{children:[_jsx(_components.strong,{children:`When to use:`}),` You want to place a Speckle model on a pitched 3D map at a real-world site.\nModels do not need geographic metadata.`]}),`\n`,_jsxs(_components.p,{children:[_jsx(_components.strong,{children:`Context`}),` is the widget that draws Speckle geometry on OpenFreeMap at the dashboard site\nlocation. It is not the same as marking a model as a\n`,_jsx(_components.a,{href:`/analytics/intelligence-dashboards#context-models`,children:`context model`}),` in the Model Viewer.`]}),`\n`,_jsx(Note,{children:`Context is experimental and is not in the widget panel for every workspace.`}),`\n`,_jsx(Note,{children:_jsxs(_components.p,{children:[`This workflow adds a Model Viewer, Context, and optionally Map to the same dashboard — each uses\none or more browser rendering contexts. On a dashboard that already has several viewer or map\nwidgets, you can hit your browser’s limit. See `,_jsx(_components.a,{href:`/analytics/dashboards/layout#is-there-a-limit-to-how-many-3d-viewer-widgets-i-can-add`,children:`3D viewer widget\nlimit`}),`.`]})}),`\n`,_jsxs(Steps,{children:[_jsx(Step,{title:`Load your model`,children:_jsxs(_components.p,{children:[`Drag `,_jsx(_components.strong,{children:`Model Viewer`}),` onto the canvas and select your project and model. Context reuses geometry\nfrom an existing viewer on the dashboard when one is available.`]})}),_jsxs(Step,{title:`Add Context`,children:[`Drag `,_jsx(_components.strong,{children:`Context`}),` from the widget panel onto the canvas.`]}),_jsx(Step,{title:`Set the dashboard site location`,children:_jsxs(_components.p,{children:[`In the Context sidebar, open `,_jsx(_components.strong,{children:`Site`}),` and enter latitude and longitude (optional elevation and\nrotation). Select `,_jsx(_components.strong,{children:`Apply`}),` to save the placement. The site location is owned by the dashboard —\nyou do not need geographic data on the model. You can also set the site from a `,_jsx(_components.strong,{children:`Map`}),` widget;\nboth share the same site.`]})}),_jsx(Step,{title:`Add a map for location pins`,children:_jsxs(_components.p,{children:[`Drag `,_jsx(_components.strong,{children:`Map`}),` from `,_jsx(_components.strong,{children:`Presentation`}),` if you want a lighter map with location bookmarks only (no\nSpeckle geometry). Search for a place, then add, rename, or remove pins from Locations.`]})}),_jsx(Step,{title:`Tune filters, colour, and the map`,children:_jsxs(_components.p,{children:[`Use Context sidebar controls as needed: local `,_jsx(_components.strong,{children:`Filters`}),`, `,_jsx(_components.strong,{children:`Apply global filters`}),`, `,_jsx(_components.strong,{children:`Apply\ncolor by`}),`, and `,_jsx(_components.strong,{children:`Include nested objects`}),` (same idea as Model Viewer). Save a starting\nviewpoint with `,_jsx(_components.strong,{children:`Focus`}),` or Camera → Save current. Use the bulldozer control to hide basemap\nbuildings that overlap the model; set `,_jsx(_components.strong,{children:`Building clearance`}),` and optionally `,_jsx(_components.strong,{children:`Show clearance\nboundary`}),`. `,_jsx(_components.strong,{children:`Clip model to ground`}),` hides Speckle geometry below the map surface (on by\ndefault).`]})})]}),`\n`,_jsx(_components.p,{children:`Outcome: Context shows your Speckle model on a pitched 3D map at the dashboard site. Map (if\nused) shows site markers and optional pins only.`}),`\n`,_jsxs(_components.p,{children:[`The `,_jsx(_components.strong,{children:`Map`}),` widget shows site markers and location pins. Use `,_jsx(_components.strong,{children:`Context`}),` to show model geometry\non the map. The Model Viewer keeps its local coordinates. Context also saves location bookmarks\nand a starting camera position.`]}),`\n`,_jsx(Warning,{children:`Context is experimental. Avoid relying on it for production-critical dashboards.`}),`\n`,_jsx(_components.p,{children:`Map tiles require an internet connection, and OpenFreeMap attribution stays visible. Deleting a\nMap or Context widget does not clear the dashboard site location.`}),`\n`,_jsx(Heading,{level:`2`,id:`see-also`,children:`See also`}),`\n`,_jsxs(_components.ul,{children:[`\n`,_jsxs(_components.li,{children:[_jsx(_components.a,{href:`/analytics/dashboards/filters`,children:`Filters`}),` — Filter levels, operators, and colorizing the model`]}),`\n`,_jsxs(_components.li,{children:[_jsx(_components.a,{href:`/analytics/dashboards/calculated-fields`,children:`Calculated fields`}),` — Add your own values for charts, filters, and colour-by`]}),`\n`,_jsxs(_components.li,{children:[_jsx(_components.a,{href:`/analytics/dashboards/calculated-fields#dashboard-constants`,children:`Calculated fields — Dashboard constants`}),` — Stable totals and X-per-Y numbers from two models`]}),`\n`,_jsxs(_components.li,{children:[_jsx(_components.a,{href:`/analytics/dashboards/lookup-tables`,children:`Lookup tables`}),` — Import lists for Map lookup`]}),`\n`,_jsxs(_components.li,{children:[_jsx(_components.a,{href:`/analytics/dashboards/layout`,children:`Layout`}),` — Resize widgets and themes`]}),`\n`,_jsxs(_components.li,{children:[_jsx(_components.a,{href:`/analytics/dashboards/sharing`,children:`Sharing`}),` — Share links, present mode, scenarios, and\nembedding`]}),`\n`,_jsxs(_components.li,{children:[_jsx(_components.a,{href:`/analytics/dashboards/validation-widgets`,children:`Validation Widgets in Dashboards`}),` — Property checker on a dashboard`]}),`\n`,_jsxs(_components.li,{children:[_jsx(_components.a,{href:`/analytics/data-validation/overview`,children:`Data Validation`}),` — Checks that run on every new version`]}),`\n`,_jsxs(_components.li,{children:[_jsx(_components.a,{href:`/analytics/intelligence-dashboards#widget-groups-in-the-sidebar`,children:`Dashboards — Widget groups`}),` — Full Presentation widget list including Map and Context`]}),`\n`]})]})}function MDXContent(props={}){const{wrapper:MDXLayout}={..._provideComponents(),...props.components};return MDXLayout?_jsx(MDXLayout,{...props,children:_jsx(_createMdxContent,{...props})}):_createMdxContent(props)}return{default:MDXContent};function _missingMdxReference(id,component){throw new Error(`Expected `+(component?`component`:`object`)+\" `\"+id+\"` to be defined: you likely forgot to import, pass, or provide it.\")}","frontmatter":{},"scope":{"config":{},"pageMetadata":{"title":"Common workflows","sidebarTitle":"Common workflows","description":"Step-by-step guides for quantity takeoff, share of total, version comparison, validation, portfolio analysis, calculated fields, presenting to clients, and Context site maps.","href":"/analytics/dashboards/common-workflows"}}},"mdxSourceWithNoJs":null},"mdxExtracts":{"tableOfContents":[{"title":"Choose how to validate","slug":"choose-how-to-validate","depth":2,"children":[]},{"title":"Run a quantity takeoff","slug":"run-a-quantity-takeoff","depth":2,"children":[]},{"title":"Show each element as a share of the whole","slug":"show-each-element-as-a-share-of-the-whole","depth":2,"children":[]},{"title":"Compare totals from two models","slug":"compare-totals-from-two-models","depth":2,"children":[]},{"title":"Compare two versions of the same model","slug":"compare-two-versions-of-the-same-model","depth":2,"children":[]},{"title":"Show a site model while analyzing design options","slug":"show-a-site-model-while-analyzing-design-options","depth":2,"children":[]},{"title":"Perform portfolio analysis","slug":"perform-portfolio-analysis","depth":2,"children":[]},{"title":"Run a quick validation check","slug":"run-a-quick-validation-check","depth":2,"children":[]},{"title":"Find models that use a specific family or type","slug":"find-models-that-use-a-specific-family-or-type","depth":2,"children":[]},{"title":"Turn model codes into clear labels for charts","slug":"turn-model-codes-into-clear-labels-for-charts","depth":2,"children":[]},{"title":"Present a dashboard to a client","slug":"present-a-dashboard-to-a-client","depth":2,"children":[]},{"title":"Show your model on a map with Context","slug":"show-your-model-on-a-map-with-context","depth":2,"children":[]},{"title":"See also","slug":"see-also","depth":2,"children":[]}],"codeExamples":{}},"jsLinks":["/_mintlify/custom/speckle/338e4d421a1293df/.omp/extensions/atlas-sync.js"],"subdomain":"speckle","siteName":"Speckle Docs","title":"Common workflows - Speckle Docs","navMaps":{"firstHrefInVersion":{},"firstHrefInLanguage":{}},"lastModified":"2026-11-14T22:05:06.628Z","gitLastModified":"2026-11-14T22:04:48.000Z","originalFileLocation":"analytics/dashboards/common-workflows.mdx"},"headHtml":"\u003cscript data-mint-head>(function(){var d=document.documentElement,p=null;if(!p){try{p=localStorage.getItem(\"isDarkMode\")}catch(e){}if(p==='true')p='dark';else if(p==='false')p='light';if(p!=='light'\u0026\u0026p!=='dark'\u0026\u0026p!=='system')p=\"system\"}var r=p==='system'?(matchMedia(\"(prefers-color-scheme: dark)\").matches?'dark':'light'):p;d.classList.remove(r==='dark'?'light':'dark');d.classList.add(r);d.setAttribute(\"data-theme-preference\",p)})();\u003c/script>\u003cmeta data-mint-head name=\"description\" content=\"Step-by-step guides for quantity takeoff, share of total, version comparison, validation, portfolio analysis, calculated fields, presenting to clients, and Context site maps.\">\u003cmeta data-mint-head name=\"application-name\" content=\"Speckle Docs\">\u003cmeta data-mint-head name=\"generator\" content=\"Mintlify\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"192x192\" href=\"/mintlify-assets/_mintlify/favicons/speckle/f7DEGxLA7h3Bcgui/_generated/favicon/android-chrome-192x192.png\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"apple-touch-icon\" type=\"image/png\" sizes=\"180x180\" href=\"/mintlify-assets/_mintlify/favicons/speckle/f7DEGxLA7h3Bcgui/_generated/favicon/apple-touch-icon.png\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"16x16\" href=\"/mintlify-assets/_mintlify/favicons/speckle/f7DEGxLA7h3Bcgui/_generated/favicon/favicon-16x16.png\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"32x32\" href=\"/mintlify-assets/_mintlify/favicons/speckle/f7DEGxLA7h3Bcgui/_generated/favicon/favicon-32x32.png\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"shortcut icon\" type=\"image/x-icon\" href=\"/mintlify-assets/_mintlify/favicons/speckle/f7DEGxLA7h3Bcgui/_generated/favicon/favicon.ico\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"192x192\" href=\"/mintlify-assets/_mintlify/favicons/speckle/f7DEGxLA7h3Bcgui/_generated/favicon-dark/android-chrome-192x192.png\" media=\"(prefers-color-scheme: dark)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"16x16\" href=\"/mintlify-assets/_mintlify/favicons/speckle/f7DEGxLA7h3Bcgui/_generated/favicon-dark/favicon-16x16.png\" media=\"(prefers-color-scheme: dark)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"32x32\" href=\"/mintlify-assets/_mintlify/favicons/speckle/f7DEGxLA7h3Bcgui/_generated/favicon-dark/favicon-32x32.png\" media=\"(prefers-color-scheme: dark)\">\u003clink data-mint-head rel=\"shortcut icon\" type=\"image/x-icon\" href=\"/mintlify-assets/_mintlify/favicons/speckle/f7DEGxLA7h3Bcgui/_generated/favicon-dark/favicon.ico\" media=\"(prefers-color-scheme: dark)\">\u003cmeta data-mint-head property=\"og:title\" content=\"Common workflows - Speckle Docs\">\u003cmeta data-mint-head property=\"og:description\" content=\"Step-by-step guides for quantity takeoff, share of total, version comparison, validation, portfolio analysis, calculated fields, presenting to clients, and Context site maps.\">\u003cmeta data-mint-head property=\"og:site_name\" content=\"Speckle Docs\">\u003cmeta data-mint-head property=\"og:url\" content=\"https://docs.speckle.systems/analytics/dashboards/common-workflows\">\u003cmeta data-mint-head property=\"og:type\" content=\"website\">\u003cmeta data-mint-head property=\"og:image\" content=\"https://speckle.mintlify.site/_mintlify/api/og/v2?division=Dashboards\u0026amp;title=Common+workflows\u0026amp;description=Step-by-step+guides+for+quantity+takeoff%2C+share+of+total%2C+version+comparison%2C+validation%2C+portfolio+analysis%2C+calculated+fields%2C+presenting+to+clients%2C+and+Cont\u0026amp;theme=3e6fae5609aa483790e4f77c\u0026amp;signature=222212395900fd080d405a6fe8f3f944903883a63082c37aa09ab983a2e13925\">\u003cmeta data-mint-head property=\"og:image:width\" content=\"1200\">\u003cmeta data-mint-head property=\"og:image:height\" content=\"630\">\u003cmeta data-mint-head name=\"twitter:card\" content=\"summary_large_image\">\u003cmeta data-mint-head name=\"twitter:title\" content=\"Common workflows - Speckle Docs\">\u003cmeta data-mint-head name=\"twitter:description\" content=\"Step-by-step guides for quantity takeoff, share of total, version comparison, validation, portfolio analysis, calculated fields, presenting to clients, and Context site maps.\">\u003cmeta data-mint-head name=\"twitter:image\" content=\"https://speckle.mintlify.site/_mintlify/api/og/v2?division=Dashboards\u0026amp;title=Common+workflows\u0026amp;description=Step-by-step+guides+for+quantity+takeoff%2C+share+of+total%2C+version+comparison%2C+validation%2C+portfolio+analysis%2C+calculated+fields%2C+presenting+to+clients%2C+and+Cont\u0026amp;theme=3e6fae5609aa483790e4f77c\u0026amp;signature=222212395900fd080d405a6fe8f3f944903883a63082c37aa09ab983a2e13925\">\u003cmeta data-mint-head name=\"twitter:image:width\" content=\"1200\">\u003cmeta data-mint-head name=\"twitter:image:height\" content=\"630\">\u003cmeta data-mint-head name=\"msapplication-config\" content=\"/mintlify-assets/_mintlify/favicons/speckle/f7DEGxLA7h3Bcgui/_generated/favicon/browserconfig.xml\">\u003cmeta data-mint-head name=\"apple-mobile-web-app-title\" content=\"Speckle Docs\">\u003cmeta data-mint-head name=\"msapplication-TileColor\" content=\"#155DFC\">\u003clink data-mint-head rel=\"canonical\" href=\"https://docs.speckle.systems/analytics/dashboards/common-workflows\">\u003clink data-mint-head rel=\"alternate\" type=\"application/xml\" href=\"/sitemap.xml\">\u003clink data-mint-head rel=\"alternate\" type=\"text/markdown\" href=\"/analytics/dashboards/common-workflows.md\">\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@graph\":[{\"@type\":\"Organization\",\"@id\":\"https://docs.speckle.systems/#organization\",\"name\":\"Speckle Docs\",\"url\":\"https://docs.speckle.systems\",\"logo\":{\"@type\":\"ImageObject\",\"url\":\"https://mintcdn.com/speckle/8FGkkbZZbcuHzOBq/logo/light.svg?fit=max\u0026auto=format\u0026n=8FGkkbZZbcuHzOBq\u0026q=85\u0026s=9fc87cac252fa8cc443a9828ecbace70\"}},{\"@type\":\"WebSite\",\"@id\":\"https://docs.speckle.systems#website\",\"name\":\"Speckle Docs\",\"url\":\"https://docs.speckle.systems\",\"publisher\":{\"@id\":\"https://docs.speckle.systems/#organization\"}},{\"@type\":\"WebPage\",\"@id\":\"https://docs.speckle.systems/analytics/dashboards/common-workflows#webpage\",\"url\":\"https://docs.speckle.systems/analytics/dashboards/common-workflows\",\"name\":\"Common workflows\",\"description\":\"Step-by-step guides for quantity takeoff, share of total, version comparison, validation, portfolio analysis, calculated fields, presenting to clients, and Context site maps.\",\"dateModified\":\"2026-11-14T22:04:48.000Z\",\"isPartOf\":{\"@id\":\"https://docs.speckle.systems#website\"},\"breadcrumb\":{\"@id\":\"https://docs.speckle.systems/analytics/dashboards/common-workflows#breadcrumb\"}},{\"@type\":\"BreadcrumbList\",\"@id\":\"https://docs.speckle.systems/analytics/dashboards/common-workflows#breadcrumb\",\"itemListElement\":[{\"@type\":\"ListItem\",\"position\":1,\"name\":\"Analytics \u0026 Intelligence\",\"item\":\"https://docs.speckle.systems/analytics/intelligence\"},{\"@type\":\"ListItem\",\"position\":2,\"name\":\"Dashboards\",\"item\":\"https://docs.speckle.systems/analytics/intelligence-dashboards\"},{\"@type\":\"ListItem\",\"position\":3,\"name\":\"Common workflows\",\"item\":\"https://docs.speckle.systems/analytics/dashboards/common-workflows\"}]},{\"@type\":[\"Article\",\"TechArticle\"],\"@id\":\"https://docs.speckle.systems/analytics/dashboards/common-workflows#article\",\"headline\":\"Common workflows\",\"name\":\"Common workflows\",\"description\":\"Step-by-step guides for quantity takeoff, share of total, version comparison, validation, portfolio analysis, calculated fields, presenting to clients, and Context site maps.\",\"url\":\"https://docs.speckle.systems/analytics/dashboards/common-workflows\",\"mainEntityOfPage\":{\"@id\":\"https://docs.speckle.systems/analytics/dashboards/common-workflows#webpage\"},\"dateModified\":\"2026-11-14T22:04:48.000Z\",\"publisher\":{\"@id\":\"https://docs.speckle.systems/#organization\"},\"isPartOf\":{\"@id\":\"https://docs.speckle.systems#website\"}}]}\u003c/script>\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@type\":\"WebSite\",\"name\":\"Speckle Docs\",\"publisher\":{\"@type\":\"Organization\",\"name\":\"Speckle Docs\"},\"provider\":{\"@type\":\"Organization\",\"name\":\"Mintlify\",\"url\":\"https://mintlify.com\"}}\u003c/script>","agentPointerHref":"/analytics/dashboards/common-workflows.md","siteName":"Speckle Docs","nav":{"global":null,"dropdowns":[{"dropdown":"User Guides","icon":"book-open","groups":[{"group":"Quick Reference","pages":[{"title":"Welcome to Speckle","sidebarTitle":"Welcome","href":"/quickstart/welcome"},{"title":"Speckle's new data model: what has changed for you","sidebarTitle":"Data model migration","href":"/workspaces/data-model-migration"},{"title":"Quickstart Guide","href":"/quickstart/quickstart"},{"title":"Frequently Asked Questions","href":"/quickstart/faq"},{"title":"What's new in 2026.9 for workspace users","sidebarTitle":"What's new","href":"/whats-new/users"}]},{"group":"Your Speckle Workspace","pages":[{"title":"Organize teams and projects","sidebarTitle":"Overview","href":"/workspaces/introduction"},{"group":"Projects, Models, and Versions","pages":[{"title":"Projects","href":"/workspaces/projects"},{"title":"Models","href":"/workspaces/models"},{"title":"Version Control","href":"/workspaces/versions"}]},{"group":"Access and Identity","pages":[{"title":"Roles and permissions","href":"/workspaces/roles-and-seats"},{"title":"Invite to Workspace","href":"/workspaces/inviting"},{"title":"Workspace Discoverability","href":"/workspaces/workspace-discoverability"},{"title":"Domain Protection","href":"/workspaces/domain-protection"},{"title":"Single Sign-On (SSO)","tag":"Enterprise","href":"/workspaces/sso"},{"title":"User provisioning (SCIM)","sidebarTitle":"Provisioning (SCIM)","tag":"Enterprise","href":"/workspaces/scim"}]},{"group":"Plans and Governance","pages":[{"title":"Plans and Governance","sidebarTitle":"Overview","href":"/workspaces/plans-and-governance"},{"title":"Billing","href":"/workspaces/billing"},{"title":"Data Residency","tag":"Enterprise","href":"/workspaces/data-residency"}]},{"group":"Configuration","pages":[{"title":"Configuration","href":"/workspaces/configuration"},{"title":"Check workspace activity, plan limits, and AI spend","sidebarTitle":"Usage","href":"/workspaces/usage"},{"title":"Project metadata","tag":"Enterprise","href":"/workspaces/configuration/project-metadata"}]}]},{"group":"Viewing \u0026 Sharing","pages":[{"title":"Open and explore models in the 3D viewer","sidebarTitle":"Overview","href":"/3d-viewer/introduction"},{"title":"Interface and navigation","href":"/3d-viewer/interface-nav"},{"group":"Inspect and Compare","pages":[{"title":"Filter, browse, and measure your model","sidebarTitle":"Exploration","href":"/3d-viewer/exploration"},{"title":"Compare versions","href":"/3d-viewer/compare-versions"},{"title":"Combine models in one scene","sidebarTitle":"Model federation","href":"/3d-viewer/federation"}]},{"group":"Feedback and Tracking","pages":[{"title":"Issues","href":"/3d-viewer/issues"},{"title":"Sketch on your model","sidebarTitle":"Sketch","href":"/3d-viewer/markups"},{"title":"Saved views","href":"/3d-viewer/saved-views"}]},{"group":"Present and Share","pages":[{"title":"Present a model with saved views","sidebarTitle":"Presentation","href":"/3d-viewer/presentation"},{"title":"Share your models","href":"/3d-viewer/sharing"}]}]},{"group":"Publishing \u0026 Loading","pages":[{"title":"Connectors, cloud integrations, and file uploads","sidebarTitle":"Overview","href":"/connectors/overview"},{"group":"Connectors","pages":[{"title":"Installing Connectors","href":"/connectors/installation"},{"title":"Connector Assets \u0026 Templates","sidebarTitle":"Assets \u0026 Templates","href":"/connectors/assets"},{"group":"Revit","pages":[{"title":"How to use Speckle for Revit","sidebarTitle":"Quickstart","href":"/connectors/revit/revit"},{"title":"Loading blocks as families in Revit","sidebarTitle":"Blocks as Families","href":"/connectors/revit/blocks-to-families"},{"title":"Linked Revit models","href":"/connectors/revit/linked-models"}]},{"group":"Rhino","pages":[{"title":"How to use Speckle for Rhino","sidebarTitle":"Quickstart","href":"/connectors/rhino/rhino"},{"title":"Revit Categorization","href":"/connectors/rhino/rhino-revit"},{"title":"RhinoInside","sidebarTitle":"RhinoInside","href":"/connectors/grasshopper/grasshopper-integrations"}]},{"group":"Grasshopper","pages":[{"title":"How to use Speckle for Grasshopper","sidebarTitle":"Quickstart","href":"/connectors/grasshopper/grasshopper"},{"title":"Explore what an object is connected to","sidebarTitle":"Explore","href":"/connectors/grasshopper/explore"},{"title":"Models","href":"/connectors/grasshopper/grasshopper-models"},{"title":"Collections","href":"/connectors/grasshopper/grasshopper-collections"},{"title":"Objects","href":"/connectors/grasshopper/grasshopper-objects"},{"title":"Properties","href":"/connectors/grasshopper/grasshopper-properties"},{"title":"Developer Nodes","href":"/connectors/grasshopper/grasshopper-developer"},{"title":"Recommendations","href":"/connectors/grasshopper/grasshopper-recommendations"},{"title":"Karamba3D","sidebarTitle":"Karamba3D","tag":"Third-Party","href":"/connectors/third-party/karamba3d"},{"title":"ShapeDiver","sidebarTitle":"ShapeDiver","tag":"Third-Party","href":"/connectors/third-party/shapediver"}]},{"title":"How to use Speckle for SketchUp","sidebarTitle":"SketchUp","href":"/connectors/sketchup"},{"group":"Power BI","pages":[{"title":"How to use Speckle for Power BI","sidebarTitle":"Quickstart","href":"/connectors/power-bi/power-bi"},{"title":"Power BI Data Gateway","sidebarTitle":"Data Gateway","href":"/connectors/power-bi/gateway"}]},{"title":"How to use Speckle for Archicad","sidebarTitle":"Archicad","href":"/connectors/archicad"},{"title":"Publish Navisworks models to Speckle","sidebarTitle":"Navisworks","href":"/connectors/navisworks"},{"title":"How to use Speckle for Blender","sidebarTitle":"Blender","href":"/connectors/blender"},{"title":"How to use Speckle for Civil 3D","sidebarTitle":"Civil 3D","href":"/connectors/civil3d"},{"title":"How to use Speckle for Plant 3D","sidebarTitle":"Plant 3D","href":"/connectors/plant3d"},{"title":"How to use Speckle for AutoCAD","sidebarTitle":"AutoCAD","href":"/connectors/autocad"},{"title":"How to use Speckle for ETABS","sidebarTitle":"ETABS","href":"/connectors/etabs"},{"title":"How to use Speckle for Tekla Structures","sidebarTitle":"Tekla Structures","href":"/connectors/teklastructures"},{"title":"How to use Speckle for Vectorworks","sidebarTitle":"Vectorworks","tag":"Third-Party","href":"/connectors/third-party/vectorworks"}]},{"group":"Cloud Integrations","pages":[{"title":"Autodesk Forma Data Management","sidebarTitle":"Forma Data Management (ACC)","tag":"Enterprise","href":"/connectors/cloud-integrations/acc"},{"title":"Sync models from Trimble Connect","sidebarTitle":"Trimble Connect","tag":"Enterprise","href":"/connectors/cloud-integrations/trimble-connect"},{"title":"Sync models from SharePoint","sidebarTitle":"SharePoint","href":"/connectors/cloud-integrations/sharepoint"},{"title":"Bentley ProjectWise","sidebarTitle":"Bentley ProjectWise","tag":"Enterprise","href":"/connectors/cloud-integrations/projectwise"},{"title":"Databricks","sidebarTitle":"Databricks","href":"/connectors/cloud-integrations/databricks"},{"title":"Snowflake","sidebarTitle":"Snowflake","href":"/connectors/cloud-integrations/snowflake"}]},{"title":"Direct uploads","href":"/connectors/direct-uploads/introduction"}]},{"group":"Analytics \u0026 Intelligence","pages":[{"group":"Intelligence","pages":[{"title":"Ask questions about your models with Speckle Intelligence","sidebarTitle":"Speckle Intelligence","href":"/analytics/intelligence"},{"title":"Reuse organisation playbooks with Intelligence skills","sidebarTitle":"Skills","href":"/analytics/intelligence-skills"},{"title":"Set standing AI Rules for the workspace","sidebarTitle":"AI Rules","href":"/analytics/intelligence-rules"},{"title":"Create and share Intelligence Reports","sidebarTitle":"Reports","href":"/analytics/reports"}]},{"group":"Dashboards","pages":[{"title":"Intelligence Dashboards","sidebarTitle":"Overview","href":"/analytics/intelligence-dashboards"},{"title":"Retired and replaced dashboard widgets","sidebarTitle":"Widget availability","href":"/analytics/dashboards-widget-availability"},{"title":"Layout","sidebarTitle":"Layout","href":"/analytics/dashboards/layout"},{"title":"Sharing","sidebarTitle":"Sharing","href":"/analytics/dashboards/sharing"},{"title":"Filters","sidebarTitle":"Filters","href":"/analytics/dashboards/filters"},{"title":"Lookup tables","sidebarTitle":"Lookup tables","href":"/analytics/dashboards/lookup-tables"},{"title":"Calculated fields","sidebarTitle":"Calculated fields","description":"Add your own values to dashboard charts and filters without changing the model.","href":"/analytics/dashboards/calculated-fields"},{"title":"Common workflows","sidebarTitle":"Common workflows","href":"/analytics/dashboards/common-workflows"}]},{"group":"Data Validation","pages":[{"title":"Data Validation","sidebarTitle":"Overview","description":"Use Validation Checks to validate models and track results over time.","href":"/analytics/data-validation/overview"},{"title":"Checks","sidebarTitle":"Checks","href":"/analytics/data-validation/checks"},{"title":"Project standards","sidebarTitle":"Standards","href":"/analytics/data-validation/standards"},{"title":"Viewing Results","sidebarTitle":"Viewing Results","href":"/analytics/data-validation/viewing-results"},{"title":"Validation Widgets in Dashboards","sidebarTitle":"Validation Widgets","href":"/analytics/dashboards/validation-widgets"}]},{"group":"Data Conditioning","pages":[{"title":"Update parameters from the model viewer","sidebarTitle":"Parameter Updater","href":"/beta/parameter-updater"}]}]},{"group":"Workflows","pages":[{"title":"Combine capabilities into outcomes","sidebarTitle":"Overview","href":"/workflows/overview"},{"title":"Assess model changes with Speckle Intelligence","sidebarTitle":"Compare versions with Intelligence","href":"/workflows/assess-model-changes"},{"title":"Take off quantities and cost with Speckle Intelligence","sidebarTitle":"Quantity \u0026 cost takeoff","href":"/workflows/take-off-quantities"},{"title":"Benchmark a project against your portfolio with Speckle Intelligence","sidebarTitle":"Portfolio benchmarking","href":"/workflows/benchmark-against-your-portfolio"},{"title":"Validate incoming models automatically","sidebarTitle":"Automatic model validation","href":"/workflows/validate-incoming-models-automatically"},{"title":"Design review workflow","sidebarTitle":"Design Review","href":"/workflows/design-review-workflow"},{"title":"Componentised Grasshopper workflow","sidebarTitle":"Grasshopper","href":"/workflows/grasshopper-componentised-workflow"},{"title":"Compare parametric design options from Grasshopper","sidebarTitle":"Design Explorer","href":"/workflows/grasshopper-design-explorer"},{"title":"Extract Revit room data with SpecklePy","sidebarTitle":"Revit room data extraction","href":"/workflows/revit-room-data-extraction-specklepy"},{"title":"Analyse model data with SpecklePy and DuckDB","sidebarTitle":"SpecklePy analytics","href":"/workflows/specklepy-model-data-analytics"}]}],"global":{"anchors":[]}},{"dropdown":"Developers","icon":"code","tabs":[{"tab":"Build with Speckle","groups":[{"group":"Overview","pages":[{"title":"Developer documentation","sidebarTitle":"Introduction","href":"/developers/introduction"},{"title":"What's new in 2026.9 for developers","sidebarTitle":"What's new","href":"/whats-new/developers"}]},{"group":"Getting Started","pages":[{"title":"Your learning path","sidebarTitle":"Your Learning Path","href":"/developers/getting-started"},{"group":"Authentication","pages":[{"title":"Authenticating with Speckle","sidebarTitle":"Introduction","href":"/developers/authentication/introduction"},{"title":"Building with PATs","sidebarTitle":"PATs","href":"/developers/authentication/pats"},{"title":"Building with OAuth2","sidebarTitle":"OAuth2 and PKCE","href":"/developers/authentication/oauth2"},{"title":"Single Sign-On (SSO) Authentication","sidebarTitle":"SSO Authentication","href":"/developers/authentication/sso"}]},{"title":"Key Concepts","sidebarTitle":"Key Concepts","href":"/developers/key-concepts"}]},{"group":"Building Custom Apps","pages":[{"title":"Building Custom Applications","sidebarTitle":"Building Custom Apps","href":"/developers/building-apps"}]},{"group":"Building Integrations","pages":[{"title":"Add Speckle connectivity to your authoring applications","sidebarTitle":"Overview","href":"/developers/building-integrations"},{"title":"Build integrations on the bundle format","sidebarTitle":"Bundles","href":"/developers/building-integrations/bundles"},{"title":"Publish a bundle from your own code","sidebarTitle":"Publish","href":"/developers/building-integrations/publish"},{"title":"Load a bundle in your own code","sidebarTitle":"Load","href":"/developers/building-integrations/load"},{"title":"Publish, load, and integration depth","sidebarTitle":"Publish \u0026 Load","href":"/developers/connectivity/integration-depth"},{"title":"Desktop host connectivity","sidebarTitle":"Desktop Host","href":"/developers/connectivity/desktop-host"},{"title":"Cloud and automation connectivity","sidebarTitle":"Cloud \u0026 Automation","href":"/developers/connectivity/cloud-automation"},{"title":"Middleware and orchestration","sidebarTitle":"Middleware","href":"/developers/connectivity/middleware"},{"title":"Hybrid connectivity","sidebarTitle":"Hybrid","href":"/developers/connectivity/hybrid"},{"title":"Data model and build order","sidebarTitle":"Data \u0026 Build Order","href":"/developers/connectivity/data-and-build"},{"title":"Connectivity resources","sidebarTitle":"Resources","href":"/developers/connectivity/resources"}]},{"group":"Migration notices","hidden":true,"pages":[{"title":"Speckle's new data model: what has changed for developers","sidebarTitle":"Data model migration","href":"/developers/migration/data-model-migration"},{"title":"Publish through model ingestions, not legacy send","sidebarTitle":"Publish via ingestions","href":"/developers/migration/publish-through-ingestions"}]}]},{"tab":"Data Schema","groups":[{"group":"Object model","pages":[{"title":"Object model","sidebarTitle":"Overview","href":"/developers/object-model/overview"},{"title":"Relations","sidebarTitle":"Relations","href":"/developers/object-model/relations"},{"title":"Where version metadata lives","sidebarTitle":"Version metadata","href":"/developers/object-model/version-metadata"},{"title":"Geometry encoding","sidebarTitle":"Geometry encoding","href":"/developers/object-model/geometry-encoding"}]},{"group":"Object graph (before 2026.9)","pages":[{"title":"Data schema","href":"/developers/data-schema/overview"},{"title":"Core Concepts","href":"/developers/data-schema/concepts"},{"title":"Versions and the root object","href":"/developers/data-schema/version-root-object"},{"title":"Object Schema","href":"/developers/data-schema/object-schema"},{"title":"Traversal Recipes","href":"/developers/data-schema/traversal-recipes"},{"title":"Geometry Schema","href":"/developers/data-schema/geometry-schema"},{"title":"Proxy Schemas","href":"/developers/data-schema/proxy-schema"}]},{"group":"Connectors","pages":[{"title":"Object Types by Connector","sidebarTitle":"Object Types","href":"/developers/data-schema/connector-index"},{"group":"Schemas by Data Source","pages":[{"title":"ArchiCAD Schema","href":"/developers/data-schema/connectors/archicad-schema"},{"title":"IFC Schema","href":"/developers/data-schema/connectors/ifc-schema"},{"title":"Navisworks Schema","href":"/developers/data-schema/connectors/navisworks-schema"},{"title":"Revit Schema","href":"/developers/data-schema/connectors/revit-schema"},{"title":"Tekla Schema","href":"/developers/data-schema/connectors/tekla-schema"},{"title":"AutoCAD Schema","href":"/developers/data-schema/connectors/autocad-schema"},{"title":"Civil 3D Schema","href":"/developers/data-schema/connectors/civil3d-schema"},{"title":"ETABS Schema","href":"/developers/data-schema/connectors/etabs-schema"},{"title":"Rhino Schema","href":"/developers/data-schema/connectors/rhino-schema"}]}]}]},{"tab":"Interfaces","groups":[{"group":"GraphQL","pages":[{"title":"API reference","href":"/developers/api/graphql"},{"title":"Subscriptions","href":"/developers/api/subscriptions"},{"title":"GraphQL Endpoint","deprecated":null,"version":null,"openapi":"/developers/api/graphql-openapi.json post /graphql","href":"/api-reference/graphql/graphql-endpoint"}]},{"group":"REST","pages":[{"title":"API reference","href":"/developers/api/rest"},{"group":"Previews","pages":[{"title":"Get preview images of models and versions","sidebarTitle":"Overview","href":"/developers/api/previews/preview-service"},{"title":"Get a Project's Latest Preview","deprecated":null,"version":null,"openapi":"/developers/api/previews/preview-openapi.json get /preview/{streamId}","href":"/api-reference/previews/get-a-projects-latest-preview"},{"title":"Get a Model's Latest Preview","deprecated":null,"version":null,"openapi":"/developers/api/previews/preview-openapi.json get /preview/{streamId}/branches/{branchName}","href":"/api-reference/previews/get-a-models-latest-preview"},{"title":"Get a Version's Preview","deprecated":null,"version":null,"openapi":"/developers/api/previews/preview-openapi.json get /preview/{streamId}/commits/{commitId}","href":"/api-reference/previews/get-a-versions-preview"},{"title":"Get an Object's Preview","deprecated":null,"version":null,"openapi":"/developers/api/previews/preview-openapi.json get /preview/{streamId}/objects/{objectId}","href":"/api-reference/previews/get-an-objects-preview"}]},{"group":"Bundles and properties","pages":[{"title":"List a Version's Bundle Files","deprecated":null,"version":null,"openapi":"/developers/api/rest-openapi.json get /api/v2/projects/{projectId}/models/{modelId}/versions/{versionId}/artifacts","href":"/api-reference/bundles/list-a-versions-bundle-files"},{"title":"List a Model's Latest Bundle Files","deprecated":null,"version":null,"openapi":"/developers/api/rest-openapi.json get /api/v2/projects/{projectId}/models/{modelId}/artifacts","href":"/api-reference/bundles/list-a-models-latest-bundle-files"},{"title":"Export a Version's Properties","deprecated":null,"version":null,"openapi":"/developers/api/rest-openapi.json post /api/v1/projects/{projectId}/models/{modelId}/versions/{versionId}/eav/query","href":"/api-reference/properties/export-a-versions-properties"},{"title":"Download a Version's Properties Database","deprecated":null,"version":null,"openapi":"/developers/api/rest-openapi.json get /api/v1/projects/{projectId}/models/{modelId}/versions/{versionId}/eav/download","href":"/api-reference/properties/download-a-versions-properties-database"},{"title":"Download a Model's Latest Properties Database","deprecated":null,"version":null,"openapi":"/developers/api/rest-openapi.json get /api/v1/projects/{projectId}/models/{modelId}/eav/download","href":"/api-reference/properties/download-a-models-latest-properties-database"}]},{"group":"Object endpoints (legacy)","pages":[{"title":"Download a Single Object","deprecated":true,"version":null,"openapi":"/developers/api/rest-openapi.json get /objects/{projectId}/{objectId}/single","href":"/api-reference/objects/download-a-single-object"},{"title":"Download an Object and All its Children","deprecated":true,"version":null,"openapi":"/developers/api/rest-openapi.json get /objects/{projectId}/{objectId}","href":"/api-reference/objects/download-an-object-and-all-its-children"}]},{"group":"Objects","pages":[{"title":"Check if the Server Contains a List of Objects","deprecated":true,"version":null,"openapi":"/developers/api/rest-openapi.json post /api/diff/{projectId}","href":"/api-reference/objects/check-if-the-server-contains-a-list-of-objects"},{"title":"Upload a Batch of Objects","deprecated":true,"version":null,"openapi":"/developers/api/rest-openapi.json post /objects/{projectId}","href":"/api-reference/objects/upload-a-batch-of-objects"},{"title":"Download a Single Object","deprecated":true,"version":null,"openapi":"/developers/api/rest-openapi.json get /objects/{projectId}/{objectId}/single","href":"/api-reference/objects/download-a-single-object"},{"title":"Download a List of Objects","deprecated":true,"version":null,"openapi":"/developers/api/rest-openapi.json post /api/getobjects/{projectId}","href":"/api-reference/objects/download-a-list-of-objects"},{"title":"Download an Object and All its Children","deprecated":true,"version":null,"openapi":"/developers/api/rest-openapi.json get /objects/{projectId}/{objectId}","href":"/api-reference/objects/download-an-object-and-all-its-children"}]},{"group":"Bundles","pages":[{"title":"List a Version's Bundle Files","deprecated":null,"version":null,"openapi":"/developers/api/rest-openapi.json get /api/v2/projects/{projectId}/models/{modelId}/versions/{versionId}/artifacts","href":"/api-reference/bundles/list-a-versions-bundle-files"},{"title":"List a Model's Latest Bundle Files","deprecated":null,"version":null,"openapi":"/developers/api/rest-openapi.json get /api/v2/projects/{projectId}/models/{modelId}/artifacts","href":"/api-reference/bundles/list-a-models-latest-bundle-files"}]},{"group":"Properties","pages":[{"title":"Export a Version's Properties","deprecated":null,"version":null,"openapi":"/developers/api/rest-openapi.json post /api/v1/projects/{projectId}/models/{modelId}/versions/{versionId}/eav/query","href":"/api-reference/properties/export-a-versions-properties"},{"title":"Download a Version's Properties Database","deprecated":null,"version":null,"openapi":"/developers/api/rest-openapi.json get /api/v1/projects/{projectId}/models/{modelId}/versions/{versionId}/eav/download","href":"/api-reference/properties/download-a-versions-properties-database"},{"title":"Download a Model's Latest Properties Database","deprecated":null,"version":null,"openapi":"/developers/api/rest-openapi.json get /api/v1/projects/{projectId}/models/{modelId}/eav/download","href":"/api-reference/properties/download-a-models-latest-properties-database"}]}]},{"group":"Webhooks","pages":[{"title":"Broadcast and Subscribe to Speckle Events with Webhooks","sidebarTitle":"Webhooks Overview","href":"/developers/api/webhooks"},{"title":"Events and Payloads","href":"/developers/api/webhooks/events"},{"title":"Creating and Managing Webhooks","href":"/developers/api/webhooks/management"},{"title":"Webhook Security","href":"/developers/api/webhooks/security"}]},{"group":"Guides","pages":[{"title":"Use model properties in Power Automate, Zapier, or n8n","sidebarTitle":"Low-code flows","href":"/developers/api/guides/low-code-properties"},{"title":"Upload IFC and other files to Speckle","sidebarTitle":"Upload files","href":"/developers/api/guides/file-uploads"},{"title":"Read and Write Project Metadata via GraphQL","sidebarTitle":"Project metadata","tag":"Enterprise","href":"/developers/api/guides/project-metadata"},{"title":"Updating Cloud Integration Syncs via GraphQL","sidebarTitle":"Updating Syncs","href":"/developers/api/guides/updating-syncs"},{"title":"Get Data Validation Results with GraphQL","sidebarTitle":"Validation Results","href":"/developers/api/guides/data-validation-results"},{"title":"Send Slack Notifications from Speckle Webhooks","sidebarTitle":"Slack Notifications","href":"/developers/api/guides/slack-notifications"}]}]},{"tab":"SDKs","groups":[{"group":"Speckle SDKs","pages":[{"title":"Introduction","sidebarTitle":"Introduction","href":"/developers/sdks/introduction"}]},{"group":"Python","icon":"python","pages":[{"title":"specklepy","href":"/developers/sdks/python/introduction"},{"title":"Migrate a specklepy script to 2026.9","sidebarTitle":"Migrate to 2026.9","href":"/developers/sdks/python/migrate-to-2026-9"},{"group":"Getting Started","pages":[{"title":"Installation","href":"/developers/sdks/python/getting-started/installation"},{"title":"Authentication","href":"/developers/sdks/python/getting-started/authentication"},{"title":"Quickstart","href":"/developers/sdks/python/getting-started/quickstart"}]},{"group":"Core Concepts","pages":[{"title":"Python SDK concepts","href":"/developers/sdks/python/concepts/overview"},{"title":"Data Types in Speckle","href":"/developers/sdks/python/concepts/data-types"},{"title":"Objects \u0026 Base Class","href":"/developers/sdks/python/concepts/objects"},{"title":"Data Traversal","href":"/developers/sdks/python/concepts/data-traversal"},{"title":"Display Values","href":"/developers/sdks/python/concepts/display-values"},{"title":"Proxification","href":"/developers/sdks/python/concepts/proxification"}]},{"group":"API Reference","pages":[{"title":"SpeckleClient","href":"/developers/sdks/python/api-reference/client"},{"title":"Operations","href":"/developers/sdks/python/api-reference/operations"},{"group":"Resources","pages":[{"title":"ProjectResource","href":"/developers/sdks/python/api-reference/resources/project"},{"title":"ModelResource","href":"/developers/sdks/python/api-reference/resources/model"},{"title":"VersionResource","href":"/developers/sdks/python/api-reference/resources/version"},{"title":"ActiveUserResource","href":"/developers/sdks/python/api-reference/resources/active-user"},{"title":"OtherUserResource","href":"/developers/sdks/python/api-reference/resources/other-user"},{"title":"WorkspaceResource","href":"/developers/sdks/python/api-reference/resources/workspace"},{"title":"ServerResource","href":"/developers/sdks/python/api-reference/resources/server"}]},{"title":"Transports","href":"/developers/sdks/python/api-reference/transports"},{"title":"Exceptions","href":"/developers/sdks/python/api-reference/exceptions"}]},{"group":"Guides","pages":[{"title":"Working with Speckle Objects","href":"/developers/sdks/python/guides/how-to-work-with-objects"},{"title":"Finding and Extracting Data","href":"/developers/sdks/python/guides/how-to-find-and-extract-data"},{"title":"Performance and Complex Patterns","href":"/developers/sdks/python/guides/how-to-optimize-and-handle-complexity"},{"title":"Simple Data Patterns","href":"/developers/sdks/python/guides/simple-data-patterns"},{"title":"BIM Data Patterns","href":"/developers/sdks/python/guides/bim-data-patterns"},{"title":"Extracting Display Values and Transform Instances","href":"/developers/sdks/python/guides/working-with-proxies"},{"title":"Understanding Speckle Mesh","href":"/developers/sdks/python/guides/understanding-speckle-mesh"},{"title":"Working with Geometry","href":"/developers/sdks/python/guides/working-with-geometry"}]}]},{"group":"C# .NET","icon":"microsoft","pages":[{"title":"speckle-sharp","sidebarTitle":"speckle-sharp","href":"/developers/sdks/dotnet/introduction"},{"title":"Migrate a Speckle.Sdk script to 2026.9","sidebarTitle":"Migrate to 2026.9","href":"/developers/sdks/dotnet/migrate-to-2026-9"},{"group":"Getting Started","pages":[{"title":"Installation","sidebarTitle":"Installation","href":"/developers/sdks/dotnet/getting-started/installation"},{"title":"Build your first model analysis tool","sidebarTitle":"First analysis tool","href":"/developers/sdks/dotnet/guides/build-your-first-model-analysis-tool"},{"title":"Automate with scripts and notebooks","sidebarTitle":"Scripts","href":"/developers/sdks/dotnet/getting-started/scripts-and-notebooks"},{"title":"Authentication","sidebarTitle":"Authentication","href":"/developers/sdks/dotnet/getting-started/authentication"},{"title":"Publish and load a model from C#","sidebarTitle":"Quickstart","href":"/developers/sdks/dotnet/getting-started/quickstart"}]},{"group":"Guides","pages":[{"title":"Use SpeckleSharp in a Grasshopper C# node","sidebarTitle":"Grasshopper C#","href":"/developers/sdks/dotnet/guides/use-speckle-sdk-in-grasshopper-csharp"},{"title":"Find objects by property","sidebarTitle":"Find \u0026 extract","href":"/developers/sdks/dotnet/guides/finding-and-extracting-data"},{"title":"Export model data to CSV","sidebarTitle":"Export to CSV","href":"/developers/sdks/dotnet/guides/export-model-data-to-csv"},{"title":"Send analysis results back to Speckle","sidebarTitle":"Send results back","href":"/developers/sdks/dotnet/guides/send-analysis-results-back"},{"title":"BIM data patterns","sidebarTitle":"BIM patterns","href":"/developers/sdks/dotnet/guides/bim-data-patterns"},{"title":"Compare two model versions","sidebarTitle":"Compare versions","href":"/developers/sdks/dotnet/guides/compare-two-model-versions"},{"title":"Resolve groups and instances","sidebarTitle":"Proxies","href":"/developers/sdks/dotnet/guides/working-with-proxies"},{"title":"Read and create geometry","sidebarTitle":"Geometry","href":"/developers/sdks/dotnet/guides/working-with-geometry"},{"title":"Handling server capabilities","href":"/developers/sdks/dotnet/guides/handling-server-capabilities"},{"title":"Publish large models (connectors)","sidebarTitle":"Connector sends","href":"/developers/sdks/dotnet/guides/building-connector-scale-sends"}]},{"group":"Concepts","pages":[{"title":"How your code talks to Speckle Server","sidebarTitle":"Core concepts","href":"/developers/sdks/dotnet/concepts/overview"},{"title":"Work with model objects","sidebarTitle":"Objects","href":"/developers/sdks/dotnet/concepts/objects-and-traversal"},{"title":"Load and publish model data","sidebarTitle":"Send \u0026 receive","href":"/developers/sdks/dotnet/concepts/send-and-receive-paths"},{"title":"Dependency injection (connectors)","sidebarTitle":"DI (advanced)","href":"/developers/sdks/dotnet/concepts/dependency-injection"}]},{"group":"API Reference","pages":[{"title":"Client","sidebarTitle":"Client","href":"/developers/sdks/dotnet/api-reference/client"},{"title":"Service registration","sidebarTitle":"Registration","href":"/developers/sdks/dotnet/api-reference/service-registration"},{"title":"Operations","sidebarTitle":"Operations","href":"/developers/sdks/dotnet/api-reference/operations"},{"group":"Resources","pages":[{"title":"Project","sidebarTitle":"Project","href":"/developers/sdks/dotnet/api-reference/resources/project"},{"title":"Model","sidebarTitle":"Model","href":"/developers/sdks/dotnet/api-reference/resources/model"},{"title":"Version","sidebarTitle":"Version","href":"/developers/sdks/dotnet/api-reference/resources/version"},{"title":"Users","sidebarTitle":"Users","href":"/developers/sdks/dotnet/api-reference/resources/users"},{"title":"Workspace","sidebarTitle":"Workspace","href":"/developers/sdks/dotnet/api-reference/resources/workspace"},{"title":"Server","sidebarTitle":"Server","href":"/developers/sdks/dotnet/api-reference/resources/server"},{"title":"Model ingestion","sidebarTitle":"Ingestion","href":"/developers/sdks/dotnet/api-reference/resources/ingestion"}]},{"title":"Transports","sidebarTitle":"Transports","href":"/developers/sdks/dotnet/api-reference/transports"},{"title":"Exceptions","sidebarTitle":"Exceptions","href":"/developers/sdks/dotnet/api-reference/exceptions"}]}]},{"group":"JS/TS","icon":"javascript","pages":[{"title":"speckle.js","href":"/developers/sdks/typescript/introduction"}]}]},{"tab":"Viewer","groups":[{"group":"Speckle Viewer","pages":[{"title":"Developers Guide","sidebarTitle":"Getting Started","href":"/developers/viewer/introduction"},{"title":"Load a bundle in your Viewer app","sidebarTitle":"Loading bundles","href":"/developers/viewer/loading-bundles"},{"title":"Installation","href":"/developers/viewer/installation"},{"title":"Basic Setup","href":"/developers/viewer/basic-setup"},{"title":"Advanced Setup","href":"/developers/viewer/advanced-setup"}]},{"group":"Core Concepts","pages":[{"title":"3D Viewer","href":"/developers/viewer/overview"},{"title":"Data Tree","href":"/developers/viewer/viewer-data"},{"title":"Rendering","href":"/developers/viewer/viewer-rendering"},{"title":"Loaders","href":"/developers/viewer/loaders"}]},{"group":"API Reference","pages":[{"group":"Viewer Core","pages":[{"title":"AccelerationStructure","href":"/developers/viewer/acceleration-structure-api"},{"title":"Batch","href":"/developers/viewer/batch-api"},{"title":"BatchObject","href":"/developers/viewer/batch-object-api"},{"title":"GeometryConverter","href":"/developers/viewer/geometry-converter-api"},{"title":"Input","href":"/developers/viewer/input-api"},{"title":"Intersections","href":"/developers/viewer/intersections-api"},{"title":"Loader","href":"/developers/viewer/loader-api"},{"title":"Queries","href":"/developers/viewer/queries-api"},{"title":"NodeRenderView","href":"/developers/viewer/render-view-api"},{"title":"RenderTree","href":"/developers/viewer/render-tree-api"},{"group":"Rendering Pipelines","pages":[{"title":"Pipeline","href":"/developers/viewer/rendering-pipeline-api/pipeline-api"},{"title":"ProgressivePipeline","href":"/developers/viewer/rendering-pipeline-api/progressive-pipeline-api"},{"title":"GPass","href":"/developers/viewer/rendering-pipeline-api/g-pass-api"},{"title":"BaseGPass","href":"/developers/viewer/rendering-pipeline-api/base-g-pass-api"},{"title":"ProgressiveGPass","href":"/developers/viewer/rendering-pipeline-api/progressive-g-pass-api"}]},{"title":"SpeckleMaterial","href":"/developers/viewer/speckle-material-api"},{"title":"SpeckleRenderer","href":"/developers/viewer/speckle-renderer-api"},{"title":"TopLevelAccelerationStructure","href":"/developers/viewer/top-level-acceleration-structure-api"},{"title":"Viewer","href":"/developers/viewer/viewer-api"},{"title":"WorldTree","href":"/developers/viewer/world-tree-api"}]},{"group":"Extensions","pages":[{"title":"Extension","href":"/developers/viewer/extensions/extension-api"},{"title":"CameraController","href":"/developers/viewer/extensions/camera-controller-api"},{"title":"DifExtension","href":"/developers/viewer/extensions/diff-extension-api"},{"title":"FilteringExtension","href":"/developers/viewer/extensions/filtering-extension-api"},{"title":"MeasurementsTool","href":"/developers/viewer/extensions/measurements-tool-api"},{"title":"SelectionExtension","href":"/developers/viewer/extensions/selection-extension-api"},{"title":"SectionTool","href":"/developers/viewer/extensions/section-tool-api"},{"title":"SectionToolOutlines","href":"/developers/viewer/extensions/section-tool-outlines-api"},{"title":"SpeckleControls","href":"/developers/viewer/extensions/speckle-controls-api"},{"title":"SmoothOrbitControls","href":"/developers/viewer/extensions/smooth-orbit-controls-api"},{"title":"ViewModes","href":"/developers/viewer/extensions/view-modes-api"}]}]},{"group":"Examples","pages":[{"title":"Basic Example","href":"/developers/viewer/examples/basic-example"},{"title":"More Extensions","href":"/developers/viewer/examples/more-extensions-example"},{"title":"Filtering","href":"/developers/viewer/examples/filtering-example"},{"title":"Loading Data","href":"/developers/viewer/examples/loading-example"},{"title":"Object Manipulation","href":"/developers/viewer/examples/object-manipulation-example"},{"title":"Box Selection","href":"/developers/viewer/examples/box-selection-example"},{"title":"Animation \u0026 Custom Text","href":"/developers/viewer/examples/categorize-example"}]},{"group":"Reference","pages":[{"title":"Migration Guide","href":"/developers/viewer/migration-guide"},{"title":"Backwards Compatibility","href":"/developers/viewer/migration-guide-compatibility"},{"title":"API 1.0 Full Migration","href":"/developers/viewer/migration-guide-v1"}]}]},{"tab":"Server","groups":[{"group":"Speckle Server","pages":[{"title":"Hosting Your Own Speckle Server","sidebarTitle":"Overview","href":"/developers/server/introduction"},{"title":"Choosing a Speckle Deployment","sidebarTitle":"Choosing a Deployment","href":"/developers/server/self-hosted-vs-cloud-hosted-speckle"},{"title":"Docker Compose Quickstart","sidebarTitle":"Getting Started","href":"/developers/server/getting-started"},{"title":"Server Architecture","href":"/developers/server/architecture"},{"title":"Self-Hosted Deployment Options","href":"/developers/server/deployment-options"}]},{"group":"Deployment","pages":[{"title":"Deploy to Kubernetes","href":"/developers/server/deployment/kubernetes-with-helm"},{"title":"Server Maintenance","href":"/developers/server/deployment/backup-upgrade-restore"},{"title":"Deploying a Speckle Enterprise licensed server","sidebarTitle":"Enterprise Servers","tag":"Enterprise","href":"/developers/server/deployment/enterprise-license"},{"title":"Deploying a Speckle Enterprise licensed Automate server","sidebarTitle":"Enterprise Automate","tag":"Enterprise","href":"/developers/server/deployment/enterprise-license-automate"},{"title":"Deploying a Speckle Enterprise licensed Intelligence server","sidebarTitle":"Enterprise Intelligence","tag":"Enterprise","href":"/developers/server/deployment/enterprise-license-intelligence"},{"title":"Deploying a Speckle Enterprise licensed Desktop UI server","sidebarTitle":"Enterprise licensed Desktop UI","tag":"Enterprise","href":"/developers/server/deployment/enterprise-license-desktop-ui"}]},{"group":"Local Development","pages":[{"title":"Environment Setup","href":"/developers/server/development/setup"}]}]},{"tab":"Automate","groups":[{"group":"Speckle Automate","pages":[{"title":"Powering Your Automation Workflows","sidebarTitle":"Overview","tag":"Enterprise","href":"/developers/automate/introduction"},{"title":"Quickstart Guide","href":"/developers/automate/quickstart"},{"title":"API Reference","href":"/developers/automate/api-reference"},{"title":"Frequently Asked Questions","href":"/developers/automate/faq"}]},{"group":"Automate Functions","pages":[{"title":"Create an Automate function","sidebarTitle":"Creating Functions","href":"/developers/automate/create-function"},{"title":"Making Your Function","href":"/developers/automate/making-your-function"},{"title":"Function Inputs","href":"/developers/automate/function-inputs"},{"title":"Releasing a New Version","href":"/developers/automate/release-function-version"},{"title":"Publishing Automate Functions without the GitHub App","sidebarTitle":"Publish without GitHub","href":"/developers/automate/publishing-without-github"}]},{"group":"Working with Data","pages":[{"title":"Handling Data in Functions","href":"/developers/automate/function-data"},{"title":"AutomationContext","href":"/developers/automate/function-context"},{"title":"Annotating Function Results","href":"/developers/automate/function-results"},{"title":"Reporting Success","href":"/developers/automate/function-success"},{"title":"Function Artefacts","href":"/developers/automate/function-artefacts"}]},{"group":"Creating Automations","pages":[{"title":"Creating Automations","href":"/developers/automate/create-automation"},{"title":"Viewing Automation Results","href":"/developers/automate/viewing-results"},{"title":"Update an Automation","href":"/developers/automate/update-automation"}]},{"group":"Testing \u0026 Development","pages":[{"title":"Testing Your Functions","href":"/developers/automate/function-testing"},{"title":"Troubleshooting Automations","href":"/developers/automate/troubleshooting"}]},{"group":"Reference","pages":[{"title":"Considerations \u0026 Limitations","href":"/developers/automate/important-considerations"},{"title":"Function Specification","href":"/developers/automate/function-specification"}]}]}],"global":{"anchors":[]}},{"dropdown":"IT Administrators","icon":"wrench","groups":[{"group":"Deployment \u0026 Maintenance","pages":[{"title":"IT setup guide","href":"/it-admin/setup"},{"title":"Keep connectors current across your estate","sidebarTitle":"Connector updates","href":"/it-admin/connector-updates"},{"title":"Security","href":"/it-admin/security"},{"group":"Cloud Integrations","pages":[{"title":"Cloud Integrations: Access and Governance","sidebarTitle":"Introduction","href":"/it-admin/integrations/introduction"},{"title":"Enable Autodesk Forma Data Management integration","sidebarTitle":"Forma Data Management (ACC)","tag":"Enterprise","href":"/it-admin/integrations/acc"},{"title":"Configure Bentley ProjectWise Integration","sidebarTitle":"Bentley ProjectWise","tag":"Enterprise","href":"/it-admin/integrations/projectwise"},{"title":"Approve Speckle for SharePoint","sidebarTitle":"SharePoint","href":"/it-admin/integrations/sharepoint"},{"title":"Enable Databricks Integration","sidebarTitle":"Databricks","href":"/it-admin/integrations/databricks"},{"title":"Enable Snowflake Integration","sidebarTitle":"Snowflake","href":"/it-admin/integrations/snowflake"}]},{"title":"Admin Support Mode","href":"/it-admin/support-mode"},{"title":"Archive and unarchive projects","sidebarTitle":"Project Archival","tag":"Enterprise","href":"/it-admin/archived-projects"},{"title":"What's new in 2026.9 for IT admins","sidebarTitle":"What's new","href":"/whats-new/it-admins"}]},{"group":"Manual Connector Installation","pages":[{"title":"Manual installation","sidebarTitle":"Overview","href":"/connectors/manual-installation/introduction"},{"title":"Desktop Services","sidebarTitle":"Desktop Services (deprecated)","href":"/connectors/manual-installation/desktop-services"},{"title":"Archicad","href":"/connectors/manual-installation/archicad"},{"title":"AutoCAD","href":"/connectors/manual-installation/autocad"},{"title":"Blender","href":"/connectors/manual-installation/blender"},{"title":"Civil 3D","href":"/connectors/manual-installation/civil3d"},{"title":"ETABS","href":"/connectors/manual-installation/etabs"},{"title":"Navisworks","href":"/connectors/manual-installation/navisworks"},{"title":"Power BI","href":"/connectors/manual-installation/powerbi"},{"title":"Revit","href":"/connectors/manual-installation/revit"},{"title":"Rhino \u0026 Grasshopper","href":"/connectors/manual-installation/rhino-grasshopper"},{"title":"SketchUp","href":"/connectors/manual-installation/sketchup"},{"title":"Tekla Structures","href":"/connectors/manual-installation/teklastructures"}]}],"global":{"anchors":[]}},{"dropdown":"Get Involved","icon":"users","groups":[{"group":"Ways to get involved","pages":[{"title":"User testing and feedback","sidebarTitle":"User Testing","href":"/get-involved/user-testing"},{"title":"Join the Speckle Community","sidebarTitle":"Community","href":"/get-involved/community"},{"title":"Open source at Speckle","sidebarTitle":"Open source","href":"/get-involved/open-source"}]}],"global":{"anchors":[]}},{"dropdown":"Changelog","icon":"history","pages":[{"title":"Changelog — November 2026","sidebarTitle":"November 2026","href":"/technical-changelog/2026-11"},{"title":"Changelog — October 2026","sidebarTitle":"October 2026","href":"/technical-changelog/2026-10"},{"title":"Changelog — September 2026","sidebarTitle":"September 2026","href":"/technical-changelog/2026-09"}],"global":{"anchors":[]}}]},"basePath":"","title":"Common workflows - Speckle Docs","deploymentId":"dpl_DyXGnKeCjZyA3sUdfMJ7FjkdBefg","buildId":"dpl_DyXGnKeCjZyA3sUdfMJ7FjkdBefg","dynamics":[],"chunks":[]}