API Documentation

Class

App

App()

Overview

The main component that contains all other elements. Provides two themes: dark and light.
Constructor

# new App()

View Source App/App.js, line 30

Methods

# static isNameUnique(name) → {boolean}

Overview

Checks whether a provided name is unique among other project's names.
Parameters:
Name Type Description
name string

Project's name.

View Source App/App.js, line 566

  • If true the provided name is unique.
boolean

# static onDeleteDialogClose(action)

Overview

Callback fired when DeleteProjectDialog requests to be closed. If user confirmed the deletion, method proceeds to delete current project. Then updates App's state and closes dialog.
Parameters:
Name Type Description
action boolean

If true the method will proceed to delete current project.

View Source App/App.js, line 446

# static onFilesAccepted(name, files, csvSpecsopt)

Overview

Method forwarded to the Import section. Fired when user accepts their selection and requests to create project.

Method checks if project name is already used. Then, makes an API call on projects to create new project. Eventually, adds new project to App's state and changes section to "Project".
Parameters:
Name Type Attributes Description
name string

The name of the new project.
files Array.<Object>

The list of files that are used to build new project.
csvSpecs Object <optional>

If a file containing data was in CSV format, this object contains CSV settings.

View Source App/App.js, line 300

# static onObjectNamesChange()

Overview

Callback fired when SettingsProjectDialog changed global visible object name.

View Source App/App.js, line 430

# static onRenameDialogClose(name)

Overview

Callback fired when RenameProjectDialog requests to be closed. If user provided new name and when the new name is unique, method proceeds to update project's name. Then updates App's state and closes dialog.
Parameters:
Name Type Description
name string

The new name for current project.

View Source App/App.js, line 503

# static updateProject(project)

Overview

Method is forwarded to the ProjectTabs and further to all tabs except Data. Saves changes from provided project in the App's state and updates index options.
Parameters:
Name Type Description
project Object

Project with unsaved changes.

View Source App/App.js, line 170

# componentDidMount()

Overview

A component's lifecycle method. Fired once when component was mounted.

Goal

Makes an API call on projects to receive the latest list of all projects. Then, updates states and makes necessary changes in display.

View Source App/App.js, line 68