py4cytoscape.layouts.get_layout_property_names¶
-
get_layout_property_names
(layout_name, base_url='http://127.0.0.1:1234/v1')[source]¶ Returns a list of the tunable properties for the specified layout.
Run
getLayoutNames
to list available layouts- Parameters
layout_name (str) – Name of the layout
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
strings naming layout parameters
- Return type
list
- Raises
requests.exceptions.RequestException – if layout_name is invalid or can’t connect to Cytoscape or Cytoscape returns an error
Examples
>>> get_layout_property_names('force-directed') ['numIterations', 'defaultSpringCoefficient', 'defaultSpringLength', 'defaultNodeMass', 'isDeterministic', 'singlePartition']