py4cytoscape.style_mappings.get_style_all_mappings

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

Fetch all visual property mapping in a style.

The property mappings are the same as a dict created by map_visual_property().

Parameters

  • style_name (str) – name for style

  • 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

list of dicts of the type created by map_visual_property()

Return type

list

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_all_mappings('galFiltered Style')
[{"mappingType": "passthrough", "mappingColumn": "name", "mappingColumnType": "String", "visualProperty": "NODE_LABEL"},
 {"mappingType": "passthrough", "mappingColumn": "interaction", "mappingColumnType": "String", "visualProperty": "EDGE_LABEL"}]

See also

map_visual_property()