clj-wordcloud/docs/clj-wordcloud.core.html
2018-04-19 16:26:38 +05:30

19 lines
3 KiB
HTML

<!DOCTYPE html PUBLIC ""
"">
<html><head><meta charset="UTF-8" /><title>clj-wordcloud.core documentation</title><link rel="stylesheet" type="text/css" href="css/default.css" /><link rel="stylesheet" type="text/css" href="css/highlight.css" /><script type="text/javascript" src="js/highlight.min.js"></script><script type="text/javascript" src="js/jquery.min.js"></script><script type="text/javascript" src="js/page_effects.js"></script><script>hljs.initHighlightingOnLoad();</script></head><body><div id="header"><h2>Generated by <a href="https://github.com/weavejester/codox">Codox</a></h2><h1><a href="index.html"><span class="project-title"><span class="project-name">Clj-wordcloud</span> <span class="project-version">0.0.2-SNAPSHOT</span></span></a></h1></div><div class="sidebar primary"><h3 class="no-link"><span class="inner">Project</span></h3><ul class="index-link"><li class="depth-1 "><a href="index.html"><div class="inner">Index</div></a></li></ul><h3 class="no-link"><span class="inner">Namespaces</span></h3><ul><li class="depth-1 current"><a href="clj-wordcloud.core.html"><div class="inner"><span>clj-wordcloud.core</span></div></a></li></ul></div><div class="sidebar secondary"><h3><a href="#top"><span class="inner">Public Vars</span></a></h3><ul><li class="depth-1"><a href="clj-wordcloud.core.html#var-word-cloud"><div class="inner"><span>word-cloud</span></div></a></li><li class="depth-1"><a href="clj-wordcloud.core.html#var-write-to-file"><div class="inner"><span>write-to-file</span></div></a></li></ul></div><div class="namespace-docs" id="content"><h1 class="anchor" id="top">clj-wordcloud.core</h1><div class="doc"><pre class="plaintext"></pre></div><div class="public anchor" id="var-word-cloud"><h3>word-cloud</h3><div class="usage"><code>(word-cloud frequency-map)</code><code>(word-cloud frequency-map options)</code></div><div class="doc"><pre class="plaintext">
Takes a map of string and the score along with options to return a wordcloud object
Options spec as below :
{:dimension {:width 600 ; width of the image
:height 600} ; height of the image
:background {:type :circle ; type. Takes :circle, :pixel (bitmaps), :rectangle
:size 300 ; size of the circle
:color "0x000000"} ; Background color as hex
:font {:type "Calibre" ; Font type
:weight :plain ; Font weight. Takes :plain, :bold, :italic
:scale-type :linear ; linear for now
:x-scale 20 ; x scale of font
:y-scale 20 ; y scale of font
:padding 5}} ; padding between entries
</pre></div></div><div class="public anchor" id="var-write-to-file"><h3>write-to-file</h3><div class="usage"><code>(write-to-file word-cloud filename)</code></div><div class="doc"><pre class="plaintext">Writes the word cloud object as png image to the given location.
Supply file name with extension png like example.png</pre></div></div></div></body></html>