DO NOT EDIT THE CONTENT OF THIS PAGE DIRECTLY (EXCEPT INSIDE THE DIV BELOW WITH ID=DESCRIPTION), UNLESS YOU KNOW WHAT YOU'RE DOING.
THE STRUCTURE OF THE CONTENT IS VITAL IN BEING ABLE TO AUTO UPDATE THE CONTENT THROUGH THE DOC GENERATOR.
Enter additional information related to this 'class' inside the {div} macro with 'id=description'
{column:width=80px|padding=0px}{column}{column}{column}
Method Summary
getContentType()
Gets the contenttype (image/jpeg) of this image.
byte[]
getData()
Gets the bytes of this image, so that they can be saved to disk or stored the database.
getMetaDataDescription(property)
Gets the description of a metadata property from the image.
getMetaDataObject(property)
Gets the real object of a metadata property from the image.
String[]
getMetaDataProperties()
Gets the available metadata properties from the image.
{column:width=100%|padding=0px}{column}
Method Details
flip
(type)
Flips the image verticaly (type param=0) or horizontaly (type param=1). A new JSImage is returned.
Sample
var image = plugins.images.getImage(byteArray_or_file_or_filename);//loads the image image = image.flip(0);//flip vertically var bytes = image.getData();//gets the image bytes plugins.file.writeFile('filename',bytes);//saves the image bytes
getContentType
()
Gets the contenttype (image/jpeg) of this image.
Sample
var image = plugins.images.getImage(byteArray_or_file); var width = image.getWidth(); var height = image.getHeight(); var contentType = image.getContentType();
byte[]
getData
()
Gets the bytes of this image, so that they can be saved to disk or stored the database.
Returns
byte[]
Sample
var image = plugins.images.getImage(byteArray_or_file_or_filename);//loads the image image = image.resize(200,200);//resizes it to 200,200 var bytes = image.getData();//gets the image bytes plugins.file.writeFile('filename',bytes);//saves the image bytes
getHeight
()
Gets the height of this image.
Sample
var image = plugins.images.getImage(byteArray_or_file); var width = image.getWidth(); var height = image.getHeight(); var contentType = image.getContentType();
getMetaDataDescription
(property)
Gets the description of a metadata property from the image. Currently only jpg is supported.
Sample
var image = plugins.images.getImage(byteArray_or_file_or_filename);//loads the image // get the available metadata properties from the image, currently only jpg is supported var propertiesArray = image.getMetaDataProperties(); for(var i=0;i<propertiesArray.length;i++) { var property = propertiesArray[i] application.output("property: " + property); application.output("description (string): " + image.getMetaDataDescription(property)) application.output("real object: " + image.getMetaDataObject(property)) } // Thumbnail data is stored under property 'Exif - Thumbnail Data', extract that and set it in a dataprovider thumbnail = image.getMetaDataObject("Exif - Thumbnail Data"); // gets thumbnail data from the image
getMetaDataObject
(property)
Gets the real object of a metadata property from the image. Currently only jpg is supported.
Sample
var image = plugins.images.getImage(byteArray_or_file_or_filename);//loads the image // get the available metadata properties from the image, currently only jpg is supported var propertiesArray = image.getMetaDataProperties(); for(var i=0;i<propertiesArray.length;i++) { var property = propertiesArray[i] application.output("property: " + property); application.output("description (string): " + image.getMetaDataDescription(property)) application.output("real object: " + image.getMetaDataObject(property)) } // Thumbnail data is stored under property 'Exif - Thumbnail Data', extract that and set it in a dataprovider thumbnail = image.getMetaDataObject("Exif - Thumbnail Data"); // gets thumbnail data from the image
String[]
getMetaDataProperties
()
Gets the available metadata properties from the image. Currently only jpg is supported.
Sample
var image = plugins.images.getImage(byteArray_or_file_or_filename);//loads the image // get the available metadata properties from the image, currently only jpg is supported var propertiesArray = image.getMetaDataProperties(); for(var i=0;i<propertiesArray.length;i++) { var property = propertiesArray[i] application.output("property: " + property); application.output("description (string): " + image.getMetaDataDescription(property)) application.output("real object: " + image.getMetaDataObject(property)) } // Thumbnail data is stored under property 'Exif - Thumbnail Data', extract that and set it in a dataprovider thumbnail = image.getMetaDataObject("Exif - Thumbnail Data"); // gets thumbnail data from the image
getWidth
()
Gets the width of this image.
Sample
var image = plugins.images.getImage(byteArray_or_file); var width = image.getWidth(); var height = image.getHeight(); var contentType = image.getContentType();
resize
(width, height)
Resizes the image to the width/height given, keeping aspect ratio. A new JSImage is returned.
Sample
var image = plugins.images.getImage(byteArray_or_file_or_filename);//loads the image image = image.resize(200,200);//resizes it to 200,200 var bytes = image.getData();//gets the image bytes plugins.file.writeFile('filename',bytes);//saves the image bytes
rotate
(degrees)
Rotates the image the number of degrees that is given. A new JSImage is returned.
Sample
var image = plugins.images.getImage(byteArray_or_file_or_filename);//loads the image image = image.rotate(90);//rotate the image 90 degrees var bytes = image.getData();//gets the image bytes plugins.file.writeFile('filename',bytes);//saves the image bytes