-
Task
-
Resolution: Done
-
Major
-
None
-
None
-
None
Dashbuilder should be able to connect to a samples repository and render the list the samples.
Users should be able to open the sample and import to their application.
A new property in setup.js should allow users to setup the base URL for samples (samplesUrl). When this property is set Dashbuilder will get the list of samples from file samples.json with the following format:
{
"General Category":[
{
"id":"sample1",
"name":"Sample 1"
},
{
"id":"sample2"
}
]
}
Only "id" is required. If it is missing, then the sample is not registered. If only ID is available, then it is used as the sample name. Using the sample ID dashbuilder retrieves the sample data based on sample URL:
- _ {samplesUrl}/{sampleId}/{sampleid}.dash.yaml_ retrieves the sample code;
- _{samplesUrl}/{sampleId}/{sampleid}.png retrieves the sample preview image;
The property samplesUrl display samples screen ONLY if it is in client mode. If no mode is set, and samples is configured, then dashbuilder assumes client mode and displays the samples screen in place of the EMPTY screen. So, instead prompting users to import a dashboard, dashbuilder list the samples.
Notice that to allow users to load external URL samples then users must also set "allowExternal" to true in setup.js