Skip to content

DataTable2

DataTable2 #

Bases: DataTable

Extends flet.DataTable.

Provides sticky header row, scrollable data rows, and additional layout flexibility with DataColumn2 and DataRow2.

Note

DataTable2 doesn't support flet.DataTable.data_row_min_height and flet.DataTable.data_row_max_height properties present in the parent flet.DataTable. Use data_row_height instead.

_c #

_c: str = field(init=False)

_i #

_i: int = field(init=False, compare=False)

_internals #

_internals: dict = field(
    default_factory=dict,
    init=False,
    repr=False,
    compare=False,
)

animate_offset #

animate_offset: AnimationValue | None = None

Enables implicit animation of the offset property.

More information here.

animate_opacity #

animate_opacity: AnimationValue | None = None

Enables implicit animation of the opacity property.

More information here.

animate_position #

animate_position: AnimationValue | None = None

Enables implicit animation of the positioning properties (left, right, top and bottom).

More information here.

animate_rotation #

animate_rotation: AnimationValue | None = None

Enables implicit animation of the rotate property.

More information here.

animate_scale #

animate_scale: AnimationValue | None = None

Enables implicit animation of the scale property.

More information here.

animate_size #

animate_size: AnimationValue | None = None

TBD

aspect_ratio #

aspect_ratio: Number | None = None

TBD

badge #

badge: BadgeValue | None = None

A badge to show on top of this control.

bgcolor #

bgcolor: ColorValue | None = None

The background color for the table.

border #

border: Border | None = None

The border around the table.

border_radius #

border_radius: BorderRadiusValue | None = None

Border corners.

bottom #

bottom: Number | None = None

The distance that the child's bottom edge is inset from the bottom of the stack.

Note

Effective only if this control is a descendant of one of the following: Stack control, Page.overlay list.

bottom_margin #

bottom_margin: Number | None = None

Adds space after the last row if set.

checkbox_alignment #

checkbox_alignment: Alignment = field(
    default_factory=lambda: CENTER
)

Alignment of the checkbox.

checkbox_horizontal_margin #

checkbox_horizontal_margin: Number | None = None

Horizontal margin around the checkbox, if it is displayed.

clip_behavior #

clip_behavior: ClipBehavior = NONE

Defines how the contents of the table are clipped.

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.

/// details | Dimensions type: info | Breakpoint | Dimension | |---|---| | xs | <576px | | sm | ≥576px | | md | ≥768px | | lg | ≥992px | | xl | ≥1200px | | xxl | ≥1400px | ///

column_spacing #

column_spacing: Number | None = None

The horizontal margin between the contents of each data column.

columns #

columns: list[DataColumn2 | DataColumn]

A list of table columns.

data #

data: Any = skip_field()

Arbitrary data of any type.

data_row_checkbox_theme #

data_row_checkbox_theme: CheckboxTheme | None = None

Overrides theme of checkboxes in each data row.

data_row_color #

data_row_color: ControlStateValue[ColorValue] | None = None

The background color for the data rows.

The effective background color can be made to depend on the ControlState state, i.e. if the row is selected, pressed, hovered, focused, disabled or enabled. The color is painted as an overlay to the row. To make sure that the row's InkWell is visible (when pressed, hovered and focused), it is recommended to use a translucent background color.

data_row_height #

data_row_height: Number | None = None

Height of each data row.

data_text_style #

data_text_style: TextStyle | None = None

The text style for data rows.

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.

/// details | Example type: 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()
    ]
)
///

divider_thickness #

divider_thickness: Number = 1.0

The width of the divider that appears between rows.

Note

Must be greater than or equal to zero.

empty #

empty: Control | None = None

Placeholder control shown when there are no data rows.

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.

fixed_columns_color #

fixed_columns_color: ColorValue | None = None

Background color for sticky left columns.

fixed_corner_color #

fixed_corner_color: ColorValue | None = None

Background color of the fixed top-left corner cell.

fixed_left_columns #

fixed_left_columns: int = 0

Number of sticky columns on the left. Includes checkbox column, if present.

fixed_top_rows #

fixed_top_rows: int = 1

Number of sticky rows from the top. Includes heading row by default.

gradient #

gradient: Gradient | None = None

The background gradient for the table.

heading_checkbox_theme #

heading_checkbox_theme: CheckboxTheme | None = None

Overrides theme of the heading checkbox.

heading_row_color #

heading_row_color: ControlStateValue[ColorValue] | None = (
    None
)

The background color for the heading row.

The effective background color can be made to depend on the ControlState state, i.e. if the row is pressed, hovered, focused when sorted. The color is painted as an overlay to the row. To make sure that the row's InkWell is visible (when pressed, hovered and focused), it is recommended to use a translucent color.

heading_row_height #

heading_row_height: Number | None = None

The height of the heading row.

heading_text_style #

heading_text_style: TextStyle | None = None

The text style for the heading row.

height #

height: Number | None = None

Imposed Control height in virtual pixels.

horizontal_lines #

horizontal_lines: BorderSide | None = None

Set the color and width of horizontal lines between rows.

horizontal_margin #

horizontal_margin: Number | None = None

The horizontal margin between the edges of the table and the content in the first and last cells of each row.

When a checkbox is displayed, it is also the margin between the checkbox the content in the first data column.

key #

key: KeyValue | None = None

left #

left: Number | None = None

The distance that the child's left edge is inset from the left of the stack.

Note

Effective only if this control is a descendant of one of the following: Stack control, Page.overlay list.

lm_ratio #

lm_ratio: Number = 1.2

Ratio of Large column width to Medium.

min_width #

min_width: Number | None = None

Minimum table width before horizontal scrolling kicks in.

offset #

offset: OffsetValue | None = None

Applies a translation transformation before painting the control.

The translation is expressed as an Offset scaled to the control's size. So, Offset(x=0.25, y=0), for example, will result in a horizontal translation of one quarter the width of this control.

/// details | Example type: example The following example displays container at 0, 0 top left corner of a stack as transform applies -1 * 100, -1 * 100 (offset * control's size) horizontal and vertical translations to the control:

import flet as ft

def main(page: ft.Page):
    page.add(
        ft.Stack(
            width=1000,
            height=1000,
            controls=[
                ft.Container(
                    bgcolor="red",
                    width=100,
                    height=100,
                    left=100,
                    top=100,
                    offset=ft.Offset(-1, -1),
                )
            ],
        )
    )

ft.run(main)
///

on_animation_end #

on_animation_end: (
    ControlEventHandler[ConstrainedControl] | None
) = None

Called when animation completes.

Can be used to chain multiple animations.

The data property of the event handler argument contains the name of the animation.

More information here.

on_select_all #

on_select_all: ControlEventHandler[DataTable] | None = None

Invoked when the user selects or unselects every row, using the checkbox in the heading row.

If this is None, then the DataRow.on_select_change callback of every row in the table is invoked appropriately instead.

To control whether a particular row is selectable or not, see DataRow.on_select_change. This callback is only relevant if any row is selectable.

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 | BasePage | None

The page 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.

right #

right: Number | None = None

The distance that the child's right edge is inset from the right of the stack.

Note

Effective only if this control is a descendant of one of the following: Stack control, Page.overlay list.

rotate #

rotate: RotateValue | None = None

Transforms this control using a rotation around its center.

The value of rotate property could be one of the following types:

  • number - a rotation in clockwise radians. Full circle 360° is math.pi * 2 radians, 90° is pi / 2, 45° is pi / 4, etc.
  • Rotate - allows to specify rotation angle as well as alignment - the location of rotation center.

/// details | Example type: example For example: 

ft.Image(
    src="https://picsum.photos/100/100",
    width=100,
    height=100,
    border_radius=5,
    rotate=Rotate(angle=0.25 * pi, alignment=ft.Alignment.CENTER_LEFT)
)
///

rows #

rows: list[DataRow | DataRow2] = field(default_factory=list)

A list of table rows.

rtl #

rtl: bool = False

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

scale #

scale: ScaleValue | None = None

Scales this control along the 2D plane. Default scale factor is 1.0, meaning no-scale.

Setting this property to 0.5, for example, makes this control twice smaller, while 2.0 makes it twice larger.

Different scale multipliers can be specified for x and y axis, by setting Control.scale property to an instance of Scale class. Either scale or scale_x and scale_y could be specified, but not all of them.

/// details | Example type: example 

ft.Image(
    src="https://picsum.photos/100/100",
    width=100,
    height=100,
    border_radius=5,
    scale=ft.Scale(scale_x=2, scale_y=0.5)
)
///

show_bottom_border #

show_bottom_border: bool = False

Whether a border at the bottom of the table is displayed.

By default, a border is not shown at the bottom to allow for a border around the table defined by decoration.

show_checkbox_column #

show_checkbox_column: bool = False

Whether the control should display checkboxes for selectable rows.

If True, a checkbox will be placed at the beginning of each row that is selectable. However, if DataRow.on_select_change is not set for any row, checkboxes will not be placed, even if this value is True.

If False, all rows will not display a checkbox.

show_heading_checkbox #

show_heading_checkbox: bool = True

Controls visibility of the heading checkbox.

sm_ratio #

sm_ratio: Number = 0.67

Ratio of Small column width to Medium.

sort_arrow_animation_duration #

sort_arrow_animation_duration: DurationValue = field(
    default_factory=lambda: Duration(milliseconds=150)
)

Duration of sort arrow animation.

sort_arrow_icon #

sort_arrow_icon: IconValue = ARROW_UPWARD

Icon shown when sorting is applied.

sort_arrow_icon_color #

sort_arrow_icon_color: ColorValue | None = None

When set always overrides/preceeds default arrow icon color.

sort_ascending #

sort_ascending: bool = False

Whether the column mentioned in sort_column_index, if any, is sorted in ascending order.

If True, the order is ascending (meaning the rows with the smallest values for the current sort column are first in the table).

If False, the order is descending (meaning the rows with the smallest values for the current sort column are last in the table).

sort_column_index #

sort_column_index: int | None = None

The current primary sort key's column.

If specified, indicates that the indicated column is the column by which the data is sorted. The number must correspond to the index of the relevant column in columns.

Setting this will cause the relevant column to have a sort indicator displayed.

When this is None, it implies that the table's sort order does not correspond to any of the columns.

tooltip #

tooltip: TooltipValue | None = None

The tooltip ot show when this control is hovered over.

top #

top: Number | None = None

The distance that the child's top edge is inset from the top of the stack.

Note

Effective only if this control is a descendant of one of the following: Stack control, Page.overlay list.

vertical_lines #

vertical_lines: BorderSide | None = None

Set the color and width of vertical lines between columns.

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.

visible_horizontal_scroll_bar #

visible_horizontal_scroll_bar: bool | None = None

Determines visibility of the horizontal scrollbar.

visible_vertical_scroll_bar #

visible_vertical_scroll_bar: bool | None = None

Determines visibility of the vertical scrollbar.

width #

width: Number | None = None

Imposed Control width in virtual pixels.

__contains__ #

__contains__(item)

__hash__ #

__hash__() -> int

__init__ #

__init__(
    *,
    data: Any = skip_field(),
    key: KeyValue | None = None,
    ref: InitVar[Ref[BaseControl] | None] = None,
    expand: bool | int | None = None,
    expand_loose: bool = False,
    col: ResponsiveNumber = 12,
    opacity: Number = 1.0,
    tooltip: TooltipValue | None = None,
    badge: BadgeValue | None = None,
    visible: bool = True,
    disabled: bool = False,
    rtl: bool = False,
) -> None

__post_init__ #

__post_init__(ref: Ref[Any] | None)

_invoke_method #

_invoke_method(
    method_name: str,
    arguments: dict[str, Any] | None = None,
    timeout: float | None = None,
) -> Any

_trigger_event #

_trigger_event(event_name: str, event_data: Any)

before_event #

before_event(e: ControlEvent)

before_update #

before_update()

build #

build()

Called once during control initialization to define its child controls. self.page is available in this method.

clean #

clean() -> None

did_mount #

did_mount()

init #

init()

is_isolated #

is_isolated()

update #

update() -> None

will_unmount #

will_unmount()