py4cytoscape.style_bypasses.hide_selected_nodes

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

Hide Selected Nodes.

Hide (but do not delete) the currently selected nodes, by setting the Visible property bypass value to false.

This method permanently overrides any default values or mappings defined for this visual property of the node or nodes specified. This method ultimately calls the generic function, set_node_property_bypass(), which can be used to set any visual property. To restore defaults and mappings, use unhide_nodes() or unhide_all().

Parameters

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

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

Examples

>>> hide_selected_nodes()
''
>>> hide_selected_nodes(network='galFiltered.sif')
''

See also

set_node_property_bypass(), hide_nodes(), unhide_nodes(), unhide_all()