Note

This documents the development version of NetworkX. Documentation for the current release can be found here.

networkx.drawing.layout.spiral_layout

spiral_layout(G, scale=1, center=None, dim=2, resolution=0.35, equidistant=False)[source]

Position nodes in a spiral layout.

Parameters
  • G (NetworkX graph or list of nodes) – A position will be assigned to every node in G.

  • scale (number (default: 1)) – Scale factor for positions.

  • center (array-like or None) – Coordinate pair around which to center the layout.

  • dim (int) – Dimension of layout, currently only dim=2 is supported. Other dimension values result in a ValueError.

  • resolution (float) – The compactness of the spiral layout returned. Lower values result in more compressed spiral layouts.

  • equidistant (bool) – If True, nodes will be plotted equidistant from each other.

Returns

pos – A dictionary of positions keyed by node

Return type

dict

Raises

ValueError – If dim != 2

Examples

>>> G = nx.path_graph(4)
>>> pos = nx.spiral_layout(G)

Notes

This algorithm currently only works in two dimensions.