py4cytoscape.style_bypasses.set_network_property_bypass

set_network_property_bypass(new_value, visual_property, bypass=True, network=None, base_url='http://127.0.0.1:1234/v1')[source]

Set Network Property Bypass.

Set bypass values for any network property, overriding default values defined by any visual style.

This method permanently overrides any default values or mappings defined for the visual properties of the network specified. To restore defaults and mappings, use clear_network_property_bypass().

Parameters

  • new_value (any) – Value to set

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

  • bypass (bool) – Whether to set permanent bypass value. Default is True

  • 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://localhost:1234 and the latest version of the CyREST API supported by this version of py4cytoscape.

Returns

’’

Return type

str

Raises

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

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

Examples

>>> set_network_property_bypass(0.5, 'NETWORK_SCALE_FACTOR')
''
>>> set_network_property_bypass(0.5, 'NETWORK_SCALE_FACTOR', network='galFiltered.sif')
''

See also

clear_network_property_bypass()