let config = {
    "analysis": null,
    "bins": null,
    "clusters": null,
    "comparisonType": null,
    "dimensions": null,
    "docId": null,
    "iterations": null,
    "label": null,
    "limit": null,
    "perplexity": null,
    "query": null,
    "stopList": null,
    "storeJson": null,
    "target": null,
    "term": null,
    "whitelist": null,
  };

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

Members

analysis

src/main/webapp/app/panel/ScatterPlot.js, line 53

Properties:

Name	Type	Description
analysis	String	The type of analysis to perform. Options are: 'ca', 'pca', 'tsne', and 'docSim'.

bins

src/main/webapp/app/panel/ScatterPlot.js, line 77

Properties:

Name	Type	Default	Description
bins	Number	10	The number of "bins" to divide the result into.

clusters

src/main/webapp/app/panel/ScatterPlot.js, line 85

Properties:

Name	Type	Default	Description
clusters	Number	3	The number of clusters within which to group words.

comparisonType

src/main/webapp/app/panel/ScatterPlot.js, line 109

Properties:

Name	Type	Default	Description
comparisonType	String	relative	The value to use for comparing terms. Options are: 'raw', 'relative', and 'tfidf'.

dimensions

src/main/webapp/app/panel/ScatterPlot.js, line 69

Properties:

Name	Type	Default	Description
dimensions	Number	3	The number of dimensions to render, either 2 or 3.

docId

src/main/webapp/app/panel/ScatterPlot.js, line 46

Properties:

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

height

Properties:

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

iterations

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

Properties:

Name	Type	Default	Description
iterations	Number	1500	The TSNE iterations value.

label

src/main/webapp/app/panel/ScatterPlot.js, line 152

Properties:

Name	Type	Description
label	Array.<String>	The label types to show. One or more of: 'summary', 'docs', and 'terms'.

limit

src/main/webapp/app/panel/ScatterPlot.js, line 61

Properties:

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

perplexity

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

Properties:

Name	Type	Default	Description
perplexity	Number	15	The TSNE perplexity value.

query

src/main/webapp/app/panel/ScatterPlot.js, line 138

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/ScatterPlot.js, line 117

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.

storeJson

src/main/webapp/app/panel/ScatterPlot.js, line 159

Properties:

Name	Type	Description
storeJson	String	TODO used in embed

style

Properties:

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

target

src/main/webapp/app/panel/ScatterPlot.js, line 124

Properties:

Name	Type	Description
target	String	The term to set as the target. This will filter results to terms that are near the target.

term

src/main/webapp/app/panel/ScatterPlot.js, line 131

Properties:

Name	Type	Description
term	Array.<String>	Used in combination with "target" as a white list of terms to keep.

whiteList

src/main/webapp/app/panel/ScatterPlot.js, line 145

Properties:

Name	Type	Description
whiteList	String	A list of words to always include

width

Properties:

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