Column

This component replaces a classic Panel component

pn.ui.Column supersedes pn.layout.Column, which remains available and is documented in the classic Column reference.

The Column layout arranges its contents vertically.

Use pn.ui.Column to create this component.

API

.. py:class:: Column(*objects, **params) :module: panel_material_ui.layout.base

The Column layout arranges its contents vertically.

:Attributes:

   **scroll_index**
       ..

.. rubric:: Methods

.. autosummary::

  on_click
  scroll_to

.. !! processed by numpydoc !!

Parameter Definitions

---

Parameters inherited from:

   :class:`panel.layout.base.ListLike`: objects

   :class:`panel.viewable.Layoutable`: align, aspect_ratio, css_classes, design, height, min_width, min_height, max_width, max_height, styles, stylesheets, tags, width, width_policy, height_policy, sizing_mode, visible

   :class:`panel.custom.ReactComponent`: use_shadow_dom

   :class:`panel_material_ui.base.MaterialComponent`: loading, dark_theme, theme_config, sx

   :class:`panel_material_ui.layout.base.MaterialLayout`: margin

   :class:`panel_material_ui.layout.base.MaterialListLike`: scroll

auto_scroll_limit = Integer(bounds=(0, None), default=0, inclusive_bounds=(True, True), label='Auto scroll limit')

    Max pixel distance from the latest object in the Column to
    activate automatic scrolling upon update. Setting to 0
    disables auto-scrolling.

scroll_button_threshold = Integer(bounds=(0, None), default=0, inclusive_bounds=(True, True), label='Scroll button threshold')

    Min pixel distance from the latest object in the Column to
    display the scroll button. Setting to 0
    disables the scroll button.

scroll_position = Integer(default=0, inclusive_bounds=(True, True), label='Scroll position')

    Current scroll position of the Column. Setting this value
    will update the scroll position of the Column. Setting to
    0 will scroll to the top.

scroll_index = Integer(allow_None=True, inclusive_bounds=(True, True), label='Scroll index')

    Index of the object to scroll to. Setting this value will
    scroll the Column to the object at the given index.

view_latest = Boolean(default=False, label='View latest')

    Whether to scroll to the latest object on init. If not
    enabled the view will be on the first object.

scroll_button_click = Event(default=False, label='Scroll button click')

    Triggered when the scroll-to-latest button is clicked.

.. py:method:: Column.on_click(callback: ~collections.abc.Callable[[~param.parameterized.Event], None | ~typing.Awaitable[None]]) -> ~param.parameterized.Watcher :module: panel_material_ui.layout.base

  Register a callback invoked when the scroll-to-latest button is clicked.
















  ..
      !! processed by numpydoc !!

.. py:method:: Column.scroll_to(index: int) :module: panel_material_ui.layout.base

  Scrolls to the child at the provided index.


  :Parameters:

      **index: int**
          Index of the child object to scroll to.














  ..
      !! processed by numpydoc !!