The Bounding Box component for Retool Apps

An interface to display a bounding box and tag areas of an image.

Demo

Properties

All properties for this object with supported data types or values. You can write JavaScript almost anywhere in Retool to manipulate or read property values.

boundingBoxes

A list of bounding box regions.

Type	array
Array values	object
Configurability	Read-only
Default	null

Array Object Properties

height

The height of the bounding box.

Type	number
Configurability	Read-only
Default	null

---

label

The label for the annotated text.

Type	string
Configurability	Read-only
Default	null

---

width

The width of the bounding box.

Type	number
Configurability	Read-only
Default	null

---

x

The horizontal start position of the bounding box.

Type	number
Configurability	Read-only
Default	null

---

y

The vertical start position of the bounding box.

Type	number
Configurability	Read-only
Default	null

---

---

events

A list of configured event handlers that trigger actions or queries.

Type	array
Array values	object
Configurability	Inspector > Interaction > Event handlers
Default	null

Array Object Properties

event

The event that triggers the action. Refer to the events section for details of available events for this object.

Type	string
Configurability	Inspector > Interaction > Event handlers > Event
Default	null

---

method

The JavaScript method to perform when type is datasource, widget, state, or localStorage.

Type	string
Configurability	Inspector > Interaction > Event handlers > Edit event handler > Run script actions
Default	null

---

type

The type of action to perform.

Type	string
Configurability	Inspector > Interaction > Event handlers > Edit event handler > Action
Allowed Values	Value Description datasource Control query. widget Control component. script Run script. state Set variable. localStorage Set localStorage. util Perform utility action (e.g., Open URL or Confetti).
Default	null

---

---

hidden

Whether this object is hidden from view.

Type	boolean
Format	True/False
Configurability	Inspector > Appearance > Hidden
Default	false

Examples

true

---

id

The unique identifier (name).

Type	string
Format	Plain Text
Configurability	Inspector
Default	boundingBox1

Examples

query1

button1

---

imageAltText

An accessible description for screen readers.

Type	string
Configurability	Inspector
Default	null

---

imageUrl

The image to display.

Type	string
Configurability	Inspector
Default	null

---

isHiddenOnDesktop

Whether to show or hide this object in the desktop layout.

Type	boolean
Format	True/False
Configurability	Inspector > Appearance > Advanced > Show on desktop
Default	false

Examples

true

---

isHiddenOnMobile

Whether to show or hide this object in the mobile layout.

Type	boolean
Format	True/False
Configurability	Inspector > Appearance > Advanced > Show on mobile
Default	true

Examples

true

---

labels

A list of labels for each item. Falls back to the corresponding value if no label is provided.

Type	array
Array values	string
Configurability	Read-only
Default	[]

Examples

["Label 1", "Label 2", "Label 3"]

---

maintainSpaceWhenHidden

Whether to take up space on the canvas if hidden is true.

Type	boolean
Format	True/False
Configurability	Inspector > Appearance > Advanced > Maintain space when hidden
Default	false

Examples

true

---

margin

The amount of margin to render outside.

Type	string
Format	Plain Text
Configurability	Inspector > Spacing > Margin
Allowed Values	Value UI Option Description 4px 8px Normal Normal margin. 0 None No margin.
Default	4px 8px

Examples

4px 8px

---

mode

The annotation mode used for the image.

Type	string
Configurability	Inspector
Allowed Values	Value Description boundingbox Enables annotation with bounding boxes. landmarking Enables annotation with landmarks. stretch Resize the image to the same dimensions as the area. contain Scale and clip the image to fit the area while preserving the aspect ratio.
Default	null

---

showInEditor

Whether the component remains visible in the editor if hidden is true.

Type	boolean
Format	True/False
Configurability	Inspector > Appearance > Advanced > Always show in edit mode
Default	false

Examples

true

---

style

Custom style options.

Type	object
Configurability	Inspector > Appearance > style
Default	null

---

Methods

JavaScript API methods for this object. You can write JavaScript almost anywhere in Retool and use methods to manipulate data and property values.

boundingBox.scrollIntoView()

Scrolls the canvas or parent container so that the selected component appears in the visible area.

Definition

boundingBox.scrollIntoView(options)

Parameters

options

The scroll options.

Type

object

Object Properties

behavior

The scroll behavior.

Type	string
Allowed Values	Value Description auto Scroll immediately to the specified position. smooth Scroll gradually to the specified position.

---

block

The scroll position relative to the component.

Type	string
Allowed Values	Value Description nearest Scrolls only the minimum amount required for the component to appear in the visible area. Scrolling does not occur if the component is already in view. start Scrolls to position the component at the top of the visible area. center Scrolls to position the component in the middle of the visible area. end Scrolls to position the component at the bottom of the visible area.

---

---

Examples

Scroll the minimum amount to immediately bring boundingBox into view.

boundingBox.scrollIntoView({behavior: 'auto', block: 'nearest'});

---

Events

Events triggered by user interactions. You can configure event handlers in the IDE to trigger queries or other actions in response to events.

Event	Description
Change	The value is changed.