Home Reference Source
import DataItemWithValue from './gui/data-items/DataItemWithValue.jsx'
public class | source

DataItemWithValue

Extends:

gui/data-items/DataItem.js~DataItem → DataItemWithValue

The purpose of DataItemWithValue is to store a value. Any class that extends this DataItem will have a value attribute that gets written to the tool's XML configuration.

Constructor Summary

Public Constructor
public

constructor(dataName: string, dataItemProps: object)

Constructor

Member Summary

Public Members
public

getValue: *: *

Function that returns the current value of the data item.

public

setValue(value: *): *

Function that sets the value of the data item.

Public Constructors

public constructor(dataName: string, dataItemProps: object) source

Constructor

Params:

NameTypeAttributeDescription
dataName string

The name of the data item.

dataItemProps object

An object of properties such as hidden, disabled, suppressed etc.

Public Members

public getValue: *: * source

Function that returns the current value of the data item.

Return:

*

The value of the data item.

public setValue(value: *): * source

Function that sets the value of the data item.