The type of Document which belongs to this embedded collection
Optionaloptions: DataFieldOptions = {}Options which configure the behavior of the field
Optionalcontext: DataFieldContext = {}Additional context which describes the field
The data type of each element in this array
InternalnameThe field name of this DataField instance. This is assigned by SchemaField#initialize.
The initially provided options which configure the data field
InternalparentA reference to the parent schema to which this DataField belongs. This is assigned by SchemaField#initialize.
StatichierarchicalStaticrecursiveA dot-separated string representation of the field path within the parent schema.
A reference to the DataModel subclass of the embedded document element
The DataSchema of the contained Document model.
Static_defaultsDefault parameters for this field type
StatichasDoes this form field class have defined form support?
StaticimplementationInternalAdd types of the source to the data if they are missing.
The source data
The partial data
Optionaloptions: { changes?: object; source?: object }Additional options
Optionalchanges?: objectThe root data model changes
Optionalsource?: objectThe root data model source
Dry-run an update of an EmbeddedCollection, modifying the contents of the safe copy of the source data.
Apply an ActiveEffectChange to this field.
The field's current value.
The model instance.
The change to apply.
The updated value.
Coerce source data to ensure that it conforms to the correct data type for the field. Data coercion operations should be simple and synchronous as these are applied whenever a DataModel is constructed. For one-off cleaning of user-provided input the sanitize method should be used.
An initial requested value
Optionaloptions: { partial?: boolean; source?: object } = {}Additional options for how the field is cleaned
Optionalpartial?: booleanWhether to perform partial cleaning?
Optionalsource?: objectThe root data model being cleaned
The cast value
Return the embedded document(s) as a Collection.
The parent document.
Migrate this field's candidate source data.
Candidate source data of the root model
The value of this field within the source data
Render this DataField as a standardized form-group element.
Configuration options passed to the wrapping form-group
Input element configuration options passed to DataField#toInput
The rendered form group element
Render this DataField as an HTML element.
Form element configuration parameters
A rendered HTMLElement for the field
Validate a candidate input for this field, ensuring it meets the field requirements. A validation failure can be provided as a raised Error (with a string message), by returning false, or by returning a DataModelValidationFailure instance. A validator which returns true denotes that the result is certainly valid and further validations are unnecessary.
The initial value
Optionaloptions: DataFieldValidationOptions = {}Options which affect validation behavior
Returns a DataModelValidationFailure if a validation failure occurred.
Protected_applyProtectedApply a CUSTOM change to this field.
The field's current value.
The change delta.
The model instance.
The original change data.
The updated value.
Protected_applyProtectedApply a DOWNGRADE change to this field.
The field's current value.
The change delta.
The model instance.
The original change data.
The updated value.
Protected_applyProtectedApply a MULTIPLY change to this field.
The field's current value.
The change delta.
The model instance.
The original change data.
The updated value.
Protected_applyProtectedApply an OVERRIDE change to this field.
The field's current value.
The change delta.
The model instance.
The original change data.
The updated value.
Protected_applyProtectedApply an UPGRADE change to this field.
The field's current value.
The change delta.
The model instance.
The original change data.
The updated value.
Protected_toProtectedRender this DataField as an HTML element. Subclasses should implement this method rather than the public toInput method which wraps it.
Form element configuration parameters
A rendered HTMLElement for the field
Protected_validateProtectedValidate a single element of the ArrayField.
The value of the array element
Validation options
A validation failure if the element failed validation
Protected_validateProtectedSpecial validation rules which supersede regular field validation. This validator screens for certain values which are otherwise incompatible with this field like null or undefined.
The candidate value
A boolean to indicate with certainty whether the value is valid. Otherwise, return void.
Static_validate
A subclass of foundry.data.fields.EmbeddedCollectionField which manages a collection of delta objects relative to another collection.