BMotionWeb for ProB Handbook: BMotionWeb Manifest File

3.1.1 BMotionWeb Manifest File

The BMotionWeb manifest file (bmotion.json) is the root file of every BMotionWeb visualization. It contains the configuration for the visualization formatted using JSON (JavaScript Object Notation)¹. The following options (and defaults) are available:

id [Type: String, Required]:
The unique id of the visualization.
name [Type: String]:
The name of the visualization.
model [Type: String, Required]:
The relative path to the model file (e.g. “model/mymodel.mch”).
template [Type: String, Required]:
The relative path to the root HTML file (e.g. “index.html”).
autoOpen [Type: Array]:
Specify the ProB views which should be opened automatically in the respective view when starting the visualization. The following views are available: CurrentTrace, Events, StateInspector, CurrentAnimations, GroovyConsoleSession, ModelCheckingUI.
views [Type: list]:
List of view objects that are opened in separate windows. At least one view must exists. A view object has the following options:
- id [Type: String, Required]:
  Unique id of the view.
- template [Type: String, Required]:
  The relative path to the HTML visualization file (e.g. “template.html”).
- name [Type: String]:
  The name of the view.
- width [Type: Integer]:
  The width of the view.
- height [Type: Integer]:
  The height of the view.

Example BMotionWeb manifest file (e.g. lift.json):


{
  "id": "lift",
  "name": "Simple lift",
  "template": "lift.html",
  "model": "model/lift.mch",
  "autoOpen": [
    "CurrentTrace",
    "Events"
  ],
  "views": [
    {
      "id": "buttons",
      "name": "Lift control",
      "template": "control.html",
      "width": 300,
      "height": 200
    }
  ]
}