Struct PanView 

pub struct PanView { /* private fields */ }

A single-child two-dimensional panning viewport.

Implementations

impl PanView

pub fn new() -> Self

Create an empty pan view.

pub fn child(self, child: impl Into<Element>) -> Self

Set the single child element.

pub fn width(self, width: Length) -> Self

Set requested viewport width.

pub fn height(self, height: Length) -> Self

Set requested viewport height.

pub fn offset(self, offset: (i32, i32)) -> Self

Set a controlled viewport offset.

pub fn on_pan(self, cb: Callback<PanEvent>) -> Self

Callback fired when input changes the viewport offset.

pub fn clamp(self, clamp: bool) -> Self

Enable or disable clamping to content bounds.

pub fn center_content(self, center: bool) -> Self

Center the child in the viewport until input or a persisted offset takes over.

pub fn free_pan_margin(self, margin: u16) -> Self

Limit unclamped panning so at least margin cells of content remain reachable.

This only applies when .clamp(false) is set. It gives free-canvas previews room to pull content around without allowing the child to drift infinitely far away.

pub fn free_pan_margins(self, margins: (u16, u16)) -> Self

Set independent horizontal and vertical margins for unclamped panning limits.

pub fn drag_to_pan(self, enabled: bool) -> Self

Enable or disable pointer-drag panning.

pub fn keymap(self, keymap: PanKeymap) -> Self

Configure keys that move the viewport.

pub fn pan_keys(self, keymap: PanKeymap) -> Self

Alias matching ScrollView::scroll_keys style.

pub fn key_step(self, step: (u16, u16)) -> Self

Set keyboard panning step as (horizontal_cells, vertical_cells).

The default is (4, 2) because terminal cells are taller than they are wide.

pub fn focusable(self, focusable: bool) -> Self

Allow the pan view to receive focus.

pub fn pan_state_key(self, key: impl Into<Key>) -> Self

Set a stable key for persisting uncontrolled pan offset across remounts.

pub fn state_key(self, key: impl Into<Arc<str>>) -> Self

Convenience overload for callers that already have an Arc<str>.

Trait Implementations

impl Clone for PanView

fn clone(&self) -> PanView

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Default for PanView

fn default() -> Self

Returns the “default value” for a type.

impl From<PanView> for Element

fn from(value: PanView) -> Self

Converts to this type from the input type.