Class
This message is used when a widget needs to announce its changes on data source filter to other widgets. This message carries the data source ids that the filter has changed. Other widgets within an experience may subscribe to this message and implement an update workflow when the message is received. For example: Map widget is triggered by Filter widget to zoomTo current features.
Implements
Properties
| Property | Type | Notes |
|---|---|---|
backgroundTrigger | boolean | Indicates whether this message is triggered in background mode. |
clearFilterDataSourceIds | string[] | When a widget clears all filters for a ds, 'filter-data-record-action' and 'select-data-record-action' need to reset the corresponding filters/selections. Therefore, this property is used to notify which dataSource filters were cleared by the widget. |
dataSourceId | string | The data source id that emitted this message. |
dataSourceIds | string[] | The id of the data source. |
type | MessageType | The message type. |
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. |
backgroundTrigger
Class PropertybackgroundTrigger: booleanIndicates whether this message is triggered in background mode.
clearFilterDataSourceIds
Class PropertyclearFilterDataSourceIds: string[]When a widget clears all filters for a ds, 'filter-data-record-action' and 'select-data-record-action' need to reset the corresponding filters/selections. Therefore, this property is used to notify which dataSource filters were cleared by the widget.
type
Class Propertytype: MessageType = MessageType.DataSourceFilterChangeThe message type.