Context Menu API Reference

CSS

Classes

Variables

JavaScript

Modules

DeskAPI

  • sound Object: contains URLs for sound files, available sounds are

    • sound.attention

    • sound.confirm

    • sound.exit

    • sound.finish

    • sound.navigate

    • sound.save

    • sound.set

    • sound.error

  • playSound Function ( url: String ): takes an URL of a sound file

  • robotConfiguration ko.observable( { jointAngles: Array[Number], pose: Array[Number] } ): current robot pose

  • gripperState ko.observable( { width: Number, maxWidth: Number } ): current gripper state

  • relativeGripperWidth ko.pureComputed() { return Number }: gripper width from 0 (closed) to 1 (open)

  • modbus Object: modbus configuration

ElementAPI

  • path ko.pureComputed() returns Object { id: String, indices: Array[Number] }: path to the element

  • model Object:

    • id String

    • name ko.observable(String)

    • color ko.observable(String)

    • tags ko.observableArray(String)

    • image ko.observable(String)

    • contextMenu ko.observable(Object)

    • components ko.observable(Object)

    • hiddenInLibrary ko.observable(Boolean)

  • parameter Function ( expression: String ) { return ko.observable }: takes an expression and returns an observable with the app's (scoped) parameter

  • hasParentComponent Function ( name: String, stepID: String ) { return Boolean }

componentProviderAPI

  • registerComponent Function ( sourcePath : String, componentNames : Array, parameters : Object ) { return Promise }: register a component in the component provider entry to enable linking

  • componentProviderEvents Events Object: contains a cloneConfiguration event which is called when the component config shall be duplicated in case an app is unlinked

StepAPI

  • id String

  • name ko.observable(String)

  • label ko.observable(String)

  • pilot ko.observable(Object): the pilot configuration

  • focused ko.observable(Boolean)

  • available ko.observable(Boolean)

  • configured ko.observable(Boolean)

  • steps ko.observableArray(): child steps

  • focus Function ( ): focus the step

  • done Function ( ): mark step as done and focus next step

  • parent Object: points to the parent step

  • next Object: points to the next step

  • prev Object: points to the previous step

  • update Function ( Object ): update any of the step's observable properties by passing an Object with the names of the observables to be modified as keys

ParameterAPI

  • reset Function ( ): reset parameter to the default value

  • isDirty Function ( ) { return Boolean }: returns true, if parameter was modified

  • accessPath Function ( ) { return Array(String) }: returns the access path of the parameter

  • parameter Function (String): returns a subtree of the parameter by passing an expression