static/jsvm/classes/JSONField.html
JSONField defines "json" type field for storing any serialized JSON value.
The respective zero record field value is the zero [types.JSONRaw].
calculateMaxBodySizecolumnTypegetHiddengetIdgetNamegetSystemprepareValuesetHiddensetIdsetNamesetSystemtypevalidateSettingsvalidateValue
hiddenidmaxSizenamepresentablerequiredsystem
Optional data: Partial<core.JSONField>CalculateMaxBodySize implements the [MaxBodySizeCalculator] interface.
ColumnType implements [Field.ColumnType] interface method.
GetHidden implements [Field.GetHidden] interface method.
GetId implements [Field.GetId] interface method.
GetName implements [Field.GetName] interface method.
GetSystem implements [Field.GetSystem] interface method.
PrepareValue implements [Field.PrepareValue] interface method.
SetHidden implements [Field.SetHidden] interface method.
SetId implements [Field.SetId] interface method.
SetName implements [Field.SetName] interface method.
SetSystem implements [Field.SetSystem] interface method.
Type implements [Field.Type] interface method.
ValidateSettings implements [Field.ValidateSettings] interface method.
ValidateValue implements [Field.ValidateValue] interface method.
hidden: boolean
Hidden hides the field from the API response.
id: string
Id is the unique stable field identifier.
It is automatically generated from the name when adding to a collection FieldsList.
maxSize: number
MaxSize specifies the maximum size of the allowed field value (in bytes and up to 2^53-1).
If zero, a default limit of 1MB is applied.
name: string
Name (required) is the unique name of the field.
presentable: boolean
Presentable hints the Dashboard UI to use the underlying field record value in the relation preview label.
required: boolean
Required will require the field value to be non-empty JSON value (aka. not "null", "", "[]", "{}").
system: boolean
System prevents the renaming and removal of the field.
OSLightDark
Generated using TypeDoc