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, optionally resolves one bound data source on the server, and injects the result into your page with a thin postMessage contract.

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.
  • Server-bound data. Optionally attach one TagoSQL query or one GET URL template. The server runs the fetch; the shell never holds free-form SQL or a profile token for data.
  • Simple host protocol. Signal ready, receive data and theme. 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.
  • One optional data source. Bind a saved TagoSQL query or a GET URL template when the page needs server-resolved data. Skip the source if the shell is self-contained.

What you get​

AreaBehavior
ShellOne uploaded HTML file. Upload and download from the gear menu after create.
DataOptional single source: saved TagoSQL query or GET-only URL template.
Host messagesdashboard:ready from the shell; host replies with dashboard:data, dashboard:theme, and optional dashboard:style.
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. Optionally open Data source in the gear menu and bind one TagoSQL query or GET URL.
  4. Author the page to post dashboard:ready and handle dashboard:data and dashboard:theme.

After the shell exists, the dashboard header includes a data refresh control so you can re-fetch bound data without reloading the whole page.