Struct BoundingBox

pub struct BoundingBox {
    pub height: Option<f32>,
    pub left: Option<f32>,
    pub top: Option<f32>,
    pub width: Option<f32>,
}

The bounding box around the detected page, text, key-value pair, table, table cell, or selection element on a document page. The left (x-coordinate) and top (y-coordinate) are coordinates that represent the top and left sides of the bounding box. Note that the upper-left corner of the image is the origin (0,0).

The top and left values returned are ratios of the overall document page size. For example, if the input image is 700 x 200 pixels, and the top-left coordinate of the bounding box is 350 x 50 pixels, the API returns a left value of 0.5 (350/700) and a top value of 0.25 (50/200).

The width and height values represent the dimensions of the bounding box as a ratio of the overall document page dimension. For example, if the document page size is 700 x 200 pixels, and the bounding box width is 70 pixels, the width returned is 0.1.

Fields

height: Option<f32>

The height of the bounding box as a ratio of the overall document page height.

left: Option<f32>

The left coordinate of the bounding box as a ratio of overall document page width.

top: Option<f32>

The top coordinate of the bounding box as a ratio of overall document page height.

width: Option<f32>

The width of the bounding box as a ratio of the overall document page width.

Trait Implementations

impl Clone for BoundingBox

fn clone(&self) -> BoundingBox

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for BoundingBox

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

Formats the value using the given formatter.

impl Default for BoundingBox

fn default() -> BoundingBox

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for BoundingBox

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl PartialEq for BoundingBox

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

Tests for self and other values to be equal, and is used by ==.

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

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

impl StructuralPartialEq for BoundingBox