The Statistic component for Retool Apps
A content area to display primary and secondary number values with optional trend indicators.
For more information about this component, refer to the Informational components guide.
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 | ||||||||
Configurability | Inspector | ||||||||
Allowed Values |
| ||||||||
Default | left |
Examples
"center"
clickable
Whether there is an enabled Click event handler.
Type | boolean |
Format | True/False |
Configurability | Inspector > Interaction > Event handlers |
Default | false |
Examples
true
currency
A three-letter ISO currency code to use if format
is currency
.
Type | string |
Configurability | Inspector |
Default | null |
decimalPlaces
The number of decimal places to display. If necessary, values round up or down automatically.
Type | number |
Format | Integer |
Configurability | Inspector > Content > Decimal places |
Default | null |
enableTrend
Whether to render the value using positive
or negative
color styles based on whether the secondary value is positive or negative.
Type | boolean |
Configurability | Inspector |
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 |
| ||||||||||||||
Default | null |
formattingStyle
The formatting style to use.
Type | string | ||||||||
Configurability | Inspector | ||||||||
Allowed Values |
| ||||||||
Default | null |
hidden
Whether this object is hidden from view.
Type | boolean |
Format | True/False |
Configurability | Inspector > Appearance > Hidden |
Default | false |
Examples
true
icon
the icon to display.
Type | string |
Format | Icon Key |
Configurability | Inspector > Content > Add-ons > Icon |
Default | null |
Examples
/icon:bold/shopping-gift
id
The unique identifier (name).
Type | string |
Format | Plain Text |
Configurability | Inspector |
Default | statistic1 |
Examples
query1
button1
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
label
The text label to display.
Type | string |
Format | Plain Text |
Configurability | Inspector > Content > Add-ons > Label > Label |
Default | null |
Examples
"Label"
labelCaption
The additional text to display with the label.
Type | string |
Format | Plain Text |
Configurability | Inspector > Content > Add-ons > Label > Caption |
Default | null |
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 |
| |||||||||
Default | 4px 8px |
Examples
4px 8px
padDecimal
Whether to include trailing zeros to match the specified value for decimalPlaces
.
Type | boolean |
Configurability | Inspector |
Default | null |
positiveTrend
Whether to display a positive trend for the secondary value.
Type | boolean |
Configurability | Read-only |
Default | null |
prefix
The prefix text to display.
Type | string |
Format | Plain Text |
Configurability | 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 |
Configurability | Inspector |
Default | null |
secondaryDecimalPlaces
The number of decimal places to display for the secondary value.
Type | number |
Configurability | Inspector |
Default | null |
secondaryEnableTrend
Whether to display the trend color for the secondary value.
Type | boolean |
Configurability | Inspector |
Default | null |
secondaryFormattingStyle
The formatting style for the secondary value.
Type | string | ||||||||
Configurability | Inspector | ||||||||
Allowed Values |
| ||||||||
Default | null |
secondaryPadDecimal
Whether to pad the secondary value with zeros.
Type | boolean |
Configurability | Inspector |
Default | null |
secondaryPositiveTrend
Whether to display a positive trend for the secondary value.
Type | boolean |
Configurability | Read-only |
Default | null |
secondaryShowSeparators
Whether to show separators for the secondary value.
Type | boolean |
Configurability | Inspector |
Default | null |
secondarySignDisplay
The sign display.
Type | string | ||||||||
Configurability | Inspector | ||||||||
Allowed Values |
| ||||||||
Default | null |
secondarySuffix
The suffix text to display.
Type | string |
Format | Plain Text |
Configurability | Inspector > Content > Add-ons > Suffix text |
Default | null |
Examples
USD
px
@example.com
secondaryValue
The value.
Type | string | number | boolean | object | array |
Configurability | Read-only |
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
showSeparators
Whether the formatted value includes a localized thousands separator.
Type | boolean |
Configurability | Inspector > Appearance > Show thousands separator |
Default | null |
signDisplay
The sign display.
Type | string | ||||||||
Configurability | Inspector | ||||||||
Allowed Values |
| ||||||||
Default | null |
suffix
The suffix text to display.
Type | string |
Format | Plain Text |
Configurability | Inspector > Content > Add-ons > Suffix text |
Default | null |
Examples
USD
px
@example.com
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()
Examples
Clear the current value of statistic
.
statistic.clearValue();
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.
statistic.scrollIntoView(options)
Parameters
Object Properties
behavior
The scroll behavior.
Type | string | ||||||
Allowed Values |
|
block
The scroll position relative to the component.
Type | string | ||||||||||
Allowed Values |
|
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.
statistic.setHidden(hidden)
Parameters
Examples
true
Examples
Hide statistic
.
statistic.setHidden(true);
Unhide statistic
.
statistic.setHidden(false);
statistic.setValue(key, value)
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. |