py4cytoscape.layouts.get_layout_names

get_layout_names(base_url='http://127.0.0.1:1234/v1')

Retrieve the names of the currently supported layout algorithms.

These may be used in subsequent calls to the layout_network function.

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

Parameters

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

a list of layout names as strings

Return type

list

Raises

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

Examples

>>> get_layout_names()
['attribute-circle', 'stacked-node-layout', 'degree-circle', 'circular', 'attributes-layout', 'kamada-kawai', 'force-directed', 'cose', 'grid', 'hierarchical', 'fruchterman-rheingold', 'isom']