py4cytoscape.user_interface.hide_panel

hide_panel(panel_name, base_url='http://127.0.0.1:1234/v1')[source]

Hide a panel in the UI of Cytoscape.

Other panels will expand into the space.

Parameters

  • panel_name (str) – Name of the panel. Multiple ways of referencing panels is supported: (WEST == control panel, control, c), (SOUTH == table panel, table, ta), (SOUTH_WEST == tool panel, tool, to), (EAST == results panel, results, r)

  • 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

’’

Return type

str

Raises

  • CyError – if panel name is not recognized

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

Examples

>>> hide_panel('control panel')
''
>>> hide_panel('WEST')
''