URL parameters

Concept

Some widgets are capable of handling parameters define inside the URL. These parameters allow to link/navigate to a dashboard a pre-configure the widgets that are on the dashboard. A common example would be to navigate into a dashboard with a collection table and feed the table an id to directly open a given entry of the table, without having to manually open it.

Structure of the parameter

The structure of a parameter follows https://<host>/<dashboard-id>#<widget-id>.<param-name>=<param-value>&<other-params....>.

• widget-id: Id of the widget that should read that parameter

• param-name: Name of the parameter. The names available depend on the type of widget. Look at the desired widget to see the list of available parameters

• param-value: Value of the parameter.

Warning

One parameter can only target one widget. If you want a parameter to be applied on multiple widget, you need to define one parameter for each widget-id.

Disabling the parameters

A widget that reads url parameters also writes its own state back into the url as the user works, which is what makes the state of a dashboard shareable as a link. Every widget marked as supported in the list below accepts a disableUrlHistory setting, false by default, to turn that off.

Setting it to true cuts the widget off from the url in both directions. It stops writing its state, and it also stops reading the parameters, so a link carrying them opens the widget on its configured state instead. Use it for a widget whose state is of no interest outside its dashboard, or to keep the browser history free of the entries added as the user filters and searches.

List of supported widgets

Widget	Support	Link to widget documentation
Alarm Table		See alarm table parameters
Alarm Severity		See note
Analytics Aggregate		See note
Basic Input Output Value		See note
Chart		See note
Collection Table		See collections table parameters
Discovery		See URL parameters
Form		See note
Gauge		See note
Icon		See note
Journal		See note
Limit		See note
Map		See map url parameters
Markdown		See note
Navigation		See note
Object browser		See note
PDF Viewer		See note
Ptz Controller		See note
Range		See note
Refresh		See note
Reports List		See note
Reports Viewer		See note
Schematic		See URL parameters
Select		See note
Submit		See note
Text		See note
Toolbar		See note
Value		See note
Value Subscription		See note
Video Player		See note
Web View		See note

Note

Not every widget currently support this feature. In case of interest please contact us at info@sdn.ch