Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/mobilehero-archive/titanium-imagefactory

Axway Amplify module for image transformation - scale, crop, and compress images - for Appcelerator Titanium Mobile
https://github.com/mobilehero-archive/titanium-imagefactory

amplify android api-builder appcelerator axway axway-amplify axway-sdk brenton-house ios mobile native titanium titanium-alloy titanium-mobile titanium-module titanium-sdk

Last synced: about 1 month ago
JSON representation

Axway Amplify module for image transformation - scale, crop, and compress images - for Appcelerator Titanium Mobile

Awesome Lists containing this project

README 

        
[//]: # (header-start)





	

		Preparing for end of Axway

		





	👇   support for Amplify Cloud and Mobile     👇

	





	


		RIP Axway Amplify Titanium (2010 - 2022)

	


	



	

			🪦   RIP Axway Amplify Titanium (2010 - 2022)

	





	

			🪦   RIP Axway Amplify Cloud Services (2012 - 2022)

	





	

			🪦   RIP Axway Amplify Crash Analytics (2015 - 2022)

	








🛑    Axway support for Amplify products has ended for most products related to mobile and cloud. 






A few of the open-source versions of Axway Amplify products will live on after Axway Amplify End-of-Life (EOL) announcements.  However, all closed-source projects and most open-source projects are now dead.  

	



 



> 👉    A group of Axway employees, ex-Axway employees, and some developers from Titanium community have created a legal org and now officially decide all matters related to future of these products.  



 





## API FAQ:



* [API Best Practices](https://brenton.house)

* [What is API Security?](https://brenton.house/what-is-api-security-5ca8117d4911)

* [OWASP Top 10 List for API Security](https://www.youtube.com/watch?v=GLVHDj0Cpg4)

* [What is API Security?](https://brenton.house/what-is-api-security-5ca8117d4911)

* [Top API Trends for 2022](https://brenton.house/top-10-api-integration-trends-for-2022-49b05f2ef299)

* [What is a Frankenstein API?](https://brenton.house/what-is-a-frankenstein-api-4d6e59fca6)

* [What is a Zombie API?](https://brenton.house/what-is-a-zombie-api-6e5427c39b6a)

* [API Developer Experience](https://brenton.house/keys-to-winning-with-an-awesome-api-developer-experience-62dd2fa668f4)

* [API Cybersecurity 101](https://brenton.house/what-is-api-security-5ca8117d4911)

* [YouTube API Videos](https://youtube.com/brentonhouse)

* [YouTube API Shorts Videos](https://youtube.com/apishorts)



 



[![Click to watch on Youtube](https://img.youtube.com/vi/GLVHDj0Cpg4/0.jpg)](https://www.youtube.com/watch?v=GLVHDj0Cpg4&list=PLsy9MwYlG1pew6sktCAIFD5tbrXy9HUQ7  "Click to watch on YouTube")



>   [↑ Watch video on YouTube ↑](https://www.youtube.com/watch?v=GLVHDj0Cpg4&list=PLsy9MwYlG1pew6sktCAIFD5tbrXy9HUQ7)



 



 





 


 



[//]: # (header-end)



# @titanium/imagefactory



[![@titanium/imagefactory](https://img.shields.io/npm/v/@titanium/imagefactory.png)](https://www.npmjs.com/package/@titanium/imagefactory)

[![Dependabot Status](https://api.dependabot.com/badges/status?host=github&repo=brentonhouse/titanium-imagefactory)](https://dependabot.com)



> Titanium native mobile image transformation functions including the ability to scale, crop, and compress images.



* [API FAQ:](#api-faq)

* [📝 Description](#-description)

* [🚀 Getting Started](#-getting-started)

* [Accessing the @titanium/imagefactory Module](#accessing-the-titaniumimagefactory-module)

	* [Methods](#methods)

		* [imageWithRotation(blob, options)](#imagewithrotationblob-options)

			* [Arguments](#arguments)

		* [imageWithAlpha(blob, options)](#imagewithalphablob-options)

			* [Arguments](#arguments-1)

		* [imageWithTransparentBorder(blob, options)](#imagewithtransparentborderblob-options)

			* [Arguments](#arguments-2)

		* [imageWithRoundedCorner(blob, options)](#imagewithroundedcornerblob-options)

			* [Arguments](#arguments-3)

		* [imageAsThumbnail(blob, options)](#imageasthumbnailblob-options)

			* [Arguments](#arguments-4)

		* [imageAsResized(blob, options)](#imageasresizedblob-options)

			* [Arguments](#arguments-5)

		* [imageAsCropped(blob, options)](#imageascroppedblob-options)

			* [Arguments](#arguments-6)

		* [imageTransform(blob, options)](#imagetransformblob-options)

			* [Arguments](#arguments-7)

		* [compress(blob, quality)](#compressblob-quality)

			* [Arguments](#arguments-8)

* [✨Features](#features)

* [📚Learn More](#learn-more)

* [📣 Feedback](#-feedback)

* [©️ Legal](#️-legal)



## 📝 Description



Ti.ImageFactory provides a set of image transformation functions including the ability to scale, crop, and compress images. Additionally, this module offers the functionality of adding alpha channels and transparent borders.  This is a repackaging of the compiled iOS and Android modules for [Ti.ImageFactory](https://github.com/appcelerator-modules/ti.imagefactory) to allow for installation via npm.



## 🚀 Getting Started



1. Install `@titanium/imagefactory` in root of project



```

npm install @titanium/imagefactory

```



## Accessing the @titanium/imagefactory Module



To access this module from JavaScript, you would do the following:



```js

const imageFactory = require('@titanium/imagefactory');

```



### Methods



#### imageWithRotation(blob, options)



Creates a new image by creating a copy of the given image that is rotated.



##### Arguments



* Image blob[blob]: Image to transform

* Options[dictionary]: A dictionary specifying the options for the transformation

    * degrees[int]: The degrees to rotate the image



#### imageWithAlpha(blob, options)



Creates a new image by creating a copy of the given image, adding an alpha channel if it doesn't already have one.



##### Arguments



* Image blob[blob]: Image to transform

* Options[dictionary]: A dictionary specifying the options for the transformation

    * iOS: Currently there are no properties for this method -- specify an empty dictionary

    * Android: format [int]: The output format of the image: either ImageFactory.PNG or ImageFactory.JPEG (default: ImageFactory.JPEG)

    * Android: quality[float]: The quality of the resulting JPEG image, expressed as a value from 0.0 to 1.0. The value 0.0 represents the maximum compression (or lowest quality) while the value 1.0 represents the least compression (or best quality). (default: 0.7)



#### imageWithTransparentBorder(blob, options)



Creates a new image by creating a copy of the given image, adding a transparent border of the given size around its edges. The size of the image will be expanded by the specified border size.



##### Arguments



* Image blob[blob]: Image to transform

* Options[dictionary]: A dictionary specifying the options for the transformation

    * borderSize[int]: The size of the border (default: 1)

    * Android: format [int]: The output format of the image: either ImageFactory.PNG or ImageFactory.JPEG (default: ImageFactory.JPEG)

    * Android: quality[float]: The quality of the resulting JPEG image, expressed as a value from 0.0 to 1.0. The value 0.0 represents the maximum compression (or lowest quality) while the value 1.0 represents the least compression (or best quality). (default: 0.7)



#### imageWithRoundedCorner(blob, options)



Creates a new image by creating a copy of the given image with rounded corners.



##### Arguments



* Image blob[blob]: Image to transform

* Options[dictionary]: A dictionary specifying the options for the transformation

   * borderSize[int]: The size of the border (default: 1)

   * cornerRadius[int]: The radius of the corner edges (default: 0)

   * Android: format [int]: The output format of the image: either ImageFactory.PNG or ImageFactory.JPEG (default: ImageFactory.JPEG).

   * Android: quality[float]: The quality of the resulting JPEG image, expressed as a value from 0.0 to 1.0. The value 0.0 represents the maximum compression (or lowest quality) while the value 1.0 represents the least compression (or best quality). (default: 0.7).



#### imageAsThumbnail(blob, options)



Creates a new image by creating a copy of the given image that is squared to the thumbnail size.



##### Arguments



* Image blob[blob]: Image to transform

* Options[dictionary]: A dictionary specifying the options for the transformation

    * size[int]: The size of the thumbnail (default: 48)

    * borderSize[int]: The size of the border (default: 1)

    * cornerRadius[int]: The radius of the corner edges (default:0)

    * iOS: quality[int]: The interpolation quality. One of the following constants (default: imagefactory.QUALITY\_HIGH)

        * imagefactory.QUALITY\_DEFAULT

        * imagefactory.QUALITY\_NONE

        * imagefactory.QUALITY\_LOW

        * imagefactory.QUALITY\_MEDIUM

        * imagefactory.QUALITY\_HIGH

    * Android: quality[float]: The quality of the resulting JPEG image, expressed as a value from 0.0 to 1.0. The value 0.0 represents the maximum compression (or lowest quality) while the value 1.0 represents the least compression (or best quality). (default: 0.7)

    * Android: dither[boolean]: Indicates if dithering should be applied while scaling. May provide better quality (default: true)

    * Android: format [int]: The output format of the image: either ImageFactory.PNG or ImageFactory.JPEG (default: ImageFactory.JPEG)



#### imageAsResized(blob, options)



Creates a new image by creating a copy of the given image that is rescaled to the specified size.



##### Arguments



* Image blob[blob]: Image to transform

* Options[dictionary]: A dictionary specifying the options for the transformation

    * width[int]: The width of the new image (default: image width)

    * height[int]: The height of the new image (default: image height)

    * iOS: hires[boolean]: Create a hires image (for Retina displays only)

    * iOS: quality[int]: The interpolation quality. One of the following constants (default: imagefactory.QUALITY\_HIGH)

        * imagefactory.QUALITY\_DEFAULT

        * imagefactory.QUALITY\_NONE

        * imagefactory.QUALITY\_LOW

        * imagefactory.QUALITY\_MEDIUM

        * imagefactory.QUALITY\_HIGH

    * Android. format [int]: The output format of the image: either ImageFactory.PNG or ImageFactory.JPEG (default: ImageFactory.JPEG)

    * quality[float]: The quality of the resulting JPEG image, expressed as a value from 0.0 to 1.0. The value 0.0 represents the maximum compression (or lowest quality) while the value 1.0 represents the least compression (or best quality). (default: 0.7)



#### imageAsCropped(blob, options)



Creates a new image by creating a copy of the given image that is cropped to the specified bounds.



##### Arguments



* Image blob[blob]: Image to transform

* Options[dictionary]: A dictionary specifying the options for the transformation

    * width[int]: The width of the new image (default: image width)

    * height[int]: The height of the new image (default: image height)

    * x[int]: The x-coordinate of the upper-left corner of the bounds (default: image center - width / 2)

    * y[int]: The y-coordinate of the upper-left corner of the bounds (default: image center - height / 2)

    * Android: format [int]: The output format of the image: either ImageFactory.PNG or ImageFactory.JPEG (default: ImageFactory.JPEG)

    * Android: quality[float]: The quality of the resulting JPEG image, expressed as a value from 0.0 to 1.0. The value 0.0 represents the maximum compression (or lowest quality) while the value 1.0 represents the least compression (or best quality). (default: 0.7)



#### imageTransform(blob, options)



Creates a new image by applying a sequence of transformations to the image.



##### Arguments



* Image blob[blob]: Image to transform

* Transform[dictionary]: A sequence of transform specifications. Transforms are listed as additional parameters to the function and are applied in the order specified. Each transform is a dictionary with the options described above for each transform along with an additional 'type' property included with each dictionary of transform options.

    * type[int]: The identifier of the transform to apply. One of the following constants

        * imagefactory.TRANSFORM\_CROP

        * imagefactory.TRANSFORM\_RESIZE

        * imagefactory.TRANSFORM\_THUMBNAIL

        * imagefactory.TRANSFORM\_ROUNDEDCORNER

        * imagefactory.TRANSFORM\_TRANSPARENTBORDER

        * imagefactory.TRANSFORM\_ALPHA

    * options as described in the above transforms



#### compress(blob, quality)



Creates a new image by creating a copy of the given image and applying the specified compression quality.



##### Arguments



* Image blob[blob]: Image to compress

* Compression Quality[float]; The quality of the resulting JPEG image, expressed as a value from 0.0 to 1.0. The value 0.0 represents the maximum compression (or lowest quality) while the value 1.0 represents the least compression (or best quality). (default: 1.0)



## ✨Features



iOS: `ti.imagefactory 1.3.0`

Android: `ti.imagefactory 4.0.0`



* [x] Scale images

* [x] Crop images

* [x] Compress images

* [x] Add alpha channel to images

* [x] Add transparent borders to images



## 📚Learn More



- [Ti.ImageFactory GitHub Repo](https://github.com/appcelerator-modules/ti.imagefactory)



## 📣 Feedback



Have an idea or a comment?  [Join in the conversation here](https://github.com/brentonhouse/titanium-imagefactory/issues)! 



## ©️ Legal



Modules are licensed under Apache 2.0 from https://github.com/appcelerator-modules/ti.imagefactory



Alloy is developed by Appcelerator and the community and is Copyright © 2012-Present by Appcelerator, Inc. All Rights Reserved.



Alloy is made available under the Apache Public License, version 2. See their license file for more information.



Appcelerator is a registered trademark of Appcelerator, Inc. Titanium is a registered trademark of Appcelerator, Inc. Please see the LEGAL information about using trademarks, privacy policy, terms of usage and other legal information at http://www.appcelerator.com/legal.