new Cirrus()
Cirrus tool, a wordcloud-like visualization.
- Tutorials:
Example
let config = {
background: null,
categories: null,
docIndex: null,
fontFamily: null,
inlineData: null,
limit: null,
stopList: null,
visible: null,
whiteList: null,
};
loadCorpus("austen").tool("cirrus", config);
Members
-
categories
-
Properties:
Name Type Description categories
String The categories ID to use. For more information see the Categories documentation.
-
docId
-
Properties:
Name Type Description docId
String | Array.<String> The document ID(s) to restrict the results to.
-
docIndex
-
Properties:
Name Type Description docIndex
Number | Array.<Number> The document index(es) to restrict the results to.
-
fontFamily
-
Properties:
Name Type Default Description fontFamily
String "Palatino Linotype", "Book Antiqua", Palatino, serif The CSS font-family to use for the terms
-
inlineData
-
Properties:
Name Type Description inlineData
String Directly specify the terms and their relative sizes. There data format is a comma-separated list of colon-separated term/size pairs. For example: love:20,like:15,dear:10,child:6
-
limit
-
Properties:
Name Type Default Description limit
Number 500 Specify the number of terms to load (which is separate from the number of Cirrus.visible terms to show) at a time).
-
stopList
-
Properties:
Name Type Default Description stopList
String auto A comma-separated list of words, a named list or a URL to a plain text list, one word per line. By default this is set to 'auto' which auto-detects the document's language and loads an appropriate list (if available for that language). Set this to blank to not use the default stopList. For more information see the Stopwords documentation.
-
visible
-
Properties:
Name Type Default Description visible
Number 50 Specify the number of terms that are visible at a time.
-
whiteList
-
Properties:
Name Type Description whiteList
String | Array.<String> a list of words to always include