py4cytoscape.style_bypasses.hide_nodes

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

Hide Nodes.

Hide (but do not delete) the specified node or 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

  • node_names (str or list or int or None) – List of nodes as list of node names or SUIDs, comma-separated string of node names or SUIDs, or scalar node name or SUID. Node names should be found in the name column of the nodes table.

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

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

Examples

>>> hide_nodes(get_node_names())
''
>>> hide_nodes(['YDL194W', 'YBR043C'], network='galFiltered.sif')
''
>>> hide_nodes('YDL194W, YBR043C', network='galFiltered.sif')
''
>>> hide_nodes([1255, 1988], network='galFiltered.sif')
''
>>> hide_nodes('1255, 1988', network='galFiltered.sif')
''
>>> hide_nodes(1255, network='galFiltered.sif')
''

Note

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

See also

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