py4cytoscape.style_bypasses.clear_node_property_bypass

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

Clear Node Property Bypass.

Clear bypass values for any node property of the specified nodes, effectively restoring any previously defined style defaults or mappings.

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.
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

{‘data’: {}, ‘errors’: []}

Return type

dict

Raises

CyError – if node, visual property or network name doesn’t exist
TypeError – if node list is None
requests.exceptions.RequestException – if can’t connect to Cytoscape or Cytoscape returns an error

Examples

>>> node_names = list(get_table_columns(columns='name')['name'])
>>> clear_node_property_bypass(node_names, 'NODE_FILL_COLOR')
''
>>> clear_node_property_bypass('YDL194W, YDR277C', 'NODE_FILL_COLOR')
''
>>> node_suids = list(get_table_columns(columns='name').index)
>>> clear_node_property_bypass(node_suids, 'NODE_FILL_COLOR', network='galFiltered.sif')
''
>>> clear_node_property_bypass('12755, 13877', 'NODE_FILL_COLOR')
''
>>> clear_node_property_bypass(12755, 'NODE_FILL_COLOR', 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’.