Skip to main content

onProjectGet

Last updated 23/07/2026

Definition​

onProjectGet
is a host callback invoked by
DimensionIQWidget
 when the widget needs to retrieve a project using its

projectKey
.

The host application is responsible for locating the requested

DIQ_Project
and returning the project.

Once processing is complete, please refer to the

onResponse
contract in the Widget Callback Introduction.

This callback ensures the widget and the host application remain synchronized regarding project data.

Function Signature​

TypeScript
Function Signature
onProjectGet: (
    projectKey: string,
    onResponse: (
        result: DIQ_Result,
        project: DIQ_Project | null
    ) => void
) => void;

Callback Parameters​

projectKey
Type: string
Description: The unique key identifying the project to retrieve.

onResponse
Type: (result: DIQ_Result, project: DIQ_Project | null) => void
Description: Callback function that must be called by the host to complete the operation and return the requested

DIQ_Project
.

Examples​

onProjectGet