Skip to main content

onListConstants

Last updated 23/07/2026

Definition​

onListConstants
is a host callback invoked by
DimensionIQWidget
 when the widget requires the complete list of constants contained within a constant folder and the host application must retrieve them from persistent storage.

Once processing is complete, please refer to the

onResponse
contract in the Widget Callback Introduction.

This callback ensures the widget and the host application remain synchronized by providing the current collection of constants for the requested constant folder.

Function Signature​

TypeScript
Function Signature
onListConstants: (
    folder: DIQ_ConstantFolder,
    onResponse: (
        result: DIQ_Result,
        constants: Array<DIQ_Constant> | null
    ) => void
) => void;

Callback Parameters​

folder
Type: DIQ_ConstantFolder
Description: The

DIQ_ConstantFolder
object whose constants should be retrieved.

onResponse
Type: (result: DIQ_Result, constants: Array<DIQ_Constant> | null) => void
Description: Callback function that must be called by the host to complete the operation, and return an array of

DIQ_Constant
objects. If no constants exist within the folder, return an empty array.

Examples​

onListConstants