py4cytoscape.network_selection.get_selected_edges

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

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

Parameters

  • edge_suids (bool) – Whether to return edge SUIDs. Default is FALSE to return edge names.

  • network (SUID or str or None) – Name or SUID of a network. 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 edge names (or SUIDs if edge_suids is True) – None if no edges 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_edges()
None
>>> get_selected_edge_count(network='My Network')
['YGL035C (pd) YIL162W', 'YGL035C (pd) YLR044C', 'YNL216W (pd) YLR044C']
>>> get_selected_edge_count(edge_suids=True, network=52)
[27656, 27658, 27716]