py4cytoscape.style_bypasses.set_node_position_bypass

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

Sets the bypass value of node position for one or more nodes. Only applicable if node dimensions are locked. See lock_node_dimensions().

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 clear_node_property_bypass(), see examples.

Parameters

  • node_names (str or list or int) – 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.

  • new_x_locations (list, int or float) – List of x position values, or single value, default is current x position

  • new_y_locations (list, int or float) – List of y position values, or single value, default is current y position

  • 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

>>> set_node_position_bypass(get_node_names(), new_x_locations, new_y_locations)
''
>>> set_node_position_bypass(['YDL194W', 'YBR043C'], [100, 200], [300, 400], network='galFiltered.sif')
''
>>> set_node_position_bypass('YDL194W, YBR043C', [100, 200], [300, 400], network='galFiltered.sif')
''
>>> set_node_position_bypass([1255, 1988], [100, 200], [300, 400], network='galFiltered.sif')
''
>>> set_node_position_bypass('1255, 1988', [100, 200], [300, 400], network='galFiltered.sif')
''
>>> set_node_position_bypass(1255, 100, 300, 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(), clear_node_property_bypass(), lock_node_dimensions()