Screenshot

Examples

Taking control screenshot

from pathlib import Path

import flet as ft
from flet.utils.files import get_current_script_dir


def main(page: ft.Page):
    async def take_screenshot():
        image = await scr.capture()
        with open(Path(get_current_script_dir(), "screenshot.png"), "wb") as f:
            f.write(image)

    page.add(
        scr := ft.Screenshot(
            ft.Container(
                ft.Button("Hello, world!", bgcolor=ft.Colors.BLUE, elevation=10),
                padding=10,
            )
        ),
        ft.Button("Take screenshot", on_click=take_screenshot),
    )


ft.run(main)

Screenshot

Bases: Control

Takes a screenshot of containing 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: Control

The control to be captured.

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: KeyValue | None = None

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.

rtl

rtl: bool = False

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

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()

build

build()

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

capture

capture(
    pixel_ratio: Number | None = None,
    delay: DurationValue | None = None,
) -> bytes

Captures a screenshot of the enclosed content control.

PARAMETER	DESCRIPTION
pixel_ratio	A pixel ratio of the captured screenshot. If None, device-specific pixel ratio will be used. TYPE: Number | None DEFAULT: None
delay	A delay before taking a screenshot. The delay will be 20 milliseconds if not specified. TYPE: DurationValue | None DEFAULT: None

RETURNS	DESCRIPTION
bytes	Screenshot in PNG format.

clean

clean() -> None

did_mount

did_mount()

init

init()

is_isolated

is_isolated()

update

update() -> None

will_unmount

will_unmount()