Git Product home page Git Product logo

simg's Introduction

simg

A small SVG to image converter. Works in browser or PhantomJS.

To use

  var simg = new Simg(svgElement);

  // Replace the current SVG with an image version of it.
  simg.replace();

  // And trigger a download of the rendered image.
  simg.download();

Live example

The example page in this repo is also hosted at http://krunkosaurus.github.io/simg/

To install

You can install this code in your project in 3 ways:

Documentation

Instances Methods

Simg.toString(svg) - Returns SVG as HTML content. Used internally.

Simg.toCanvas(cb) - Return canvas element with this SVG drawn inside. Used internally. Callback is optional.

Simg.toSvgImage(cb) - Creates an image with the SVG data. Used internally. Callback runs on image load.

Simg.toImg(cb) - Converts svg in to an image. Called the cb once the image is loaded so that you can place it anywhere.

Simg.replace(svg) - Shortcut to replace the SVG with an image version.

Simg.toBinaryBlog(svg) - Internal method for getting blob data.

Simg.download(filename) - Shortcut method for triggering a browser download of the SVG as an image (.png). You can pass optional filename. Default is 'chart'.

Static methods:

Simg.noConflict() - Allows you to move the Simg class from the global window to inside your own JavaScript library.

Simg.getBase64Image(imgReference) - Converts an image to base64 encoding so that we can display it inline.

Development

To install

  • Git clone this repo
  • npm install

Grunt commands (for development only)

grunt - Shortcut for running both grunt uglify and grunt lint.

grunt uglify - Convert source file to compressed file.

grunt lint - Run source file through jshint

Notes

  • Many SVG's have transparent backgrounds that look white because of the website under it. Be sure to set a white background in your SVG if you want it in your image.
  • Simg works best with SVG or Canvas elements that have a fixed width and height. Percentages occasionally cause issues. If someone is feeling up to it, a helper function can be added that converts a % width/height SVG or Canvas element to its fixed pixel equivalent before conversion. One day I'll get around to doing it.

Contributors

Thanks to the following contributors:

  • @clemsos - Suggesting naming download file and adding support for non-latin characters ie. Chinese.
  • @headwinds - Creating example page.
  • @brightrain - For Firefox workaround.
  • @B3rn475 - Fixed problem when the svg tag is not the only child.

simg's People

Contributors

krunkosaurus avatar

Watchers

 avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.