Skip to main content

onListDimensionCustomValuesForLayout

Last updated 29/07/2026

Layout dimension custom value listing handler​

This example demonstrates how the

onListDimensionCustomValuesForLayout
callback retrieves all dimension custom values associated with a layout from the host application's persistent storage. Once the custom values have been retrieved, they are returned to the widget through the

onResponse
callback.
TypeScript
Layout dimension custom value listing handler
onListDimensionCustomValuesForLayout: (layoutKey: string, onResponse: (result: DIQ_Result, dimensionCustomValues: Array<DIQ_DimensionCustomValue> | null) => void) => {

    // Retrieve all custom values for the layout
    const dimensionCustomValues = database.getDimensionCustomValuesForLayout(layoutKey);

    // Return the custom values to the widget
    onResponse(
        { success: true },
        dimensionCustomValues
    );

},