py4cytoscape.style_bypasses.set_node_property_bypass
-
set_node_property_bypass
(node_names, new_values, visual_property, bypass=True, network=None, base_url='http://127.0.0.1:1234/v1')[source] Set Node Property Bypass.
Set bypass values for any node property of the specified nodes, 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 node or nodes specified. To restore defaults and mappings, use
clear_node_property_bypass()
.- 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 thename
column of thenodes 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 node, visual property or network name doesn’t exist
requests.exceptions.RequestException – if can’t connect to Cytoscape or Cytoscape returns an error
Examples
>>> node_names = list(get_table_columns(columns='name')['name']) >>> set_node_property_bypass(node_names, '#FF00FF', 'NODE_FILL_COLOR') '' >>> set_node_property_bypass(node_names, 'red', 'NODE_FILL_COLOR') '' >>> set_node_property_bypass('YDL194W, YDR277C', '#FF00FF', 'NODE_FILL_COLOR') '' >>> node_suids = list(get_table_columns(columns='name').index) >>> set_node_property_bypass(node_suids, ['#FF00FF'], 'NODE_FILL_COLOR', network='galFiltered.sif') '' >>> set_node_property_bypass('12755, 13877', '#FF00FF', 'NODE_FILL_COLOR') '' >>> set_node_property_bypass(12755, ['#FF00FF'], '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’.
See also