DAND6 JSDoc

Class: AppExploreController

AppExplainController~ AppExploreController

new AppExploreController()

The controller retrieving the data for the exploratory visualization and
governing the interaction on this visualization.

Source:

Methods

<static> factory()

Factory to create the directive; used in the angular.directive call.

Source:

loadMetrics(metricsUrl)

Loads a metrics file containing the metrics data from a URL
supplied to the function.

Parameters:
Name Type Description
metricsUrl

the URL to load the metrics file from
Source:

loadScenarios(scenarioUrl)

Loads the scenario file containing all the selectable scenarios from a URL
supplied to the function.

Parameters:
Name Type Description
scenarioUrl

the URL to load the scenarios file from
Source:

loadStories(storiesUrl)

Loads a stories file containing the stories from a URL
supplied to the function.

Parameters:
Name Type Description
storiesUrl

the URL to load the stories file from
Source:

metricsLoadedHandler()

Returns a callback to be invoked with the JSON data as parameter after a
metrics JSON file is loaded.

Source:

processUrlHandler()

Returns a callback that should be invoked every time the URL's search
string changes. The callback processes the URL-parameters 'scenarioId' and
'storyId'.

Source:
See:
  • module:AppExploreController~AppExploreController#processUrlScenarioId
  • module:AppExploreController~AppExploreController#processUrlStoryId

processUrlScenarioId()

Updates the selected scenario based on the URL's search parameter
'scenarioId'.

Source:

processUrlStoryId()

Updates the selected story based on the URL's search parameter 'storyId'.

Source:

resetHighlights()

Resets all "highlights" back to normal, that means, no part of the
visualization will be highlighted/marked/zoomed-in etc. after calling this
method.

Source:

scenariosLoadedHandler()

Returns a callback to be invoked with the JSON data as parameter after the
scenarios JSON file is loaded.

Source:

selectedMetricsChangedHandler()

Returns a callback that should be invoked every time the user changes the
selected metrics. The callback updates an internal array "serieses"
that contains all the serieses of all the metrics.

Source:

selectedScenarioChangedHandler()

Returns a callback that should be invoked every time the user changes the
selected scenario. The callback updates the URL's search string and loads
all metrics associated with the scenario.

Source:

selectedStoryChangedHandler()

Returns a callback that should be invoked every time the user changes the
selected story. The callback updates the URL's search string to contain
a reference to that story.

Source:

selectMetricsById(metricsIds)

Helper function to select a number of metrics from the loaded metrics
by its 'id' property. Can be used, e.g., if a storybox needs to display
certain metric graphs based on the story's 'metrics' property.

Parameters:
Name Type Description
metricsIds

an array of metric ids
Source:

storiesLoadedHandler()

Returns a callback to be invoked with the JSON data as parameter after a
stories JSON file is loaded.

Source: