Range Structure

Spotfire 14.2 API Reference
A Range represents a double-precision floating-point interval.

Namespace:  Spotfire.Dxp.Data
Assembly:  Spotfire.Dxp.Data (in Spotfire.Dxp.Data.dll) Version: 64.0.19329.3263 (64.0.19329.3263)
Syntax

C#
[SerializableAttribute]
[PersistenceVersionAttribute(2, 0)]
public struct Range

The Range type exposes the following members.

Constructors

  NameDescription
Public methodRange(Range)
Initializes a new instance of the Range struct. Copy constructor.
Public methodRange(Double, Double)
Initializes a new instance of the Range struct.
Top
Properties

  NameDescription
Public propertyHigh
Gets the high limit of the range.
Public propertyIsEmptyRange
Gets a value indicating whether the range is empty or not.True Returns true if the range is an empty (point) interval.
Public propertyIsUnitRange
Gets a value indicating whether the range is a unit range. Returns true if the range is a unit range [0, 1].
Public propertyIsValidRange
Gets a value indicating whether the range is valid or not.
Public propertyLow
Gets the low limit of the range.
Public propertyMidpoint
Gets the mid-point of the range. Equal to (Low + High)/2.
Public propertyWidth
Gets the width of the range. Equal to High - Low.
Top
Methods

  NameDescription
Public methodClamp
Clamps the specified value to this range. That is, the returned value will be within this range.
Public methodContains
Determines whether the specified value is within the range.
Public methodEquals
Compare for equality.
(Overrides ValueTypeEquals(Object).)
Public methodGetHashCode
Calculates hash code for a range.
(Overrides ValueTypeGetHashCode.)
Public methodGetType
Gets the Type of the current instance.
(Inherited from Object.)
Public methodToString
Returns a string representation of the range.
(Overrides ValueTypeToString.)
Top
Operators

  NameDescription
Public operatorStatic memberEquality
Compare for equality.
Public operatorStatic memberInequality
Compare for Inequality.
Top
Fields

  NameDescription
Public fieldStatic memberEmptyRange
Empty range. Both Low and High are 0.
Public fieldStatic memberInvalidRange
Invalid range. No operations except IsInvalid are allowed.
Public fieldStatic memberUnitRange
Unit range. Low is 0 and High is 1.
Top
Version Information

Supported in: 14.2, 14.1, 14.0, 12.5, 12.4, 12.3, 12.2, 12.1, 12.0, 11.8, 11.7, 11.6, 11.5, 11.4
See Also

Reference