Image field

From EPrints Documentation
Revision as of 23:25, 11 April 2023 by Drn@ecs.soton.ac.uk (talk | contribs) (Additional Properties)
(diff) ← Older revision | Latest revision (diff) | Newer revision → (diff)
Jump to: navigation, search

EPrints 3 Reference: Directory Structure - Metadata Fields - Repository Configuration - XML Config Files - XML Export Format - EPrints data structure - Core API - Data Objects


Metadata Fields: Arclanguage - Base64 - Bigint - Boolean - Compound - Counter - Dataobjref - Date - Decimal - Email - Fields - Float - Id - Idci - Image - Int - Itemref - Keywords - Langid - Longtext - Longtext_counter - Multilang - Multipart - Name - Namedset - Pagerange - Recaptcha - Recaptcha3 - Relation - Search - Secret - Set - Storable - Subject - Subobject - Text - Time - Timestamp - Url - Uuid


Description

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

Inheritance

Additional Properties

As for Base64 fields except for:

Name Default Value Required Description Notes
maxwidth 640 NO Maximum width in pixels of the stored image.
maxheight 480 NO Maximum height in pixels of the stored image.

Required Phrases

No additional phrases beyond those required for Base64 fields.

Database

Image fields are stored in the database as

 fieldname LONGTEXT

API

See API page.

Examples

Most basic example.

{
   name => 'picture',
   type => 'image',
}

Sets bespoke maximum width and height.

{
   name => 'icon',
   type => 'image',
   maxwidth => '64',
   maxheight => '64',
}