framedisplay 1.2.1

Enhanced DataFrame Display

FrameDisplay: Enhanced DataFrame Display

FrameDisplay is a lightweight Python package for rendering Pandas DataFrames as interactive HTML tables within Jupyter Notebooks and JupyterLab. It improves the default DataFrame display by adding features such as resizable columns, client-side sorting, sticky headers and index for improved navigation, data type indicators in column headers, distinct styling for null values, and tooltips for viewing complete cell content.

I work extensively with Pandas in my personal projects and have always wanted something similar to Databricks' display function, but for Jupyter. The existing open-source alternatives were either too heavyweight, lacked the visual appeal or didn't check all the boxes I needed. So I built this package to bridge that gap. It's not perfect yet, but I like it more than the alternatives :)

Live demo: CodePen

Features

• Resizable Columns: Drag column dividers to resize them.
• Sortable Columns: Click on column headers to sort the data.
• Sticky Header & Index: The header and index rows remain visible during vertical and horizontal scrolling.
• Column Type Icons: Icons in headers indicate data types (numeric, string, etc.).
• Null Value Styling: null values are visually distinct.
• Tooltips: Hover over cell content to see the full value.
• No Size Limit: Display DataFrames of any size (be mindful of browser performance with very large tables).
• Customizable Themes: Choose from several built-in themes or add your own CSS.

Roadmap

• Virtual scrolling for improved performance with very large DataFrames.
• Additional customization options (e.g., theming).

Installation

pip install framedisplay

Usage

To display a DataFrame, simply import framedisplay and use the frame_display function:

import pandas as pd
import numpy as np
import framedisplay as fd

df = pd.DataFrame({
    'Name': ['Alice', 'Bob', np.nan],
    'Age': [25, np.nan, 35],
    'Score': [95.5, 87.2, np.nan]
})

fd.frame_display(df)

You can also enable FrameDisplay globally for all DataFrames in Jupyter by calling fd.integrate_with_pandas():

import pandas as pd
import framedisplay as fd

# Enable FrameDisplay for all DataFrames
fd.integrate_with_pandas()

# This will now display using FrameDisplay
df

How it Works

FrameDisplay renders your Pandas DataFrame into an HTML table and injects custom CSS and JavaScript to enable interactive features directly in your Jupyter Notebook or browser.

Configuration Options

FrameDisplay uses global configuration (window.FrameDisplayConfig) that applies to all future table renderings in the notebook/browser session. Once you set a configuration option, it persists until you explicitly reset it or change it.

import framedisplay as fd

fd.configure({
    'theme': 'dark',
    'enableSorting': False
})

# All subsequent calls use this config
fd.frame_display(df1)
fd.frame_display(df2)

You can also pass configuration options directly to frame_display():

fd.frame_display(df1, config={
    'theme': 'ocean',
    'enableSorting': False
})

To reset the global configuration to defaults, call configure() with reset=True:

fd.configure(reset=True)

Themes

Option	Type	Default	Description
theme	string	''	Built-in theme: 'dark', 'ocean', 'sunset', 'neon', 'minimal', 'contrast'
customCSS	string	''	Additional CSS rules to append after base styles

Behavior Options

Option	Type	Default	Description
autoInit	boolean	true	Automatically initialize on page load
ReInitialize	boolean	false	Force reprocessing of all existing tables with new config
tableSelector	string	'.frame-display-table'	CSS selector for tables to process
minColumnWidth	number	30	Minimum column width in pixels

Feature Toggles

Option	Type	Default	Description
enableResizing	boolean	true	Enable column resizing by dragging column dividers
enableSorting	boolean	true	Enable sorting by clicking column headers
enableTooltips	boolean	true	Show full cell content on hover
enableStickyHeader	boolean	true	Keep header row visible when scrolling vertically
enableStickyIndex	boolean	true	Keep index column visible when scrolling horizontally

Offline Mode

If you are working in an environment without internet access, you can inject the necessary JavaScript and CSS locally by calling initialize() at the start of your notebook. This bundles the required assets into the notebook itself.

import framedisplay as fd
fd.initialize()

# Now you can use fd.frame_display(df) without needing an internet connection

License

MIT