py4cytoscape.style_mappings.set_node_border_width_mapping

set_node_border_width_mapping(table_column, table_column_values=None, widths=None, mapping_type='c', default_width=None, style_name=None, network=None, base_url='http://127.0.0.1:1234/v1')[source]

Map table column values to widths to set the node border width.

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
widths (list) – List of width values to map to table_column_values
mapping_type (str) – continuous, discrete or passthrough (c,d,p); default is continuous
default_width (int) – Width value to set as default for all unmapped values
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, or if invalid width
requests.exceptions.RequestException – if can’t connect to Cytoscape or Cytoscape returns an error

Examples

>>> set_node_border_width_mapping('AverageShortestPathLength', table_column_values=[1.0, 16.36], widths=[5, 10], style_name='galFiltered Style')
''
>>> set_node_border_width_mapping('Degree', table_column_values=['1', '2'], widths=[5, 10], mapping_type='d', style_name='galFiltered Style')
''
>>> set_node_border_width_mapping(**gen_node_width_map('Degree', mapping_type='d'))
''
>>> set_node_border_width_mapping(**gen_node_width_map('AverageShortestPathLength', scheme_c_number_continuous(100, 200), style_name='galFiltered Style'))
''
>>> set_node_border_width_mapping('PassthruCol', mapping_type='p', default_width=3, style_name='galFiltered Style')
''