Skip to main content

onListDimensionGroupFolders

Last updated 5/03/2026

Definition​

onListDimensionGroupFolders
is a host callback invoked by
DimensionIQWidget
 when it requires the host application to provide all dimension group folders belonging to a specific project.

The host application is responsible for using the provided

projectKey
to locate all stored
DIQ_DimensionGroupFolder
 records for that project.

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 project's folder hierarchy.

Function Signature​

TypeScript
Function Signature
onListDimensionGroupFolders: (
    projectKey: string,
    onResponse: (result: DIQ_Result, groupFolders: DIQ_DimensionGroupFolder[]) => void
) => void;

Callback Parameters​

projectKey
Type: string
Description: The unique identifier of the project whose dimension group folders are being requested.

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

DIQ_DimensionGroupFolder
objects.

Examples​

onListDimensionGroupFolders