Function set_env

pywebio/session/__init__.py:501–533

configure the environment of current session. Available configuration are: * ``title`` (str): Title of current page. * ``output_animation`` (bool): Whether to enable output animation, enabled by default * ``auto_scroll_bottom`` (bool): Whether to automatically scroll the page to th

(**env_info)

def set_env(**env_info):
    """configure the environment of current session.

    Available configuration are:

    * ``title`` (str): Title of current page.
    * ``output_animation`` (bool): Whether to enable output animation, enabled by default
    * ``auto_scroll_bottom`` (bool): Whether to automatically scroll the page to the bottom after output content,
      it is closed by default.  Note that after enabled, only outputting to ROOT scope can trigger automatic scrolling.
    * ``http_pull_interval`` (int): The period of HTTP polling messages (in milliseconds, default 1000ms),
      only available in sessions based on HTTP connection.
    * ``input_panel_fixed`` (bool): Whether to make input panel fixed at bottom, enabled by default
    * ``input_panel_min_height`` (int): The minimum height of input panel (in pixel, default 300px),
      it should be larger than 75px. Available only when ``input_panel_fixed=True``
    * ``input_panel_init_height`` (int): The initial height of input panel (in pixel, default 300px),
      it should be larger than 175px. Available only when ``input_panel_fixed=True``
    * ``input_auto_focus`` (bool): Whether to focus on input automatically after showing input panel, default is ``True``
    * ``output_max_width`` (str): The max width of the page content area (in pixel or percentage,
      e.g. ``'1080px'``, ``'80%'``. Default is 880px).

    Example::

        set_env(title='Awesome PyWebIO!!', output_animation=False)

    .. versionchanged:: 1.4

       Added the ``output_max_width`` parameter
    """
    from ..io_ctrl import send_msg
    assert all(k in ('title', 'output_animation', 'auto_scroll_bottom', 'http_pull_interval', 'output_max_width',
                     'input_panel_min_height', 'input_panel_init_height', 'input_panel_fixed', 'input_auto_focus')
               for k in env_info.keys())
    send_msg('set_env', spec=env_info)


def go_app(name, new_window=True):