Skip to end of metadata
Go to start of metadata

This function is used in Python Scripting.

Description

Navigate the session to a specified view or mounted page.

The function can be used in three different ways, depending on which parameter is specified:

  • page: Navigates to a Perspective page.
  • url: Navigates to a web address, so the function can be used to navigate the user to a web portal, search engine, or other website. This parameter is specified via keyword argument.
  • view: Navigates to a view. Note that using this parameter does not modify the web browser's address bar, so the browser's history will not contain a listing for the new view. This parameter is specified via keyword argument.
Syntax

Note: This function accepts keyword arguments.
system.perspective.navigate(page,  [url], [view], params], [sessionId], [pageId], [newTab] )

  • Parameters

String page - The URL of a Perspective page to navigate to. The path can include an optional leading slash: "new-page" and "/new-page" both result cause the session to navigate to the "new-page" page. See Page URLs.

String url - The URL of a web address to navigate to. If the page or view parameters are specified, then this parameter is ignored. [optional]

String view - If specified, will navigate to a specific view. Navigating to a view with this parameter does not change the address in the web browser. Thus the web browser's back button will not be able to return the user to the previous view. If the page parameter is specified, then this parameter is ignored. [optional]

Dictionary[String, String] params - Used only in conjunction with the view parameter, Dictionary of values to pass to any parameters on the view. [optional]

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]

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]

The following feature is new in Ignition version 8.1.5
Click here to check out the other new features

Boolean  newTab -  If True, opens the contents in a new tab. [optional]

  • Returns

Nothing

  • Scope

Gateway, Perspective Session


Code Examples
Code Snippet - Page
# Navigating to a perspective-page. The 'page' parameter doesn't require the use of a keyword argument.
system.perspective.navigate('/new-page')
Code Snippet - Web Address
# Navigating to a web address. Note that we're using a keyword argument here.
# web addresses must use a scheme (like 'http://') at the beginning
system.perspective.navigate(url = 'http://docs.inductiveautomation.com')
Code Snippet - View
# Navigating to a new view. Again, we need to use a keyword argument. We are passing in two parameters, called "myParam" and "myParam2".
system.perspective.navigate(view = 'folder/myView', params = {'myParam':1,'myParam2':'Test'})
Keywords

system perspective navigate, perspective.navigate