Versions Compared

Key

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


Panel
titleDescription

Closes a docked view.

Panel
titleSyntax

system.perspective.closeDock(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] 

  • Returns

Nothing

  • Scope

Gateway, Perspective Session

Panel
titleCode Examples
Code Block
languagepy
titleCode Snippet
# Closes a docked view with the given dock id.
system.perspective.closeDock('myDockID')
Panel
titleKeywords

system perspective closeDock, perspective.closeDock