Documentation

Action bar

The action bar is the main interaction element of a dashboard. It will be automatically hidden, if the mouse pointer is out of the active window.

If the action bar is over your content, go to the top menu Window > Toggle Action Bar Visiblity to disable or reenable it

Keyboard Shortcuts

CMD + N New dashboard
CMD + LEFT One page back in history
CMD + RIGHT One page forward in history
CMD + SHIFT + H Go back to start URL (home)
CMD + R Reload current dashboard
CMD + SHIFT + R Reload current dashboard, clear cache
CMD + + Zoom in
CMD + - Zoom out
CMD + 0 Reset zoom to 100%
CMD + SHIFT + E Toggle action bar
CMD + M Minimize dashboard
CMD + SHIFT + F Show dashboard on fullscreen
ALT + SHIFT + TAB Switch between dashboards
CMD + ? Open this help
CMD + W Close dashbaord
CMD + Q Close App

URL Template Generator

Simply create your URLs to embed in your website, favourites, documentation, etc

Name
URL
Generate

URL option 1 to open in dashbaord.ninja (prefered)

https://dashboard.ninja/go/<base64 encode JSON object>

Drawback: If this URL is open in Safari, it might be that instead of opening die App directly, only a top sidebar is apearing pointing to the App

URL option 2 to open in dashbaord.ninja

dashboard.ninja:go?data=<base64 encode JSON object>

Drawback: If the App is not installed, a not so useful error might be shown

URL Template Format

The URL contains a base64 encoded JSON object:

{
    "title": "dashboard.ninja",
    "url": "https://dashboard.ninja"
}

Settings Format

The settings are stored in a JSON file named settings.json located in the user Library folder. It can opened in the Menu > Help > Show Configuration in Finder

The first time of a day a dashbord the settings will be written to the file, a backup is created. Up to 14 days will be kept. To restore a backup or try manual changes, close the App, rename the wanted file to settings.json and reopen the App.

Example JSON, only mandatory fields

{
    "dashboards": [
        [
            {
                "id": "19B2EB44-68D4-494A-9ED7-339F78254ADF",
                "url": "https://dashboard.ninja"
            }
        ]
    ]
}

Example JSON with all available fields

{
    "dashboards": [
        [
            {
                "id": "19B2EB44-68D4-494A-9ED7-339F78254ADF",
                "title": "dashboard.ninja",
                "url": "https://dashboard.ninja",
                "userAgent": "Mozilla/5.0 (Macintosh; Intel Mac OS X 10_14_6) AppleWebKit/605.1.15 (KHTML, like Gecko) Version/13.0 Safari/605.1.15",
                "width": 2560,
                "height": 1417,
                "x": 2560,
                "y": -82,
                "zoom": 1
            }
        ]
    ]
}

Also a JSON schema is available to verify created data.