We use proprietary and third party's cookies to improve your experience and our services, identifying your Internet Browsing preferences on our website; develop analytic activities and display advertising based on your preferences. If you keep browsing, you accept its use. You can get more information on our Cookie Policy
Cookies Policy
Interface Designer API Specification - FIWARE Forge Wiki

Interface Designer API Specification

From FIWARE Forge Wiki

Jump to: navigation, search

This is an Interface Designer javascript API. More functionality and details are to be added, and existing ones may be modified.

  • Editor
    • setEnabled( toggle:bool ) : void
      • Enables or disables the editor, depending on "toggle" value
      • Arguments: toggle:bool
      • This method does not return a value.
    • isEditorEnabled() : bool
      • Checks if the editor is enabled.
      • Arguments: none
      • Returns "true" if the editor is enabled and "false" if it is disabled.
    • switchPanels(ecPanel : bool) : void
      • Switches between Scene Tree panel and EC panel. If "ecPanel" is true, the EC panel will be shown, otherwise the Scene Tree editor is shown
      • Arguments: ecPanel:bool
      • This method does not return a value.
    • setSwitchPanelsShortcut(meta : string, key : string) : void
      • Sets a new shortcut instead of the default "Shift + E" for switching between EC and Scene Tree panels. The variable "meta" can accept values such as "ctrl", "shift", "alt" or "meta", while "key" accepts any key that is on the keyboard
      • Arguments: meta : string, key : string
      • This method does not return a value.
    • setToggleEditorShortcut(meta : string, key : string) : void
      • Sets a new shortcut instead of the default "Shift + S" for enabling / disabling the editor. The variable "meta" can accept values such as "ctrl", "shift", "alt" or "meta", while "key" accepts any key that is on the keyboard
      • Arguments: meta : string, key : string
      • This method does not return a value.
    • selectEntity ( entityPtr : EntityWrapper ) : void
      • Assigns a target entity "entityPtr" to be edited. The editor UI will switch the EC panel and then build the UI in correspondence with the contents of the target entity
      • Arguments: entityPtr : EntityWrapper, a reference to an EntityWrapper instance.
      • This method does not return a value.
Personal tools
Create a book