InteractiveViewer

Allows you to pan, zoom, and rotate its content.

Inherits: LayoutControl

Properties

• alignment(Alignment | None) –

  The alignment of the content within this viewer.

• boundary_margin(MarginValue) –

  A margin for the visible boundaries of the content.

• clip_behavior(ClipBehavior) –

  Defines how to clip the content.

• constrained(bool) –

  Whether the normal size constraints at this point in the control tree are applied

• content(Control) –

  The Control to be transformed.

• interaction_end_friction_coefficient(Number) –

  Changes the deceleration behavior after a gesture.

• interaction_update_interval(int) –

  The interval (in milliseconds) at which the

• max_scale(Number) –

  The maximum allowed scale.

• min_scale(Number) –

  The minimum allowed scale.

• pan_enabled(bool) –

  Whether panning is enabled.

• scale_enabled(bool) –

  Whether scaling is enabled.

• scale_factor(Number) –

  The amount of scale to be performed per pointer scroll.

• trackpad_scroll_causes_scale(bool) –

  Whether scrolling up/down on a trackpad should cause scaling instead of panning.

Events

• on_interaction_end(EventHandler[ScaleEndEvent[InteractiveViewer]] | None) –

  Called when the user ends a pan or scale gesture.

• on_interaction_start(EventHandler[ScaleStartEvent[InteractiveViewer]] | None) –

  Called when the user begins a pan or scale gesture.

• on_interaction_update(EventHandler[ScaleUpdateEvent[InteractiveViewer]] | None) –

  Called when the user updates a pan or scale gesture.

Methods

• pan –
• reset –
• restore_state –
• save_state –
• zoom –

Examples

Live example

Handling events

import flet as ft


def main(page: ft.Page):
    page.add(
        ft.InteractiveViewer(
            min_scale=0.1,
            max_scale=15,
            boundary_margin=ft.margin.all(20),
            on_interaction_start=lambda e: print(e),
            on_interaction_end=lambda e: print(e),
            on_interaction_update=lambda e: print(e),
            content=ft.Image(
                src="https://picsum.photos/500/500",
            ),
        )
    )


ft.run(main)

Programmatic transformations

import flet as ft


def main(page: ft.Page):
    page.horizontal_alignment = ft.CrossAxisAlignment.CENTER
    page.vertical_alignment = ft.MainAxisAlignment.CENTER

    async def handle_zoom_in(e: ft.Event[ft.Button]):
        await i.zoom(1.2)

    async def handle_zoom_out(e: ft.Event[ft.Button]):
        await i.zoom(0.8)

    async def handle_pan(e: ft.Event[ft.Button]):
        await i.pan(dx=50, dy=50)

    async def handle_reset(e: ft.Event[ft.Button]):
        await i.reset()

    async def handle_reset_slow(e: ft.Event[ft.Button]):
        await i.reset(animation_duration=ft.Duration(seconds=2))

    async def handle_save_state(e: ft.Event[ft.Button]):
        await i.save_state()

    async def handle_restore_state(e: ft.Event[ft.Button]):
        await i.restore_state()

    page.add(
        i := ft.InteractiveViewer(
            min_scale=0.1,
            max_scale=5,
            boundary_margin=ft.Margin.all(20),
            content=ft.Image(src="https://picsum.photos/500/500"),
        ),
        ft.Row(
            wrap=True,
            controls=[
                ft.Button("Zoom In", on_click=handle_zoom_in),
                ft.Button("Zoom Out", on_click=handle_zoom_out),
                ft.Button("Pan", on_click=handle_pan),
                ft.Button("Save State", on_click=handle_save_state),
                ft.Button("Restore State", on_click=handle_restore_state),
                ft.Button("Reset (instant)", on_click=handle_reset),
                ft.Button("Reset (slow)", on_click=handle_reset_slow),
            ],
        ),
    )


ft.run(main)

Properties

alignment class-attribute instance-attribute

alignment: Alignment | None = None

The alignment of the content within this viewer.

boundary_margin class-attribute instance-attribute

boundary_margin: MarginValue = field(
    default_factory=lambda: all(0)
)

A margin for the visible boundaries of the content.

Any transformation that results in the viewport being able to view outside of the boundaries will be stopped at the boundary. The boundaries do not rotate with the rest of the scene, so they are always aligned with the viewport.

To produce no boundaries at all, pass an infinite value.

Defaults to Margin.all(0), which results in boundaries that are the exact same size and position as the content.

clip_behavior class-attribute instance-attribute

clip_behavior: ClipBehavior = HARD_EDGE

Defines how to clip the content.

If set to ClipBehavior.NONE, the content can visually overflow the bounds of this InteractiveViewer, but gesture events (such as pan or zoom) will only be recognized within the viewer's area. Ensure this InteractiveViewer is sized appropriately when using ClipBehavior.NONE.

constrained class-attribute instance-attribute

constrained: bool = True

Whether the normal size constraints at this point in the control tree are applied to the content.

If set to False, then the content will be given infinite constraints. This is often useful when a content should be bigger than this InteractiveViewer.

For example, for a content which is bigger than the viewport but can be panned to reveal parts that were initially offscreen, constrained must be set to False to allow it to size itself properly. If constrained is True and the content can only size itself to the viewport, then areas initially outside of the viewport will not be able to receive user interaction events. If experiencing regions of the content that are not receptive to user gestures, make sure constrained is False and the content is sized properly.

content instance-attribute

content: Control

The Control to be transformed.

Must be visible.

Raises:

• ValueError –

  If content is not visible.

interaction_end_friction_coefficient class-attribute instance-attribute

interaction_end_friction_coefficient: Number = 1.35e-05

Changes the deceleration behavior after a gesture.

Raises:

• ValueError –

  If it is less than or equal to 0.

interaction_update_interval class-attribute instance-attribute

interaction_update_interval: int = 200

The interval (in milliseconds) at which the on_interaction_update event is fired.

max_scale class-attribute instance-attribute

max_scale: Number = 2.5

The maximum allowed scale.

Raises:

• ValueError –

  If it is not greater than 0 or is less than min_scale.

min_scale class-attribute instance-attribute

min_scale: Number = 0.8

The minimum allowed scale.

The effective scale is limited by the value of boundary_margin. If scaling would cause the content to be displayed outside the defined boundary, it is prevented. By default, boundary_margin is set to Margin.all(0), so scaling below 1.0 is typically not possible unless you increase the boundary_margin value.

Raises:

• ValueError –

  If it is not greater than 0 or less than max_scale.

pan_enabled class-attribute instance-attribute

pan_enabled: bool = True

Whether panning is enabled.

scale_enabled class-attribute instance-attribute

scale_enabled: bool = True

Whether scaling is enabled.

scale_factor class-attribute instance-attribute

scale_factor: Number = 200

The amount of scale to be performed per pointer scroll.

Increasing this value above the default causes scaling to feel slower, while decreasing it causes scaling to feel faster.

Note

Has effect only on pointer device scrolling, not pinch to zoom.

trackpad_scroll_causes_scale class-attribute instance-attribute

trackpad_scroll_causes_scale: bool = False

Whether scrolling up/down on a trackpad should cause scaling instead of panning.

Events

on_interaction_end class-attribute instance-attribute

on_interaction_end: (
    EventHandler[ScaleEndEvent[InteractiveViewer]] | None
) = None

Called when the user ends a pan or scale gesture.

on_interaction_start class-attribute instance-attribute

on_interaction_start: (
    EventHandler[ScaleStartEvent[InteractiveViewer]] | None
) = None

Called when the user begins a pan or scale gesture.

on_interaction_update class-attribute instance-attribute

on_interaction_update: (
    EventHandler[ScaleUpdateEvent[InteractiveViewer]] | None
) = None

Called when the user updates a pan or scale gesture.

Methods

pan async

pan(dx: Number, dy: Number = 0, dz: Number = 0)

reset async

reset(animation_duration: DurationValue | None = None)

restore_state async

restore_state()

save_state async

save_state()

zoom async

zoom(factor: Number)