Skip to content

Latest commit

 

History

History
84 lines (62 loc) · 3.53 KB

README.md

File metadata and controls

84 lines (62 loc) · 3.53 KB
Raw

What?

A tagmob in action

tagmob.js aims to mimic the functionality of the Wordle Java-Applet by Jonathan Feinberg in a clickable and hoverable way using a pure javascript implementation. Fair enough.

It is based on code mercilessly stolen from Raphaël and Cufón. Although Jonathan was not able to provide the source code, he described how Wordle actually works on stackoverflow.com. Lucky sausages we are.

In contrast to the Java applet, no fancy quadtree or spatial indexing is used so far, only hierarchical bounding boxes (not even last hit caching). The inital layout is random every time you load a tag cloud, so you get a new layout all the time. Albeit, the results look quite ok.

You can see tagmob.js working inside a small webapp here or in the tagmob.html provided.

Usage

To create a tagmob, you basically need two things:

  • A list containing your tags.
  • At least one Cufón font registered after loading tagmob.js (I have provided a free Helvetica style font by Manfred Klein for your convenience).

The list should provide words directly inside the <li>elements and a data-count attribute, sorted in descending order:

<ol id="wordcloud">
  <li data-count="150">Ruby</li>
  <li data-count="130">Rails</li>
  <li data-count="90">user</li>
  <li data-count="80">restart</li>
  ...
</ol>

Supposed your list has the id wordcloud Your header should contain something like this:

<script src="http://ajax.googleapis.com/ajax/libs/jquery/1.5.1/jquery.min.js" type="text/javascript"></script>
<script src="tagmob.js" type="text/javascript"></script>
<script src="fonts/OldSansBlack_500.font.js" type="text/javascript"></script>
<script type="text/javascript">
  $(function() {

    tagmob.createFromList('wordcloud', options);

  });
</script>

That's it. You should see a tagmob inside a canvas element where you list was.

Options

{
  width: 800,                     // width of the created canvas element
  height: 640,                    // height of the created canvas element
  rotationProbability: 0.5,       // rotation probability, defaults to height/width ratio
  rotationOrientation: 'right',   // 'left' or 'right' rotation
  color: "#000000",               // standard word color, if not overriden by data-color
  hoverColor: "#00FF00",          // mousehover color
  selectColor: "#FF0000",         // color for currently selected word
  maxFontHeight: 200,             // max font height in pixels
  minFontHeight: 12,              // min font height in pixels
  scaleToFit: true,               // if true, tagmob is scaled afterwards to fit into width and height of the canvas.
  palette: ['#00FF00','#FF0000','#0000FF'] //cycle through this palette. this is overriden by the color property if set.
  // mouse callbacks
  onselect: function(word) {
    alert(word.text + " selected!");
  },
  onunselect: function(word) {},
  onmouseover: function(word) {},
  onmouseout: function(word) {},
}

TODO

Lots of things to do, especially cleaning up. Comments, bug reports and pull requests welcome!