Skip to main content

onListDrawingLayouts

Last updated 5/03/2026

Definition​

onListDrawingLayouts
is a host callback invoked by
DimensionIQWidget
 when it requires the host application to provide all layouts associated with a specific drawing revision.

The host application is responsible for retrieving all stored

DIQ_Layout
records for the requested drawing revision.

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 by providing the correct set of layouts associated with a drawing revision.

Function Signature​

TypeScript
Function Signature
onListDrawingLayouts: (
    drawing: DIQ_DrawingRevision,
    onResponse: (result: DIQ_Result, layouts: Array<DIQ_Layout>) => void
) => void;

Callback Parameters​

drawing
Type: DIQ_DrawingRevision
Description: The

DIQ_DrawingRevision
object for which layouts 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_Layout
objects.

Examples​

onListDrawingLayouts