Skip to main content

onListDimensionCustomValuesForLayout

Last updated 29/07/2026

Definition​

onListDimensionCustomValuesForLayout
is a host callback invoked by
DimensionIQWidget
 when the widget requires the list of custom values associated with all dimensions within a layout.

The host application is responsible for retrieving the requested

DIQ_DimensionCustomValue
records for the specified layout.

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 associated with a layout.

Function Signature​

TypeScript
Function Signature
onListDimensionCustomValuesForLayout: (
    layoutKey: string,
    onResponse: (
        result: DIQ_Result,
        dimensionCustomValues: Array<DIQ_DimensionCustomValue> | null
    ) => void
) => void;

Callback Parameters​

layoutKey
Type: string
Description: The unique key identifying the layout for which

DIQ_DimensionCustomValue
objects 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​

OnListDimensionCustomValuesForLayout