The Bounding Box component for Retool Apps

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

Demo

For more information about this component, refer to the Images guide.

Settings

Bounding Box includes the following configurable options when building apps in the IDE.

Event handlersHiddenImage src URLShow on desktopShow on mobileMaintain space when hiddenMarginFitAlways show in edit modeStyles

Properties

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

boundingBoxes

object[]

A list of bounding box regions.

Properties

height

number

The height of the bounding box.

---

label

string

The label for the annotated text.

---

width

number

The width of the bounding box.

---

x

number

The horizontal start position of the bounding box.

---

y

number

The vertical start position of the bounding box.

---

---

events

object[]

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

Properties

event

enum

The event type. Refer to the events section for a list of supported events.

---

method

enum

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

---

type

enum

The type of action to perform.

Values

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).

---

---

global

boolean

Whether the object is globally scoped for use in all app pages.

---

hidden

boolean

Whether the component is visible.

---

id

string

The unique identifier.

---

imageUrl

url

The image to display.

---

isHiddenOnDesktop

boolean

Whether the component is visible in the desktop layout.

---

isHiddenOnMobile

boolean

Whether the component is visible in the mobile layout.

---

labels

string

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

---

maintainSpaceWhenHidden

boolean

Whether the component takes up space on the canvas if hidden is true.

---

margin

enum

The amount of margin to render outside.

Values

4px 8px	Normal margin.
0	No margin.

---

mode

enum

The annotation mode used for the image.

Values

boundingbox	Enables annotation with bounding boxes.
landmarking	Enables annotation with landmarks.

---

pluginType

string

The plugin type.

---

showInEditor

boolean

Whether to remain visible in the editor if hidden is true.

---

style

object

Custom style options in use. Not all style options may be available for all components.

---

Methods

JavaScript API methods for interacting with Bounding Box. You can write JavaScript almost anywhere in Retool and use methods to manipulate data and property values.

scrollIntoView

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

boundingBox.scrollIntoView(scrollIntoViewOptions)

Parameters

scrollIntoViewOptions

object

The scroll options.

Properties

behavior

enum

The scroll behavior.

Values

auto	Scroll immediately to the specified position.
smooth	Scroll gradually to the specified position.

---

block

enum

The scroll position relative to the component.

Values

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.

---

---

---

Events

Events are triggered by user interactions, such as clicking a button or entering a value. Use event handlers to trigger queries or other actions in response to events.

change

The value is changed.

---