Type Definitions
-
bins
-
The number of "bins" to divide the result into.
-
categories
-
The categories ID to use. For more information see the Categories documentation.
-
columns
-
One or more column data indexes to display, separated by a comma. Use this to modify the default set of visible columns.
-
context
-
The number of terms to consider on each side of the keyword.
-
dir
-
The direction in which to sort the results: 'asc' or 'desc'
-
docId
-
The document ID(s) to restrict the results to.
-
docIndex
-
The document index(es) to restrict the results to.
-
limit
-
The number of items to limit the result to.
-
query
-
A query or array of queries (queries can be separated by a comma). For query syntax, see the search documentation.
-
sort
-
The column to sort the results by
-
start
-
The index of the item to start the results at.
-
stopList
-
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.
-
termColors
-
Which term colors to show in the grid. By default this is set to 'categories' which shows the term color only if it's been assigned by a category. The other alternatives are 'terms' which shows all terms colors, and '' or undefined which shows no term colors.
-
withDistributions
-
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).