py4cytoscape.style_values.get_network_property

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

Get values for any network property.

This method retrieves the actual property of the network, given the current visual style, factoring together any default, mapping and bypass setting.

Parameters

  • visual_property (str) – Name of a visual property. See get_visual_property_names

  • network (SUID or str or None) – Name or SUID of a network. 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

value of visual property

Return type

float

Raises

  • CyError – if network name or property name doesn’t exist

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

Examples

>>> get_network_property('NETWORK_SCALE_FACTOR')
0.6299925248514752
>>> get_network_property(visual_property='NETWORK_SCALE_FACTOR', network='galFiltered.sif')
0.6299925248514752