new Spyral.Categories({
  categories: {
    positive: ['good', 'happy'],
    negative: ['bad', 'sad']
  },
  categoriesRanking: ['positive','negative'],
  features: {color: {}},
  featureDefaults: {color: '#333333'}
})

Methods

addCategory(name)

voyantjs/src/categories.js, line 70

Add a new category.

Parameters:

Name	Type	Description
name	String	The category name

addFeature(name, defaultValue)

voyantjs/src/categories.js, line 254

Add a feature.

Parameters:

Name	Type	Description
name	String	The feature name
defaultValue	*	The default value

addTerm(category, term)

voyantjs/src/categories.js, line 146

Add a term to a category.

Parameters:

Name	Type	Description
category	String	The category name
term	String	The term

addTerms(category, terms)

voyantjs/src/categories.js, line 155

Add multiple terms to a category.

Parameters:

Name	Type	Description
category	String	The category name
terms	Array	An array of terms

getCategories() → {Object}

voyantjs/src/categories.js, line 45

Get the categories.

Returns:

Object

getCategoriesForTerm(term) → {Array}

voyantjs/src/categories.js, line 221

Get all the categories a term belongs to.

Parameters:

Name	Type	Description
term	String	The term

Returns:

Array

getCategoryExportData() → {Object}

voyantjs/src/categories.js, line 309

Get a copy of the category and feature data.

Returns:

Object

getCategoryFeature(categoryName, featureName) → {*}

voyantjs/src/categories.js, line 291

Get the feature for a category.

Parameters:

Name	Type	Description
categoryName	String	The category name
featureName	String	The feature name

Returns:

*

getCategoryForTerm(term) → {string}

voyantjs/src/categories.js, line 204

Get the category that a term belongs to, taking ranking into account.

Parameters:

Name	Type	Description
term	String	The term

Returns:

string

getCategoryNames() → {Array}

voyantjs/src/categories.js, line 53

Get category names as an array.

Returns:

Array

getCategoryRanking(name) → {number}

voyantjs/src/categories.js, line 116

Gets the ranking for a category.

Parameters:

Name	Type	Description
name	String	The category name

Returns:

number

getCategoryTerms(name) → {Array}

voyantjs/src/categories.js, line 62

Get the terms for a category.

Parameters:

Name	Type	Description
name	String	The category name

Returns:

Array

getFeatureForTerm(feature, term) → {*}

voyantjs/src/categories.js, line 237

Get the feature for a term.

Parameters:

Name	Type	Description
feature	String	The feature
term	String	The term

Returns:

*

getFeatures() → {Object}

voyantjs/src/categories.js, line 245

Get the features.

Returns:

Object

load(config, apiopt) → {Promise.<Object>}

voyantjs/src/categories.js, line 346

Load the categories (if we're in a recognized environment).

In its simplest form this can be used with a single string ID to load:

new Spyral.Categories().load("categories.en.txt")

Which is equivalent to:

new Spyral.Categories().load({retrieveResourceId: "categories.en.txt"});

Parameters:

Name	Type	Attributes	Description
config	Object | String		an object specifying the parameters (see above)
api	Object	<optional>	an object specifying any parameters for the trombone call

Returns:

Promise.<Object> -

this first returns a promise and when the promise is resolved it returns this categories object (with the loaded data included)

removeCategory(name)

voyantjs/src/categories.js, line 100

Remove a category.

Parameters:

Name	Type	Description
name	String	The category name

removeFeature(name)

voyantjs/src/categories.js, line 267

Remove a feature.

Parameters:

Name	Type	Description
name	String	The feature name

removeTerm(category, term)

voyantjs/src/categories.js, line 175

Remove a term from a category.

Parameters:

Name	Type	Description
category	String	The category name
term	String	The term

removeTerms(category, terms)

voyantjs/src/categories.js, line 184

Remove multiple terms from a category.

Parameters:

Name	Type	Description
category	String	The category name
terms	Array	An array of terms

renameCategory(oldName, newName)

voyantjs/src/categories.js, line 82

Rename a category.

Parameters:

Name	Type	Description
oldName	String	The old category name
newName	String	The new category name

save(config, apiopt) → {Promise.<String>}

voyantjs/src/categories.js, line 323

Save the categories (if we're in a recognized environment).

Parameters:

Name	Type	Attributes	Description
config	Object		for the network call (specifying if needed the location of Trombone, etc., see Spyral.Load#trombone
api	Object	<optional>	an object specifying any parameters for the trombone call

Returns:

Promise.<String> -

this returns a promise which eventually resolves to a string that is the ID reference for the stored categories

setCategoryFeature(categoryName, featureName, featureValue)

voyantjs/src/categories.js, line 278

Set the feature for a category.

Parameters:

Name	Type	Description
categoryName	String	The category name
featureName	String	The feature name
featureValue	*	The feature value

setCategoryRanking(name, ranking)

voyantjs/src/categories.js, line 130

Sets the ranking for a category.

Parameters:

Name	Type	Description
name	String	The category name
ranking	number	The category ranking

static load(config, apiopt) → {Promise.<Object>}

voyantjs/src/categories.js, line 378

Load categories and return a promise that resolves to a new Spyral.Categories instance.

Parameters:

Name	Type	Attributes	Description
config	Object | String		an object specifying the parameters (see above)
api	Object	<optional>	an object specifying any parameters for the trombone call

Returns:

Promise.<Object> -

this first returns a promise and when the promise is resolved it returns this categories object (with the loaded data included)