py4cytoscape.layouts.get_layout_name_mapping

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

Get Layout Name Mapping.

The Cytoscape ‘Layout’ menu lists many layout algorithms, but the names presented there are different from the names by which these algorithms are known to `layout_network` method. This method returns a named list in which the names are from the GUI, and the values identify the names you must use to choose an algorithms in the programmatic interface.

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

{gui-layout-name: layout_name, …}

Return type

dict

Raises

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

Examples

>>> get_layout_name_mapping()
{'Attribute Circle Layout': 'attribute-circle', 'Stacked Node Layout': 'stacked-node-layout' ...}