py4cytoscape.networks.create_cytoscapejs_from_network

create_cytoscapejs_from_network(network=None, base_url='http://127.0.0.1:1234/v1')[source]

Create a Cytoscape JS representation of a Cytoscape network.

Notes

Takes a Cytoscape network and translates its nodes and edges into a dict corresponding to a Cytoscape JS JSON document. Attributes, node positions and network metadata are also captured.

Parameters

network (SUID or str or None) – Name or SUID of a network or view. Default is the “current” network active in Cytoscape.
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

The Cytoscape JS object

Return type

dict

Raises

CyError – if network name or SUID doesn’t exist
requests.exceptions.RequestException – if can’t connect to Cytoscape or Cytoscape returns an error

Examples

>>> create_cytoscapejs_from_network()
{'format_version': '1.0',
 'generated_by': 'cytoscape-3.9.1',
 'target_cytoscapejs_version': '~2.1',
 'data': {
   'shared_name': 'galFiltered.sif',
   'Dataset_Name': 'Yeast Perturbation Network',
   '__Annotations': [''],
   'name': 'galFiltered.sif',
   'SUID': 3027163,
   'selected': True},
 'elements': {'nodes': [ ... ], 'edges': [ ... ]}