py4cytoscape.style_bypasses.set_edge_property_bypass

set_edge_property_bypass(edge_names, new_values, visual_property, bypass=True, network=None, base_url='http://127.0.0.1:1234/v1')[source]

Set Edge Property Bypass.

Set bypass values for any edge property of the specified edges, overriding default values and mappings defined by any visual style.

This method permanently overrides any default values or mappings defined for the visual properties of the edge or edges specified. To restore defaults and mappings, use clear_edge_property_bypass().

Parameters

  • edge_names (str or list or int or None) – List of edges as list of edge names or SUIDs, comma-separated string of edge names or SUIDs, or scalar edge name or SUID. Edge names should be found in the name column of the edges table.

  • new_values (list) – List of values to set, or single value

  • visual_property (str) – Name of a visual property. See get_visual_property_names.

  • bypass (bool) – Whether to set permanent bypass value. Default is True

  • 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://localhost:1234 and the latest version of the CyREST API supported by this version of py4cytoscape.

Returns

’’

Return type

str

Raises

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

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

Examples

>>> edge_names = list(get_table_columns(table='edge', columns='name')['name'])
>>> set_edge_property_bypass(edge_names, '#FF00FF', 'EDGE_UNSELECTED_PAINT')
{'data': {}, 'errors': []}
>>> set_edge_property_bypass('YDR277C (pp) YDL194W, YDR277C (pp) YJR022W', ['#FF00FF'], 'EDGE_UNSELECTED_PAINT')
{'data': {}, 'errors': []}
>>> set_edge_property_bypass('YDR277C (pp) YDL194W, YDR277C (pp) YJR022W', ['red'], 'EDGE_UNSELECTED_PAINT')
{'data': {}, 'errors': []}
>>> edge_suids = list(get_table_columns(table='edge', columns='name').index)
>>> set_edge_property_bypass(edge_suids, ['#FF00FF'], 'EDGE_UNSELECTED_PAINT', network='galFiltered.sif')
{'data': {}, 'errors': []}
>>> set_edge_property_bypass('12755, 13877', ['#FF00FF'], 'EDGE_UNSELECTED_PAINT')
{'data': {}, 'errors': []}
>>> set_edge_property_bypass(12755, '#FF00FF', 'EDGE_UNSELECTED_PAINT')
{'data': {}, 'errors': []}

Note

To identify a node whose name contains a comma, use ‘\’ to escape the comma. For example, ‘node1 (pd) node\,2’ identifies ‘node1 (pd) node,2’.

See also

clear_edge_property_bypass()