Image field - Revision history

Drn@ecs.soton.ac.uk: /* Additional Properties */

2023-04-11T23:25:58Z

‎Additional Properties

Drn@ecs.soton.ac.uk: /* Additional Properties */

2023-04-10T22:08:17Z

‎Additional Properties

Drn@ecs.soton.ac.uk: Added Image as metadata field type

2023-04-10T22:04:33Z

Added Image as metadata field type

New page

{{fieldtypes}}

== Description ==
This field store images encoded as base64 data. This may be useful for logos, icons, avatars, etc.

== Inheritance ==
* [[:Category:EPrints_Metadata_Fields|Metadata field]]
** [[Text field]]
*** [[Longtext field]]
**** [[Base64 field]]
***** [[Image field]]

== Additional Properties ==
As for [[Base64 field#Additional_Properties|Base64 fields]] except for:

{| border="1" cellpadding="3" cellspacing="0"
| name || default || description
|-
| '''maxwidth''' || 640 || ''''Can be overridden in the field definition.'''
|-
| '''maxheight''' || 480 || '''Can be overridden in the field definition.'''
|}

== Required Phrases ==
No additional phrases beyond those required for [[Base64 field#Required_Phrases|Base64 fields]].

== Database ==
Image fields are stored in the database as
fieldname LONGTEXT

== API ==
See [[API:EPrints/MetaField/Image|API page]].

== Examples ==
Most basic example.
{
name => 'picture',
type => 'image',
}

Sets bespoke maximum width and height.
{
name => 'icon',
type => 'image',
maxwidth => '64',
maxheight => '64',
}

@@ Line 16: / Line 16: @@
 {| border="1" cellpadding="3" cellspacing="0"
-| name || default || description
+! Name !! Default Value !! Required || Description || Notes
 |-
-| '''maxwidth''' || 640 || '''Can be overridden in the field definition.'''
+| '''maxwidth''' || <tt>640</tt> || NO || Maximum width in pixels of the stored image. ||
 |-
-| '''maxheight''' || 480 || '''Can be overridden in the field definition.'''
+| '''maxheight''' || <tt>480</tt> || NO || Maximum height in pixels of the stored image. ||
 |}