Tools.Contexts()

new Contexts()

The Contexts (or Keywords in Context) tool shows each occurrence of a keyword with a bit of surrounding text (the context).

Tutorials:
Example
let config = {
    columns: null,
    context: 5,
    dir: null,
    docId: null,
    docIndex: null,
    expand: null,
    query: null,
    sort: null,
    stopList: null,
    termColors: null
  };

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

Members

columns

Properties:
Name Type Description
columns columns

'docIndex', 'left', 'term', 'right', 'position'

context

Properties:
Name Type Default Description
context Number 5

The number of terms to consider on each side of the keyword.

dir

Properties:
Name Type Description
dir String

The direction in which to sort the results: 'asc' or 'desc'

docId

Properties:
Name Type Description
docId String | Array.<String>

The document ID(s) to restrict the results to.

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.

expand

Properties:
Name Type Default Description
expand Number 50

How many terms to show when you expand any given row

query

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.

sort

Properties:
Name Type Description
sort String

The column to sort the results by

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.

termColors

Properties:
Name Type Default Description
termColors String categories

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.