py4cytoscape.layouts.scale_layout

scale_layout(axis, scale_factor, selected_only=False, network=None, base_url='http://127.0.0.1:1234/v1')[source]

Scale the layout to a network.

Parameters

  • axis (str) – Scale the layout in either the X, Y, or both directions. Choices are ‘X Axis’, ‘Y Axis” or ‘Both Axes’

  • scale_factor (int or float) – Scale the layout along the named axis

  • selected_only (bool) – Whether to scale only currently selected nodes. Default is false.

  • network (SUID or str or None) – Name or SUID of the network; default is “current” network.

  • 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

{} empty

Return type

dict

Raises

  • CyError – if network name is invalid

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

Examples

>>> scale_layout('X Axis', 2, selected_only=False, network='current')
{}