Skip to main content
Version: 8.1

system.perspective.openDock

This function is used in Python Scripting.

Description

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

Syntax

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

Parameters

TypeParameterDescription
StringidThe unique, preconfigured dock ID for the docked View. Is specified when a View is assigned as docked for a particular Page (in Page Configuration).
StringsessionIdIdentifier 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]
StringpageIdIdentifier of the Page to target. If omitted, the current Page will be used automatically. [optional]
Dictionary[String, String]paramsParameters that can be passed into the docked view. Must match the docked views View Parameters. [optional]

Returns

Nothing

Scope

Gateway, Perspective Session

note

This function will only work in the Gateway scope if both sessionId and pageId are supplied to the call.

Code Examples

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

Keywords

system perspective openDock, perspective.openDock