BoundingBox (AWS SDK for Android

java.lang.Object
- com.amazonaws.services.textract.model.BoundingBox

All Implemented Interfaces:

java.io.Serializable
```
public class BoundingBox
extends java.lang.Object
implements java.io.Serializable
```
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.

See Also:

Serialized Form

Constructor Summary

Constructors
Constructor and Description

BoundingBox()

Constructors
Constructor and Description
`BoundingBox()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`boolean`	`equals(java.lang.Object obj)`
`java.lang.Float`	`getHeight()` The height of the bounding box as a ratio of the overall document page height.
`java.lang.Float`	`getLeft()` The left coordinate of the bounding box as a ratio of overall document page width.
`java.lang.Float`	`getTop()` The top coordinate of the bounding box as a ratio of overall document page height.
`java.lang.Float`	`getWidth()` The width of the bounding box as a ratio of the overall document page width.
`int`	`hashCode()`
`void`	`setHeight(java.lang.Float height)` The height of the bounding box as a ratio of the overall document page height.
`void`	`setLeft(java.lang.Float left)` The left coordinate of the bounding box as a ratio of overall document page width.
`void`	`setTop(java.lang.Float top)` The top coordinate of the bounding box as a ratio of overall document page height.
`void`	`setWidth(java.lang.Float width)` The width of the bounding box as a ratio of the overall document page width.
`java.lang.String`	`toString()` Returns a string representation of this object; useful for testing and debugging.
`BoundingBox`	`withHeight(java.lang.Float height)` The height of the bounding box as a ratio of the overall document page height.
`BoundingBox`	`withLeft(java.lang.Float left)` The left coordinate of the bounding box as a ratio of overall document page width.
`BoundingBox`	`withTop(java.lang.Float top)` The top coordinate of the bounding box as a ratio of overall document page height.
`BoundingBox`	`withWidth(java.lang.Float width)` The width of the bounding box as a ratio of the overall document page width.

Methods inherited from class java.lang.Object
getClass, notify, notifyAll, wait, wait, wait

- Constructor Detail
  - BoundingBox
```
public BoundingBox()
```
- Method Detail
  - getWidth
```
public java.lang.Float getWidth()
```
    The width of the bounding box as a ratio of the overall document page width.
    
    Returns:
    
    The width of the bounding box as a ratio of the overall document page width.
  - setWidth
```
public void setWidth(java.lang.Float width)
```
    The width of the bounding box as a ratio of the overall document page width.
    
    Parameters:
    
    width -
    The width of the bounding box as a ratio of the overall document page width.
  - withWidth
```
public BoundingBox withWidth(java.lang.Float width)
```
    The width of the bounding box as a ratio of the overall document page width.
    
    Returns a reference to this object so that method calls can be chained together.
    
    Parameters:
    
    width -
    The width of the bounding box as a ratio of the overall document page width.
    
    Returns:
    
    A reference to this updated object so that method calls can be chained together.
  - getHeight
```
public java.lang.Float getHeight()
```
    The height of the bounding box as a ratio of the overall document page height.
    
    Returns:
    
    The height of the bounding box as a ratio of the overall document page height.
  - setHeight
```
public void setHeight(java.lang.Float height)
```
    The height of the bounding box as a ratio of the overall document page height.
    
    Parameters:
    
    height -
    The height of the bounding box as a ratio of the overall document page height.
  - withHeight
```
public BoundingBox withHeight(java.lang.Float height)
```
    The height of the bounding box as a ratio of the overall document page height.
    
    Returns a reference to this object so that method calls can be chained together.
    
    Parameters:
    
    height -
    The height of the bounding box as a ratio of the overall document page height.
    
    Returns:
    
    A reference to this updated object so that method calls can be chained together.
  - getLeft
```
public java.lang.Float getLeft()
```
    The left coordinate of the bounding box as a ratio of overall document page width.
    
    Returns:
    
    The left coordinate of the bounding box as a ratio of overall document page width.
  - setLeft
```
public void setLeft(java.lang.Float left)
```
    The left coordinate of the bounding box as a ratio of overall document page width.
    
    Parameters:
    
    left -
    The left coordinate of the bounding box as a ratio of overall document page width.
  - withLeft
```
public BoundingBox withLeft(java.lang.Float left)
```
    The left coordinate of the bounding box as a ratio of overall document page width.
    
    Returns a reference to this object so that method calls can be chained together.
    
    Parameters:
    
    left -
    The left coordinate of the bounding box as a ratio of overall document page width.
    
    Returns:
    
    A reference to this updated object so that method calls can be chained together.
  - getTop
```
public java.lang.Float getTop()
```
    The top coordinate of the bounding box as a ratio of overall document page height.
    
    Returns:
    
    The top coordinate of the bounding box as a ratio of overall document page height.
  - setTop
```
public void setTop(java.lang.Float top)
```
    The top coordinate of the bounding box as a ratio of overall document page height.
    
    Parameters:
    
    top -
    The top coordinate of the bounding box as a ratio of overall document page height.
  - withTop
```
public BoundingBox withTop(java.lang.Float top)
```
    The top coordinate of the bounding box as a ratio of overall document page height.
    
    Returns a reference to this object so that method calls can be chained together.
    
    Parameters:
    
    top -
    The top coordinate of the bounding box as a ratio of overall document page height.
    
    Returns:
    
    A reference to this updated object so that method calls can be chained together.
  - toString
```
public java.lang.String toString()
```
    Returns a string representation of this object; useful for testing and debugging.
    
    Overrides:
    
    toString in class java.lang.Object
    
    Returns:
    
    A string representation of this object.
    
    See Also:
    
    Object.toString()
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class java.lang.Object
  - equals
```
public boolean equals(java.lang.Object obj)
```
    Overrides:
    
    equals in class java.lang.Object

Class BoundingBox

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

BoundingBox

Method Detail

getWidth

setWidth

withWidth

getHeight

setHeight

withHeight

getLeft

setLeft

withLeft

getTop

setTop

withTop

toString

hashCode

equals