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

src/main/webapp/app/panel/Cirrus.js, line 45

Properties:

Name	Type	Description
categories	String	The categories ID to use. For more information see the Categories documentation.

docId

src/main/webapp/app/panel/Cirrus.js, line 78

Properties:

Name	Type	Description
docId	String | Array.<String>	The document ID(s) to restrict the results to.

docIndex

src/main/webapp/app/panel/Cirrus.js, line 84

Properties:

Name	Type	Description
docIndex	Number | Array.<Number>	The document index(es) to restrict the results to.

fontFamily

src/main/webapp/app/panel/Cirrus.js, line 101

Properties:

Name	Type	Default	Description
fontFamily	String	"Palatino Linotype", "Book Antiqua", Palatino, serif	The CSS font-family to use for the terms

height

Properties:

Name	Type	Description
height	Number	The display height of the tool in pixels.

inlineData

src/main/webapp/app/panel/Cirrus.js, line 93

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

src/main/webapp/app/panel/Cirrus.js, line 60

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

src/main/webapp/app/panel/Cirrus.js, line 39

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.

style

Properties:

Name	Type	Description
style	String	A string of CSS properties to use as the style attribute for the tool's parent tag.

visible

src/main/webapp/app/panel/Cirrus.js, line 68

Properties:

Name	Type	Default	Description
visible	Number	50	Specify the number of terms that are visible at a time.

whiteList

src/main/webapp/app/panel/Cirrus.js, line 52

Properties:

Name	Type	Description
whiteList	String | Array.<String>	a list of words to always include

width

Properties:

Name	Type	Description
width	Number	The display width of the tool in pixels.