textifier v1.2.0
Textifier 
Textifier is a javascript library that lets you convert images to any text of your choosing, in your browser
| Original | Colored | Grayscale | Monochrome | Console |
|---|---|---|---|---|
 |  |  |  |  |
Textifier can print as HTML an image or it can even print it in you browser's console.
Instalation
$ npm install textifier
# OR
$ bower install textifierOr just download the minified script and add it in your HTML:
<script src="textifier.min.js"></script>Usage
Here is the mandatory one-liner to show how simple it can be.
new Textifier().draw(target, 'images/piggies.png');Of course you are probably going to want use some options. Textifier takes 3 optional arguments: maxWidth, maxHeight and options.
:warning: NOTES :warning:
Textifier needs CORS access to the source images.
maxWidth
type: number | string
maxWidth should be a positive number. This sets maximum width of the rendered image. If it is not set or set with an invalid value, it will take as much space as it can.
Valid values are either a number or a valid CSS size value (e.g 200px).
Unless specified units will be measured in characters.
maxHeight
type: number | string
Same as maxWidth except that if it is not set the maximum height will be the the same as the height of the original image but in characters instead of pixels.
options
type: object
Every other option will be in the option object.
| Names | Defaults | Types | Info |
|---|---|---|---|
| characters | "01" | string | The character list to write the image with. |
| background | #00000000 | string | Color of the background. This color will also be rendered in text. |
| ordered | false | boolean | If true the characters will show up in order of the characters string |
| color | 0 | number | If the image should be colored, in grayscale or monochrome0 = colored1 = grayscale2 = monochromeTextifier comes with some constants so you don't have to memorize this |
Since all arguments are optional the options argument can be placed anywhere by omitting any of the other 2.
new Textifier(100, 50, options);new Textifier(100, options);new Textifier(options);↿These are all valid↾
Functions
There are 3 main functions in Textifier, write, draw and log. There a few other mainly used internally but available anyways since they might come in handy.
write, draw
arguments: (url, element, append)
The write and draw functions work exactly the same way. The only difference is that write will print html in a \ tag and the draw will print an actual image on a canvas.
url
type: string
The url of the image to be used.
element
type: DOM Element
The element in which the rendered image will be added to.
append
type: boolean
If the rendered image should be appended or replace the contents of the target element.
Example
new Textifier(100, {characters: 'oink', ordered: true}).draw('images/piggies.png', target);Output
log
arguments: (url)
The log function will print the image in the dev console of your browser.
url
type: string
The url of the image to be used.
Example
new Textifier(100, {characters: 'oink', ordered: true}).log('images/piggies.png');Output
Constants
Textifier comes with some "constants" so you don't have to remember arguments that are numbers and to make your code more readable.
Textifier.COLORED = 0;
Textifier.GRAYSCALE = 1;
Textifier.MONOCHROME = 2;
Textifier.HTML = 0;
Textifier.CANVAS = 1;
Textifier.CONSOLE = 2;