API Documentation

Class

Cones

Cones(props) → {React.Component}

Overview

The dominance cones tab in RuLeStudio. Presents the list of all objects from information table with details about their dominance cones.
Constructor

# new Cones(props) → {React.Component}

Parameters:
Name Type Description
props Object
objectGlobalName string

The global visible object name used by all tabs as reference.
onTabChange function

Callback fired when a tab is changed and there are unsaved changes in this tab.
project Object

Current project.
serverBase string

The host and port in the URL of an API call.
showAlert function

Callback fired when results in this tab are based on outdated information table.
value number

The index of a selected tab.

View Source Body/Project/Tabs/Cones.js, line 34

React.Component

Methods

# static getData()

Overview

Makes an API call on cones to receive current copy of dominance cones from server. Then, updates state and makes necessary changes in display.

View Source Body/Project/Tabs/Cones.js, line 63

# static onCalculateClick()

Overview

Makes an API call on cones to generate new dominance cones from current information table. Then, updates state and makes necessary changes in display.

View Source Body/Project/Tabs/Cones.js, line 161

# static onFilterChange(event)

Overview

Filters items from Cones's state. Method uses filterFunction to filter items.
Parameters:
Name Type Description
event Object

Represents an event that takes place in DOM.

View Source Body/Project/Tabs/Cones.js, line 222

# componentDidMount()

Overview

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

Goal

Method calls getData.

View Source Body/Project/Tabs/Cones.js, line 116

# componentDidUpdate(prevProps, prevState, snapshot)

Overview

A component's lifecycle method. Fired after a component was updated.

Goal

If project was changed, method saves changes from previous project and calls getData to receive the latest copy of dominance cones.
Parameters:
Name Type Description
prevProps Object

Old props that were already replaced.
prevState Object

Old state that was already replaced.
snapshot Object

Returned from another lifecycle method getSnapshotBeforeUpdate. Usually undefined.

View Source Body/Project/Tabs/Cones.js, line 136

# componentWillUnmount()

Overview

A component's lifecycle method. Fired when component was requested to be unmounted.

View Source Body/Project/Tabs/Cones.js, line 149