The type of Document which is embedded.
Optional options: DataFieldOptions = {}Options which configure the behavior of the field.
Optional context: DataFieldContext = {}Additional context which describes the field
The base DataModel definition which is contained in this field.
The contained field definitions.
Any unknown keys encountered during the last cleaning.
Internal nameThe field name of this DataField instance. This is assigned by SchemaField#initialize.
Internal parentA reference to the parent schema to which this DataField belongs. This is assigned by SchemaField#initialize.
The initially provided options which configure the data field
Static hierarchicalStatic recursiveA dot-separated string representation of the field path within the parent schema.
Static _defaultsDefault parameters for this field type
Static hasDoes this form field class have defined form support?
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.
The initial value
Additional options for how the field is cleaned
The cast value
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
Options which affect validation behavior
Returns a DataModelValidationFailure if a validation failure occurred.
Traverse the schema, obtaining the DataField definition for a particular field.
A field path like ["abilities", "strength"] or "abilities.strength"
The corresponding DataField definition for that field, or undefined
Render this DataField as an HTML element.
Form element configuration parameters
A rendered HTMLElement for the field
An Error if this DataField subclass does not support input rendering
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
Apply an ActiveEffectChange to this field.
The field's current value.
The model instance.
The change to apply.
The updated value.
Protected _initializeProtected _validateProtected Special 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.
May throw a specific error if the value is not valid
Protected _toProtected Render 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
An Error if this DataField subclass does not support input rendering
Protected _applyProtected Apply an ADD change to this field.
The field's current value.
The change delta.
The model instance.
The original change data.
The updated value.
Protected _applyProtected Apply 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 _applyProtected Apply 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 _applyProtected Apply 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 _applyProtected Apply 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 _applyProtected Apply a CUSTOM change to this field.
The field's current value.
The change delta.
The model instance.
The original change data.
The updated value.
A special subclass of EmbeddedDocumentField which allows construction of the ActorDelta to be lazily evaluated.