Naming and aliases

In our system every dashboard gets an unique id. We call this a dashboard id and this id is not changeable by our users. Additional to this id it is possible to assign each dashboard an alias - which is a name that is limited to 32 alphanumeric characters and can be chosen freely by our users. The following rules are valid for aliasnames:

  1. Each alias is unique.
  2. Alias names are valid as long as the dasboard has not reached the end of its lifetime.
  3. You can switch the aliasname as often as you want.
  4. Aliasnames which are matching (by coincidence or not) other dashboard ids are not valid.
  5. The initial alias name is the unique id of your dashboard

These rules have the following consequences:

  • You can choose every alias you want - as long as it is not already taken and as long as it doesn't violate the naming pattern (32 alphanumeric characters).
  • Your alias expired when your dashboard reaches the end of its lifetime. To keep an alias reserved you have to keep the dashboard running.
  • You can reassign the aliases as often as you want - which enables you to have consistent naming throughout different versions of your dashboard.
  • There is no right for a specific alias. If another user 'grabs' your alias then it is your problem. Please don't contact us to reassign alias names from dashboards that do not belong to you - we are definitely not going to do this.

Embed as raw image

This is the most versatile method of how to embed your dashboard. Just copy the link to the rendered SVG image from the Raw SVG file and add it to your webpage or whatever.

The webpage Sitepoint has some good hints on how to embed an SVG image correctly. Selfhtml and Stack Overflow have also good discussions about this topic. Which solution you choose will depend on your needs. The simplest way is to use a raw image tag like this:

<img src="https://simpledashboard.io/ga/embed/0123456789abcdef.svg" alt="My dashboard" onerror="this.src='your-alternative-image.png'">

or - if you have assigned an alias then you can also use tha alias name instead of the dashboard id:

<img src="https://simpledashboard.io/ga/embed/my_alias.svg" alt="My dashboard" onerror="this.src='your-alternative-image.png'">

But with great power, comes great responsibility! You are responsible for

  • Refreshing the image
  • Scaling it into your viewport
  • Respecting the specific browser quirks
  • Deal with securitiy issues
  • ...

Embed as Webpage

Another way how to embed dashboards is to use them wrapped into a webpage. This is by far not as flexible as if you would embed it by yourself - but it is much simpler. You can just display the links an any modern webbrowser, but you can also inline it into existing webpages (via the iframe tag). We provide two different ways where we embed your dashboard into a HTML page, which can be called by any modern webbrowser:

Approach 1: Embed-as-image

Just use your dashboard id or your alias and attach the parameter type=img to it.

https://simpledashboard.io/ga/embed/0123456789abcdef.html?type=img
https://simpledashboard.io/ga/embed/my_alias.html?type=img

The 'embed-as-imge' approach works very well and can be interpreted by the most current browsers. There is no chance that the rendered SVG will inject any scripts or other resources into the browser.

Approach 2: Embed-as-object

Just use your dashboard id or your alias and attach the parameter type=obj to it.

https://simpledashboard.io/ga/embed/0123456789abcdef.html?type=obj
https://simpledashboard.io/ga/embed/my_alias.html?type=obj

The 'embed-as-object' approach is more versatile than the embed-as-img, because the browsers are also executing javascript code which is embedded within the dashboard. This is neccessary if you hae inline animations or other things which require to run javascript in the SVG. Be aware the execution of javascript can be a security issue - especially if you dont have the control over the script.

Approach 2: Let-the-system-decide

Just use your dashboard id or your alias and do not attach any parameter at all.

https://simpledashboard.io/ga/embed/0123456789abcdef.html
https://simpledashboard.io/ga/embed/my_alias.html

If you do not specify any type at the embedding URL, then we assume (for security reasons) that you are meaning the 'embed-as-img' approach.

Provide an QR Code

One of the simplest ways to redirect users to your dashboard is to provide a QR code to your dashboard. The tab QR code helps you to do this: It provides an QR code to the HTML version of your dashboard which automatically refreshes the result as needed. If you click at the QR code then it will be sent to your printer. If you click the link beside the QR code then another window will open that shows the preview of the dashboard.

Auto reload

If you choose to ebmed via the webpage it is possible to add the additional autorefresh parameter which refreshes the webpage in the same interval as you have chosen in the acutuality of the dashboard. The snipplet shows how to embed your dashboard into your webpage via an iframe that automatically refreshes its content:

<iframe src="https://simpledashboard.io/ga/embed/my_alias.html?autorefresh"></iframe>

Auto reload

If you choose to ebmed via the webpage it is possible to add an additional parameter which refreshes the webpage in the same interval as you have chosen in the acutuality of the dashboard. The snipplet shows how to embed your dashboard into your webpage via an iframe that automatically refreshes its content:

<iframe src="https://simpledashboard.io/ga/embed/my_alias.html?autorefresh"></iframe>

Limits

Even if we are currently not enforcing any limits, we are asking you kindly not to embed or link your dashboard in websites with heavy traffic. We do our best to treat all our customers equal and if there are some of them demanding a lot more resources (in terms of bandwidth and traffic) than others then we are forced to apply countermeasures.