incendium.vision.nav.swap_windows

Description

Performs a window swap.

Syntax

swap_windows(from_path, to_path[, params])

Args:

• from_path (str): The path of the window to swap from.
• to_path (str): The full path or relative path of the window to swap to.
• params (dict): A dictionary of parameters to pass into the window. The keys in the dictionary must match dynamic property names on the target window's root container. The values for each key will be used to set those properties. Optional.

Recommendations

None.

Code Examples

This function allows you to swap between two windows by using relative paths, but it also works with full paths.

# Imports.
from incendium.vision import nav

# Windows:
# From: 'Path/To/From/Window'
# To: 'Path/To/Window'

nav.swap_windows('Path/To/From/Window', '../Window')