Skip to main content

Custom Dashboard

warning

Experimental. This feature may change or be removed.

A Custom Dashboard is a dashboard whose entire canvas is an HTML page you write. You upload a single HTML file (the shell). Admin hosts it. Your page talks to Admin only through window.postMessage: ready, theme, style, and a request/response SQL bridge to list and run saved TagoSQL queries.

In the create dialog the tab is labeled Custom HTML. The dashboard type string is "custom".

Custom Dashboard is not a Custom Widget. A Custom Widget is one tile on a Normal or Blueprint dashboard. A Custom Dashboard replaces the whole dashboard with your page. See Custom Dashboard vs Custom Widget.

Why use it​

  • Own the full surface. Layout, charts, and interaction are your HTML, CSS, and JavaScript, not a grid of TagoIO widgets.
  • Saved queries over postMessage. List and run TagoSQL queries saved on the profile. No free-form SQL from the embed; Admin fulfills each call with the signed-in session.
  • Simple host protocol. Signal ready, receive theme, request data. No custom-widget library handshake.
  • Versioned shell. TagoIO hosts the uploaded file (versioned). Dashboard version restore can bring back a previous shell.

Where to use it​

  • Admin only. Custom Dashboards run in TagoIO Admin. They are not available in TagoRUN. Public share and distribute are not supported for this type.
  • Full-page apps and reports. Use a Custom Dashboard when the whole canvas should be your HTML, not a single tile on a widget grid. For a component inside a Normal or Blueprint layout, use a Custom Widget instead.
  • Query-driven pages. Use the SQL bridge when the page needs profile data through saved queries. Skip requests if the shell is self-contained.

What you get​

AreaBehavior
ShellOne uploaded HTML file. Upload and download from the gear menu after create.
DatapostMessage SQL bridge: sql.list and sql.run on saved TagoSQL queries.
Host messagesdashboard:ready from the shell; host sends dashboard:theme and optional dashboard:style; data via dashboard:request / dashboard:response.
AudienceAdmin only. Not available in TagoRUN. No public share or distribute.
EditorNo in-app HTML editor. Edit offline, re-upload.

How it works​

  1. Create a Custom Dashboard from the create dialog (Custom HTML tab).
  2. On first open, upload your HTML shell. Until then you see an empty state with Upload HTML and a short author note.
  3. Author the page to post dashboard:ready and handle dashboard:theme (and optional style).
  4. Load data with the SQL bridge: list saved queries, run them, render the results in your page.