py4cytoscape.tools.cybrowser_list

cybrowser_list(base_url='http://127.0.0.1:1234/v1')[source]

Cybrowser List.

List all browsers that are currently open, whether as a dialog or in the results panel.

Parameters: base_url (str) – Ignore unless you need to specify a custom domain, port or version to connect to the CyREST API. Default is http://127.0.0.1:1234 and the latest version of the CyREST API supported by this version of py4cytoscape.
Returns: [{‘id’: id, ‘title’: title, ‘url’: current url}]
Return type: list
Raises: requests.exceptions.RequestException – if can’t connect to Cytoscape or Cytoscape returns an error

Examples

>>> cybrowser_list()
[{'id': 'CytoManual ID', 'title': 'CytoManual Page', 'url': 'http://manual.cytoscape.org/en/stable/'}, {'id': ...} ...]

Note

In the return value, there is a dict for each browser window, and the id and title were provided in the cybrowser_show() call, and the url is for the page currently loaded in the browser window