Content
DataFrame
A component to display Pandas DataFrames.
Fields
Name | Type | Description | Options |
---|---|---|---|
Data | Text | Must be a state reference to a Pandas dataframe or PyArrow table. Alternatively, a URL for an Arrow IPC file. | |
Show index | Text | Shows the dataframe’s index. If an Arrow table is used, shows the zero-based integer index. |
|
Enable search | Text |
| |
Enable download | Text | Allows the user to download the data as CSV. |
|
Use Markdown | Text | If active, the output will be sanitized; unsafe elements will be removed. |
|
Display row count | Number | Specifies how many rows to show simultaneously. | |
Wrap text | Text | Not wrapping text allows for an uniform grid, but may be inconvenient if your data contains longer text fields. |
|
Primary text | Color | ||
Secondary text | Color | ||
Separator | Color | ||
Background | Color | ||
Font style | Text |
| |
Custom CSS classes | Text | CSS classes, separated by spaces. You can define classes in custom stylesheets. |
Low code usage
This component can be declared directly in Python, using backend-driven UI.
ui.DataFrame(content={
"dataframe": "", # str
"showIndex": "yes", # str [yes, no]
"enableSearch": "no", # str [yes, no]
"enableDownload": "no", # str [yes, no]
"useMarkdown": "no", # str [yes, no]
"displayRowCount": 0.0, # Union[float, str]
"wrapText": "no", # str [yes, no]
"primaryTextColor": "", # str
"secondaryTextColor": "", # str
"separatorColor": "", # str
"dataframeBackgroundColor": "", # str
"fontStyle": "normal", # str [normal, monospace]
"cssClasses": "", # str
}
)