py4cytoscape.style_bypasses.set_edge_tooltip_bypass

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

Sets a bypass tooltip for one or more edges.

This method permanently overrides any default values or mappings defined for this visual property of the edge or edges specified. This method ultimately calls the generic function, set_edge_property_bypass() which can be used to set any visual property. To restore defaults and mappings, use clear_edge_property_bypass(), see examples.

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_tooltip (str or list) – list of size values or single value

  • 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 or network name doesn’t exist

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

Examples

>>> set_edge_tooltip_bypass(get_edge_names(), 'Some Tooltip')
''
>>> set_edge_tooltip_bypass(['YJR022W (pp) YNL050C', 'YJR022W (pp) YNR050C'], ['One Tooltip', 'Other Tooltip'], network='galFiltered.sif')
''
>>> set_edge_tooltip_bypass('YJR022W (pp) YNL050C, YJR022W (pp) YNR050C', ['One Tooltip', 'Other Tooltip'], network='galFiltered.sif')
''
>>> set_edge_tooltip_bypass([10288, 16300], ['One Tooltip', 'Other Tooltip'], network='galFiltered.sif')
''
>>> set_edge_tooltip_bypass('10288, 16300', ['One Tooltip', 'Other Tooltip'], network='galFiltered.sif')
''
>>> set_edge_tooltip_bypass(10288, 'Some Tooltip')
''

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

set_edge_property_bypass(), clear_edge_property_bypass()