Versions Compared

Old Version 12

changes.mady.by.user Paul Scott

Saved on

compared with

New Version Current

changes.mady.by.user Maria Ipsaro

Saved on

Key

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


Scripting_function



Panel
titleDescription

Opens a docked View. Requires the preconfigured dock ID for the view.


Panel
titleSyntax

system.perspective.openDock(id [, sessionId, pageId])

  • Parameters

String id - The unique, preconfigured 'Dock ID' for the docked View. Is specified when a View is assigned as docked for a particular Page (in Page Configuration).

String sessionId - Identifier of the Session to target. If omitted, the current Session will be used automatically. When targeting a different session, then the pageId parameter must be included in the call. [optional]

String pageId - Identifier of the Page to target. If omitted, the current Page will be used automatically. [optional]

PyDictionary params - Parameters that can be passed into the docked view. Must match the docked views View Parameters. Added in 8.0.1. [optional]

  • Returns

None

  • Scope

Perspective Session



Panel
titleCode Examples


Code Block
languagepy
titleCode Snippet - View
# Opens a docked view with a dock ID of "myDockID" on the current page and session.
system.perspective.openDock("myDockID", params = {"stationNum":2})




Panel
titleKeywords

system perspective openDock, perspective.openDock