DataCell

Examples#

DataCell #

Bases: Control

The data for a cell of a DataTable.

RAISES	DESCRIPTION
`AssertionError`	If the `content` is neither a string nor a visible control.

badge #

badge: BadgeValue | None = None

A badge to show on top of this control.

col #

col: ResponsiveNumber = 12

If a parent of this control is a ResponsiveRow, this property is used to determine how many virtual columns of a screen this control will span.

Can be a number or a dictionary configured to have a different value for specific breakpoints, for example col={"sm": 6}.

This control spans the 12 virtual columns by default.

Dimensions

Breakpoint	Dimension
xs	<576px
sm	≥576px
md	≥768px
lg	≥992px
xl	≥1200px
xxl	≥1400px

content #

content: StrOrControl

The content of this cell. Can be a string or a control.

Typically a Text control or a Dropdown control.

If the cell has no data, then a Text widget with placeholder text should be provided instead, and placeholder should be set to True.

To lay out multiple children, let this control's child be a container-like control such as Row, Column, or Stack, which have controls property.

data #

data: Any = skip_field()

Arbitrary data of any type.

disabled #

disabled: bool = False

Every control has disabled property which is False by default - control and all its children are enabled.

Note

The value of this property will be propagated down to all children controls recursively.

Example

For example, if you have a form with multiple entry controls you can disable them all together by disabling container:

ft.Column(
    disabled = True,
    controls=[
        ft.TextField(),
        ft.TextField()
    ]
)

expand #

expand: bool | int | None = None

Specifies whether/how this control should expand to fill available space in its parent layout.

More information here.

Note

Has effect only if the direct parent of this control is one of the following controls, or their subclasses: Column, Row, View, Page.

expand_loose #

expand_loose: bool = False

Allows the control to expand along the main axis if space is available, but does not require it to fill all available space.

More information here.

Note

If expand_loose is True, it will have effect only if:

expand is not None and
the direct parent of this control is one of the following controls, or their subclasses: Column, Row, View, Page.

key #

key: (
    str | int | float | bool | ValueKey | ScrollKey | None
) = None

on_double_tap #

on_double_tap: ControlEventHandler[DataCell] | None = None

Called when the cell is double tapped.

Note

If this is None (including on_tap, on_long_press, on_tap_cancel, on_tap_down), tapping this cell will attempt to select its row (if DataRow.on_select_change is provided).

on_long_press #

on_long_press: ControlEventHandler[DataCell] | None = None

Called if the cell is long-pressed.

Note

If this is None (including on_tap, on_double_tap, on_tap_cancel, on_tap_down), tapping this cell will attempt to select its row (if DataRow.on_select_change is provided).

on_tap #

on_tap: ControlEventHandler[DataCell] | None = None

Called if the cell is tapped.

Note

If this is None (including on_double_tap, on_long_press, on_tap_cancel, on_tap_down), tapping this cell will attempt to select its row (if DataRow.on_select_change is provided).

on_tap_cancel #

on_tap_cancel: ControlEventHandler[DataCell] | None = None

Called if the user cancels a tap was started on cell.

Note

If this is None (including on_tap, on_double_tap, on_long_press, on_tap_down), tapping this cell will attempt to select its row (if DataRow.on_select_change is provided).

on_tap_down #

on_tap_down: EventHandler[TapEvent[DataCell]] | None = None

Called if the cell is tapped down.

Note

If this is None (including on_tap, on_double_tap, on_long_press, on_tap_cancel), tapping this cell will attempt to select its row (if DataRow.on_select_change is provided).

opacity #

opacity: Number = 1.0

Defines the transparency of the control.

Value ranges from 0.0 (completely transparent) to 1.0 (completely opaque without any transparency).

page #

page: Page | PageView | None

The page (of type Page or PageView) to which this control belongs to.

parent #

parent: BaseControl | None

The direct ancestor(parent) of this control.

It defaults to None and will only have a value when this control is mounted (added to the page tree).

The Page control (which is the root of the tree) is an exception - it always has parent=None.

placeholder #

placeholder: bool = False

Whether the child is actually a placeholder.

If this is True, the default text style for the cell is changed to be appropriate for placeholder text.

rtl #

rtl: bool = False

Whether the text direction of the control should be right-to-left (RTL).

show_edit_icon #

show_edit_icon: bool = False

Whether to show an edit icon at the end of the cell.

This does not make the cell actually editable; the caller must implement editing behavior if desired (initiated from the on_tap callback).

Note

If this is set, on_tap should also be set, otherwise tapping the icon will have no effect.

tooltip #

tooltip: TooltipValue | None = None

The tooltip ot show when this control is hovered over.

visible #

visible: bool = True

Every control has visible property which is True by default - control is rendered on the page. Setting visible to False completely prevents control (and all its children if any) from rendering on a page canvas. Hidden controls cannot be focused or selected with a keyboard or mouse and they do not emit any events.

before_event #

before_event(e: ControlEvent)

before_update #

before_update()

clean #

clean() -> None

did_mount #

did_mount()

init #

init()

is_isolated #

is_isolated()

update #

update() -> None

will_unmount #

will_unmount()