CallbackProperty - Cesium Documentation

# CallbackProperty

#### new CallbackProperty(callback, isConstant)

  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.

  Source: DataSources/CallbackProperty.js, line 23

### Members

#### readonlydefinitionChanged :Event

  Gets the event that is raised whenever the definition of this property changes. The definition is changed whenever setCallback is called.
  Source: DataSources/CallbackProperty.js, line 51

#### readonlyisConstant :Boolean

  Gets a value indicating if this property is constant.
  Source: DataSources/CallbackProperty.js, line 38

### 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/CallbackProperty.js, line 102

#### 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 or is unsupported.
  Source: DataSources/CallbackProperty.js, line 65

#### setCallback(callback, isConstant)

  Sets the callback to be used.

  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.

  Source: DataSources/CallbackProperty.js, line 75

### Type Definitions

#### Callback(time, result) → Object

  A function that returns the value of the property.

  Name | Type | Description
  --- | --- | ---
  `time` | JulianDate | optional The time for which to retrieve the value.
  `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 or is unsupported.
  Source: DataSources/CallbackProperty.js, line 106