The Statistic web component

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

Demo

Settings

Statistic includes the following configurable options when building apps in the IDE.

AlignCurrency codeDecimal placesShow weekendsEvent handlersFormatHiddenIconShow on desktopShow on mobileLabelLabelsMaintain space when hiddenMarginPad decimal placesPrefix textCurrency codeDecimal placesEnable trend colorSecondary formatting stylePad decimal placesPrefixShow separatorsAlways show in edit modeShow thousands separatorSign displayStylesSuffix textHelper textValue

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.

align

enum

The horizontal alignment of the contents.

Values

left	Left alignment.
center	Center alignment.
right	Right alignment.

---

clickable

boolean

Whether there is an enabled Click event handler.

---

currency

string

The three-letter ISO currency code to use.

---

decimalPlaces

number

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

---

enableTrend

boolean

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

---

events

object[]

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

Properties

event

enum

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 true.
false	A user sets the value to false.
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

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

---

---

formattingStyle

enum

The formatting style to use.

Values

decimal	Decimal.
percent	Percent.
currency	Currency.

---

global

boolean

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

---

hidden

boolean

Whether the component is visible.

---

icon

enum

The icon to display.

Values

You can select an icon or dynamically set one with a valid icon key.

Demo

---

id

string

The unique identifier.

---

isHiddenOnDesktop

boolean

Whether the component is visible in the desktop layout.

---

isHiddenOnMobile

boolean

Whether the component is visible in the mobile layout.

---

label

string

The text label to display.

---

labelCaption

string[]

The label for the node.

---

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.

---

padDecimal

boolean

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

---

pluginType

string

The plugin type.

---

positiveTrend

---

prefix

string

The prefix text to display.

---

secondaryCurrency

string

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

---

secondaryDecimalPlaces

number

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

---

secondaryEnableTrend

boolean

Whether to display the trend color for the secondary value.

---

secondaryFormattingStyle

enum

The formatting style for the secondary value.

Values

currency	Currency.
standard	Number.
percent	Percentage.

---

secondaryPadDecimal

boolean

Whether to pad the secondary value with zeros.

---

secondaryPositiveTrend

boolean

Whether to display a positive trend.

---

secondaryPrefix

string

The prefix for the secondary value.

---

secondaryShowSeparators

boolean

Whether to show separators for the secondary value.

---

secondarySignDisplay

enum

The sign display.

Values

trendArrows	Trend arrows.
exceptZero	Positive and negative symbols.
auto	Negative trend signs only.

---

secondarySuffix

string

The suffix text to display.

---

secondaryValue

number

The value.

---

showInEditor

boolean

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

---

showSeparators

boolean

Whether the formatted value includes a localized thousands separator.

---

signDisplay

enum

The sign display.

Values

trendArrows	Trend arrows.
exceptZero	Positive and negative symbols.
auto	Negative trend signs only.

---

style

object

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

---

suffix

string

The suffix text to display.

---

tooltipText

string

The tooltip text to display.

---

value

number

The value.

---

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

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.

---

---

---

setHidden

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

statistic.setHidden(hidden)

Parameters

hidden

boolean

Whether the component is visible.

---

---

setValue

Set the current value.

statistic.setValue(value)

Parameters

value

number

The value.

---

---

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.

---