Karana.WebUI.easydock
=====================

.. py:module:: Karana.WebUI.easydock

.. autoapi-nested-parse::

   Provides the EasyDock class.



Classes
-------

.. autoapisummary::

   Karana.WebUI.easydock.EasyDock


Module Contents
---------------

.. py:class:: EasyDock(port: int = 0)

   Class to simplify setup of a GUI consisting of IFrames.


   .. py:attribute:: server


   .. py:attribute:: router


   .. py:attribute:: dock


   .. py:attribute:: iframes
      :value: []



   .. py:property:: port
      :type: int


      The server's port.

      :returns: The port
      :rtype: int


   .. py:property:: url
      :type: str


      The server's base url.

      :returns: The base url
      :rtype: str


   .. py:method:: addFrame(url: str, title: str = 'untitled', *, relative_to: Any | None = None, direction: Literal['left', 'right', 'above', 'below', 'within'] | None = None) -> Any

      Add an IFrame panel to the dock.

      :param url: The url to open in the iframe
      :type url: str
      :param title: Title of the panel containing the iframe
      :type title: str
      :param relative_to: Object returned from a previous call, specifying a frame to
                          position relative to.
      :type relative_to: Any | None
      :param direction: If relative_to was given, how to position the new frame
      :type direction: Literal["left", "right", "above", "below", "within"] | None

      :returns: An object to be used for relative_to
      :rtype: Any