Skip to main content

onListDimensionCustomValues

Last updated 28/07/2026

Definition​

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

The host application is responsible for retrieving the requested

DIQ_DimensionCustomValue
records for the the requested dimension.

Once processing is complete, please refer to the

onResponse
contract in the Widget Callback Introduction.

This callback ensures the widget and host application remain synchronized regarding the custom values assigned to a dimension.

Function Signature​

TypeScript
Function Signature
onListDimensionCustomValues: (
    dimension: DIQ_Dimension,
    onResponse: (
        result: DIQ_Result,
        dimensionCustomValues: Array<DIQ_DimensionCustomValue> | null
    ) => void
) => void;

Callback Parameters​

dimension
Type: DIQ_Dimension
Description: The

DIQ_Dimension
object for which custom values are being requested.

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

DIQ_DimensionCustomValue
objects.

Examples​

onListDimensionCustomValues