# DO NOT EDIT! This file was auto-generated by crates/build/re_types_builder/src/codegen/python/mod.rs
# Based on "crates/store/re_sdk_types/definitions/rerun/blueprint/views/graph.fbs".
from __future__ import annotations
from typing import TYPE_CHECKING
__all__ = ["GraphView"]
from .. import archetypes as blueprint_archetypes
from ..api import View, ViewContentsLike, VisualizerLike
if TYPE_CHECKING:
from collections.abc import Iterable, Mapping
from ... import datatypes
from ..._baseclasses import (
AsComponents,
DescribedComponentBatch,
)
from ...datatypes import EntityPathLike, Utf8Like
class GraphView(View):
"""
**View**: A graph view to display time-variying, directed or undirected graph visualization.
⚠️ **This type is _unstable_ and may change significantly in a way that the data won't be backwards compatible.**
Example
-------
### Use a blueprint to create a graph view.:
```python
import rerun as rr
import rerun.blueprint as rrb
rr.init("rerun_example_graph_view", spawn=True)
rr.log(
"simple",
rr.GraphNodes(
node_ids=["a", "b", "c"],
positions=[(0.0, 100.0), (-100.0, 0.0), (100.0, 0.0)],
labels=["A", "B", "C"],
),
)
# Create a Spatial2D view to display the points.
blueprint = rrb.Blueprint(
rrb.GraphView(
origin="/",
name="Graph",
# Note that this translates the viewbox.
visual_bounds=rrb.VisualBounds2D(
x_range=[-150, 150], y_range=[-50, 150]
),
background=rrb.archetypes.GraphBackground(color=[30, 10, 10]),
),
collapse_panels=True,
)
rr.send_blueprint(blueprint)
```
"""
def __init__(
self,
*,
origin: EntityPathLike = "/",
contents: ViewContentsLike = "$origin/**",
name: Utf8Like | None = None,
visible: datatypes.BoolLike | None = None,
defaults: Iterable[AsComponents | Iterable[DescribedComponentBatch]] | None = None,
overrides: Mapping[EntityPathLike, VisualizerLike | Iterable[VisualizerLike]] | None = None,
background: blueprint_archetypes.GraphBackground | None = None,
visual_bounds: blueprint_archetypes.VisualBounds2D | None = None,
force_link: blueprint_archetypes.ForceLink | None = None,
force_many_body: blueprint_archetypes.ForceManyBody | None = None,
force_position: blueprint_archetypes.ForcePosition | None = None,
force_collision_radius: blueprint_archetypes.ForceCollisionRadius | None = None,
force_center: blueprint_archetypes.ForceCenter | None = None,
) -> None:
"""
Construct a blueprint for a new GraphView view.
Parameters
----------
origin:
The `EntityPath` to use as the origin of this view.
All other entities will be transformed to be displayed relative to this origin.
contents:
The contents of the view specified as a query expression.
This is either a single expression, or a list of multiple expressions.
See [rerun.blueprint.archetypes.ViewContents][].
name:
The display name of the view.
visible:
Whether this view is visible.
Defaults to true if not specified.
defaults:
List of archetypes or (described) component batches to add to the view.
When an archetype in the view is missing a component included in this set,
the value of default will be used instead of the normal fallback for the visualizer.
Note that an archetype's required components typically don't have any effect.
It is recommended to use the archetype's `from_fields` method instead and only specify the fields that you need.
overrides:
Dictionary of visualizer overrides to apply to the view. The key is the path to the entity where the override
should be applied. The value is a list of visualizers which should be enabled for that entity, or a single visualizer.
Each visualizer can be configured with arbitrary overrides and mappings.
For any entity mentioned in this map, visualizers are no longer added automatically based on the entity's components.
Important note: the path must be a fully qualified entity path starting at the root. The override paths
do not yet support `$origin` relative paths or glob expressions.
This will be addressed in .
background:
Configures the background of the graph.
visual_bounds:
Everything within these bounds is guaranteed to be visible.
Some things outside of these bounds may also be visible due to letterboxing.
force_link:
Allows to control the interaction between two nodes connected by an edge.
force_many_body:
A force between each pair of nodes that ressembles an electrical charge.
force_position:
Similar to gravity, this force pulls nodes towards a specific position.
force_collision_radius:
Resolves collisions between the bounding spheres, according to the radius of the nodes.
force_center:
Tries to move the center of mass of the graph to the origin.
"""
properties: dict[str, AsComponents] = {}
if background is not None:
if not isinstance(background, blueprint_archetypes.GraphBackground):
background = blueprint_archetypes.GraphBackground(background)
properties["GraphBackground"] = background
if visual_bounds is not None:
if not isinstance(visual_bounds, blueprint_archetypes.VisualBounds2D):
visual_bounds = blueprint_archetypes.VisualBounds2D(visual_bounds)
properties["VisualBounds2D"] = visual_bounds
if force_link is not None:
if not isinstance(force_link, blueprint_archetypes.ForceLink):
force_link = blueprint_archetypes.ForceLink(force_link)
properties["ForceLink"] = force_link
if force_many_body is not None:
if not isinstance(force_many_body, blueprint_archetypes.ForceManyBody):
force_many_body = blueprint_archetypes.ForceManyBody(force_many_body)
properties["ForceManyBody"] = force_many_body
if force_position is not None:
if not isinstance(force_position, blueprint_archetypes.ForcePosition):
force_position = blueprint_archetypes.ForcePosition(force_position)
properties["ForcePosition"] = force_position
if force_collision_radius is not None:
if not isinstance(force_collision_radius, blueprint_archetypes.ForceCollisionRadius):
force_collision_radius = blueprint_archetypes.ForceCollisionRadius(force_collision_radius)
properties["ForceCollisionRadius"] = force_collision_radius
if force_center is not None:
if not isinstance(force_center, blueprint_archetypes.ForceCenter):
force_center = blueprint_archetypes.ForceCenter(force_center)
properties["ForceCenter"] = force_center
super().__init__(
class_identifier="Graph",
origin=origin,
contents=contents,
name=name,
visible=visible,
properties=properties,
defaults=defaults,
overrides=overrides,
)
