Class

This message is used when implementing a workflow on a change of selected records. This message carries the selected records. Other widgets within an experience may subscribe to this message and implement an update workflow when the message is received.

Implements

Properties

PropertyTypeNotes
backgroundTriggerboolean

Indicates whether this message is triggered in background mode.

dataSourceIdstring

The data source id that emitted this message.

dataSourceIdsstring[]

The data sources the message carries.

extentGraphic | Extent | (jimuMapViewJimuMapView) => Promise<Graphic | Extent>

The extent of the selected records.

recordsDataRecord[]

The selected records. To cancel selection, use an empty array.

typeMessageType

The message type.

widgetIdstring

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 Property
backgroundTrigger: boolean

Indicates whether this message is triggered in background mode.

dataSourceId

optional
Class Property
dataSourceId: string

The data source id that emitted this message.

dataSourceIds

Class Property
dataSourceIds: string[]

The data sources the message carries.

extent

optional
Class Property
extent: Graphic | Extent | (jimuMapViewJimuMapView) => Promise<Graphic | Extent>

The extent of the selected records.

records

Class Property
records: DataRecord[]

The selected records. To cancel selection, use an empty array.

type

Class Property
type: MessageType = MessageType.DataRecordsSelectionChange

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.