py4cytoscape.network_views.toggle_graphics_details

toggle_graphics_details(base_url='http://127.0.0.1:1234/v1')[source]

Toggle Graphics Details.

Regardless of the current zoom level and network size, show (or hide) graphics details, e.g., node labels.

Displaying graphics details on a very large network will affect pan and zoom performance, depending on your available RAM. See cytoscape_memory_status().

Parameters

  • network (str or SUID or None) – Name or SUID of the network or view. Default is the “current” network active in Cytoscape. If a network view SUID is provided, then it is validated and returned.

  • base_url (str) – Ignore unless you need to specify a custom domain, port or version to connect to the CyREST API. Default is http://127.0.0.1:1234 and the latest version of the CyREST API supported by this version of py4cytoscape.

Returns

{‘message’: ‘Toggled Graphics level of details.’}

Return type

dict

Raises

  • CyError – if network or view doesn’t exist

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

Examples

>>> toggle_graphics_details()
{'message': 'Toggled Graphics level of details.'}