let config = {
    "chartType": null,
    "docId": null,
    "docIndex": null,
    "labels": null,
    "limit": null,
    "mode": null,
    "query": null,
    "stopList": null,
    "withDistributions": null
  };

  loadCorpus("austen").tool("Trends", config);

Members

bins

src/main/webapp/app/panel/Trends.js, line 125

Properties:

Name	Type	Description
The	bins	default value will depend on the nature of the corpus: corpus has one document: the default number of bins is 10 corpus has multiple documents: corpus has up to 100 documents: the default number is the size of the corpus corpus has more than 1000 documents: the default number is 100

chartType

src/main/webapp/app/panel/Trends.js, line 155

Properties:

Name	Type	Default	Description
chartType	String	barline	The of chart to display: Options are: 'area', 'bar', 'line', 'stacked', and 'barline'.

docId

src/main/webapp/app/panel/Trends.js, line 139

Properties:

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

docIndex

src/main/webapp/app/panel/Trends.js, line 132

Properties:

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

height

Properties:

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

labels

src/main/webapp/app/panel/Trends.js, line 163

Properties:

Name	Type	Default	Description
labels	Boolean	false	Whether to show term labels.

limit

src/main/webapp/app/panel/Trends.js, line 88

Properties:

Name	Type	Default	Description
limit	Number	5	The number of items to limit the result to.

mode

src/main/webapp/app/panel/Trends.js, line 147

Properties:

Name	Type	Default	Description
mode	String	corpus	Force the mode to be either "corpus" (distribution of terms across documents) or "document" (distribution of terms within a document); usually this is correctly set by default according to whether the corpus has one document ("document") or more than one ("corpus").

query

src/main/webapp/app/panel/Trends.js, line 103

Properties:

Name	Type	Description
query	String | Array.<String>	A query or array of queries (queries can be separated by a comma). For query syntax, see the search documentation.

stopList

src/main/webapp/app/panel/Trends.js, line 96

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.

width

Properties:

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

withDistributions

src/main/webapp/app/panel/Trends.js, line 111

Properties:

Name	Type	Default	Description
withDistributions	String	relative	Determines whether to show "raw" or "relative" frequencies (those are the two valid values). The default value is "relative" (unless there's only one document in the corpus, in which case raw frequencies are shown).