Skip to main content

onListVariables

Last updated 23/07/2026

Definition​

onListVariables
is a host callback invoked by
DimensionIQWidget
 when the widget needs to retrieve the list of variables contained within a specific variable folder.

The host application is responsible for retrieving all stored

DIQ_Variable
for that folder.

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 regarding the available variables within a folder.

Function Signature​

TypeScript
Function Signature
onListVariables: (
    folder: DIQ_VariableFolder,
    onResponse: (
        result: DIQ_Result,
        variables: Array<DIQ_Variable> | null
    ) => void
) => void;

Callback Parameters​

folder
Type: DIQ_VariableFolder
Description: The

DIQ_VariableFolder
object for which the widget is requesting the list of variables.

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

DIQ_Variable
objects. If no variables exist, return an empty array.

Examples​

onListVariables