Class TypeDataField

A subclass of foundry.data.fields.ObjectField which supports a type-specific data object.

Hierarchy (View Summary)

ObjectField
- TypeDataField

Constructors

constructor

new TypeDataField(
    document: typeof Document,
    options?: DataFieldOptions,
    context?: DataFieldContext,
): TypeDataField
Parameters
- document: typeof Document
  The base document class which belongs in this field
- Optionaloptions: DataFieldOptions = {}
  Options which configure the behavior of the field
- Optionalcontext: DataFieldContext = {}
  Additional context which describes the field
Returns TypeDataField
Overrides ObjectField.constructor

Properties

document

document: typeof Document

The canonical document name of the document type which belongs in this field

`Internal`name

name: string | undefined

The field name of this DataField instance. This is assigned by SchemaField#initialize.

options

options: DataFieldOptions

The initially provided options which configure the data field

`Internal`parent

parent: any

A reference to the parent schema to which this DataField belongs. This is assigned by SchemaField#initialize.

persisted

persisted: boolean = true

Is a value of this field written to source data? A Non-persisted value is initialized (with its initial value), and ActiveEffects can use the field for change application.

`Static`hierarchical

hierarchical: boolean = false

Whether this field defines part of a Document/Embedded Document hierarchy.

`Static`recursive

recursive: boolean = true

Accessors

documentName

get documentName(): string
A convenience accessor for the name of the document type associated with this TypeDataField

Returns string

fieldPath

get fieldPath(): string
A dot-separated string representation of the field path within the parent schema.

Returns string
Inherited from ObjectField.fieldPath

`Static`_defaults

get _defaults(): DataFieldOptions & { nullable: boolean; required: boolean } & {
    nullable: boolean;
    required: boolean;
}
Default parameters for this field type

Returns DataFieldOptions & { nullable: boolean; required: boolean } & {
    nullable: boolean;
    required: boolean;
}
Overrides ObjectField._defaults

`Static`hasFormSupport

get hasFormSupport(): boolean
Does this form field class have defined form support?

Returns boolean
Inherited from ObjectField.hasFormSupport

Methods

_applyChangeAdd

_applyChangeAdd(value: any, delta: any, model: any, change: any): any
Parameters
- value: any
- delta: any
- model: any
- change: any
Returns any
Inherited from ObjectField._applyChangeAdd

_cast

_cast(value: any): any
Parameters
- value: any
Returns any
Inherited from ObjectField._cast

_cleanType

_cleanType(value: any, options: any, _state: any): any
Parameters
- value: any
- options: any
- _state: any
Returns any
Overrides ObjectField._cleanType

_getField

_getField(parts: any, __namedParameters?: {}): any
Parameters
- parts: any
- __namedParameters: {} = {}
Returns any
Overrides ObjectField._getField

_migrate

_migrate(value: any, options: any, _state: any): any
Parameters
- value: any
- options: any
- _state: any
Returns any
Overrides ObjectField._migrate

_updateCommit

_updateCommit(source: any, key: any, value: any, diff: any, options: any): void
Internal
Commit a prepared update to DataModel#_source.
Parameters
- source: any
  The parent source object within which the key field exists
- key: any
  The named field in source to commit
- value: any
  The new value of the field which should be committed to source
- diff: any
  The reported change to the field
- options: any
  Options which modify how this update workflow is performed.
Returns void
Overrides ObjectField._updateCommit

_updateDiff

_updateDiff(key: any, value: any, options: any, state: any): void
Parameters
- key: any
- value: any
- options: any
- state: any
Returns void
Overrides ObjectField._updateDiff

_validateModel

_validateModel(changes: any, options?: {}): any
Parameters
- changes: any
- options: {} = {}
Returns any
Overrides ObjectField._validateModel

_validateRecursive

_validateRecursive(value: any, options: any): any
Parameters
- value: any
- options: any
Returns any
Overrides ObjectField._validateRecursive

_validateType

_validateType(value: any, _options: any): void
Parameters
- value: any
- _options: any
Returns void
Inherited from ObjectField._validateType

apply

apply(fn: string | Function, value: any, options?: object): object
Apply a function to this DataField which propagates through recursively to any contained data schema.
Parameters
- fn: string | Function
  The function to apply
- value: any
  The current value of this field
- Optionaloptions: object = {}
  Additional options passed to the applied function
Returns object
The results object

Inherited from ObjectField.apply

applyChange

applyChange<T>(
    value: T,
    model: DataModel,
    change: EffectChangeData,
    options?: { replacementData?: Record<string, unknown> },
): T
Apply an ActiveEffectChange to this field.
Type Parameters
- T
Parameters
- value: T
  The field's current value.
- model: DataModel
  The model instance.
- change: EffectChangeData
  The change to apply.
- options: { replacementData?: Record<string, unknown> } = {}
  Additional options to configure the change application.
  - OptionalreplacementData?: Record<string, unknown>
    Data used to resolve "@" expressions.
Returns T
The updated value.

Inherited from ObjectField.applyChange

clean

clean(value: any, options: any, _state: any): any
Preprocess and clean source data to ensure that it conforms to the correct data type for this field and is ready to be used by data model construction or update operations. Data cleaning is synchronous and automatically applied as the first step of construction and update operations.
Parameters
- value: any
  An initial requested value
- options: any
  Additional options for how the field is cleaned
- _state: any
  Internal state variables which are used during recursion
Returns any
The cleaned value

Overrides ObjectField.clean

getInitialValue

getInitialValue(source: any): any
Parameters
- source: any
Returns any
Overrides ObjectField.getInitialValue

getModelForType

getModelForType(type: string): any
Get the DataModel definition that should be used for this type of document.
Parameters
- type: string
  The Document instance type
Returns any
The DataModel class or null

initialize

initialize(value: any, model: any, options?: {}): any
Parameters
- value: any
- model: any
- options: {} = {}
Returns any
Overrides ObjectField.initialize

toFormGroup

toFormGroup(
groupConfig?: FormGroupConfig,
inputConfig?: FormInputConfig,
): HTMLDivElement
Render this DataField as a standardized form-group element.
Parameters
- groupConfig: FormGroupConfig = {}
  Configuration options passed to the wrapping form-group
- inputConfig: FormInputConfig = {}
  Input element configuration options passed to DataField#toInput
Returns HTMLDivElement
The rendered form group element

Inherited from ObjectField.toFormGroup

toInput

toInput(config?: FormInputConfig): HTMLElement | HTMLCollection | HTMLElement[]
Render this DataField as an HTML element.
Parameters
- config: FormInputConfig = {}
  Form element configuration parameters
Returns HTMLElement | HTMLCollection | HTMLElement[]
A rendered HTMLElement for the field

Throws
An Error if this DataField subclass does not support input rendering

Inherited from ObjectField.toInput

toObject

toObject(value: any): any
Parameters
- value: any
Returns any
Overrides ObjectField.toObject

validate

validate(
value: any,
options?: DataFieldValidationOptions,
): void | DataModelValidationFailure
Validate candidate input for this field, ensuring it meets the field requirements.

This public method validates recursively, testing both the immediate value of this field as well as the validity of any child values for fields with hierarchical data types.
Parameters
- value: any
  The candidate value to validate
- Optionaloptions: DataFieldValidationOptions = {}
  Options which affect validation behavior
Returns void | DataModelValidationFailure
A failure that occurred if validation is non-strict. The failure may have been resolved by fallback or dropping invalid elements.

Throws
A failure error type including details of the failure if validation is performed strictly.

Inherited from ObjectField.validate

validators

validators(
options?: Pick<DataFieldValidationOptions, "recursive" | "phase">,
): Generator<DataFieldValidator, void, unknown>
Iterate over validation functions applied to this field. Validation happens in a depth-first way, for example consider an outerSchema with an innerField:
Parameters
- options: Pick<DataFieldValidationOptions, "recursive" | "phase"> = {}
Returns Generator<DataFieldValidator, void, unknown>
Example: Validator Invocation Order
```
outerSchema
  _validateSpecial
  _validateType
  _validateRecursive
  outerSchema.options.validate
    innerField
      _validateSpecial
      _validateType
      innerField.options.validate
      _validateModel
  _validateModel
```
Yields
Inherited from ObjectField.validators

`Protected`_applyChangeCustom

_applyChangeCustom(
    value: any,
    delta: any,
    model: DataModel,
    change: EffectChangeData,
): any
Protected
Apply a custom change to this field.
Parameters
- value: any
  The field's current value.
- delta: any
  The change delta.
- model: DataModel
  The model instance.
- change: EffectChangeData
  The original change data.
Returns any
The updated value.

Inherited from ObjectField._applyChangeCustom

`Protected`_applyChangeDowngrade

_applyChangeDowngrade(
    value: any,
    delta: any,
    model: DataModel,
    change: EffectChangeData,
): any
Protected
Apply a "downgrade" change to this field.
Parameters
- value: any
  The field's current value.
- delta: any
  The change delta.
- model: DataModel
  The model instance.
- change: EffectChangeData
  The original change data.
Returns any
The updated value.

Inherited from ObjectField._applyChangeDowngrade

`Protected`_applyChangeMultiply

_applyChangeMultiply(
    value: any,
    delta: any,
    model: DataModel,
    change: EffectChangeData,
): any
Protected
Apply a "multiply" change to this field.
Parameters
- value: any
  The field's current value.
- delta: any
  The change delta.
- model: DataModel
  The model instance.
- change: EffectChangeData
  The original change data.
Returns any
The updated value.

Inherited from ObjectField._applyChangeMultiply

`Protected`_applyChangeOverride

_applyChangeOverride(
    value: any,
    delta: any,
    model: DataModel,
    change: EffectChangeData,
): any
Protected
Apply an "override" change to this field.
Parameters
- value: any
  The field's current value.
- delta: any
  The change delta.
- model: DataModel
  The model instance.
- change: EffectChangeData
  The original change data.
Returns any
The updated value.

Inherited from ObjectField._applyChangeOverride

`Protected`_applyChangeSubtract

_applyChangeSubtract(
    value: any,
    delta: any,
    model: DataModel,
    change: EffectChangeData,
): any
Protected
Apply a "subtract" change to this field.
Parameters
- value: any
  The field's current value.
- delta: any
  The change delta.
- model: DataModel
  The model instance.
- change: EffectChangeData
  The original change data.
Returns any
The updated value.

Inherited from ObjectField._applyChangeSubtract

`Protected`_applyChangeUpgrade

_applyChangeUpgrade(
    value: any,
    delta: any,
    model: DataModel,
    change: EffectChangeData,
): any
Protected
Apply an "upgrade" change to this field.
Parameters
- value: any
  The field's current value.
- delta: any
  The change delta.
- model: DataModel
  The model instance.
- change: EffectChangeData
  The original change data.
Returns any
The updated value.

Inherited from ObjectField._applyChangeUpgrade

`Protected`_castChangeDelta

_castChangeDelta(delta: any, replacementData?: object): any
Protected
Cast a change delta into an appropriate type to be applied to this field.
Parameters
- delta: any
  The change delta.
- replacementData: object = {}
  Data used to resolve "@" expressions.
Returns any
Inherited from ObjectField._castChangeDelta

`Protected`_replaceDataRefs

_replaceDataRefs(
    raw: string,
    data: Record<string, unknown>,
    options?: { strict?: boolean },
): string
Protected
Recursively replace data references in a string change value.
Parameters
- raw: string
- data: Record<string, unknown>
  An object providing replacements
- Optionaloptions: { strict?: boolean } = {}
  Additional options to configure the data replacement
  - Optionalstrict?: boolean
    Throw an Error if data replacement fails
Returns string
The expression with data references resolved

Inherited from ObjectField._replaceDataRefs

`Protected`_toInput

_toInput(config: FormInputConfig): HTMLElement | HTMLCollection | HTMLElement[]
Protected
Render this DataField as an HTML element. Subclasses should implement this method rather than the public toInput method which wraps it.
Parameters
- config: FormInputConfig
  Form element configuration parameters
Returns HTMLElement | HTMLCollection | HTMLElement[]
A rendered HTMLElement for the field

Throws
An Error if this DataField subclass does not support input rendering

Inherited from ObjectField._toInput

`Protected`_validateSpecial

_validateSpecial(value: any): boolean | void
Protected
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.
Parameters
- value: any
  The candidate value
Returns boolean | void
A boolean to indicate with certainty whether the value is valid

Throws
An error with a specific reason the value is invalid

Inherited from ObjectField._validateSpecial

`Static`getModelProvider

getModelProvider(model: DataModel): any
Return the package that provides the sub-type for the given model.
Parameters
- model: DataModel
  The model instance created for this sub-type.
Returns any

Class TypeDataField

Hierarchy (View Summary)

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Parameters

Returns TypeDataField

Properties

document

Internalname

options

Internalparent

persisted

Statichierarchical

Staticrecursive

Accessors

documentName

Returns string

fieldPath

Returns string

Static_defaults

Returns DataFieldOptions & { nullable: boolean; required: boolean } & { nullable: boolean; required: boolean;}

StatichasFormSupport

Returns boolean

Methods

_applyChangeAdd

Parameters

Returns any

_cast

Parameters

Returns any

_cleanType

Parameters

Returns any

_getField

Parameters

Returns any

_migrate

Parameters

Returns any

_updateCommit

Parameters

Returns void

_updateDiff

Parameters

Returns void

_validateModel

Parameters

Returns any

_validateRecursive

Parameters

Returns any

_validateType

Parameters

Returns void

apply

Parameters

Returns object

applyChange

Type Parameters

Parameters

OptionalreplacementData?: Record<string, unknown>

Returns T

clean

Parameters

Returns any

getInitialValue

Parameters

Returns any

getModelForType

Parameters

Returns any

initialize

Parameters

Returns any

toFormGroup

`Internal`name

`Internal`parent

`Static`hierarchical

`Static`recursive

`Static`_defaults

Returns DataFieldOptions & { nullable: boolean; required: boolean } & {
nullable: boolean;
required: boolean;
}

`Static`hasFormSupport

`Optional`replacementData?: Record<string, unknown>

`Protected`_applyChangeCustom

`Protected`_applyChangeDowngrade

`Protected`_applyChangeMultiply

`Protected`_applyChangeOverride

`Protected`_applyChangeSubtract

`Protected`_applyChangeUpgrade

`Protected`_castChangeDelta

`Protected`_replaceDataRefs

`Optional`strict?: boolean

`Protected`_toInput

`Protected`_validateSpecial

`Static`getModelProvider