Skip to main content

PandasRowSelectionInput

Pandas DataFrame row selection input widget for selecting rows from tabular data.

Signature

def PandasRowSelectionInput(
df: pd.DataFrame,
key: str = None,
required: bool = True,
hint: str = None,
full_width: bool = True,
display_index: bool = False,
disabled: bool = False,
label: str = '',
filterable: bool = False,
multiple: bool = False,
initial_value: Union[List, Any] = None,
min: int = None,
max: int = None,
page_size: int = 10,
errors: Union[List[str], str] = None,
pagination_always_visible: bool = True
)

Parameters

NameDescriptionTypeDefault
df (required)The pandas DataFrame to display.pd.DataFrameNone
keyIdentifier for the widget.strNone
requiredWhether row selection is required before proceeding.boolTrue
hintHelp text displayed below the input.strNone
full_widthWhether the table should take up the full width of its container.boolTrue
display_indexWhether to display row indices.boolFalse
disabledWhether the input is non-interactive.boolFalse
labelText label displayed above the table.str''
filterableWhether the table is filterable.boolFalse
multipleWhether multiple rows can be selected.boolFalse
initial_valueInitial selected row(s).Union[List, Any]None
minMinimum number of rows that must be selected when multiple=True.intNone
maxMaximum number of rows that can be selected when multiple=True.intNone
page_sizeNumber of rows to display per page.int10
errorsPre-defined validation error messages to display.Union[List[str], str]None
pagination_always_visibleWhether pagination controls are always visible.boolTrue