Tools.StreamGraph()

new StreamGraph()

StreamGraph is a visualization that depicts the change of the frequency of words in a corpus (or within a single document).

Tutorials:
Example
let config = {
    "bins": null,
    "docId": null,
    "docIndex": null,
    "limit": null,
    "query": null,
    "stopList": null,
    "withDistributions": null
  };

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

Members

bins

Properties:
Name Type Default Description
bins Number 50

The number of "bins" to divide the result into.

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.

limit

Properties:
Name Type Default Description
limit Number 5

The number of items to limit the result to.

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.

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.

withDistributions

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).