py4cytoscape.layouts.get_layout_property_type

get_layout_property_type(layout_name, property_name, base_url='http://127.0.0.1:1234/v1')[source]

Returns the type of one of the tunable properties (property_name) for the specified layout.

Run getLayoutNames to list available layouts. Run getLayoutPropertyNames to list properties per layout.

Parameters

  • layout_name (str) – Name of the layout

  • property_name (str) – Name of the property

  • 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

  • KeyError – if property_name is invalid

  • 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','defaultSpringLength')
"double"