py4cytoscape.style_mappings.get_style_mapping

get_style_mapping(style_name, visual_prop, base_url='http://127.0.0.1:1234/v1')[source]

Fetch a visual property mapping in a style.

The property mapping is the same as a dict created by map_visual_property().

Parameters

  • style_name (str) – name for style

  • visual_prop (str) – the name of the visual property

  • 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

see map_visual_property()

Return type

dict

Raises

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

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

Examples

>>> get_style_mapping('galFiltered Style', 'node label')
{"mappingType": "passthrough", "mappingColumn": "COMMON", "mappingColumnType": "String", "visualProperty": "NODE_LABEL"}

See also

map_visual_property()