ForceAtlas2 Layout

ForceAtlas2 Layout#

graphistry.layout.fa2.compute_bounding_boxes(self, partition_key, engine)#

Returns the bounding boxes for each partition based on the center coordinates and dimensions of the nodes. DF keys: - cx: Center x-coordinate - cy: Center y-coordinate - w: Width - h: Height - partition_key: Partition key

Parameters:

  • self (Plottable)

  • partition_key (str)

  • engine (Engine)

Return type:

Any

graphistry.layout.fa2.fa2_layout(self, fa2_params=None, circle_layout_params=None, singleton_layout=None, partition_key=None, engine=EngineAbstract.AUTO, allow_cpu_fallback=False)#

Applies FA2 layout for connected nodes and circle layout for singleton (edgeless) nodes

Allows optional parameterization of the circle layout, e.g., ring and point spacing

Parameters:

  • self (graphistry.Plottable.Plottable) – The graph object with nodes and edges, in a format compatible with Graphistry’s Plottable object.

  • fa2_params (Optional[Dict[str, Any]]) – Optional parameters for the underlying force-directed layout, forwarded as params= to layout_cugraph(‘force_atlas2’, …) on GPU or layout_igraph(‘fr’, …) on CPU.

  • circle_layout_params (Optional[Dict[str, Any]]) – Optional parameters for customizing the circle layout, passed through to graphistry.layout.circle.circle_layout(). Can include: - partition_by: Node column(s) selecting one circle per partition. - ring_spacing: Spacing between rings in the circle layout. - point_spacing: Spacing between points in each ring. - sort_by / ascending: accepted, but currently have no effect on positions (see circle_layout).

  • singleton_layout (Optional[Callable[[Plottable, Tuple[float, float, float, float] | Any], Plottable]]) – Optional custom layout function for singleton nodes (default: circle_layout).

  • partition_key (Optional[str]) – The key for partitioning nodes (used for picking bounding box type). Default is None.

  • allow_cpu_fallback (bool) – When True, allow a CPU (igraph Fruchterman-Reingold) fallback instead of raising. Only intended for internal callers that explicitly expect the approximation.

  • engine (EngineAbstract | str)

Returns:

A graph object with FA2 and circle layouts applied.

Return type:

graphistry.Plottable.Plottable