Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.
Comment: edits/style, syntax verified by Dev
Scripting_function


Panel
titleDescription

Get a list of all the monitors on the computer this client is open on. Use with system.gui.setScreenIndex to move the client.

Client permissions restrictions


Panel
titleSyntax

system.gui.getScreens()

  • Parameters

Nothing

  • Returns

PySequenceList[Tuple[String, Integer, Integer]] - A sequence of tuples of the form (index, width, height) for each screen device (monitor) available.

  • Scope

Vision Client

Panel
titleCode Examples
Code Block
languagepy
titleCode Snippet - Getting Screen Information
# This example fetches monitor data and pushes it to a table in the same container.

screens = system.gui.getScreens()
pyData = []
for screen in screens:
	pyData.append([screen[0], screen[1], screen[2]])

# Push data to 'Table'.
event.source.parent.getComponent('Table').data = system.dataset.toDataSet(["screen","width","height"], pyData)
Panel
titleKeywords

system gui getScreens, gui.getScreens