A2uiFormatNumberFunction


class A2uiFormatNumberFunction : A2uiFunction


Formats a number with grouping and decimal precision.

Use this A2uiFunction to format numeric values for display.

Summary

Public companion properties

A2uiFormatNumberFunction

Public constructors

Public functions

open Any?
execute(args: Map<StringAny>, executionContext: A2uiExecutionContext)

Formats the given number using precision options in args.

Public properties

open A2uiFunctionDefinition

The definition of the function.

Public companion properties

Public constructors

A2uiFormatNumberFunction

Added in 1.0.0-alpha01
A2uiFormatNumberFunction(
    localeProvider: A2uiLocaleProvider = A2uiLocaleProvider.Default
)

Public functions

execute

open fun execute(args: Map<StringAny>, executionContext: A2uiExecutionContext): Any?

Formats the given number using precision options in args.

Parameters
args: Map<StringAny>

arguments containing "value" (number) and optional decimal or grouping flags

executionContext: A2uiExecutionContext

context allowing to execute other functions, evaluate dynamic payloads and resolving data bindings

Returns
Any?

the formatted number string, or null if required values are missing

Public properties

definition

open val definitionA2uiFunctionDefinition

The definition of the function.