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	Boolean	Shows the dataframe’s index. If an Arrow table is used, shows the zero-based integer index.	Yes No
Enable search	Boolean		Yes No
Enable adding a record	Boolean		Yes No
Enable updating a record	Boolean		Yes No
Enable download	Boolean	Allows the user to download the data as CSV.	Yes No
Actions	Key-Value	Define rows actions
Use Markdown	Boolean	If active, the output will be sanitized; unsafe elements will be removed.	Yes No
Display row count	Number	Specifies how many rows to show simultaneously.
Wrap text	Boolean	Not wrapping text allows for an uniform grid, but may be inconvenient if your data contains longer text fields.	Yes No
Primary text	Color
Secondary text	Color
Accent	Color
Separator	Color
Background	Color
Font style	Text		normal monospace
Custom CSS classes	Text	CSS classes, separated by spaces. You can define classes in custom stylesheets.

Events

Capture adding a row.

# Subscribe this event handler to the `wf-dataframe-add` event
#
# more on : https://dev.writer.com/framework/dataframe
def on_record_add(state, payload):
payload['record']['sales'] = 0 # default value inside the dataframe
state['mydf'].record_add(payload) # should contain an EditableDataFrame instance

Capture a cell change.

# Subscribe this event handler to the `wf-dataframe-update` event
#
# more on : https://dev.writer.com/framework/dataframe
def on_record_change(state, payload):
state['mydf'].record_update(payload) # should contain an EditableDataFrame instance

Remove or open a row.

# Subscribe this event handler to the `wf-dataframe-action` event
#
# more on : https://dev.writer.com/framework/dataframe
def on_record_action(state, payload):
# state['mydf'] should contains an EditableDataFrame instance
record_index = payload['record_index']
if payload['action'] == 'remove':
	state['mydf'].record_remove(payload) # should contain an EditableDataFrame instance
if payload['action'] == 'open':
	state['record'] = state['mydf'].record(record_index) # dict representation of record

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]
        "enableRecordAdd": "no", # str [yes, no]
        "enableRecordUpdate": "no", # str [yes, no]
        "enableDownload": "no", # str [yes, no]
        "actions": {}, # Union[Dict, str] 
        "useMarkdown": "no", # str [yes, no]
        "displayRowCount": 0.0, # Union[float, str] 
        "wrapText": "no", # str [yes, no]
        "primaryTextColor": "", # str 
        "secondaryTextColor": "", # str 
        "accentColor": "", # str 
        "separatorColor": "", # str 
        "dataframeBackgroundColor": "", # str 
        "fontStyle": "normal", # str [normal, monospace]
        "cssClasses": "", # str 
    },
    handlers={
        "wf-dataframe-add": handle_event,
        "wf-dataframe-update": handle_event,
        "wf-dataframe-action": handle_event,
    }
)

A function, in this example handle_event, should be implemented in your code to handle events.

def handle_event(state, payload, context, ui):
  pass

Reference

Explore this component’s source code on GitHub

Layout

Content

Input

Other

Embed

Fields

Events

Low code usage

Reference

Layout

Content

Input

Other

Embed

​Fields

​Events

​Low code usage

​Reference

Fields

Events

Low code usage

Reference