The Statistic web component
A content area to display primary and secondary number values with optional trend indicators.
Settings
Statistic includes the following configurable options when building apps in the IDE.
Properties
All properties for Statistic with supported data types or values. You can write JavaScript almost anywhere in Retool to manipulate or read property values.
Values
left | Left alignment. |
center | Center alignment. |
right | Right alignment. |
clickable
Whether there is an enabled Click event handler.
decimalPlaces
The number of decimal places to display. If necessary, values round up or down automatically.
enableTrend
Whether to render the value using positive
or negative
color styles based on whether the secondary value is positive or negative.
Properties
event
The event type.
Values
change | A user changes the value. |
click | A user clicks or taps the component. |
submit | A user submits the value. |
focus | A user selects the input field. |
blur | A user deselects the input field. |
scan | A user scans a barcode. |
open | A user opens the component. |
close | A user closes the component. |
true | A user sets the value to |
false | A user sets the value to |
select | A user selects a value. |
clear | A user clears the value. |
upload | A user uploads a file. |
parse | An uploaded file is parsed. |
inputValueChange | A user changes the value of the input field. |
method
The JavaScript method to perform when type
is datasource
, widget
, state
, or localStorage
.
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). |
formattingStyle
The formatting style to use.
Values
decimal | Decimal. |
percent | Percent. |
currency | Currency. |
global
Whether the object is globally scoped for use in all app pages.
Values
You can select an icon or dynamically set one with a valid icon key.
id
The unique identifier.
isHiddenOnDesktop
Whether the component is visible in the desktop layout.
isHiddenOnMobile
Whether the component is visible in the mobile layout.
labelCaption
The label for the node.
maintainSpaceWhenHidden
Whether the component takes up space on the canvas if hidden
is true
.
padDecimal
Whether to include trailing zeros to match the specified value for decimalPlaces
.
pluginType
The plugin type.
positiveTrend
secondaryCurrency
The three-letter ISO currency code to use if format
is currency
.
secondaryDecimalPlaces
The number of decimal places to display for the secondary value.
secondaryEnableTrend
Whether to display the trend color for the secondary value.
The formatting style for the secondary value.
Values
currency | Currency. |
standard | Number. |
percent | Percentage. |
secondaryPadDecimal
Whether to pad the secondary value with zeros.
secondaryPositiveTrend
Whether to display a positive trend.
secondaryPrefix
The prefix for the secondary value.
secondaryShowSeparators
Whether to show separators for the secondary value.
The sign display.
Values
trendArrows | Trend arrows. |
exceptZero | Positive and negative symbols. |
auto | Negative trend signs only. |
secondarySuffix
The suffix text to display.
secondaryValue
The value.
showInEditor
Whether to remain visible in the editor if hidden
is true
.
showSeparators
Whether the formatted value includes a localized thousands separator.
signDisplay
The sign display.
Values
trendArrows | Trend arrows. |
exceptZero | Positive and negative symbols. |
auto | Negative trend signs only. |
tooltipText
The tooltip text to display.
Methods
JavaScript API methods for interacting with Statistic. You can write JavaScript almost anywhere in Retool and use methods to manipulate data and property values.
clearValue
Clear the current values.
statistic.clearValue()
resetValue
Reset the current value to the default value.
statistic.resetValue()
scrollIntoView
Scrolls the canvas or parent container so that the selected component appears in the visible area.
statistic.scrollIntoView(scrollIntoViewOptions)
Parameters
scrollIntoViewOptions
The scroll options.
Properties
behavior
The scroll behavior.
Values
auto | Scroll immediately to the specified position. |
smooth | Scroll gradually to the specified position. |
block
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. |
setHidden
Set the hidden
value to toggle whether the component is visible. Defaults to true
without a parameter.
statistic.setHidden(hidden)
Parameters
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.
click
The item is clicked or pressed.