Class Constraint.NumericRange
A class which provides a numeric constraint for a Fabric connection.
Use HTTPFabricConnection#getNumericRangeConstraint method to
get a 'Constraint.NumericRange' object for the current Fabric
connection.
Defined in: <D:\Programs\Neeve\Projects\NeeveBuild\stjsapi/src/main/webapp/js\constraint\NumericRange.js>.
Constructor Attributes | Constructor Name and Description |
---|---|
Constraint.NumericRange(rangeName, minValue, maxValue, eventScope)
Represents a numeric range constraint for a Fabric connection.
|
Method Attributes | Method Name and Description |
---|---|
boolean |
containsValue(value)
Checks if the range contains the specified value
|
number |
Returns the max value of the range constraint
|
number |
Returns the min value of the range constraint
|
void |
setMaxValue(value)
Sets the specified value as the right boundary of the range constraint
|
void |
setMinValue(value)
Sets the specified value as the left boundary of the range constraint
|
Class Detail
Constraint.NumericRange(rangeName, minValue, maxValue, eventScope)
Represents a numeric range constraint for a Fabric connection.
- Parameters:
- {String} rangeName
- The name of the constraint to be created
- {number} minValue
- The left boundary of the range constraint to be created
- {number} maxValue
- The right boundary of the range constraint to be created
- {String} eventScope
- The data scope of the constraint to be created. Possible values: 'LOCAL' (the current component scope), 'OBSERVABLE' (the current Fabric node scope), 'GLOBAL' (the whole Fabric scope).
Method Detail
{boolean}
containsValue(value)
Checks if the range contains the specified value
- Parameters:
- {number} value
- The value to be checked
- Returns:
- True if the range contains the specified value, false otherwise
{number}
getMaxValue()
Returns the max value of the range constraint
- Returns:
- the max range value
{number}
getMinValue()
Returns the min value of the range constraint
- Returns:
- the min range value
setMaxValue(value)
Sets the specified value as the right boundary of the range constraint
- Parameters:
- {number} value
- The value to be set as the max value of the range
setMinValue(value)
Sets the specified value as the left boundary of the range constraint
- Parameters:
- {number} value
- The value to be set as the min value of the range