py4cytoscape.style_mappings.set_node_shape_mapping

set_node_shape_mapping(table_column, table_column_values=None, shapes=None, default_shape=None, style_name=None, network=None, base_url='http://127.0.0.1:1234/v1')[source]

Map table column values to shapes to set the node shape.

Parameters
  • table_column (str) – Name of Cytoscape table column to map values from

  • table_column_values (list) – List of values from Cytoscape table to be used in mapping

  • shapes (list) – List of shapes to map to table_column_values. See get_node_shapes()

  • default_shape (str) – Shape to set as default. See get_node_shapes()

  • style_name (str) – name for style

  • 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

’’

Return type

str

Raises
  • CyError – if table column doesn’t exist, table column values doesn’t match values list, or invalid style name, network or mapping type

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

Examples

>>> set_node_shape_mapping('Degree', table_column_values=['1', '2'], shapes=['TRIANGLE', 'OCTAGON'], default_shape='ELLIPSE', style_name='galFiltered Style')
''
>>> set_node_shape_mapping(**gen_node_shape_map('Degree', style_name='galFiltered Style'))
''

See also

gen_node_shape_map()

See also

Value Generators in the Concepts section in the py4cytoscape User Manual.