The events that are handled by the behavior.
The source data object for this DataModel instance. Once constructed, the source object is sealed such that no keys may be added nor removed.
An immutable reverse-reference to a parent DataModel to which this model belongs.
Static LOCALIZATION_Static eventsA RegionBehaviorType may register to always receive certain events by providing a record of handler functions. These handlers are called with the behavior instance as its bound scope.
A convenience reference to the RegionBehavior which contains this behavior sub-type.
A convenience reference to the RegionDocument which contains this behavior sub-type.
A convenience reference to the Scene which contains this behavior sub-type.
Define the data schema for this document instance.
Is the current state of this DataModel invalid? The model is invalid if there is any unresolved failure.
An array of validation failure instances which may have occurred when this instance was last validated.
Static schemaConvert this Document to some HTML display for embedding purposes.
Configuration for embedding behavior.
Optional options: EnrichmentOptions = {}The original enrichment options for cases where the Document embed content also contains text that must be enriched.
Internal Called by ClientDocument#_preCreate.
The initial data object provided to the document creation request
Additional options which modify the creation request
The User requesting the document creation
Return false to exclude this Document from the creation operation
Clone a model, creating a new data model by combining current data with provided overrides.
Optional data: Object = {}Additional data which overrides current document data at the time of creation
Optional context: object = {}Context options passed to the data model constructor
The cloned Document instance
Validate the data contained in the document to check for type and content This function throws an error if data within the document is not valid
Optional parameters which customize how validation occurs.
A specific set of proposed changes to validate, rather than the full source data of the model.
If changes are provided, attempt to clean the changes before validating them?
Allow replacement of invalid values with valid defaults?
If true, invalid embedded documents will emit a warning and be placed in the invalidDocuments collection rather than causing the parent to be considered invalid.
Throw if an invalid value is encountered, otherwise log a warning?
Perform validation on individual fields?
Perform joint validation on the full data model? Joint validation will be performed by default if no changes are passed. Joint validation will be disabled by default if changes are passed. Joint validation can be performed on a complete set of changes (for example testing a complete data model) by explicitly passing true.
An indicator for whether the document contains valid data
Update the DataModel locally by applying an object of changes to its source data. The provided changes are cleaned, validated, and stored to the source data object for this model. The source data is then re-initialized to apply those changes to the prepared data. The method returns an object of differential changes which modified the original data.
New values which should be applied to the data model
Optional options: object = {}Options which determine how the new data is merged
An object containing the changed keys and values
Copy and transform the DataModel into a plain object. Draw the values of the extracted object from the data source (by default) otherwise from its transformed values.
Optional source: boolean = trueDraw values from the underlying data source rather than transformed values
The extracted primitive object
Protected _onProtected Internal Called by ClientDocument#_onCreate.
The initial data object provided to the document creation request
Additional options which modify the creation request
The id of the User requesting the document update
Protected _preProtected Internal Called by ClientDocument#_preUpdate.
The candidate changes to the Document
Additional options which modify the update request
The User requesting the document update
A return value of false indicates the update operation should be cancelled.
Protected _onProtected Internal Called by ClientDocument#_onUpdate.
The differential data that was changed relative to the documents prior values
Additional options which modify the update request
The id of the User requesting the document update
Protected _preProtected Internal Called by ClientDocument#_preDelete.
Additional options which modify the deletion request
The User requesting the document deletion
A return value of false indicates the deletion operation should be cancelled.
Protected _onProtected _configureProtected _initializeProtected Initialize the source data for a new DataModel instance. One-time migrations and initial cleaning operations are applied to the source data.
The candidate source data from which the model will be constructed
Optional options: object = {}Options provided to the model constructor
Migrated and cleaned source data which will be stored to the model instance
Protected _initializeProtected Initialize the instance by copying data from the source object to instance attributes. This mirrors the workflow of SchemaField#initialize but with some added functionality.
Optional options: object = {}Options provided to the model constructor
Static defineStatic cleanStatic validateEvaluate joint validation rules which apply validation conditions across multiple fields of the model. Field-specific validation rules should be defined as part of the DataSchema for the model. This method allows for testing aggregate rules which impose requirements on the overall model.
Candidate data for the model
An error if a validation failure is detected
Static fromCreate a new instance of this DataModel from a source record. The source is presumed to be trustworthy and is not strictly validated.
Initial document data which comes from a trusted source.
Optional context: any = {}Model construction context
Static fromJSONStatic migrateStatic migrateStatic shimTake data which conforms to the current data schema and add backwards-compatible accessors to it in order to support older code which uses this data.
Data which matches the current schema
Optional options: { Additional shimming options
Apply shims to embedded models?
Data with added backwards-compatible properties
Static Protected _createProtected Create the events field.
Options which configure how the events field is declared
The event names to restrict to.
The initial set of events that should be default for the field
Static Protected _initialization
The data model for a behavior that executes a script.