Overview

Syncfusion Dashboard Platform SDK includes sample browser which includes features of Syncfusion Dashboard Viewer by using JavaScript API.

Getting Started with SDK sample browser

This is simple walkthrough to get started with Syncfusion Dashboard Platform SDK Sample Browser.

Running SDK sample browser

Click the following link to install the Syncfusion Dashboard Platform SDK

https://help.syncfusion.com/dashboard-platform/dashboard-sdk/installation-and-deployment#installation

After completing the installation, select the Launch Sample Browser radio button, and then click finish. It will be opened in the default browser of your machine.

The following screenshot illustrates this process:

Installation wizard completed status

Or

Also, you can launch the Dashboard Platform SDK sample browser through double-clicking the shortcut icon

Desktop shortcut

Now, the Dashboard Platform SDK sample browser will open in the default browser of your machine.

Samples view in Sample Browser

Using Dashboard Platform SDK sample browser

The left pane holds the list of samples of dashboard viewer in the Dashboard Platform SDK. Click any sample, the sample dashboard will be rendered at the center pane and the properties of the corresponding sample will be shown at the right pane.

The following screenshot illustrates the dashboard Auto Refresh sample in the desktop view:

Auto-refresh sample view in Sample Browser

In mobile view, the showcase list of samples of the dashboard viewer in the Dashboard Platform SDK is displayed while clicking the header menu like below:

Sample browser samples listing in mobile view

The properties window will be opened while clicking the properties option in the footer like below:

Sample Browser Properties section view in mobile

The following are the three tabs provided in the header of the Dashboard Platform SDK sample browser.

  • Dashboard
  • Info
  • Code

The sample dashboard will be rendered at the center pane while clicking the dashboard tab in desktop view like below

Dashboard in Desktop view

In mobile view:

Dashboard in mobile view

When you switch to Info tab, the selected sample information will be shown as below in the desktop view

Info tab view in desktop

In mobile view, information tab will be shown as below

Info tab view in mobile

The code view of the selected sample will be showcased based on a platform, when you switch to the Code tab.

The following screenshot illustrates the code view for desktop view

Code tab view in desktop