ExtentChangeMessage
Class
The ExtentChangeMessage
uses the widgetId
and the MessageType
and the provides
the Extent
when the MessageType
is 'EXTENT_CHANGE'. This message is used when needing to implement a workflow
upon a change of extent. Other widgets within an experience may subscribe to this message and implement
an update workflow when the message is received.
Implements
Constructors
constructor
Class Constructornew ExtentChangeMessage(widgetId: string, extent: Extent): ExtentChangeMessage
Parameters
Parameter | Type |
---|---|
widget | string |
extent | Extent |
Returns
ExtentChangeMessage
Properties
Property | Type | Notes |
---|---|---|
Extent | The extent, which is the main content of the extent change message. | |
The message type. | ||
string | The widget id from which the message is sourced. If a widget id is not provided, the message is provided by the Jimu framework. |
type
Class Propertytype: MessageType = MessageType.ExtentChange
The message type.
extent: Extent
The extent, which is the main content of the extent change message.