A
Property whose value is lazily evaluated by a callback function.
| Name | Type | Description |
|---|---|---|
callback |
CallbackProperty~Callback | The function to be called when the property is evaluated. |
isConstant |
Boolean |
true when the callback function returns the same value every time, false if the value will change. |
Members
-
readonlydefinitionChanged : Event
-
Gets the event that is raised whenever the definition of this property changes. The definition is changed whenever setCallback is called.
-
Gets a value indicating if this property is constant.
Methods
-
Compares this property to the provided property and returns
trueif they are equal,falseotherwise.Name Type Description otherProperty optional The other property. Returns:
trueif left and right are equal,falseotherwise. -
Gets the value of the property.
Name Type Description timeJulianDate optional The time for which to retrieve the value. This parameter is unused since the value does not change with respect to time. resultObject 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 or is unsupported. -
Sets the callback to be used.
Name Type Description callbackCallbackProperty~Callback The function to be called when the property is evaluated. isConstantBoolean truewhen the callback function returns the same value every time,falseif the value will change.
Type Definitions
-
A function that returns the value of the property.
Name Type Description timeJulianDate optional The time for which to retrieve the value. resultObject 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 or is unsupported.