Layouts Content#
Welcome to our guide on layouting Python objects, including Panel components! Let’s dive into arranging your content in a visually appealing and organized manner.
Explore Layouts#
In this guide, we’ll explore the following aspects of layouts:
Layouts: Accessible in the
pnnamespace.Layout Techniques: Utilize
pn.Columnandpn.Rowto structure your content.Reference Guides: Explore detailed documentation for each layout in the Layouts Section of the Component Gallery.
Note
As you follow along with the code examples below, feel free to execute them directly in the Panel documentation, a notebook cell, or within a file named app.py served with panel serve app.py --autoreload.
Layout in a Column#
Let’s start by arranging objects vertically using the Column layout.
Run the code below:
import pandas as pd
import panel as pn
pn.extension()
button = pn.widgets.Button(name="Refresh", icon="refresh", button_type="primary")
data = pd.DataFrame(
[
("Monday", 7),
("Tuesday", 4),
("Wednesday", 9),
("Thursday", 4),
("Friday", 4),
("Saturday", 4),
("Sunday", 4),
],
columns=["Day", "Wind Speed (m/s)"],
)
pn.Column("# Wind Speed", data, button).servable()
Note
The Column layout organizes the elements "# Wind Speed", data, and button vertically.
We add .servable() to display the Column component in a server app. It’s not necessary for displaying it in a notebook.
Click this link to access the Column reference guide and familiarize yourself with its functionality.
Layout in a Row#
Next, let’s arrange objects horizontally using the Row layout.
Run the code below:
import pandas as pd
import panel as pn
import hvplot.pandas
pn.extension()
data = pd.DataFrame(
[
("Monday", 7),
("Tuesday", 4),
("Wednesday", 9),
("Thursday", 4),
("Friday", 4),
("Saturday", 4),
("Sunday", 4),
],
columns=["Day", "Wind Speed (m/s)"],
)
plot = data.hvplot(x="Day", y="Wind Speed (m/s)", kind="bar", color="goldenrod", title="Wind Speed (m/s)")
pn.Row(plot, data).servable()
Displays using pn.panel#
Layouts automatically display objects using pn.panel.
Run the code below:
import pandas as pd
import panel as pn
pn.extension()
data = pd.DataFrame(
[
("Monday", 7),
("Tuesday", 4),
("Wednesday", 9),
("Thursday", 4),
("Friday", 4),
("Saturday", 4),
("Sunday", 4),
],
columns=["Day", "Wind Speed (m/s)"],
)
button = pn.widgets.Button(name="Refresh", icon="refresh", button_type="primary")
component = pn.Column("# Wind Speed", data, button)
print(component)
component.servable()
Column
[0] Markdown(str)
[1] DataFrame(DataFrame)
[2] Button(button_type='primary', icon='refresh', name='Refresh')
The print statement will output something like:
Column
[0] Markdown(str)
[1] DataFrame(DataFrame)
[2] Button(button_type='primary', icon='refresh', name='Refresh')
Under the hood, the Column layout uses pn.panel to determine how to best display Python objects.
Tip
You can customize how objects are displayed using various arguments of pn.panel, specific Panes, or specific Widgets.
Run the code below to see custom display:
import pandas as pd
import panel as pn
pn.extension()
button = pn.widgets.Button(name="Refresh", icon="refresh", button_type="primary")
data = pd.DataFrame(
[
("Monday", 7),
("Tuesday", 4),
("Wednesday", 9),
("Thursday", 4),
("Friday", 4),
("Saturday", 4),
("Sunday", 4),
],
columns=["Day", "Wind Speed (m/s)"],
)
pn.Column(
pn.pane.Str("# Wind Speed"), pn.panel(data, sizing_mode="stretch_width"), button
).servable()
Works like a list#
Column, Row, and many other layouts behave like lists.
Run the code below:
import pandas as pd
import panel as pn
pn.extension()
button = pn.widgets.Button(name="Refresh", icon="refresh", button_type="primary")
data = pd.DataFrame(
[
("Monday", 7),
("Tuesday", 4),
("Wednesday", 9),
("Thursday", 4),
("Friday", 4),
("Saturday", 4),
("Sunday", 4),
],
columns=["Day", "Wind Speed (m/s)"],
)
component = pn.Column("# Wind Speed", data, button)
pn.Column(component[0], component[2], component[1]).servable()
Note
We utilize the list-like properties of the Column layout to rearrange its elements using list-indexing as in component[0], component[2], component[1].
The Column layout implements all the methods you would expect from a list-like object, including .append and .remove.
Combine Layouts#
To create more complex layouts, we can combine and nest layouts.
Let’s run the code below:
import pandas as pd
import panel as pn
import hvplot.pandas
pn.extension()
button = pn.widgets.Button(name="Refresh", icon="refresh", button_type="primary")
data = pd.DataFrame(
[
("Monday", 7),
("Tuesday", 4),
("Wednesday", 9),
("Thursday", 4),
("Friday", 4),
("Saturday", 4),
("Sunday", 4),
],
columns=["Day", "Wind Speed (m/s)"],
)
plot = data.hvplot(
x="Day",
y="Wind Speed (m/s)",
kind="bar",
color="goldenrod",
title="Wind Speed (m/s)",
)
pn.Column(
"# Wind Speed",
button,
pn.Row(pn.panel(plot, sizing_mode="stretch_width"), pn.panel(data)),
).servable()
Explore the Layouts#
Panel provides a vast collection of layouts to suit your needs.
Click this link to explore available layouts and their detailed reference guides.
Recap#
In this guide, we have learned:
Layouts: Available in the
pnnamespace.Layout Techniques: Utilize
pn.Columnandpn.Rowto structure your content.Automatic Display: Layouts use
pn.panelto determine the optimal display for Python objects.List-like Behavior: Layouts like
ColumnandRowbehave like lists, allowing for flexible manipulation.Complex Layouts: Combine and nest layouts for more intricate arrangements.
Now, you’re equipped to create dynamic and visually appealing layouts for your Panel apps!
