ansys-fluent-visualization 0.21.dev1__tar.gz → 0.22.dev0__tar.gz

{ansys_fluent_visualization-0.21.dev1 → ansys_fluent_visualization-0.22.dev0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.3
 Name: ansys-fluent-visualization
-Version: 0.21.dev1
+Version: 0.22.dev0
 Summary: A python wrapper for ansys Fluent visualization
 License: MIT
 Author: ANSYS, Inc.
@@ -16,13 +16,14 @@ Classifier: Programming Language :: Python :: 3.10
 Classifier: Programming Language :: Python :: 3.11
 Classifier: Programming Language :: Python :: 3.12
 Classifier: Programming Language :: Python :: 3.13
-Requires-Dist: ansys-fluent-core (>=0.33.dev0)
-Requires-Dist: imageio (>=2.36.1)
+Provides-Extra: interactive
+Provides-Extra: single-window
+Requires-Dist: ansys-fluent-core (>=0.35.dev0,<1.0)
 Requires-Dist: importlib-metadata (>=4.0,<5.0) ; python_version < "3.9"
 Requires-Dist: matplotlib (>=3.6.0)
-Requires-Dist: pyside6 (>=6.8.1,<6.9.0)
+Requires-Dist: pyside6 (>=6.8.1,<6.9.0) ; extra == "single-window"
 Requires-Dist: pyvista (>=0.44.0)
-Requires-Dist: pyvistaqt (>=0.11.1,<0.12.0)
+Requires-Dist: pyvistaqt (>=0.11.1,<0.12.0) ; extra == "interactive" or extra == "single-window"
 Project-URL: Documentation, https://visualization.fluent.docs.pyansys.com/
 Project-URL: Repository, https://github.com/ansys/pyfluent-visualization
 Project-URL: Source, https://github.com/ansys/pyfluent-visualization
@@ -95,6 +96,19 @@ Install the latest release from `PyPI
 
    pip install ansys-fluent-visualization
 
+There are optional dependencies depending on the desired usage mode.
+To run the plotter in interactive mode, install with:
+
+.. code:: console
+
+   pip install ansys-fluent-visualization[interactive]
+
+For interactive mode with graphics displayed in a single Qt window using multiple tabs, install with:
+
+.. code:: console
+
+   pip install ansys-fluent-visualization[single-window]
+
 Alternatively, install the latest release from `GitHub
 <https://github.com/ansys/pyfluent-visualization>`_ with:
 

{ansys_fluent_visualization-0.21.dev1 → ansys_fluent_visualization-0.22.dev0}/README.rst

@@ -64,6 +64,19 @@ Install the latest release from `PyPI
 
    pip install ansys-fluent-visualization
 
+There are optional dependencies depending on the desired usage mode.
+To run the plotter in interactive mode, install with:
+
+.. code:: console
+
+   pip install ansys-fluent-visualization[interactive]
+
+For interactive mode with graphics displayed in a single Qt window using multiple tabs, install with:
+
+.. code:: console
+
+   pip install ansys-fluent-visualization[single-window]
+
 Alternatively, install the latest release from `GitHub
 <https://github.com/ansys/pyfluent-visualization>`_ with:
 

{ansys_fluent_visualization-0.21.dev1 → ansys_fluent_visualization-0.22.dev0}/pyproject.toml

@@ -5,7 +5,7 @@ build-backend = "poetry.core.masonry.api"
 [tool.poetry]
 # Check https://python-poetry.org/docs/pyproject/ for all available sections
 name = "ansys-fluent-visualization"
-version = "0.21.dev1"
+version = "0.22.dev0"
 description = "A python wrapper for ansys Fluent visualization"
 license = "MIT"
 authors = ["ANSYS, Inc. <ansys.support@ansys.com>"]
@@ -25,12 +25,15 @@ packages = [
 [tool.poetry.dependencies]
 python = ">=3.10,<4.0"
 importlib-metadata = {version = "^4.0", python = "<3.9"}
-ansys-fluent-core = ">=0.33.dev0"
+ansys-fluent-core = "~=0.35.dev0"
 pyvista = ">=0.44.0"
 matplotlib = ">=3.6.0"
-pyvistaqt = "~=0.11.1"
-pyside6 = "~=6.8.1"
-imageio= ">=2.36.1"
+pyvistaqt = { version = "~=0.11.1", optional = true }
+pyside6 = { version = "~=6.8.1", optional = true }
+
+[tool.poetry.extras]
+interactive = ["pyvistaqt"]
+single-window = ["pyvistaqt", "pyside6"]
 
 [tool.poetry.urls]
 "Documentation" = "https://visualization.fluent.docs.pyansys.com/"

{ansys_fluent_visualization-0.21.dev1 → ansys_fluent_visualization-0.22.dev0}/src/ansys/fluent/interface/post_objects/meta.py

@@ -254,6 +254,8 @@ class PyLocalBaseMeta(type):
         attrs["root"] = property(lambda self: self.get_root())
         attrs["path"] = property(lambda self: self.get_path())
         attrs["session"] = property(lambda self: self.get_session())
+        attrs["field_data"] = property(lambda self: self.get_session().field_data)
+        attrs["monitors"] = property(lambda self: self.get_session().monitors)
         attrs["session_handle"] = property(lambda self: self.get_session_handle())
         return super(PyLocalBaseMeta, cls).__new__(cls, name, bases, attrs)
 
@@ -261,33 +263,6 @@ class PyLocalBaseMeta(type):
 class PyLocalPropertyMeta(PyLocalBaseMeta):
     """Metaclass for local property classes."""
 
-    @classmethod
-    def __create_validate(cls):
-        def wrapper(self, value):
-            attrs = getattr(self, "attributes", None)
-            if attrs:
-                for attr in attrs:
-                    if attr == "range":
-                        if self.range and (
-                            value < self.range[0] or value > self.range[1]
-                        ):
-                            raise DisallowedValuesError("value", value, self.range)
-                    elif attr == "allowed_values":
-                        if isinstance(value, list):
-                            if not all(
-                                v is None or v in self.allowed_values for v in value
-                            ):
-                                raise DisallowedValuesError(
-                                    "value", value, self.allowed_values
-                                )
-                        elif value is not None and value not in self.allowed_values:
-                            raise DisallowedValuesError(
-                                "value", value, self.allowed_values
-                            )
-            return value
-
-        return wrapper
-
     @classmethod
     def __create_init(cls):
         def wrapper(self, parent, api_helper, name=""):
@@ -342,8 +317,8 @@ class PyLocalPropertyMeta(PyLocalBaseMeta):
 
     @classmethod
     def __create_set_state(cls):
-        def wrapper(self, value, validate=True):
-            self.value = self._validate(value) if validate else value
+        def wrapper(self, value):
+            self.value = value
             for on_change_cb in self._on_change_cbs:
                 on_change_cb()
 
@@ -359,7 +334,6 @@ class PyLocalPropertyMeta(PyLocalBaseMeta):
     def __new__(cls, name, bases, attrs):
         attrs["__init__"] = cls.__create_init()
         attrs["__call__"] = cls.__create_get_state()
-        attrs["_validate"] = cls.__create_validate()
         attrs["_register_on_change_cb"] = cls.__create_register_on_change()
         attrs["set_state"] = cls.__create_set_state()
         return super(PyLocalPropertyMeta, cls).__new__(cls, name, bases, attrs)

{ansys_fluent_visualization-0.21.dev1 → ansys_fluent_visualization-0.22.dev0}/src/ansys/fluent/interface/post_objects/post_helper.py

@@ -57,14 +57,14 @@ class PostAPIHelper:
         @staticmethod
         def surface_name_on_server(local_surface_name):
             """Return the surface name on server."""
-            return "_dummy_surface_for_pyfluent:" + local_surface_name.lower()
+            return local_surface_name.lower()
 
         def _get_api_handle(self):
             return self.obj.get_root().session.results.surfaces
 
         def _delete_if_exists_on_server(self):
-            field_info = self.obj._api_helper.field_info()
-            surfaces_list = list(field_info.get_surfaces_info().keys())
+            field_data = self.obj._api_helper.field_data()
+            surfaces_list = list(field_data.surfaces())
             if self._surface_name_on_server in surfaces_list:
                 self.delete_surface_on_server()
 
@@ -91,28 +91,47 @@ class PostAPIHelper:
                 }
             elif self.obj.definition.type() == "plane-surface":
                 plane_surface = self.obj.definition.plane_surface
-                xy_plane = plane_surface.xy_plane
-                yz_plane = plane_surface.yz_plane
-                zx_plane = plane_surface.zx_plane
-                self._delete_if_exists_on_server()
-                if xy_plane():
-                    method = "xy-plane"
-                    position = "z"
-                    value = xy_plane.z()
-                elif yz_plane():
-                    method = "yz-plane"
-                    position = "x"
-                    value = yz_plane.x()
+                if plane_surface.creation_method() == "point-and-normal":
+                    self._get_api_handle().plane_surface[
+                        self._surface_name_on_server
+                    ] = {
+                        "method": "point-and-normal",
+                        "normal": [
+                            plane_surface.normal.x(),
+                            plane_surface.normal.y(),
+                            plane_surface.normal.z(),
+                        ],
+                        "point": [
+                            plane_surface.point.x(),
+                            plane_surface.point.y(),
+                            plane_surface.point.z(),
+                        ],
+                    }
                 else:
-                    method = "zx-plane"
-                    position = "y"
-                    value = zx_plane.y()
-                self._get_api_handle().plane_surface[self._surface_name_on_server] = {
-                    "method": method,
-                    position: value,
-                }
-            field_info = self.obj._api_helper.field_info()
-            surfaces_list = list(field_info.get_surfaces_info().keys())
+                    xy_plane = plane_surface.xy_plane
+                    yz_plane = plane_surface.yz_plane
+                    zx_plane = plane_surface.zx_plane
+                    self._delete_if_exists_on_server()
+                    if xy_plane():
+                        method = "xy-plane"
+                        position = "z"
+                        value = xy_plane.z()
+                    elif yz_plane():
+                        method = "yz-plane"
+                        position = "x"
+                        value = yz_plane.x()
+                    else:
+                        method = "zx-plane"
+                        position = "y"
+                        value = zx_plane.y()
+                    self._get_api_handle().plane_surface[
+                        self._surface_name_on_server
+                    ] = {
+                        "method": method,
+                        position: value,
+                    }
+            field_data = self.obj._api_helper.field_data()
+            surfaces_list = list(field_data.surfaces())
             if self._surface_name_on_server not in surfaces_list:
                 raise SurfaceCreationError()
 
@@ -126,7 +145,6 @@ class PostAPIHelper:
     def __init__(self, obj):
         """__init__ method of PostAPIHelper class."""
         self.obj = obj
-        self.field_info = lambda: obj.get_root().session.fields.field_info
         self.field_data = lambda: obj.get_root().session.fields.field_data
         if obj.__class__.__name__ == "Surface":
             self.surface_api = PostAPIHelper._SurfaceAPI(obj)
@@ -144,14 +162,14 @@ class PostAPIHelper:
     def get_field_unit(self, field):
         """Return the unit of the field."""
         session = self.obj.get_root().session
-        if FluentVersion(session.scheme_eval.version) < FluentVersion.v252:
+        if FluentVersion(session.scheme.version) < FluentVersion.v252:
             quantity = self._field_unit_quantity(field)
             if quantity == "*null*":
                 return ""
             scheme_eval_str = f"(units/get-pretty-wb-units-from-dimension (units/inquire-dimension '{quantity}))"  # noqa: E501
             return " ".join(self._scheme_str_to_py_list(scheme_eval_str))
         else:
-            fields_info = self.field_info().get_scalar_fields_info()
+            fields_info = self.field_data().scalar_fields()
             return get_si_unit_for_fluent_quantity(fields_info[field]["quantity_name"])
 
     def _field_unit_quantity(self, field):
@@ -161,7 +179,7 @@ class PostAPIHelper:
     def _scheme_str_to_py_list(self, scheme_eval_str):
         session = self.obj.get_root().session
         if hasattr(session, "scheme_eval"):
-            str_val = session.scheme_eval.string_eval(scheme_eval_str)
+            str_val = session.scheme.string_eval(scheme_eval_str)
             return list(filter(None, re.split(r'[\s()"\']', str_val)))
         else:
             return ["*null*"]

{ansys_fluent_visualization-0.21.dev1 → ansys_fluent_visualization-0.22.dev0}/src/ansys/fluent/interface/post_objects/post_object_definitions.py

@@ -107,7 +107,7 @@ class MonitorDefn(PlotDefn):
         @Attribute
         def allowed_values(self):
             """Monitor set allowed values."""
-            return self.session.monitors.get_monitor_set_names()
+            return self.monitors.get_monitor_set_names()
 
 
 class XYPlotDefn(PlotDefn):
@@ -138,7 +138,7 @@ class XYPlotDefn(PlotDefn):
         @Attribute
         def allowed_values(self):
             """Y axis function allowed values."""
-            return list(self.session.field_info.get_scalar_fields_info())
+            return list(self.field_data.scalar_fields())
 
     class x_axis_function(metaclass=PyLocalPropertyMeta):
         """X Axis Function."""
@@ -158,7 +158,7 @@ class XYPlotDefn(PlotDefn):
         @Attribute
         def allowed_values(self):
             """Surface list allowed values."""
-            return list(self.session.field_info.get_surfaces_info()) + list(
+            return list(self.field_data.surfaces()) + list(
                 self.get_root()._local_surfaces_provider()
             )
 
@@ -176,7 +176,7 @@ class MeshDefn(GraphicsDefn):
         @Attribute
         def allowed_values(self):
             """Surface list allowed values."""
-            return list(self.session.field_info.get_surfaces_info()) + list(
+            return list(self.field_data.surfaces()) + list(
                 self.get_root()._local_surfaces_provider()
             )
 
@@ -209,7 +209,7 @@ class PathlinesDefn(GraphicsDefn):
         @Attribute
         def allowed_values(self):
             """Field allowed values."""
-            return list(self.session.field_info.get_scalar_fields_info())
+            return list(self.field_data.scalar_fields())
 
     class surfaces(metaclass=PyLocalPropertyMeta):
         """List of surfaces for pathlines."""
@@ -219,7 +219,7 @@ class PathlinesDefn(GraphicsDefn):
         @Attribute
         def allowed_values(self):
             """Surface list allowed values."""
-            return list(self.session.field_info.get_surfaces_info()) + list(
+            return list(self.field_data.surfaces()) + list(
                 self.get_root()._local_surfaces_provider()
             )
 
@@ -268,7 +268,83 @@ class SurfaceDefn(GraphicsDefn):
                 @Attribute
                 def allowed_values(self):
                     """Surface type allowed values."""
-                    return ["xy-plane", "yz-plane", "zx-plane"]
+                    return ["xy-plane", "yz-plane", "zx-plane", "point-and-normal"]
+
+            class point(metaclass=PyLocalObjectMeta):
+                """Point entry for point-and-normal surface."""
+
+                @Attribute
+                def is_active(self):
+                    """Check whether current object is active or not."""
+                    return self._parent.creation_method() == "point-and-normal"
+
+                class x(metaclass=PyLocalPropertyMeta):
+                    """X value."""
+
+                    value: float = 0
+
+                    @Attribute
+                    def range(self):
+                        """X value range."""
+                        return self.field_data.scalar_fields.range("x-coordinate", True)
+
+                class y(metaclass=PyLocalPropertyMeta):
+                    """Y value."""
+
+                    value: float = 0
+
+                    @Attribute
+                    def range(self):
+                        """Y value range."""
+                        return self.field_data.scalar_fields.range("y-coordinate", True)
+
+                class z(metaclass=PyLocalPropertyMeta):
+                    """Z value."""
+
+                    value: float = 0
+
+                    @Attribute
+                    def range(self):
+                        """Z value range."""
+                        return self.field_data.scalar_fields.range("z-coordinate", True)
+
+            class normal(metaclass=PyLocalObjectMeta):
+                """Normal entry for point-and-normal surface."""
+
+                @Attribute
+                def is_active(self):
+                    """Check whether current object is active or not."""
+                    return self._parent.creation_method() == "point-and-normal"
+
+                class x(metaclass=PyLocalPropertyMeta):
+                    """X value."""
+
+                    value: float = 0
+
+                    @Attribute
+                    def range(self):
+                        """X value range."""
+                        return [-1, 1]
+
+                class y(metaclass=PyLocalPropertyMeta):
+                    """Y value."""
+
+                    value: float = 0
+
+                    @Attribute
+                    def range(self):
+                        """Y value range."""
+                        return [-1, 1]
+
+                class z(metaclass=PyLocalPropertyMeta):
+                    """Z value."""
+
+                    value: float = 0
+
+                    @Attribute
+                    def range(self):
+                        """Z value range."""
+                        return [-1, 1]
 
             class xy_plane(metaclass=PyLocalObjectMeta):
                 """XY Plane definition."""
@@ -286,9 +362,7 @@ class SurfaceDefn(GraphicsDefn):
                     @Attribute
                     def range(self):
                         """Z value range."""
-                        return self.session.field_info.get_scalar_field_range(
-                            "z-coordinate", True
-                        )
+                        return self.field_data.scalar_fields.range("z-coordinate", True)
 
             class yz_plane(metaclass=PyLocalObjectMeta):
                 """YZ Plane definition."""
@@ -306,9 +380,7 @@ class SurfaceDefn(GraphicsDefn):
                     @Attribute
                     def range(self):
                         """X value range."""
-                        return self.session.field_info.get_scalar_field_range(
-                            "x-coordinate", True
-                        )
+                        return self.field_data.scalar_fields.range("x-coordinate", True)
 
             class zx_plane(metaclass=PyLocalObjectMeta):
                 """ZX Plane definition."""
@@ -326,9 +398,7 @@ class SurfaceDefn(GraphicsDefn):
                     @Attribute
                     def range(self):
                         """Y value range."""
-                        return self.session.field_info.get_scalar_field_range(
-                            "y-coordinate", True
-                        )
+                        return self.field_data.scalar_fields.range("y-coordinate", True)
 
         class iso_surface(metaclass=PyLocalObjectMeta):
             """Iso surface definition."""
@@ -346,7 +416,7 @@ class SurfaceDefn(GraphicsDefn):
                 @Attribute
                 def allowed_values(self):
                     """Field allowed values."""
-                    return list(self.session.field_info.get_scalar_fields_info())
+                    return list(self.field_data.scalar_fields())
 
             class rendering(metaclass=PyLocalPropertyMeta):
                 """Iso surface rendering."""
@@ -383,9 +453,7 @@ class SurfaceDefn(GraphicsDefn):
                     """Iso value range."""
                     field = self._parent.field()
                     if field:
-                        return self.session.field_info.get_scalar_field_range(
-                            field, True
-                        )
+                        return self.field_data.scalar_fields.range(field, True)
 
 
 class ContourDefn(GraphicsDefn):
@@ -401,7 +469,7 @@ class ContourDefn(GraphicsDefn):
         @Attribute
         def allowed_values(self):
             """Field allowed values."""
-            return list(self.session.field_info.get_scalar_fields_info())
+            return list(self.field_data.scalar_fields())
 
     class surfaces(metaclass=PyLocalPropertyMeta):
         """Contour surfaces."""
@@ -411,7 +479,7 @@ class ContourDefn(GraphicsDefn):
         @Attribute
         def allowed_values(self):
             """Surfaces list allowed values."""
-            return list(self.session.field_info.get_surfaces_info()) + list(
+            return list(self.field_data.surfaces()) + list(
                 self.get_root()._local_surfaces_provider()
             )
 
@@ -525,8 +593,8 @@ class ContourDefn(GraphicsDefn):
                     if getattr(self, "_value", None) is None:
                         field = self.get_ancestors_by_type(ContourDefn).field()
                         if field:
-                            field_info = self.session.field_info
-                            field_range = field_info.get_scalar_field_range(
+                            field_data = self.field_data
+                            field_range = field_data.scalar_fields.range(
                                 field,
                                 self.get_ancestors_by_type(ContourDefn).node_values(),
                             )
@@ -554,8 +622,8 @@ class ContourDefn(GraphicsDefn):
                     if getattr(self, "_value", None) is None:
                         field = self.get_ancestors_by_type(ContourDefn).field()
                         if field:
-                            field_info = self.session.field_info
-                            field_range = field_info.get_scalar_field_range(
+                            field_data = self.field_data
+                            field_range = field_data.scalar_fields.range(
                                 field,
                                 self.get_ancestors_by_type(ContourDefn).node_values(),
                             )
@@ -581,7 +649,7 @@ class VectorDefn(GraphicsDefn):
         @Attribute
         def allowed_values(self):
             """Vectors of allowed values."""
-            return list(self.session.field_info.get_vector_fields_info())
+            return list(self.field_data.vectors())
 
     class field(metaclass=PyLocalPropertyMeta):
         """Vector color field."""
@@ -591,7 +659,7 @@ class VectorDefn(GraphicsDefn):
         @Attribute
         def allowed_values(self):
             """Field allowed values."""
-            return list(self.session.field_info.get_scalar_fields_info())
+            return list(self.field_data.scalar_fields())
 
     class surfaces(metaclass=PyLocalPropertyMeta):
         """List of surfaces for vector graphics."""
@@ -601,7 +669,7 @@ class VectorDefn(GraphicsDefn):
         @Attribute
         def allowed_values(self):
             """Surface list allowed values."""
-            return list(self.session.field_info.get_surfaces_info()) + list(
+            return list(self.field_data.surfaces()) + list(
                 self.get_root()._local_surfaces_provider()
             )
 
@@ -668,8 +736,8 @@ class VectorDefn(GraphicsDefn):
                 def value(self):
                     """Range minimum property setter."""
                     if getattr(self, "_value", None) is None:
-                        field_info = self.session.field_info
-                        field_range = field_info.get_scalar_field_range(
+                        field_data = self.field_data
+                        field_range = field_data.scalar_fields.range(
                             "velocity-magnitude",
                             False,
                         )
@@ -689,8 +757,8 @@ class VectorDefn(GraphicsDefn):
                 def value(self):
                     """Range maximum property setter."""
                     if getattr(self, "_value", None) is None:
-                        field_info = self.session.field_info
-                        field_range = field_info.get_scalar_field_range(
+                        field_data = self.field_data
+                        field_range = field_data.scalar_fields.range(
                             "velocity-magnitude",
                             False,
                         )

{ansys_fluent_visualization-0.21.dev1 → ansys_fluent_visualization-0.22.dev0}/src/ansys/fluent/interface/post_objects/post_objects_container.py

@@ -135,6 +135,8 @@ class Container:
                                 f"create() got an unexpected keyword argument '{next(iter(unexpected_args))}'."  # noqa: E501
                             )
                         for key, value in kwargs.items():
+                            if key == "surfaces":
+                                value = list(value)
                             setattr(new_object, key, value)
                         return new_object
 

{ansys_fluent_visualization-0.21.dev1 → ansys_fluent_visualization-0.22.dev0}/src/ansys/fluent/visualization/__init__.py

@@ -27,7 +27,7 @@ try:
 except ModuleNotFoundError:
     import importlib_metadata
 
-_VERSION_INFO = "Build date: June 13, 2025 08:20 UTC ShaID: d5c70c4"
+_VERSION_INFO = "Build date: August 12, 2025 07:23 UTC ShaID: 897e757"
 __version__ = importlib_metadata.version(__name__.replace(".", "-"))
 
 
@@ -49,9 +49,11 @@ def version_info() -> str:
 from ansys.fluent.visualization.config import config, get_config, set_config
 from ansys.fluent.visualization.containers import (  # noqa: F401
     Contour,
+    IsoSurface,
     Mesh,
     Monitor,
     Pathline,
+    PlaneSurface,
     Surface,
     Vector,
     XYPlot,

ansys_fluent_visualization-0.21.dev1/src/ansys/fluent/visualization/abstract_renderer_defn.py → ansys_fluent_visualization-0.22.dev0/src/ansys/fluent/visualization/base/renderer.py

@@ -29,14 +29,31 @@ class AbstractRenderer(ABC):
     """Abstract class for rendering graphics and plots."""
 
     @abstractmethod
-    def render(self, data, grid, position, subplot_title, **kwargs) -> None:
-        """Render graphics and plots in window.
+    def render(self, meshes: list[list[dict]]) -> None:
+        """Render graphics and plots in a window.
 
         Parameters
         ----------
-        data : dict
-            Data to plot. Data consists the list of x and y
-            values for each curve.
+        meshes : list[list[dict]]
+            A nested list structure defining the layout and content of the graphics
+            to be rendered.
+
+            - The outer list represents the number of subplots to be plotted
+            into a single plotter window.
+
+            - Each inner list corresponds to a single sub-plot and
+            contains multiple surface definitions.
+
+            - Each dictionary in the inner list defines a surface to be plotted,
+            with the following keys:
+
+                - 'data': The mesh or 2d plot object to be plotted.
+                - 'position': tuple(int, int),  Location of subplot. Defaults to (0, 0).
+                - 'opacity': int, Sets the transparency of the subplot. Defaults to 1,
+                meaning fully opaque.
+                - 'title': str, Title of the subplot.
+                - 'kwargs': A dictionary of additional keyword arguments passed
+                directly to the plotter.
         """
         pass