py4cytoscape.network_selection.clear_selection

clear_selection(type='both', network=None, base_url='http://127.0.0.1:1234/v1')[source]

If any nodes are selected in the network, they will be unselected.

Parameters

  • type (str) – What kinds of objects to deselect: ‘nodes’, ‘edges’ or ‘both’ (default)

  • 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

‘’ empty

Return type

str

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

>>> clear_selection()
''
>>> clear_selection(type='both')
''
>>> clear_selection(type='nodes', network=52)
''