Versions Compared

Old Version 3

changes.mady.by.user BrightSign TechDocs

Saved on

compared with

New Version 4

changes.mady.by.user BrightSign TechDocs

Saved on

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

Insert excerpt
BrightScript Version Navigation Menu
BrightScript Version Navigation Menu
nopaneltrue

This BrightScript object launches an Electron instance from a BrightScript runtime. 

All BrightSign Javascript objects are available to use with Electron, and BrightSign mechanisms allow communication between Javascript (Electron main processes) and BrightScript (BrightSign processes).

Note
titleNote

roElectron objects can only be created on BrightSignOS 8.3.* NX releases - standard releases do not include the Electron runtime.

Panel
borderColor#3D3D3D
bgColor#F4F4F4
titleColor#3D3D3D
borderWidth0
titleBGColor#3D3D3D
borderStylesolid

ON THIS PAGE

Table of Contents
indent20px

Object Creation

roElectron takes two parameters: a filename and an options parameter.

Code Block
languagejs
aa = CreateObject("roAssociativeArray")
aa.message_port = my_message_port
aa.arguments = CreateObject("roArray")
aa.arguments[0] = "arg1"
aa.arguments[1] = "arg2"
aa.node_arguments = CreateObject("roArray")
aa.node_arguments = {"node_arg1", "node_arg2")
aa.env_vars = CreateObject("roAssociativeArray")
aa.env_vars.AddReplace("ENV_VAR_1", "test")
aa.env_vars.AddReplace("ENV_VAR_2", "true")
node = CreateObject("roElectron", "path/to/my/application", aa)
  • message_port: Optional. A message port to bridge the Electron and BrightScript applications.
  • arguments: Optional. An roArray of arguments for Electron
  • node_arguments: Optional. An roArray of arguments for the Electron application itself to consume.
  • env_vars: Optional. An roAssociativeArray of environment variables for Electron application.

BrightScript associative arrays are case insensitive when object-literal syntax (for example, aa={bright:"Sign"}) is used. Environment variables are generally considered as case sensitive. Use the AddReplace method with an associative array, or call SetModeCaseSensitive() before assigning object-literal syntax variables into an env_vars associative array.