static/jsvm/interfaces/core.FileField.html
FileField defines "file" type field for managing record file(s).
Only the file name is stored as part of the record value. New files (aka. files to upload) are expected to be of *filesystem.File.
If MaxSelect is not set or <= 1, then the field value is expected to be a single record id.
If MaxSelect is > 1, then the field value is expected to be a slice of record ids.
The respective zero record field value is either empty string (single) or empty string slice (multiple).
The following additional setter keys are available:
- "fieldName+" - append one or more files to the existing record one. For example: // []string{"old1.txt", "old2.txt", "new1_ajkvass.txt", "new2_klhfnwd.txt"} record.Set("documents+", []*filesystem.File{new1, new2}) - "+fieldName" - prepend one or more files to the existing record one. For example: // []string{"new1_ajkvass.txt", "new2_klhfnwd.txt", "old1.txt", "old2.txt",} record.Set("+documents", []*filesystem.File{new1, new2}) - "fieldName-" - subtract/delete one or more files from the existing record one. For example: // []string{"old2.txt",} record.Set("documents-", "old1.txt")Copy
calculateMaxBodySizecolumnTypedriverValuefindGetterfindSettergetHiddengetIdgetNamegetSysteminterceptisMultipleprepareValuesetHiddensetIdsetNamesetSystemtypevalidateSettingsvalidateValue
hiddenidmaxSelectmaxSizemimeTypesnamepresentableprotectedrequiredsystemthumbs
CalculateMaxBodySize implements the [MaxBodySizeCalculator] interface.
ColumnType implements [Field.ColumnType] interface method.
DriverValue implements the [DriverValuer] interface.
FindGetter implements the [GetterFinder] interface.
FindSetter implements the [SetterFinder] interface.
GetHidden implements [Field.GetHidden] interface method.
GetId implements [Field.GetId] interface method.
GetName implements [Field.GetName] interface method.
GetSystem implements [Field.GetSystem] interface method.
Intercept implements the [RecordInterceptor] interface.
note: files delete after records deletion is handled globally by the app FileManager hook
-
- (): void
-
IsMultiple implements MultiValuer interface and checks whether the current field options support multiple values.
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.
maxSelect: number
MaxSelect specifies the max allowed files.
For multiple files the value must be > 1, otherwise fallbacks to single (default).
maxSize: number
MaxSize specifies the maximum size of a single uploaded file (in bytes and up to 2^53-1).
If zero, a default limit of 5MB is applied.
mimeTypes: string[]
MimeTypes specifies an optional list of the allowed file mime types.
Leave it empty to disable the validator.
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.
protected: boolean
Protected will require the users to provide a special file token to access the file.
Note that by default all files are publicly accessible.
For the majority of the cases this is fine because by default all file names have random part appended to their name which need to be known by the user before accessing the file.
required: boolean
Required will require the field value to have at least one file.
system: boolean
System prevents the renaming and removal of the field.
thumbs: string[]
Thumbs specifies an optional list of the supported thumbs for image based files.
Each entry must be in one of the following formats:
- WxH (eg. 100x300) - crop to WxH viewbox (from center) - WxHt (eg. 100x300t) - crop to WxH viewbox (from top) - WxHb (eg. 100x300b) - crop to WxH viewbox (from bottom) - WxHf (eg. 100x300f) - fit inside a WxH viewbox (without cropping) - 0xH (eg. 0x300) - resize to H height preserving the aspect ratio - Wx0 (eg. 100x0) - resize to W width preserving the aspect ratioCopy
OSLightDark
Generated using TypeDoc