system.perspective.closeDock

This function is used in Python Scripting.

Description

Closes a docked view.

Syntax

tip

This function accepts keyword arguments.

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

Parameters

Type	Parameter	Description
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

note

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

Code Examples

Code Snippet

# Closes a docked view with the given dock id.
system.perspective.closeDock('myDockID')