py4cytoscape.layouts.layout_network

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

Apply a layout to a network.

Run getLayoutNames to list available layouts.

Note that yFiles layouts are not available due to licensing restrictions with yWorks, the owner of yFiles.

Parameters

  • layout_name (str) – Name of the layout (with optional parameters). If not specified, then the preferred layout set in the Cytoscape UI is applied.

  • network (SUID or str or None) – Name or SUID of the network; default is “current” network.

  • 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

{} empty

Return type

dict

Raises

  • CyError – if layout_name is invalid

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

Examples

>>> layout_network() # Layout current network using default layout
{}
>>> layout_network('force-directed') # Layout current network using force-directed layout
{}
>>> layout_network('grid', 'yeastHighQuality.sif') # layout named network using grid layout
{}