ExtentChangeMessage

Class

The ExtentChangeMessage uses the widgetId and the MessageType and the provides the Extentwhen 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 Constructor
new ExtentChangeMessage(widgetIdstring, extentExtent): ExtentChangeMessage
Parameters
ParameterType
widgetId
string
extent
Extent
Returns 
ExtentChangeMessage

Properties

PropertyTypeNotes
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.

extent

Class Property
extent: Extent

The extent, which is the main content of the extent change message.

type

Class Property
type: MessageType = MessageType.ExtentChange

The message type.

widgetId

Class Property
widgetId: 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.

Your browser is no longer supported. Please upgrade your browser for the best experience. See our browser deprecation post for more details.