JSDoc: Global

Members

ActorType :string

An enumeration representing the type of an actor in the system.

Type:

string

Source:

types/actorType.ts, line 7

(constant) ActorsContext

A context that provides a Map of actors, where the keys are the actor IDs and the values are the actor objects. This context is used to share the actors data between components.

Source:

components/context/ActorsContext.tsx, line 9

ConnectionType :string

An enumeration representing the type of connection between two intentional elements in the system.

Type:

string

Source:

types/intentionType.ts, line 19

(constant) DependenciesContext

A context that provides a Map of dependencies, where the keys are the dependency IDs and the values are the dependency objects. This context is used to share the dependencies data between components.

Source:

components/context/DependenciesContext.tsx, line 7

(constant) ExpandMore

A styled component that renders an IconButton with a down arrow icon that rotates 180 degrees when expanded.

Source:

components/ExpandMoreButton.tsx, line 9

IntentionType :string

An enumeration representing the type of an intentional element in the system.

Type:

string

Source:

types/intentionType.ts, line 7

QualityType :string

An enumeration representing the type of quality associated with an intentional element in the system.

Type:

string

Source:

types/qualityType.ts, line 7

(constant) SelectedActorContext

A context that provides the currently selected actor object. This context is used to share the selected actor data between components.

Source:

components/context/SelectedActorContext.tsx, line 7

(constant) SelectedActorDispatchContext

A context that provides a dispatch function to update the selected actor object. This context is used to share the dispatch function between components.

Source:

components/context/SelectedActorContext.tsx, line 12

(constant) SelectedIntentionContext

A context that provides the currently selected intention object. This context is used to share the selected intention data between components.

Source:

components/context/SelectedIntentionContext.tsx, line 9

(constant) SelectedIntentionDispatchContext

A context that provides a dispatch function to update the selected intention object. This context is used to share the dispatch function between components.

Source:

components/context/SelectedIntentionContext.tsx, line 14

Methods

capitalizeFirstLetter(string)

A function that capitalizes the first letter of a string.

Parameters:

Name	Type	Description
`string`		The string to capitalize.

Source:

util/StringUtil.ts, line 41

Returns:

The string with the first letter capitalized.

combineDependenciesByDependee(dependencies, actors)

A function that combines dependencies by dependee and returns an array of objects representing the combined dependencies.

Parameters:

Name	Type	Description
`dependencies`		An array of dependencies to be combined.
`actors`		A map of actors in the system.

Source:

util/DependencyUtil.ts, line 61

Returns:

An array of objects representing the combined dependencies.

combineDependenciesByDepender(dependencies, actors)

A function that combines dependencies by depender and returns an array of objects representing the combined dependencies.

Parameters:

Name	Type	Description
`dependencies`		An array of dependencies to be combined.
`actors`		A map of actors in the system.

Source:

util/DependencyUtil.ts, line 9

Returns:

An array of objects representing the combined dependencies.

elementIsActor(element)

Returns true if the element is an Actor or Intention, false otherwise.

Parameters:

Name	Type	Description
`element`		The element to check.

Source:

components/LinkHoverChip.tsx, line 67

Returns:

True if the element is an Actor or Intention, false otherwise.

elementIsIntention(element)

Checks if an element is an instance of the Intention class.

Parameters:

Name	Type	Description
`element`		The element to check.

Source:

components/LinkHoverChip.tsx, line 75

Returns:

True if the element is an instance of the Intention class, false otherwise.

elementIsLast(index, count)

A function that returns a boolean indicating whether the element at the specified index is the last element in a list of the specified count.

Parameters:

Name	Type	Description
`index`		The index of the element.
`count`		The count of elements in the list.

Source:

util/ElementListUtil.ts, line 19

Returns:

A boolean indicating whether the element is the last element in the list.

elementIsNotFirstOrLast(index, count)

A function that returns a boolean indicating whether the element at the specified index is not the first or last element in a list of the specified count.

Parameters:

Name	Type	Description
`index`		The index of the element.
`count`		The count of elements in the list.

Source:

util/ElementListUtil.ts, line 9

Returns:

A boolean indicating whether the element is not the first or last element in the list.

getActorTypeDescription(actorType)

A function that returns a description of the specified actor type.

Parameters:

Name	Type	Description
`actorType`		The type of the actor.

Source:

types/actorType.ts, line 19

Returns:

A string describing the specified actor type.

getChipColor(type)

A function that returns the color of a chip based on the specified intention type.

Parameters:

Name	Type	Description
`type`		The intention type.

Source:

util/DisplayUtil.ts, line 9

Returns:

The color of the chip.

getConnectionTypeDescription(connectionType)

A function that returns a description of the specified connection type.

Parameters:

Name	Type	Description
`connectionType`		The type of the connection.

Source:

types/intentionType.ts, line 30

Returns:

A string describing the specified connection type.

getIntentionTypeDescription(intentionType)

A function that returns a description of the specified intention type.

Parameters:

Name	Type	Description
`intentionType`		The type of the intentional element.

Source:

types/intentionType.ts, line 40

Returns:

A string describing the specified intention type.

getQualityTypeDescription(qualityType, isPlural, direction)

A function that returns a description of the specified quality type.

Parameters:

Name	Type	Description
`qualityType`		The type of the quality.
`isPlural`		A boolean indicating whether the description should be pluralized.
`direction`		A string representing the direction of the quality, which can be incoming, outgoing, or both.

Source:

types/qualityType.ts, line 23

Returns:

A string describing the specified quality type.

getQualityTypeDescriptionIncoming(qualityType)

A function that returns a description of the specified quality type in the incoming direction.

Parameters:

Name	Type	Description
`qualityType`		The type of the quality.

Source:

types/qualityType.ts, line 63

Returns:

A string describing the specified quality type in the incoming direction.

getQualityTypeDescriptionPlural(qualityType)

A function that returns a pluralized description of the specified quality type.

Parameters:

Name	Type	Description
`qualityType`		The type of the quality.

Source:

types/qualityType.ts, line 45

Returns:

A string describing the specified quality type in plural form.

getRequiredDependencies(dependencyIDs, dependencies, actor)

A function that returns an array of required dependencies for the specified actor, given an array of dependency IDs and a map of dependencies.

Parameters:

Name	Type	Description
`dependencyIDs`		An array of dependency IDs.
`dependencies`		A map of dependencies.
`actor`		The actor for which to retrieve the required dependencies.

Source:

util/DependencyUtil.ts, line 36

Returns:

An array of required dependencies for the specified actor.

getRequiringDependencies(dependencyIDs, dependencies, actor)

A function that returns an array of requiring dependencies for the specified actor, given an array of dependency IDs and a map of dependencies.

Parameters:

Name	Type	Description
`dependencyIDs`		An array of dependency IDs.
`dependencies`		A map of dependencies.
`actor`		The actor for which to retrieve the requiring dependencies.

Source:

util/DependencyUtil.ts, line 49

Returns:

An array of requiring dependencies for the specified actor.

numberToText(n)

A function that returns the text representation of a number.

Parameters:

Name	Type	Description
`n`		The number to convert to text.

Source:

util/StringUtil.ts, line 8

Returns:

The text representation of the number.

splitElementsByType(elements)

A function that splits an array of intentional elements into separate arrays by type.

Parameters:

Name	Type	Description
`elements`		The array of intentional elements to split.

Source:

components/IntentionsPhrase.tsx, line 45

Returns:

An object containing separate arrays of intentional elements by type.

Type Definitions

QualityDirection

A type representing the direction of a quality associated with an intentional element in the system.

Type:

string

Properties:

Name	Type	Description
`INCOMING`	string	The quality is incoming, meaning that it is associated with the intentional element that depends on the other intentional element.
`OUTGOING`	string	The quality is outgoing, meaning that it is associated with the intentional element that the depender intentional element depends on.
`BOTH`	string	The quality is related to another element in the sense of describing it further.

Source:

types/Quality.ts, line 23