BoundingBox

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.

Types

Link copied to clipboard
class Builder
Link copied to clipboard
object Companion

Properties

Link copied to clipboard

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

Link copied to clipboard
val left: Float

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

Link copied to clipboard
val top: Float

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

Link copied to clipboard

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

Functions

Link copied to clipboard
inline fun copy(block: BoundingBox.Builder.() -> Unit = {}): BoundingBox
Link copied to clipboard
open operator override fun equals(other: Any?): Boolean
Link copied to clipboard
open override fun hashCode(): Int
Link copied to clipboard
open override fun toString(): String