Versions Compared

Key

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


Panel
titleDescription

Opens the window with the given path. If the window is already open, brings it to the front. The optional params dictionary contains key:value pairs which will be used to set the target window's root container's dynamic variables.

For instance, if the window that you are opening is named "TankDisplay" and has a dynamic variable in its root container named "TankNumber", then callingsystem.nav.openWindow("TankDisplay", {"TankNumber" : 4}) will open the "TankDisplay" window and set Root Container.TankNumber to four. This is useful for making parameterized windows, that is, windows that are re-used to display information about like pieces of equipment. See also: Parameterized Popup Windows.

Client permissions restrictions


Panel
titleSyntax

system.nav.openWindow(path, [params])

  • Parameters

String path - The path to the window to open.

Dictionary[String, Any] params - A dictionary of parameters to pass into the window. The keys in the dictionary must match dynamic property names on the target window's root container. The values for each key will be used to set those properties. [optional]

  • Returns

Window A reference to the opened window. Refer to the list of window objects.

  • Scope

Vision Client

Panel
titleCode Examples
Code Block
languagepy
titleCode Snippet
# This is the simplest form of openWindow.
system.nav.openWindow("SomeWindowName")
Code Block
languagepy
titleCode Snippet
# A more complex example - a setpoint screen for multiple valves that opens centered.
titleText = "Third Valve Setpoints"
tankNo = system.nav.openWindow("ValveSetPts", {"valveNum":3, "titleText":titleText})
system.nav.centerWindow("ValveSetPts")
Code Block
languagepy
titleCode Snippet
# Opens a popup window, and sets the dimensions to 100 pixels x 100 pixels. 
window = system.nav.openWindow("popup")
window.size = (100,100)
Panel
titleKeywords

system nav openWindow, nav.openWindow