wordcram

Interface WordSizer

public interface WordSizer

A WordSizer tells WordCram how big to render each word. You'll pass a WordSizer to WordCram via WordCram.withSizer(WordSizer).

Some useful implementations are available in Sizers.

Method Summary

Methods

Modifier and Type	Method and Description
float	sizeFor(Word word, int wordRank, int wordCount) How big should this Word be rendered?

Method Detail

sizeFor

float sizeFor(Word word,
            int wordRank,
            int wordCount)

How big should this Word be rendered?

Generally, a word cloud draws more important words bigger. Two typical ways to measure word's importance are its weight, and its rank (its position in the list of words, sorted by weight).

Given that, sizeFor is passed the Word (which knows its own weight), its rank, and the total number of words.

For example, given the text "I think I can I think", the words would look like this:

• "I", weight 1.0 (3/3), rank 1
• "think", weight 0.667 (2/3), rank 2
• "can", weight 0.333 (1/3), rank 3

...and the WordSizer would be called with the following values:

• Word "I" (weight 1.0), 1, 3
• Word "think" (weight 0.667), 2, 3
• Word "can" (weight 0.333), 3, 3

Parameters:

word - the Word to determine the size of

wordRank - the rank of the Word

wordCount - the total number of Words being rendered

Returns:

the size to render the Word