GridMaterialProperty - Cesium Documentation

# GridMaterialProperty

#### new GridMaterialProperty(options)

  A `MaterialProperty` that maps to grid `Material` uniforms.

  Name | Type | Description
  --- | --- | ---

  `options`

  Object

  optional Object with the following properties:

  Name | Type | Default | Description
  --- | --- | --- | ---
  `color` | Property | `Color.WHITE` | optional A Property specifying the grid `Color`.
  `cellAlpha` | Property | `0.1` | optional A numeric Property specifying cell alpha values.
  `lineCount` | Property | `new Cartesian2(8, 8)` | optional A `Cartesian2` Property specifying the number of grid lines along each axis.
  `lineThickness` | Property | `new Cartesian2(1.0, 1.0)` | optional A `Cartesian2` Property specifying the thickness of grid lines along each axis.
  `lineOffset` | Property | `new Cartesian2(0.0, 0.0)` | optional A `Cartesian2` Property specifying starting offset of grid lines along each axis.

  Source: DataSources/GridMaterialProperty.js, line 41

### Members

#### cellAlpha :Property

  Gets or sets the numeric Property specifying cell alpha values.
  Default Value: `0.1`
  Source: DataSources/GridMaterialProperty.js, line 108

#### color :Property

  Gets or sets the Property specifying the grid `Color`.
  Default Value: `Color.WHITE`
  Source: DataSources/GridMaterialProperty.js, line 101

#### readonlydefinitionChanged :Event

  Gets the event that is raised whenever the definition of this property changes. The definition is considered to have changed if a call to getValue would return a different result for the same time.
  Source: DataSources/GridMaterialProperty.js, line 90

#### readonlyisConstant :Boolean

  Gets a value indicating if this property is constant. A property is considered constant if getValue always returns the same result for the current definition.
  Source: DataSources/GridMaterialProperty.js, line 72

#### lineCount :Property

  Gets or sets the `Cartesian2` Property specifying the number of grid lines along each axis.
  Default Value: `new Cartesian2(8.0, 8.0)`
  Source: DataSources/GridMaterialProperty.js, line 115

#### lineOffset :Property

  Gets or sets the `Cartesian2` Property specifying the starting offset of grid lines along each axis.
  Default Value: `new Cartesian2(0.0, 0.0)`
  Source: DataSources/GridMaterialProperty.js, line 129

#### lineThickness :Property

  Gets or sets the `Cartesian2` Property specifying the thickness of grid lines along each axis.
  Default Value: `new Cartesian2(1.0, 1.0)`
  Source: DataSources/GridMaterialProperty.js, line 122

### 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/GridMaterialProperty.js, line 168

#### getType(time) → String

  Gets the `Material` type at the provided time.

  Name | Type | Description
  --- | --- | ---
  `time` | JulianDate | The time for which to retrieve the type.

  ##### Returns:

  The type of material.
  Source: DataSources/GridMaterialProperty.js, line 138

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

  Gets the value of the property at the provided time.

  Name | Type | Description
  --- | --- | ---
  `time` | JulianDate | 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.
  Source: DataSources/GridMaterialProperty.js, line 149