Class
This message is used when needing to implement a workflow upon the creation, update or removal of a record set.
This message carries the changed DataRecordSet information.
Other widgets may need to subscribe to this message whenever a workflow involves reliance on a change to record set(s).
Implements
Constructors
constructor
Class ConstructorDataRecordSetChangeMessage(widgetId: string, changeType: RecordSetChangeType, data: string[] | DataRecordSet[]): DataRecordSetChangeMessageWhen removing data record sets, please pass in dataRecordSetNames; when adding or updating data record sets, please pass in dataRecordSets
Parameters
| Parameter | Type |
|---|---|
widget | string |
change | RecordSetChangeType |
data | string[] | DataRecordSet[] |
Returns
DataRecordSetChangeMessageProperties
| Property | Type | Notes |
|---|---|---|
The record set change type. | ||
string[] | The name of the record sets. When removing some data record sets, only names are required. | |
The data record sets that are created or updated. | ||
Extent | () => Promise<Extent> | The extent of the created records. | |
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. |
changeType
Class PropertychangeType: RecordSetChangeTypeThe record set change type.
dataRecordSetNames
dataRecordSetNames: string[]The name of the record sets. When removing some data record sets, only names are required.
dataRecordSets
dataRecordSets: DataRecordSet[]The data record sets that are created or updated.
extent
extent: Extent | () => Promise<Extent>The extent of the created records.
type
Class Propertytype: MessageType = MessageType.DataRecordSetChangeThe message type.