ConstantProperty

Members

readonlydefinitionChanged :Event

Gets the event that is raised whenever the definition of this property changes. The definition is changed whenever setValue is called with data different than the current value.

Source: DataSources/ConstantProperty.js, line 56

readonlyisConstant :Boolean

Gets a value indicating if this property is constant. This property always returns true.

Source: DataSources/ConstantProperty.js, line 44

Methods

equals(other) → Boolean

Compares this property to the provided property and returns true if they are equal, false otherwise.

Name	Type	Description
other	Property	optional The other property.

Returns:

true if left and right are equal, false otherwise.

Source: DataSources/ConstantProperty.js, line 113

getValue(time, result) → Object

Gets the value of the property.

Name	Type	Description
time	JulianDate	optional The time for which to retrieve the value. This parameter is unused since the value does not change with respect to time.
result	Object	optional The object to store the value into, if omitted, a new instance is created and returned.

Returns:

The modified result parameter or a new instance if the result parameter was not supplied.

Source: DataSources/ConstantProperty.js, line 70

setValue(value)

Sets the value of the property. If the value is a non-basic type, then it must provide clone and equals functions.

Name	Type	Description
value	Object	The property value.

Throws:

• DeveloperError : value.clone is a required function.
• DeveloperError : value.equals is a required function.

Source: DataSources/ConstantProperty.js, line 83