Struct dioxus_html::geometry::Coordinates

pub struct Coordinates { /* private fields */ }

Coordinates of a point in the app’s interface

Implementations

impl Coordinates

pub fn new( screen: ScreenPoint, client: ClientPoint, element: ElementPoint, page: PagePoint ) -> Self

Construct new coordinates with the specified screen-, client-, element- and page-relative points

pub fn screen(&self) -> ScreenPoint

Coordinates relative to the entire screen. This takes into account the window’s offset.

pub fn client(&self) -> ClientPoint

Coordinates relative to the application’s viewport (as opposed to the coordinate within the page).

For example, clicking in the top left corner of the viewport will always result in a mouse event with client coordinates (0., 0.), regardless of whether the page is scrolled horizontally.

pub fn element(&self) -> ElementPoint

Coordinates relative to the padding edge of the target element

For example, clicking in the top left corner of an element will result in element coordinates (0., 0.)

pub fn page(&self) -> PagePoint

Coordinates relative to the entire document. This includes any portion of the document not currently visible.

For example, if the page is scrolled 200 pixels to the right and 300 pixels down, clicking in the top left corner of the viewport would result in page coordinates (200., 300.)

Trait Implementations

impl Debug for Coordinates

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl PartialEq for Coordinates

fn eq(&self, other: &Coordinates) -> bool

This method tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl StructuralPartialEq for Coordinates