The Statistic component for Retool Apps

A content area to display primary and secondary number values with optional trend indicators.

Version: Cloud and 3.185 Edge

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

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.

align

The horizontal alignment of the contents.

Type	string
Format	Plain Text
Mutability	Control Usage Retool UI Inspector
Allowed Values	Value Description left Left alignment. center Center alignment. right Right alignment.
Default	left

Examples

"center"

---

clickable

Whether there is an enabled Click event handler.

Type	boolean
Format	True/False
Mutability	Control Usage Retool UI Inspector > Interaction > Event handlers
Default	false

Examples

true

---

currency

A three-letter ISO currency code to use if format is currency.

Type	string
Mutability	Control Usage Retool UI Inspector

---

decimalPlaces

The number of decimal places to display. If necessary, values round up or down automatically.

Type	number
Format	Integer
Mutability	Control Usage Retool UI Inspector > Content > Decimal places

---

enableTrend

Whether to render the value using positive or negative color styles based on whether the secondary value is positive or negative.

Type	boolean
Mutability	Control Usage Retool UI Inspector

---

formattingStyle

The formatting style to use.

Type	string
Mutability	Control Usage Retool UI Inspector
Allowed Values	Value Description decimal Decimal. percent Percent. currency Currency.

---

hidden

Whether this object is hidden from view.

Type	boolean
Format	True/False
Mutability	Control Usage Retool UI Inspector > Appearance > Hidden Method setHidden()
Default	false

Examples

true

---

icon

the icon to display.

Type	string
Format	Icon Key
Mutability	Control Usage Retool UI Inspector > Content > Add-ons > Icon
Default	null

Examples

/icon:bold/shopping-gift

---

id

The unique identifier (name).

Type	string
Format	Plain Text
Mutability	Control Usage Retool UI Inspector
Default	statistic1

Examples

query1

button1

---

isHiddenOnDesktop

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

Type	boolean
Format	True/False
Mutability	Control Usage Retool UI 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
Mutability	Control Usage Retool UI Inspector > Appearance > Advanced > Show on mobile
Default	true

Examples

true

---

label

The text label to display.

Type	string
Format	Plain Text
Mutability	Control Usage Retool UI Inspector > Content > Add-ons > Label > Label
Default	null

Examples

"Label"

---

labelCaption

The additional text to display with the label.

Type	string
Format	Plain Text
Mutability	Control Usage Retool UI Inspector > Content > Add-ons > Label > Caption

---

maintainSpaceWhenHidden

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

Type	boolean
Format	True/False
Mutability	Control Usage Retool UI Inspector > Appearance > Advanced > Maintain space when hidden
Default	false

Examples

true

---

margin

The amount of margin to render outside.

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

Examples

4px 8px

---

padDecimal

Whether to include trailing zeros to match the specified value for decimalPlaces.

Type	boolean
Mutability	Control Usage Retool UI Inspector

---

positiveTrend

Whether to display a positive trend for the secondary value.

Type	boolean
Mutability	Read-only

---

prefix

The prefix text to display.

Type	string
Format	Plain Text
Mutability	Control Usage Retool UI Inspector > Content > Add-ons > Prefix text
Default	null

Examples

$

Email address

SKU

---

secondaryCurrency

The three-letter ISO currency code to use if format is currency.

Type	string
Mutability	Control Usage Retool UI Inspector

---

secondaryDecimalPlaces

The number of decimal places to display for the secondary value.

Type	number
Mutability	Control Usage Retool UI Inspector

---

secondaryEnableTrend

Whether to display the trend color for the secondary value.

Type	boolean
Mutability	Control Usage Retool UI Inspector

---

secondaryFormattingStyle

The formatting style for the secondary value.

Type	string
Mutability	Control Usage Retool UI Inspector
Allowed Values	Value Description currency Currency. standard Number. percent Percentage.

---

secondaryPadDecimal

Whether to pad the secondary value with zeros.

Type	boolean
Mutability	Control Usage Retool UI Inspector

---

secondaryPositiveTrend

Whether to display a positive trend for the secondary value.

Type	boolean
Mutability	Read-only

---

secondaryPrefix

The prefix for the secondary value.

Type	string
Mutability	Control Usage Retool UI Inspector

---

secondaryShowSeparators

Whether to show separators for the secondary value.

Type	boolean
Mutability	Control Usage Retool UI Inspector

---

secondarySignDisplay

The sign display.

Type	string
Mutability	Control Usage Retool UI Inspector
Allowed Values	Value Description trendArrows Trend arrows. exceptZero Positive and negative symbols. auto Negative trend signs only.

---

secondarySuffix

The suffix text to display.

Type	string
Format	Plain Text
Mutability	Control Usage Retool UI Inspector > Content > Add-ons > Suffix text
Default	null

Examples

USD

px

@example.com

---

secondaryValue

The value.

Type	string | number | boolean | object | array
Mutability	Read-only

---

showInEditor

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

Type	boolean
Format	True/False
Mutability	Control Usage Retool UI Inspector > Appearance > Advanced > Always show in edit mode
Default	false

Examples

true

---

showSeparators

Whether the formatted value includes a localized thousands separator.

Type	boolean
Mutability	Control Usage Retool UI Inspector > Appearance > Show thousands separator

---

signDisplay

The sign display.

Type	string
Mutability	Control Usage Retool UI Inspector
Allowed Values	Value Description trendArrows Trend arrows. exceptZero Positive and negative symbols. auto Negative trend signs only.

---

style

Custom style options.

Type	object
Mutability	Control Usage Retool UI Inspector > Appearance > style

---

suffix

The suffix text to display.

Type	string
Format	Plain Text
Mutability	Control Usage Retool UI Inspector > Content > Add-ons > Suffix text
Default	null

Examples

USD

px

@example.com

---

value

The current value.

Type	number
Mutability	Read-only

---

Methods

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

statistic.clearValue()

Clear the current values.

Definition

statistic.clearValue()

Examples

Clear the current value of statistic.

statistic.clearValue();

---

statistic.resetValue()

Reset the current value to the default value.

Definition

statistic.resetValue()

Examples

Reset the current value of statistic.

statistic.resetValue();

---

statistic.scrollIntoView()

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

Definition

statistic.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 statistic into view.

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

---

statistic.setHidden()

Set the hidden value to toggle whether the component is visible. Defaults to true without a parameter.

Definition

statistic.setHidden(hidden)

Parameters

hidden

Whether this object is hidden from view.

Type	boolean
Format	True/False
Default	false

Examples

true

---

Examples

Hide statistic.

statistic.setHidden(true);

Unhide statistic.

statistic.setHidden(false);

---

statistic.setValue()

Set the current value.

Definition

statistic.setValue(value)

Parameters

value

The value.

Type	string | number | boolean | object | array

---

Examples

Set the current value of statistic to userValue.

statistic.setValue(userValue);

---

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
Click	An item is clicked or pressed.