/iLanguageCloud

An HTML5/Android word cloud generation codebase which uses statistics and field linguistics to stem/tokenize any language, and jason davies d3 cloud to render

Primary LanguageJavaScript

ILanguageCloud

Build Status Dependency Status

Generate interactive wordclouds for any language, with automatic stop word detection and ability to export as svg or png.

lexicon_browser2

screen shot 2014-05-23 at 02 07 45 pm

Getting Started

On the server

Install the module with: npm install ilanguage-cloud

var ILanguageCloud = require('ilanguage-cloud').ILanguageCloud;
var myCloud = new ILanguageCloud({text: 'A cloud is a visible mass ...'});
myCloud.render();

In the browser

Install the module with: bower install ilanguage-cloud --save

Or, download the production version or the development version.

In your web page:

<script src="ilanguage-cloud.min.js"></script>
<script>
  var myCloud = new ILanguageCloud({text: 'A cloud is a visible mass ...'});
  myCloud.render(); // renders the text as a cloud to a div id="cloud" if exists
</script>

In your code, you can attach ILanguageCloud's methods to any object.

<script>
var exports = WordCloud;
</script>
<script src="ilanguage-cloud.min.js"></script>
<script>
  new WordCloud({text: 'A cloud is a visible mass ...'}).render();
</script>

Documentation

You can also specify many options on the cloud, for example how the cloud should be analyzed, and in which element it should render.

var myOptions = {
  element: document.getElementById('anyElementCanBePassedIn'),
  orthography: 'A cloud is a visible mass of condensed droplets or frozen crystals suspended in the atmosphere.',
  morphemes: 'A cloud is a visible mass of condense-ed drop-let-s or frozen crystal-s suspend-ed in the atmosphere.',
  font: 'FreeSans',
  nonContentWords: 'a is by in of the or'
};
var cloud = new ILanguageCloud(myOptions);
cloud.render();

Examples

Contributing

In lieu of a formal styleguide, take care to maintain the existing coding style. Add unit tests for any new or changed functionality. Lint and test your code using the scripts in package.json.

More details...

Release History

  • v1.0 Feb 9 2012 - Initial word cloud using CSS rotation in vanilla js
  • v2.0 Jan 29 2013 - WordPress plugin with SVG generation in vanilla js
  • v3.0 Nov 15 2013 - Switched to Jason Davies' d3-cloud to generate SVG
  • v4.0 Nov 15 2017 - Updated to d3-cloud v1.2.5-rc1 d3-cloud to generate SVG Download on Google Play

License

Copyright (c) 2012-2017 iLanguageCloud Contributors. Licensed under the Apache 2.0 license.