py4cytoscape.network_selection.get_selected_nodes

get_selected_nodes(node_suids=False, network=None, base_url='http://127.0.0.1:1234/v1')[source]

Retrieve the names of all the nodes selected in the network.

Parameters

  • node_suids (bool) – Whether to return node SUIDs. Default is FALSE to return node names.

  • network (SUID or str or None) – Name or SUID of a network or view. Default is the “current” network active in Cytoscape.

  • 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

list of selected SUIDs or node names, or None if no nodes are selected

Return type

list

Raises

  • CyError – if network name or SUID doesn’t exist

  • requests.exceptions.RequestException – if can’t connect to Cytoscape or Cytoscape returns an error

Examples

>>> get_selected_nodes()
None
>>> get_selected_nodes(node_suids=False)
['YNL216W', 'YPL075W']
>>> get_selected_nodes(node_suids=True, network='My Network')
[10235, 10236]