Skip to main content

onListCustomValues

Last updated 27/07/2026

Definition​

onListCustomValues
is a host callback invoked by
DimensionIQWidget
 when the widget requires the list of custom values associated with a dimension group.

Once processing is complete, please refer to the

onResponse
contract in the Widget Callback Introduction.

This callback enables the widget to retrieve and display the custom values maintained by the host application.

Function Signature​

TypeScript
Function Signature
onListCustomValues: (
    group: DIQ_DimensionGroupRevision,
    onResponse: (
        result: DIQ_Result,
        customValues: Array<DIQ_CustomValue> | null
    ) => void
) => void;

Callback Parameters​

group
Type: DIQ_DimensionGroupRevision
Description: The

DIQ_DimensionGroupRevision
object for which the widget is requesting custom values.

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

DIQ_CustomValue
objects, or null if no custom values are available.

Examples​

onListCustomValues