py4cytoscape.style_values.get_edge_color

get_edge_color(edge_names=None, network=None, base_url='http://127.0.0.1:1234/v1')[source]

Retrieve the actual line color of specified edges.

Parameters

  • edge_names (list) – List of edge names or edge SUIDs. Default is None for all edges.

  • 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

as a collection of {edge-name: line-color} for each edge in edge_names parameter

Return type

dict

Raises

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

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

Examples

>>> get_edge_color()
{'YMR117C (pp) YCL032W': '#808080', 'YMR255W (pp) YGL122C': '#808080', 'YNL214W (pp) YGL153W': '#808080', ...}
>>> get_edge_color(['YHR084W (pd) YFL026W', 'YHR084W (pd) YDR461W', 'YMR255W (pp) YGL122C'])
{'YHR084W (pd) YFL026W': '#808080', 'YHR084W (pd) YDR461W': '#808080', 'YMR255W (pp) YGL122C': '#808080'}
>>> get_edge_color([421382, 421383, 421380])
{421382: '#808080', 421383: '#808080', 421380: '#808080'}
>>> get_edge_color(edge_names='YOR355W (pp) YNL091W', network='galFiltered.sif')
{'YOR355W (pp) YNL091W': '#808080'}