InteractiveViewer 继承自：LayoutControl, Control, BaseControl

允许你对 content 进行平移、缩放和旋转。

示例

import flet as ft


def main(page: ft.Page):
    page.add(
        ft.SafeArea(
            content=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"),
            ),
        )
    )


if __name__ == "__main__":
    ft.run(main)

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(
        ft.SafeArea(
            content=ft.Column(
                controls=[
                    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),
                        ],
                    ),
                ],
            ),
        )
    )


if __name__ == "__main__":
    ft.run(main)

属性

名称	类型	默认值	说明
content	Annotated[Control, V.visible_control()]	必填	要变换的 Control。 抛出异常： ValueError：如果它不可见。
pan_enabled	bool	True	是否启用平移。
scale_enabled	bool	True	是否启用缩放。
trackpad_scroll_causes_scale	bool	False	在触控板上向上/向下滚动时是否应触发缩放而非平移。
constrained	bool	True	是否对 content 应用控件树中此位置上的常规尺寸约束。 如果设为 False，则内容会获得无限约束。当内容需要比此 InteractiveViewer 更大时，这通常很有用。 例如，对于比视口更大、但可以通过平移来查看初始不可见部分的内容，必须将 constrained 设为 False 才能让内容正确确定自身尺寸。如果 constrained 为 True 而内容只能按视口大小确定尺寸，那么初始位于视口之外的区域将无法接收用户交互事件。如果你遇到内容中某些区域无法响应用户手势的情况，请确保 constrained 为 False 且内容尺寸设置正确。
max_scale	Annotated[Number, V.gt(0), V.ge_field('min_scale')]	2.5	允许的最大缩放值。 抛出异常： ValueError：如果它不大于 0。 ValueError：如果它不大于或等于 min_scale。
min_scale	Annotated[Number, V.gt(0), V.le_field('max_scale')]	0.8	允许的最小缩放值。 实际生效的缩放会受 boundary_margin 的值限制。如果缩放会导致内容显示在定义的边界之外，就会被阻止。默认情况下，boundary_margin 为 Margin.all(0)，因此除非增大 boundary_margin 的值，通常无法缩放到 1.0 以下。 抛出异常： ValueError：如果它不大于 0。 ValueError：如果它不小于或等于 max_scale。
interaction_end_friction_coefficient	Annotated[Number, V.gt(0)]	1.35e-05	更改手势结束后的减速行为。 抛出异常： ValueError：如果它不大于 0。
scale_factor	Number	200	每次指针滚动所执行的缩放量。 将此值增大到默认值以上会让缩放感觉更慢，减小则会让缩放感觉更快。 注意： 仅对指针设备滚动生效，对捏合缩放无效。
clip_behavior	ClipBehavior	ClipBehavior.HARD_EDGE	定义如何裁剪 content。 如果设为 NONE，content 可以在视觉上溢出此 InteractiveViewer 的边界，但手势事件（例如平移或缩放）只会在 viewer 区域内被识别。使用 NONE 时，请确保此 InteractiveViewer 设置了合适的尺寸。
alignment	Optional[Alignment]	None	content 在此 viewer 内的对齐方式。
boundary_margin	MarginValue	Margin.all(0()	content 可见边界的外边距。 任何导致视口能够看到边界之外的变换都会在边界处停止。边界不会随场景其余部分旋转，因此它们始终与视口对齐。 若要完全不设边界，请传入无限值。 默认值为 Margin.all(0)，即边界与 content 的尺寸和位置完全相同。
interaction_update_interval	int	200	on_interaction_update 事件的触发间隔（毫秒）。
width	Optional[Number]	None	控件的强制宽度（以虚拟像素为单位）。
height	Optional[Number]	None	控件的强制高度（以虚拟像素为单位）。
left	Optional[Number]	None	子控件左边缘相对于 Stack 左侧的内缩距离。 注意： 仅当此控件是以下之一的后代时才生效： Stack 控件、overlay 列表。
top	Optional[Number]	None	子控件上边缘相对于 Stack 顶部的内缩距离。 注意： 仅当此控件是以下之一的后代时才生效： Stack 控件、overlay 列表。
right	Optional[Number]	None	子控件右边缘相对于 Stack 右侧的内缩距离。 注意： 仅当此控件是以下之一的后代时才生效： Stack 控件、overlay 列表。
bottom	Optional[Number]	None	子控件下边缘相对于 Stack 底部的内缩距离。 注意： 仅当此控件是以下之一的后代时才生效： Stack 控件、overlay 列表。
align	Optional[Alignment]	None	控件在其父级中的对齐方式。
margin	Optional[MarginValue]	None	设置控件的外边距。
rotate	Optional[RotateValue]	None	围绕控件中心旋转来变换此控件。 rotate 属性的值可以是以下类型之一： * number —— 顺时针旋转的弧度值。整圈 360° 为 math.pi * 2 弧度，90° 为 pi / 2，45° 为 pi / 4，以此类推。 * Rotate —— 允许同时指定旋转 angle 和 alignment，即旋转中心的位置。 示例： python 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) )
scale	Optional[ScaleValue]	None	沿二维平面缩放此控件。默认缩放因子为 1.0，表示不缩放。 例如，将此属性设为 0.5 会让控件缩小一半，而设为 2.0 则会放大一倍。 通过将 Control.scale 属性设为 Scale 类的实例，可以为 x 和 y 轴指定不同的缩放倍数。可以指定 scale，或者指定 scale_x 和 scale_y，但不能同时指定全部。 示例： python 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) )
offset	Optional[OffsetValue]	None	在绘制控件之前应用平移变换。 平移量表示为按控件尺寸缩放的 Offset。例如，Offset(x=0.25, y=0) 会使控件沿水平方向平移其宽度的四分之一。 示例 下面的示例把容器显示在 Stack 的 0, 0 左上角，因为变换对控件应用了 -1 * 100, -1 * 100（即 offset * control's size）的水平与垂直平移： python import flet as ft def main(page: ft.Page): page.add( ft.Stack( width=1000, height=1000, controls=[ ft.Container( bgcolor=ft.Colors.RED, width=100, height=100, left=100, top=100, offset=ft.Offset(-1, -1), ) ], ) ) ft.run(main)
flip	Optional[Flip]	None	水平方向和/或垂直方向翻转此控件。 设为 Flip 的实例即可沿 x 轴、y 轴或两者镜像翻转。
transform	Optional[Transform]	None	对此控件应用通用矩阵变换。 设为带 Matrix4 记录的 Transform 实例，用以描述任意的变换序列。
aspect_ratio	Optional[Number]	None	控件的宽高比，定义为 width 与 height 的比值。 注意： 在当前实现中，如果设置了 aspect_ratio，同一控件上的 width 和 height 将在最终渲染尺寸中被忽略。
animate_opacity	Optional[AnimationValue]	None	启用 opacity 属性的隐式动画。 更多信息见此处。
animate_size	Optional[AnimationValue]	None	启用此控件尺寸的隐式动画。 如果设置了 width 或 height，则这些维度的变化会以动画呈现。如果两者都未设置，则对控件自然尺寸的变化进行动画。 更多信息见此处。
animate_position	Optional[AnimationValue]	None	启用定位属性（left、right、top 和 bottom）的隐式动画。 更多信息见此处。
animate_align	Optional[AnimationValue]	None	启用 align 属性的隐式动画。 更多信息见此处。
animate_margin	Optional[AnimationValue]	None	启用 margin 属性的隐式动画。 更多信息见此处。
animate_rotation	Optional[AnimationValue]	None	启用 rotate 属性的隐式动画。 更多信息见此处。
animate_scale	Optional[AnimationValue]	None	启用 scale 属性的隐式动画。 更多信息见此处。
animate_offset	Optional[AnimationValue]	None	启用 offset 属性的隐式动画。 更多信息见此处。
size_change_interval	int	10	on_size_change 事件的采样间隔（毫秒）。 设为 0 时，每次变化都会立即调用 on_size_change。
expand	Annotated[Optional[Union[bool, int]], V.instance_of((bool, int))]	None	指定此控件是否／如何扩展以填满父布局中的可用空间。 更多信息见此处。 注意： 仅当此控件的直接父级是以下控件或其子类时才生效：Column、Row、View、Page。 抛出异常： ValueError：如果它不是 bool 或 int 类型。
expand_loose	bool	False	允许控件在主轴方向有可用空间时扩展，但不要求它填满所有可用空间。 更多信息见此处。 注意： 如果 expand_loose 为 True，则仅在以下条件满足时才生效： - expand 不为 None，且 - 此控件的直接父级是以下控件或其子类之一：Column、Row、View、Page。
col	ResponsiveNumber	12	如果此控件的父级是 ResponsiveRow，则此属性决定该控件在屏幕上跨越多少虚拟列。 可以是一个数字，也可以是一个按断点配置不同值的字典，例如 col={"sm": 6}。 值为 0 时会在该断点隐藏控件，因此它不会占用父级 ResponsiveRow 中的任何列。 此控件默认跨越 12 个虚拟列。 | 断点 | 尺寸 | |---|---| | xs | <576px | | sm | ≥576px | | md | ≥768px | | lg | ≥992px | | xl | ≥1200px | | xxl | ≥1400px |
opacity	Annotated[Number, V.between(0.0, 1.0)]	1.0	定义控件的透明度。 取值范围从 0.0（完全透明）到 1.0（完全不透明，无任何透明感）。 抛出异常： ValueError：如果它不在 0.0 到 1.0（含）之间。
tooltip	Optional[TooltipValue]	None	鼠标悬停在此控件上时显示的工具提示。
badge	Optional[BadgeValue]	None	显示在此控件顶部的徽章。
visible	bool	True	每个控件都有 visible 属性，默认为 True —— 控件会渲染在页面上。将 visible 设为 False 会彻底阻止控件（及其所有子控件，如果有）渲染到页面画布上。隐藏的控件无法通过键盘或鼠标获得焦点或选中，也不会触发任何事件。
disabled	bool	False	每个控件都有 disabled 属性，默认为 False —— 控件及其所有子控件都处于启用状态。 注意： 此属性的值会递归向下传播到所有子控件。 示例： 例如，如果你有一个包含多个输入控件的表单，可以通过禁用容器来一并禁用它们： python ft.Column( disabled = True, controls=[ ft.TextField(), ft.TextField() ] )
rtl	bool	False	控件的文本方向是否为从右到左（RTL）。
data	Any	skip_	任意类型的自定义数据。
key	Optional['KeyValue']	None	用于在更新之间保持控件标识稳定的键。

只读属性

名称	类型	默认值	说明
parent	Optional['BaseControl']	—	此控件的直接祖先（父级）。 默认为 None，只有在此控件被挂载（加入页面树）后才有值。 Page 控件（页面树的根）是个例外 —— 它的 parent 始终为 None。
page	'Page'	—	此控件所属的页面。

事件

名称	类型	默认值	说明
on_interaction_start	Optional[EventHandler[ScaleStartEvent['InteractiveViewer']]]	None	当用户开始平移或缩放手势时调用。
on_interaction_update	Optional[EventHandler[ScaleUpdateEvent['InteractiveViewer']]]	None	当用户更新平移或缩放手势时调用。
on_interaction_end	Optional[EventHandler[ScaleEndEvent['InteractiveViewer']]]	None	当用户结束平移或缩放手势时调用。
on_size_change	Optional[EventHandler[LayoutSizeChangeEvent['LayoutControl']]]	None	当此控件的尺寸发生变化时调用。 size_change_interval 定义此事件的调用频率。
on_animation_end	Optional[ControlEventHandler['LayoutControl']]	None	动画完成时调用。 可用于串联多个动画。 事件处理器参数的 data 属性包含动画名称。 更多信息见此处。

方法

名称	类型	默认值	说明
reset	—	—	将当前变换矩阵重置为单位矩阵。 参数： animation_duration：重置过渡可选使用的动画时长。如果为 None，则立即应用重置。 说明： 当提供了 animation_duration 时，Flutter 会使用矩阵补间从当前变换插值到单位矩阵。
save_state	—	—	保存当前变换矩阵的快照。 保存的状态之后可以通过 restore_state 恢复。再次调用此方法会覆盖之前保存的快照。
restore_state	—	—	恢复此前由 save_state 捕获的变换矩阵。 如果尚未保存任何状态，此方法不产生任何效果。
zoom	—	—	对当前变换应用乘性缩放。 参数： factor：相对于当前缩放值的缩放倍数。 大于 1 的值会放大，介于 0 和 1 之间的值会缩小。 注意： 最终的缩放值会被限制在 min_scale 和 max_scale 之间。此外还会应用边界限制，使可见视口始终保持在 boundary_margin 范围内。
pan	—	—	平移当前变换矩阵。 参数： dx：水平平移量（逻辑像素）。 dy：垂直平移量（逻辑像素）。 dz：应用到变换矩阵的 Z 轴平移量。 注意： XY 方向的平移会被限制在用于手势驱动平移的相同交互边界内。dz 会直接应用到矩阵上，默认为 0。
is_isolated	—	—	返回此控件是否被标记为隔离。 隔离控件会被排除在父级驱动的更新遍历之外，并需要自行管理更新边界。
init	—	—	在控件实例初始化之后、第一次 build / 更新循环之前调用。 重写此钩子以执行依赖于已初始化字段的轻量级设置。不要在此处调用 update()。
build	—	—	在控件初始化期间调用一次，用于定义其子控件。在此方法中 page 属性可用。
before_update	—	—	每当此控件被更新时都会调用此方法。 注意： 务必不要在此处调用或请求 update()。
before_event	—	—	在事件处理器执行之前拦截事件。 返回 False 可取消分发。返回 True 或 None 则继续正常的事件处理。
did_mount	—	—	在控件挂载到页面树之后调用。 重写此方法以启动需要已挂载页面的资源，例如订阅、定时器或服务监听器。
will_unmount	—	—	在控件从页面树移除之前调用。 重写此方法以释放 did_mount() 中创建的资源，例如订阅、定时器或外部句柄。
get_data_channel	—	—	解析为此 widget 在 Dart 侧分配的 [DataChannel]。模式： on_data_channel_open: Optional[ft.EventHandler[DataChannelOpenEvent]] = None def init(self): self.on_data_channel_open = self._on_open def _on_open(self, e): self._channel = self.get_data_channel(e.channel_id) 幂等 —— 底层的 Connection 会按 id 缓存 DataChannel，因此重复调用会返回同一实例。没有错误路径：该 id 始终来自框架触发的事件，所以当此方法运行时，通道在两端都已存在。
update	None	—	为此控件请求一次 UI 更新。 在更改控件状态或属性后调用。控件必须已挂载到页面且未被标记为冻结。