Skip to main content

onLayoutUpdate

Last updated 5/03/2026

Definition

is a host callback invoked by
DimensionIQWidget
when a user modifies an existing layout in the widget component and the host application is responsible for persisting those updates.

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 layout's updated state.

Function Signature

TypeScript
Function Signature
onLayoutUpdate: (
layout: DIQ_Layout,
onResponse: (result: DIQ_Result) => void
) => void;

Callback Parameters

layout
Type: DIQ_Layout
Description: The updated

object from the widget.

onResponse
Type: (result: DIQ_Result) => void
Description: Callback function that must be called by the host to complete the operation.

Examples

onLayoutUpdate