network (Graph
) – Graph to plot.
radial (str, list of str or array-like) – Values that will be used to place the nodes on the axes. Either one
identical property is used for all axes (traditional hive plot) or
one radial coordinate per axis is used (custom hive plot).
If radial is a string or a list of strings, then these must correspond
to the names of node attributes stored in the graph.
axes (str, or list of str, optional (default: one per radial coordinate)) – Name of the attribute(s) that will be used to make each of the axes
(i.e. each group of nodes).
This can be either “groups” if the graph has a structure or is a
Network
, a list of (Meta)Group names, or any (list of)
node attribute(s).
If a single node attribute is used, axes_bins must be provided to
make one axis for each range of values.
If there are multiple radial coordinates, then leaving axes blanck
will plot all nodes on each of the axes (one per radial coordinate).
axes_bins (int or array-like, optional (default: all nodes on each axis)) – Required if there is a single radial coordinate and a single axis
entry: provides the bins that will be used to separate the nodes
into groups (one per axis). For N axes, there must therefore be N + 1
entries in axes_bins, or axis_bins must be equal to N, in which
case the nodes are separated into N evenly sized bins.
axes_units (str, optional) – Units used to scale the axes. Either “native” to have them scaled
between the minimal and maximal radial coordinates among all axes,
“rank”, to use the min and max ranks of the nodes on all axes, or
“normed”, to have each axis go from zero (minimal local radial
coordinate) to one (maximal local radial coordinate).
“native” is the default if there is a single radial coordinate,
“normed” is the default for multiple coordinates.
axes_angles (list of angles, optional (default: automatic)) – Angles for each of the axes, by increasing degree. If
intra_connections is True, then angles of duplicate axes must be
adjacent, e.g. [a1, a1bis, a2, a2bis, a3, a3bis]
.
axes_labels (str or list of str, optional) – Label of each axis. For binned axes, it can be automatically formatted
via the three entries {name}
, {start}
, {stop}
.
E.g. “{name} in [{start}, {stop}]” would give “CC in [0, 0.2]” for
a first axis and “CC in [0.2, 0.4]” for a second axis.
intra_connections (bool, optional (default: True)) – Show connections between nodes belonging to the same axis. If true,
then each axis is duplicated to display intra-axis connections.
highlight_nodes (list of nodes, optional (default: all nodes)) – Highlight a subset of nodes and their connections, all other nodes
and connections will be gray.
highlight_edges (list of edges, optional (default: all edges)) – Highlight a subset of edges; all other connections will be gray.
nsize (float, str, or array-like, optional (default: automatic)) – Size of the nodes on the axes. Either a fixed size, the name of a
node attribute, or a list of user-defined values.
esize (float or str, optional (default: 1)) – Size of the edges. Either a fixed size or the name of an edge
attribute.
max_nsize (float, optional (default: 10)) – Maximum node size if nsize is an attribute or a list of
user-defined values.
max_esize (float, optional (default: 1)) – Maximum edge size if esize is an attribute.
axes_colors (valid matplotlib color/colormap, optional (default: Set1)) – Color associated to each axis.
nborder_color (matplotlib color, optional (default: “k”)) – Color of the node’s border.
or floats in [0, 1] defining the position in the palette.
nborder_width (float, optional (default: 0.2)) – Width of the border.
edge_colors (valid matplotlib color/colormap, optional (default: auto)) – Color of the edges. By default it is the intermediate color between
two axes colors. To provide custom colors, they must be provided as
a dictionnary of axes edges {(0, 0): "r", (0, 1): "g", (1, 0): "b"}
with default color being black.
edge_alpha (float, optional (default: 0.05)) – Edge opacity.
show_names (bool, optional (default: True)) – Show axes names and properties.
show_circles (bool, optional (default: False)) – Show the circles associated to the maximum value of each axis.
axis (matplotlib axis, optional (default: create new axis)) – Axis on which the network will be plotted.
tight (bool, optional (default: True)) – Set figure layout to tight (set to False if plotting multiple axes on
a single figure).
show (bool, optional (default: True)) – Display the plot immediately.