import SimpleBool from './gui/data-items/SimpleBool.jsx'

public class | source

SimpleBool

Extends:

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

The purpose of SimpleBool is to store a true or false value. It will write to your tool's XML configuration the text "True" or "False", depending on its value. The value it stores and provides through the HTML GUI SDK is however a JavaScript boolean. The default value is false.

Constructor Summary

Public Constructor
public	constructor(dataName: string, dataItemProps: object) Constructor

Public Constructors

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

Constructor

Params:

Name	Type	Attribute	Description
dataName	string		The name of the data item.
dataItemProps	object	optional	An object of properties such as hidden, disabled, suppressed etc.