Skip to main content

onListDimensions

Last updated 5/03/2026

Definition​

onListDimensions
is a host callback invoked by
DimensionIQWidget
 when it requires the host application to provide the list of dimensions associated with a specific dimension group revision.

The host application is responsible for retrieving all the stored

DIQ_Dimension
records for that revision.

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 stored dimension data.

Function Signature​

TypeScript
Function Signature
onListDimensions: (
    group: DIQ_DimensionGroupRevision,
    onResponse: (result: DIQ_Result, dimensions: DIQ_Dimension[]) => void
) => void;

Callback Parameters​

group
Type: DIQ_DimensionGroupRevision
Description: The

DIQ_DimensionGroupRevision
object for which dimensions are being requested.

onResponse
Type: (result: DIQ_Result, dimensions: DIQ_Dimension[]) => void
Description: Callback function that must be called by the host to complete the operation, and return an array of

DIQ_Dimension
objects.

Examples​

onListDimensions